Top Description Fields Constructors Methods
com.sun.security.sasl.digest

public final Class FactoryImpl

extends Object
implements SaslClientFactory, SaslServerFactory
Class Inheritance
All Implemented Interfaces
javax.security.sasl.SaslServerFactory, javax.security.sasl.SaslClientFactory
Imports
java.util.Map, javax.security.sasl.*, javax.security.auth.callback.CallbackHandler, com.sun.security.sasl.util.PolicyUtils

Client and server factory for DIGEST-MD5 SASL client/server mechanisms. See DigestMD5Client and DigestMD5Server for input requirements.
Authors
Jonathan Bruce, Rosanna Lee

Field Summary

Modifier and TypeField and Description
private static final int
private static final int[]
private static final String[]

Constructor Summary

AccessConstructor and Description
public
FactoryImpl()

Empty constructor.

Method Summary

Modifier and TypeMethod and Description
public SaslClient

Returns:

a new SaslClient; otherwise null if unsuccessful.
createSaslClient
(String[]
The non-null list of mechanism names to try. Each is the IANA-registered name of a SASL mechanism. (e.g. "GSSAPI", "CRAM-MD5").
mechs
,
String
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.
authorizationId
,
String
The non-null string name of the protocol for which the authentication is being performed (e.g., "ldap").
protocol
,
String
The non-null fully qualified host name of the server to authenticate to.
serverName
,
Map<String, ?>
The possibly null set of properties used to select the SASL mechanism and to configure the authentication exchange of the selected mechanism. See the Sasl class for a list of standard properties. 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.
props
,
CallbackHandler
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.
cbh
)

Implements javax.security.sasl.SaslClientFactory.createSaslClient.

Returns a new instance of the DIGEST-MD5 SASL client mechanism.

public SaslServer

Returns:

a new SaslServer; otherwise null if unsuccessful.
createSaslServer
(String
The non-null IANA-registered name of a SASL mechanism. (e.g. "GSSAPI", "CRAM-MD5").
mech
,
String
The non-null string name of the protocol for which the authentication is being performed (e.g., "ldap").
protocol
,
String
The fully qualified host name of the server to authenticate to, or null if the server is not bound to any specific host name. If the mechanism does not allow an unbound server, a SaslException will be thrown.
serverName
,
Map<String, ?>
The possibly null set of properties used to select the SASL mechanism and to configure the authentication exchange of the selected mechanism. See the Sasl class for a list of standard properties. 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.
props
,
CallbackHandler
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.
cbh
)

Implements javax.security.sasl.SaslServerFactory.createSaslServer.

Returns a new instance of the DIGEST-MD5 SASL server mechanism.

public String[]

Returns:

String[] {"DigestMD5"} if policies in env match those of this factory.
getMechanismNames
(Map<String, ?>
The possibly null set of properties used to specify the security policy of the SASL mechanisms. For example, if props contains the Sasl.POLICY_NOPLAINTEXT property with the value "true", then the factory must not return any SASL mechanisms that are susceptible to simple plain passive attacks. See the Sasl class for a complete list of policy properties. Non-policy related properties, if present in props, are ignored, including any map entries with non-String keys.
env
)

Implements javax.security.sasl.SaslClientFactory.getMechanismNames, javax.security.sasl.SaslServerFactory.getMechanismNames.

Returns the authentication mechanisms that this factory can produce.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

DIGEST_MD5back to summary
private static final int DIGEST_MD5
mechPoliciesback to summary
private static final int[] mechPolicies
myMechsback to summary
private static final String[] myMechs

Constructor Detail

FactoryImplback to summary
public FactoryImpl()

Empty constructor.

Method Detail

createSaslClientback to summary
public SaslClient createSaslClient(String[] mechs, String authorizationId, String protocol, String serverName, Map<String, ?> props, CallbackHandler cbh) throws SaslException

Implements javax.security.sasl.SaslClientFactory.createSaslClient.

Returns a new instance of the DIGEST-MD5 SASL client mechanism.

Parameters
mechs:String[]

Doc from javax.security.sasl.SaslClientFactory.createSaslClient.

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:String

Doc from javax.security.sasl.SaslClientFactory.createSaslClient.

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:String

Doc from javax.security.sasl.SaslClientFactory.createSaslClient.

The non-null string name of the protocol for which the authentication is being performed (e.g., "ldap").

serverName:String

Doc from javax.security.sasl.SaslClientFactory.createSaslClient.

The non-null fully qualified host name of the server to authenticate to.

props:Map<String, ?>

Doc from javax.security.sasl.SaslClientFactory.createSaslClient.

The possibly null set of properties used to select the SASL mechanism and to configure the authentication exchange of the selected mechanism. See the Sasl class for a list of standard properties. 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:CallbackHandler

Doc from javax.security.sasl.SaslClientFactory.createSaslClient.

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:SaslClient

a new SaslClient; otherwise null if unsuccessful.

Exceptions
SaslException:
If there is an error creating the DigestMD5 SASL client.
createSaslServerback to summary
public SaslServer createSaslServer(String mech, String protocol, String serverName, Map<String, ?> props, CallbackHandler cbh) throws SaslException

Implements javax.security.sasl.SaslServerFactory.createSaslServer.

Returns a new instance of the DIGEST-MD5 SASL server mechanism.

Parameters
mech:String

Doc from javax.security.sasl.SaslServerFactory.createSaslServer.

The non-null IANA-registered name of a SASL mechanism. (e.g. "GSSAPI", "CRAM-MD5").

protocol:String

Doc from javax.security.sasl.SaslServerFactory.createSaslServer.

The non-null string name of the protocol for which the authentication is being performed (e.g., "ldap").

serverName:String

Doc from javax.security.sasl.SaslServerFactory.createSaslServer.

The fully qualified host name of the server to authenticate to, or null if the server is not bound to any specific host name. If the mechanism does not allow an unbound server, a SaslException will be thrown.

props:Map<String, ?>

Doc from javax.security.sasl.SaslServerFactory.createSaslServer.

The possibly null set of properties used to select the SASL mechanism and to configure the authentication exchange of the selected mechanism. See the Sasl class for a list of standard properties. 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:CallbackHandler

Doc from javax.security.sasl.SaslServerFactory.createSaslServer.

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:SaslServer

a new SaslServer; otherwise null if unsuccessful.

Exceptions
SaslException:
If there is an error creating the DigestMD5 SASL server.
getMechanismNamesback to summary
public String[] getMechanismNames(Map<String, ?> env)

Implements javax.security.sasl.SaslClientFactory.getMechanismNames, javax.security.sasl.SaslServerFactory.getMechanismNames.

Returns the authentication mechanisms that this factory can produce.

Parameters
env:Map<String, ?>

Doc from javax.security.sasl.SaslClientFactory.getMechanismNames.

The possibly null set of properties used to specify the security policy of the SASL mechanisms. For example, if props contains the Sasl.POLICY_NOPLAINTEXT property with the value "true", then the factory must not return any SASL mechanisms that are susceptible to simple plain passive attacks. See the Sasl class for a complete list of policy properties. Non-policy related properties, if present in props, are ignored, including any map entries with non-String keys.

Returns:String[]

String[] {"DigestMD5"} if policies in env match those of this factory.