compact3

javax.security.sasl

Class Sasl

java.lang.Object

javax.security.sasl.Sasl

public class Sasl
extends Object

用于创建SASL客户端和服务器的静态类。

此类定义了如何定位，加载和实例化SASL客户端和服务器的策略。

例如，应用程序或库通过执行以下操作获取SASL客户端：

 SaslClient sc = Sasl.createSaslClient(mechanisms,
     authorizationId, protocol, serverName, props, callbackHandler);

然后可以继续使用实例来创建身份验证连接。

类似地，服务器通过使用如下所示的代码获取SASL服务器：

 SaslServer ss = Sasl.createSaslServer(mechanism,
     protocol, serverName, props, callbackHandler);

从以下版本开始：

1.5

Field Summary

Fields

Modifier and Type	Field and Description
static String	BOUND_SERVER_NAME 指定未绑定服务器的绑定服务器名称的属性的名称。
static String	CREDENTIALS 指定要使用的凭据的属性的名称。
static String	MAX_BUFFER 它指定的字节接收缓冲器的最大大小的属性的名称 SaslClient / SaslServer 。
static String	POLICY_FORWARD_SECRECY 指定是否需要在会话之间实现向前保密的机制的属性的名称。
static String	POLICY_NOACTIVE 指定是否允许容易受到活动（非字典）攻击的机制的属性的名称。
static String	POLICY_NOANONYMOUS 指定是否允许接受匿名登录的机制的属性的名称。
static String	POLICY_NODICTIONARY 指定是否允许容易受被动字典攻击的机制的属性的名称。
static String	POLICY_NOPLAINTEXT 指定是否允许容易受到简单的被动攻击的机制（例如“PLAIN”）的属性的名称。
static String	POLICY_PASS_CREDENTIALS 指定是否需要传递客户端凭据的机制的属性的名称。
static String	QOP 指定要使用的保护质量的属性的名称。
static String	RAW_SEND_SIZE 一个属性的名称，指定原始发送缓冲区的最大大小（以字节为单位）， SaslClient SaslServer 。
static String	REUSE 指定是否重新使用以前验证的会话信息的属性的名称。
static String	SERVER_AUTH 指定服务器是否必须向客户端进行身份验证的属性的名称。
static String	STRENGTH 指定要使用的密码强度的属性的名称。

方法摘要

Modifier and Type	Method and Description
static SaslClient	createSaslClient(String[] mechanisms, String authorizationId, String protocol, String serverName, Map<String,?> props, CallbackHandler cbh) 创建 SaslClient使用所提供的参数。
static SaslServer	createSaslServer(String mechanism, String protocol, String serverName, Map<String,?> props, CallbackHandler cbh) 创建一个 SaslServer指定机制。
static Enumeration<SaslClientFactory>	getSaslClientFactories() 获得已知工厂的列举，生产 SaslClient 。
static Enumeration<SaslServerFactory>	getSaslServerFactories() 获得已知工厂的列举，生产 SaslServer 。

Methods inherited from class java.lang.Object

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

字段详细信息

QOP

public static final String QOP

指定要使用的保护质量的属性的名称。 该属性包含客户端或服务器愿意支持的以逗号分隔的保护值质量列表。 qop值是其中之一

• "auth" - 仅认证
• "auth-int" - 认证加完整性保护
• "auth-conf" - 认证加完整性和机密性保护

列表的顺序指定客户端或服务器的首选顺序。 如果此属性不存在，则默认qop为"auth" 。 该常数的值为"javax.security.sasl.qop" 。

另请参见：

Constant Field Values

STRENGTH

public static final String STRENGTH

指定要使用的密码强度的属性的名称。 该属性包含客户端或服务器愿意支持的密码强度值的逗号分隔的有序列表。 强度值是其中之一

• "low"
• "medium"
• "high"

列表的顺序指定客户端或服务器的首选顺序。 实现应允许配置这些值的含义。 应用程序可以使用具有JCE感知机制的Java加密扩展（JCE）来控制与强度值匹配的密码套件的选择。
如果此属性不存在，默认强度为"high,medium,low" 。 该常数的值为"javax.security.sasl.strength" 。

