1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
3
<title>gSOAP WS-Security: /Users/engelen/Projects/gsoap/doc/wsse/wsseapi.h File Reference</title>
4
<link href="doxygen.css" rel="stylesheet" type="text/css">
6
<!-- Generated by Doxygen 1.3.8 -->
7
<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="globals.html">File Members</a> | <a class="qindex" href="pages.html">Related Pages</a></div>
8
<h1>/Users/engelen/Projects/gsoap/doc/wsse/wsseapi.h File Reference</h1><code>#include "soapH.h"</code><br>
9
<code>#include "<a class="el" href="smdevp_8h.html">smdevp.h</a>"</code><br>
12
Include dependency graph for wsseapi.h:<p><center><img src="wsseapi_8h__incl.png" border="0" usemap="#wsseapi.h_map" alt="Include dependency graph"></center>
13
<map name="wsseapi.h_map">
14
<area href="smdevp_8h.html" shape="rect" coords="89,92,156,118" alt="">
18
This graph shows which files directly or indirectly include this file:<p><center><img src="wsseapi_8h__dep__incl.png" border="0" usemap="#wsseapi.hdep_map" alt="Included by dependency graph"></center>
19
<map name="wsseapi.hdep_map">
20
<area href="wsseapi_8c.html" shape="rect" coords="6,17,76,44" alt="">
22
<table border=0 cellpadding=0 cellspacing=0>
24
<tr><td colspan=2><br><h2>Classes</h2></td></tr>
25
<tr><td class="memItemLeft" nowrap align=right valign=top>struct </td><td class="memItemRight" valign=bottom><a class="el" href="structsoap__wsse__data.html">soap_wsse_data</a></td></tr>
27
<tr><td class="mdescLeft"> </td><td class="mdescRight">wsseapi plugin data <a href="structsoap__wsse__data.html#_details">More...</a><br></td></tr>
28
<tr><td class="memItemLeft" nowrap align=right valign=top>struct </td><td class="memItemRight" valign=bottom><a class="el" href="structsoap__wsse__digest.html">soap_wsse_digest</a></td></tr>
30
<tr><td class="mdescLeft"> </td><td class="mdescRight">Digest dictionary: linked list of ID-hash pairs. <a href="structsoap__wsse__digest.html#_details">More...</a><br></td></tr>
31
<tr><td colspan=2><br><h2>Defines</h2></td></tr>
32
<tr><td class="memItemLeft" nowrap align=right valign=top>#define </td><td class="memItemRight" valign=bottom><a class="el" href="wsseapi_8h.html#a0">SOAP_WSSE_ID</a> "SOAP-WSSE-1.0"</td></tr>
34
<tr><td colspan=2><br><h2>Functions</h2></td></tr>
35
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="struct__wsse_____security.html">_wsse__Security</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="wsseapi_8h.html#a14">soap_wsse_add_Security</a> (struct soap *soap)</td></tr>
37
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds Security header element. <a href="#a14"></a><br></td></tr>
38
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="struct__wsse_____security.html">_wsse__Security</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="wsseapi_8h.html#a15">soap_wsse_add_Security_actor</a> (struct soap *soap, const char *actor)</td></tr>
40
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds Security header element with actor or role attribute. <a href="#a15"></a><br></td></tr>
41
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="wsseapi_8h.html#a16">soap_wsse_delete_Security</a> (struct soap *soap)</td></tr>
43
<tr><td class="mdescLeft"> </td><td class="mdescRight">Deletes Security header element. <a href="#a16"></a><br></td></tr>
44
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="struct__wsse_____security.html">_wsse__Security</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="wsseapi_8h.html#a17">soap_wsse_Security</a> (struct soap *soap)</td></tr>
46
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns Security header element if present. <a href="#a17"></a><br></td></tr>
47
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="structds_____signature_type.html">ds__SignatureType</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="wsseapi_8h.html#a18">soap_wsse_add_Signature</a> (struct soap *soap)</td></tr>
49
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds Signature header element. <a href="#a18"></a><br></td></tr>
50
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="wsseapi_8h.html#a19">soap_wsse_delete_Signature</a> (struct soap *soap)</td></tr>
52
<tr><td class="mdescLeft"> </td><td class="mdescRight">Deletes Signature header element. <a href="#a19"></a><br></td></tr>
53
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="structds_____signature_type.html">ds__SignatureType</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="wsseapi_8h.html#a20">soap_wsse_Signature</a> (struct soap *soap)</td></tr>
55
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns Signature header element if present. <a href="#a20"></a><br></td></tr>
56
<tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="wsseapi_8h.html#a21">soap_wsse_add_Timestamp</a> (struct soap *soap, const char *id, time_t lifetime)</td></tr>
58
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds Timestamp element with optional expiration date+time (lifetime). <a href="#a21"></a><br></td></tr>
59
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="struct__wsu_____timestamp.html">_wsu__Timestamp</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="wsseapi_8h.html#a22">soap_wsse_Timestamp</a> (struct soap *soap)</td></tr>
61
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns Timestamp element if present. <a href="#a22"></a><br></td></tr>
62
<tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="wsseapi_8h.html#a23">soap_wsse_verify_Timestamp</a> (struct soap *soap)</td></tr>
64
<tr><td class="mdescLeft"> </td><td class="mdescRight">Verifies the Timestamp/Expires element against the current time. <a href="#a23"></a><br></td></tr>
65
<tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="wsseapi_8h.html#a24">soap_wsse_add_UsernameTokenText</a> (struct soap *soap, const char *id, const char *username, const char *password)</td></tr>
67
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds UsernameToken element with optional clear-text password. <a href="#a24"></a><br></td></tr>
68
<tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="wsseapi_8h.html#a25">soap_wsse_add_UsernameTokenDigest</a> (struct soap *soap, const char *id, const char *username, const char *password)</td></tr>
70
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds UsernameToken element for digest authentication. <a href="#a25"></a><br></td></tr>
71
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="struct__wsse_____username_token.html">_wsse__UsernameToken</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="wsseapi_8h.html#a26">soap_wsse_UsernameToken</a> (struct soap *soap, const char *id)</td></tr>
73
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns UsernameToken element if present. <a href="#a26"></a><br></td></tr>
74
<tr><td class="memItemLeft" nowrap align=right valign=top>const char * </td><td class="memItemRight" valign=bottom><a class="el" href="wsseapi_8h.html#a27">soap_wsse_get_Username</a> (struct soap *soap)</td></tr>
76
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns UsernameToken/username string or wsse:FailedAuthentication fault. <a href="#a27"></a><br></td></tr>
77
<tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="wsseapi_8h.html#a28">soap_wsse_verify_Password</a> (struct soap *soap, const char *password)</td></tr>
79
<tr><td class="mdescLeft"> </td><td class="mdescRight">Verifies the supplied password or sets wsse:FailedAuthentication fault. <a href="#a28"></a><br></td></tr>
80
<tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="wsseapi_8h.html#a29">soap_wsse_add_BinarySecurityToken</a> (struct soap *soap, const char *id, const char *valueType, const unsigned char *data, int size)</td></tr>
82
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds BinarySecurityToken element. <a href="#a29"></a><br></td></tr>
83
<tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="wsseapi_8h.html#a30">soap_wsse_add_BinarySecurityTokenX509</a> (struct soap *soap, const char *id, X509 *cert)</td></tr>
85
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds BinarySecurityToken element with X509 certificate. <a href="#a30"></a><br></td></tr>
86
<tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="wsseapi_8h.html#a31">soap_wsse_add_BinarySecurityTokenPEM</a> (struct soap *soap, const char *id, const char *filename)</td></tr>
88
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds BinarySecurityToken element from a PEM file. <a href="#a31"></a><br></td></tr>
89
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="struct__wsse_____binary_security_token.html">_wsse__BinarySecurityToken</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="wsseapi_8h.html#a32">soap_wsse_BinarySecurityToken</a> (struct soap *soap, const char *id)</td></tr>
91
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns BinarySecurityToken element if present. <a href="#a32"></a><br></td></tr>
92
<tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="wsseapi_8h.html#a33">soap_wsse_get_BinarySecurityToken</a> (struct soap *soap, const char *id, char **valueType, unsigned char **data, int *size)</td></tr>
94
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get wsse:BinarySecurityToken element token data in binary form. <a href="#a33"></a><br></td></tr>
95
<tr><td class="memItemLeft" nowrap align=right valign=top>X509 * </td><td class="memItemRight" valign=bottom><a class="el" href="wsseapi_8h.html#a34">soap_wsse_get_BinarySecurityTokenX509</a> (struct soap *soap, const char *id)</td></tr>
97
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get X509 wsse:BinarySecurityToken certificate and verify its content. <a href="#a34"></a><br></td></tr>
98
<tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="wsseapi_8h.html#a35">soap_wsse_verify_X509</a> (struct soap *soap, X509 *cert)</td></tr>
100
<tr><td class="mdescLeft"> </td><td class="mdescRight">Verifies X509 certificate against soap->cafile, soap->capath, and soap->crlfile. <a href="#a35"></a><br></td></tr>
101
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="structds_____signed_info_type.html">ds__SignedInfoType</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="wsseapi_8h.html#a36">soap_wsse_add_SignedInfo</a> (struct soap *soap)</td></tr>
103
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds SignedInfo element. <a href="#a36"></a><br></td></tr>
104
<tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="wsseapi_8h.html#a37">soap_wsse_add_SignedInfo_Reference</a> (struct soap *soap, const char *URI, const char *transform, const char *inclusiveNamespaces, const char *HA)</td></tr>
106
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds SignedInfo element with Reference URI, transform algorithm used, and digest value. <a href="#a37"></a><br></td></tr>
107
<tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="wsseapi_8h.html#a38">soap_wsse_add_SignedInfo_SignatureMethod</a> (struct soap *soap, const char *method, int canonical)</td></tr>
109
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds SignedInfo element with SignatureMethod. <a href="#a38"></a><br></td></tr>
110
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="structds_____signed_info_type.html">ds__SignedInfoType</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="wsseapi_8h.html#a39">soap_wsse_SignedInfo</a> (struct soap *soap)</td></tr>
112
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns SignedInfo element if present. <a href="#a39"></a><br></td></tr>
113
<tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="wsseapi_8h.html#a40">soap_wsse_get_SignedInfo_SignatureMethod</a> (struct soap *soap, int *alg)</td></tr>
115
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get SignatureMethod algorithm. <a href="#a40"></a><br></td></tr>
116
<tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="wsseapi_8h.html#a41">soap_wsse_add_SignatureValue</a> (struct soap *soap, int alg, const void *key, int keylen)</td></tr>
118
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds SignedInfo/SignatureMethod element, signs the SignedInfo element, and adds the resulting SignatureValue element. <a href="#a41"></a><br></td></tr>
119
<tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="wsseapi_8h.html#a42">soap_wsse_verify_SignatureValue</a> (struct soap *soap, int alg, const void *key, int keylen)</td></tr>
121
<tr><td class="mdescLeft"> </td><td class="mdescRight">Verifies the SignatureValue of a SignedInfo element. <a href="#a42"></a><br></td></tr>
122
<tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="wsseapi_8h.html#a43">soap_wsse_verify_SignedInfo</a> (struct soap *soap)</td></tr>
124
<tr><td class="mdescLeft"> </td><td class="mdescRight">Verifies the digest values of the XML elements referenced by the SignedInfo References. <a href="#a43"></a><br></td></tr>
125
<tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="wsseapi_8h.html#a44">soap_wsse_verify_digest</a> (struct soap *soap, int alg, const char *id, unsigned char hash[SOAP_SMD_MAX_SIZE])</td></tr>
127
<tr><td class="mdescLeft"> </td><td class="mdescRight">Verifies the digest value of an XML element referenced by id against the hash. <a href="#a44"></a><br></td></tr>
128
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="structds_____key_info_type.html">ds__KeyInfoType</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="wsseapi_8h.html#a45">soap_wsse_add_KeyInfo</a> (struct soap *soap)</td></tr>
130
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds KeyInfo element. <a href="#a45"></a><br></td></tr>
131
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="structds_____key_info_type.html">ds__KeyInfoType</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="wsseapi_8h.html#a46">soap_wsse_KeyInfo</a> (struct soap *soap)</td></tr>
133
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns KeyInfo element if present. <a href="#a46"></a><br></td></tr>
134
<tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="wsseapi_8h.html#a47">soap_wsse_add_KeyInfo_KeyName</a> (struct soap *soap, const char *name)</td></tr>
136
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds KeyName element. <a href="#a47"></a><br></td></tr>
137
<tr><td class="memItemLeft" nowrap align=right valign=top>const char * </td><td class="memItemRight" valign=bottom><a class="el" href="wsseapi_8h.html#a48">soap_wsse_get_KeyInfo_KeyName</a> (struct soap *soap)</td></tr>
139
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns KeyName element if present. <a href="#a48"></a><br></td></tr>
140
<tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="wsseapi_8h.html#a49">soap_wsse_add_KeyInfo_SecurityTokenReferenceURI</a> (struct soap *soap, const char *URI, const char *valueType)</td></tr>
142
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds KeyInfo element with SecurityTokenReference URI. <a href="#a49"></a><br></td></tr>
143
<tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="wsseapi_8h.html#a50">soap_wsse_add_KeyInfo_SecurityTokenReferenceX509</a> (struct soap *soap, const char *URI)</td></tr>
145
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds KeyInfo element with SecurityTokenReference URI to an X509 cert. <a href="#a50"></a><br></td></tr>
146
<tr><td class="memItemLeft" nowrap align=right valign=top>const char * </td><td class="memItemRight" valign=bottom><a class="el" href="wsseapi_8h.html#a51">soap_wsse_get_KeyInfo_SecurityTokenReferenceURI</a> (struct soap *soap)</td></tr>
148
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a SecurityTokenReference URI if present. <a href="#a51"></a><br></td></tr>
149
<tr><td class="memItemLeft" nowrap align=right valign=top>const char * </td><td class="memItemRight" valign=bottom><a class="el" href="wsseapi_8h.html#a52">soap_wsse_get_KeyInfo_SecurityTokenReferenceValueType</a> (struct soap *soap)</td></tr>
151
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a SecurityTokenReference ValueType if present. <a href="#a52"></a><br></td></tr>
152
<tr><td class="memItemLeft" nowrap align=right valign=top>X509 * </td><td class="memItemRight" valign=bottom><a class="el" href="wsseapi_8h.html#a53">soap_wsse_get_KeyInfo_SecurityTokenReferenceX509</a> (struct soap *soap)</td></tr>
154
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a X509 certificate if present as a BinarySecurity token. <a href="#a53"></a><br></td></tr>
155
<tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="wsseapi_8h.html#a54">soap_wsse_add_KeyInfo_SecurityTokenReferenceKeyIdentifier</a> (struct soap *soap, const char *id, const char *valueType, unsigned char *data, int size)</td></tr>
157
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds KeyInfo element with SecurityTokenReference/KeyIdentifier binary data. <a href="#a54"></a><br></td></tr>
158
<tr><td class="memItemLeft" nowrap align=right valign=top>const char * </td><td class="memItemRight" valign=bottom><a class="el" href="wsseapi_8h.html#a55">soap_wsse_get_KeyInfo_SecurityTokenReferenceKeyIdentifierValueType</a> (struct soap *soap)</td></tr>
160
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns KeyInfo/SecurityTokenReference/KeyIdentifier/ValueType if present. <a href="#a55"></a><br></td></tr>
161
<tr><td class="memItemLeft" nowrap align=right valign=top>const unsigned char * </td><td class="memItemRight" valign=bottom><a class="el" href="wsseapi_8h.html#a56">soap_wsse_get_KeyInfo_SecurityTokenReferenceKeyIdentifier</a> (struct soap *soap, int *size)</td></tr>
163
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns KeyInfo/SecurityTokenReference/KeyIdentifier binary data. <a href="#a56"></a><br></td></tr>
164
<tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="wsseapi_8h.html#a57">soap_wsse_add_KeyInfo_SecurityTokenReferenceEmbedded</a> (struct soap *soap, const char *id, const char *valueType)</td></tr>
166
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds KeyInfo element with Embedded SecurityTokenReference. <a href="#a57"></a><br></td></tr>
167
<tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="wsseapi_8h.html#a58">soap_wsse_fault</a> (struct soap *soap, enum <a class="el" href="wsse_8h.html#a0">wsse__FaultcodeEnum</a> fault, const char *detail)</td></tr>
169
<tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="wsseapi_8h.html#a59">soap_wsse</a> (struct soap *soap, struct soap_plugin *p, void *arg)</td></tr>
171
<tr><td class="mdescLeft"> </td><td class="mdescRight">Plugin registry function, used with soap_register_plugin. <a href="#a59"></a><br></td></tr>
172
<tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="wsseapi_8h.html#a60">soap_wsse_sign</a> (struct soap *soap, int alg, const void *key, int keylen)</td></tr>
174
<tr><td class="mdescLeft"> </td><td class="mdescRight">Uses the wsse plugin to sign all wsu:Id attributed elements. <a href="#a60"></a><br></td></tr>
175
<tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="wsseapi_8h.html#a61">soap_wsse_sign_body</a> (struct soap *soap, int alg, const void *key, int keylen)</td></tr>
177
<tr><td class="mdescLeft"> </td><td class="mdescRight">Uses the wsse plugin to sign all wsu:Id attributed elements, including the SOAP Body (by adding a wsu:Id="Body" attribute). <a href="#a61"></a><br></td></tr>
178
<tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="wsseapi_8h.html#a62">soap_wsse_verify_init</a> (struct soap *soap)</td></tr>
180
<tr><td class="mdescLeft"> </td><td class="mdescRight">Uses the wsse plugin to initiate the verification of the signature and SignedInfo Reference digests. <a href="#a62"></a><br></td></tr>
181
<tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="wsseapi_8h.html#a63">soap_wsse_verify_auto</a> (struct soap *soap, int alg, const void *key, size_t keylen)</td></tr>
183
<tr><td class="mdescLeft"> </td><td class="mdescRight">Uses the wsse plugin to initiate the automatic verification of the signature and SignedInfo Reference digests. <a href="#a63"></a><br></td></tr>
184
<tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="wsseapi_8h.html#a64">soap_wsse_verify_done</a> (struct soap *soap)</td></tr>
186
<tr><td class="mdescLeft"> </td><td class="mdescRight">Terminates the automatic verification of signatures. <a href="#a64"></a><br></td></tr>
187
<tr><td class="memItemLeft" nowrap align=right valign=top>SOAP_FMAC1 void SOAP_FMAC2 </td><td class="memItemRight" valign=bottom><a class="el" href="wsseapi_8h.html#a65">soap_default_xsd__anyType</a> (struct soap *, struct soap_dom_element *node)</td></tr>
189
<tr><td class="memItemLeft" nowrap align=right valign=top>SOAP_FMAC1 int SOAP_FMAC2 </td><td class="memItemRight" valign=bottom><a class="el" href="wsseapi_8h.html#a66">soap_out_xsd__anyType</a> (struct soap *soap, const char *tag, int id, const struct soap_dom_element *node, const char *type)</td></tr>
191
<tr><td class="memItemLeft" nowrap align=right valign=top>SOAP_FMAC1 struct soap_dom_element <br>
192
*SOAP_FMAC2 </td><td class="memItemRight" valign=bottom><a class="el" href="wsseapi_8h.html#a67">soap_in_xsd__anyType</a> (struct soap *soap, const char *tag, struct soap_dom_element *node, const char *type)</td></tr>
194
<tr><td colspan=2><br><h2>Variables</h2></td></tr>
195
<tr><td class="memItemLeft" nowrap align=right valign=top>const char </td><td class="memItemRight" valign=bottom><a class="el" href="wsseapi_8h.html#a1">soap_wsse_id</a> []</td></tr>
197
<tr><td class="memItemLeft" nowrap align=right valign=top>const char * </td><td class="memItemRight" valign=bottom><a class="el" href="wsseapi_8h.html#a2">wsse_PasswordTextURI</a></td></tr>
199
<tr><td class="memItemLeft" nowrap align=right valign=top>const char * </td><td class="memItemRight" valign=bottom><a class="el" href="wsseapi_8h.html#a3">wsse_PasswordDigestURI</a></td></tr>
201
<tr><td class="memItemLeft" nowrap align=right valign=top>const char * </td><td class="memItemRight" valign=bottom><a class="el" href="wsseapi_8h.html#a4">wsse_Base64BinaryURI</a></td></tr>
203
<tr><td class="memItemLeft" nowrap align=right valign=top>const char * </td><td class="memItemRight" valign=bottom><a class="el" href="wsseapi_8h.html#a5">wsse_X509v3URI</a></td></tr>
205
<tr><td class="memItemLeft" nowrap align=right valign=top>const char * </td><td class="memItemRight" valign=bottom><a class="el" href="wsseapi_8h.html#a6">wsse_X509v3SubjectKeyIdentifierURI</a></td></tr>
207
<tr><td class="memItemLeft" nowrap align=right valign=top>const char * </td><td class="memItemRight" valign=bottom><a class="el" href="wsseapi_8h.html#a7">ds_sha1URI</a></td></tr>
209
<tr><td class="memItemLeft" nowrap align=right valign=top>const char * </td><td class="memItemRight" valign=bottom><a class="el" href="wsseapi_8h.html#a8">ds_hmac_sha1URI</a></td></tr>
211
<tr><td class="memItemLeft" nowrap align=right valign=top>const char * </td><td class="memItemRight" valign=bottom><a class="el" href="wsseapi_8h.html#a9">ds_dsa_sha1URI</a></td></tr>
213
<tr><td class="memItemLeft" nowrap align=right valign=top>const char * </td><td class="memItemRight" valign=bottom><a class="el" href="wsseapi_8h.html#a10">ds_rsa_sha1URI</a></td></tr>
215
<tr><td class="memItemLeft" nowrap align=right valign=top>const char * </td><td class="memItemRight" valign=bottom><a class="el" href="wsseapi_8h.html#a11">ds_URI</a></td></tr>
217
<tr><td class="memItemLeft" nowrap align=right valign=top>const char * </td><td class="memItemRight" valign=bottom><a class="el" href="wsseapi_8h.html#a12">c14n_URI</a></td></tr>
219
<tr><td class="memItemLeft" nowrap align=right valign=top>const char * </td><td class="memItemRight" valign=bottom><a class="el" href="wsseapi_8h.html#a13">wsu_URI</a></td></tr>
222
<hr><h2>Define Documentation</h2>
223
<a class="anchor" name="a0" doxytag="wsseapi.h::SOAP_WSSE_ID" ></a><p>
224
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
227
<table cellpadding="0" cellspacing="0" border="0">
229
<td class="md" nowrap valign="top"> #define SOAP_WSSE_ID "SOAP-WSSE-1.0" </td>
235
<table cellspacing=5 cellpadding=0 border=0>
243
plugin identification for plugin registry </td>
246
<hr><h2>Function Documentation</h2>
247
<a class="anchor" name="a65" doxytag="wsseapi.h::soap_default_xsd__anyType" ></a><p>
248
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
251
<table cellpadding="0" cellspacing="0" border="0">
253
<td class="md" nowrap valign="top"> SOAP_FMAC1 void SOAP_FMAC2 soap_default_xsd__anyType </td>
254
<td class="md" valign="top">( </td>
255
<td class="md" nowrap valign="top">struct soap * </td>
256
<td class="mdname" nowrap>, </td>
259
<td class="md" nowrap align="right"></td>
261
<td class="md" nowrap>struct soap_dom_element * </td>
262
<td class="mdname" nowrap> <em>node</em></td>
266
<td class="md">) </td>
267
<td class="md" colspan="2"></td>
273
<table cellspacing=5 cellpadding=0 border=0>
284
<a class="anchor" name="a67" doxytag="wsseapi.h::soap_in_xsd__anyType" ></a><p>
285
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
288
<table cellpadding="0" cellspacing="0" border="0">
290
<td class="md" nowrap valign="top"> SOAP_FMAC1 struct soap_dom_element* SOAP_FMAC2 soap_in_xsd__anyType </td>
291
<td class="md" valign="top">( </td>
292
<td class="md" nowrap valign="top">struct soap * </td>
293
<td class="mdname" nowrap> <em>soap</em>, </td>
296
<td class="md" nowrap align="right"></td>
298
<td class="md" nowrap>const char * </td>
299
<td class="mdname" nowrap> <em>tag</em>, </td>
302
<td class="md" nowrap align="right"></td>
304
<td class="md" nowrap>struct soap_dom_element * </td>
305
<td class="mdname" nowrap> <em>node</em>, </td>
308
<td class="md" nowrap align="right"></td>
310
<td class="md" nowrap>const char * </td>
311
<td class="mdname" nowrap> <em>type</em></td>
315
<td class="md">) </td>
316
<td class="md" colspan="2"></td>
322
<table cellspacing=5 cellpadding=0 border=0>
333
<a class="anchor" name="a66" doxytag="wsseapi.h::soap_out_xsd__anyType" ></a><p>
334
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
337
<table cellpadding="0" cellspacing="0" border="0">
339
<td class="md" nowrap valign="top"> SOAP_FMAC1 int SOAP_FMAC2 soap_out_xsd__anyType </td>
340
<td class="md" valign="top">( </td>
341
<td class="md" nowrap valign="top">struct soap * </td>
342
<td class="mdname" nowrap> <em>soap</em>, </td>
345
<td class="md" nowrap align="right"></td>
347
<td class="md" nowrap>const char * </td>
348
<td class="mdname" nowrap> <em>tag</em>, </td>
351
<td class="md" nowrap align="right"></td>
353
<td class="md" nowrap>int </td>
354
<td class="mdname" nowrap> <em>id</em>, </td>
357
<td class="md" nowrap align="right"></td>
359
<td class="md" nowrap>const struct soap_dom_element * </td>
360
<td class="mdname" nowrap> <em>node</em>, </td>
363
<td class="md" nowrap align="right"></td>
365
<td class="md" nowrap>const char * </td>
366
<td class="mdname" nowrap> <em>type</em></td>
370
<td class="md">) </td>
371
<td class="md" colspan="2"></td>
377
<table cellspacing=5 cellpadding=0 border=0>
388
<a class="anchor" name="a59" doxytag="wsseapi.h::soap_wsse" ></a><p>
389
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
392
<table cellpadding="0" cellspacing="0" border="0">
394
<td class="md" nowrap valign="top"> int soap_wsse </td>
395
<td class="md" valign="top">( </td>
396
<td class="md" nowrap valign="top">struct soap * </td>
397
<td class="mdname" nowrap> <em>soap</em>, </td>
400
<td class="md" nowrap align="right"></td>
402
<td class="md" nowrap>struct soap_plugin * </td>
403
<td class="mdname" nowrap> <em>p</em>, </td>
406
<td class="md" nowrap align="right"></td>
408
<td class="md" nowrap>void * </td>
409
<td class="mdname" nowrap> <em>arg</em></td>
413
<td class="md">) </td>
414
<td class="md" colspan="2"></td>
420
<table cellspacing=5 cellpadding=0 border=0>
428
Plugin registry function, used with soap_register_plugin.
430
<dl compact><dt><b>Parameters:</b></dt><dd>
431
<table border="0" cellspacing="2" cellpadding="0">
432
<tr><td></td><td valign=top><em>soap</em> </td><td>context </td></tr>
433
<tr><td><tt>[in,out]</tt> </td><td valign=top><em>p</em> </td><td>plugin created in registry </td></tr>
434
<tr><td><tt>[in]</tt> </td><td valign=top><em>arg</em> </td><td>passed from soap_register_plugin_arg is an optional security token handler callback </td></tr>
437
<dl compact><dt><b>Returns:</b></dt><dd>SOAP_OK </dd></dl>
441
<a class="anchor" name="a29" doxytag="wsseapi.h::soap_wsse_add_BinarySecurityToken" ></a><p>
442
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
445
<table cellpadding="0" cellspacing="0" border="0">
447
<td class="md" nowrap valign="top"> int soap_wsse_add_BinarySecurityToken </td>
448
<td class="md" valign="top">( </td>
449
<td class="md" nowrap valign="top">struct soap * </td>
450
<td class="mdname" nowrap> <em>soap</em>, </td>
453
<td class="md" nowrap align="right"></td>
455
<td class="md" nowrap>const char * </td>
456
<td class="mdname" nowrap> <em>id</em>, </td>
459
<td class="md" nowrap align="right"></td>
461
<td class="md" nowrap>const char * </td>
462
<td class="mdname" nowrap> <em>valueType</em>, </td>
465
<td class="md" nowrap align="right"></td>
467
<td class="md" nowrap>const unsigned char * </td>
468
<td class="mdname" nowrap> <em>data</em>, </td>
471
<td class="md" nowrap align="right"></td>
473
<td class="md" nowrap>int </td>
474
<td class="mdname" nowrap> <em>size</em></td>
478
<td class="md">) </td>
479
<td class="md" colspan="2"></td>
485
<table cellspacing=5 cellpadding=0 border=0>
493
Adds BinarySecurityToken element.
495
<dl compact><dt><b>Parameters:</b></dt><dd>
496
<table border="0" cellspacing="2" cellpadding="0">
497
<tr><td></td><td valign=top><em>soap</em> </td><td>context </td></tr>
498
<tr><td><tt>[in]</tt> </td><td valign=top><em>id</em> </td><td>string for signature referencing or NULL </td></tr>
499
<tr><td><tt>[in]</tt> </td><td valign=top><em>valueType</em> </td><td>string </td></tr>
500
<tr><td><tt>[in]</tt> </td><td valign=top><em>data</em> </td><td>points to binary token data </td></tr>
501
<tr><td><tt>[in]</tt> </td><td valign=top><em>size</em> </td><td>is length of binary token </td></tr>
504
<dl compact><dt><b>Returns:</b></dt><dd>SOAP_OK </dd></dl>
508
<a class="anchor" name="a31" doxytag="wsseapi.h::soap_wsse_add_BinarySecurityTokenPEM" ></a><p>
509
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
512
<table cellpadding="0" cellspacing="0" border="0">
514
<td class="md" nowrap valign="top"> int soap_wsse_add_BinarySecurityTokenPEM </td>
515
<td class="md" valign="top">( </td>
516
<td class="md" nowrap valign="top">struct soap * </td>
517
<td class="mdname" nowrap> <em>soap</em>, </td>
520
<td class="md" nowrap align="right"></td>
522
<td class="md" nowrap>const char * </td>
523
<td class="mdname" nowrap> <em>id</em>, </td>
526
<td class="md" nowrap align="right"></td>
528
<td class="md" nowrap>const char * </td>
529
<td class="mdname" nowrap> <em>filename</em></td>
533
<td class="md">) </td>
534
<td class="md" colspan="2"></td>
540
<table cellspacing=5 cellpadding=0 border=0>
548
Adds BinarySecurityToken element from a PEM file.
550
<dl compact><dt><b>Parameters:</b></dt><dd>
551
<table border="0" cellspacing="2" cellpadding="0">
552
<tr><td></td><td valign=top><em>soap</em> </td><td>context </td></tr>
553
<tr><td><tt>[in]</tt> </td><td valign=top><em>id</em> </td><td>string for signature reference </td></tr>
554
<tr><td><tt>[in]</tt> </td><td valign=top><em>filename</em> </td><td></td></tr>
557
<dl compact><dt><b>Returns:</b></dt><dd>SOAP_OK or SOAP_FAULT with wsse__InvalidSecurity fault when file cannot be read or does not contain a valid certificate</dd></dl>
558
This function uses PEM_read_X509 from the the OpenSSL library to read a certificate from a PEM formatted file. </td>
561
<a class="anchor" name="a30" doxytag="wsseapi.h::soap_wsse_add_BinarySecurityTokenX509" ></a><p>
562
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
565
<table cellpadding="0" cellspacing="0" border="0">
567
<td class="md" nowrap valign="top"> int soap_wsse_add_BinarySecurityTokenX509 </td>
568
<td class="md" valign="top">( </td>
569
<td class="md" nowrap valign="top">struct soap * </td>
570
<td class="mdname" nowrap> <em>soap</em>, </td>
573
<td class="md" nowrap align="right"></td>
575
<td class="md" nowrap>const char * </td>
576
<td class="mdname" nowrap> <em>id</em>, </td>
579
<td class="md" nowrap align="right"></td>
581
<td class="md" nowrap>X509 * </td>
582
<td class="mdname" nowrap> <em>cert</em></td>
586
<td class="md">) </td>
587
<td class="md" colspan="2"></td>
593
<table cellspacing=5 cellpadding=0 border=0>
601
Adds BinarySecurityToken element with X509 certificate.
603
<dl compact><dt><b>Parameters:</b></dt><dd>
604
<table border="0" cellspacing="2" cellpadding="0">
605
<tr><td></td><td valign=top><em>soap</em> </td><td>context </td></tr>
606
<tr><td><tt>[in]</tt> </td><td valign=top><em>id</em> </td><td>string for signature reference </td></tr>
607
<tr><td><tt>[in]</tt> </td><td valign=top><em>cert</em> </td><td>points to the X509 certificate </td></tr>
610
<dl compact><dt><b>Returns:</b></dt><dd>SOAP_OK or SOAP_EOM</dd></dl>
611
This function uses i2d_X509 from the the OpenSSL library to convert an X509 object to binary DER format. </td>
614
<a class="anchor" name="a45" doxytag="wsseapi.h::soap_wsse_add_KeyInfo" ></a><p>
615
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
618
<table cellpadding="0" cellspacing="0" border="0">
620
<td class="md" nowrap valign="top"> struct <a class="el" href="structds_____key_info_type.html">ds__KeyInfoType</a>* soap_wsse_add_KeyInfo </td>
621
<td class="md" valign="top">( </td>
622
<td class="md" nowrap valign="top">struct soap * </td>
623
<td class="mdname1" valign="top" nowrap> <em>soap</em> </td>
624
<td class="md" valign="top"> ) </td>
625
<td class="md" nowrap></td>
631
<table cellspacing=5 cellpadding=0 border=0>
639
Adds KeyInfo element.
641
<dl compact><dt><b>Parameters:</b></dt><dd>
642
<table border="0" cellspacing="2" cellpadding="0">
643
<tr><td></td><td valign=top><em>soap</em> </td><td>context </td></tr>
646
<dl compact><dt><b>Returns:</b></dt><dd>ds__KeyInfo object </dd></dl>
650
<a class="anchor" name="a47" doxytag="wsseapi.h::soap_wsse_add_KeyInfo_KeyName" ></a><p>
651
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
654
<table cellpadding="0" cellspacing="0" border="0">
656
<td class="md" nowrap valign="top"> int soap_wsse_add_KeyInfo_KeyName </td>
657
<td class="md" valign="top">( </td>
658
<td class="md" nowrap valign="top">struct soap * </td>
659
<td class="mdname" nowrap> <em>soap</em>, </td>
662
<td class="md" nowrap align="right"></td>
664
<td class="md" nowrap>const char * </td>
665
<td class="mdname" nowrap> <em>name</em></td>
669
<td class="md">) </td>
670
<td class="md" colspan="2"></td>
676
<table cellspacing=5 cellpadding=0 border=0>
684
Adds KeyName element.
686
<dl compact><dt><b>Parameters:</b></dt><dd>
687
<table border="0" cellspacing="2" cellpadding="0">
688
<tr><td></td><td valign=top><em>soap</em> </td><td>context </td></tr>
689
<tr><td><tt>[in]</tt> </td><td valign=top><em>name</em> </td><td>string of the KeyName </td></tr>
692
<dl compact><dt><b>Returns:</b></dt><dd>SOAP_OK</dd></dl>
693
Note: the recommended method to add Key information is to utilize KeyIdentifier instead of KeyName. A KeyName is useful mainly for internal use. </td>
696
<a class="anchor" name="a57" doxytag="wsseapi.h::soap_wsse_add_KeyInfo_SecurityTokenReferenceEmbedded" ></a><p>
697
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
700
<table cellpadding="0" cellspacing="0" border="0">
702
<td class="md" nowrap valign="top"> int soap_wsse_add_KeyInfo_SecurityTokenReferenceEmbedded </td>
703
<td class="md" valign="top">( </td>
704
<td class="md" nowrap valign="top">struct soap * </td>
705
<td class="mdname" nowrap> <em>soap</em>, </td>
708
<td class="md" nowrap align="right"></td>
710
<td class="md" nowrap>const char * </td>
711
<td class="mdname" nowrap> <em>id</em>, </td>
714
<td class="md" nowrap align="right"></td>
716
<td class="md" nowrap>const char * </td>
717
<td class="mdname" nowrap> <em>valueType</em></td>
721
<td class="md">) </td>
722
<td class="md" colspan="2"></td>
728
<table cellspacing=5 cellpadding=0 border=0>
736
Adds KeyInfo element with Embedded SecurityTokenReference.
738
<dl compact><dt><b>Parameters:</b></dt><dd>
739
<table border="0" cellspacing="2" cellpadding="0">
740
<tr><td></td><td valign=top><em>soap</em> </td><td>context </td></tr>
741
<tr><td><tt>[in]</tt> </td><td valign=top><em>id</em> </td><td>string for signature reference </td></tr>
742
<tr><td><tt>[in]</tt> </td><td valign=top><em>valueType</em> </td><td>string </td></tr>
745
<dl compact><dt><b>Returns:</b></dt><dd>SOAP_OK</dd></dl>
746
Note: this function does not add embedded tokens automatically. See code for comments. </td>
749
<a class="anchor" name="a54" doxytag="wsseapi.h::soap_wsse_add_KeyInfo_SecurityTokenReferenceKeyIdentifier" ></a><p>
750
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
753
<table cellpadding="0" cellspacing="0" border="0">
755
<td class="md" nowrap valign="top"> int soap_wsse_add_KeyInfo_SecurityTokenReferenceKeyIdentifier </td>
756
<td class="md" valign="top">( </td>
757
<td class="md" nowrap valign="top">struct soap * </td>
758
<td class="mdname" nowrap> <em>soap</em>, </td>
761
<td class="md" nowrap align="right"></td>
763
<td class="md" nowrap>const char * </td>
764
<td class="mdname" nowrap> <em>id</em>, </td>
767
<td class="md" nowrap align="right"></td>
769
<td class="md" nowrap>const char * </td>
770
<td class="mdname" nowrap> <em>valueType</em>, </td>
773
<td class="md" nowrap align="right"></td>
775
<td class="md" nowrap>unsigned char * </td>
776
<td class="mdname" nowrap> <em>data</em>, </td>
779
<td class="md" nowrap align="right"></td>
781
<td class="md" nowrap>int </td>
782
<td class="mdname" nowrap> <em>size</em></td>
786
<td class="md">) </td>
787
<td class="md" colspan="2"></td>
793
<table cellspacing=5 cellpadding=0 border=0>
801
Adds KeyInfo element with SecurityTokenReference/KeyIdentifier binary data.
803
<dl compact><dt><b>Parameters:</b></dt><dd>
804
<table border="0" cellspacing="2" cellpadding="0">
805
<tr><td></td><td valign=top><em>soap</em> </td><td>context </td></tr>
806
<tr><td><tt>[in]</tt> </td><td valign=top><em>id</em> </td><td>string for signature reference </td></tr>
807
<tr><td><tt>[in]</tt> </td><td valign=top><em>valueType</em> </td><td>string </td></tr>
808
<tr><td><tt>[in]</tt> </td><td valign=top><em>data</em> </td><td>binary data </td></tr>
809
<tr><td><tt>[in]</tt> </td><td valign=top><em>size</em> </td><td>of binary data </td></tr>
812
<dl compact><dt><b>Returns:</b></dt><dd>SOAP_OK </dd></dl>
816
<a class="anchor" name="a49" doxytag="wsseapi.h::soap_wsse_add_KeyInfo_SecurityTokenReferenceURI" ></a><p>
817
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
820
<table cellpadding="0" cellspacing="0" border="0">
822
<td class="md" nowrap valign="top"> int soap_wsse_add_KeyInfo_SecurityTokenReferenceURI </td>
823
<td class="md" valign="top">( </td>
824
<td class="md" nowrap valign="top">struct soap * </td>
825
<td class="mdname" nowrap> <em>soap</em>, </td>
828
<td class="md" nowrap align="right"></td>
830
<td class="md" nowrap>const char * </td>
831
<td class="mdname" nowrap> <em>URI</em>, </td>
834
<td class="md" nowrap align="right"></td>
836
<td class="md" nowrap>const char * </td>
837
<td class="mdname" nowrap> <em>valueType</em></td>
841
<td class="md">) </td>
842
<td class="md" colspan="2"></td>
848
<table cellspacing=5 cellpadding=0 border=0>
856
Adds KeyInfo element with SecurityTokenReference URI.
858
<dl compact><dt><b>Parameters:</b></dt><dd>
859
<table border="0" cellspacing="2" cellpadding="0">
860
<tr><td></td><td valign=top><em>soap</em> </td><td>context </td></tr>
861
<tr><td><tt>[in]</tt> </td><td valign=top><em>URI</em> </td><td>string referencing a security token </td></tr>
862
<tr><td><tt>[in]</tt> </td><td valign=top><em>valueType</em> </td><td>string or NULL </td></tr>
865
<dl compact><dt><b>Returns:</b></dt><dd>SOAP_OK </dd></dl>
869
<a class="anchor" name="a50" doxytag="wsseapi.h::soap_wsse_add_KeyInfo_SecurityTokenReferenceX509" ></a><p>
870
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
873
<table cellpadding="0" cellspacing="0" border="0">
875
<td class="md" nowrap valign="top"> int soap_wsse_add_KeyInfo_SecurityTokenReferenceX509 </td>
876
<td class="md" valign="top">( </td>
877
<td class="md" nowrap valign="top">struct soap * </td>
878
<td class="mdname" nowrap> <em>soap</em>, </td>
881
<td class="md" nowrap align="right"></td>
883
<td class="md" nowrap>const char * </td>
884
<td class="mdname" nowrap> <em>URI</em></td>
888
<td class="md">) </td>
889
<td class="md" colspan="2"></td>
895
<table cellspacing=5 cellpadding=0 border=0>
903
Adds KeyInfo element with SecurityTokenReference URI to an X509 cert.
905
<dl compact><dt><b>Parameters:</b></dt><dd>
906
<table border="0" cellspacing="2" cellpadding="0">
907
<tr><td></td><td valign=top><em>soap</em> </td><td>context </td></tr>
908
<tr><td><tt>[in]</tt> </td><td valign=top><em>URI</em> </td><td>string referencing an X509 certificate </td></tr>
911
<dl compact><dt><b>Returns:</b></dt><dd>SOAP_OK </dd></dl>
915
<a class="anchor" name="a14" doxytag="wsseapi.h::soap_wsse_add_Security" ></a><p>
916
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
919
<table cellpadding="0" cellspacing="0" border="0">
921
<td class="md" nowrap valign="top"> struct <a class="el" href="struct__wsse_____security.html">_wsse__Security</a>* soap_wsse_add_Security </td>
922
<td class="md" valign="top">( </td>
923
<td class="md" nowrap valign="top">struct soap * </td>
924
<td class="mdname1" valign="top" nowrap> <em>soap</em> </td>
925
<td class="md" valign="top"> ) </td>
926
<td class="md" nowrap></td>
932
<table cellspacing=5 cellpadding=0 border=0>
940
Adds Security header element.
942
<dl compact><dt><b>Parameters:</b></dt><dd>
943
<table border="0" cellspacing="2" cellpadding="0">
944
<tr><td></td><td valign=top><em>soap</em> </td><td>context </td></tr>
947
<dl compact><dt><b>Returns:</b></dt><dd><a class="el" href="struct__wsse_____security.html">_wsse__Security</a> object </dd></dl>
951
<a class="anchor" name="a15" doxytag="wsseapi.h::soap_wsse_add_Security_actor" ></a><p>
952
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
955
<table cellpadding="0" cellspacing="0" border="0">
957
<td class="md" nowrap valign="top"> struct <a class="el" href="struct__wsse_____security.html">_wsse__Security</a>* soap_wsse_add_Security_actor </td>
958
<td class="md" valign="top">( </td>
959
<td class="md" nowrap valign="top">struct soap * </td>
960
<td class="mdname" nowrap> <em>soap</em>, </td>
963
<td class="md" nowrap align="right"></td>
965
<td class="md" nowrap>const char * </td>
966
<td class="mdname" nowrap> <em>actor</em></td>
970
<td class="md">) </td>
971
<td class="md" colspan="2"></td>
977
<table cellspacing=5 cellpadding=0 border=0>
985
Adds Security header element with actor or role attribute.
987
<dl compact><dt><b>Parameters:</b></dt><dd>
988
<table border="0" cellspacing="2" cellpadding="0">
989
<tr><td></td><td valign=top><em>soap</em> </td><td>context </td></tr>
990
<tr><td></td><td valign=top><em>actor</em> </td><td>string </td></tr>
993
<dl compact><dt><b>Returns:</b></dt><dd><a class="el" href="struct__wsse_____security.html">_wsse__Security</a> object </dd></dl>
997
<a class="anchor" name="a18" doxytag="wsseapi.h::soap_wsse_add_Signature" ></a><p>
998
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1001
<table cellpadding="0" cellspacing="0" border="0">
1003
<td class="md" nowrap valign="top"> struct <a class="el" href="structds_____signature_type.html">ds__SignatureType</a>* soap_wsse_add_Signature </td>
1004
<td class="md" valign="top">( </td>
1005
<td class="md" nowrap valign="top">struct soap * </td>
1006
<td class="mdname1" valign="top" nowrap> <em>soap</em> </td>
1007
<td class="md" valign="top"> ) </td>
1008
<td class="md" nowrap></td>
1014
<table cellspacing=5 cellpadding=0 border=0>
1022
Adds Signature header element.
1024
<dl compact><dt><b>Parameters:</b></dt><dd>
1025
<table border="0" cellspacing="2" cellpadding="0">
1026
<tr><td></td><td valign=top><em>soap</em> </td><td>context </td></tr>
1029
<dl compact><dt><b>Returns:</b></dt><dd><a class="el" href="structds_____signature_type.html">ds__SignatureType</a> object </dd></dl>
1033
<a class="anchor" name="a41" doxytag="wsseapi.h::soap_wsse_add_SignatureValue" ></a><p>
1034
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1037
<table cellpadding="0" cellspacing="0" border="0">
1039
<td class="md" nowrap valign="top"> int soap_wsse_add_SignatureValue </td>
1040
<td class="md" valign="top">( </td>
1041
<td class="md" nowrap valign="top">struct soap * </td>
1042
<td class="mdname" nowrap> <em>soap</em>, </td>
1045
<td class="md" nowrap align="right"></td>
1047
<td class="md" nowrap>int </td>
1048
<td class="mdname" nowrap> <em>alg</em>, </td>
1051
<td class="md" nowrap align="right"></td>
1053
<td class="md" nowrap>const void * </td>
1054
<td class="mdname" nowrap> <em>key</em>, </td>
1057
<td class="md" nowrap align="right"></td>
1059
<td class="md" nowrap>int </td>
1060
<td class="mdname" nowrap> <em>keylen</em></td>
1064
<td class="md">) </td>
1065
<td class="md" colspan="2"></td>
1071
<table cellspacing=5 cellpadding=0 border=0>
1079
Adds SignedInfo/SignatureMethod element, signs the SignedInfo element, and adds the resulting SignatureValue element.
1081
<dl compact><dt><b>Parameters:</b></dt><dd>
1082
<table border="0" cellspacing="2" cellpadding="0">
1083
<tr><td></td><td valign=top><em>soap</em> </td><td>context </td></tr>
1084
<tr><td><tt>[in]</tt> </td><td valign=top><em>alg</em> </td><td>is SOAP_SMD_HMAC_SHA1, SOAP_SMD_SIGN_DSA_SHA1, or SOAP_SMD_SIGN_RSA_SHA1 </td></tr>
1085
<tr><td><tt>[in]</tt> </td><td valign=top><em>key</em> </td><td>to use to sign (HMAC or EVP_PKEY) </td></tr>
1086
<tr><td><tt>[in]</tt> </td><td valign=top><em>keylen</em> </td><td>length of HMAC key </td></tr>
1089
<dl compact><dt><b>Returns:</b></dt><dd>SOAP_OK, SOAP_EOM, or fault</dd></dl>
1090
To sign the SignedInfo element with this function, populate SignedInfo with Reference elements first using soap_wsse_add_SignedInfo_Reference. The SignedInfo element must not be modified after signing.<p>
1091
The SOAP_XML_INDENT and SOAP_XML_CANONICAL flags are used to serialize the SignedInfo to compute the signature. </td>
1094
<a class="anchor" name="a36" doxytag="wsseapi.h::soap_wsse_add_SignedInfo" ></a><p>
1095
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1098
<table cellpadding="0" cellspacing="0" border="0">
1100
<td class="md" nowrap valign="top"> struct <a class="el" href="structds_____signed_info_type.html">ds__SignedInfoType</a>* soap_wsse_add_SignedInfo </td>
1101
<td class="md" valign="top">( </td>
1102
<td class="md" nowrap valign="top">struct soap * </td>
1103
<td class="mdname1" valign="top" nowrap> <em>soap</em> </td>
1104
<td class="md" valign="top"> ) </td>
1105
<td class="md" nowrap></td>
1111
<table cellspacing=5 cellpadding=0 border=0>
1119
Adds SignedInfo element.
1121
<dl compact><dt><b>Parameters:</b></dt><dd>
1122
<table border="0" cellspacing="2" cellpadding="0">
1123
<tr><td></td><td valign=top><em>soap</em> </td><td>context </td></tr>
1126
<dl compact><dt><b>Returns:</b></dt><dd><a class="el" href="structds_____signed_info_type.html">ds__SignedInfoType</a> object </dd></dl>
1130
<a class="anchor" name="a37" doxytag="wsseapi.h::soap_wsse_add_SignedInfo_Reference" ></a><p>
1131
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1134
<table cellpadding="0" cellspacing="0" border="0">
1136
<td class="md" nowrap valign="top"> int soap_wsse_add_SignedInfo_Reference </td>
1137
<td class="md" valign="top">( </td>
1138
<td class="md" nowrap valign="top">struct soap * </td>
1139
<td class="mdname" nowrap> <em>soap</em>, </td>
1142
<td class="md" nowrap align="right"></td>
1144
<td class="md" nowrap>const char * </td>
1145
<td class="mdname" nowrap> <em>URI</em>, </td>
1148
<td class="md" nowrap align="right"></td>
1150
<td class="md" nowrap>const char * </td>
1151
<td class="mdname" nowrap> <em>transform</em>, </td>
1154
<td class="md" nowrap align="right"></td>
1156
<td class="md" nowrap>const char * </td>
1157
<td class="mdname" nowrap> <em>inclusiveNamespaces</em>, </td>
1160
<td class="md" nowrap align="right"></td>
1162
<td class="md" nowrap>const char * </td>
1163
<td class="mdname" nowrap> <em>HA</em></td>
1167
<td class="md">) </td>
1168
<td class="md" colspan="2"></td>
1174
<table cellspacing=5 cellpadding=0 border=0>
1182
Adds SignedInfo element with Reference URI, transform algorithm used, and digest value.
1184
<dl compact><dt><b>Parameters:</b></dt><dd>
1185
<table border="0" cellspacing="2" cellpadding="0">
1186
<tr><td></td><td valign=top><em>soap</em> </td><td>context </td></tr>
1187
<tr><td><tt>[in]</tt> </td><td valign=top><em>URI</em> </td><td>reference </td></tr>
1188
<tr><td><tt>[in]</tt> </td><td valign=top><em>transform</em> </td><td>string should be c14n_URI for exc-c14n or NULL </td></tr>
1189
<tr><td><tt>[in]</tt> </td><td valign=top><em>inclusiveNamespaces</em> </td><td>used by the exc-c14n transform or NULL </td></tr>
1190
<tr><td><tt>[in]</tt> </td><td valign=top><em>HA</em> </td><td>is the SHA1 digest in binary form (length=SOAP_SMD_SHA1_SIZE) </td></tr>
1193
<dl compact><dt><b>Returns:</b></dt><dd>SOAP_OK or SOAP_EOM when references exceed SOAP_WSSE_MAX_REF</dd></dl>
1194
This function can be called to add more references to the wsse:SignedInfo element. A maximum number of SOAP_WSSE_MAX_REF references can be added. The digest method is always SHA1. Note: XPath transforms cannot be specified in this release. </td>
1197
<a class="anchor" name="a38" doxytag="wsseapi.h::soap_wsse_add_SignedInfo_SignatureMethod" ></a><p>
1198
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1201
<table cellpadding="0" cellspacing="0" border="0">
1203
<td class="md" nowrap valign="top"> int soap_wsse_add_SignedInfo_SignatureMethod </td>
1204
<td class="md" valign="top">( </td>
1205
<td class="md" nowrap valign="top">struct soap * </td>
1206
<td class="mdname" nowrap> <em>soap</em>, </td>
1209
<td class="md" nowrap align="right"></td>
1211
<td class="md" nowrap>const char * </td>
1212
<td class="mdname" nowrap> <em>method</em>, </td>
1215
<td class="md" nowrap align="right"></td>
1217
<td class="md" nowrap>int </td>
1218
<td class="mdname" nowrap> <em>canonical</em></td>
1222
<td class="md">) </td>
1223
<td class="md" colspan="2"></td>
1229
<table cellspacing=5 cellpadding=0 border=0>
1237
Adds SignedInfo element with SignatureMethod.
1239
<dl compact><dt><b>Parameters:</b></dt><dd>
1240
<table border="0" cellspacing="2" cellpadding="0">
1241
<tr><td></td><td valign=top><em>soap</em> </td><td>context </td></tr>
1242
<tr><td><tt>[in]</tt> </td><td valign=top><em>method</em> </td><td>is the URI of the signature algorithm (e.g. ds_rsa_sha1) </td></tr>
1243
<tr><td><tt>[in]</tt> </td><td valign=top><em>canonical</em> </td><td>flag indicating that SignedInfo is signed in exc-c14n form </td></tr>
1246
<dl compact><dt><b>Returns:</b></dt><dd>SOAP_OK</dd></dl>
1247
Note: the c14n:InclusiveNamespaces/PrefixList is set to "SOAP-ENV wsse". </td>
1250
<a class="anchor" name="a21" doxytag="wsseapi.h::soap_wsse_add_Timestamp" ></a><p>
1251
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1254
<table cellpadding="0" cellspacing="0" border="0">
1256
<td class="md" nowrap valign="top"> int soap_wsse_add_Timestamp </td>
1257
<td class="md" valign="top">( </td>
1258
<td class="md" nowrap valign="top">struct soap * </td>
1259
<td class="mdname" nowrap> <em>soap</em>, </td>
1262
<td class="md" nowrap align="right"></td>
1264
<td class="md" nowrap>const char * </td>
1265
<td class="mdname" nowrap> <em>id</em>, </td>
1268
<td class="md" nowrap align="right"></td>
1270
<td class="md" nowrap>time_t </td>
1271
<td class="mdname" nowrap> <em>lifetime</em></td>
1275
<td class="md">) </td>
1276
<td class="md" colspan="2"></td>
1282
<table cellspacing=5 cellpadding=0 border=0>
1290
Adds Timestamp element with optional expiration date+time (lifetime).
1292
<dl compact><dt><b>Parameters:</b></dt><dd>
1293
<table border="0" cellspacing="2" cellpadding="0">
1294
<tr><td><tt>[in]</tt> </td><td valign=top><em>soap</em> </td><td>context </td></tr>
1295
<tr><td><tt>[in]</tt> </td><td valign=top><em>id</em> </td><td>for signature referencing or NULL </td></tr>
1296
<tr><td><tt>[in]</tt> </td><td valign=top><em>lifetime</em> </td><td>expressed in time_t units, or 0 for no expiration </td></tr>
1299
<dl compact><dt><b>Returns:</b></dt><dd>SOAP_OK </dd></dl>
1303
<a class="anchor" name="a25" doxytag="wsseapi.h::soap_wsse_add_UsernameTokenDigest" ></a><p>
1304
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1307
<table cellpadding="0" cellspacing="0" border="0">
1309
<td class="md" nowrap valign="top"> int soap_wsse_add_UsernameTokenDigest </td>
1310
<td class="md" valign="top">( </td>
1311
<td class="md" nowrap valign="top">struct soap * </td>
1312
<td class="mdname" nowrap> <em>soap</em>, </td>
1315
<td class="md" nowrap align="right"></td>
1317
<td class="md" nowrap>const char * </td>
1318
<td class="mdname" nowrap> <em>id</em>, </td>
1321
<td class="md" nowrap align="right"></td>
1323
<td class="md" nowrap>const char * </td>
1324
<td class="mdname" nowrap> <em>username</em>, </td>
1327
<td class="md" nowrap align="right"></td>
1329
<td class="md" nowrap>const char * </td>
1330
<td class="mdname" nowrap> <em>password</em></td>
1334
<td class="md">) </td>
1335
<td class="md" colspan="2"></td>
1341
<table cellspacing=5 cellpadding=0 border=0>
1349
Adds UsernameToken element for digest authentication.
1351
<dl compact><dt><b>Parameters:</b></dt><dd>
1352
<table border="0" cellspacing="2" cellpadding="0">
1353
<tr><td></td><td valign=top><em>soap</em> </td><td>context </td></tr>
1354
<tr><td><tt>[in]</tt> </td><td valign=top><em>id</em> </td><td>string for signature referencing or NULL </td></tr>
1355
<tr><td><tt>[in]</tt> </td><td valign=top><em>username</em> </td><td>string </td></tr>
1356
<tr><td><tt>[in]</tt> </td><td valign=top><em>password</em> </td><td>string </td></tr>
1359
<dl compact><dt><b>Returns:</b></dt><dd>SOAP_OK</dd></dl>
1360
Computes SHA1 digest of the time stamp, a nonce, and the password. The digest provides the authentication credentials. Passwords are NOT sent in the clear. Note: this release supports the use of at most one UsernameToken in the header. </td>
1363
<a class="anchor" name="a24" doxytag="wsseapi.h::soap_wsse_add_UsernameTokenText" ></a><p>
1364
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1367
<table cellpadding="0" cellspacing="0" border="0">
1369
<td class="md" nowrap valign="top"> int soap_wsse_add_UsernameTokenText </td>
1370
<td class="md" valign="top">( </td>
1371
<td class="md" nowrap valign="top">struct soap * </td>
1372
<td class="mdname" nowrap> <em>soap</em>, </td>
1375
<td class="md" nowrap align="right"></td>
1377
<td class="md" nowrap>const char * </td>
1378
<td class="mdname" nowrap> <em>id</em>, </td>
1381
<td class="md" nowrap align="right"></td>
1383
<td class="md" nowrap>const char * </td>
1384
<td class="mdname" nowrap> <em>username</em>, </td>
1387
<td class="md" nowrap align="right"></td>
1389
<td class="md" nowrap>const char * </td>
1390
<td class="mdname" nowrap> <em>password</em></td>
1394
<td class="md">) </td>
1395
<td class="md" colspan="2"></td>
1401
<table cellspacing=5 cellpadding=0 border=0>
1409
Adds UsernameToken element with optional clear-text password.
1411
<dl compact><dt><b>Parameters:</b></dt><dd>
1412
<table border="0" cellspacing="2" cellpadding="0">
1413
<tr><td></td><td valign=top><em>soap</em> </td><td>context </td></tr>
1414
<tr><td><tt>[in]</tt> </td><td valign=top><em>id</em> </td><td>string for signature referencing or NULL </td></tr>
1415
<tr><td><tt>[in]</tt> </td><td valign=top><em>username</em> </td><td>string </td></tr>
1416
<tr><td><tt>[in]</tt> </td><td valign=top><em>password</em> </td><td>string or NULL to omit the password </td></tr>
1419
<dl compact><dt><b>Returns:</b></dt><dd>SOAP_OK</dd></dl>
1420
Passwords are sent in the clear, so transport-level encryption is required. Note: this release supports the use of at most one UsernameToken in the header. </td>
1423
<a class="anchor" name="a32" doxytag="wsseapi.h::soap_wsse_BinarySecurityToken" ></a><p>
1424
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1427
<table cellpadding="0" cellspacing="0" border="0">
1429
<td class="md" nowrap valign="top"> struct <a class="el" href="struct__wsse_____binary_security_token.html">_wsse__BinarySecurityToken</a>* soap_wsse_BinarySecurityToken </td>
1430
<td class="md" valign="top">( </td>
1431
<td class="md" nowrap valign="top">struct soap * </td>
1432
<td class="mdname" nowrap> <em>soap</em>, </td>
1435
<td class="md" nowrap align="right"></td>
1437
<td class="md" nowrap>const char * </td>
1438
<td class="mdname" nowrap> <em>id</em></td>
1442
<td class="md">) </td>
1443
<td class="md" colspan="2"></td>
1449
<table cellspacing=5 cellpadding=0 border=0>
1457
Returns BinarySecurityToken element if present.
1459
<dl compact><dt><b>Parameters:</b></dt><dd>
1460
<table border="0" cellspacing="2" cellpadding="0">
1461
<tr><td></td><td valign=top><em>soap</em> </td><td>context </td></tr>
1462
<tr><td><tt>[in]</tt> </td><td valign=top><em>id</em> </td><td>string of token to get or NULL </td></tr>
1465
<dl compact><dt><b>Returns:</b></dt><dd><a class="el" href="struct__wsse_____binary_security_token.html">_wsse__BinarySecurityToken</a> object or NULL </dd></dl>
1469
<a class="anchor" name="a16" doxytag="wsseapi.h::soap_wsse_delete_Security" ></a><p>
1470
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1473
<table cellpadding="0" cellspacing="0" border="0">
1475
<td class="md" nowrap valign="top"> void soap_wsse_delete_Security </td>
1476
<td class="md" valign="top">( </td>
1477
<td class="md" nowrap valign="top">struct soap * </td>
1478
<td class="mdname1" valign="top" nowrap> <em>soap</em> </td>
1479
<td class="md" valign="top"> ) </td>
1480
<td class="md" nowrap></td>
1486
<table cellspacing=5 cellpadding=0 border=0>
1494
Deletes Security header element.
1496
<dl compact><dt><b>Parameters:</b></dt><dd>
1497
<table border="0" cellspacing="2" cellpadding="0">
1498
<tr><td></td><td valign=top><em>soap</em> </td><td>context </td></tr>
1504
<a class="anchor" name="a19" doxytag="wsseapi.h::soap_wsse_delete_Signature" ></a><p>
1505
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1508
<table cellpadding="0" cellspacing="0" border="0">
1510
<td class="md" nowrap valign="top"> void soap_wsse_delete_Signature </td>
1511
<td class="md" valign="top">( </td>
1512
<td class="md" nowrap valign="top">struct soap * </td>
1513
<td class="mdname1" valign="top" nowrap> <em>soap</em> </td>
1514
<td class="md" valign="top"> ) </td>
1515
<td class="md" nowrap></td>
1521
<table cellspacing=5 cellpadding=0 border=0>
1529
Deletes Signature header element.
1531
<dl compact><dt><b>Parameters:</b></dt><dd>
1532
<table border="0" cellspacing="2" cellpadding="0">
1533
<tr><td></td><td valign=top><em>soap</em> </td><td>context </td></tr>
1539
<a class="anchor" name="a58" doxytag="wsseapi.h::soap_wsse_fault" ></a><p>
1540
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1543
<table cellpadding="0" cellspacing="0" border="0">
1545
<td class="md" nowrap valign="top"> int soap_wsse_fault </td>
1546
<td class="md" valign="top">( </td>
1547
<td class="md" nowrap valign="top">struct soap * </td>
1548
<td class="mdname" nowrap> <em>soap</em>, </td>
1551
<td class="md" nowrap align="right"></td>
1553
<td class="md" nowrap>enum <a class="el" href="wsse_8h.html#a0">wsse__FaultcodeEnum</a> </td>
1554
<td class="mdname" nowrap> <em>fault</em>, </td>
1557
<td class="md" nowrap align="right"></td>
1559
<td class="md" nowrap>const char * </td>
1560
<td class="mdname" nowrap> <em>detail</em></td>
1564
<td class="md">) </td>
1565
<td class="md" colspan="2"></td>
1571
<table cellspacing=5 cellpadding=0 border=0>
1582
<a class="anchor" name="a33" doxytag="wsseapi.h::soap_wsse_get_BinarySecurityToken" ></a><p>
1583
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1586
<table cellpadding="0" cellspacing="0" border="0">
1588
<td class="md" nowrap valign="top"> int soap_wsse_get_BinarySecurityToken </td>
1589
<td class="md" valign="top">( </td>
1590
<td class="md" nowrap valign="top">struct soap * </td>
1591
<td class="mdname" nowrap> <em>soap</em>, </td>
1594
<td class="md" nowrap align="right"></td>
1596
<td class="md" nowrap>const char * </td>
1597
<td class="mdname" nowrap> <em>id</em>, </td>
1600
<td class="md" nowrap align="right"></td>
1602
<td class="md" nowrap>char ** </td>
1603
<td class="mdname" nowrap> <em>valueType</em>, </td>
1606
<td class="md" nowrap align="right"></td>
1608
<td class="md" nowrap>unsigned char ** </td>
1609
<td class="mdname" nowrap> <em>data</em>, </td>
1612
<td class="md" nowrap align="right"></td>
1614
<td class="md" nowrap>int * </td>
1615
<td class="mdname" nowrap> <em>size</em></td>
1619
<td class="md">) </td>
1620
<td class="md" colspan="2"></td>
1626
<table cellspacing=5 cellpadding=0 border=0>
1634
Get wsse:BinarySecurityToken element token data in binary form.
1636
<dl compact><dt><b>Parameters:</b></dt><dd>
1637
<table border="0" cellspacing="2" cellpadding="0">
1638
<tr><td></td><td valign=top><em>soap</em> </td><td>context </td></tr>
1639
<tr><td><tt>[in]</tt> </td><td valign=top><em>id</em> </td><td>string of token to get or NULL </td></tr>
1640
<tr><td><tt>[out]</tt> </td><td valign=top><em>valueType</em> </td><td>string </td></tr>
1641
<tr><td><tt>[out]</tt> </td><td valign=top><em>data</em> </td><td>points to binary token data </td></tr>
1642
<tr><td><tt>[out]</tt> </td><td valign=top><em>size</em> </td><td>is length of binary token </td></tr>
1645
<dl compact><dt><b>Returns:</b></dt><dd>SOAP_OK or SOAP_FAULT with wsse:SecurityTokenUnavailable fault </dd></dl>
1649
<a class="anchor" name="a34" doxytag="wsseapi.h::soap_wsse_get_BinarySecurityTokenX509" ></a><p>
1650
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1653
<table cellpadding="0" cellspacing="0" border="0">
1655
<td class="md" nowrap valign="top"> X509* soap_wsse_get_BinarySecurityTokenX509 </td>
1656
<td class="md" valign="top">( </td>
1657
<td class="md" nowrap valign="top">struct soap * </td>
1658
<td class="mdname" nowrap> <em>soap</em>, </td>
1661
<td class="md" nowrap align="right"></td>
1663
<td class="md" nowrap>const char * </td>
1664
<td class="mdname" nowrap> <em>id</em></td>
1668
<td class="md">) </td>
1669
<td class="md" colspan="2"></td>
1675
<table cellspacing=5 cellpadding=0 border=0>
1683
Get X509 wsse:BinarySecurityToken certificate and verify its content.
1685
<dl compact><dt><b>Parameters:</b></dt><dd>
1686
<table border="0" cellspacing="2" cellpadding="0">
1687
<tr><td></td><td valign=top><em>soap</em> </td><td>context </td></tr>
1688
<tr><td><tt>[in]</tt> </td><td valign=top><em>id</em> </td><td>string of token to get or NULL </td></tr>
1691
<dl compact><dt><b>Returns:</b></dt><dd>X509 certificate (dynamically allocated) or NULL with wsse:SecurityTokenUnavailable fault </dd></dl>
1695
<a class="anchor" name="a48" doxytag="wsseapi.h::soap_wsse_get_KeyInfo_KeyName" ></a><p>
1696
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1699
<table cellpadding="0" cellspacing="0" border="0">
1701
<td class="md" nowrap valign="top"> const char* soap_wsse_get_KeyInfo_KeyName </td>
1702
<td class="md" valign="top">( </td>
1703
<td class="md" nowrap valign="top">struct soap * </td>
1704
<td class="mdname1" valign="top" nowrap> <em>soap</em> </td>
1705
<td class="md" valign="top"> ) </td>
1706
<td class="md" nowrap></td>
1712
<table cellspacing=5 cellpadding=0 border=0>
1720
Returns KeyName element if present.
1722
<dl compact><dt><b>Parameters:</b></dt><dd>
1723
<table border="0" cellspacing="2" cellpadding="0">
1724
<tr><td></td><td valign=top><em>soap</em> </td><td>context </td></tr>
1727
<dl compact><dt><b>Returns:</b></dt><dd>string or NULL </dd></dl>
1731
<a class="anchor" name="a56" doxytag="wsseapi.h::soap_wsse_get_KeyInfo_SecurityTokenReferenceKeyIdentifier" ></a><p>
1732
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1735
<table cellpadding="0" cellspacing="0" border="0">
1737
<td class="md" nowrap valign="top"> const unsigned char* soap_wsse_get_KeyInfo_SecurityTokenReferenceKeyIdentifier </td>
1738
<td class="md" valign="top">( </td>
1739
<td class="md" nowrap valign="top">struct soap * </td>
1740
<td class="mdname" nowrap> <em>soap</em>, </td>
1743
<td class="md" nowrap align="right"></td>
1745
<td class="md" nowrap>int * </td>
1746
<td class="mdname" nowrap> <em>size</em></td>
1750
<td class="md">) </td>
1751
<td class="md" colspan="2"></td>
1757
<table cellspacing=5 cellpadding=0 border=0>
1765
Returns KeyInfo/SecurityTokenReference/KeyIdentifier binary data.
1767
<dl compact><dt><b>Parameters:</b></dt><dd>
1768
<table border="0" cellspacing="2" cellpadding="0">
1769
<tr><td></td><td valign=top><em>soap</em> </td><td>context </td></tr>
1770
<tr><td><tt>[out]</tt> </td><td valign=top><em>size</em> </td><td>is set to the size of the decoded data </td></tr>
1773
<dl compact><dt><b>Returns:</b></dt><dd>data or NULL </dd></dl>
1777
<a class="anchor" name="a55" doxytag="wsseapi.h::soap_wsse_get_KeyInfo_SecurityTokenReferenceKeyIdentifierValueType" ></a><p>
1778
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1781
<table cellpadding="0" cellspacing="0" border="0">
1783
<td class="md" nowrap valign="top"> const char* soap_wsse_get_KeyInfo_SecurityTokenReferenceKeyIdentifierValueType </td>
1784
<td class="md" valign="top">( </td>
1785
<td class="md" nowrap valign="top">struct soap * </td>
1786
<td class="mdname1" valign="top" nowrap> <em>soap</em> </td>
1787
<td class="md" valign="top"> ) </td>
1788
<td class="md" nowrap></td>
1794
<table cellspacing=5 cellpadding=0 border=0>
1802
Returns KeyInfo/SecurityTokenReference/KeyIdentifier/ValueType if present.
1804
<dl compact><dt><b>Parameters:</b></dt><dd>
1805
<table border="0" cellspacing="2" cellpadding="0">
1806
<tr><td></td><td valign=top><em>soap</em> </td><td>context </td></tr>
1809
<dl compact><dt><b>Returns:</b></dt><dd>string or NULL </dd></dl>
1813
<a class="anchor" name="a51" doxytag="wsseapi.h::soap_wsse_get_KeyInfo_SecurityTokenReferenceURI" ></a><p>
1814
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1817
<table cellpadding="0" cellspacing="0" border="0">
1819
<td class="md" nowrap valign="top"> const char* soap_wsse_get_KeyInfo_SecurityTokenReferenceURI </td>
1820
<td class="md" valign="top">( </td>
1821
<td class="md" nowrap valign="top">struct soap * </td>
1822
<td class="mdname1" valign="top" nowrap> <em>soap</em> </td>
1823
<td class="md" valign="top"> ) </td>
1824
<td class="md" nowrap></td>
1830
<table cellspacing=5 cellpadding=0 border=0>
1838
Returns a SecurityTokenReference URI if present.
1840
<dl compact><dt><b>Parameters:</b></dt><dd>
1841
<table border="0" cellspacing="2" cellpadding="0">
1842
<tr><td></td><td valign=top><em>soap</em> </td><td>context </td></tr>
1845
<dl compact><dt><b>Returns:</b></dt><dd>string or NULL </dd></dl>
1849
<a class="anchor" name="a52" doxytag="wsseapi.h::soap_wsse_get_KeyInfo_SecurityTokenReferenceValueType" ></a><p>
1850
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1853
<table cellpadding="0" cellspacing="0" border="0">
1855
<td class="md" nowrap valign="top"> const char* soap_wsse_get_KeyInfo_SecurityTokenReferenceValueType </td>
1856
<td class="md" valign="top">( </td>
1857
<td class="md" nowrap valign="top">struct soap * </td>
1858
<td class="mdname1" valign="top" nowrap> <em>soap</em> </td>
1859
<td class="md" valign="top"> ) </td>
1860
<td class="md" nowrap></td>
1866
<table cellspacing=5 cellpadding=0 border=0>
1874
Returns a SecurityTokenReference ValueType if present.
1876
<dl compact><dt><b>Parameters:</b></dt><dd>
1877
<table border="0" cellspacing="2" cellpadding="0">
1878
<tr><td></td><td valign=top><em>soap</em> </td><td>context </td></tr>
1881
<dl compact><dt><b>Returns:</b></dt><dd>string or NULL </dd></dl>
1885
<a class="anchor" name="a53" doxytag="wsseapi.h::soap_wsse_get_KeyInfo_SecurityTokenReferenceX509" ></a><p>
1886
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1889
<table cellpadding="0" cellspacing="0" border="0">
1891
<td class="md" nowrap valign="top"> X509* soap_wsse_get_KeyInfo_SecurityTokenReferenceX509 </td>
1892
<td class="md" valign="top">( </td>
1893
<td class="md" nowrap valign="top">struct soap * </td>
1894
<td class="mdname1" valign="top" nowrap> <em>soap</em> </td>
1895
<td class="md" valign="top"> ) </td>
1896
<td class="md" nowrap></td>
1902
<table cellspacing=5 cellpadding=0 border=0>
1910
Returns a X509 certificate if present as a BinarySecurity token.
1912
<dl compact><dt><b>Parameters:</b></dt><dd>
1913
<table border="0" cellspacing="2" cellpadding="0">
1914
<tr><td></td><td valign=top><em>soap</em> </td><td>context </td></tr>
1917
<dl compact><dt><b>Returns:</b></dt><dd>X509 object or NULL with wsse:SecurityTokenUnavailable fault </dd></dl>
1921
<a class="anchor" name="a40" doxytag="wsseapi.h::soap_wsse_get_SignedInfo_SignatureMethod" ></a><p>
1922
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1925
<table cellpadding="0" cellspacing="0" border="0">
1927
<td class="md" nowrap valign="top"> int soap_wsse_get_SignedInfo_SignatureMethod </td>
1928
<td class="md" valign="top">( </td>
1929
<td class="md" nowrap valign="top">struct soap * </td>
1930
<td class="mdname" nowrap> <em>soap</em>, </td>
1933
<td class="md" nowrap align="right"></td>
1935
<td class="md" nowrap>int * </td>
1936
<td class="mdname" nowrap> <em>alg</em></td>
1940
<td class="md">) </td>
1941
<td class="md" colspan="2"></td>
1947
<table cellspacing=5 cellpadding=0 border=0>
1955
Get SignatureMethod algorithm.
1957
<dl compact><dt><b>Parameters:</b></dt><dd>
1958
<table border="0" cellspacing="2" cellpadding="0">
1959
<tr><td></td><td valign=top><em>soap</em> </td><td>context </td></tr>
1960
<tr><td><tt>[out]</tt> </td><td valign=top><em>alg</em> </td><td>is SOAP_SMD_HMAC_SHA1, SOAP_SMD_VRFY_DSA_SHA1, or SOAP_SMD_VRFY_RSA_SHA1 </td></tr>
1963
<dl compact><dt><b>Returns:</b></dt><dd>SOAP_OK or SOAP_FAULT with wsse:UnsupportedAlgorithm or wsse:FailedCheck fault </dd></dl>
1967
<a class="anchor" name="a27" doxytag="wsseapi.h::soap_wsse_get_Username" ></a><p>
1968
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1971
<table cellpadding="0" cellspacing="0" border="0">
1973
<td class="md" nowrap valign="top"> const char* soap_wsse_get_Username </td>
1974
<td class="md" valign="top">( </td>
1975
<td class="md" nowrap valign="top">struct soap * </td>
1976
<td class="mdname1" valign="top" nowrap> <em>soap</em> </td>
1977
<td class="md" valign="top"> ) </td>
1978
<td class="md" nowrap></td>
1984
<table cellspacing=5 cellpadding=0 border=0>
1992
Returns UsernameToken/username string or wsse:FailedAuthentication fault.
1994
<dl compact><dt><b>Parameters:</b></dt><dd>
1995
<table border="0" cellspacing="2" cellpadding="0">
1996
<tr><td></td><td valign=top><em>soap</em> </td><td>context </td></tr>
1999
<dl compact><dt><b>Returns:</b></dt><dd>UsernameToken/username string or NULL with wsse:FailedAuthentication fault error set </dd></dl>
2000
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="wsseapi_8h.html#a28">soap_wsse_verify_Password</a></dd></dl>
2001
The returned username should be used to lookup the user's password in a dictionary or database for server-side authentication with soap_wsse_verify_Password. </td>
2004
<a class="anchor" name="a46" doxytag="wsseapi.h::soap_wsse_KeyInfo" ></a><p>
2005
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
2008
<table cellpadding="0" cellspacing="0" border="0">
2010
<td class="md" nowrap valign="top"> struct <a class="el" href="structds_____key_info_type.html">ds__KeyInfoType</a>* soap_wsse_KeyInfo </td>
2011
<td class="md" valign="top">( </td>
2012
<td class="md" nowrap valign="top">struct soap * </td>
2013
<td class="mdname1" valign="top" nowrap> <em>soap</em> </td>
2014
<td class="md" valign="top"> ) </td>
2015
<td class="md" nowrap></td>
2021
<table cellspacing=5 cellpadding=0 border=0>
2029
Returns KeyInfo element if present.
2031
<dl compact><dt><b>Parameters:</b></dt><dd>
2032
<table border="0" cellspacing="2" cellpadding="0">
2033
<tr><td></td><td valign=top><em>soap</em> </td><td>context </td></tr>
2036
<dl compact><dt><b>Returns:</b></dt><dd>ds__KeyInfo object or NULL </dd></dl>
2040
<a class="anchor" name="a17" doxytag="wsseapi.h::soap_wsse_Security" ></a><p>
2041
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
2044
<table cellpadding="0" cellspacing="0" border="0">
2046
<td class="md" nowrap valign="top"> struct <a class="el" href="struct__wsse_____security.html">_wsse__Security</a>* soap_wsse_Security </td>
2047
<td class="md" valign="top">( </td>
2048
<td class="md" nowrap valign="top">struct soap * </td>
2049
<td class="mdname1" valign="top" nowrap> <em>soap</em> </td>
2050
<td class="md" valign="top"> ) </td>
2051
<td class="md" nowrap></td>
2057
<table cellspacing=5 cellpadding=0 border=0>
2065
Returns Security header element if present.
2067
<dl compact><dt><b>Parameters:</b></dt><dd>
2068
<table border="0" cellspacing="2" cellpadding="0">
2069
<tr><td></td><td valign=top><em>soap</em> </td><td>context </td></tr>
2072
<dl compact><dt><b>Returns:</b></dt><dd><a class="el" href="struct__wsse_____security.html">_wsse__Security</a> object or NULL </dd></dl>
2076
<a class="anchor" name="a60" doxytag="wsseapi.h::soap_wsse_sign" ></a><p>
2077
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
2080
<table cellpadding="0" cellspacing="0" border="0">
2082
<td class="md" nowrap valign="top"> int soap_wsse_sign </td>
2083
<td class="md" valign="top">( </td>
2084
<td class="md" nowrap valign="top">struct soap * </td>
2085
<td class="mdname" nowrap> <em>soap</em>, </td>
2088
<td class="md" nowrap align="right"></td>
2090
<td class="md" nowrap>int </td>
2091
<td class="mdname" nowrap> <em>alg</em>, </td>
2094
<td class="md" nowrap align="right"></td>
2096
<td class="md" nowrap>const void * </td>
2097
<td class="mdname" nowrap> <em>key</em>, </td>
2100
<td class="md" nowrap align="right"></td>
2102
<td class="md" nowrap>int </td>
2103
<td class="mdname" nowrap> <em>keylen</em></td>
2107
<td class="md">) </td>
2108
<td class="md" colspan="2"></td>
2114
<table cellspacing=5 cellpadding=0 border=0>
2122
Uses the wsse plugin to sign all wsu:Id attributed elements.
2124
<dl compact><dt><b>Parameters:</b></dt><dd>
2125
<table border="0" cellspacing="2" cellpadding="0">
2126
<tr><td></td><td valign=top><em>soap</em> </td><td>context </td></tr>
2127
<tr><td><tt>[in]</tt> </td><td valign=top><em>alg</em> </td><td>is the signature algorithm SOAP_SMD_HMAC_SHA1, SOAP_SMD_SIGN_DSA_SHA1, or SOAP_SMD_SIGN_RSA_SHA1 </td></tr>
2128
<tr><td><tt>[in]</tt> </td><td valign=top><em>key</em> </td><td>is the HMAC secret key or DSA/RSA private EVP_PKEY </td></tr>
2129
<tr><td><tt>[in]</tt> </td><td valign=top><em>keylen</em> </td><td>is the HMAC key length </td></tr>
2132
<dl compact><dt><b>Returns:</b></dt><dd>SOAP_OK or fault</dd></dl>
2133
This function does not actually sign the message, but initiates the plugin's signature algorithm to sign the message upon message transfer. </td>
2136
<a class="anchor" name="a61" doxytag="wsseapi.h::soap_wsse_sign_body" ></a><p>
2137
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
2140
<table cellpadding="0" cellspacing="0" border="0">
2142
<td class="md" nowrap valign="top"> int soap_wsse_sign_body </td>
2143
<td class="md" valign="top">( </td>
2144
<td class="md" nowrap valign="top">struct soap * </td>
2145
<td class="mdname" nowrap> <em>soap</em>, </td>
2148
<td class="md" nowrap align="right"></td>
2150
<td class="md" nowrap>int </td>
2151
<td class="mdname" nowrap> <em>alg</em>, </td>
2154
<td class="md" nowrap align="right"></td>
2156
<td class="md" nowrap>const void * </td>
2157
<td class="mdname" nowrap> <em>key</em>, </td>
2160
<td class="md" nowrap align="right"></td>
2162
<td class="md" nowrap>int </td>
2163
<td class="mdname" nowrap> <em>keylen</em></td>
2167
<td class="md">) </td>
2168
<td class="md" colspan="2"></td>
2174
<table cellspacing=5 cellpadding=0 border=0>
2182
Uses the wsse plugin to sign all wsu:Id attributed elements, including the SOAP Body (by adding a wsu:Id="Body" attribute).
2184
<dl compact><dt><b>Parameters:</b></dt><dd>
2185
<table border="0" cellspacing="2" cellpadding="0">
2186
<tr><td></td><td valign=top><em>soap</em> </td><td>context </td></tr>
2187
<tr><td><tt>[in]</tt> </td><td valign=top><em>alg</em> </td><td>is the signature algorithm SOAP_SMD_HMAC_SHA1, SOAP_SMD_SIGN_DSA_SHA1, or SOAP_SMD_SIGN_RSA_SHA1 </td></tr>
2188
<tr><td><tt>[in]</tt> </td><td valign=top><em>key</em> </td><td>is the HMAC secret key or DSA/RSA private EVP_PKEY </td></tr>
2189
<tr><td><tt>[in]</tt> </td><td valign=top><em>keylen</em> </td><td>is the HMAC key length </td></tr>
2192
<dl compact><dt><b>Returns:</b></dt><dd>SOAP_OK</dd></dl>
2193
This function does not actually sign the message, but initiates the plugin's signature algorithm to sign the message upon message transfer. </td>
2196
<a class="anchor" name="a20" doxytag="wsseapi.h::soap_wsse_Signature" ></a><p>
2197
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
2200
<table cellpadding="0" cellspacing="0" border="0">
2202
<td class="md" nowrap valign="top"> struct <a class="el" href="structds_____signature_type.html">ds__SignatureType</a>* soap_wsse_Signature </td>
2203
<td class="md" valign="top">( </td>
2204
<td class="md" nowrap valign="top">struct soap * </td>
2205
<td class="mdname1" valign="top" nowrap> <em>soap</em> </td>
2206
<td class="md" valign="top"> ) </td>
2207
<td class="md" nowrap></td>
2213
<table cellspacing=5 cellpadding=0 border=0>
2221
Returns Signature header element if present.
2223
<dl compact><dt><b>Parameters:</b></dt><dd>
2224
<table border="0" cellspacing="2" cellpadding="0">
2225
<tr><td></td><td valign=top><em>soap</em> </td><td>context </td></tr>
2228
<dl compact><dt><b>Returns:</b></dt><dd><a class="el" href="structds_____signature_type.html">ds__SignatureType</a> object or NULL </dd></dl>
2232
<a class="anchor" name="a39" doxytag="wsseapi.h::soap_wsse_SignedInfo" ></a><p>
2233
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
2236
<table cellpadding="0" cellspacing="0" border="0">
2238
<td class="md" nowrap valign="top"> struct <a class="el" href="structds_____signed_info_type.html">ds__SignedInfoType</a>* soap_wsse_SignedInfo </td>
2239
<td class="md" valign="top">( </td>
2240
<td class="md" nowrap valign="top">struct soap * </td>
2241
<td class="mdname1" valign="top" nowrap> <em>soap</em> </td>
2242
<td class="md" valign="top"> ) </td>
2243
<td class="md" nowrap></td>
2249
<table cellspacing=5 cellpadding=0 border=0>
2257
Returns SignedInfo element if present.
2259
<dl compact><dt><b>Parameters:</b></dt><dd>
2260
<table border="0" cellspacing="2" cellpadding="0">
2261
<tr><td></td><td valign=top><em>soap</em> </td><td>context </td></tr>
2264
<dl compact><dt><b>Returns:</b></dt><dd><a class="el" href="structds_____signed_info_type.html">ds__SignedInfoType</a> object or NULL </dd></dl>
2268
<a class="anchor" name="a22" doxytag="wsseapi.h::soap_wsse_Timestamp" ></a><p>
2269
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
2272
<table cellpadding="0" cellspacing="0" border="0">
2274
<td class="md" nowrap valign="top"> struct <a class="el" href="struct__wsu_____timestamp.html">_wsu__Timestamp</a>* soap_wsse_Timestamp </td>
2275
<td class="md" valign="top">( </td>
2276
<td class="md" nowrap valign="top">struct soap * </td>
2277
<td class="mdname1" valign="top" nowrap> <em>soap</em> </td>
2278
<td class="md" valign="top"> ) </td>
2279
<td class="md" nowrap></td>
2285
<table cellspacing=5 cellpadding=0 border=0>
2293
Returns Timestamp element if present.
2295
<dl compact><dt><b>Parameters:</b></dt><dd>
2296
<table border="0" cellspacing="2" cellpadding="0">
2297
<tr><td></td><td valign=top><em>soap</em> </td><td>context </td></tr>
2300
<dl compact><dt><b>Returns:</b></dt><dd><a class="el" href="struct__wsu_____timestamp.html">_wsu__Timestamp</a> object or NULL </dd></dl>
2304
<a class="anchor" name="a26" doxytag="wsseapi.h::soap_wsse_UsernameToken" ></a><p>
2305
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
2308
<table cellpadding="0" cellspacing="0" border="0">
2310
<td class="md" nowrap valign="top"> struct <a class="el" href="struct__wsse_____username_token.html">_wsse__UsernameToken</a>* soap_wsse_UsernameToken </td>
2311
<td class="md" valign="top">( </td>
2312
<td class="md" nowrap valign="top">struct soap * </td>
2313
<td class="mdname" nowrap> <em>soap</em>, </td>
2316
<td class="md" nowrap align="right"></td>
2318
<td class="md" nowrap>const char * </td>
2319
<td class="mdname" nowrap> <em>id</em></td>
2323
<td class="md">) </td>
2324
<td class="md" colspan="2"></td>
2330
<table cellspacing=5 cellpadding=0 border=0>
2338
Returns UsernameToken element if present.
2340
<dl compact><dt><b>Parameters:</b></dt><dd>
2341
<table border="0" cellspacing="2" cellpadding="0">
2342
<tr><td></td><td valign=top><em>soap</em> </td><td>context </td></tr>
2343
<tr><td><tt>[in]</tt> </td><td valign=top><em>id</em> </td><td>string of UsernameToken or NULL </td></tr>
2346
<dl compact><dt><b>Returns:</b></dt><dd><a class="el" href="struct__wsse_____username_token.html">_wsse__UsernameToken</a> object or NULL</dd></dl>
2347
Note: this release supports the use of at most one UsernameToken in the header. </td>
2350
<a class="anchor" name="a63" doxytag="wsseapi.h::soap_wsse_verify_auto" ></a><p>
2351
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
2354
<table cellpadding="0" cellspacing="0" border="0">
2356
<td class="md" nowrap valign="top"> int soap_wsse_verify_auto </td>
2357
<td class="md" valign="top">( </td>
2358
<td class="md" nowrap valign="top">struct soap * </td>
2359
<td class="mdname" nowrap> <em>soap</em>, </td>
2362
<td class="md" nowrap align="right"></td>
2364
<td class="md" nowrap>int </td>
2365
<td class="mdname" nowrap> <em>alg</em>, </td>
2368
<td class="md" nowrap align="right"></td>
2370
<td class="md" nowrap>const void * </td>
2371
<td class="mdname" nowrap> <em>key</em>, </td>
2374
<td class="md" nowrap align="right"></td>
2376
<td class="md" nowrap>size_t </td>
2377
<td class="mdname" nowrap> <em>keylen</em></td>
2381
<td class="md">) </td>
2382
<td class="md" colspan="2"></td>
2388
<table cellspacing=5 cellpadding=0 border=0>
2396
Uses the wsse plugin to initiate the automatic verification of the signature and SignedInfo Reference digests.
2398
<dl compact><dt><b>Parameters:</b></dt><dd>
2399
<table border="0" cellspacing="2" cellpadding="0">
2400
<tr><td></td><td valign=top><em>soap</em> </td><td>context </td></tr>
2401
<tr><td><tt>[in]</tt> </td><td valign=top><em>alg</em> </td><td>to verify signature if signature has no secret or public key, use SOAP_SMD_NONE to omit </td></tr>
2402
<tr><td><tt>[in]</tt> </td><td valign=top><em>key</em> </td><td>is HMAC key or EVP_PKEY or NULL </td></tr>
2403
<tr><td><tt>[in]</tt> </td><td valign=top><em>keylen</em> </td><td>is HMAC key length or 0 </td></tr>
2406
<dl compact><dt><b>Returns:</b></dt><dd>SOAP_OK</dd></dl>
2407
This function does not actually verify the message, but initiates the plugin's algorithm to store the message in a DOM to automatically verify the signature and digests. If the message does not contain a key to verify the signature, the alg, key, and keylen parameters are used. It is important that the X509 certificate used to verify the signature, which requires soap->cafile and/or soap->capath to be set. </td>
2410
<a class="anchor" name="a44" doxytag="wsseapi.h::soap_wsse_verify_digest" ></a><p>
2411
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
2414
<table cellpadding="0" cellspacing="0" border="0">
2416
<td class="md" nowrap valign="top"> int soap_wsse_verify_digest </td>
2417
<td class="md" valign="top">( </td>
2418
<td class="md" nowrap valign="top">struct soap * </td>
2419
<td class="mdname" nowrap> <em>soap</em>, </td>
2422
<td class="md" nowrap align="right"></td>
2424
<td class="md" nowrap>int </td>
2425
<td class="mdname" nowrap> <em>alg</em>, </td>
2428
<td class="md" nowrap align="right"></td>
2430
<td class="md" nowrap>const char * </td>
2431
<td class="mdname" nowrap> <em>id</em>, </td>
2434
<td class="md" nowrap align="right"></td>
2436
<td class="md" nowrap>unsigned char </td>
2437
<td class="mdname" nowrap> <em>hash</em>[SOAP_SMD_MAX_SIZE]</td>
2441
<td class="md">) </td>
2442
<td class="md" colspan="2"></td>
2448
<table cellspacing=5 cellpadding=0 border=0>
2456
Verifies the digest value of an XML element referenced by id against the hash.
2458
<dl compact><dt><b>Parameters:</b></dt><dd>
2459
<table border="0" cellspacing="2" cellpadding="0">
2460
<tr><td></td><td valign=top><em>soap</em> </td><td>context </td></tr>
2461
<tr><td><tt>[in]</tt> </td><td valign=top><em>alg</em> </td><td>digest algorithm </td></tr>
2462
<tr><td><tt>[in]</tt> </td><td valign=top><em>id</em> </td><td>string of the XML element to verify </td></tr>
2463
<tr><td><tt>[in]</tt> </td><td valign=top><em>hash</em> </td><td>digest value to verify against </td></tr>
2466
<dl compact><dt><b>Returns:</b></dt><dd>SOAP_OK or fault </dd></dl>
2470
<a class="anchor" name="a64" doxytag="wsseapi.h::soap_wsse_verify_done" ></a><p>
2471
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
2474
<table cellpadding="0" cellspacing="0" border="0">
2476
<td class="md" nowrap valign="top"> int soap_wsse_verify_done </td>
2477
<td class="md" valign="top">( </td>
2478
<td class="md" nowrap valign="top">struct soap * </td>
2479
<td class="mdname1" valign="top" nowrap> <em>soap</em> </td>
2480
<td class="md" valign="top"> ) </td>
2481
<td class="md" nowrap></td>
2487
<table cellspacing=5 cellpadding=0 border=0>
2495
Terminates the automatic verification of signatures.
2497
<dl compact><dt><b>Parameters:</b></dt><dd>
2498
<table border="0" cellspacing="2" cellpadding="0">
2499
<tr><td></td><td valign=top><em>soap</em> </td><td>context </td></tr>
2502
<dl compact><dt><b>Returns:</b></dt><dd>SOAP_OK </dd></dl>
2506
<a class="anchor" name="a62" doxytag="wsseapi.h::soap_wsse_verify_init" ></a><p>
2507
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
2510
<table cellpadding="0" cellspacing="0" border="0">
2512
<td class="md" nowrap valign="top"> int soap_wsse_verify_init </td>
2513
<td class="md" valign="top">( </td>
2514
<td class="md" nowrap valign="top">struct soap * </td>
2515
<td class="mdname1" valign="top" nowrap> <em>soap</em> </td>
2516
<td class="md" valign="top"> ) </td>
2517
<td class="md" nowrap></td>
2523
<table cellspacing=5 cellpadding=0 border=0>
2531
Uses the wsse plugin to initiate the verification of the signature and SignedInfo Reference digests.
2533
<dl compact><dt><b>Parameters:</b></dt><dd>
2534
<table border="0" cellspacing="2" cellpadding="0">
2535
<tr><td></td><td valign=top><em>soap</em> </td><td>context </td></tr>
2538
<dl compact><dt><b>Returns:</b></dt><dd>SOAP_OK</dd></dl>
2539
This function does not actually verify the message, but initiates the plugin's data to store the message in a DOM to verify the signature. The signature and digests in the DOM must be verified manually. </td>
2542
<a class="anchor" name="a28" doxytag="wsseapi.h::soap_wsse_verify_Password" ></a><p>
2543
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
2546
<table cellpadding="0" cellspacing="0" border="0">
2548
<td class="md" nowrap valign="top"> int soap_wsse_verify_Password </td>
2549
<td class="md" valign="top">( </td>
2550
<td class="md" nowrap valign="top">struct soap * </td>
2551
<td class="mdname" nowrap> <em>soap</em>, </td>
2554
<td class="md" nowrap align="right"></td>
2556
<td class="md" nowrap>const char * </td>
2557
<td class="mdname" nowrap> <em>password</em></td>
2561
<td class="md">) </td>
2562
<td class="md" colspan="2"></td>
2568
<table cellspacing=5 cellpadding=0 border=0>
2576
Verifies the supplied password or sets wsse:FailedAuthentication fault.
2578
<dl compact><dt><b>Parameters:</b></dt><dd>
2579
<table border="0" cellspacing="2" cellpadding="0">
2580
<tr><td></td><td valign=top><em>soap</em> </td><td>context </td></tr>
2581
<tr><td><tt>[in]</tt> </td><td valign=top><em>password</em> </td><td>string to verify against </td></tr>
2584
<dl compact><dt><b>Returns:</b></dt><dd>SOAP_OK (authorized) or SOAP_FAULT with wsse:FailedAuthentication fault</dd></dl>
2585
The verification supports both clear-text password verification and digest password authentication. For digest authentication a history mechanism with a digest authentication session database ensures protection against replay attacks. Note: this release supports the use of at most one UsernameToken in the header. </td>
2588
<a class="anchor" name="a42" doxytag="wsseapi.h::soap_wsse_verify_SignatureValue" ></a><p>
2589
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
2592
<table cellpadding="0" cellspacing="0" border="0">
2594
<td class="md" nowrap valign="top"> int soap_wsse_verify_SignatureValue </td>
2595
<td class="md" valign="top">( </td>
2596
<td class="md" nowrap valign="top">struct soap * </td>
2597
<td class="mdname" nowrap> <em>soap</em>, </td>
2600
<td class="md" nowrap align="right"></td>
2602
<td class="md" nowrap>int </td>
2603
<td class="mdname" nowrap> <em>alg</em>, </td>
2606
<td class="md" nowrap align="right"></td>
2608
<td class="md" nowrap>const void * </td>
2609
<td class="mdname" nowrap> <em>key</em>, </td>
2612
<td class="md" nowrap align="right"></td>
2614
<td class="md" nowrap>int </td>
2615
<td class="mdname" nowrap> <em>keylen</em></td>
2619
<td class="md">) </td>
2620
<td class="md" colspan="2"></td>
2626
<table cellspacing=5 cellpadding=0 border=0>
2634
Verifies the SignatureValue of a SignedInfo element.
2636
<dl compact><dt><b>Parameters:</b></dt><dd>
2637
<table border="0" cellspacing="2" cellpadding="0">
2638
<tr><td></td><td valign=top><em>soap</em> </td><td>context </td></tr>
2639
<tr><td><tt>[in]</tt> </td><td valign=top><em>alg</em> </td><td>is SOAP_SMD_HMAC_SHA1, SOAP_SMD_VRFY_DSA_SHA1, or SOAP_SMD_VRFY_RSA_SHA1 determined by the SignedInfo/SignatureMethod </td></tr>
2640
<tr><td><tt>[in]</tt> </td><td valign=top><em>key</em> </td><td>to use to verify (HMAC or EVP_PKEY) </td></tr>
2641
<tr><td><tt>[in]</tt> </td><td valign=top><em>keylen</em> </td><td>length of HMAC key </td></tr>
2644
<dl compact><dt><b>Returns:</b></dt><dd>SOAP_OK, SOAP_EOM, or fault</dd></dl>
2645
This function searches for the SignedInfo element in the soap->dom DOM tree to verify the signature in the SignatureValue element. Using the DOM ensures we will verify the signature of a SignedInfo as it was exactly received by the parser, by using the -DWITH_DOM compile flag and SOAP_XML_DOM runtime flag. If there is no DOM, it verifies the signature of the deserialized SignedInfo element in the SOAP Header. However, serializing deserialized data may change the octet stream that was signed, unless we're using gSOAP as producers and consumers (with the SOAP_XML_INDENT flag reset). </td>
2648
<a class="anchor" name="a43" doxytag="wsseapi.h::soap_wsse_verify_SignedInfo" ></a><p>
2649
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
2652
<table cellpadding="0" cellspacing="0" border="0">
2654
<td class="md" nowrap valign="top"> int soap_wsse_verify_SignedInfo </td>
2655
<td class="md" valign="top">( </td>
2656
<td class="md" nowrap valign="top">struct soap * </td>
2657
<td class="mdname1" valign="top" nowrap> <em>soap</em> </td>
2658
<td class="md" valign="top"> ) </td>
2659
<td class="md" nowrap></td>
2665
<table cellspacing=5 cellpadding=0 border=0>
2673
Verifies the digest values of the XML elements referenced by the SignedInfo References.
2675
<dl compact><dt><b>Parameters:</b></dt><dd>
2676
<table border="0" cellspacing="2" cellpadding="0">
2677
<tr><td></td><td valign=top><em>soap</em> </td><td>context </td></tr>
2680
<dl compact><dt><b>Returns:</b></dt><dd>SOAP_OK or fault</dd></dl>
2681
This function searches for the SignedInfo element in the soap->dom DOM tree to verify the digests contained therein. Using the DOM ensures we will verify the digests of the locally signed elements as they were exactly received by the parser, by using the -DWITH_DOM compile flag and SOAP_XML_DOM runtime flag. If there is no DOM, the function fails. </td>
2684
<a class="anchor" name="a23" doxytag="wsseapi.h::soap_wsse_verify_Timestamp" ></a><p>
2685
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
2688
<table cellpadding="0" cellspacing="0" border="0">
2690
<td class="md" nowrap valign="top"> int soap_wsse_verify_Timestamp </td>
2691
<td class="md" valign="top">( </td>
2692
<td class="md" nowrap valign="top">struct soap * </td>
2693
<td class="mdname1" valign="top" nowrap> <em>soap</em> </td>
2694
<td class="md" valign="top"> ) </td>
2695
<td class="md" nowrap></td>
2701
<table cellspacing=5 cellpadding=0 border=0>
2709
Verifies the Timestamp/Expires element against the current time.
2711
<dl compact><dt><b>Parameters:</b></dt><dd>
2712
<table border="0" cellspacing="2" cellpadding="0">
2713
<tr><td></td><td valign=top><em>soap</em> </td><td>context </td></tr>
2716
<dl compact><dt><b>Returns:</b></dt><dd>SOAP_OK or SOAP_FAULT with wsse:FailedAuthentication fault</dd></dl>
2717
Sets wsse:FailedAuthentication fault if wsu:Timestamp is expired. The SOAP_WSSE_CLKSKEW value is used as a margin to mitigate clock skew. Keeps silent when no timestamp is supplied or no expiration date is included in the wsu:Timestamp element. </td>
2720
<a class="anchor" name="a35" doxytag="wsseapi.h::soap_wsse_verify_X509" ></a><p>
2721
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
2724
<table cellpadding="0" cellspacing="0" border="0">
2726
<td class="md" nowrap valign="top"> int soap_wsse_verify_X509 </td>
2727
<td class="md" valign="top">( </td>
2728
<td class="md" nowrap valign="top">struct soap * </td>
2729
<td class="mdname" nowrap> <em>soap</em>, </td>
2732
<td class="md" nowrap align="right"></td>
2734
<td class="md" nowrap>X509 * </td>
2735
<td class="mdname" nowrap> <em>cert</em></td>
2739
<td class="md">) </td>
2740
<td class="md" colspan="2"></td>
2746
<table cellspacing=5 cellpadding=0 border=0>
2754
Verifies X509 certificate against soap->cafile, soap->capath, and soap->crlfile.
2756
<dl compact><dt><b>Parameters:</b></dt><dd>
2757
<table border="0" cellspacing="2" cellpadding="0">
2758
<tr><td></td><td valign=top><em>soap</em> </td><td>context </td></tr>
2759
<tr><td><tt>[in]</tt> </td><td valign=top><em>cert</em> </td><td>X509 certificate </td></tr>
2762
<dl compact><dt><b>Returns:</b></dt><dd>SOAP_OK or fault</dd></dl>
2763
This is an expensive operation. Whenever a new soap context is created, the cafile and objects are loaded into that context each time we need to verify a certificate. </td>
2766
<hr><h2>Variable Documentation</h2>
2767
<a class="anchor" name="a12" doxytag="wsseapi.h::c14n_URI" ></a><p>
2768
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
2771
<table cellpadding="0" cellspacing="0" border="0">
2773
<td class="md" nowrap valign="top"> const char* <a class="el" href="wsseapi_8h.html#a12">c14n_URI</a> </td>
2779
<table cellspacing=5 cellpadding=0 border=0>
2790
<a class="anchor" name="a9" doxytag="wsseapi.h::ds_dsa_sha1URI" ></a><p>
2791
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
2794
<table cellpadding="0" cellspacing="0" border="0">
2796
<td class="md" nowrap valign="top"> const char* <a class="el" href="wsseapi_8h.html#a9">ds_dsa_sha1URI</a> </td>
2802
<table cellspacing=5 cellpadding=0 border=0>
2813
<a class="anchor" name="a8" doxytag="wsseapi.h::ds_hmac_sha1URI" ></a><p>
2814
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
2817
<table cellpadding="0" cellspacing="0" border="0">
2819
<td class="md" nowrap valign="top"> const char* <a class="el" href="wsseapi_8h.html#a8">ds_hmac_sha1URI</a> </td>
2825
<table cellspacing=5 cellpadding=0 border=0>
2836
<a class="anchor" name="a10" doxytag="wsseapi.h::ds_rsa_sha1URI" ></a><p>
2837
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
2840
<table cellpadding="0" cellspacing="0" border="0">
2842
<td class="md" nowrap valign="top"> const char* <a class="el" href="wsseapi_8h.html#a10">ds_rsa_sha1URI</a> </td>
2848
<table cellspacing=5 cellpadding=0 border=0>
2859
<a class="anchor" name="a7" doxytag="wsseapi.h::ds_sha1URI" ></a><p>
2860
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
2863
<table cellpadding="0" cellspacing="0" border="0">
2865
<td class="md" nowrap valign="top"> const char* <a class="el" href="wsseapi_8h.html#a7">ds_sha1URI</a> </td>
2871
<table cellspacing=5 cellpadding=0 border=0>
2882
<a class="anchor" name="a11" doxytag="wsseapi.h::ds_URI" ></a><p>
2883
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
2886
<table cellpadding="0" cellspacing="0" border="0">
2888
<td class="md" nowrap valign="top"> const char* <a class="el" href="wsseapi_8h.html#a11">ds_URI</a> </td>
2894
<table cellspacing=5 cellpadding=0 border=0>
2905
<a class="anchor" name="a1" doxytag="wsseapi.h::soap_wsse_id" ></a><p>
2906
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
2909
<table cellpadding="0" cellspacing="0" border="0">
2911
<td class="md" nowrap valign="top"> const char <a class="el" href="wsseapi_8h.html#a1">soap_wsse_id</a>[] </td>
2917
<table cellspacing=5 cellpadding=0 border=0>
2925
Plugin identification for plugin registry </td>
2928
<a class="anchor" name="a4" doxytag="wsseapi.h::wsse_Base64BinaryURI" ></a><p>
2929
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
2932
<table cellpadding="0" cellspacing="0" border="0">
2934
<td class="md" nowrap valign="top"> const char* <a class="el" href="wsseapi_8h.html#a4">wsse_Base64BinaryURI</a> </td>
2940
<table cellspacing=5 cellpadding=0 border=0>
2951
<a class="anchor" name="a3" doxytag="wsseapi.h::wsse_PasswordDigestURI" ></a><p>
2952
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
2955
<table cellpadding="0" cellspacing="0" border="0">
2957
<td class="md" nowrap valign="top"> const char* <a class="el" href="wsseapi_8h.html#a3">wsse_PasswordDigestURI</a> </td>
2963
<table cellspacing=5 cellpadding=0 border=0>
2974
<a class="anchor" name="a2" doxytag="wsseapi.h::wsse_PasswordTextURI" ></a><p>
2975
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
2978
<table cellpadding="0" cellspacing="0" border="0">
2980
<td class="md" nowrap valign="top"> const char* <a class="el" href="wsseapi_8h.html#a2">wsse_PasswordTextURI</a> </td>
2986
<table cellspacing=5 cellpadding=0 border=0>
2997
<a class="anchor" name="a6" doxytag="wsseapi.h::wsse_X509v3SubjectKeyIdentifierURI" ></a><p>
2998
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
3001
<table cellpadding="0" cellspacing="0" border="0">
3003
<td class="md" nowrap valign="top"> const char* <a class="el" href="wsseapi_8h.html#a6">wsse_X509v3SubjectKeyIdentifierURI</a> </td>
3009
<table cellspacing=5 cellpadding=0 border=0>
3020
<a class="anchor" name="a5" doxytag="wsseapi.h::wsse_X509v3URI" ></a><p>
3021
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
3024
<table cellpadding="0" cellspacing="0" border="0">
3026
<td class="md" nowrap valign="top"> const char* <a class="el" href="wsseapi_8h.html#a5">wsse_X509v3URI</a> </td>
3032
<table cellspacing=5 cellpadding=0 border=0>
3043
<a class="anchor" name="a13" doxytag="wsseapi.h::wsu_URI" ></a><p>
3044
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
3047
<table cellpadding="0" cellspacing="0" border="0">
3049
<td class="md" nowrap valign="top"> const char* <a class="el" href="wsseapi_8h.html#a13">wsu_URI</a> </td>
3055
<table cellspacing=5 cellpadding=0 border=0>
3066
<hr size="1"><address style="align: right;"><small>Generated on Fri Jun 30 22:21:01 2006 for gSOAP WS-Security by
3067
<a href="http://www.doxygen.org/index.html">
3068
<img src="doxygen.png" alt="doxygen" align="middle" border=0 ></a> 1.3.8 </small></address>