<!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 Source File</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 class="header">
<div class="headertitle">
<h1>apr_sha1.h</h1> </div>
</div>
<div class="contents">
<a href="apr__sha1_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* Licensed to the Apache Software Foundation (ASF) under one or more</span>
<a name="l00002"></a>00002 <span class="comment"> * contributor license agreements. See the NOTICE file distributed with</span>
<a name="l00003"></a>00003 <span class="comment"> * this work for additional information regarding copyright ownership.</span>
<a name="l00004"></a>00004 <span class="comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</span>
<a name="l00005"></a>00005 <span class="comment"> * (the "License"); you may not use this file except in compliance with</span>
<a name="l00006"></a>00006 <span class="comment"> * the License. You may obtain a copy of the License at</span>
<a name="l00007"></a>00007 <span class="comment"> *</span>
<a name="l00008"></a>00008 <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span>
<a name="l00009"></a>00009 <span class="comment"> *</span>
<a name="l00010"></a>00010 <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span>
<a name="l00011"></a>00011 <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span>
<a name="l00012"></a>00012 <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<a name="l00013"></a>00013 <span class="comment"> * See the License for the specific language governing permissions and</span>
<a name="l00014"></a>00014 <span class="comment"> * limitations under the License.</span>
<a name="l00015"></a>00015 <span class="comment"> */</span>
<a name="l00016"></a>00016 <span class="comment">/* NIST Secure Hash Algorithm</span>
<a name="l00017"></a>00017 <span class="comment"> * heavily modified by Uwe Hollerbach uh@alumni.caltech edu</span>
<a name="l00018"></a>00018 <span class="comment"> * from Peter C. Gutmann's implementation as found in</span>
<a name="l00019"></a>00019 <span class="comment"> * Applied Cryptography by Bruce Schneier</span>
<a name="l00020"></a>00020 <span class="comment"> * This code is hereby placed in the public domain</span>
<a name="l00021"></a>00021 <span class="comment"> */</span>
<a name="l00022"></a>00022
<a name="l00023"></a>00023 <span class="preprocessor">#ifndef APR_SHA1_H</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span><span class="preprocessor">#define APR_SHA1_H</span>
<a name="l00025"></a>00025 <span class="preprocessor"></span>
<a name="l00026"></a>00026 <span class="preprocessor">#include "apu.h"</span>
<a name="l00027"></a>00027 <span class="preprocessor">#include "<a class="code" href="apr__general_8h.html" title="APR Miscellaneous library routines.">apr_general.h</a>"</span>
<a name="l00028"></a>00028
<a name="l00029"></a>00029 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00030"></a>00030 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
<a name="l00031"></a>00031 <span class="preprocessor">#endif</span>
<a name="l00032"></a>00032 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00033"></a>00033 <span class="comment">/**</span>
<a name="l00034"></a>00034 <span class="comment"> * @file apr_sha1.h</span>
<a name="l00035"></a>00035 <span class="comment"> * @brief APR-UTIL SHA1 library</span>
<a name="l00036"></a>00036 <span class="comment"> */</span>
<a name="l00037"></a>00037 <span class="comment"></span>
<a name="l00038"></a>00038 <span class="comment">/** size of the SHA1 DIGEST */</span>
<a name="l00039"></a><a class="code" href="apr__sha1_8h.html#af4ce94a96702e0d9fe96e1d861168af9">00039</a> <span class="preprocessor">#define APR_SHA1_DIGESTSIZE 20</span>
<a name="l00040"></a>00040 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00041"></a>00041 <span class="comment">/**</span>
<a name="l00042"></a>00042 <span class="comment"> * Define the Magic String prefix that identifies a password as being</span>
<a name="l00043"></a>00043 <span class="comment"> * hashed using our algorithm.</span>
<a name="l00044"></a>00044 <span class="comment"> */</span>
<a name="l00045"></a><a class="code" href="apr__sha1_8h.html#afec390451cd4f502babb1f982a78690b">00045</a> <span class="preprocessor">#define APR_SHA1PW_ID "{SHA}"</span>
<a name="l00046"></a>00046 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00047"></a>00047 <span class="comment">/** length of the SHA Password */</span>
<a name="l00048"></a><a class="code" href="apr__sha1_8h.html#a6e6ab60388eea5f855f1613425f8e34c">00048</a> <span class="preprocessor">#define APR_SHA1PW_IDLEN 5</span>
<a name="l00049"></a>00049 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00050"></a>00050 <span class="comment">/** @see apr_sha1_ctx_t */</span>
<a name="l00051"></a><a class="code" href="apr__sha1_8h.html#a1acfd1f91495d6d22a188308b0b2d2b5">00051</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structapr__sha1__ctx__t.html">apr_sha1_ctx_t</a> <a class="code" href="structapr__sha1__ctx__t.html">apr_sha1_ctx_t</a>;
<a name="l00052"></a>00052 <span class="comment"></span>
<a name="l00053"></a>00053 <span class="comment">/** </span>
<a name="l00054"></a>00054 <span class="comment"> * SHA1 context structure</span>
<a name="l00055"></a>00055 <span class="comment"> */</span>
<a name="l00056"></a><a class="code" href="structapr__sha1__ctx__t.html">00056</a> <span class="keyword">struct </span><a class="code" href="structapr__sha1__ctx__t.html">apr_sha1_ctx_t</a> {<span class="comment"></span>
<a name="l00057"></a>00057 <span class="comment"> /** message digest */</span>
<a name="l00058"></a><a class="code" href="structapr__sha1__ctx__t.html#a152a127b59eb6e1cb686c2bbe00d51de">00058</a> apr_uint32_t <a class="code" href="structapr__sha1__ctx__t.html#a152a127b59eb6e1cb686c2bbe00d51de">digest</a>[5];<span class="comment"></span>
<a name="l00059"></a>00059 <span class="comment"> /** 64-bit bit counts */</span>
<a name="l00060"></a><a class="code" href="structapr__sha1__ctx__t.html#ab105efa48b9318a419525e0f6076f6d2">00060</a> apr_uint32_t <a class="code" href="structapr__sha1__ctx__t.html#ab105efa48b9318a419525e0f6076f6d2">count_lo</a>, count_hi;<span class="comment"></span>
<a name="l00061"></a>00061 <span class="comment"> /** SHA data buffer */</span>
<a name="l00062"></a><a class="code" href="structapr__sha1__ctx__t.html#af61fc6c30be244247e35e7c8b0b63407">00062</a> apr_uint32_t <a class="code" href="structapr__sha1__ctx__t.html#af61fc6c30be244247e35e7c8b0b63407">data</a>[16];<span class="comment"></span>
<a name="l00063"></a>00063 <span class="comment"> /** unprocessed amount in data */</span>
<a name="l00064"></a><a class="code" href="structapr__sha1__ctx__t.html#aaa8433058ac7a3b0649821cbab7de822">00064</a> <span class="keywordtype">int</span> <a class="code" href="structapr__sha1__ctx__t.html#aaa8433058ac7a3b0649821cbab7de822">local</a>;
<a name="l00065"></a>00065 };
<a name="l00066"></a>00066 <span class="comment"></span>
<a name="l00067"></a>00067 <span class="comment">/**</span>
<a name="l00068"></a>00068 <span class="comment"> * Provide a means to SHA1 crypt/encode a plaintext password in a way which</span>
<a name="l00069"></a>00069 <span class="comment"> * makes password file compatible with those commonly use in netscape web</span>
<a name="l00070"></a>00070 <span class="comment"> * and ldap installations.</span>
<a name="l00071"></a>00071 <span class="comment"> * @param clear The plaintext password</span>
<a name="l00072"></a>00072 <span class="comment"> * @param len The length of the plaintext password</span>
<a name="l00073"></a>00073 <span class="comment"> * @param out The encrypted/encoded password</span>
<a name="l00074"></a>00074 <span class="comment"> * @note SHA1 support is useful for migration purposes, but is less</span>
<a name="l00075"></a>00075 <span class="comment"> * secure than Apache's password format, since Apache's (MD5)</span>
<a name="l00076"></a>00076 <span class="comment"> * password format uses a random eight character salt to generate</span>
<a name="l00077"></a>00077 <span class="comment"> * one of many possible hashes for the same password. Netscape</span>
<a name="l00078"></a>00078 <span class="comment"> * uses plain SHA1 without a salt, so the same password</span>
<a name="l00079"></a>00079 <span class="comment"> * will always generate the same hash, making it easier</span>
<a name="l00080"></a>00080 <span class="comment"> * to break since the search space is smaller.</span>
<a name="l00081"></a>00081 <span class="comment"> */</span>
<a name="l00082"></a>00082 APU_DECLARE(<span class="keywordtype">void</span>) <a class="code" href="apr__sha1_8h.html#a38a5ac487992a24e941b7501273829e8">apr_sha1_base64</a>(const <span class="keywordtype">char</span> *clear, <span class="keywordtype">int</span> len, <span class="keywordtype">char</span> *out);
<a name="l00083"></a>00083 <span class="comment"></span>
<a name="l00084"></a>00084 <span class="comment">/**</span>
<a name="l00085"></a>00085 <span class="comment"> * Initialize the SHA digest</span>
<a name="l00086"></a>00086 <span class="comment"> * @param context The SHA context to initialize</span>
<a name="l00087"></a>00087 <span class="comment"> */</span>
<a name="l00088"></a>00088 APU_DECLARE(<span class="keywordtype">void</span>) <a class="code" href="apr__sha1_8h.html#a79220a1d610128cca63a6c363ea27d01">apr_sha1_init</a>(<a class="code" href="structapr__sha1__ctx__t.html">apr_sha1_ctx_t</a> *context);
<a name="l00089"></a>00089 <span class="comment"></span>
<a name="l00090"></a>00090 <span class="comment">/**</span>
<a name="l00091"></a>00091 <span class="comment"> * Update the SHA digest</span>
<a name="l00092"></a>00092 <span class="comment"> * @param context The SHA1 context to update</span>
<a name="l00093"></a>00093 <span class="comment"> * @param input The buffer to add to the SHA digest</span>
<a name="l00094"></a>00094 <span class="comment"> * @param inputLen The length of the input buffer</span>
<a name="l00095"></a>00095 <span class="comment"> */</span>
<a name="l00096"></a>00096 APU_DECLARE(<span class="keywordtype">void</span>) <a class="code" href="apr__sha1_8h.html#ad85fb14e7e8d1c26e6591eb681b047b0">apr_sha1_update</a>(<a class="code" href="structapr__sha1__ctx__t.html">apr_sha1_ctx_t</a> *context, const <span class="keywordtype">char</span> *input,
<a name="l00097"></a>00097 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> inputLen);
<a name="l00098"></a>00098 <span class="comment"></span>
<a name="l00099"></a>00099 <span class="comment">/**</span>
<a name="l00100"></a>00100 <span class="comment"> * Update the SHA digest with binary data</span>
<a name="l00101"></a>00101 <span class="comment"> * @param context The SHA1 context to update</span>
<a name="l00102"></a>00102 <span class="comment"> * @param input The buffer to add to the SHA digest</span>
<a name="l00103"></a>00103 <span class="comment"> * @param inputLen The length of the input buffer</span>
<a name="l00104"></a>00104 <span class="comment"> */</span>
<a name="l00105"></a>00105 APU_DECLARE(<span class="keywordtype">void</span>) <a class="code" href="apr__sha1_8h.html#a3db65581e6cd2f029735c8689485b11a">apr_sha1_update_binary</a>(<a class="code" href="structapr__sha1__ctx__t.html">apr_sha1_ctx_t</a> *context,
<a name="l00106"></a>00106 const <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *input,
<a name="l00107"></a>00107 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> inputLen);
<a name="l00108"></a>00108 <span class="comment"></span>
<a name="l00109"></a>00109 <span class="comment">/**</span>
<a name="l00110"></a>00110 <span class="comment"> * Finish computing the SHA digest</span>
<a name="l00111"></a>00111 <span class="comment"> * @param digest the output buffer in which to store the digest</span>
<a name="l00112"></a>00112 <span class="comment"> * @param context The context to finalize</span>
<a name="l00113"></a>00113 <span class="comment"> */</span>
<a name="l00114"></a>00114 APU_DECLARE(<span class="keywordtype">void</span>) <a class="code" href="apr__sha1_8h.html#a037d3697f6604bdaa2f46c0f381a2bba">apr_sha1_final</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> digest[<a class="code" href="apr__sha1_8h.html#af4ce94a96702e0d9fe96e1d861168af9">APR_SHA1_DIGESTSIZE</a>],
<a name="l00115"></a>00115 <a class="code" href="structapr__sha1__ctx__t.html">apr_sha1_ctx_t</a> *context);
<a name="l00116"></a>00116
<a name="l00117"></a>00117 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00118"></a>00118 <span class="preprocessor"></span>}
<a name="l00119"></a>00119 <span class="preprocessor">#endif</span>
<a name="l00120"></a>00120 <span class="preprocessor"></span>
<a name="l00121"></a>00121 <span class="preprocessor">#endif </span><span class="comment">/* APR_SHA1_H */</span>
</pre></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>
