compact3

javax.security.sasl

Class Sasl

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:

 SaslClient sc = Sasl.createSaslClient(mechanisms,
     authorizationId, protocol, serverName, props, callbackHandler);

It can then proceed to use the instance to create an authentication connection.

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	Description
static String	BOUND_SERVER_NAME	The name of a property that specifies the bound server name for an unbound server.
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

Modifier and Type	Method	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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

The order of the list specifies the preference order of the client or server. If this property is absent, the default qop is "auth". The value of this constant is "javax.security.sasl.qop".

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"

The order of the list specifies the preference order of the client or server. An implementation should allow configuration of the meaning of these values. An application may use the Java Cryptography Extension (JCE) with JCE-aware mechanisms to control the selection of cipher suites that match the strength values.
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

BOUND_SERVER_NAME

public static final String BOUND_SERVER_NAME

The name of a property that specifies the bound server name for an unbound server. A server is created as an unbound server by setting the serverName argument in createSaslServer(java.lang.String, java.lang.String, java.lang.String, java.util.Map<java.lang.String, ?>, javax.security.auth.callback.CallbackHandler) as null. The property contains the bound host name after the authentication exchange has completed. It is only available on the server side.
The value of this constant is "javax.security.sasl.bound.server.name".

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 reusability. Such customizations are implementation-dependent.

See Also:

Constant Field Values