<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Apache Portable Runtime: apr_sha1.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.7.3 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Apache Portable Runtime</div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</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 id="searchli">
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#define-members">Defines</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<h1>apr_sha1.h File Reference</h1> </div>
</div>
<div class="contents">
<p>APR-UTIL SHA1 library.
<a href="#_details">More...</a></p>
<div class="textblock"><code>#include "apu.h"</code><br/>
<code>#include "<a class="el" href="apr__general_8h_source.html">apr_general.h</a>"</code><br/>
</div>
<p><a href="apr__sha1_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr><td class="memItemLeft" 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"><h2><a name="define-members"></a>
Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="apr__sha1_8h.html#af4ce94a96702e0d9fe96e1d861168af9">APR_SHA1_DIGESTSIZE</a>   20</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="apr__sha1_8h.html#afec390451cd4f502babb1f982a78690b">APR_SHA1PW_ID</a>   "{SHA}"</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="apr__sha1_8h.html#a6e6ab60388eea5f855f1613425f8e34c">APR_SHA1PW_IDLEN</a>   5</td></tr>
<tr><td colspan="2"><h2><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr><td class="memItemLeft" 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#a1acfd1f91495d6d22a188308b0b2d2b5">apr_sha1_ctx_t</a></td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="apr__sha1_8h.html#a38a5ac487992a24e941b7501273829e8">apr_sha1_base64</a> (const char *clear, int len, char *out)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="apr__sha1_8h.html#a79220a1d610128cca63a6c363ea27d01">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" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="apr__sha1_8h.html#ad85fb14e7e8d1c26e6591eb681b047b0">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" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="apr__sha1_8h.html#a3db65581e6cd2f029735c8689485b11a">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" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="apr__sha1_8h.html#a037d3697f6604bdaa2f46c0f381a2bba">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>
<div class="textblock"><p>APR-UTIL SHA1 library. </p>
</div><hr/><h2>Define Documentation</h2>
<a class="anchor" id="af4ce94a96702e0d9fe96e1d861168af9"></a><!-- doxytag: member="apr_sha1.h::APR_SHA1_DIGESTSIZE" ref="af4ce94a96702e0d9fe96e1d861168af9" 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 </p>
</div>
</div>
<a class="anchor" id="afec390451cd4f502babb1f982a78690b"></a><!-- doxytag: member="apr_sha1.h::APR_SHA1PW_ID" ref="afec390451cd4f502babb1f982a78690b" 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. </p>
</div>
</div>
<a class="anchor" id="a6e6ab60388eea5f855f1613425f8e34c"></a><!-- doxytag: member="apr_sha1.h::APR_SHA1PW_IDLEN" ref="a6e6ab60388eea5f855f1613425f8e34c" 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 </p>
</div>
</div>
<hr/><h2>Typedef Documentation</h2>
<a class="anchor" id="a1acfd1f91495d6d22a188308b0b2d2b5"></a><!-- doxytag: member="apr_sha1.h::apr_sha1_ctx_t" ref="a1acfd1f91495d6d22a188308b0b2d2b5" 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">
<dl class="see"><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>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="a38a5ac487992a24e941b7501273829e8"></a><!-- doxytag: member="apr_sha1.h::apr_sha1_base64" ref="a38a5ac487992a24e941b7501273829e8" 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>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></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. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">clear</td><td>The plaintext password </td></tr>
<tr><td class="paramname">len</td><td>The length of the plaintext password </td></tr>
<tr><td class="paramname">out</td><td>The encrypted/encoded password </td></tr>
</table>
</dd>
</dl>
<dl class="note"><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>
<a class="anchor" id="a037d3697f6604bdaa2f46c0f381a2bba"></a><!-- doxytag: member="apr_sha1.h::apr_sha1_final" ref="a037d3697f6604bdaa2f46c0f381a2bba" 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>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Finish computing the SHA digest </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">digest</td><td>the output buffer in which to store the digest </td></tr>
<tr><td class="paramname">context</td><td>The context to finalize </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a79220a1d610128cca63a6c363ea27d01"></a><!-- doxytag: member="apr_sha1.h::apr_sha1_init" ref="a79220a1d610128cca63a6c363ea27d01" 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></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Initialize the SHA digest </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">context</td><td>The SHA context to initialize </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ad85fb14e7e8d1c26e6591eb681b047b0"></a><!-- doxytag: member="apr_sha1.h::apr_sha1_update" ref="ad85fb14e7e8d1c26e6591eb681b047b0" 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>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Update the SHA digest </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">context</td><td>The SHA1 context to update </td></tr>
<tr><td class="paramname">input</td><td>The buffer to add to the SHA digest </td></tr>
<tr><td class="paramname">inputLen</td><td>The length of the input buffer </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a3db65581e6cd2f029735c8689485b11a"></a><!-- doxytag: member="apr_sha1.h::apr_sha1_update_binary" ref="a3db65581e6cd2f029735c8689485b11a" 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>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Update the SHA digest with binary data </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">context</td><td>The SHA1 context to update </td></tr>
<tr><td class="paramname">input</td><td>The buffer to add to the SHA digest </td></tr>
<tr><td class="paramname">inputLen</td><td>The length of the input buffer </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div>
<!--- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Defines</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Tue Feb 8 2011 for Apache Portable Runtime by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
</body>
</html>
