<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>LassoWsseUsernameToken: Lasso Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="Lasso Reference Manual">
<link rel="up" href="ws-addr.html" title="Object from the WS-* schemas">
<link rel="prev" href="lasso-LassoWsSec1TransformationParameters.html" title="LassoWsSec1TransformationParameters">
<link rel="next" href="lasso-LassoWsUtil1Timestamp.html" title="LassoWsUtil1Timestamp">
<meta name="generator" content="GTK-Doc V1.28 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#lasso-wsse-username-token.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ws-addr.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="lasso-LassoWsSec1TransformationParameters.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="lasso-LassoWsUtil1Timestamp.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="lasso-wsse-username-token"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="lasso-wsse-username-token.top_of_page"></a>LassoWsseUsernameToken</span></h2>
<p>LassoWsseUsernameToken</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="lasso-wsse-username-token.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="lasso-wsse-username-token.html#LassoWsseUsernameToken" title="struct LassoWsseUsernameToken"><span class="returnvalue">LassoWsseUsernameToken</span></a> *
</td>
<td class="function_name">
<a class="link" href="lasso-wsse-username-token.html#lasso-wsse-username-token-new" title="lasso_wsse_username_token_new ()">lasso_wsse_username_token_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="lasso-wsse-username-token.html#lasso-wsse-username-token-reset-nonce" title="lasso_wsse_username_token_reset_nonce ()">lasso_wsse_username_token_reset_nonce</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="lasso-wsse-username-token.html#lasso-wsse-username-token-set-password-kind" title="lasso_wsse_username_token_set_password_kind ()">lasso_wsse_username_token_set_password_kind</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">lasso_error_t</span>
</td>
<td class="function_name">
<a class="link" href="lasso-wsse-username-token.html#lasso-wsse-username-token-set-password" title="lasso_wsse_username_token_set_password ()">lasso_wsse_username_token_set_password</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">lasso_error_t</span>
</td>
<td class="function_name">
<a class="link" href="lasso-wsse-username-token.html#lasso-wsse-username-token-check-password" title="lasso_wsse_username_token_check_password ()">lasso_wsse_username_token_check_password</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">guchar</span> *
</td>
<td class="function_name">
<a class="link" href="lasso-wsse-username-token.html#lasso-wsse-username-token-derive-key" title="lasso_wsse_username_token_derive_key ()">lasso_wsse_username_token_derive_key</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="lasso-wsse-username-token.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="lasso-wsse-username-token.html#LassoWsseUsernameTokenPasswordType" title="enum LassoWsseUsernameTokenPasswordType">LassoWsseUsernameTokenPasswordType</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="lasso-wsse-username-token.html#LassoWsseUsernameToken" title="struct LassoWsseUsernameToken">LassoWsseUsernameToken</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="lasso-wsse-username-token.description"></a><h2>Description</h2>
<p>Transmit username and password credential as a WS-Security token. The password can be transmitted
as cleartext or using a digest mode. It also allows to derive encryption and HMAC signing keys.</p>
</div>
<div class="refsect1">
<a name="lasso-wsse-username-token.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="lasso-wsse-username-token-new"></a><h3>lasso_wsse_username_token_new ()</h3>
<pre class="programlisting"><a class="link" href="lasso-wsse-username-token.html#LassoWsseUsernameToken" title="struct LassoWsseUsernameToken"><span class="returnvalue">LassoWsseUsernameToken</span></a> *
lasso_wsse_username_token_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="lasso-wsse-username-token-reset-nonce"></a><h3>lasso_wsse_username_token_reset_nonce ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
lasso_wsse_username_token_reset_nonce (<em class="parameter"><code><a class="link" href="lasso-wsse-username-token.html#LassoWsseUsernameToken" title="struct LassoWsseUsernameToken"><span class="type">LassoWsseUsernameToken</span></a> *wsse_username_token</code></em>);</pre>
<p>Generate a random nonce.</p>
<div class="refsect3">
<a name="lasso-wsse-username-token-reset-nonce.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>wsse_username_token</p></td>
<td class="parameter_description"><p>a <a class="link" href="lasso-wsse-username-token.html#LassoWsseUsernameToken" title="struct LassoWsseUsernameToken"><span class="type">LassoWsseUsernameToken</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="lasso-wsse-username-token-set-password-kind"></a><h3>lasso_wsse_username_token_set_password_kind ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
lasso_wsse_username_token_set_password_kind
(<em class="parameter"><code><a class="link" href="lasso-wsse-username-token.html#LassoWsseUsernameToken" title="struct LassoWsseUsernameToken"><span class="type">LassoWsseUsernameToken</span></a> *wsse_username_token</code></em>,
<em class="parameter"><code><a class="link" href="lasso-wsse-username-token.html#LassoWsseUsernameTokenPasswordType" title="enum LassoWsseUsernameTokenPasswordType"><span class="type">LassoWsseUsernameTokenPasswordType</span></a> password_type</code></em>);</pre>
<p>Set the way to transmit password, that is either cleartext or digest.</p>
<div class="refsect3">
<a name="lasso-wsse-username-token-set-password-kind.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>wsse_username_token</p></td>
<td class="parameter_description"><p>a <a class="link" href="lasso-wsse-username-token.html#LassoWsseUsernameToken" title="struct LassoWsseUsernameToken"><span class="type">LassoWsseUsernameToken</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>password_type</p></td>
<td class="parameter_description"><p>a <a class="link" href="lasso-wsse-username-token.html#LassoWsseUsernameTokenPasswordType" title="enum LassoWsseUsernameTokenPasswordType"><span class="type">LassoWsseUsernameTokenPasswordType</span></a> enumeration</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="lasso-wsse-username-token-set-password"></a><h3>lasso_wsse_username_token_set_password ()</h3>
<pre class="programlisting"><span class="returnvalue">lasso_error_t</span>
lasso_wsse_username_token_set_password
(<em class="parameter"><code><a class="link" href="lasso-wsse-username-token.html#LassoWsseUsernameToken" title="struct LassoWsseUsernameToken"><span class="type">LassoWsseUsernameToken</span></a> *wsse_username_token</code></em>,
<em class="parameter"><code><span class="type">char</span> *password</code></em>);</pre>
<p>Set the password using the given UTF-8 string. If password kind is digest, compute the digest
SHA1(nonce + created + password), convert to Base64 and set it as the password. If nonce or
created are NULL, the empty string is used.</p>
<div class="refsect3">
<a name="lasso-wsse-username-token-set-password.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>wsse_username_token</p></td>
<td class="parameter_description"><p>a <a class="link" href="lasso-wsse-username-token.html#LassoWsseUsernameToken" title="struct LassoWsseUsernameToken"><span class="type">LassoWsseUsernameToken</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>password</p></td>
<td class="parameter_description"><p>an UTF-8 string</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="lasso-wsse-username-token-set-password.returns"></a><h4>Returns</h4>
<p> 0 if successfull, an error code otherwise.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="lasso-wsse-username-token-check-password"></a><h3>lasso_wsse_username_token_check_password ()</h3>
<pre class="programlisting"><span class="returnvalue">lasso_error_t</span>
lasso_wsse_username_token_check_password
(<em class="parameter"><code><a class="link" href="lasso-wsse-username-token.html#LassoWsseUsernameToken" title="struct LassoWsseUsernameToken"><span class="type">LassoWsseUsernameToken</span></a> *wsse_username_token</code></em>,
<em class="parameter"><code><span class="type">char</span> *password</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="lasso-wsse-username-token-derive-key"></a><h3>lasso_wsse_username_token_derive_key ()</h3>
<pre class="programlisting"><span class="returnvalue">guchar</span> *
lasso_wsse_username_token_derive_key (<em class="parameter"><code><a class="link" href="lasso-wsse-username-token.html#LassoWsseUsernameToken" title="struct LassoWsseUsernameToken"><span class="type">LassoWsseUsernameToken</span></a> *wsse_username_token</code></em>,
<em class="parameter"><code><span class="type">char</span> *password</code></em>);</pre>
<p>Generate a derived 128bit key using the password and setting from the UsernameToken.</p>
<div class="refsect3">
<a name="lasso-wsse-username-token-derive-key.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>wsse_username_token</p></td>
<td class="parameter_description"><p>a <a class="link" href="lasso-wsse-username-token.html#LassoWsseUsernameToken" title="struct LassoWsseUsernameToken"><span class="type">LassoWsseUsernameToken</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>password</p></td>
<td class="parameter_description"><p>the known password</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="lasso-wsse-username-token-derive-key.returns"></a><h4>Returns</h4>
<p> a 20 byte octet string.</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="lasso-wsse-username-token.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="LassoWsseUsernameTokenPasswordType"></a><h3>enum LassoWsseUsernameTokenPasswordType</h3>
<div class="refsect3">
<a name="LassoWsseUsernameTokenPasswordType.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="LASSO-WSSE-USERNAME-TOKEN-PASSWORD-TYPE-UNKNOWN:CAPS"></a>LASSO_WSSE_USERNAME_TOKEN_PASSWORD_TYPE_UNKNOWN</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="LASSO-WSSE-USERNAME-TOKEN-PASSWORD-TYPE-TEXT:CAPS"></a>LASSO_WSSE_USERNAME_TOKEN_PASSWORD_TYPE_TEXT</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="LASSO-WSSE-USERNAME-TOKEN-PASSWORD-TYPE-DIGEST:CAPS"></a>LASSO_WSSE_USERNAME_TOKEN_PASSWORD_TYPE_DIGEST</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="LASSO-WSSE-USERNAME-TOKEN-PASSWORD-TYPE-LAST:CAPS"></a>LASSO_WSSE_USERNAME_TOKEN_PASSWORD_TYPE_LAST</p></td>
<td> </td>
<td> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="LassoWsseUsernameToken"></a><h3>struct LassoWsseUsernameToken</h3>
<pre class="programlisting">struct LassoWsseUsernameToken {
LassoNode parent;
char *Id;
char *Username;
char *Nonce;
char *Salt;
char *Created;
int Iteration;
GHashTable *attributes;
};
</pre>
<div class="refsect3">
<a name="LassoWsseUsernameToken.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p><a class="link" href="lasso-node.html#LassoNode" title="struct LassoNode"><span class="type">LassoNode</span></a> <em class="structfield"><code><a name="LassoWsseUsernameToken.parent"></a>parent</code></em>;</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">char</span> *<em class="structfield"><code><a name="LassoWsseUsernameToken.Id"></a>Id</code></em>;</p></td>
<td class="struct_member_description"><p>the identifier of the UsernameToken</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">char</span> *<em class="structfield"><code><a name="LassoWsseUsernameToken.Username"></a>Username</code></em>;</p></td>
<td class="struct_member_description"><p>the username</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">char</span> *<em class="structfield"><code><a name="LassoWsseUsernameToken.Nonce"></a>Nonce</code></em>;</p></td>
<td class="struct_member_description"><p>a nonce used to compute the digest of the password</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">char</span> *<em class="structfield"><code><a name="LassoWsseUsernameToken.Salt"></a>Salt</code></em>;</p></td>
<td class="struct_member_description"><p>the salt for generating derived key</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">char</span> *<em class="structfield"><code><a name="LassoWsseUsernameToken.Created"></a>Created</code></em>;</p></td>
<td class="struct_member_description"><p>the timestamp for the generation of the token, also used in the digest of the password</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">int</span> <em class="structfield"><code><a name="LassoWsseUsernameToken.Iteration"></a>Iteration</code></em>;</p></td>
<td class="struct_member_description"><p>how many times to apply SHA1 for generating derivated key</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">GHashTable</span> *<em class="structfield"><code><a name="LassoWsseUsernameToken.attributes"></a>attributes</code></em>;</p></td>
<td> </td>
<td> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.28</div>
</body>
</html>