com.ibm.security.sasl.digest
Class FactoryImpl
- java.lang.Object
com.ibm.security.sasl.digest.FactoryImpl
All implemented interfaces:
- public final class FactoryImpl
- extends java.lang.Object
- implements SaslClientFactory, SaslServerFactory
Author:
Jonathan Bruce , Rosanna Lee
Constructor Summary
Constructor and Description |
---|
FactoryImpl()
Empty constructor.
|
Method Summary
Modifier and Type | Method and Description |
---|---|
createSaslClient(java.lang.String[] mechs,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)
Returns a new instance of the DIGEST-MD5 SASL client mechanism.
|
|
createSaslServer(java.lang.String mech,java.lang.String protocol,java.lang.String serverName,java.util.Map<java.lang.String,?> props,javax.security.auth.callback.CallbackHandler cbh)
Returns a new instance of the DIGEST-MD5 SASL server mechanism.
|
|
|
getMechanismNames(java.util.Map<java.lang.String,?> env)
Returns the authentication mechanisms that this factory can produce.
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail
FactoryImpl
- public FactoryImpl()
Empty constructor.
Method Detail
createSaslClient
- public SaslClient createSaslClient( java.lang.String[] mechs,
- 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
Returns a new instance of the DIGEST-MD5 SASL client mechanism.
Specified by:
createSaslClient
in interface SaslClientFactory
Parameters:
mechs
- 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. 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. 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, this factory cannot produce a SaslClient
using the parameters supplied. Throws:
SaslException
- If there is an error creating the DigestMD5
SASL client. createSaslServer
- public SaslServer createSaslServer( java.lang.String mech,
- java.lang.String protocol,
- java.lang.String serverName,
- java.util.Map<java.lang.String,?> props,
- javax.security.auth.callback.CallbackHandler cbh)
- throws SaslException
Returns a new instance of the DIGEST-MD5 SASL server mechanism.
Specified by:
createSaslServer
in interface SaslServerFactory
Parameters:
mech
- The non-null
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
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. 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. 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, this factory cannot produce a SaslServer
using the parameters supplied. Throws:
SaslException
- If there is an error creating the DigestMD5
SASL server. getMechanismNames
- public java.lang.String[] getMechanismNames( java.util.Map<java.lang.String,?> env)
Returns the authentication mechanisms that this factory can produce.
Specified by:
getMechanismNames
in interface SaslClientFactory
Specified by:
getMechanismNames
in interface SaslServerFactory
Parameters:
env
- 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. Returns:
A non-null array containing a IANA-registered SASL mechanism names.