<!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_md5.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_md5.h</h1> </div>
</div>
<div class="contents">
<a href="apr__md5_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> * This is work is derived from material Copyright RSA Data Security, Inc.</span>
<a name="l00003"></a>00003 <span class="comment"> *</span>
<a name="l00004"></a>00004 <span class="comment"> * The RSA copyright statement and Licence for that original material is</span>
<a name="l00005"></a>00005 <span class="comment"> * included below. This is followed by the Apache copyright statement and</span>
<a name="l00006"></a>00006 <span class="comment"> * licence for the modifications made to that material.</span>
<a name="l00007"></a>00007 <span class="comment"> */</span>
<a name="l00008"></a>00008
<a name="l00009"></a>00009 <span class="comment">/* Copyright (C) 1991-2, RSA Data Security, Inc. Created 1991. All</span>
<a name="l00010"></a>00010 <span class="comment"> rights reserved.</span>
<a name="l00011"></a>00011 <span class="comment"></span>
<a name="l00012"></a>00012 <span class="comment"> License to copy and use this software is granted provided that it</span>
<a name="l00013"></a>00013 <span class="comment"> is identified as the "RSA Data Security, Inc. MD5 Message-Digest</span>
<a name="l00014"></a>00014 <span class="comment"> Algorithm" in all material mentioning or referencing this software</span>
<a name="l00015"></a>00015 <span class="comment"> or this function.</span>
<a name="l00016"></a>00016 <span class="comment"></span>
<a name="l00017"></a>00017 <span class="comment"> License is also granted to make and use derivative works provided</span>
<a name="l00018"></a>00018 <span class="comment"> that such works are identified as "derived from the RSA Data</span>
<a name="l00019"></a>00019 <span class="comment"> Security, Inc. MD5 Message-Digest Algorithm" in all material</span>
<a name="l00020"></a>00020 <span class="comment"> mentioning or referencing the derived work.</span>
<a name="l00021"></a>00021 <span class="comment"></span>
<a name="l00022"></a>00022 <span class="comment"> RSA Data Security, Inc. makes no representations concerning either</span>
<a name="l00023"></a>00023 <span class="comment"> the merchantability of this software or the suitability of this</span>
<a name="l00024"></a>00024 <span class="comment"> software for any particular purpose. It is provided "as is"</span>
<a name="l00025"></a>00025 <span class="comment"> without express or implied warranty of any kind.</span>
<a name="l00026"></a>00026 <span class="comment"></span>
<a name="l00027"></a>00027 <span class="comment"> These notices must be retained in any copies of any part of this</span>
<a name="l00028"></a>00028 <span class="comment"> documentation and/or software.</span>
<a name="l00029"></a>00029 <span class="comment"> */</span>
<a name="l00030"></a>00030
<a name="l00031"></a>00031 <span class="comment">/* Licensed to the Apache Software Foundation (ASF) under one or more</span>
<a name="l00032"></a>00032 <span class="comment"> * contributor license agreements. See the NOTICE file distributed with</span>
<a name="l00033"></a>00033 <span class="comment"> * this work for additional information regarding copyright ownership.</span>
<a name="l00034"></a>00034 <span class="comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</span>
<a name="l00035"></a>00035 <span class="comment"> * (the "License"); you may not use this file except in compliance with</span>
<a name="l00036"></a>00036 <span class="comment"> * the License. You may obtain a copy of the License at</span>
<a name="l00037"></a>00037 <span class="comment"> *</span>
<a name="l00038"></a>00038 <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span>
<a name="l00039"></a>00039 <span class="comment"> *</span>
<a name="l00040"></a>00040 <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span>
<a name="l00041"></a>00041 <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span>
<a name="l00042"></a>00042 <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<a name="l00043"></a>00043 <span class="comment"> * See the License for the specific language governing permissions and</span>
<a name="l00044"></a>00044 <span class="comment"> * limitations under the License.</span>
<a name="l00045"></a>00045 <span class="comment"> */</span>
<a name="l00046"></a>00046
<a name="l00047"></a>00047 <span class="preprocessor">#ifndef APR_MD5_H</span>
<a name="l00048"></a>00048 <span class="preprocessor"></span><span class="preprocessor">#define APR_MD5_H</span>
<a name="l00049"></a>00049 <span class="preprocessor"></span>
<a name="l00050"></a>00050 <span class="preprocessor">#include "apu.h"</span>
<a name="l00051"></a>00051 <span class="preprocessor">#include "<a class="code" href="apr__xlate_8h.html" title="APR I18N translation library.">apr_xlate.h</a>"</span>
<a name="l00052"></a>00052
<a name="l00053"></a>00053 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00054"></a>00054 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
<a name="l00055"></a>00055 <span class="preprocessor">#endif</span>
<a name="l00056"></a>00056 <span class="preprocessor"></span><span class="comment">/**</span>
<a name="l00057"></a>00057 <span class="comment"> * @file apr_md5.h</span>
<a name="l00058"></a>00058 <span class="comment"> * @brief APR MD5 Routines</span>
<a name="l00059"></a>00059 <span class="comment"> */</span>
<a name="l00060"></a>00060 <span class="comment"></span>
<a name="l00061"></a>00061 <span class="comment">/**</span>
<a name="l00062"></a>00062 <span class="comment"> * @defgroup APR_MD5 MD5 Routines</span>
<a name="l00063"></a>00063 <span class="comment"> * @ingroup APR</span>
<a name="l00064"></a>00064 <span class="comment"> * @{</span>
<a name="l00065"></a>00065 <span class="comment"> */</span>
<a name="l00066"></a>00066 <span class="comment"></span>
<a name="l00067"></a>00067 <span class="comment">/** The MD5 digest size */</span>
<a name="l00068"></a><a class="code" href="group___a_p_r___m_d5.html#ga0bb65e74ccdddca6ef75e886084e52dc">00068</a> <span class="preprocessor">#define APR_MD5_DIGESTSIZE 16</span>
<a name="l00069"></a>00069 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00070"></a>00070 <span class="comment">/** @see apr_md5_ctx_t */</span>
<a name="l00071"></a><a class="code" href="group___a_p_r___m_d5.html#gacb4d6bf2cf0a29553a63273ff0a6fe69">00071</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structapr__md5__ctx__t.html">apr_md5_ctx_t</a> <a class="code" href="structapr__md5__ctx__t.html">apr_md5_ctx_t</a>;
<a name="l00072"></a>00072 <span class="comment"></span>
<a name="l00073"></a>00073 <span class="comment">/** MD5 context. */</span>
<a name="l00074"></a><a class="code" href="structapr__md5__ctx__t.html">00074</a> <span class="keyword">struct </span><a class="code" href="structapr__md5__ctx__t.html">apr_md5_ctx_t</a> {<span class="comment"></span>
<a name="l00075"></a>00075 <span class="comment"> /** state (ABCD) */</span>
<a name="l00076"></a><a class="code" href="structapr__md5__ctx__t.html#ab8acbc6cd7a3dcd16e66e64a7f5357b5">00076</a> apr_uint32_t <a class="code" href="structapr__md5__ctx__t.html#ab8acbc6cd7a3dcd16e66e64a7f5357b5">state</a>[4];<span class="comment"></span>
<a name="l00077"></a>00077 <span class="comment"> /** number of bits, modulo 2^64 (lsb first) */</span>
<a name="l00078"></a><a class="code" href="structapr__md5__ctx__t.html#a3234a76e68a4ef546026a9854f9ba6d0">00078</a> apr_uint32_t <a class="code" href="structapr__md5__ctx__t.html#a3234a76e68a4ef546026a9854f9ba6d0">count</a>[2];<span class="comment"></span>
<a name="l00079"></a>00079 <span class="comment"> /** input buffer */</span>
<a name="l00080"></a><a class="code" href="structapr__md5__ctx__t.html#aed43a8aefc65c8973dbae804c94ad1e3">00080</a> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> <a class="code" href="structapr__md5__ctx__t.html#aed43a8aefc65c8973dbae804c94ad1e3">buffer</a>[64];<span class="comment"></span>
<a name="l00081"></a>00081 <span class="comment"> /** translation handle </span>
<a name="l00082"></a>00082 <span class="comment"> * ignored if xlate is unsupported</span>
<a name="l00083"></a>00083 <span class="comment"> */</span>
<a name="l00084"></a><a class="code" href="structapr__md5__ctx__t.html#a391a62bc9e7fada71d03f786df4f49ba">00084</a> <a class="code" href="group___a_p_r___x_l_a_t_e.html#ga069dabbadc30e3a4157c38104a250e77">apr_xlate_t</a> *<a class="code" href="structapr__md5__ctx__t.html#a391a62bc9e7fada71d03f786df4f49ba">xlate</a>;
<a name="l00085"></a>00085 };
<a name="l00086"></a>00086 <span class="comment"></span>
<a name="l00087"></a>00087 <span class="comment">/**</span>
<a name="l00088"></a>00088 <span class="comment"> * MD5 Initialize. Begins an MD5 operation, writing a new context.</span>
<a name="l00089"></a>00089 <span class="comment"> * @param context The MD5 context to initialize.</span>
<a name="l00090"></a>00090 <span class="comment"> */</span>
<a name="l00091"></a>00091 APU_DECLARE(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group___a_p_r___m_d5.html#ga7a0502bfc466821beabe4876987fbcb5">apr_md5_init</a>(<a class="code" href="structapr__md5__ctx__t.html">apr_md5_ctx_t</a> *context);
<a name="l00092"></a>00092 <span class="comment"></span>
<a name="l00093"></a>00093 <span class="comment">/**</span>
<a name="l00094"></a>00094 <span class="comment"> * MD5 translation setup. Provides the APR translation handle to be used </span>
<a name="l00095"></a>00095 <span class="comment"> * for translating the content before calculating the digest.</span>
<a name="l00096"></a>00096 <span class="comment"> * @param context The MD5 content to set the translation for.</span>
<a name="l00097"></a>00097 <span class="comment"> * @param xlate The translation handle to use for this MD5 context </span>
<a name="l00098"></a>00098 <span class="comment"> */</span>
<a name="l00099"></a>00099 APU_DECLARE(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group___a_p_r___m_d5.html#gad80cbd97ca3197a237bbed006c033a57">apr_md5_set_xlate</a>(<a class="code" href="structapr__md5__ctx__t.html">apr_md5_ctx_t</a> *context,
<a name="l00100"></a>00100 <a class="code" href="group___a_p_r___x_l_a_t_e.html#ga069dabbadc30e3a4157c38104a250e77">apr_xlate_t</a> *xlate);
<a name="l00101"></a>00101 <span class="comment"></span>
<a name="l00102"></a>00102 <span class="comment">/**</span>
<a name="l00103"></a>00103 <span class="comment"> * MD5 block update operation. Continue an MD5 message-digest operation, </span>
<a name="l00104"></a>00104 <span class="comment"> * processing another message block, and updating the context.</span>
<a name="l00105"></a>00105 <span class="comment"> * @param context The MD5 content to update.</span>
<a name="l00106"></a>00106 <span class="comment"> * @param input next message block to update</span>
<a name="l00107"></a>00107 <span class="comment"> * @param inputLen The length of the next message block</span>
<a name="l00108"></a>00108 <span class="comment"> */</span>
<a name="l00109"></a>00109 APU_DECLARE(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group___a_p_r___m_d5.html#ga1ae4e5c171ae98953e716ac02f026ed2">apr_md5_update</a>(<a class="code" href="structapr__md5__ctx__t.html">apr_md5_ctx_t</a> *context,
<a name="l00110"></a>00110 const <span class="keywordtype">void</span> *input,
<a name="l00111"></a>00111 apr_size_t inputLen);
<a name="l00112"></a>00112 <span class="comment"></span>
<a name="l00113"></a>00113 <span class="comment">/**</span>
<a name="l00114"></a>00114 <span class="comment"> * MD5 finalization. Ends an MD5 message-digest operation, writing the </span>
<a name="l00115"></a>00115 <span class="comment"> * message digest and zeroing the context</span>
<a name="l00116"></a>00116 <span class="comment"> * @param digest The final MD5 digest</span>
<a name="l00117"></a>00117 <span class="comment"> * @param context The MD5 content we are finalizing.</span>
<a name="l00118"></a>00118 <span class="comment"> */</span>
<a name="l00119"></a>00119 APU_DECLARE(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group___a_p_r___m_d5.html#ga245fb83991257b096ebadd2b1b8cef62">apr_md5_final</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> digest[<a class="code" href="group___a_p_r___m_d5.html#ga0bb65e74ccdddca6ef75e886084e52dc">APR_MD5_DIGESTSIZE</a>],
<a name="l00120"></a>00120 <a class="code" href="structapr__md5__ctx__t.html">apr_md5_ctx_t</a> *context);
<a name="l00121"></a>00121 <span class="comment"></span>
<a name="l00122"></a>00122 <span class="comment">/**</span>
<a name="l00123"></a>00123 <span class="comment"> * MD5 in one step</span>
<a name="l00124"></a>00124 <span class="comment"> * @param digest The final MD5 digest</span>
<a name="l00125"></a>00125 <span class="comment"> * @param input The message block to use</span>
<a name="l00126"></a>00126 <span class="comment"> * @param inputLen The length of the message block</span>
<a name="l00127"></a>00127 <span class="comment"> */</span>
<a name="l00128"></a>00128 APU_DECLARE(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group___a_p_r___m_d5.html#gac98c04b75053ae04907ca325f46df955">apr_md5</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> digest[APR_MD5_DIGESTSIZE],
<a name="l00129"></a>00129 const <span class="keywordtype">void</span> *input,
<a name="l00130"></a>00130 apr_size_t inputLen);
<a name="l00131"></a>00131 <span class="comment"></span>
<a name="l00132"></a>00132 <span class="comment">/**</span>
<a name="l00133"></a>00133 <span class="comment"> * Encode a password using an MD5 algorithm</span>
<a name="l00134"></a>00134 <span class="comment"> * @param password The password to encode</span>
<a name="l00135"></a>00135 <span class="comment"> * @param salt The salt to use for the encoding</span>
<a name="l00136"></a>00136 <span class="comment"> * @param result The string to store the encoded password in</span>
<a name="l00137"></a>00137 <span class="comment"> * @param nbytes The size of the result buffer</span>
<a name="l00138"></a>00138 <span class="comment"> */</span>
<a name="l00139"></a>00139 APU_DECLARE(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group___a_p_r___m_d5.html#gaf902e64b62e4056c6dcc1594b2dca645">apr_md5_encode</a>(const <span class="keywordtype">char</span> *password, const <span class="keywordtype">char</span> *salt,
<a name="l00140"></a>00140 <span class="keywordtype">char</span> *result, apr_size_t nbytes);
<a name="l00141"></a>00141
<a name="l00142"></a>00142 <span class="comment"></span>
<a name="l00143"></a>00143 <span class="comment">/**</span>
<a name="l00144"></a>00144 <span class="comment"> * Validate hashes created by APR-supported algorithms: md5 and sha1.</span>
<a name="l00145"></a>00145 <span class="comment"> * hashes created by crypt are supported only on platforms that provide</span>
<a name="l00146"></a>00146 <span class="comment"> * crypt(3), so don't rely on that function unless you know that your</span>
<a name="l00147"></a>00147 <span class="comment"> * application will be run only on platforms that support it. On platforms</span>
<a name="l00148"></a>00148 <span class="comment"> * that don't support crypt(3), this falls back to a clear text string</span>
<a name="l00149"></a>00149 <span class="comment"> * comparison.</span>
<a name="l00150"></a>00150 <span class="comment"> * @param passwd The password to validate</span>
<a name="l00151"></a>00151 <span class="comment"> * @param hash The password to validate against</span>
<a name="l00152"></a>00152 <span class="comment"> */</span>
<a name="l00153"></a>00153 APU_DECLARE(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group___a_p_r___m_d5.html#ga9ea1aa7e468de57e603d6e1d1b1516f2">apr_password_validate</a>(const <span class="keywordtype">char</span> *passwd,
<a name="l00154"></a>00154 const <span class="keywordtype">char</span> *hash);
<a name="l00155"></a>00155
<a name="l00156"></a>00156 <span class="comment"></span>
<a name="l00157"></a>00157 <span class="comment">/** @} */</span>
<a name="l00158"></a>00158 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00159"></a>00159 <span class="preprocessor"></span>}
<a name="l00160"></a>00160 <span class="preprocessor">#endif</span>
<a name="l00161"></a>00161 <span class="preprocessor"></span>
<a name="l00162"></a>00162 <span class="preprocessor">#endif </span><span class="comment">/* !APR_MD5_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>
