jespa.sasl

Class SaslClient

java.lang.Object

jespa.sasl.SaslClient

All Implemented Interfaces:

javax.security.sasl.SaslClient

public class SaslClient
extends java.lang.Object
implements javax.security.sasl.SaslClient

The Jespa SASL client. The property provider.classname specifies the SecurityProvider that this SASL client should use. If the provider.classname propery is not supplied, the default provider is jespa.ntlm.NtlmSecurityProvider. If a property is prefixed with "jespa.", the prefix will be removed and passed through to the provider constructor properties map.

The NtlmSecurityProvider does not require any properties to act as an initiator in a SASL client although it may be desireable to do so. For example, jespa.flags.confidentiality could be set to false to turn off encryption.

See also the The Java SASL API Programming and Deployment Guide.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	mechanismName
protected SecurityProvider	provider

Constructor Summary

Constructors

Constructor and Description
SaslClient(java.lang.String mechanismName, java.lang.String authorizationId, java.lang.String protocol, java.lang.String serverName, java.util.Map props, javax.security.auth.callback.CallbackHandler cbh) Create a SaslClient that supports NTLM authentication, integrity and confidentiality.

Method Summary

Modifier and Type	Method and Description
void	dispose()
byte[]	evaluateChallenge(byte[] challenge)
java.lang.String	getMechanismName()
java.lang.Object	getNegotiatedProperty(java.lang.String propName)
boolean	hasInitialResponse()
boolean	isComplete()
byte[]	unwrap(byte[] incoming, int offset, int len)
byte[]	wrap(byte[] outgoing, int offset, int len)

Methods inherited from class java.lang.Object

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

Field Detail

mechanismName

protected java.lang.String mechanismName

provider

protected SecurityProvider provider

Constructor Detail

SaslClient

public SaslClient(java.lang.String mechanismName,
                  java.lang.String authorizationId,
                  java.lang.String protocol,
                  java.lang.String serverName,
                  java.util.Map props,
                  javax.security.auth.callback.CallbackHandler cbh)
           throws javax.security.sasl.SaslException

Create a SaslClient that supports NTLM authentication, integrity and confidentiality.

Currently this SASL client only supports an NTLM security provider and therefore the mechanismName should be "NTLM". However, even though the NTLM security provider does not implement SPNEGO, the Windows LDAP client authenticating with Active Directory using raw NTLMSSP will use a mechanism name of "GSS-SPNEGO". The props parameter indicates which security provider should be used with the provider.classname property. Any properties prefixed with "jespa." will be stripped of the prefix and passed to the security provider constructor in a new map. In practice, because the NTLM security provider does not need any properties to initiate authentication, the props parameter will likely be an empty map. The authorizationId, protocol, serverName and cbh parameters are currently ignored and should be null.

Parameters:

mechanismName - the mechanism name such as "NTLM"

props - the properties that define which security provider is used and it's properties (usually an empty map)

Throws:

javax.security.sasl.SaslException - if the underlying security provider could not be instantiated

Method Detail

getMechanismName

public java.lang.String getMechanismName()

Specified by:

getMechanismName in interface javax.security.sasl.SaslClient

hasInitialResponse

public boolean hasInitialResponse()

Specified by:

hasInitialResponse in interface javax.security.sasl.SaslClient

evaluateChallenge

public byte[] evaluateChallenge(byte[] challenge)
                         throws javax.security.sasl.SaslException

Specified by:

evaluateChallenge in interface javax.security.sasl.SaslClient

Throws:

javax.security.sasl.SaslException

isComplete

public boolean isComplete()

Specified by:

isComplete in interface javax.security.sasl.SaslClient

unwrap

public byte[] unwrap(byte[] incoming,
                     int offset,
                     int len)
              throws javax.security.sasl.SaslException

Specified by:

unwrap in interface javax.security.sasl.SaslClient

Throws:

javax.security.sasl.SaslException

wrap

public byte[] wrap(byte[] outgoing,
                   int offset,
                   int len)
            throws javax.security.sasl.SaslException

Specified by:

wrap in interface javax.security.sasl.SaslClient

Throws:

javax.security.sasl.SaslException

getNegotiatedProperty

public java.lang.Object getNegotiatedProperty(java.lang.String propName)

Specified by:

getNegotiatedProperty in interface javax.security.sasl.SaslClient

dispose

public void dispose()
             throws javax.security.sasl.SaslException

Specified by:

dispose in interface javax.security.sasl.SaslClient

Throws:

javax.security.sasl.SaslException