Class CRAMMD5BindRequest

  • All Implemented Interfaces:
    ReadOnlyLDAPRequest, java.io.Serializable, javax.security.auth.callback.CallbackHandler

    @NotMutable
    @ThreadSafety(level=NOT_THREADSAFE)
    public final class CRAMMD5BindRequest
    extends SASLBindRequest
    implements javax.security.auth.callback.CallbackHandler
    This class provides a SASL CRAM-MD5 bind request implementation as described in draft-ietf-sasl-crammd5. The CRAM-MD5 mechanism can be used to authenticate over an insecure channel without exposing the credentials (although it requires that the server have access to the clear-text password). It is similar to DIGEST-MD5, but does not provide as many options, and provides slightly weaker protection because the client does not contribute any of the random data used during bind processing.

    Elements included in a CRAM-MD5 bind request include:
    • Authentication ID -- A string which identifies the user that is attempting to authenticate. It should be an "authzId" value as described in section 5.2.1.8 of RFC 4513. That is, it should be either "dn:" followed by the distinguished name of the target user, or "u:" followed by the username. If the "u:" form is used, then the mechanism used to resolve the provided username to an entry may vary from server to server.
    • Password -- The clear-text password for the target user.

    Example

    The following example demonstrates the process for performing a CRAM-MD5 bind against a directory server with a username of "john.doe" and a password of "password":
     CRAMMD5BindRequest bindRequest =
          new CRAMMD5BindRequest("u:john.doe", "password");
     BindResult bindResult;
     try
     {
       bindResult = connection.bind(bindRequest);
       // If we get here, then the bind was successful.
     }
     catch (LDAPException le)
     {
       // The bind failed for some reason.
       bindResult = new BindResult(le.toLDAPResult());
       ResultCode resultCode = le.getResultCode();
       String errorMessageFromServer = le.getDiagnosticMessage();
     }
     
    See Also:
    Serialized Form
    • Constructor Detail

      • CRAMMD5BindRequest

        public CRAMMD5BindRequest​(java.lang.String authenticationID,
                                  java.lang.String password)
        Creates a new SASL CRAM-MD5 bind request with the provided authentication ID and password. It will not include any controls.
        Parameters:
        authenticationID - The authentication ID for this bind request. It must not be null.
        password - The password for this bind request. It must not be null.
      • CRAMMD5BindRequest

        public CRAMMD5BindRequest​(java.lang.String authenticationID,
                                  byte[] password)
        Creates a new SASL CRAM-MD5 bind request with the provided authentication ID and password. It will not include any controls.
        Parameters:
        authenticationID - The authentication ID for this bind request. It must not be null.
        password - The password for this bind request. It must not be null.
      • CRAMMD5BindRequest

        public CRAMMD5BindRequest​(java.lang.String authenticationID,
                                  ASN1OctetString password)
        Creates a new SASL CRAM-MD5 bind request with the provided authentication ID and password. It will not include any controls.
        Parameters:
        authenticationID - The authentication ID for this bind request. It must not be null.
        password - The password for this bind request. It must not be null.
      • CRAMMD5BindRequest

        public CRAMMD5BindRequest​(java.lang.String authenticationID,
                                  java.lang.String password,
                                  Control... controls)
        Creates a new SASL CRAM-MD5 bind request with the provided authentication ID, password, and set of controls.
        Parameters:
        authenticationID - The authentication ID for this bind request. It must not be null.
        password - The password for this bind request. It must not be null.
        controls - The set of controls to include in the request.
      • CRAMMD5BindRequest

        public CRAMMD5BindRequest​(java.lang.String authenticationID,
                                  byte[] password,
                                  Control... controls)
        Creates a new SASL CRAM-MD5 bind request with the provided authentication ID, password, and set of controls.
        Parameters:
        authenticationID - The authentication ID for this bind request. It must not be null.
        password - The password for this bind request. It must not be null.
        controls - The set of controls to include in the request.
      • CRAMMD5BindRequest

        public CRAMMD5BindRequest​(java.lang.String authenticationID,
                                  ASN1OctetString password,
                                  Control... controls)
        Creates a new SASL CRAM-MD5 bind request with the provided authentication ID, password, and set of controls.
        Parameters:
        authenticationID - The authentication ID for this bind request. It must not be null.
        password - The password for this bind request. It must not be null.
        controls - The set of controls to include in the request.
    • Method Detail

      • getSASLMechanismName

        public java.lang.String getSASLMechanismName()
        Retrieves the name of the SASL mechanism used in this SASL bind request.
        Specified by:
        getSASLMechanismName in class SASLBindRequest
        Returns:
        The name of the SASL mechanism used in this SASL bind request.
      • getAuthenticationID

        public java.lang.String getAuthenticationID()
        Retrieves the authentication ID for this bind request.
        Returns:
        The authentication ID for this bind request.
      • getPasswordString

        public java.lang.String getPasswordString()
        Retrieves the string representation of the password for this bind request.
        Returns:
        The string representation of the password for this bind request.
      • getPasswordBytes

        public byte[] getPasswordBytes()
        Retrieves the bytes that comprise the the password for this bind request.
        Returns:
        The bytes that comprise the password for this bind request.
      • process

        protected BindResult process​(LDAPConnection connection,
                                     int depth)
                              throws LDAPException
        Sends this bind request to the target server over the provided connection and returns the corresponding response.
        Specified by:
        process in class BindRequest
        Parameters:
        connection - The connection to use to send this bind request to the server and read the associated response.
        depth - The current referral depth for this request. It should always be one for the initial request, and should only be incremented when following referrals.
        Returns:
        The bind response read from the server.
        Throws:
        LDAPException - If a problem occurs while sending the request or reading the response.
      • getRebindRequest

        public CRAMMD5BindRequest getRebindRequest​(java.lang.String host,
                                                   int port)
        Retrieves a bind request that may be used to re-bind using the same credentials authentication type and credentials as previously used to perform the initial bind. This may be used in an attempt to automatically re-establish a connection that is lost, or potentially when following a referral to another directory instance.

        It is recommended that all bind request types which implement this capability be implemented so that the elements needed to create a new request are immutable. If this is not done, then changes made to a bind request object may alter the authentication/authorization identity and/or credentials associated with that request so that a rebind request created from it will not match the original request used to authenticate on a connection.
        Overrides:
        getRebindRequest in class BindRequest
        Parameters:
        host - The address of the directory server to which the connection is established.
        port - The port of the directory server to which the connection is established.
        Returns:
        A bind request that may be used to re-bind using the same authentication type and credentials as previously used to perform the initial bind, or null to indicate that automatic re-binding is not supported for this type of bind request.
      • handle

        @InternalUseOnly
        public void handle​(javax.security.auth.callback.Callback[] callbacks)
        Handles any necessary callbacks required for SASL authentication.
        Specified by:
        handle in interface javax.security.auth.callback.CallbackHandler
        Parameters:
        callbacks - The set of callbacks to be handled.
      • getLastMessageID

        public int getLastMessageID()
        Retrieves the message ID for the last LDAP message sent using this request.
        Overrides:
        getLastMessageID in class SASLBindRequest
        Returns:
        The message ID for the last LDAP message sent using this request, or -1 if it no LDAP messages have yet been sent using this request.
      • duplicate

        public CRAMMD5BindRequest duplicate​(Control[] controls)
        Creates a new instance of this LDAP request that may be modified without impacting this request. The provided controls will be used for the new request instead of duplicating the controls from this request.
        Specified by:
        duplicate in interface ReadOnlyLDAPRequest
        Specified by:
        duplicate in class BindRequest
        Parameters:
        controls - The set of controls to include in the duplicate request.
        Returns:
        A new instance of this LDAP request that may be modified without impacting this request.
      • toString

        public void toString​(java.lang.StringBuilder buffer)
        Appends a string representation of this request to the provided buffer.
        Specified by:
        toString in interface ReadOnlyLDAPRequest
        Specified by:
        toString in class LDAPRequest
        Parameters:
        buffer - The buffer to which to append a string representation of this request.
      • toCode

        public void toCode​(java.util.List<java.lang.String> lineList,
                           java.lang.String requestID,
                           int indentSpaces,
                           boolean includeProcessing)
        Appends a number of lines comprising the Java source code that can be used to recreate this request to the given list.
        Specified by:
        toCode in interface ReadOnlyLDAPRequest
        Overrides:
        toCode in class SASLBindRequest
        Parameters:
        lineList - The list to which the source code lines should be added.
        requestID - The name that should be used as an identifier for the request. If this is null or empty, then a generic ID will be used.
        indentSpaces - The number of spaces that should be used to indent the generated code. It must not be negative.
        includeProcessing - Indicates whether the generated code should include code required to actually process the request and handle the result (if true), or just to generate the request (if false).