Struct xpcom::interfaces::nsIAuthModule [−] [src]

#[repr(C)]

pub struct nsIAuthModule { /* fields omitted */ }

interface nsIAuthModule : nsISupports

Methods

impl nsIAuthModule
[src]

[src]

Cast this nsIAuthModule to one of its base interfaces.

impl nsIAuthModule
[src]

REQ_DEFAULT: i64 = 0
/**
     * Default behavior.
     */


REQ_MUTUAL_AUTH: i64 = 1
/**
     * Client and server will be authenticated.
     */


REQ_DELEGATE: i64 = 2
/**
     * 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.
     */


REQ_PROXY_AUTH: i64 = 4
/**
     * The authentication is required for a proxy connection.
     */


NTLM_MODULE_SAMBA_AUTH_PROXY: i64 = 0
/**
     * Flags used for telemetry.
     */


NTLM_MODULE_SAMBA_AUTH_DIRECT: i64 = 1

NTLM_MODULE_WIN_API_PROXY: i64 = 2

NTLM_MODULE_WIN_API_DIRECT: i64 = 3

NTLM_MODULE_GENERIC_PROXY: i64 = 4

NTLM_MODULE_GENERIC_DIRECT: i64 = 5

NTLM_MODULE_KERBEROS_PROXY: i64 = 6

NTLM_MODULE_KERBEROS_DIRECT: i64 = 7

[src]

/** Other flags may be defined in the future */
/**
     * Called to initialize an auth module.  The other methods cannot be called
     * unless this method succeeds.
     *
     * @param aServiceName
     *        the service name, which may be null if not applicable (e.g., for
     *        NTLM, this parameter should be null).
     * @param aServiceFlags
     *        a bitwise-or of the REQ_ flags defined above (pass REQ_DEFAULT
     *        for default behavior).
     * @param aDomain
     *        the authentication domain, which may be null if not applicable.
     * @param aUsername
     *        the user's login name
     * @param aPassword
     *        the user's password
     */

void init (in string aServiceName, in unsigned long aServiceFlags, in wstring aDomain, in wstring aUsername, in wstring aPassword);

[src]

/**
     * Called to get the next token in a sequence of authentication steps.
     *
     * @param aInToken
     *        A buffer containing the input token (e.g., a challenge from a
     *        server).  This may be null.
     * @param aInTokenLength
     *        The length of the input token.
     * @param 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 free.
     * @param aOutTokenLength
     *        If getNextToken succeeds, then aOutTokenLength contains the
     *        length of the buffer (number of bytes) pointed to by aOutToken.
     */

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

[src]

/**
     * 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.
     *
     * @param aInToken
     *        A buffer containing the data to be sent to the server
     * @param aInTokenLength
     *        The length of the input token
     * @param confidential
     *        If set to true, Wrap() will encrypt the data, otherwise data will
     *        just be integrity protected (checksummed)
     * @param aOutToken
     *        A buffer containing the resulting data to be sent to the server
     * @param 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.
     */

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

[src]

/**
     * Unwrap() is used to unpack, decrypt, and verify the checksums on data
     * returned by a server when security layers are in use.
     *
     * @param aInToken
     *        A buffer containing the data received from the server
     * @param aInTokenLength
     *        The length of the input token
     * @param aOutToken
     *        A buffer containing the plaintext data from the server
     * @param 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 unwrap ([const] in voidPtr aInToken, in unsigned long aInTokenLength, out voidPtr aOutToken, out unsigned long aOutTokenLength);

Methods from Deref<Target = nsISupports>

[src]

Cast this nsISupports to one of its base interfaces.

[src]

void QueryInterface (in nsIIDRef uuid, [iid_is (uuid), retval] out nsQIResult result);

[src]

[noscript,notxpcom] nsrefcnt AddRef ();

[src]

[noscript,notxpcom] nsrefcnt Release ();

Trait Implementations

impl XpCom for nsIAuthModule
[src]

IID: nsIID = nsID(1849023424, 18927, 20012, [177, 234, 183, 46, 198, 68, 80, 162])

[src]

Perform a QueryInterface call on this object, attempting to dynamically cast it to the requested interface type. Returns Some(RefPtr) if the cast succeeded, and None otherwise. Read more

impl RefCounted for nsIAuthModule
[src]

[src]

Increment the reference count.

[src]

Decrement the reference count, potentially freeing backing memory.

impl Deref for nsIAuthModule
[src]

The resulting type after dereferencing.

[src]

Dereferences the value.