另请参见：

Constant Field Values

SERVER_AUTH

public static final String SERVER_AUTH

指定服务器是否必须向客户端进行身份验证的属性的名称。 如果服务器必须验证客户端，该属性包含"true" ; "false"否则。 默认值为"false" 。
该常数的值为"javax.security.sasl.server.authentication" 。

另请参见：

Constant Field Values

BOUND_SERVER_NAME

public static final String BOUND_SERVER_NAME

指定未绑定服务器的绑定服务器名称的属性的名称。 服务器是通过设置作为未结合的服务器创建serverName在参数createSaslServer(java.lang.String, java.lang.String, java.lang.String, java.util.Map<java.lang.String, ?>, javax.security.auth.callback.CallbackHandler)为空。 该属性在认证交换完成后包含绑定的主机名。 它仅在服务器端可用。
该常数的值为"javax.security.sasl.bound.server.name" 。

另请参见：

Constant Field Values

MAX_BUFFER

public static final String MAX_BUFFER

一个属性的名称，指定接收缓冲区的最大大小（以字节为SaslClient ） SaslServer 。 该属性包含整数的字符串表示形式。
如果此属性不存在，则默认大小由机制定义。
该常数的值为"javax.security.sasl.maxbuffer" 。

另请参见：

Constant Field Values

RAW_SEND_SIZE

public static final String RAW_SEND_SIZE

一个属性的名称，指定原始发送缓冲区的最大大小（以字节为SaslClient ） SaslServer 。 该属性包含整数的字符串表示形式。 在验证交换期间，客户端和服务器之间协商此属性的值。
该常数的值为"javax.security.sasl.rawsendsize" 。

另请参见：

Constant Field Values

REUSE

public static final String REUSE

指定是否重新使用以前验证的会话信息的属性的名称。 如果机制实现可能尝试重用以前验证的会话信息，该属性包含“true”; 如果实现不能重复使用以前验证的会话信息，则它包含“false”。 “真实”的设置仅作为一个提示：它不一定需要实际的重用，因为重用可能不可能，原因有很多，包括但不限于缺乏对重用的机制支持，可重用信息的到期，同侪拒绝支持重用。 属性的默认值为“false”。 该常量的值为“javax.security.sasl.reuse”。 请注意，必须提供创建SASL客户端/服务器实例所需的所有其他参数和属性，而不管此属性是否已提供。 也就是说，您不能提供任何少于预期重用的信息。 支持重用的机制实现可能允许自定义其实现，例如高速缓存大小，超时和可重用性的标准。 这样的定制是依赖于实现的。

另请参见：

Constant Field Values

POLICY_NOPLAINTEXT

public static final String POLICY_NOPLAINTEXT

指定是否允许容易受到简单的被动攻击的机制（例如“PLAIN”）的属性的名称。 如果"true"这样的机制，该属性包含"true"; "false"如果允许这样的机制。 默认值为"false" 。
该常数的值为"javax.security.sasl.policy.noplaintext" 。

另请参见：

Constant Field Values

POLICY_NOACTIVE

public static final String POLICY_NOACTIVE

指定是否允许容易受到活动（非字典）攻击的机制的属性的名称。 该属性包含"true"如果易受主动攻击的机制是不允许的; "false"如果这样的机制是允许的。 默认值为"false" 。
该常数的值为"javax.security.sasl.policy.noactive" 。

另请参见：

Constant Field Values

POLICY_NODICTIONARY

public static final String POLICY_NODICTIONARY

指定是否允许容易受被动字典攻击的机制的属性的名称。 如果不允许易受字典攻击的"true"则属性包含"true"; "false"如果这样的机制是允许的。 默认值为"false" 。
该常数的值为"javax.security.sasl.policy.nodictionary" 。

另请参见：

Constant Field Values

POLICY_NOANONYMOUS

public static final String POLICY_NOANONYMOUS

指定是否允许接受匿名登录的机制的属性的名称。 该属性包含"true"如果接受匿名登录的机制是不允许的; "false"如果这样的机制是允许的。 默认值为"false" 。
该常数的值为"javax.security.sasl.policy.noanonymous" 。

另请参见：

Constant Field Values

POLICY_FORWARD_SECRECY

public static final String POLICY_FORWARD_SECRECY

指定是否需要在会话之间实现向前保密的机制的属性的名称。 转发保密意味着，打破一个会话将不会自动提供用于打破未来会话的信息。 如果需要在会话之间实现向前保密的"true"则该属性包含"true" ; "false"如果不需要这样的机制。 默认值为"false" 。
该常数的值为"javax.security.sasl.policy.forward" 。

另请参见：

Constant Field Values

POLICY_PASS_CREDENTIALS

public static final String POLICY_PASS_CREDENTIALS

指定是否需要传递客户端凭据的机制的属性的名称。 如果需要通过客户端凭据的"true"则该属性包含"true" ; "false"如果不需要这样的机制。 默认值为"false" 。
该常数的值为"javax.security.sasl.policy.credentials" 。

另请参见：

Constant Field Values

CREDENTIALS

public static final String CREDENTIALS

指定要使用的凭据的属性的名称。 该属性包含一个机制特定的Java凭据对象。 机制实现可以检查此属性的值，以确定它是否是它们支持的类。 该属性可用于向支持委托认证的机制提供凭据。
该常数的值为"javax.security.sasl.credentials" 。

另请参见：

Constant Field Values

方法详细信息

createSaslClient

public static SaslClient createSaslClient(String[] mechanisms,
                                          String authorizationId,
                                          String protocol,
                                          String serverName,
                                          Map<String,?> props,
                                          CallbackHandler cbh)
                                   throws SaslException

创建SaslClient使用所提供的参数。 此方法使用JCA Security Provider Framework ，在“Java加密体系结构API规范与参考”中所述，用于定位和选择SaslClient实现。 首先，它从“SaslClientFactory”服务和指定的SASL机制的注册安全提供程序获取SaslClientFactory实例的有序列表。 然后它在列表上的每个工厂实例上调用createSaslClient() ，直到生成一个非空的SaslClient实例。 它返回非空值SaslClient实例，如果搜索无法生成非空值SaslClient实例，则返回null。

SaslClientFactory的安全提供程序向表单的JCA Security Provider Framework键注册
SaslClientFactory. mechanism_name
和值为javax.security.sasl.SaslClientFactory的javax.security.sasl.SaslClientFactory类的名称。 例如，一个包含工厂类， com.wiz.sasl.digest.ClientFactory ，支持“DIGEST-MD5”机制的提供商将注册以下条目与JCA： SaslClientFactory.DIGEST-MD5 com.wiz.sasl.digest.ClientFactory

有关如何安装和配置安全性服务提供程序的信息，请参阅“Java加密体系结构API规范和参考”。

参数

mechanisms - 要尝试的机制名称的非空列表。 每个都是SASA机制的IANA注册名称。 （例如“GSSAPI”，“CRAM-MD5”）。

authorizationId - 用于授权的可能无效的协议相关标识。 如果为空或为空，则服务器从客户端的身份验证凭据中导出授权标识。 当SASL认证成功完成时，指定的实体被授予访问权限。

protocol - 正在执行身份验证的协议的非空字符串名称（例如，“ldap”）。

serverName - 要验证的服务器的非空的全限定主机名。

props - 用于选择SASL机制并配置所选机制的认证交换的可能的空属性集。 例如，如果props包含值为"true"的Sasl.POLICY_NOPLAINTEXT属性，则所选择的SASL机制不能容易受到简单的普通被动攻击。 除了在此类中声明的标准属性之外，还可以包括其他可能机制特定的属性。 与所选机制无关的属性将被忽略，包括具有非String键的任何地图条目。

cbh - SASL机制使用的可能的空回调处理程序，以从应用程序/库获取进一步的信息来完成认证。 例如，SASL机制可能需要来自呼叫者的身份验证ID，密码和领域。 认证ID是通过使用所请求的NameCallback 。 使用PasswordCallback密码。 该领域是通过使用要求RealmChoiceCallback ，如果有选择，领域列表，并通过使用RealmCallback如果必须输入领域。

