|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.ldap.sdk.LDAPRequest
com.unboundid.ldap.sdk.BindRequest
com.unboundid.ldap.sdk.SASLBindRequest
com.unboundid.ldap.sdk.unboundidds.UnboundIDTOTPBindRequest
com.unboundid.ldap.sdk.unboundidds.SingleUseTOTPBindRequest
@NotMutable @ThreadSafety(level=NOT_THREADSAFE) public final class SingleUseTOTPBindRequest
NOTE: This class is part of the Commercial Edition of the UnboundID LDAP SDK for Java. It is not available for use in applications that include only the Standard Edition of the LDAP SDK, and is not supported for use in conjunction with non-UnboundID products.This class provides an implementation of the UNBOUNDID-TOTP SASL bind request that contains a point-in-time version of the one-time password and can be used for a single bind but is not suitable for repeated use. This version of the bind request should be used for authentication in which the one-time password is provided by an external source rather than being generated by the LDAP SDK.
ReusableTOTPBindRequest
class)
which generates the one-time password should be used instead.
Field Summary |
---|
Fields inherited from class com.unboundid.ldap.sdk.unboundidds.UnboundIDTOTPBindRequest |
---|
UNBOUNDID_TOTP_MECHANISM_NAME |
Fields inherited from class com.unboundid.ldap.sdk.SASLBindRequest |
---|
CRED_TYPE_SASL |
Fields inherited from class com.unboundid.ldap.sdk.BindRequest |
---|
VERSION_ELEMENT |
Constructor Summary | |
---|---|
SingleUseTOTPBindRequest(java.lang.String authenticationID,
java.lang.String authorizationID,
java.lang.String totpPassword,
byte[] staticPassword,
Control... controls)
Creates a new SASL TOTP bind request with the provided information. |
|
SingleUseTOTPBindRequest(java.lang.String authenticationID,
java.lang.String authorizationID,
java.lang.String totpPassword,
java.lang.String staticPassword,
Control... controls)
Creates a new SASL TOTP bind request with the provided information. |
Method Summary | |
---|---|
static SingleUseTOTPBindRequest |
decodeSASLCredentials(ASN1OctetString saslCredentials,
Control... controls)
Creates a new single-use TOTP bind request from the information contained in the provided encoded SASL credentials. |
SingleUseTOTPBindRequest |
duplicate()
Creates a new instance of this LDAP request that may be modified without impacting this request. |
SingleUseTOTPBindRequest |
duplicate(Control[] controls)
Creates a new instance of this LDAP request that may be modified without impacting this request. |
SingleUseTOTPBindRequest |
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. |
protected ASN1OctetString |
getSASLCredentials()
Retrieves the encoded SASL credentials that may be included in an UNBOUNDID-TOTP SASL bind request. |
java.lang.String |
getTOTPPassword()
Retrieves the hard-coded TOTP password to include in the bind request. |
Methods inherited from class com.unboundid.ldap.sdk.unboundidds.UnboundIDTOTPBindRequest |
---|
encodeCredentials, getAuthenticationID, getAuthorizationID, getLastMessageID, getSASLMechanismName, getStaticPassword, process, toString |
Methods inherited from class com.unboundid.ldap.sdk.SASLBindRequest |
---|
getBindType, responseReceived, sendBindRequest, sendMessage |
Methods inherited from class com.unboundid.ldap.sdk.BindRequest |
---|
getOperationType |
Methods inherited from class com.unboundid.ldap.sdk.LDAPRequest |
---|
followReferrals, getControl, getControlList, getControls, getIntermediateResponseListener, getResponseTimeoutMillis, hasControl, hasControl, setFollowReferrals, setIntermediateResponseListener, setResponseTimeoutMillis, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public SingleUseTOTPBindRequest(java.lang.String authenticationID, java.lang.String authorizationID, java.lang.String totpPassword, java.lang.String staticPassword, Control... controls)
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 hard-coded 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).controls
- The set of controls to include in the bind
request.public SingleUseTOTPBindRequest(java.lang.String authenticationID, java.lang.String authorizationID, java.lang.String totpPassword, byte[] staticPassword, Control... controls)
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 hard-coded 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).controls
- The set of controls to include in the bind
request.Method Detail |
---|
public static SingleUseTOTPBindRequest decodeSASLCredentials(ASN1OctetString saslCredentials, Control... controls) throws LDAPException
saslCredentials
- The encoded SASL credentials to be decoded in
order to create this single-use TOTP bind request.
It must not be null
.controls
- The set of controls to include in the bind
request.
LDAPException
- If the provided credentials are not valid for an
UNBOUNDID-TOTP bind request.public java.lang.String getTOTPPassword()
protected ASN1OctetString getSASLCredentials()
getSASLCredentials
in class UnboundIDTOTPBindRequest
public SingleUseTOTPBindRequest getRebindRequest(java.lang.String host, int port)
getRebindRequest
in class BindRequest
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.
null
to indicate that automatic
re-binding is not supported for this type of bind request.public SingleUseTOTPBindRequest duplicate()
duplicate
in interface ReadOnlyLDAPRequest
duplicate
in class BindRequest
public SingleUseTOTPBindRequest duplicate(Control[] controls)
duplicate
in interface ReadOnlyLDAPRequest
duplicate
in class BindRequest
controls
- The set of controls to include in the duplicate request.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |