compact3

javax.security.sasl

Interface SaslServer

public interface SaslServer

SASL认证作为一个服务器执行。

一个服务器的LDAP服务器获取该类的实例来执行身份验证的具体机制定义。在SaslServer实例调用方法产生的挑战根据SaslServer实施机制。作为认证的收益，例如封装了该服务器的身份验证交换状态。

这里有一个例子，一个LDAP服务器可以使用一个SaslServer。首先获取一个客户端所请求的机制SaslServer实例：

 SaslServer ss = Sasl.createSaslServer(mechanism,
     "ldap", myFQDN, props, callbackHandler);

可以进行身份验证使用的服务器。例如，假设LDAP服务器收到一个LDAP绑定请求中包含的机制和一个名称（可选）的初始反应。然后，可以使用服务器如下：

 while (!ss.isComplete()) {
     try {
         byte[] challenge = ss.evaluateResponse(response);
         if (ss.isComplete()) {
             status = ldap.sendBindResponse(mechanism, challenge, SUCCESS);
         } else {
             status = ldap.sendBindResponse(mechanism, challenge,
                   SASL_BIND_IN_PROGRESS);
             response = ldap.readBindRequest();
         }
     } catch (SaslException e) {
          status = ldap.sendErrorResponse(e);
          break;
     }
 }
 if (ss.isComplete() && status == SUCCESS) {
    String qop = (String) sc.getNegotiatedProperty(Sasl.QOP);
    if (qop != null
        && (qop.equalsIgnoreCase("auth-int")
            || qop.equalsIgnoreCase("auth-conf"))) {

      // Use SaslServer.wrap() and SaslServer.unwrap() for future
      // communication with client
      ldap.in = new SecureInputStream(ss, ldap.in);
      ldap.out = new SecureOutputStream(ss, ldap.out);
    }
 }

从以下版本开始：

一点五

另请参见：

Sasl， SaslServerFactory

方法摘要

Modifier and Type	Method and Description
void	dispose() 处置任何系统资源或安全敏感信息的saslserver可能使用。
byte[]	evaluateResponse(byte[] response) 评估响应数据，并生成一个挑战。
String	getAuthorizationID() 报告此会话的客户端的授权标识。
String	getMechanismName() 返回IANA注册机制这个SASL服务器名称。
Object	getNegotiatedProperty(String propName) 检索协商的属性。
boolean	isComplete() 确定身份验证交换是否已完成。
byte[]	unwrap(byte[] incoming, int offset, int len) 打开从客户端接收到一个字节数组。
byte[]	wrap(byte[] outgoing, int offset, int len) 将一个字节数组封装到客户端。

方法详细信息

getMechanismName

String getMechanismName()

返回IANA注册机制这个SASL服务器名称。（例如“CRAM-MD5”、“GSSAPI”）。

结果

一个代表IANA注册机构名称的非空字符串。

evaluateResponse

byte[] evaluateResponse(byte[] response)
                 throws SaslException

评估响应数据，并生成一个挑战。如果在认证过程中从客户端接收响应，该方法被调用以准备一个适当的下一个挑战提交给客户端。如果身份验证成功，并没有更多的挑战数据将被发送到客户端，挑战是无效的。它是非空的，如果认证必须继续向客户端发送一个挑战，或如果身份验证成功，但挑战性的数据需要由客户端处理。 isComplete()应该每次调用 evaluateResponse()后调用，以确定是否有任何进一步的响应是从客户需要。

参数

response -非空（但也可能是空的）响应客户端发送的。

结果

发送给客户端的可能是空的挑战。如果身份验证成功，并且没有更多的挑战数据被发送到客户端，则是无效的。

异常

SaslException如果发生错误处理响应时，或产生一个挑战。

isComplete

boolean isComplete()

确定身份验证交换是否已完成。这种方法通常是每次调用 evaluateResponse()确定是否认证成功完成后调用或应继续。

结果

如果身份验证交换已完成，则为假；否则为。

getAuthorizationID

String getAuthorizationID()

报告此会话的客户端的授权标识。这种方法只能称为iscomplete()返回true。

结果

客户端的授权标识。

异常

IllegalStateException如果认证过程尚未完成

unwrap

byte[] unwrap(byte[] incoming,
              int offset,
              int len)
       throws SaslException

打开从客户端接收到一个字节数组。这种方法只能在认证交换完成了所谓的（即，当 isComplete()返回true），只有认证交流协商的完整性和/或隐私保护的质量；否则，一个 IllegalStateException抛出。

incoming是SASL缓冲区的内容定义在RFC 2222中没有领先的四字节字段表示的长度。offset和len指定要使用的incoming部分。

参数

incoming -非空字节数组从客户端包含已编码的字节。

offset -起始位置的字节 incoming使用。

len从 incoming字节数的使用。

结果

包含已解码字节的非空字节数组。

异常

SaslException -如果 incoming不能顺利展开。

IllegalStateException -如果身份验证交换尚未完成，或者如果协商质量的保护既不完整也不隐私

wrap

byte[] wrap(byte[] outgoing,
            int offset,
            int len)
     throws SaslException

将一个字节数组封装到客户端。这种方法只能在认证交换完成了所谓的（即，当 isComplete()返回true），只有认证交流协商的完整性和/或隐私保护的质量；否则，一个 SaslException抛出。

这种方法的结果将使SASL缓冲区的内容定义在RFC 2222中没有领先的四字节字段表示的长度。offset和len指定要使用的outgoing部分。

参数

outgoing -非空字节数组包含的字节编码。

offset -起始位置的字节 outgoing使用。

len从 outgoing字节数的使用。

结果

一种包含编码字节的非空字节数组。

异常

SaslException -如果 outgoing不能成功的包裹。

IllegalStateException -如果身份验证交换尚未完成，或者如果协商质量的保护既不完整也不隐私。

getNegotiatedProperty

Object getNegotiatedProperty(String propName)

检索协商的属性。这种方法只能在认证交换完成了所谓的（即，当 isComplete()返回true）；否则，一个 IllegalStateException抛出。

参数

propName -属性

结果

协商性财产的价值。如果为空，则该属性没有协商或不适用于该机制。

异常

IllegalStateException如果身份验证交换尚未完成

dispose

void dispose()
      throws SaslException

处置任何系统资源或安全敏感信息的saslserver可能使用。调用此方法无效的saslserver实例。这种方法是幂等。

异常

SaslException如果配置资源时遇到了一个问题。