Public Member Functions | Public Attributes

nsIAuthModule Interface Reference

import "nsIAuthModule.idl";

List of all members.

Public Member Functions

void init (in string aServiceName, in unsigned long aServiceFlags, in wstring aDomain, in wstring aUsername, in wstring aPassword)
 Other flags may be defined in the future.
void getNextToken ([const ] in voidPtr aInToken, in unsigned long aInTokenLength, out voidPtr aOutToken, out unsigned long aOutTokenLength)
 Called to get the next token in a sequence of authentication steps.
void wrap ([const ] in voidPtr aInToken, in unsigned long aInTokenLength, in boolean confidential, out voidPtr aOutToken, out unsigned long aOutTokenLength)
 Once a security context has been established through calls to GetNextToken() it may be used to protect data exchanged between client and server.
void unwrap ([const ] in voidPtr aInToken, in unsigned long aInTokenLength, out voidPtr aOutToken, out unsigned long aOutTokenLength)
 Unwrap() is used to unpack, decrypt, and verify the checksums on data returned by a server when security layers are in use.

Public Attributes

const unsigned long REQ_DEFAULT = 0
 Default behavior.
const unsigned long REQ_MUTUAL_AUTH = (1 << 0)
 Client and server will be authenticated.
const unsigned long REQ_DELEGATE = (1 << 1)
 The server is allowed to impersonate the client.

Member Function Documentation

void nsIAuthModule::getNextToken ( [const ] in voidPtr  aInToken,
in unsigned long  aInTokenLength,
out voidPtr  aOutToken,
out unsigned long  aOutTokenLength 
)

Called to get the next token in a sequence of authentication steps.

Parameters:
aInToken A buffer containing the input token (e.g., a challenge from a server). This may be null.
aInTokenLength The length of the input token.
aOutToken If getNextToken succeeds, then aOutToken will point to a buffer to be sent in response to the server challenge. The length of this buffer is given by aOutTokenLength. The buffer at aOutToken must be recycled with a call to nsMemory::Free.
aOutTokenLength If getNextToken succeeds, then aOutTokenLength contains the length of the buffer (number of bytes) pointed to by aOutToken.
void nsIAuthModule::init ( in string  aServiceName,
in unsigned long  aServiceFlags,
in wstring  aDomain,
in wstring  aUsername,
in wstring  aPassword 
)

Other flags may be defined in the future.

Called to initialize an auth module. The other methods cannot be called unless this method succeeds.

Parameters:
aServiceName the service name, which may be null if not applicable (e.g., for NTLM, this parameter should be null).
aServiceFlags a bitwise-or of the REQ_ flags defined above (pass REQ_DEFAULT for default behavior).
aDomain the authentication domain, which may be null if not applicable.
aUsername the user's login name
aPassword the user's password
void nsIAuthModule::unwrap ( [const ] in voidPtr  aInToken,
in unsigned long  aInTokenLength,
out voidPtr  aOutToken,
out unsigned long  aOutTokenLength 
)

Unwrap() is used to unpack, decrypt, and verify the checksums on data returned by a server when security layers are in use.

Parameters:
aInToken A buffer containing the data received from the server
aInTokenLength The length of the input token
aOutToken A buffer containing the plaintext data from the server
aOutTokenLength The length of the output token buffer

Unwrap() may return NS_ERROR_NOT_IMPLEMENTED, if the underlying authentication mechanism does not support security layers.

void nsIAuthModule::wrap ( [const ] in voidPtr  aInToken,
in unsigned long  aInTokenLength,
in boolean  confidential,
out voidPtr  aOutToken,
out unsigned long  aOutTokenLength 
)

Once a security context has been established through calls to GetNextToken() it may be used to protect data exchanged between client and server.

Calls to Wrap() are used to protect items of data to be sent to the server.

Parameters:
aInToken A buffer containing the data to be sent to the server
aInTokenLength The length of the input token
confidential If set to true, Wrap() will encrypt the data, otherwise data will just be integrity protected (checksummed)
aOutToken A buffer containing the resulting data to be sent to the server
aOutTokenLength The length of the output token buffer

Wrap() may return NS_ERROR_NOT_IMPLEMENTED, if the underlying authentication mechanism does not support security layers.


Member Data Documentation

const unsigned long nsIAuthModule::REQ_DEFAULT = 0

Default behavior.

const unsigned long nsIAuthModule::REQ_DELEGATE = (1 << 1)

The server is allowed to impersonate the client.

The REQ_MUTUAL_AUTH flag may also need to be specified in order for this flag to take effect.

const unsigned long nsIAuthModule::REQ_MUTUAL_AUTH = (1 << 0)

Client and server will be authenticated.


The documentation for this interface was generated from the following file: