Java Web 服务: 通过 CXF 使用 WS-Security

如何通过 Apache CXF Web 服务堆栈使用 WS-Security

Apache CXF Web 服务堆栈支持 WS-Security,包括使用 WS-SecurityPolicy 配置安全处理。CXF 允许通过灵活地配置运行时使用的部署参数实现安全处理,支持客户端使用静态和动态配置方法。在本文中,Java Web 服务 系列的作者 Dennis Sosnoski 讲解如何在简单的 UsernameToken WS-Security 示例和使用签名和加密的示例中使用 CXF。

Dennis Sosnoski, 咨询师, Sosnoski Software Associates Ltd

Dennis Sosnoski 是一名咨询师和培训师,专长是基于 Java 的 XML 和 Web 服务。他有 30 多年的专业软件开发经验,最近 10 年一直致力于服务器端 XML 和 Java 技术方面的工作。Dennis 是开源 JiBX XML Data Binding 框架及相关的 JiBX/WS Web 服务框架的首席开发人员,也是 Apache Axis2 Web 服务框架的提交者。他还是 JAX-WS 2.0 和 JAXB 2.0 规范的专家组成员之一。



2010 年 4 月 19 日

本系列 前面的文章讨论的 Axis2 和 Metro Web 服务堆栈一样,Apache CXF 支持使用 WS-Security SOAP 扩展技术提供一整套用于消息交换的与安全相关的功能(关于 CXF 的基础知识见 “CXF 简介”)。与这些堆栈一样,CXF 也使用 WS-SecurityPolicy 配置 WS-Security 安全处理(也可以手工配置)。

