<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Apache Portable Runtime Utility Library: include/apr_sha1.h File Reference</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.4 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
</ul>
</div>
<h1>include/apr_sha1.h File Reference</h1>APR-UTIL SHA1 library. <a href="#_details">More...</a>
<p>
<code>#include "apu.h"</code><br>
<code>#include "apr_general.h"</code><br>
<p>
<a href="apr__sha1_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Data Structures</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structapr__sha1__ctx__t.html">apr_sha1_ctx_t</a></td></tr>
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="apr__sha1_8h.html#f4ce94a96702e0d9fe96e1d861168af9">APR_SHA1_DIGESTSIZE</a> 20</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="apr__sha1_8h.html#fec390451cd4f502babb1f982a78690b">APR_SHA1PW_ID</a> "{SHA}"</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="apr__sha1_8h.html#6e6ab60388eea5f855f1613425f8e34c">APR_SHA1PW_IDLEN</a> 5</td></tr>
<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef struct <a class="el" href="structapr__sha1__ctx__t.html">apr_sha1_ctx_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="apr__sha1_8h.html#1acfd1f91495d6d22a188308b0b2d2b5">apr_sha1_ctx_t</a></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="apr__sha1_8h.html#38a5ac487992a24e941b7501273829e8">apr_sha1_base64</a> (const char *clear, int len, char *out)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="apr__sha1_8h.html#79220a1d610128cca63a6c363ea27d01">apr_sha1_init</a> (<a class="el" href="structapr__sha1__ctx__t.html">apr_sha1_ctx_t</a> *context)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="apr__sha1_8h.html#d85fb14e7e8d1c26e6591eb681b047b0">apr_sha1_update</a> (<a class="el" href="structapr__sha1__ctx__t.html">apr_sha1_ctx_t</a> *context, const char *input, unsigned int inputLen)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="apr__sha1_8h.html#3db65581e6cd2f029735c8689485b11a">apr_sha1_update_binary</a> (<a class="el" href="structapr__sha1__ctx__t.html">apr_sha1_ctx_t</a> *context, const unsigned char *input, unsigned int inputLen)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="apr__sha1_8h.html#037d3697f6604bdaa2f46c0f381a2bba">apr_sha1_final</a> (unsigned char digest[APR_SHA1_DIGESTSIZE], <a class="el" href="structapr__sha1__ctx__t.html">apr_sha1_ctx_t</a> *context)</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
APR-UTIL SHA1 library.
<p>
<hr><h2>Define Documentation</h2>
<a class="anchor" name="f4ce94a96702e0d9fe96e1d861168af9"></a><!-- doxytag: member="apr_sha1.h::APR_SHA1_DIGESTSIZE" ref="f4ce94a96702e0d9fe96e1d861168af9" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define APR_SHA1_DIGESTSIZE 20 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
size of the SHA1 DIGEST
</div>
</div><p>
<a class="anchor" name="fec390451cd4f502babb1f982a78690b"></a><!-- doxytag: member="apr_sha1.h::APR_SHA1PW_ID" ref="fec390451cd4f502babb1f982a78690b" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define APR_SHA1PW_ID "{SHA}" </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Define the Magic String prefix that identifies a password as being hashed using our algorithm.
</div>
</div><p>
<a class="anchor" name="6e6ab60388eea5f855f1613425f8e34c"></a><!-- doxytag: member="apr_sha1.h::APR_SHA1PW_IDLEN" ref="6e6ab60388eea5f855f1613425f8e34c" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define APR_SHA1PW_IDLEN 5 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
length of the SHA Password
</div>
</div><p>
<hr><h2>Typedef Documentation</h2>
<a class="anchor" name="1acfd1f91495d6d22a188308b0b2d2b5"></a><!-- doxytag: member="apr_sha1.h::apr_sha1_ctx_t" ref="1acfd1f91495d6d22a188308b0b2d2b5" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structapr__sha1__ctx__t.html">apr_sha1_ctx_t</a> <a class="el" href="structapr__sha1__ctx__t.html">apr_sha1_ctx_t</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="structapr__sha1__ctx__t.html">apr_sha1_ctx_t</a> </dd></dl>
</div>
</div><p>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="38a5ac487992a24e941b7501273829e8"></a><!-- doxytag: member="apr_sha1.h::apr_sha1_base64" ref="38a5ac487992a24e941b7501273829e8" args="(const char *clear, int len, char *out)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void apr_sha1_base64 </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>clear</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>len</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>out</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Provide a means to SHA1 crypt/encode a plaintext password in a way which makes password file compatible with those commonly use in netscape web and ldap installations. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>clear</em> </td><td>The plaintext password </td></tr>
<tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>The length of the plaintext password </td></tr>
<tr><td valign="top"></td><td valign="top"><em>out</em> </td><td>The encrypted/encoded password </td></tr>
</table>
</dl>
<dl class="note" compact><dt><b>Note:</b></dt><dd>SHA1 support is useful for migration purposes, but is less secure than Apache's password format, since Apache's (MD5) password format uses a random eight character salt to generate one of many possible hashes for the same password. Netscape uses plain SHA1 without a salt, so the same password will always generate the same hash, making it easier to break since the search space is smaller. </dd></dl>
</div>
</div><p>
<a class="anchor" name="037d3697f6604bdaa2f46c0f381a2bba"></a><!-- doxytag: member="apr_sha1.h::apr_sha1_final" ref="037d3697f6604bdaa2f46c0f381a2bba" args="(unsigned char digest[APR_SHA1_DIGESTSIZE], apr_sha1_ctx_t *context)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void apr_sha1_final </td>
<td>(</td>
<td class="paramtype">unsigned char </td>
<td class="paramname"> <em>digest</em>[APR_SHA1_DIGESTSIZE], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structapr__sha1__ctx__t.html">apr_sha1_ctx_t</a> * </td>
<td class="paramname"> <em>context</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Finish computing the SHA digest <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>digest</em> </td><td>the output buffer in which to store the digest </td></tr>
<tr><td valign="top"></td><td valign="top"><em>context</em> </td><td>The context to finalize </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="79220a1d610128cca63a6c363ea27d01"></a><!-- doxytag: member="apr_sha1.h::apr_sha1_init" ref="79220a1d610128cca63a6c363ea27d01" args="(apr_sha1_ctx_t *context)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void apr_sha1_init </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structapr__sha1__ctx__t.html">apr_sha1_ctx_t</a> * </td>
<td class="paramname"> <em>context</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Initialize the SHA digest <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>context</em> </td><td>The SHA context to initialize </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="d85fb14e7e8d1c26e6591eb681b047b0"></a><!-- doxytag: member="apr_sha1.h::apr_sha1_update" ref="d85fb14e7e8d1c26e6591eb681b047b0" args="(apr_sha1_ctx_t *context, const char *input, unsigned int inputLen)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void apr_sha1_update </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structapr__sha1__ctx__t.html">apr_sha1_ctx_t</a> * </td>
<td class="paramname"> <em>context</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>input</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>inputLen</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Update the SHA digest <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>context</em> </td><td>The SHA1 context to update </td></tr>
<tr><td valign="top"></td><td valign="top"><em>input</em> </td><td>The buffer to add to the SHA digest </td></tr>
<tr><td valign="top"></td><td valign="top"><em>inputLen</em> </td><td>The length of the input buffer </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="3db65581e6cd2f029735c8689485b11a"></a><!-- doxytag: member="apr_sha1.h::apr_sha1_update_binary" ref="3db65581e6cd2f029735c8689485b11a" args="(apr_sha1_ctx_t *context, const unsigned char *input, unsigned int inputLen)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void apr_sha1_update_binary </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structapr__sha1__ctx__t.html">apr_sha1_ctx_t</a> * </td>
<td class="paramname"> <em>context</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const unsigned char * </td>
<td class="paramname"> <em>input</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>inputLen</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Update the SHA digest with binary data <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>context</em> </td><td>The SHA1 context to update </td></tr>
<tr><td valign="top"></td><td valign="top"><em>input</em> </td><td>The buffer to add to the SHA digest </td></tr>
<tr><td valign="top"></td><td valign="top"><em>inputLen</em> </td><td>The length of the input buffer </td></tr>
</table>
</dl>
</div>
</div><p>
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Jan 24 02:22:55 2008 for Apache Portable Runtime Utility Library by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.4 </small></address>
</body>
</html>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-release
>
by-pkgid
>
bdcd72668be70f58bf0aa7c2102b0734
>
files
>
87
