blob: 528ddba775fee6cf8a463575bb6468595ccd35aa [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Rampart/C: Signature</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.5 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>Signature<br>
<small>
[<a class="el" href="group__oxs.html">OMXMLSecurity</a>]</small>
</h1><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">AXIS2_EXTERN axis2_status_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__oxs__signature.html#g65444e4c24a81e022929e760d8eb17df">oxs_sig_sign_hmac_sha1</a> (const axutil_env_t *env, oxs_sign_ctx_t *sign_ctx, <a class="el" href="group__oxs__buffer.html#g0c4b78066ec1762a58cbec685dd60537">oxs_buffer_t</a> *input, <a class="el" href="group__oxs__buffer.html#g0c4b78066ec1762a58cbec685dd60537">oxs_buffer_t</a> *output)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">AXIS2_EXTERN axis2_status_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__oxs__signature.html#g206da339419ebb73cc9fbc912cf962fd">oxs_sig_sign_rsa_sha1</a> (const axutil_env_t *env, oxs_sign_ctx_t *sign_ctx, <a class="el" href="group__oxs__buffer.html#g0c4b78066ec1762a58cbec685dd60537">oxs_buffer_t</a> *input, <a class="el" href="group__oxs__buffer.html#g0c4b78066ec1762a58cbec685dd60537">oxs_buffer_t</a> *output)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">AXIS2_EXTERN axis2_status_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__oxs__signature.html#geca4f19f8a7f95d280830f673c3d3825">oxs_sig_sign</a> (const axutil_env_t *env, oxs_sign_ctx_t *sign_ctx, <a class="el" href="group__oxs__buffer.html#g0c4b78066ec1762a58cbec685dd60537">oxs_buffer_t</a> *input, <a class="el" href="group__oxs__buffer.html#g0c4b78066ec1762a58cbec685dd60537">oxs_buffer_t</a> *output)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">AXIS2_EXTERN axis2_status_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__oxs__signature.html#g3e0ab6136279af65b9715904f726eb08">oxs_sig_verify</a> (const axutil_env_t *env, oxs_sign_ctx_t *sign_ctx, axis2_char_t *content, axis2_char_t *signature)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">AXIS2_EXTERN axis2_status_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__oxs__signature.html#ga388ce3d92c07629410e3c6eb24aa6b3">oxs_sig_verify_hmac_sha1</a> (const axutil_env_t *env, oxs_sign_ctx_t *sign_ctx, axis2_char_t *content, axis2_char_t *signature)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">AXIS2_EXTERN axis2_status_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__oxs__signature.html#g3a364e177ec85cd45f7a961af490d7f5">oxs_sig_verify_rsa_sha1</a> (const axutil_env_t *env, oxs_sign_ctx_t *sign_ctx, axis2_char_t *content, axis2_char_t *signature)</td></tr>
</table>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="geca4f19f8a7f95d280830f673c3d3825"></a><!-- doxytag: member="oxs_signature.h::oxs_sig_sign" ref="geca4f19f8a7f95d280830f673c3d3825" args="(const axutil_env_t *env, oxs_sign_ctx_t *sign_ctx, oxs_buffer_t *input, oxs_buffer_t *output)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">AXIS2_EXTERN axis2_status_t oxs_sig_sign </td>
<td>(</td>
<td class="paramtype">const axutil_env_t *&nbsp;</td>
<td class="paramname"> <em>env</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">oxs_sign_ctx_t *&nbsp;</td>
<td class="paramname"> <em>sign_ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__oxs__buffer.html#g0c4b78066ec1762a58cbec685dd60537">oxs_buffer_t</a> *&nbsp;</td>
<td class="paramname"> <em>input</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__oxs__buffer.html#g0c4b78066ec1762a58cbec685dd60537">oxs_buffer_t</a> *&nbsp;</td>
<td class="paramname"> <em>output</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Signs a content placed in buf using the information available in the signature context . The result will be placed in the buffer . Note that the result is base64 encoded. pointer to environment struct the signature context input buffer output buffer <dl class="return" compact><dt><b>Returns:</b></dt><dd>AXIS2_SUCCESS on success, else AXIS2_FAILURE </dd></dl>
</div>
</div><p>
<a class="anchor" name="g65444e4c24a81e022929e760d8eb17df"></a><!-- doxytag: member="oxs_signature.h::oxs_sig_sign_hmac_sha1" ref="g65444e4c24a81e022929e760d8eb17df" args="(const axutil_env_t *env, oxs_sign_ctx_t *sign_ctx, oxs_buffer_t *input, oxs_buffer_t *output)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">AXIS2_EXTERN axis2_status_t oxs_sig_sign_hmac_sha1 </td>
<td>(</td>
<td class="paramtype">const axutil_env_t *&nbsp;</td>
<td class="paramname"> <em>env</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">oxs_sign_ctx_t *&nbsp;</td>
<td class="paramname"> <em>sign_ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__oxs__buffer.html#g0c4b78066ec1762a58cbec685dd60537">oxs_buffer_t</a> *&nbsp;</td>
<td class="paramname"> <em>input</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__oxs__buffer.html#g0c4b78066ec1762a58cbec685dd60537">oxs_buffer_t</a> *&nbsp;</td>
<td class="paramname"> <em>output</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Signs an input buffer using the HMAC-SHA1 algorithm. The secret will be taken form the signature context Result will be placed in output buffer pointer to environment struct the signature context input buffer output buffer <dl class="return" compact><dt><b>Returns:</b></dt><dd>AXIS2_SUCCESS on success, else AXIS2_FAILURE </dd></dl>
</div>
</div><p>
<a class="anchor" name="g206da339419ebb73cc9fbc912cf962fd"></a><!-- doxytag: member="oxs_signature.h::oxs_sig_sign_rsa_sha1" ref="g206da339419ebb73cc9fbc912cf962fd" args="(const axutil_env_t *env, oxs_sign_ctx_t *sign_ctx, oxs_buffer_t *input, oxs_buffer_t *output)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">AXIS2_EXTERN axis2_status_t oxs_sig_sign_rsa_sha1 </td>
<td>(</td>
<td class="paramtype">const axutil_env_t *&nbsp;</td>
<td class="paramname"> <em>env</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">oxs_sign_ctx_t *&nbsp;</td>
<td class="paramname"> <em>sign_ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__oxs__buffer.html#g0c4b78066ec1762a58cbec685dd60537">oxs_buffer_t</a> *&nbsp;</td>
<td class="paramname"> <em>input</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__oxs__buffer.html#g0c4b78066ec1762a58cbec685dd60537">oxs_buffer_t</a> *&nbsp;</td>
<td class="paramname"> <em>output</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Signs an input buffer using the RSA-SHA1 algorithm. Result will be placed in output buffer pointer to environment struct the signature context input buffer output buffer <dl class="return" compact><dt><b>Returns:</b></dt><dd>AXIS2_SUCCESS on success, else AXIS2_FAILURE </dd></dl>
</div>
</div><p>
<a class="anchor" name="g3e0ab6136279af65b9715904f726eb08"></a><!-- doxytag: member="oxs_signature.h::oxs_sig_verify" ref="g3e0ab6136279af65b9715904f726eb08" args="(const axutil_env_t *env, oxs_sign_ctx_t *sign_ctx, axis2_char_t *content, axis2_char_t *signature)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">AXIS2_EXTERN axis2_status_t oxs_sig_verify </td>
<td>(</td>
<td class="paramtype">const axutil_env_t *&nbsp;</td>
<td class="paramname"> <em>env</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">oxs_sign_ctx_t *&nbsp;</td>
<td class="paramname"> <em>sign_ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">axis2_char_t *&nbsp;</td>
<td class="paramname"> <em>content</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">axis2_char_t *&nbsp;</td>
<td class="paramname"> <em>signature</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Verifies a with using the information available in the signature content . Note that the signature should be the base64 encoded value of a digital signature. pointer to environment struct the signature context the content that's signed the signature value <dl class="return" compact><dt><b>Returns:</b></dt><dd>AXIS2_SUCCESS on success, else AXIS2_FAILURE </dd></dl>
</div>
</div><p>
<a class="anchor" name="ga388ce3d92c07629410e3c6eb24aa6b3"></a><!-- doxytag: member="oxs_signature.h::oxs_sig_verify_hmac_sha1" ref="ga388ce3d92c07629410e3c6eb24aa6b3" args="(const axutil_env_t *env, oxs_sign_ctx_t *sign_ctx, axis2_char_t *content, axis2_char_t *signature)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">AXIS2_EXTERN axis2_status_t oxs_sig_verify_hmac_sha1 </td>
<td>(</td>
<td class="paramtype">const axutil_env_t *&nbsp;</td>
<td class="paramname"> <em>env</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">oxs_sign_ctx_t *&nbsp;</td>
<td class="paramname"> <em>sign_ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">axis2_char_t *&nbsp;</td>
<td class="paramname"> <em>content</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">axis2_char_t *&nbsp;</td>
<td class="paramname"> <em>signature</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Verifies with using the information available in the signature content as per the HMA-SHA1 algorithm pointer to environment struct the signature context the content that's signed the signature value <dl class="return" compact><dt><b>Returns:</b></dt><dd>AXIS2_SUCCESS on success, else AXIS2_FAILURE </dd></dl>
</div>
</div><p>
<a class="anchor" name="g3a364e177ec85cd45f7a961af490d7f5"></a><!-- doxytag: member="oxs_signature.h::oxs_sig_verify_rsa_sha1" ref="g3a364e177ec85cd45f7a961af490d7f5" args="(const axutil_env_t *env, oxs_sign_ctx_t *sign_ctx, axis2_char_t *content, axis2_char_t *signature)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">AXIS2_EXTERN axis2_status_t oxs_sig_verify_rsa_sha1 </td>
<td>(</td>
<td class="paramtype">const axutil_env_t *&nbsp;</td>
<td class="paramname"> <em>env</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">oxs_sign_ctx_t *&nbsp;</td>
<td class="paramname"> <em>sign_ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">axis2_char_t *&nbsp;</td>
<td class="paramname"> <em>content</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">axis2_char_t *&nbsp;</td>
<td class="paramname"> <em>signature</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Verifies with using the information available in the signature content as per the RSA-SHA1 algorithm pointer to environment struct the signature context the content that's signed the signature value <dl class="return" compact><dt><b>Returns:</b></dt><dd>AXIS2_SUCCESS on success, else AXIS2_FAILURE </dd></dl>
</div>
</div><p>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed May 13 10:52:54 2009 for Rampart/C by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address>
</body>
</html>