CXF 的 WS-Security 实现基于开放源码的 WSS4J 库(见 参考资料)。Axis2 代码也使用这个库,因此这两个堆栈的 WS-Security 配置细节有一些相似之处。但是,通过解释 WS-SecurityPolicy 配置 WSS4J 的代码层不一样。在 Axis2 中这由单独发布的 Rampart 模块处理,而在 CXF 中由 cxf-rt-ws-policy 和 cxf-rt-ws-security 模块处理(这些模块包含在标准的 cxf-#.jar 中,其中的 # 是版本号)。

在本文中,您会看到在 CXF 中配置 WS-Security 处理的两个示例。第一个示例是一个简单的 UsernameToken,它仅仅包装明文用户名和密码。第二个示例使用 X.409 证书和密钥对消息进行签名和加密。这些示例与 “Axis2 WS-Security 基础” 和 “Axis2 WS-Security 签名和加密” 中通过 Axis2 和 Metro 实现的示例一致,这样您就可以看出这些堆栈的技术差异。可以 下载 本文的源代码。

配置基础

关于本系列

Web 服务构成了 Java 技术在企业计算应用中的关键部分。在本系列文章中,XML 和 Web 服务顾问 Dennis Sosnoski 介绍对于使用 Web 服务的 Java 开发人员来说比较重要的主要框架和技术。通过跟随本系列学习,您将了解到该领域的最新进展,并且知道如何使用它们来为您的编程项目提供帮助。

WS-SecurityPolicy 安全配置指定在客户机和服务之间交换的消息所需的安全处理。在大多数情况下,Web 服务堆栈还需要更多信息,才能对消息交换应用安全措施。例如,WS-SecurityPolicy 可能要求客户机对发送到服务器的请求消息进行签名,这为服务提供不可否认性。在这种情况下,在把消息发送到服务时,客户机 Web 服务堆栈需要通过某种方法确定用于签名的私有密钥。

Axis2 和 Metro 使用定制的 WS-SecurityPolicy 扩展提供这种安全参数。因为 WS-SecurityPolicy 通常嵌入在 WSDL 服务描述中,所以一般需要通过修改 WSDL 文档添加这些信息(Axis2 也允许在客户机代码中直接设置策略)。修改 WSDL 文档很麻烦,而且违背 WSDL 的意图(即作为服务描述)。

CXF 采用不同的方法,可能应该说多种不同的方法,因为可以通过多种方法为 CXF 配置在对消息应用 WS-SecurityPolicy 配置时需要的参数。在客户端,可以直接在客户机代码中配置,也可以使用 Spring XML 配置文件。在服务器端,需要使用 XML 配置文件,但是仍然可以选择不同的文件类型。在本文的示例中,将演示客户机和服务器可以采用的不同方法。


CXF 中的 UsernameToken

UsernameToken 是向 WS-Security 提供用户名和密码对的标准方法。可以以明文形式发送密码信息(通常只在与 Transport Layer Security [TLS] 或 WS-Security 加密结合使用时用于生产环境,但是便于测试),也可以以散列值形式发送。它对于需要直接身份验证的许多应用程序很方便。UsernameToken 是 WS-Security 特性最简单的形式,很适合作为第一个示例。

要想在 CXF 中实现简单的明文 UsernameToken 示例,需要一个 WSDL 服务定义,其中应该包含适当的 WS-Policy/WS-SecurityPolicy 配置。清单 1 给出 “CXF 简介” 中使用的基本 WSDL 服务定义经过编辑之后的版本。清单 1 包含的策略信息要求在客户机发送给服务器的请求中有 UsernameToken<wsdl:binding> 中的策略引用和策略本身以粗体显示。

清单 1. 明文 UsernameToken WSDL
<?xml version="1.0" encoding="UTF-8"?> 
<wsdl:definitions targetNamespace="http://ws.sosnoski.com/library/wsdl"
    xmlns:wns="http://ws.sosnoski.com/library/wsdl"
    xmlns:tns="http://ws.sosnoski.com/library/types"
    xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"
    xmlns:wsdlsoap="http://schemas.xmlsoap.org/wsdl/soap/">
  
  <!-- Policy for UsernameToken with plaintext password, sent from client to
    server only -->
  <wsp:Policy wsu:Id="UsernameToken" xmlns:wsu=
  "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd"
   xmlns:wsp="http://schemas.xmlsoap.org/ws/2004/09/policy"
   xmlns:sp="http://docs.oasis-open.org/ws-sx/ws-securitypolicy/200702">
   <wsp:ExactlyOne>
      <wsp:All>
        <!-- Empty <TransportBinding/> element required due to bug in CXF 2.2.6 -->
        <sp:TransportBinding/>
        <sp:SupportingTokens>
          <wsp:Policy>
            <sp:UsernameToken sp:IncludeToken=".../IncludeToken/AlwaysToRecipient"/>
          </wsp:Policy>
        </sp:SupportingTokens>
      </wsp:All>
    </wsp:ExactlyOne>
  </wsp:Policy>
  
  <wsdl:types>
    ...
  </wsdl:types>

  <wsdl:message name="getBookRequest">
    <wsdl:part element="wns:getBook" name="parameters"/>
  </wsdl:message>
  ...

  <wsdl:portType name="Library">

    <wsdl:operation name="getBook">
      <wsdl:input message="wns:getBookRequest" name="getBookRequest"/>
      <wsdl:output message="wns:getBookResponse" name="getBookResponse"/>
    </wsdl:operation>
    ...

  </wsdl:portType>

  <wsdl:binding name="LibrarySoapBinding" type="wns:Library">
  
    <wsp:PolicyReference xmlns:wsp="http://schemas.xmlsoap.org/ws/2004/09/policy"
        URI="#UsernameToken"/>

    <wsdlsoap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http"/>

    <wsdl:operation name="getBook">
    
      <wsdlsoap:operation soapAction="urn:getBook"/>
      
      <wsdl:input name="getBookRequest">
        <wsdlsoap:body use="literal"/>
      </wsdl:input>
      
      <wsdl:output name="getBookResponse">
        <wsdlsoap:body use="literal"/>
      </wsdl:output>
      
    </wsdl:operation>
    ...

  </wsdl:binding>

  <wsdl:service name="CXFLibrary">

    <wsdl:port binding="wns:LibrarySoapBinding" name="library">
      <wsdlsoap:address location="http://localhost:8080/cxf-library-username"/>
    </wsdl:port>

  </wsdl:service>


</wsdl:definitions>

清单 1 与 Axis2 和 Metro 示例使用的 WSDL 之间有一个重要的差异。这个版本的 WS-SecurityPolicy 配置中包含一个空的 <sp:TransportBinding/> 元素,这是因为本文使用的 CXF 2.2.6 中有一个 bug。如果没有 <sp:TransportBinding/> 或某种形式的加密或签名,CXF 的 WS-SecurityPolicy 处理就无法处理 UsernameToken。在高于 2.2.6 的 CXF 版本中应该会纠正这个错误。

清单 1 中的 WSDL 告诉要访问这个服务的任何客户机在安全处理方面需要做什么。正如前面提到的,要想使用策略,一般需要向 CXF 提供额外的参数。在这个示例中,参数是客户机代码在发送请求时使用的用户名和密码,还有服务器端在接收请求时检验用户名和密码的方法。下面的示例演示如何向消息交换的两端提供这些额外信息。

客户端使用方法

可以在客户机代码中动态地配置 CXF 客户机 WS-Security 支持,也可以在配置文件中静态地配置。清单 2 是在客户机代码中动态地配置 UsernameToken 的示例。

清单 2. 在客户机代码中动态地配置 UsernameToken
// create the client stub
CXFLibrary service = new CXFLibrary();
Library stub = service.getLibrary();

...
// set the username and password
Map ctx = ((BindingProvider)stub).getRequestContext();
ctx.put("ws-security.username", "libuser");
ctx.put("ws-security.password", "books");

JAX-WS 客户机使用生成的代理接口访问服务。在 清单 2 中,这是 Library 接口。通过调用生成的 javax.xml.ws.Service 的子类(在这里是 CXFService 类)的一个方法,创建接口的实例(在示例代码中称为 stub)。尽管在生成的代码的 API 中没有反映出来,但是 JAX-WS 会保证返回的代理接口实例总是 javax.xml.ws.BindingProvider 类的子类。要想动态地配置 CXF,需要使用这个隐含的类型并把代理转换为 BindingProvider 类,然后通过类型转换访问请求上下文属性映射。清单 2 演示如何在属性映射中为 WS-Security 处理设置用户名和密码。

静态配置使用与动态配置相同的属性值,只是以不同的方法设置。CXF 在启动时在类路径中寻找配置文件,如果找到了,就用它设置属性值。在默认情况下,这个配置文件必须名为 cxf.xml,必须放在类路径的根目录中(但是可以使用系统属性 cxf.config.file.url 修改默认设置)。清单 3 给出一个 cxf.xml 文件示例(下载代码中的 cxf-username-client.xml),可以用它替代 清单 2 所示的动态配置:

清单 3. 在 cxf.xml 中静态地配置 UsernameToken
<beans xmlns="http://www.springframework.org/schema/beans"
   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xmlns:jaxws="http://cxf.apache.org/jaxws"
   xsi:schemaLocation="http://www.springframework.org/schema/beans 
   http://www.springframework.org/schema/beans/spring-beans-2.0.xsd
   http://cxf.apache.org/jaxws 
   http://cxf.apache.org/schemas/jaxws.xsd">

  <jaxws:client name="{http://ws.sosnoski.com/library/wsdl}library"
      createdFromAPI="true">
    <jaxws:properties>
      <entry key="ws-security.username" value="libuser"/>
      <entry key="ws-security.password" value="books"/>
    </jaxws:properties>
  </jaxws:client>
</beans>

如果要使用固定的 WS-Security 参数值,静态配置方法比较方便。必须确保配置文件的名称及其在类路径中的位置正确,因为这个文件是可选的,如果没有找到它,CXF 会继续运行,不会发出警告(直到它试图使用 WS-Security 时由于缺少所需的参数而失败)。如果遇到了问题,可以检查客户机的 INFO 级日志输出。应该会看到消息 INFO: Loaded configuration file cxf.xml.(或者通过 cxf.config.file.url 系统属性设置的其他文件名);如果没有 看到这个消息,就说明没有找到文件,需要检查类路径以查明原因。

服务器端使用方法

在服务器端,必须使用配置文件提供 WS-Security 参数。最简单的方法是把这些信息添加到定义服务端点的 cxf-servlet.xml 文件中。清单 4 给出 “CXF 简介” 中使用的 cxf-servlet.xml 经过修改之后的版本,添加的 WS-Security 信息以粗体显示(下载代码中的 server/etc/cxf-username-servlet.xml):

清单 4. 添加了安全参数的 cxf-servlet.xml
<?xml version="1.0" encoding="UTF-8"?> 
<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:jaxws="http://cxf.apache.org/jaxws"
    xmlns:soap="http://cxf.apache.org/bindings/soap"
    xsi:schemaLocation="http://www.springframework.org/schema/beans
      http://www.springframework.org/schema/beans/spring-beans-2.0.xsd
      http://cxf.apache.org/jaxws
      http://cxf.apache.org/schemas/jaxws.xsd">

  <jaxws:endpoint id="Processor"
      implementor="com.sosnoski.ws.library.cxf.CXFLibraryImpl"

      wsdlLocation="WEB-INF/wsdl/library-signencr.wsdl"
      address="/">

    <jaxws:properties>
      <entry key="ws-security.callback-handler"
          value="com.sosnoski.ws.library.cxf.ServerCallback"/>
    </jaxws:properties>

  </jaxws:endpoint>
</beans>

为这个 UsernameToken 示例添加的配置信息是一个安全回调类。Axis2 和 Metro 示例也使用这种方法。WS-Security 代码用用户名和密码信息调用用户提供的回调类,这个类实现 javax.security.auth.callback.CallbackHandler 接口。这个回调类可以实现您需要的任何用户名和密码组合检验方法,所以这种技术非常灵活。

清单 5 给出示例代码使用的回调类。这个类可以处理检验用户名和密码的 UsernameToken 示例,也可以处理使用签名和加密的示例(在本文的下一节中讨论)。

清单 5. 服务器端回调类
**
 * Simple password callback handler. This just handles two cases: matching the username
 * and password, and providing the password used for access to the private key.
 */
public class ServerCallback implements CallbackHandler {
  public void handle(Callback[] callbacks)
  throws IOException, UnsupportedCallbackException {
    for (int i = 0; i < callbacks.length; i++) {
      WSPasswordCallback pwcb = (WSPasswordCallback)callbacks[i];
      String id = pwcb.getIdentifier();
      switch (pwcb.getUsage()) {
          case WSPasswordCallback.USERNAME_TOKEN_UNKNOWN:

              // used when plaintext password in message
              if (!"libuser".equals(id) || !"books".equals(pwcb.getPassword())) {
                    throw new UnsupportedCallbackException(callbacks[i], "check failed");
                }
                break;

        case WSPasswordCallback.DECRYPT:
        case WSPasswordCallback.SIGNATURE:

              // used to retrieve password for private key
              if ("serverkey".equals(id)) {
                    pwcb.setPassword("serverpass");
                }
                break;
      }
    }
  }
}

也可以不使用默认的 cxf-servlet.xml,而是在 Web 应用程序的 web.xml 文件中指定另一个文件来提供服务器端配置。这种方法比较复杂,因为必须直接指定在服务器上要使用的每个 CXF 模块,但是这会加快 Web 应用程序的启动速度。详细信息见 CXF 文档 “Configuration” 页面中的 “Server configuration files” 主题。

构建并运行示例代码

在运行示例代码之前,需要下载并在自己的系统上安装 CXF 的当前版本(见 参考资料)。还需要编辑解压后的 示例代码 的根目录中的 build.properties 文件,把 cxf-home 属性改为 CXF 的安装路径。如果打算用不同的系统上的服务器或不同的端口进行测试,还需要修改 host-namehost-port

为了使用提供的 Ant build.xml 构建示例应用程序,打开一个控制台,进入下载代码的根目录,然后输入 ant。这首先调用 CXF WSDLToJava 工具来生成 JAX-WS 2.x 服务类和 JAXB 2.x 数据模型类,然后编译客户机和服务器,最后把服务器代码打包为一个 WAR。然后,可以把生成的 cxf-library-username.war 文件部署到测试服务器上,在控制台上输入 ant run 运行示例客户机。示例客户机向服务器发送几个请求,输出每个请求的简要结果。


在 CXF 中实现签名和加密

UsernameToken 很简单,很适合作为起点,但这不是 WS-Security 的典型用法。在使用 WS-Security 时,往往会涉及签名和/或加密。清单 6 给出一个使用签名和加密的 WSDL 示例(基于前面的 “Metro 服务下的 WS-Security” 和 “Axis2 WS-Security 签名和加密” 中的示例)。在 Axis2 文章中可以找到对签名和加密的详细讨论,以及为 WS-Security 生成和使用自签名证书的详细信息。WSDL 的策略部分以粗体显示。

清单 6. 签名/加密 WSDL
<?xml version="1.0" encoding="UTF-8"?> 
<wsdl:definitions targetNamespace="http://ws.sosnoski.com/library/wsdl"
    xmlns:wns="http://ws.sosnoski.com/library/wsdl"
    xmlns:tns="http://ws.sosnoski.com/library/types"
    xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"
    xmlns:wsdlsoap="http://schemas.xmlsoap.org/wsdl/soap/">
  
  <!-- Policy for first signing and then encrypting all messages, with the 
   certificate included in the message from client to server but only a thumbprint 
   on messages from the server to the client. -->
  <wsp:Policy wsu:Id="SignEncr"
      xmlns:wsu="http://docs.oasis-open.org/...-wss-wssecurity-utility-1.0.xsd"
      xmlns:wsp="http://schemas.xmlsoap.org/ws/2004/09/policy">
  
    <wsp:ExactlyOne>
      <wsp:All>
        <sp:AsymmetricBinding
            xmlns:sp="http://docs.oasis-open.org/ws-sx/ws-securitypolicy/200702">
          <wsp:Policy>
            <sp:InitiatorToken>
              <wsp:Policy>
                <sp:X509Token sp:IncludeToken=".../AlwaysToRecipient">
                  <wsp:Policy>
                    <sp:RequireThumbprintReference/>
                  </wsp:Policy>
                </sp:X509Token>
              </wsp:Policy>
            </sp:InitiatorToken>
            <sp:RecipientToken>
              <wsp:Policy>
                <sp:X509Token sp:IncludeToken=".../Never">
                  <wsp:Policy>
                    <sp:RequireThumbprintReference/>
                  </wsp:Policy>
                </sp:X509Token>
              </wsp:Policy>
            </sp:RecipientToken>
            <sp:AlgorithmSuite>
              <wsp:Policy>
                <sp:TripleDesRsa15/>

              </wsp:Policy>
            </sp:AlgorithmSuite>
            <sp:Layout>
              <wsp:Policy>
                <sp:Strict/>
              </wsp:Policy>
            </sp:Layout>
            <sp:IncludeTimestamp/>
            <sp:OnlySignEntireHeadersAndBody/>
          </wsp:Policy>
        </sp:AsymmetricBinding>
        <sp:SignedParts
            xmlns:sp="http://docs.oasis-open.org/ws-sx/ws-securitypolicy/200702">
          <sp:Body/>

        </sp:SignedParts>
        <sp:EncryptedParts
            xmlns:sp="http://docs.oasis-open.org/ws-sx/ws-securitypolicy/200702">
          <sp:Body/>
        </sp:EncryptedParts>
      </wsp:All>
    </wsp:ExactlyOne>
  </wsp:Policy>
  
  <wsdl:types>
    ...
  </wsdl:types>

  <wsdl:message name="getBookRequest">
    <wsdl:part element="wns:getBook" name="parameters"/>
  </wsdl:message>
  ...
  
  <wsdl:portType name="Library">
    ...
  </wsdl:portType>

  <wsdl:binding name="LibrarySoapBinding" type="wns:Library">
  
    <wsp:PolicyReference xmlns:wsp="http://schemas.xmlsoap.org/ws/2004/09/policy"
        URI="#SignEncr"/>

    <wsdlsoap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http"/>

    <wsdl:operation name="getBook">
    
      <wsdlsoap:operation soapAction="urn:getBook"/>
      
      <wsdl:input name="getBookRequest">
        <wsdlsoap:body use="literal"/>
      </wsdl:input>
      
      <wsdl:output name="getBookResponse">
        <wsdlsoap:body use="literal"/>
      </wsdl:output>
      

    </wsdl:operation>
    ...
  </wsdl:binding>

  <wsdl:service name="CXFLibrary">

    <wsdl:port binding="wns:LibrarySoapBinding" name="library">
      <wsdlsoap:address location="http://localhost:8080/cxf-library-signencr"/>
    </wsdl:port>

  </wsdl:service>

</wsdl:definitions>

清单 6 与前面文章中使用的 WSDL 之间只有一个显著的差异,WS-Policy/WS-SecurityPolicy 部分转移到了 WSDL 的开头,与 WSDL 1.1 模式定义的最新版本保持一致。

与简单的 UsernameToken 示例相比,使用私有密钥-证书对进行消息签名和加密的配置比较复杂。需要指定密钥存储作为密钥和证书的来源,还要提供访问密钥存储所需的密码。必须通过 .properties 文件提供密钥存储信息;必须通过回调提供用于访问私有密钥的密码。接下来,看看在客户机和服务器上的实现方式。

客户端使用方法

UsernameToken 示例一样,可以在客户机代码中直接配置消息签名和加密所需的安全参数,也可以使用 cxf-client.xml 配置文件。清单 7 给出用于签名和加密的 cxf-client.xml(示例代码中的 cxf-signencr-client.xml):

清单 7. 包含签名和加密参数的 cxf-client.xml
<beans xmlns="http://www.springframework.org/schema/beans"
   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xmlns:jaxws="http://cxf.apache.org/jaxws"
   xsi:schemaLocation="http://www.springframework.org/schema/beans 
   http://www.springframework.org/schema/beans/spring-beans-2.0.xsd
   http://cxf.apache.org/jaxws 
   http://cxf.apache.org/schemas/jaxws.xsd">

  <jaxws:client name="{http://ws.sosnoski.com/library/wsdl}library"
      createdFromAPI="true">
    <jaxws:properties>
      <entry key="ws-security.signature.properties"
          value="client-crypto.properties"/>
      <entry key="ws-security.signature.username" value="clientkey"/>
      <entry key="ws-security.encryption.properties"
          value="client-crypto.properties"/>
      <entry key="ws-security.encryption.username" value="serverkey"/>
      <entry key="ws-security.callback-handler"
          value="com.sosnoski.ws.library.cxf.ClientCallback"/>
    </jaxws:properties>
  </jaxws:client>

</beans>

清单 7 所示的 cxf-client.xml 定义了两对属性文件和用户名,一对用于签名处理,另一对用于加密处理。每个属性文件指定一个密钥存储并提供访问密钥存储所需的信息。相关联的用户名值指定存储中要使用的密钥(用于处理签名)或证书(用于处理加密)。在这里,签名处理和加密处理使用同一个密钥存储,其中包含服务器证书与客户机私有密钥和证书。因为只有一个存储,这两个属性引用同一个 client-crypto.properties 文件。这个文件必须放在类路径的根目录中,见 清单 8

清单 8. client-crypto.properties 文件
org.apache.ws.security.crypto.provider=org.apache.ws.security.components.crypto.Merlin 
org.apache.ws.security.crypto.merlin.keystore.type=jks 
org.apache.ws.security.crypto.merlin.keystore.password=nosecret 
org.apache.ws.security.crypto.merlin.file=client.keystore

底层的 WSS4J WS-Security 代码使用 清单 8 所示的属性文件配置签名和加密处理。它指定用来处理签名和加密的 “提供者”、密钥存储的类型、密钥存储密码和密钥存储文件(必须放在类路径的根目录中)。

除了密钥存储信息之外,清单 7 中的 cxf-client.xml 文件还定义另一个参数 — ws-security.callback-handler,在前面的 清单 4 cxf-servlet.xml 中见过这个参数。与前面的示例一样,这个参数的值必须是一个安全回调处理器类。当 WSS4J 代码需要访问密钥存储密码以获取客户机私有密钥时,它调用这个类的实例。示例代码中使用的实现见 清单 9

清单 9. 客户端回调类
/**
 * Simple password callback handler. This just checks if the password for the private key
 * is being requested, and if so sets that value.
 */
public class ClientCallback implements CallbackHandler {
  public void handle(Callback[] callbacks) throws IOException {
    for (int i = 0; i < callbacks.length; i++) {
      WSPasswordCallback pwcb = (WSPasswordCallback)callbacks[i];
      String id = pwcb.getIdentifier();
      int usage = pwcb.getUsage();
      if (usage == WSPasswordCallback.DECRYPT || usage == WSPasswordCallback.SIGNATURE) {

         // used to retrieve password for private key
         if ("clientkey".equals(id)) {
             pwcb.setPassword("clientpass");
         }

      }
    }
  }
}

UsernameToken 示例一样,可以不使用 cxf-client.xml 文件,而是在客户机代码中配置安全参数。甚至可以把 清单 8 中的属性文件替换为在代码中构造的值,设置一个 java.util.Properties,作为请求上下文中 ws-security.encryption.properties 键的值。(参见 清单 2 中以这种方式设置用户名和密码属性的示例。)

服务器端使用方法

在服务器端,需要在 cxf-servlet.xml 文件中包含与客户机基本相同的安全参数。清单 10 给出示例代码中使用的 cxf-servlet.xml(示例代码中的 server/etc/cxf-signencr-servlet.xml),添加的 WS-Security 参数以粗体显示:

清单 10. 添加了安全参数的 cxf-servlet.xml
<?xml version="1.0" encoding="UTF-8"?> 
<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:jaxws="http://cxf.apache.org/jaxws"
    xmlns:soap="http://cxf.apache.org/bindings/soap"
    xsi:schemaLocation="http://www.springframework.org/schema/beans
      http://www.springframework.org/schema/beans/spring-beans-2.0.xsd
      http://cxf.apache.org/jaxws
      http://cxf.apache.org/schemas/jaxws.xsd">

  <jaxws:endpoint id="Processor"
      implementor="com.sosnoski.ws.library.cxf.CXFLibraryImpl"
      wsdlLocation="WEB-INF/wsdl/library-signencr.wsdl"
      address="/">

    <jaxws:properties>
      <entry key="ws-security.signature.properties" value="server-crypto.properties"/>
      <entry key="ws-security.signature.username" value="serverkey"/>
      <entry key="ws-security.encryption.username" value="useReqSigCert"/>
      <entry key="ws-security.callback-handler"
          value="com.sosnoski.ws.library.cxf.ServerCallback"/>
    </jaxws:properties>

  </jaxws:endpoint>
</beans>

这个服务器版本与客户机设置的主要差异是,它没有指定加密属性文件,而且加密用户名设置是 useReqSigCert。这个值是 WSS4J 能够识别的特殊名称,这表示应该使用请求签名所用的客户机证书对响应进行加密。使用这个设置让服务器代码可以处理多个客户机,每个客户机有自己的证书。

server-crypto.properties 文件实际上与 清单 8 所示的 client-crypto.properties 相同。服务器回调类与 UsernameToken 示例中使用的相同,见 清单 5

构建并运行示例代码

对于签名和加密示例,需要修改 build.properties 文件以使用 variant-name=signencr(而不是 UsernameToken 示例使用的 username 值)。除此之外,构建步骤UsernameToken 示例相同。

如果使用 CXF 当前的 2.2.6 版运行客户机,会看到某种 WARNING 级日志输出,例如 WARNING: No assertion builder for type ... registered。这些消息并不意味着代码中有任何问题,在以后的 CXF 版本中可能不会出现。


结束语

在本文中,您了解了如何通过 CXF 使用 WS-Security。与 Axis2 和 Metro 一样,CXF 支持在 WSDL 中设置 WS-SecurityPolicy 这种标准的 WS-Security 配置方法。根据应用程序的需要,可以以几种方法配置额外的安全参数,不需要把部署信息嵌入在服务 WSDL 中。因此,与 Axis2 和 Metro 相比,CXF 使用 WS-Security 的方法更简便更清晰。

测试本文的示例代码时发现了 CXF 中的一个 bug,这个 bug 正在纠正。它导致 UsernamePolicy 被忽略,除非这个策略也要求其他形式的安全处理。很难根据本文中的简单示例评价 CXF WS-SecurityPolicy 处理的健壮性,但是它的设计看起来是可靠的,很可能有越来越多的人使用这个相当新的 CXF 特性,实现中的问题会很快解决。

Java Web 服务 的下一期继续讨论 CXF,这一次讨论性能问题。我要对比 CXF 与最新 Axis2 和 Metro 版本的性能,包括简单的消息交换和使用 WS-Security 两种情况。


下载

描述名字大小
本文的源代码j-jws13.zip28KB

参考资料

学习

获得产品和技术

讨论

条评论

developerWorks: 登录

标有星(*)号的字段是必填字段。


需要一个 IBM ID?
忘记 IBM ID?


忘记密码?
更改您的密码

单击提交则表示您同意developerWorks 的条款和条件。 查看条款和条件

 


在您首次登录 developerWorks 时,会为您创建一份个人概要。您的个人概要中的信息(您的姓名、国家/地区,以及公司名称)是公开显示的,而且会随着您发布的任何内容一起显示,除非您选择隐藏您的公司名称。您可以随时更新您的 IBM 帐户。

所有提交的信息确保安全。

选择您的昵称



当您初次登录到 developerWorks 时,将会为您创建一份概要信息,您需要指定一个昵称。您的昵称将和您在 developerWorks 发布的内容显示在一起。

昵称长度在 3 至 31 个字符之间。 您的昵称在 developerWorks 社区中必须是唯一的,并且出于隐私保护的原因,不能是您的电子邮件地址。

标有星(*)号的字段是必填字段。

(昵称长度在 3 至 31 个字符之间)

单击提交则表示您同意developerWorks 的条款和条件。 查看条款和条件.

 


所有提交的信息确保安全。


static.content.url=http://www.ibm.com/developerworks/js/artrating/
SITE_ID=10
Zone=Java technology, SOA and web services, Open source
ArticleID=483280
ArticleTitle=Java Web 服务: 通过 CXF 使用 WS-Security
publish-date=04192010