/* * CDDL HEADER START * * The contents of this file are subject to the terms of the * Common Development and Distribution License, Version 1.0 only * (the "License"). You may not use this file except in compliance * with the License. * * You can obtain a copy of the license at * trunk/opends/resource/legal-notices/OpenDS.LICENSE * or https://OpenDS.dev.java.net/OpenDS.LICENSE. * See the License for the specific language governing permissions * and limitations under the License. * * When distributing Covered Code, include this CDDL HEADER in each * file and include the License file at * trunk/opends/resource/legal-notices/OpenDS.LICENSE. If applicable, * add the following below this CDDL HEADER, with the fields enclosed * by brackets "[]" replaced with your own identifying information: * Portions Copyright [yyyy] [name of copyright owner] * * CDDL HEADER END * * * Copyright 2010 Sun Microsystems, Inc. */ package org.opends.sdk.requests; import java.util.List; import java.util.Map; import org.opends.sdk.*; import org.opends.sdk.controls.Control; import org.opends.sdk.controls.ControlDecoder; /** * The DIGEST-MD5 SASL bind request as defined in RFC 2831. This SASL mechanism * allows a client to perform a challenge-response authentication method, * similar to HTTP Digest Access Authentication. This mechanism can be used to * negotiate integrity and/or privacy protection for the underlying connection. *

* Compared to CRAM-MD5, DIGEST-MD5 prevents chosen plain-text attacks, and * permits the use of third party authentication servers, mutual authentication, * and optimized re-authentication if a client has recently authenticated to a * server. *

* The authentication and optional authorization identity is specified using an * authorization ID, or {@code authzId}, as defined in RFC 4513 section 5.2.1.8. * * @see RFC 2831 - Using Digest * Authentication as a SASL Mechanism * @see RFC 4513 - * SASL Authorization Identities (authzId) */ public interface DigestMD5SASLBindRequest extends SASLBindRequest { /** * The name of the SASL mechanism based on DIGEST-MD5 authentication. */ public static final String SASL_MECHANISM_NAME = "DIGEST-MD5"; /** * Indicates that the client will accept authentication only. More * specifically, the underlying connection will not be protected using * integrity protection or encryption, unless previously established using * SSL/TLS. This is the default if no QOP option is present in the bind * request. */ public static final String QOP_AUTH = "auth"; /** * Indicates that the client will accept authentication with connection * integrity protection. More specifically, the underlying connection will not * be encrypted, unless previously established using SSL/TLS. */ public static final String QOP_AUTH_INT = "auth-int"; /** * Indicates that the client will accept authentication with connection * integrity protection and encryption. */ public static final String QOP_AUTH_CONF = "auth-conf"; /** * Indicates that the client will accept connection encryption using the high * strength triple-DES cipher. */ public static final String CIPHER_3DES = "3des"; /** * Indicates that the client will accept connection encryption using the high * strength 128-bit RC4 cipher. */ public static final String CIPHER_RC4_128 = "rc4"; /** * Indicates that the client will accept connection encryption using the * medium strength DES cipher. */ public static final String CIPHER_DES = "des"; /** * Indicates that the client will accept connection encryption using the * medium strength 56-bit RC4 cipher. */ public static final String CIPHER_RC4_56 = "rc4-56"; /** * Indicates that the client will accept connection encryption using the low * strength 40-bit RC4 cipher. */ public static final String CIPHER_RC4_40 = "rc4-40"; /** * Indicates that the client will accept connection encryption using the * strongest supported cipher, as long as the cipher is considered to be high * strength. */ public static final String CIPHER_HIGH = "high"; /** * Indicates that the client will accept connection encryption using the * strongest supported cipher, as long as the cipher is considered to be high * or medium strength. */ public static final String CIPHER_MEDIUM = "medium"; /** * Indicates that the client will accept connection encryption using the * strongest supported cipher, even if the strongest cipher is considered to * be medium or low strength. */ public static final String CIPHER_LOW = "low"; /** * Adds the provided additional authentication parameter to the list of * parameters to be passed to the underlying mechanism implementation. This * method is provided in order to allow for future extensions. * * @param name * The name of the additional authentication parameter. * @param value * The value of the additional authentication parameter. * @return This bind request. * @throws UnsupportedOperationException * If this bind request does not permit additional authentication * parameters to be added. * @throws NullPointerException * If {@code name} or {@code value} was {@code null}. */ DigestMD5SASLBindRequest addAdditionalAuthParam(String name, String value) throws UnsupportedOperationException, NullPointerException; /** * {@inheritDoc} */ @Override DigestMD5SASLBindRequest addControl(Control control) throws UnsupportedOperationException, NullPointerException; /** * Adds the provided quality of protection (QOP) values to the ordered list of * QOP values that the client is willing to accept. The order of the list * specifies the preference order, high to low. Authentication will fail if no * QOP values are recognized or accepted by the server. *

* By default the client will accept {@link #QOP_AUTH AUTH}. * * @param qopValues * The quality of protection values that the client is willing to * accept. * @return This bind request. * @throws UnsupportedOperationException * If this bind request does not permit QOP values to be added. * @throws NullPointerException * If {@code qopValues} was {@code null}. * @see #QOP_AUTH * @see #QOP_AUTH_INT * @see #QOP_AUTH_CONF */ DigestMD5SASLBindRequest addQOP(String... qopValues) throws UnsupportedOperationException, NullPointerException; /** * {@inheritDoc} */ @Override BindClient createBindClient(String serverName) throws ErrorResultException; /** * Returns a map containing the provided additional authentication parameters * to be passed to the underlying mechanism implementation. This method is * provided in order to allow for future extensions. * * @return A map containing the provided additional authentication parameters * to be passed to the underlying mechanism implementation. */ Map getAdditionalAuthParams(); /** * Returns the authentication ID of the user. The authentication ID usually * has the form "dn:" immediately followed by the distinguished name of the * user, or "u:" followed by a user ID string, but other forms are permitted. * * @return The authentication ID of the user. */ String getAuthenticationID(); /** * Returns the authentication mechanism identifier for this SASL bind request * as defined by the LDAP protocol, which is always {@code 0xA3}. * * @return The authentication mechanism identifier. */ @Override byte getAuthenticationType(); /** * Returns the optional authorization ID of the user which represents an * alternate authorization identity which should be used for subsequent * operations performed on the connection. The authorization ID usually has * the form "dn:" immediately followed by the distinguished name of the user, * or "u:" followed by a user ID string, but other forms are permitted. * * @return The authorization ID of the user, which may be {@code null}. */ String getAuthorizationID(); /** * Returns the cipher name or strength that the client is willing to use when * connection encryption quality of protection, {@link #QOP_AUTH_CONF * AUTH-CONF}, is requested. *

* By default the client will accept connection encryption using the strongest * supported cipher, even if the strongest cipher is considered to be medium * or low strength. This is equivalent to {@link #CIPHER_LOW}. * * @return The cipher that the client is willing to use if connection * encryption QOP is negotiated. May be {@code null}, indicating that * the default cipher should be used. */ String getCipher(); /** * {@inheritDoc} */ @Override C getControl(ControlDecoder decoder, DecodeOptions options) throws NullPointerException, DecodeException; /** * {@inheritDoc} */ @Override List getControls(); /** * Returns the maximum size of the receive buffer in bytes. The actual maximum * number of bytes will be the minimum of this number and the peer's maximum * send buffer size. The default size is 65536. * * @return The maximum size of the receive buffer in bytes. */ int getMaxReceiveBufferSize(); /** * Returns the maximum size of the send buffer in bytes. The actual maximum * number of bytes will be the minimum of this number and the peer's maximum * receive buffer size. The default size is 65536. * * @return The maximum size of the send buffer in bytes. */ int getMaxSendBufferSize(); /** * Returns the name of the Directory object that the client wishes to bind as, * which is always the empty string for SASL authentication. * * @return The name of the Directory object that the client wishes to bind as. */ @Override String getName(); /** * Returns the password of the user that the client wishes to bind as. * * @return The password of the user that the client wishes to bind as. */ ByteString getPassword(); /** * Returns the ordered list of quality of protection (QOP) values that the * client is willing to accept. The order of the list specifies the preference * order, high to low. Authentication will fail if no QOP values are * recognized or accepted by the server. *

* By default the client will accept {@link #QOP_AUTH AUTH}. * * @return The list of quality of protection values that the client is willing * to accept. The returned list may be empty indicating that the * default QOP will be accepted. */ List getQOPs(); /** * Returns the optional realm containing the user's account. * * @return The name of the realm containing the user's account, which may be * {@code null}. */ String getRealm(); /** * {@inheritDoc} */ @Override String getSASLMechanism(); /** * Returns {@code true} if the server must authenticate to the client. The * default is {@code false}. * * @return {@code true} if the server must authenticate to the client. */ boolean isServerAuth(); /** * Sets the authentication ID of the user. The authentication ID usually has * the form "dn:" immediately followed by the distinguished name of the user, * or "u:" followed by a user ID string, but other forms are permitted. * * @param authenticationID * The authentication ID of the user. * @return This bind request. * @throws LocalizedIllegalArgumentException * If {@code authenticationID} was non-empty and did not contain a * valid authorization ID type. * @throws UnsupportedOperationException * If this bind request does not permit the authentication ID to be * set. * @throws NullPointerException * If {@code authenticationID} was {@code null}. */ DigestMD5SASLBindRequest setAuthenticationID(String authenticationID) throws LocalizedIllegalArgumentException, UnsupportedOperationException, NullPointerException; /** * Sets the optional authorization ID of the user which represents an * alternate authorization identity which should be used for subsequent * operations performed on the connection. The authorization ID usually has * the form "dn:" immediately followed by the distinguished name of the user, * or "u:" followed by a user ID string, but other forms are permitted. * * @param authorizationID * The authorization ID of the user, which may be {@code null}. * @return This bind request. * @throws LocalizedIllegalArgumentException * If {@code authorizationID} was non-empty and did not contain a * valid authorization ID type. * @throws UnsupportedOperationException * If this bind request does not permit the authorization ID to be * set. */ DigestMD5SASLBindRequest setAuthorizationID(String authorizationID) throws LocalizedIllegalArgumentException, UnsupportedOperationException; /** * Sets the cipher name or strength that the client is willing to use when * connection encryption quality of protection, {@link #QOP_AUTH_CONF * AUTH-CONF}, is requested. *

* By default the client will accept connection encryption using the strongest * supported cipher, even if the strongest cipher is considered to be medium * or low strength. This is equivalent to {@link #CIPHER_LOW}. * * @param cipher * The cipher that the client is willing to use if connection * encryption QOP is negotiated. May be {@code null}, indicating that * the default cipher should be used. * @return This bind request. * @throws UnsupportedOperationException * If this bind request does not permit the cipher name or strength * to be set. * @see #QOP_AUTH_CONF * @see #CIPHER_3DES * @see #CIPHER_RC4_128 * @see #CIPHER_DES * @see #CIPHER_RC4_56 * @see #CIPHER_RC4_40 * @see #CIPHER_HIGH * @see #CIPHER_MEDIUM * @see #CIPHER_LOW */ DigestMD5SASLBindRequest setCipher(String cipher) throws UnsupportedOperationException; /** * Sets the maximum size of the receive buffer in bytes. The actual maximum * number of bytes will be the minimum of this number and the peer's maximum * send buffer size. The default size is 65536. * * @param size * The maximum size of the receive buffer in bytes. * @return This bind request. * @throws UnsupportedOperationException * If this bind request does not permit the buffer size to be set. */ DigestMD5SASLBindRequest setMaxReceiveBufferSize(int size) throws UnsupportedOperationException; /** * Sets the maximum size of the send buffer in bytes. The actual maximum * number of bytes will be the minimum of this number and the peer's maximum * receive buffer size. The default size is 65536. * * @param size * The maximum size of the send buffer in bytes. * @return This bind request. * @throws UnsupportedOperationException * If this bind request does not permit the buffer size to be set. */ DigestMD5SASLBindRequest setMaxSendBufferSize(int size) throws UnsupportedOperationException; /** * Sets the password of the user that the client wishes to bind as. * * @param password * The password of the user that the client wishes to bind as, which * may be empty. * @return This bind request. * @throws UnsupportedOperationException * If this bind request does not permit the password to be set. * @throws NullPointerException * If {@code password} was {@code null}. */ DigestMD5SASLBindRequest setPassword(ByteString password) throws UnsupportedOperationException, NullPointerException; /** * Sets the password of the user that the client wishes to bind as. The * password will be converted to a UTF-8 octet string. * * @param password * The password of the user that the client wishes to bind as. * @return This bind request. * @throws UnsupportedOperationException * If this bind request does not permit the password to be set. * @throws NullPointerException * If {@code password} was {@code null}. */ DigestMD5SASLBindRequest setPassword(char[] password) throws UnsupportedOperationException, NullPointerException; /** * Sets the optional realm containing the user's account. * * @param realm * The name of the realm containing the user's account, which may be * {@code null}. * @return This bind request. * @throws UnsupportedOperationException * If this bind request does not permit the realm to be set. * @throws NullPointerException * If {@code realm} was {@code null}. */ DigestMD5SASLBindRequest setRealm(String realm) throws UnsupportedOperationException, NullPointerException; /** * Specifies whether or not the server must authenticate to the client. The * default is {@code false}. * * @param serverAuth * {@code true} if the server must authenticate to the client or * {@code false} otherwise. * @return This bind request. * @throws UnsupportedOperationException * If this bind request does not permit server auth to be set. */ DigestMD5SASLBindRequest setServerAuth(boolean serverAuth) throws UnsupportedOperationException; }