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);

从以下版本开始：

一点五

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 一个属性的名称，指定是否容易受到简单的普通的被动攻击（例如，“普通”）的机制是不允许的。
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

Field Detail

QOP

public static final String QOP

指定要使用的保护的属性的名称。该属性包含一个逗号分隔的、有序的客户端或服务器愿意支持的保护值的质量列表列表。一

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

QoP的值是一个列表的顺序指定的客户端或服务器的优先顺序。如果此属性是不存在的，默认的QOP是 "auth"。此常数的值是 "javax.security.sasl.qop"。

另请参见：

Constant Field Values

STRENGTH

public static final String STRENGTH

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

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

列表的顺序指定的客户端或服务器的优先顺序。一个实现应该允许这些值的意义的配置。应用程序可以使用java加密扩展（JCE）与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"
the。

另请参见：

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"
the。

另请参见：

Constant Field Values

MAX_BUFFER

public static final String MAX_BUFFER

一个属性指定接收在 SaslClient / SaslServer字节缓冲区的最大大小的名称。该属性包含一个整数的字符串表示形式。
if这个属性是不存在的，默认的大小是由机制定义。这个常数的值是 "javax.security.sasl.maxbuffer"
the。

另请参见：

Constant Field Values

RAW_SEND_SIZE

public static final String RAW_SEND_SIZE

名称属性指定的最大大小的原发 SaslClient / SaslServer字节缓冲区。属性包含整数的字符串表示形式。此属性的值在验证交换过程中在客户端和服务器之间协商。这个常数的值是 "javax.security.sasl.rawsendsize"
the。

另请参见：

Constant Field Values

REUSE

public static final String REUSE

指定是否重用先前已验证会话信息的属性的名称。属性包含“真正”，如果机制实现可能尝试重用先前已验证的会话信息；它包含“错误”，如果实现不能重用先前已验证的会话信息。一个设置的“真正的”只是作为一个提示：它不一定意味着实际的重用，因为重用可能是可能的，因为一些原因，包括，但不限于，缺乏机制的支持，重用，过期的可重复使用的信息，和同行的拒绝支持重用。该属性的默认值为“假”。该常数的值是“javax.安全。SASL。复用”。请注意，所有其他参数和性能，需要创建一个SASL客户端/服务器实例必须提供无论此属性提供了。也就是说，你不能提供任何较少的信息，在预期的重用。机制的实现，支持重用，可以实现个性化定制，如缓存大小、因素超时，和标准的可重用性。这种自定义的实现依赖。

另请参见：

Constant Field Values

POLICY_NOPLAINTEXT

public static final String POLICY_NOPLAINTEXT

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

另请参见：

Constant Field Values

POLICY_NOACTIVE

public static final String POLICY_NOACTIVE

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

另请参见：

Constant Field Values

POLICY_NODICTIONARY

public static final String POLICY_NODICTIONARY

指定的属性的名称，指定是否容易受到被动字典攻击的机制是不允许的。该属性包含 "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"如果实现了保密之间的会话机制是必需的；如果不需要这样的机制 "false"。默认的是 "false"。
此常数的值是 "javax.security.sasl.policy.forward"。

另请参见：

Constant Field Values

POLICY_PASS_CREDENTIALS

public static final String POLICY_PASS_CREDENTIALS

指定是否需要通过客户端凭据的机制的名称。该属性包含 "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实例有序列表从注册安全提供商“saslclientfactory”服务和指定的机制（S）。然后调用列表上的每个工厂实例 createSaslClient()直到产生一个非零 SaslClient实例。它返回非零 SaslClient实例，或null如果搜索未能产生一个非空的 SaslClient实例。

一个saslclientfactory寄存器与JCA安全提供者框架键的形式
SaslClientFactory.mechanism_name
和价值观，是实现javax.security.sasl.SaslClientFactory类名安全提供商。例如，包含一个工厂类，com.wiz.sasl.digest.ClientFactory提供者，支持“DIGEST-MD5”机制将登记与JCA以下条目：SaslClientFactory.DIGEST-MD5 com.wiz.sasl.digest.ClientFactory

看到“java加密体系API规范和参考”有关如何安装和配置安全服务提供商。

参数

mechanisms -非空表机构名称的尝试。每个IANA注册名SASL机制。（例如“GSSAPI”、“CRAM-MD5”）。

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

protocol -非空字符串名称的协议的认证正在进行中（例如，“LDAP”）。

serverName -非空的完全限定主机名的服务器进行身份验证。

props -用于选择机制和配置的选择机制的认证交换性能可能是空集。例如，如果 props包含 Sasl.POLICY_NOPLAINTEXT财产价值 "true"，然后选择机制不易简单被动攻击。除了在这个类中声明的标准属性，其他的，可能机制特定的属性，可以包括。未被忽略的属性与所选机制无关，包括非字符串键的任何Map项。

cbh -可能的空回调函数通过SASL机制用于从应用程序/库得到进一步的信息来完成身份认证。例如，一个机制可能需要验证身份，从对方的密码和境界。认证ID是用 NameCallback要求。密码是用 PasswordCallback要求。境界是要求用 RealmChoiceCallback如果有一列领域的选择，以及如果领域必须输入一个 RealmCallback。

结果

使用提供的参数创建一个可能的空 SaslClient。如果为空，找不到一个 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实例，或null如果搜索未能产生一个非空的 SaslServer实例。

一个saslserverfactory寄存器与JCA安全提供者框架键的形式
SaslServerFactory.mechanism_name
和价值观，是实现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 -用于选择机制和配置的选择机制的认证交换性能可能是空集。例如，如果 props包含 Sasl.POLICY_NOPLAINTEXT财产价值 "true"，然后选择机制不易简单被动攻击。除了在这个类中声明的标准属性，其他的，可能机制特定的属性，可以包括。未被忽略的属性与所选机制无关，包括非字符串键的任何Map项。

cbh -可能的空回调函数通过SASL机制用于从应用程序/库得到进一步的信息来完成身份认证。例如，一个机制可能需要验证身份，从对方的密码和境界。认证ID是用 NameCallback要求。密码是用 PasswordCallback要求。境界是要求用 RealmChoiceCallback如果有一列领域的选择，以及如果领域必须输入一个 RealmCallback。

结果

使用提供的参数创建一个可能的空 SaslServer。如果为空，找不到一个 SaslServerFactory将产生一个。

异常

SaslException如果不能创造一个 SaslServer因为错误。

getSaslClientFactories

public static Enumeration<SaslClientFactory> getSaslClientFactories()

获取生产 SaslClient已知工厂枚举。此方法使用同样的算法定位工厂 createSaslClient()。

结果

生产 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()。

结果

生产 SaslServer非已知工厂零计数。

另请参见：

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