使用gSOAP开发实例--Usernametoken Authentication实现.docx

使用gSOAP开发实例 自定义header实现用户名令牌认证(Usernametoken Authentication)上一节介绍了怎样实现基本认证(Basic Authentication，以下简称basic方式)，望文生义，也就是最简单的用户验证方式，本节稍微深入一些，介绍用户名令牌认证(Usernametoken Authentication，以下简称usernametoken方式)。 Usernametoken方式与basic方式不同的地方，在于后者会把用户名和密码以摘要(digest)的形式，置于HTTP信息头，而前者则把用户名以明文的形式、密码以明文或者摘要的形式，嵌入到一段XML文本中，再置于SOAP消息头当中。 如果使用soapUI调试客户端程序的话，会发现以下是basic方式发出的完整的SOAP消息： POST /Services/ECHO HTTP/0.9 Content-Type: text/xml;charset=UTF-8 SOAPAction: User-Agent: Jakarta Commons-HttpClient/3.1 Content-Length: 292 Authorization: Basic VkYtSEstbVNNST0OdlR42EMZaD1BMyE= Host: Cookie: $Version=0; MSP2LB=test2.test2f02; $Path=/ hello 以下是usernametoken方式发出的完整的SOAP消息： POST /4.0/services/SecureEcho HTTP/1.1 Content-Type: text/xml;charset=UTF-8 SOAPAction: User-Agent: Jakarta Commons-HttpClient/3.1 Host: Content-Length: xxx roy liang LX4gh+njbEtCNAtkWkXDYA= 2010-08-11T06:02:25.874Z G06164 hello 其中，加粗部分表示两者的主要区别，红字部分表示各自必不可少的元素。 由此可以看出，usernametoken方式的特点，是在SOAP的header中加入一个Security标签，把usernametoken信息放在这个Security标签里。至于header里的另外一个customerId标签，是该应用自身的额外要求。 gSOAP实现basic方式相对简单，不过实现usernametoken就比较复杂。gSOAP的用户指南推荐使用其自带的插件，在samples/wsse目录下的官方实例也是使用这个插件。但是，我个人认为这种方法比较累赘，自动生成的代码太多，不易看懂，而且似乎非常依赖于wsdl本身的写法。比如，samples/wsse目录下的官方实例含有下列表示SOAP header的结构体，但是，在我实际开发的应用并没有自动产生，即使强行加上去，编译执行通过，运行的时候也出现了相当多的错误。structSOAP_ENV_Headerstruct_wsse_Security*wsse_Security; 而且，从理论上讲，gSOAP不过是一个框架，定义了从SOAP对象到SOAP消息，以及从SOAP消息到SOAP对象的序列化过程，并且提供了一套与之相适应的API，使用gSOAP开发不过是在其框架范围内调用其API编程。框架的弊端，可想而知，限制了灵活，也限制了方便，更限制了创新。所以，我们可以使用gSOAP编程，但是也许没有必要全部照搬，至少在这个案例中，就没有必要照搬。 我们应有的思路是，既然customerId可以直接写到SOAP header中，那么与之并列的、含有usernametoken的Security也可以直接写到SOAP header中，完全不需要依赖于gSOAP的wsse插件。 与上节一样，基于保密原则，本节案例采用的wsdl同样是经过裁剪和替换的，内容如下： 在gSOAP的wsdl目录，按以下步骤建立客户端存根程序： -bash-3.2$ mkdir p secure_echo -bash-3.2$ cd secure_echo -bash-3.2$ ./wsdl2h c o secure_echo.h secure_echo.wsdl -bash-3.2$ ././src/soapcpp2 C L x secure_echo.h 重点来了，此时需要修改gSOAP为你自动生成的部分文件，加入usernametoken支持，以下是详细步骤，代码中加粗部分即修改的内容： 1. soapStub.h，搜索SOAP_ENV_Header结构体，本案例中，gSOAP只为我们自动生成了对应customerId的指针，因为需要在SOAP header中增加用户名和密码，所以要在这里手动添加这些信息。这样，修改后的SOAP_ENV_Header变为： struct SOAP_ENV_Header char *wsse_username; /* mustUnderstand */ char *wsse_password; /* mustUnderstand */ char *ns1_customerId;/* mustUnderstand */ ; 2. soapC.c，搜索soap_out_SOAP_ENV_Header函数，这是客户端把SOAP对象转化为SOAP消息相关的函数，由于gSOAP只是自动生成了customerId属性的转化，我们还需要加入Security属性，按照soapUI测试好的结果，Security含有一个UsernameToken，而UsernameToken又含有用户名和密码，因此soap_out函数应当这样写： SOAP_FMAC3 int SOAP_FMAC4 soap_out_SOAP_ENV_Header(struct soap *soap, const char *tag, int id, const struct SOAP_ENV_Header *a, const char *type) if (soap_element_begin_out(soap, tag, soap_embedded_id(soap, id, a, SOAP_TYPE_SOAP_ENV_Header), type) return soap-error; if (soap_element_begin_out(soap, wsse:Security, -1, ) | soap_element_begin_out(soap, wsse:UsernameToken, -1, ) | soap_out_string(soap, wsse:Username, -1, &a-wsse_username, ) | soap_out_string(soap, wsse:Password, -1, &a-wsse_password, /wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText) | soap_element_end_out(soap, wsse:UsernameToken) | soap_element_end_out(soap, wsse:Security) ) return soap-error; soap-mustUnderstand = 1; if (soap_out_string(soap, ns1:customerId, -1, &a-ns1_customerId, ) return soap-error; return soap_element_end_out(soap, tag); 3. SecureEchoHttpBinding.nsmap，由于上一步用到了wsse这个namespace，而它又没有出现在nsmap文件中，因此我们需要增加该命名空间的信息，其URL同样可以从soapUI测试结果中取得： SOAP_NMAC struct Namespace namespaces = SOAP-ENV, /soap/envelope/, /*/soap-envelope, NULL, SOAP-ENC, /soap/encoding/, /*/soap-encoding, NULL, xsi, /2001/XMLSchema-instance, /*/XMLSchema-instance, NULL, xsd, /2001/XMLSchema, /*/XMLSchema, NULL, ns1, , NULL, NULL, wsse, /wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd, NULL, NULL, NULL, NULL, NULL, NULL ; 存根程序修改完成，就可以开始编写客户端程序代码了。这个web service提供了两个接口，一个是secure_echo，也就是客户端送任意信息上来，服务端就返回相同的字符串，代码如下： #includesoapH.h#includeSecureEchoHttpBinding.nsmapintmain(intargc,char*argv)if(argc!=5&argc!=6)printf(Usage:%susernamepasswordcustomer_idmessageend_pointn,argv0);exit(-1);structsoapsoap;soap_init(&soap);struct_ns1_sendEchorequest;struct_ns1_sendEchoResponseresponse;soap_ssl_init();if(soap_ssl_client_context(&soap,SOAP_SSL_NO_AUTHENTICATION,NULL,NULL,NULL,NULL,NULL)soap_print_fault(&soap,stderr);exit(-1);structSOAP_ENV_Headerheader;header.wsse_username=argv1;header.wsse_password=argv2;header.ns1_customerId=argv3;soap.header=&header;/soap_write_SOAP_ENV_Header(&soap,&header);request.message=argv4;char*endpoint=NULL;if(argc=6)endpoint=argv5;printf(username:%sn,header.wsse_username);printf(password:%sn,header.wsse_password);printf(customerid:%sn,header.ns1_customerId);printf(message:%sn,request.message);if(endpoint)printf(endpoint:%sn,endpoint);if(soap_call_ns1_sendEcho(&soap,endpoint,NULL,&request,&response)=SOAP_OK)printf(%sn,response.out);elsesoap_print_fault(&soap,stderr);soap_destroy(&soap);soap_end(&soap);soap_done(&soap);return0; 另外一个是显示版本信息，代码如下： #includesoapH.h#includeSecureEchoHttpBinding.nsmapintmain(intargc,char*argv)if(argc!=4&argc!=5)printf(Usage:%susernamepasswordcustomer_idend_pointn,argv0);exit(-1);structsoapsoap;soap_init(&soap);struct_ns1_showVersionInformationrequest;struct_ns1_showVersionInformationResponseresponse;soap_ssl_init();if(soap_ssl_client_context(&soap,SOAP_SSL_NO_AUTHENTICATION,NULL,NULL,NULL,NULL,NULL)soap_print_fault(&soap,stderr);exit(-1);structSOAP_ENV_Headerheader;header.wsse_username=argv1;header.wsse_password=argv2;header.ns1_customerId=argv3;soap.header=&header;/soap_write_SOAP_ENV_Header(&soap,&header);char*endpoint=NULL;if(argc=5)endpoint=argv4;printf(username:%sn,header.wsse_username);printf(password:%sn,header.wsse_password);printf(customerid:%sn,header.ns1_customerId);if(endpoint)printf(endpoint:%sn,endpoint);if(soap_call_ns1_showVersionInformation(&soap,endpoint,NULL,&request,&response)=SOAP_OK)printf(%sn,response.out);elsesoap_print_fault(&soap,stderr);soap_destroy(&soap);soap_end(&soap);soap_done(&soap);return0; 两个客户端程序都是一样的结构，仅仅是调用的接口不一样。与上一节的basic方式的客户端相比，usernametoken方式的用户密码不是保存在soap结构体的userid变量和passwd变量中，而是保存在header指针指向的SOAP_ENV_Header结构体中，这就是刚才我们为什么要修改SOAP_ENV_Header结构体的原因。 两个客户端程序分别保存为secure_echo.c和show_version.c，编译命令分别是： gcc -DWITH_OPENSSL -O2 -o secure_echo secure_echo.c soapC.c soapClient.c ././stdsoap2.c -I./. -L./. -lgsoap -lssl gcc -DWITH_OPENSSL -O2 -o show_version show_version.c soapC.c soapClient.c ././stdsoap2.c -I./. -L./. -lgsoap lssl 由此可见，编译的源代码和链接的库文件都与上一节的没什么区别，没有使用额外的插件。 客户端程序搞掂，然后就是服务端了。 回到gSOAP的wsdl目录，按以下步骤建立服务端存根程序： -bash-3.2$ mkdir p secure_echo_server -bash-3.2$ cd secure_echo_server -bash-3.2$ cp p ./secure_echo/secure_echo.h . -bash-3.2$ ././src/soapcpp2 S L x secure_echo.h 与客户端程序一样，服务端同样要进行一些修改，步骤如下： 1. soapStub.h，与客户端的修改是一样的 2. soapC.c，搜索soap_in_SOAP_ENV_Header函数，注意客户端修改的是soap_out函数，这里是soap_in函数，是服务端把SOAP消息转化为SOAP对象的函数。由于客户端送上来的SOAP header消息含有Security属性，我们需要把它转为username和password。修改后的代码如下，加粗部分是修改内容： SOAP_FMAC3 struct SOAP_ENV_Header * SOAP_FMAC4 soap_in_SOAP_ENV_Header(struct soap *soap, const char *tag, struct SOAP_ENV_Header *a, const char *type) size_t soap_flag_wsse_security = 1; size_t soap_flag_ns1_customerId = 1; if (soap_element_begin_in(soap, tag, 0, type) return NULL; a = (struct SOAP_ENV_Header *)soap_id_enter(soap, soap-id, a, SOAP_TYPE_SOAP_ENV_Header, sizeof(struct SOAP_ENV_Header), 0, NULL, NULL, NULL); if (!a) return NULL; soap_default_SOAP_ENV_Header(soap, a); if (soap-body & !*soap-href) for (;) if ( soap_flag_wsse_security ) if ( soap_element_begin_in(soap, NULL, 0, NULL) ) return NULL; if ( soap_element_begin_in(soap, NULL, 0, NULL) ) return NULL; if ( soap_in_string(soap, , &a-wsse_username, ) & soap_in_string(soap, , &a-wsse_password, ) ) soap_flag_wsse_security-; soap_element_end_in(soap, NULL); soap_element_end_in(soap, NULL); soap-error = SOAP_TAG_MISMATCH; if (soap_flag_ns1_customerId & (soap-error = SOAP_TAG_MISMATCH | soap-error = SOAP_NO_TAG) if (soap_in_string(soap, ns1:customerId, &a-ns1_customerId, xsd:string) soap_flag_ns1_customerId-; continue; if (soap-error = SOAP_TAG_MISMATCH) soap-error = soap_ignore_element(soap); if (soap-error = SOAP_NO_TAG) break; if (soap-error) return NULL; if (soap_element_end_in(soap, tag) return NULL; else a = (struct SOAP_ENV_Header *)soap_id_forward(soap, soap-href, (void*)a, 0, SOAP_TYPE_SOAP_ENV_Header, 0, sizeof(struct SOAP_ENV_Header), 0, NULL); if (soap-body & soap_element_end_in(soap, tag) return NULL; return a; 服务端程序如下，到这里就没什么难度了，基本上与上一节的服务端结构差不多，注意要把几个pem证书拷贝过来（因为usernametoken方式通常都是基于HTTPS的），echo接口和show_version接口都要编写： #include#includesoapH.h#includeSecureEchoHttpBinding.nsmapvoid*process_request(void*soap)pthread_detach(pthread_self();if(soap_ssl_acce