blob: 140ac9c970545f49fbbc8df8019b95405aef1997 [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: Utility</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>Utility<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_char_t *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__oxs__utility.html#gfe4ad555c301794ead80dded2f066fb1">oxs_util_generate_nonce</a> (const axutil_env_t *env, int length)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">AXIS2_EXTERN axis2_char_t *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__oxs__utility.html#g9290295bce236eeeaff662b211ff5558">oxs_util_generate_id</a> (const axutil_env_t *env, axis2_char_t *prefix)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">AXIS2_EXTERN oxs_key_mgr_format_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__oxs__utility.html#g8e8730aa4aac71a5015fb2706eb45482">oxs_util_get_format_by_file_extension</a> (const axutil_env_t *env, axis2_char_t *file_name)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">AXIS2_EXTERN axis2_char_t *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__oxs__utility.html#gc1d56b4e608fd5e24874343d4a5edf5b">oxs_util_get_newline_removed_string</a> (const axutil_env_t *env, axis2_char_t *input)</td></tr>
</table>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="g9290295bce236eeeaff662b211ff5558"></a><!-- doxytag: member="oxs_utility.h::oxs_util_generate_id" ref="g9290295bce236eeeaff662b211ff5558" args="(const axutil_env_t *env, axis2_char_t *prefix)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">AXIS2_EXTERN axis2_char_t* oxs_util_generate_id </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">axis2_char_t *&nbsp;</td>
<td class="paramname"> <em>prefix</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>
Generates an id for an element. Specially used in xml encryption and signature references. Caller must free memory <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>env</em>&nbsp;</td><td>pointer to environment struct </td></tr>
<tr><td valign="top"></td><td valign="top"><em>prefix</em>&nbsp;</td><td>the prefix of the id. For ex: EncDataID-1u343yrcarwqe </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the generated id </dd></dl>
</div>
</div><p>
<a class="anchor" name="gfe4ad555c301794ead80dded2f066fb1"></a><!-- doxytag: member="oxs_utility.h::oxs_util_generate_nonce" ref="gfe4ad555c301794ead80dded2f066fb1" args="(const axutil_env_t *env, int length)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">AXIS2_EXTERN axis2_char_t* oxs_util_generate_nonce </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">int&nbsp;</td>
<td class="paramname"> <em>length</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>
Generate a nonce or a random text for a given length <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>env</em>&nbsp;</td><td>pointer to environment struct </td></tr>
<tr><td valign="top"></td><td valign="top"><em>length</em>&nbsp;</td><td>the length of the nonce </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the generated nonce </dd></dl>
</div>
</div><p>
<a class="anchor" name="g8e8730aa4aac71a5015fb2706eb45482"></a><!-- doxytag: member="oxs_utility.h::oxs_util_get_format_by_file_extension" ref="g8e8730aa4aac71a5015fb2706eb45482" args="(const axutil_env_t *env, axis2_char_t *file_name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">AXIS2_EXTERN oxs_key_mgr_format_t oxs_util_get_format_by_file_extension </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">axis2_char_t *&nbsp;</td>
<td class="paramname"> <em>file_name</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>
Given the filename returns the format of the file. These formats are defined in asym_ctx.h <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>env</em>&nbsp;</td><td>pointer to environment struct </td></tr>
<tr><td valign="top"></td><td valign="top"><em>file_name</em>&nbsp;</td><td>the file name </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="gc1d56b4e608fd5e24874343d4a5edf5b"></a><!-- doxytag: member="oxs_utility.h::oxs_util_get_newline_removed_string" ref="gc1d56b4e608fd5e24874343d4a5edf5b" args="(const axutil_env_t *env, axis2_char_t *input)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">AXIS2_EXTERN axis2_char_t* oxs_util_get_newline_removed_string </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">axis2_char_t *&nbsp;</td>
<td class="paramname"> <em>input</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>
Given string and returns new lined removed string Caller MUST free memory <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>env</em>&nbsp;</td><td>pointer to environment struct </td></tr>
<tr><td valign="top"></td><td valign="top"><em>input</em>&nbsp;</td><td>a pointer to the string which has <br>
s. return the newline removed buffer. </td></tr>
</table>
</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>