cxf+spring+数字签名开发webservice(一)

  • 数字证书的准备

        下面做的服务端和客户端证书在例子中无法加解密,不知道什么原因,我是使用正式环境中的客户端和服务端进行开发测试的,所以需要大家自己去准备证书,或者有人知道为什么jdk生成的一对证书无法加解密的原因那在好不过了。(例子中客户端和服务端都放在一起项目中,大家自己分开开发测试即可)下面是我用jdk生成的证书:

1.1、客户端

1、创建私钥和keystore
                    keytool -genkey -alias clientprivatekey -keypass keypass -keystore client.jks -storepass storepass -dname "CN=zs.com,C=CN" -keyalg RSA
               2、自签名
                    keytool -selfcert -keystore client.jks -storepass storepass -alias clientprivatekey -keypass keypass
               3、导出公钥到rsa
                    keytool -export -alias clientprivatekey -file client.rsa -keystore client.jks -storepass storepass

1.2、服务端

1、创建私钥和keystore
                    keytool -genkey -alias serverprivatekey -keypass keypass -keystore server.jks -storepass storepass -dname "CN=zs.com,C=CN" -keyalg RSA
               2、自签名
                    keytool -selfcert -keystore server.jks -storepass storepass -alias serverprivatekey -keypass keypass
               3、导出公钥到rsa
                    keytool -export -alias serverprivatekey -file server.rsa -keystore server.jks -storepass storepass

1.3、将服务端公钥加入客户端jks中

keytool -import -alias serverprivatekey  -file server.rsa -keystore client.jks -storepass storepass

1.4、将客户端公钥加入服务端jks中

keytool -import -alias clientprivatekey -file client.rsa -keystore server.jks -storepass storepass


  • 证书配置文件

2.1、客户端配置

jks文件放在ca包下,ca包直接在项目的src目录下,配置文件名称为client.properties(放在ca下),注意等号两边不要出现空格

 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=证书的storepass
org.apache.ws.security.crypto.merlin.keystore.alias=证书的别名
org.apache.ws.security.crypto.merlin.file=ca/client.jks

2.2、服务端配置

jks文件放在ca包下,ca包直接在项目的src目录下,配置文件名称为server.properties(放在ca下),注意等号两边不要出现空格

 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=storepass
org.apache.ws.security.crypto.merlin.keystore.alias=serverprivatekey
org.apache.ws.security.crypto.merlin.file=ca/server.jks

  • 秘钥配置类

         3.1、客户端

 package cxf.test.client;

 import java.io.IOException;
import javax.security.auth.callback.Callback;
import javax.security.auth.callback.CallbackHandler;
import javax.security.auth.callback.UnsupportedCallbackException;
import org.apache.ws.security.WSPasswordCallback; public class UTPasswordClientCallBack implements CallbackHandler { @Override
public void handle(Callback[] callbacks) throws IOException,UnsupportedCallbackException {
WSPasswordCallback pc = (WSPasswordCallback) callbacks[0];
pc.setPassword("证书的keypass");
System.out.println("Client Identifier=" + pc.getIdentifier());
System.out.println("Client Password=" + pc.getPassword());
} }

3.2、服务端

 package cxf.test.server;

 import java.io.IOException;

 import javax.security.auth.callback.Callback;
import javax.security.auth.callback.CallbackHandler;
import javax.security.auth.callback.UnsupportedCallbackException; import org.apache.ws.security.WSPasswordCallback; public class UTPasswordServerCallBack implements CallbackHandler { @Override
public void handle(Callback[] callbacks) throws IOException,UnsupportedCallbackException {
WSPasswordCallback pc = (WSPasswordCallback) callbacks[0];
pc.setPassword("证书的keypass");
System.out.println("Client Identifier=" + pc.getIdentifier());
System.out.println("Client Password=" + pc.getPassword());
} }

  • 配置文件

4.1、web.xml配置

 <context-param>
