jespa.sasl

Class SaslServer

java.lang.Object

jespa.sasl.SaslServer

All Implemented Interfaces:

javax.security.sasl.SaslServer

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

The Jespa SASL server. The property provider.classname specifies the SecurityProvider that this SASL server 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.

IMPORTANT: If you are using the NtlmSecurityProvider (which is the default provider) this SaslServer will not work until you create a Computer account as described in the Installation section in the Jespa Operator's Manual.

The NtlmSecurityProvider requires the following properties to act as an acceptor in a SASL server:

Properties required by the NtlmSecurityProvider

Name	Description	Example
jespa.bindstr	The fully qualified DNS hostname of the Active Directory server against which clients will be authenticated.	dc05.example.com
jepsa.service.acctname	The qualified Computer account name.	JESPA1$@EXAMPLE.COM
jepsa.service.password	The password for the above account	a89609c53443ce1c72e59275a8a1e1ce

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	dispose()
byte[]	evaluateResponse(byte[] response)
java.lang.String	getAuthorizationID()
java.lang.String	getMechanismName()
java.lang.Object	getNegotiatedProperty(java.lang.String propName)
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

SaslServer

public SaslServer(java.lang.String mechanismName,
                  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 SaslServer that supports NTLM authentication, integrity and confidentiality.

Currently this SASL server only supports an NTLM security provider and therefore the mechanismName should be "NTLM". 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. The protocol, serverName and cbh parameters are currently ignored and should be null.

Parameters:

mechanismName - the mechanism which currently must be "NTLM"

props - the properties that define which security provider is used and it's properties

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

evaluateResponse

public byte[] evaluateResponse(byte[] response)
                        throws javax.security.sasl.SaslException

Specified by:

evaluateResponse in interface javax.security.sasl.SaslServer

Throws:

javax.security.sasl.SaslException

isComplete

public boolean isComplete()

Specified by:

isComplete in interface javax.security.sasl.SaslServer

getAuthorizationID

public java.lang.String getAuthorizationID()

Specified by:

getAuthorizationID in interface javax.security.sasl.SaslServer

unwrap

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

Specified by:

unwrap in interface javax.security.sasl.SaslServer

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

Throws:

javax.security.sasl.SaslException

getNegotiatedProperty

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

Specified by:

getNegotiatedProperty in interface javax.security.sasl.SaslServer

dispose

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

Specified by:

dispose in interface javax.security.sasl.SaslServer

Throws:

javax.security.sasl.SaslException