- java.lang.Object
-
- javax.security.sasl.Sasl
-
public class Sasl extends Object
A static class for creating SASL clients and servers.This class defines the policy of how to locate, load, and instantiate SASL clients and servers.
For example, an application or library gets a SASL client by doing something like:
It can then proceed to use the instance to create an authentication connection.SaslClient sc = Sasl.createSaslClient(mechanisms, authorizationId, protocol, serverName, props, callbackHandler);
Similarly, a server gets a SASL server by using code that looks as follows:
SaslServer ss = Sasl.createSaslServer(mechanism, protocol, serverName, props, callbackHandler);
- Since:
- 1.5
-
-
Field Summary
Fields Modifier and Type Field and Description static String
CREDENTIALS
The name of a property that specifies the credentials to use.static String
MAX_BUFFER
The name of a property that specifies the maximum size of the receive buffer in bytes of SaslClient/SaslServer.static String
POLICY_FORWARD_SECRECY
The name of a property that specifies whether mechanisms that implement forward secrecy between sessions are required.static String
POLICY_NOACTIVE
The name of a property that specifies whether mechanisms susceptible to active (non-dictionary) attacks are not permitted.static String
POLICY_NOANONYMOUS
The name of a property that specifies whether mechanisms that accept anonymous login are not permitted.static String
POLICY_NODICTIONARY
The name of a property that specifies whether mechanisms susceptible to passive dictionary attacks are not permitted.static String
POLICY_NOPLAINTEXT
The name of a property that specifies whether mechanisms susceptible to simple plain passive attacks (e.g., "PLAIN") are not permitted.static String
POLICY_PASS_CREDENTIALS
The name of a property that specifies whether mechanisms that pass client credentials are required.static String
QOP
The name of a property that specifies the quality-of-protection to use.static String
RAW_SEND_SIZE
The name of a property that specifies the maximum size of the raw send buffer in bytes of SaslClient/SaslServer.static String
REUSE
The name of a property that specifies whether to reuse previously authenticated session information.static String
SERVER_AUTH
The name of a property that specifies whether the server must authenticate to the client.static String
STRENGTH
The name of a property that specifies the cipher strength to use.
-
Method Summary
Methods Modifier and Type Method and Description static SaslClient
createSaslClient(String[] mechanisms, String authorizationId, String protocol, String serverName, Map<String,?> props, CallbackHandler cbh)
Creates a SaslClient using the parameters supplied.static SaslServer
createSaslServer(String mechanism, String protocol, String serverName, Map<String,?> props, CallbackHandler cbh)
Creates a SaslServer for the specified mechanism.static Enumeration<SaslClientFactory>
getSaslClientFactories()
Gets an enumeration of known factories for producing SaslClient.static Enumeration<SaslServerFactory>
getSaslServerFactories()
Gets an enumeration of known factories for producing SaslServer.
-
-
-
Field Detail
-
QOP
public static final String QOP
The name of a property that specifies the quality-of-protection to use. The property contains a comma-separated, ordered list of quality-of-protection values that the client or server is willing to support. A qop value is one of- "auth" - authentication only
- "auth-int" - authentication plus integrity protection
- "auth-conf" - authentication plus integrity and confidentiality protection
- See Also:
- Constant Field Values
-
STRENGTH
public static final String STRENGTH
The name of a property that specifies the cipher strength to use. The property contains a comma-separated, ordered list of cipher strength values that the client or server is willing to support. A strength value is one of- "low"
- "medium"
- "high"
If this property is absent, the default strength is "high,medium,low". The value of this constant is "javax.security.sasl.strength".- See Also:
- Constant Field Values
-
SERVER_AUTH
public static final String SERVER_AUTH
The name of a property that specifies whether the server must authenticate to the client. The property contains "true" if the server must authenticate the to client; "false" otherwise. The default is "false".
The value of this constant is "javax.security.sasl.server.authentication".- See Also:
- Constant Field Values
-
MAX_BUFFER
public static final String MAX_BUFFER
The name of a property that specifies the maximum size of the receive buffer in bytes of SaslClient/SaslServer. The property contains the string representation of an integer.
If this property is absent, the default size is defined by the mechanism.
The value of this constant is "javax.security.sasl.maxbuffer".- See Also:
- Constant Field Values
-
RAW_SEND_SIZE
public static final String RAW_SEND_SIZE
The name of a property that specifies the maximum size of the raw send buffer in bytes of SaslClient/SaslServer. The property contains the string representation of an integer. The value of this property is negotiated between the client and server during the authentication exchange.
The value of this constant is "javax.security.sasl.rawsendsize".- See Also:
- Constant Field Values
-
REUSE
public static final String REUSE
The name of a property that specifies whether to reuse previously authenticated session information. The property contains "true" if the mechanism implementation may attempt to reuse previously authenticated session information; it contains "false" if the implementation must not reuse previously authenticated session information. A setting of "true" serves only as a hint: it does not necessarily entail actual reuse because reuse might not be possible due to a number of reasons, including, but not limited to, lack of mechanism support for reuse, expiration of reusable information, and the peer's refusal to support reuse. The property's default value is "false". The value of this constant is "javax.security.sasl.reuse". Note that all other parameters and properties required to create a SASL client/server instance must be provided regardless of whether this property has been supplied. That is, you cannot supply any less information in anticipation of reuse. Mechanism implementations that support reuse might allow customization of its implementation, for factors such as cache size, timeouts, and criteria for reuseability. Such customizations are implementation-dependent.- See Also:
- Constant Field Values
-
POLICY_NOPLAINTEXT
public static final String POLICY_NOPLAINTEXT
The name of a property that specifies whether mechanisms susceptible to simple plain passive attacks (e.g., "PLAIN") are not permitted. The property contains "true" if such mechanisms are not permitted; "false" if such mechanisms are permitted. The default is "false".
The value of this constant is "javax.security.sasl.policy.noplaintext".- See Also:
- Constant Field Values
-
POLICY_NOACTIVE
public static final String POLICY_NOACTIVE
The name of a property that specifies whether mechanisms susceptible to active (non-dictionary) attacks are not permitted. The property contains "true" if mechanisms susceptible to active attacks are not permitted; "false" if such mechanisms are permitted. The default is "false".
The value of this constant is "javax.security.sasl.policy.noactive".- See Also:
- Constant Field Values
-
POLICY_NODICTIONARY
public static final String POLICY_NODICTIONARY
The name of a property that specifies whether mechanisms susceptible to passive dictionary attacks are not permitted. The property contains "true" if mechanisms susceptible to dictionary attacks are not permitted; "false" if such mechanisms are permitted. The default is "false".
The value of this constant is "javax.security.sasl.policy.nodictionary".- See Also:
- Constant Field Values
-
POLICY_NOANONYMOUS
public static final String POLICY_NOANONYMOUS
The name of a property that specifies whether mechanisms that accept anonymous login are not permitted. The property contains "true" if mechanisms that accept anonymous login are not permitted; "false" if such mechanisms are permitted. The default is "false".
The value of this constant is "javax.security.sasl.policy.noanonymous".- See Also:
- Constant Field Values
-
POLICY_FORWARD_SECRECY
public static final String POLICY_FORWARD_SECRECY
The name of a property that specifies whether mechanisms that implement forward secrecy between sessions are required. Forward secrecy means that breaking into one session will not automatically provide information for breaking into future sessions. The property contains "true" if mechanisms that implement forward secrecy between sessions are required; "false" if such mechanisms are not required. The default is "false".
The value of this constant is "javax.security.sasl.policy.forward".- See Also:
- Constant Field Values
-
POLICY_PASS_CREDENTIALS
public static final String POLICY_PASS_CREDENTIALS
The name of a property that specifies whether mechanisms that pass client credentials are required. The property contains "true" if mechanisms that pass client credentials are required; "false" if such mechanisms are not required. The default is "false".
The value of this constant is "javax.security.sasl.policy.credentials".- See Also:
- Constant Field Values
-
CREDENTIALS
public static final String CREDENTIALS
The name of a property that specifies the credentials to use. The property contains a mechanism-specific Java credential object. Mechanism implementations may examine the value of this property to determine whether it is a class that they support. The property may be used to supply credentials to a mechanism that supports delegated authentication.
The value of this constant is "javax.security.sasl.credentials".- See Also:
- Constant Field Values
-
-
Method Detail
-
createSaslClient
public static SaslClient createSaslClient(String[] mechanisms, String authorizationId, String protocol, String serverName, Map<String,?> props, CallbackHandler cbh) throws SaslException
Creates a SaslClient using the parameters supplied. This method uses the JCA Security Provider Framework, described in the "Java Cryptography Architecture API Specification & Reference", for locating and selecting a SaslClient implementation. First, it obtains an ordered list of SaslClientFactory instances from the registered security providers for the "SaslClientFactory" service and the specified SASL mechanism(s). It then invokes createSaslClient() on each factory instance on the list until one produces a non-null SaslClient instance. It returns the non-null SaslClient instance, or null if the search fails to produce a non-null SaslClient instance.A security provider for SaslClientFactory registers with the JCA Security Provider Framework keys of the form
SaslClientFactory.mechanism_name
and values that are class names of implementations of javax.security.sasl.SaslClientFactory. For example, a provider that contains a factory class, com.wiz.sasl.digest.ClientFactory, that supports the "DIGEST-MD5" mechanism would register the following entry with the JCA: SaslClientFactory.DIGEST-MD5 com.wiz.sasl.digest.ClientFactorySee the "Java Cryptography Architecture API Specification & Reference" for information about how to install and configure security service providers.
- Parameters:
mechanisms
- The non-null list of mechanism names to try. Each is the IANA-registered name of a SASL mechanism. (e.g. "GSSAPI", "CRAM-MD5").authorizationId
- The possibly null protocol-dependent identification to be used for authorization. If null or empty, the server derives an authorization ID from the client's authentication credentials. When the SASL authentication completes successfully, the specified entity is granted access.protocol
- The non-null string name of the protocol for which the authentication is being performed (e.g., "ldap").serverName
- The non-null fully-qualified host name of the server to authenticate to.props
- The possibly null set of properties used to select the SASL mechanism and to configure the authentication exchange of the selected mechanism. For example, if props contains theSasl.POLICY_NOPLAINTEXT
property with the value "true", then the selected SASL mechanism must not be susceptible to simple plain passive attacks. In addition to the standard properties declared in this class, other, possibly mechanism-specific, properties can be included. Properties not relevant to the selected mechanism are ignored, including any map entries with non-String keys.cbh
- The possibly null callback handler to used by the SASL mechanisms to get further information from the application/library to complete the authentication. For example, a SASL mechanism might require the authentication ID, password and realm from the caller. The authentication ID is requested by using a NameCallback. The password is requested by using a PasswordCallback. The realm is requested by using a RealmChoiceCallback if there is a list of realms to choose from, and by using a RealmCallback if the realm must be entered.- Returns:
- A possibly null SaslClient created using the parameters supplied. If null, cannot find a SaslClientFactory that will produce one.
- Throws:
SaslException
- If cannot create a SaslClient because of an error.
-
createSaslServer
public static SaslServer createSaslServer(String mechanism, String protocol, String serverName, Map<String,?> props, CallbackHandler cbh) throws SaslException
Creates a SaslServer for the specified mechanism. This method uses the JCA Security Provider Framework, described in the "Java Cryptography Architecture API Specification & Reference", for locating and selecting a SaslServer implementation. First, it obtains an ordered list of SaslServerFactory instances from the registered security providers for the "SaslServerFactory" service and the specified mechanism. It then invokes createSaslServer() on each factory instance on the list until one produces a non-null SaslServer instance. It returns the non-null SaslServer instance, or null if the search fails to produce a non-null SaslServer instance.A security provider for SaslServerFactory registers with the JCA Security Provider Framework keys of the form
SaslServerFactory.mechanism_name
and values that are class names of implementations of javax.security.sasl.SaslServerFactory. For example, a provider that contains a factory class, com.wiz.sasl.digest.ServerFactory, that supports the "DIGEST-MD5" mechanism would register the following entry with the JCA: SaslServerFactory.DIGEST-MD5 com.wiz.sasl.digest.ServerFactorySee the "Java Cryptography Architecture API Specification & Reference" for information about how to install and configure security service providers.
- Parameters:
mechanism
- The non-null mechanism name. It must be an IANA-registered name of a SASL mechanism. (e.g. "GSSAPI", "CRAM-MD5").protocol
- The non-null string name of the protocol for which the authentication is being performed (e.g., "ldap").serverName
- The non-null fully qualified host name of the server.props
- The possibly null set of properties used to select the SASL mechanism and to configure the authentication exchange of the selected mechanism. For example, if props contains theSasl.POLICY_NOPLAINTEXT
property with the value "true", then the selected SASL mechanism must not be susceptible to simple plain passive attacks. In addition to the standard properties declared in this class, other, possibly mechanism-specific, properties can be included. Properties not relevant to the selected mechanism are ignored, including any map entries with non-String keys.cbh
- The possibly null callback handler to used by the SASL mechanisms to get further information from the application/library to complete the authentication. For example, a SASL mechanism might require the authentication ID, password and realm from the caller. The authentication ID is requested by using a NameCallback. The password is requested by using a PasswordCallback. The realm is requested by using a RealmChoiceCallback if there is a list of realms to choose from, and by using a RealmCallback if the realm must be entered.- Returns:
- A possibly null SaslServer created using the parameters supplied. If null, cannot find a SaslServerFactory that will produce one.
- Throws:
SaslException
- If cannot create a SaslServer because of an error.
-
getSaslClientFactories
public static Enumeration<SaslClientFactory> getSaslClientFactories()
Gets an enumeration of known factories for producing SaslClient. This method uses the same algorithm for locating factories as createSaslClient().- Returns:
- A non-null enumeration of known factories for producing SaslClient.
- See Also:
createSaslClient(java.lang.String[], java.lang.String, java.lang.String, java.lang.String, java.util.Map<java.lang.String, ?>, javax.security.auth.callback.CallbackHandler)
-
getSaslServerFactories
public static Enumeration<SaslServerFactory> getSaslServerFactories()
Gets an enumeration of known factories for producing SaslServer. This method uses the same algorithm for locating factories as createSaslServer().- Returns:
- A non-null enumeration of known factories for producing SaslServer.
- See Also:
createSaslServer(java.lang.String, java.lang.String, java.lang.String, java.util.Map<java.lang.String, ?>, javax.security.auth.callback.CallbackHandler)
-
-
Traduction non disponible
Les API Java ne sont pas encore traduites en français sur l'infobrol. Seule la version anglaise est disponible pour l'instant.
Version en cache
05/11/2024 16:28:49 Cette version de la page est en cache (à la date du 05/11/2024 16:28:49) afin d'accélérer le traitement. Vous pouvez activer le mode utilisateur dans le menu en haut pour afficher la dernère version de la page.Document créé le 15/09/2006, dernière modification le 04/03/2020
Source du document imprimé : https://www.gaudry.be/java-api-rf-javax/security/sasl/Sasl.html
L'infobrol est un site personnel dont le contenu n'engage que moi. Le texte est mis à disposition sous licence CreativeCommons(BY-NC-SA). Plus d'info sur les conditions d'utilisation et sur l'auteur.
Références
Ces références et liens indiquent des documents consultés lors de la rédaction de cette page, ou qui peuvent apporter un complément d'information, mais les auteurs de ces sources ne peuvent être tenus responsables du contenu de cette page.
L'auteur de ce site est seul responsable de la manière dont sont présentés ici les différents concepts, et des libertés qui sont prises avec les ouvrages de référence. N'oubliez pas que vous devez croiser les informations de sources multiples afin de diminuer les risques d'erreurs.