<param-name>contextConfigLocation</param-name>
<param-value>WEB-INF/beans.xml</param-value><!-- spring配置文件 -->
</context-param>
<listener>
<listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
</listener>
<servlet>
<servlet-name>CXFServlet</servlet-name>
<servlet-class>org.apache.cxf.transport.servlet.CXFServlet</servlet-class>
</servlet>
<servlet-mapping>
<servlet-name>CXFServlet</servlet-name>
<url-pattern>/services/*</url-pattern><!-- 匹配services/*后缀url -->
</servlet-mapping>

4.2、beans.xml配置(spring配置文件)

 <?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"
xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://cxf.apache.org/jaxws http://cxf.apache.org/schemas/jaxws.xsd">
<!-- jar包中自带的cxf文件夹下的*.xml文件 -->
<import resource="classpath:META-INF/cxf/cxf.xml" />
<import resource="classpath:META-INF/cxf/cxf-extension-soap.xml" />
<import resource="classpath:META-INF/cxf/cxf-servlet.xml" />
<!-- 配置服务端方法所在的类及数字签名 -->
<jaxws:endpoint id="TestWebService" implementor="cxf.test.server.TestWebServiceImpl"
address="/wstest">
<!-- 通过拦截器对客户端发送的数据和签名进行解密处理 -->
<jaxws:inInterceptors>
<bean class="org.apache.cxf.ws.security.wss4j.WSS4JInInterceptor">
<constructor-arg>
<map>
<entry key="action" value="Signature Encrypt" />
<entry key="signaturePropFile" value="ca/server.properties" />
<entry key="decryptionPropFile" value="ca/server.properties" />
<entry key="passwordCallbackClass" value="cxf.test.server.UTPasswordServerCallBack" />
</map>
</constructor-arg>
</bean>
</jaxws:inInterceptors>
<!-- 通过拦截器将服务端发送给客户端的数据和签名进行加密 -->
<jaxws:outInterceptors>
<bean class="org.apache.cxf.ws.security.wss4j.WSS4JOutInterceptor">
<constructor-arg>
<map>
<entry key="action" value="Signature Encrypt" />
<entry key="user" value="服务端证书别名" />
<entry key="signatureUser" value="服务端证书别名" />
<entry key="signaturePropFile" value="ca/server.properties" />
<entry key="encryptionUser" value="useReqSigCert"></entry>
<entry key="decryptionPropFile" value="ca/server.properties" />
<entry key="passwordCallbackClass" value="cxf.test.server.UTPasswordServerCallBack" />
</map>
</constructor-arg>
<property name="allowMTOM" value="true"></property>
</bean>
</jaxws:outInterceptors>
</jaxws:endpoint>
</beans>

  • 服务端类

5.1、接口类

 package cxf.test.server;

 import javax.jws.WebParam;
import javax.jws.WebService; //配置targetNamespace,不进行配置,将使用当前类所在的包名顺序反向(如果这里没设置,默认命名空间为:http://server.test.cxf/)为命名空间。
//不进行命名空间设置,会存在客户端和服务端需要保持包名一致的问题,这在现实开发中肯定是很麻烦的事
@WebService(name = "TestWebService", targetNamespace = "http://cxf.test.tns/")
public interface TestWebService {
// 为了更好的兼容不同的开发语言、jdk版本等,接口方法的参数和返回结果最好是字符串,对象按xml格式进行编写和解析
// 接口方法的参数最好使用annotation设定接口方法的参数名,不进行设置,默认会在参数前加上“{”等符号(具体符号可能有误),
// 这样可能会给客户端调用带来不必要的麻烦,cxf有好几个annotation配置,如果客户端和服务端传递数据复杂类型参数时出现null等情况,一般进行相应annotation配置即可
public abstract String testMethod(@WebParam(name = "xml") String xml);
}

5.2、接口实现类

 package cxf.test.server;

 public class TestWebServiceImpl implements TestWebService {
public String testMethod(String xml) {
System.out.println(xml);
return "服务端被调用";
}
}
  • 客户端类

6.1、接口类

 package cxf.test.client;

 import javax.jws.WebParam;
import javax.jws.WebService; //使用annotation设置接口的命名空间。如果不进行设置,会出现客户端和服务端的接口类和bean类所在包名需保持一致的问题。出现对象作为参数
//或返回结果时为null的情况,不进行设置,默认按包名的反向顺序(如果该接口方法不进行设置,默认命名空间为:http://server.test.cxf/)作为命名空间
//最好是设置命名空间,包名暴露也不是好事
@WebService(name = "TestWebService", targetNamespace = "http://cxf.test.tns/")
public interface TestWebService {
// 为了更好的兼容不同的开发语言、jdk版本等,接口方法的参数和返回结果最好是字符串,对象按xml格式进行编写和解析
// 接口方法的参数最好使用annotation设定接口方法的参数名,不进行设置,默认会在参数前加上“{”等符号(具体符号可能有误),
// 这样可能会给客户端调用带来不必要的麻烦
public abstract String testMethod(@WebParam(name = "xml") String xml);
}

6.2、公共方法

 package cxf.test.client;

 import java.util.HashMap;
import java.util.Map;
import org.apache.cxf.jaxws.JaxWsProxyFactoryBean;
import org.apache.cxf.ws.security.wss4j.WSS4JInInterceptor;
import org.apache.cxf.ws.security.wss4j.WSS4JOutInterceptor; /**
* 客户端调用服务端公共类
*
* @author yu
*
*/
public class Client {
/**
* 调用服务端接口时,先调用该方法,获得服务端接口方法,该方法设置数字签名的加解密信息
*
* @param address
* wsdl地址,包含“?wsdl”后缀
* @return
*/
public TestWebService call(String address) throws Exception {
JaxWsProxyFactoryBean factory = new JaxWsProxyFactoryBean();
factory.setServiceClass(TestWebService.class);
factory.setAddress(address);
Map<String, Object> properties = new HashMap<String, Object>();
properties.put("mtom-enabled", Boolean.TRUE);
factory.setProperties(properties);
// 客户端请求服务端时,客户端进行签名和加密,对应服务端请求拦截器。
Map<String, Object> outProps = new HashMap<String, Object>();
outProps.put("action", "Signature Encrypt");
outProps.put("user", "85e46503a2958c9137b832ebca4ee304_e9c397b2-2e69-4de0-8183-e978aa23b1d5");// 客户端证书别名
outProps.put("passwordCallbackClass",
UTPasswordClientCallBack.class.getName());
outProps.put("encryptionUser", "9598de1694450bdbe56ff58d7fa55cb9_e9c397b2-2e69-4de0-8183-e978aa23b1d5");// 服务端证书别名
outProps.put("encryptionPropFile", "ca/client.properties");// 客户端证书配置信息
outProps.put("signatureUser", "85e46503a2958c9137b832ebca4ee304_e9c397b2-2e69-4de0-8183-e978aa23b1d5");// 客户端证书别名
outProps.put("signaturePropFile", "ca/client.properties");
WSS4JOutInterceptor outInterceptor = new WSS4JOutInterceptor(outProps);
outInterceptor.setAllowMTOM(true);
factory.getOutInterceptors().add(outInterceptor);
// 服务端响应客户端请求时,客户端对服务端签名和加密进行处理,对应服务端响应拦截器
Map<String, Object> inProps = new HashMap<String, Object>();
inProps.put("action", "Signature Encrypt");
inProps.put("passwordCallbackClass",
UTPasswordClientCallBack.class.getName());
inProps.put("decryptionPropFile", "ca/client.properties");
inProps.put("signaturePropFile", "ca/client.properties");
factory.getInInterceptors().add(new WSS4JInInterceptor(inProps));
TestWebService webService = (TestWebService) factory.create();
return webService;
} }

6.3、测试

 package cxf.test.client;

 public class TestClient {
// 服务端wsdl地址,包含"?wsdl"后缀,wsdl地址一般放在数据库等地方,方便服务端改动时,客户端好更改.
private static String address = "http://127.0.0.1:7001/cxfserver/services/wstest?wsdl"; public static void main(String[] args) {
try {
Client client = new Client();
TestWebService webService = client.call(address);
String result = webService.testMethod("客户端调用服务端");
System.out.println(result);
} catch (Exception e) {
e.printStackTrace();
}
}
}
  • 说明

如果webservice的方法参数和返回值是xml(即将对象编写成xml作为参数传递),可以使用JiBx对对象和xml之间的转换做操作,可以参考下面文章:

http://www.ibm.com/developerworks/cn/java/tutorials/j-jibx1/

上一篇:Vue 入门之 Vuex 实战


下一篇:SOAPUI使用教程-验证SOAP服务