public interface Secur32 extends StdCallLibrary
Modifier and Type | Interface and Description |
---|---|
static class |
Secur32.EXTENDED_NAME_FORMAT
Specifies a format for a directory service object name.
|
StdCallLibrary.StdCallCallback
Library.Handler
Modifier and Type | Field and Description |
---|---|
static Secur32 |
INSTANCE |
FUNCTION_MAPPER, STDCALL_CONVENTION
OPTION_ALLOW_OBJECTS, OPTION_CALLING_CONVENTION, OPTION_CLASSLOADER, OPTION_FUNCTION_MAPPER, OPTION_INVOCATION_MAPPER, OPTION_OPEN_FLAGS, OPTION_STRING_ENCODING, OPTION_STRUCTURE_ALIGNMENT, OPTION_TYPE_MAPPER
Modifier and Type | Method and Description |
---|---|
int |
AcceptSecurityContext(Sspi.CredHandle phCredential,
Sspi.CtxtHandle phContext,
Sspi.SecBufferDesc pInput,
int fContextReq,
int TargetDataRep,
Sspi.CtxtHandle phNewContext,
Sspi.SecBufferDesc pOutput,
IntByReference pfContextAttr,
Sspi.TimeStamp ptsTimeStamp)
The AcceptSecurityContext function enables the server component of a transport
application to establish a security context between the server and a remote client.
|
int |
AcquireCredentialsHandle(String pszPrincipal,
String pszPackage,
int fCredentialUse,
WinNT.LUID pvLogonID,
Pointer pAuthData,
Pointer pGetKeyFn,
Pointer pvGetKeyArgument,
Sspi.CredHandle phCredential,
Sspi.TimeStamp ptsExpiry)
The AcquireCredentialsHandle function acquires a handle to preexisting credentials
of a security principal.
|
int |
DeleteSecurityContext(Sspi.CtxtHandle phContext)
The DeleteSecurityContext function deletes the local data structures associated
with the specified security context.
|
int |
EnumerateSecurityPackages(IntByReference pcPackages,
Sspi.PSecPkgInfo ppPackageInfo)
The EnumerateSecurityPackages function returns an array of SecPkgInfo structures that
describe the security packages available to the client.
|
int |
FreeContextBuffer(Pointer buffer)
The FreeContextBuffer function enables callers of security package functions to free a memory
buffer that was allocated by the security package as a result of calls to InitializeSecurityContext
and AcceptSecurityContext.
|
int |
FreeCredentialsHandle(Sspi.CredHandle phCredential)
The FreeCredentialsHandle function notifies the security system that the
credentials are no longer needed.
|
boolean |
GetUserNameEx(int nameFormat,
char[] lpNameBuffer,
IntByReference len)
Retrieves the name of the user or other security principal associated with
the calling thread.
|
int |
ImpersonateSecurityContext(Sspi.CtxtHandle phContext)
The ImpersonateSecurityContext function allows a server to impersonate a client by using
a token previously obtained by a call to AcceptSecurityContext or QuerySecurityContextToken.
|
int |
InitializeSecurityContext(Sspi.CredHandle phCredential,
Sspi.CtxtHandle phContext,
String pszTargetName,
int fContextReq,
int Reserved1,
int TargetDataRep,
Sspi.SecBufferDesc pInput,
int Reserved2,
Sspi.CtxtHandle phNewContext,
Sspi.SecBufferDesc pOutput,
IntByReference pfContextAttr,
Sspi.TimeStamp ptsExpiry)
The InitializeSecurityContext function initiates the client side, outbound security
context from a credential handle.
|
int |
QuerySecurityContextToken(Sspi.CtxtHandle phContext,
WinNT.HANDLEByReference phToken)
The QuerySecurityContextToken function obtains the access token for a client security context
and uses it directly.
|
int |
RevertSecurityContext(Sspi.CtxtHandle phContext)
Allows a security package to discontinue the impersonation of the caller and restore its
own security context.
|
static final Secur32 INSTANCE
boolean GetUserNameEx(int nameFormat, char[] lpNameBuffer, IntByReference len)
nameFormat
- The format of the name.lpNameBuffer
- A pointer to a buffer that receives the name in the specified format.len
- On input, the size of the buffer, on output the number of characters copied into the buffer, not including the terminating null character.int AcquireCredentialsHandle(String pszPrincipal, String pszPackage, int fCredentialUse, WinNT.LUID pvLogonID, Pointer pAuthData, Pointer pGetKeyFn, Pointer pvGetKeyArgument, Sspi.CredHandle phCredential, Sspi.TimeStamp ptsExpiry)
pszPrincipal
- A pointer to a null-terminated string that specifies the name of the principal whose
credentials the handle will reference.pszPackage
- A pointer to a null-terminated string that specifies the name of the security package
with which these credentials will be used.fCredentialUse
- A flag that indicates how these credentials will be used.pvLogonID
- A pointer to a locally unique identifier (LUID) that identifies the user.pAuthData
- A pointer to package-specific data. This parameter can be NULL, which indicates
that the default credentials for that package must be used. To use supplied
credentials, pass a SEC_WINNT_AUTH_IDENTITY structure that includes those credentials
in this parameter.pGetKeyFn
- This parameter is not used and should be set to NULL.pvGetKeyArgument
- This parameter is not used and should be set to NULL.phCredential
- A pointer to a CredHandle structure to receive the credential handle.ptsExpiry
- A pointer to a TimeStamp structure that receives the time at which the returned
credentials expire. The value returned in this TimeStamp structure depends on
the security package. The security package must return this value in local time.int InitializeSecurityContext(Sspi.CredHandle phCredential, Sspi.CtxtHandle phContext, String pszTargetName, int fContextReq, int Reserved1, int TargetDataRep, Sspi.SecBufferDesc pInput, int Reserved2, Sspi.CtxtHandle phNewContext, Sspi.SecBufferDesc pOutput, IntByReference pfContextAttr, Sspi.TimeStamp ptsExpiry)
phCredential
- A handle to the credentials returned by AcquireCredentialsHandle. This handle is
used to build the security context. The InitializeSecurityContext function requires
at least OUTBOUND credentials.phContext
- A pointer to a CtxtHandle structure. On the first call to InitializeSecurityContext,
this pointer is NULL. On the second call, this parameter is a pointer to the handle
to the partially formed context returned in the phNewContext parameter by the first
call.pszTargetName
- A pointer to a null-terminated string that indicates the target of the context.
The string contents are security-package specific.fContextReq
- Bit flags that indicate requests for the context. Not all packages can support all
requirements. Flags used for this parameter are prefixed with ISC_REQ_, for example,
ISC_REQ_DELEGATE.Reserved1
- This parameter is reserved and must be set to zero.TargetDataRep
- The data representation, such as byte ordering, on the target. This parameter can be
either SECURITY_NATIVE_DREP or SECURITY_NETWORK_DREP.pInput
- A pointer to a SecBufferDesc structure that contains pointers to the buffers supplied
as input to the package. The pointer must be NULL on the first call to the function.
On subsequent calls to the function, it is a pointer to a buffer allocated with enough
memory to hold the token returned by the remote peer.Reserved2
- This parameter is reserved and must be set to zero.phNewContext
- A pointer to a CtxtHandle structure. On the first call to InitializeSecurityContext,
this pointer receives the new context handle. On the second call, phNewContext can be
the same as the handle specified in the phContext parameter.pOutput
- A pointer to a SecBufferDesc structure that contains pointers to the SecBuffer structure
that receives the output data. If a buffer was typed as SEC_READWRITE in the input, it
will be there on output. The system will allocate a buffer for the security token if
requested (through ISC_REQ_ALLOCATE_MEMORY) and fill in the address in the buffer
descriptor for the security token.pfContextAttr
- A pointer to a variable to receive a set of bit flags that indicate the attributes of
the established context. Flags used for this parameter are prefixed with ISC_RET,
such as ISC_RET_DELEGATE.ptsExpiry
- A pointer to a TimeStamp structure that receives the expiration time of the context.
It is recommended that the security package always return this value in local time.
This parameter is optional and NULL should be passed for short-lived clients.int DeleteSecurityContext(Sspi.CtxtHandle phContext)
phContext
- Handle of the security context to delete.int FreeCredentialsHandle(Sspi.CredHandle phCredential)
phCredential
- A pointer to the credential handle obtained by using the AcquireCredentialsHandle
function.int AcceptSecurityContext(Sspi.CredHandle phCredential, Sspi.CtxtHandle phContext, Sspi.SecBufferDesc pInput, int fContextReq, int TargetDataRep, Sspi.CtxtHandle phNewContext, Sspi.SecBufferDesc pOutput, IntByReference pfContextAttr, Sspi.TimeStamp ptsTimeStamp)
phCredential
- A handle to the credentials of the server. The server calls the AcquireCredentialsHandle
function with either the SECPKG_CRED_INBOUND or SECPKG_CRED_BOTH flag set to retrieve
this handle.phContext
- A pointer to a CtxtHandle structure. On the first call to AcceptSecurityContext,
this pointer is NULL. On subsequent calls, phContext is the handle to the partially
formed context that was returned in the phNewContext parameter by the first call.pInput
- A pointer to a SecBufferDesc structure generated by a client call to
InitializeSecurityContext that contains the input buffer descriptor.fContextReq
- Bit flags that specify the attributes required by the server to establish the
context. Bit flags can be combined by using bitwise-OR operations.TargetDataRep
- The data representation, such as byte ordering, on the target. This parameter can
be either SECURITY_NATIVE_DREP or SECURITY_NETWORK_DREP.phNewContext
- A pointer to a CtxtHandle structure. On the first call to AcceptSecurityContext,
this pointer receives the new context handle. On subsequent calls, phNewContext
can be the same as the handle specified in the phContext parameter.pOutput
- A pointer to a SecBufferDesc structure that contains the output buffer descriptor.
This buffer is sent to the client for input into additional calls to
InitializeSecurityContext. An output buffer may be generated even if the function
returns SEC_E_OK. Any buffer generated must be sent back to the client application.pfContextAttr
- A pointer to a variable that receives a set of bit flags that indicate the
attributes of the established context. For a description of the various attributes,
see Context Requirements. Flags used for this parameter are prefixed with ASC_RET,
for example, ASC_RET_DELEGATE.ptsTimeStamp
- A pointer to a TimeStamp structure that receives the expiration time of the context.int EnumerateSecurityPackages(IntByReference pcPackages, Sspi.PSecPkgInfo ppPackageInfo)
pcPackages
- A pointer to a int variable that receives the number of packages returned.ppPackageInfo
- A pointer to a variable that receives a pointer to an array of SecPkgInfo structures.
Each structure contains information from the security support provider (SSP) that
describes a security package that is available within that SSP.int FreeContextBuffer(Pointer buffer)
buffer
- A pointer to memory allocated by the security package.int QuerySecurityContextToken(Sspi.CtxtHandle phContext, WinNT.HANDLEByReference phToken)
phContext
- Handle of the context to query.phToken
- Returned handle to the access token.int ImpersonateSecurityContext(Sspi.CtxtHandle phContext)
phContext
- The handle of the context to impersonate. This handle must have been obtained by a call
to the AcceptSecurityContext function.int RevertSecurityContext(Sspi.CtxtHandle phContext)
phContext
- Handle of the security context being impersonated. This handle must have been obtained in
the call to the AcceptSecurityContext function and used in the call to the
ImpersonateSecurityContext function.