Package com.unboundid.ldap.sdk.unboundidds

Class UnboundIDTOTPBindRequest

java.lang.Object
com.unboundid.ldap.sdk.LDAPRequest
com.unboundid.ldap.sdk.BindRequest
com.unboundid.ldap.sdk.SASLBindRequest
com.unboundid.ldap.sdk.unboundidds.UnboundIDTOTPBindRequest
All Implemented Interfaces:
ReadOnlyLDAPRequest, Serializable
Direct Known Subclasses:
ReusableTOTPBindRequest, SingleUseTOTPBindRequest
@NotExtensible @ThreadSafety(level=NOT_THREADSAFE) public abstract class UnboundIDTOTPBindRequest extends SASLBindRequest
This class provides support for an UnboundID-proprietary SASL mechanism that uses the time-based one-time password mechanism (TOTP) as described in RFC 6238, optionally (based on the server configuration) in conjunction with a static password for a form of multifactor authentication.
NOTE: This class, and other classes within the com.unboundid.ldap.sdk.unboundidds package structure, are only supported for use against Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 server products. These classes provide support for proprietary functionality or for external specifications that are not considered stable or mature enough to be guaranteed to work in an interoperable way with other types of LDAP servers.

The name for this SASL mechanism is "UNBOUNDID-TOTP". An UNBOUNDID-TOTP SASL bind request MUST include SASL credentials with the following ASN.1 encoding: 

 UnboundIDTOTPCredentials ::= SEQUENCE {
   authenticationID  [0] OCTET STRING,
   authorizationID   [1] OCTET STRING OPTIONAL,
   totpPassword      [2] OCTET STRING,
   staticPassword    [3] OCTET STRING OPTIONAL }


Note that this class is abstract, with two different concrete implementations: the SingleUseTOTPBindRequest class may be used for cases in which the one-time password will be obtained from an external source (e.g., provided by the user, perhaps using the Google Authenticator application), and the ReusableTOTPBindRequest class may be used for cases in which the one-time password should be generated by the LDAP SDK itself. Because the SingleUseTOTPBindRequest class contains a point-in-time password, it cannot be used for re-authentication (e.g., for use with a connection pool, following referrals, or with the auto-reconnect feature). If TOTP authentication should be used in contexts where one or more of these may be needed, then the dynamic variant should be used.
See Also:

  • Field Details

  • Constructor Details

    • UnboundIDTOTPBindRequest

      protected UnboundIDTOTPBindRequest(@NotNull String authenticationID, @Nullable String authorizationID, @Nullable String staticPassword, @Nullable Control... controls)
      Creates a new TOTP bind request with the provided information.
      Parameters:
      authenticationID - The authentication identity for the bind request. It must not be null, and must be in the form "u:" followed by a username, or "dn:" followed by a DN.
      authorizationID - The authorization identity for the bind request. It may be null if the authorization identity should be the same as the authentication identity. If an authorization identity is specified, it must be in the form "u:" followed by a username, or "dn:" followed by a DN. The value "dn:" may indicate an authorization identity of the anonymous user.
      staticPassword - The static password for the target user. It may be null if only the one-time password is to be used for authentication (which may or may not be allowed by the server).
      controls - The set of controls to include in the bind request.

    • UnboundIDTOTPBindRequest

      protected UnboundIDTOTPBindRequest(@NotNull String authenticationID, @Nullable String authorizationID, @Nullable byte[] staticPassword, @Nullable Control... controls)
      Creates a new TOTP bind request with the provided information.
      Parameters:
      authenticationID - The authentication identity for the bind request. It must not be null, and must be in the form "u:" followed by a username, or "dn:" followed by a DN.
      authorizationID - The authorization identity for the bind request. It may be null if the authorization identity should be the same as the authentication identity. If an authorization identity is specified, it must be in the form "u:" followed by a username, or "dn:" followed by a DN. The value "dn:" may indicate an authorization identity of the anonymous user.
      staticPassword - The static password for the target user. It may be null if only the one-time password is to be used for authentication (which may or may not be allowed by the server).
      controls - The set of controls to include in the bind request.

    • UnboundIDTOTPBindRequest

      protected UnboundIDTOTPBindRequest(@NotNull String authenticationID, @Nullable String authorizationID, @Nullable ASN1OctetString staticPassword, @Nullable Control... controls)
      Creates a new TOTP bind request with the provided information.
      Parameters:
      authenticationID - The authentication identity for the bind request. It must not be null, and must be in the form "u:" followed by a username, or "dn:" followed by a DN.
      authorizationID - The authorization identity for the bind request. It may be null if the authorization identity should be the same as the authentication identity. If an authorization identity is specified, it must be in the form "u:" followed by a username, or "dn:" followed by a DN. The value "dn:" may indicate an authorization identity of the anonymous user.
      staticPassword - The static password for the target user. It may be null if only the one-time password is to be used for authentication (which may or may not be allowed by the server). If it is non-null, then it must have the appropriate BER type.
      controls - The set of controls to include in the bind request.

  • Method Details

    • getAuthenticationID

      @NotNull public final String getAuthenticationID()
      Retrieves the authentication ID for the bind request.
      Returns:
      The authentication ID for the bind request.

    • getAuthorizationID

      @Nullable public final String getAuthorizationID()
      Retrieves the authorization ID for the bind request, if one was provided.
      Returns:
      The authorization ID for the bind request, or null if the authorization ID should be the same as the authentication ID.

    • getStaticPassword

      @Nullable public final ASN1OctetString getStaticPassword()
      Retrieves the static password for the bind request, if one was provided.
      Returns:
      The static password for the bind request, or null if no static password was provided and only the one-time password should be used for authentication.

    • getSASLMechanismName

      @NotNull public final 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.

    • process

      @NotNull protected final BindResult process(@NotNull 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.

    • getSASLCredentials

      @NotNull protected abstract ASN1OctetString getSASLCredentials() throws LDAPException
      Retrieves the encoded SASL credentials that may be included in an UNBOUNDID-TOTP SASL bind request.
      Returns:
      The encoded SASL credentials that may be included in an UNBOUNDID-TOTP SASL bind request.
      Throws:
      LDAPException - If a problem is encountered while attempting to obtain the encoded credentials.

    • encodeCredentials

      @NotNull public static ASN1OctetString encodeCredentials(@NotNull String authenticationID, @Nullable String authorizationID, @NotNull String totpPassword, @Nullable ASN1OctetString staticPassword)
      Encodes the provided information in a form suitable for inclusion in an UNBOUNDID-TOTP SASL bind request.
      Parameters:
      authenticationID - The authentication identity for the bind request. It must not be null, and must be in the form "u:" followed by a username, or "dn:" followed by a DN.
      authorizationID - The authorization identity for the bind request. It may be null if the authorization identity should be the same as the authentication identity. If an authorization identity is specified, it must be in the form "u:" followed by a username, or "dn:" followed by a DN. The value "dn:" may indicate an authorization identity of the anonymous user.
      totpPassword - The TOTP password to include in the bind request. It must not be null.
      staticPassword - The static password for the target user. It may be null if only the one-time password is to be used for authentication (which may or may not be allowed by the server).
      Returns:
      The encoded SASL credentials.

    • getLastMessageID

      public final 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.

    • toString

      public final void toString(@NotNull 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.