结果

可能null SaslClient使用提供的SaslClient创建。 如果为null，找不到SaslClientFactory就会产生一个。

异常

SaslException - 如果由于错误而无法创建 SaslClient 。

createSaslServer

public static SaslServer createSaslServer(String mechanism,
                                          String protocol,
                                          String serverName,
                                          Map<String,?> props,
                                          CallbackHandler cbh)
                                   throws SaslException

创建一个SaslServer指定机制。 此方法使用JCA Security Provider Framework ，在“Java加密体系结构API规范与参考”中所述，用于定位和选择SaslServer实现。 首先，它从“SaslServerFactory”服务和指定机制的注册安全提供程序获取SaslServerFactory实例的有序列表。 然后它在列表上的每个工厂实例上调用createSaslServer() ，直到生成一个非空值SaslServer实例。 它返回非空值SaslServer实例，如果搜索无法生成非空值SaslServer实例，则返回null。

SaslServerFactory的安全提供程序向表单的JCA Security Provider Framework键注册
SaslServerFactory. mechanism_name
和值为javax.security.sasl.SaslServerFactory的javax.security.sasl.SaslServerFactory类的名称。 例如，一个包含工厂类， com.wiz.sasl.digest.ServerFactory ，支持“DIGEST-MD5”机制的提供商将注册以下条目与JCA： SaslServerFactory.DIGEST-MD5 com.wiz.sasl.digest.ServerFactory

有关如何安装和配置安全性服务提供程序的信息，请参阅“Java加密体系结构API规范和参考”。

参数

mechanism - 非空机制名称。 它必须是IANA注册的SASL机制的名称。 （例如“GSSAPI”，“CRAM-MD5”）。

protocol - 正在执行身份验证的协议的非空字符串名称（例如，“ldap”）。

serverName - 服务器的标准主机名，如果服务器未绑定到任何特定主机名，则为null。 如果机制不允许未绑定的服务器，则会抛出SaslException 。

props - 用于选择SASL机制并配置所选机制的认证交换的可能的空属性集。 例如，如果props包含值为"true"的Sasl.POLICY_NOPLAINTEXT属性，则所选择的SASL机制不能容易受到简单的普通被动攻击。 除了在此类中声明的标准属性之外，还可以包括其他可能机制特定的属性。 与所选机制无关的属性将被忽略，包括具有非String键的任何地图条目。

cbh - SASL机制使用的可能的空回调处理程序，以从应用程序/库获取进一步的信息来完成身份验证。 例如，SASL机制可能需要来自呼叫者的身份验证ID，密码和领域。 认证ID是通过使用所请求的NameCallback 。 使用PasswordCallback密码。 该领域是通过使用要求RealmChoiceCallback ，如果有选择，领域列表，并通过使用RealmCallback如果必须输入领域。

结果

可能null SaslServer使用提供的SaslServer创建。 如果为null，找不到SaslServerFactory就会产生一个。

异常

SaslException - 如果由于错误而无法创建 SaslServer 。

getSaslClientFactories

public static Enumeration<SaslClientFactory> getSaslClientFactories()

获得已知工厂的列举，生产SaslClient 。 该方法使用与createSaslClient()相同的算法来定位createSaslClient() 。

结果

已知工厂生产SaslClient的非空 SaslClient 。

另请参见：

createSaslClient(java.lang.String[], java.lang.String, java.lang.String, java.lang.String, java.util.Map<java.lang.String, ?>, javax.security.auth.callback.CallbackHandler)

getSaslServerFactories

public static Enumeration<SaslServerFactory> getSaslServerFactories()

获得已知工厂的列举，生产SaslServer 。 该方法使用与createSaslServer()相同的算法来定位createSaslServer() 。

结果

已知工厂生产SaslServer的 SaslServer 。

另请参见：

createSaslServer(java.lang.String, java.lang.String, java.lang.String, java.util.Map<java.lang.String, ?>, javax.security.auth.callback.CallbackHandler)