|
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
javax.security.sasl.Sasl
public class Sasl
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);
Field Summary | |
---|---|
static java.lang.String |
MAX_BUFFER
The name of a property that specifies the maximum size of the receive buffer in bytes of SaslClient/SaslServer. |
static java.lang.String |
POLICY_FORWARD_SECRECY
The name of a property that specifies whether mechanisms that implement forward secrecy between sessions are required. |
static java.lang.String |
POLICY_NOACTIVE
The name of a property that specifies whether mechanisms susceptible to active (non-dictionary) attacks are not permitted. |
static java.lang.String |
POLICY_NOANONYMOUS
The name of a property that specifies whether mechanisms that accept anonymous login are not permitted. |
static java.lang.String |
POLICY_NODICTIONARY
The name of a property that specifies whether mechanisms susceptible to passive dictionary attacks are not permitted. |
static java.lang.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 java.lang.String |
POLICY_PASS_CREDENTIALS
The name of a property that specifies whether mechanisms that pass client credentials are required. |
static java.lang.String |
QOP
The name of a property that specifies the quality-of-protection to use. |
static java.lang.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 java.lang.String |
REUSE
The name of a property that specifies whether to reuse previously authenticated session information. |
static java.lang.String |
SERVER_AUTH
The name of a property that specifies whether the server must authenticate to the client. |
static java.lang.String |
STRENGTH
The name of a property that specifies the cipher strength to use. |
Method Summary | |
---|---|
static SaslClient |
createSaslClient(java.lang.String[] mechanisms,
java.lang.String authorizationId, java.lang.String protocol,
java.lang.String serverName,
java.util.Map<java.lang.String,?> props,
javax.security.auth.callback.CallbackHandler cbh) Creates a SaslClient using the parameters supplied. |
static SaslServer |
createSaslServer(java.lang.String mechanism,
java.lang.String protocol, java.lang.String serverName,
java.util.Map<java.lang.String,?> props,
javax.security.auth.callback.CallbackHandler cbh) Creates a SaslServer for the specified mechanism. |
static java.util.Enumeration<SaslClientFactory> |
getSaslClientFactories()
Gets an enumeration of known factories for producing SaslClient. |
static java.util.Enumeration<SaslServerFactory> |
getSaslServerFactories()
Gets an enumeration of known factories for producing SaslServer. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify,
notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String QOP
public static final java.lang.String STRENGTH
public static final java.lang.String SERVER_AUTH
public static final java.lang.String MAX_BUFFER
public static final java.lang.String RAW_SEND_SIZE
public static final java.lang.String REUSE
public static final java.lang.String POLICY_NOPLAINTEXT
public static final java.lang.String POLICY_NOACTIVE
public static final java.lang.String POLICY_NODICTIONARY
public static final java.lang.String POLICY_NOANONYMOUS
public static final java.lang.String POLICY_FORWARD_SECRECY
public static final java.lang.String POLICY_PASS_CREDENTIALS
Method Detail |
---|
public static SaslClient createSaslClient(java.lang.String[] mechanisms,
java.lang.String authorizationId,
java.lang.String protocol,
java.lang.String serverName,
java.util.Map<java.lang.String,?> props,
javax.security.auth.callback.CallbackHandler cbh)
throws SaslException
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.ClientFactory
See the "Java Cryptography Architecture API Specification & Reference" for information about how to install and configure security service providers.
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 the Sasl.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.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. SaslException
- If
cannot create a SaslClient because of an error.public static SaslServer createSaslServer(java.lang.String mechanism,
java.lang.String protocol,
java.lang.String serverName,
java.util.Map<java.lang.String,?> props,
javax.security.auth.callback.CallbackHandler cbh)
throws SaslException
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.ServerFactory
See the "Java Cryptography Architecture API Specification & Reference" for information about how to install and configure security service providers.
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 the Sasl.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.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. SaslException
- If
cannot create a SaslServer because of an error.public static java.util.Enumeration<SaslClientFactory> getSaslClientFactories()
createSaslClient(java.lang.String[],
java.lang.String, java.lang.String, java.lang.String, java.util.Map, javax.security.auth.callback.CallbackHandler)
public static java.util.Enumeration<SaslServerFactory> getSaslServerFactories()
createSaslServer(java.lang.String,
java.lang.String, java.lang.String, java.util.Map, javax.security.auth.callback.CallbackHandler)
|
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |