<!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>PolarSSL: polarssl/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.4 --> <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">PolarSSL</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="annotated.html"><span>Classes</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>File Members</span></a></li> </ul> </div> </div> <div class="header"> <div class="summary"> <a href="#nested-classes">Classes</a> | <a href="#func-members">Functions</a> </div> <div class="headertitle"> <div class="title">polarssl/sha1.h File Reference</div> </div> </div> <div class="contents"> <p><a href="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> Classes</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structsha1__context.html">sha1_context</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">SHA-1 context structure. <a href="structsha1__context.html#details">More...</a><br/></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="sha1_8h.html#a1055bb44108c1e8d9692f3e3b8acd568">sha1_starts</a> (<a class="el" href="structsha1__context.html">sha1_context</a> *ctx)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">SHA-1 context setup. <a href="#a1055bb44108c1e8d9692f3e3b8acd568"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sha1_8h.html#a86f218b14cbc26d1abc52968356cb516">sha1_update</a> (<a class="el" href="structsha1__context.html">sha1_context</a> *ctx, const unsigned char *input, int ilen)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">SHA-1 process buffer. <a href="#a86f218b14cbc26d1abc52968356cb516"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sha1_8h.html#a83ee41b9375fb1cfaa52a98b86b92c58">sha1_finish</a> (<a class="el" href="structsha1__context.html">sha1_context</a> *ctx, unsigned char output[20])</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">SHA-1 final digest. <a href="#a83ee41b9375fb1cfaa52a98b86b92c58"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sha1_8h.html#adb2c9ead8e7b91c333f2b3bc264a4469">sha1</a> (const unsigned char *input, int ilen, unsigned char output[20])</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Output = SHA-1( input buffer ) <a href="#adb2c9ead8e7b91c333f2b3bc264a4469"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sha1_8h.html#a2b0a100878886e9145a49172794f7d28">sha1_file</a> (const char *path, unsigned char output[20])</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Output = SHA-1( file contents ) <a href="#a2b0a100878886e9145a49172794f7d28"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sha1_8h.html#a6c7ab0cbe82d72ef4d8c2b598573ebcd">sha1_hmac_starts</a> (<a class="el" href="structsha1__context.html">sha1_context</a> *ctx, const unsigned char *key, int keylen)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">SHA-1 HMAC context setup. <a href="#a6c7ab0cbe82d72ef4d8c2b598573ebcd"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sha1_8h.html#a2cc379af580ca3c6fa4c8191223bfa1a">sha1_hmac_update</a> (<a class="el" href="structsha1__context.html">sha1_context</a> *ctx, const unsigned char *input, int ilen)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">SHA-1 HMAC process buffer. <a href="#a2cc379af580ca3c6fa4c8191223bfa1a"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sha1_8h.html#a38679c6fef6af534896808974a98c884">sha1_hmac_finish</a> (<a class="el" href="structsha1__context.html">sha1_context</a> *ctx, unsigned char output[20])</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">SHA-1 HMAC final digest. <a href="#a38679c6fef6af534896808974a98c884"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sha1_8h.html#ae69d81f33e1ddb70e8e7b697d908cb74">sha1_hmac_reset</a> (<a class="el" href="structsha1__context.html">sha1_context</a> *ctx)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">SHA-1 HMAC context reset. <a href="#ae69d81f33e1ddb70e8e7b697d908cb74"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sha1_8h.html#ad4ba973d2b6d418dd688d11db915fad3">sha1_hmac</a> (const unsigned char *key, int keylen, const unsigned char *input, int ilen, unsigned char output[20])</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Output = HMAC-SHA-1( hmac key, input buffer ) <a href="#ad4ba973d2b6d418dd688d11db915fad3"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sha1_8h.html#a4f74b29e82caff3c6f73b4e13648effb">sha1_self_test</a> (int verbose)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Checkup routine. <a href="#a4f74b29e82caff3c6f73b4e13648effb"></a><br/></td></tr> </table> <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> <div class="textblock"><p>Copyright (C) 2006-2010, Brainspark B.V.</p> <p>This file is part of PolarSSL (<a href="http://www.polarssl.org">http://www.polarssl.org</a>) Lead Maintainer: Paul Bakker <polarssl_maintainer at polarssl.org></p> <p>All rights reserved.</p> <p>This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.</p> <p>This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.</p> <p>You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. </p> </div><hr/><h2>Function Documentation</h2> <a class="anchor" id="adb2c9ead8e7b91c333f2b3bc264a4469"></a><!-- doxytag: member="sha1.h::sha1" ref="adb2c9ead8e7b91c333f2b3bc264a4469" args="(const unsigned char *input, int ilen, unsigned char output[20])" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void sha1 </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">int </td> <td class="paramname"><em>ilen</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">unsigned char </td> <td class="paramname"><em>output</em>[20] </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>Output = SHA-1( input buffer ) </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">input</td><td>buffer holding the data </td></tr> <tr><td class="paramname">ilen</td><td>length of the input data </td></tr> <tr><td class="paramname">output</td><td>SHA-1 checksum result </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a2b0a100878886e9145a49172794f7d28"></a><!-- doxytag: member="sha1.h::sha1_file" ref="a2b0a100878886e9145a49172794f7d28" args="(const char *path, unsigned char output[20])" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int sha1_file </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"><em>path</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">unsigned char </td> <td class="paramname"><em>output</em>[20] </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>Output = SHA-1( file contents ) </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">path</td><td>input file name </td></tr> <tr><td class="paramname">output</td><td>SHA-1 checksum result</td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>0 if successful, 1 if fopen failed, or 2 if fread failed </dd></dl> </div> </div> <a class="anchor" id="a83ee41b9375fb1cfaa52a98b86b92c58"></a><!-- doxytag: member="sha1.h::sha1_finish" ref="a83ee41b9375fb1cfaa52a98b86b92c58" args="(sha1_context *ctx, unsigned char output[20])" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void sha1_finish </td> <td>(</td> <td class="paramtype"><a class="el" href="structsha1__context.html">sha1_context</a> * </td> <td class="paramname"><em>ctx</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">unsigned char </td> <td class="paramname"><em>output</em>[20] </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>SHA-1 final digest. </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">ctx</td><td>SHA-1 context </td></tr> <tr><td class="paramname">output</td><td>SHA-1 checksum result </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="ad4ba973d2b6d418dd688d11db915fad3"></a><!-- doxytag: member="sha1.h::sha1_hmac" ref="ad4ba973d2b6d418dd688d11db915fad3" args="(const unsigned char *key, int keylen, const unsigned char *input, int ilen, unsigned char output[20])" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void sha1_hmac </td> <td>(</td> <td class="paramtype">const unsigned char * </td> <td class="paramname"><em>key</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>keylen</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">int </td> <td class="paramname"><em>ilen</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">unsigned char </td> <td class="paramname"><em>output</em>[20] </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>Output = HMAC-SHA-1( hmac key, input buffer ) </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">key</td><td>HMAC secret key </td></tr> <tr><td class="paramname">keylen</td><td>length of the HMAC key </td></tr> <tr><td class="paramname">input</td><td>buffer holding the data </td></tr> <tr><td class="paramname">ilen</td><td>length of the input data </td></tr> <tr><td class="paramname">output</td><td>HMAC-SHA-1 result </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a38679c6fef6af534896808974a98c884"></a><!-- doxytag: member="sha1.h::sha1_hmac_finish" ref="a38679c6fef6af534896808974a98c884" args="(sha1_context *ctx, unsigned char output[20])" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void sha1_hmac_finish </td> <td>(</td> <td class="paramtype"><a class="el" href="structsha1__context.html">sha1_context</a> * </td> <td class="paramname"><em>ctx</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">unsigned char </td> <td class="paramname"><em>output</em>[20] </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>SHA-1 HMAC final digest. </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">ctx</td><td>HMAC context </td></tr> <tr><td class="paramname">output</td><td>SHA-1 HMAC checksum result </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="ae69d81f33e1ddb70e8e7b697d908cb74"></a><!-- doxytag: member="sha1.h::sha1_hmac_reset" ref="ae69d81f33e1ddb70e8e7b697d908cb74" args="(sha1_context *ctx)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void sha1_hmac_reset </td> <td>(</td> <td class="paramtype"><a class="el" href="structsha1__context.html">sha1_context</a> * </td> <td class="paramname"><em>ctx</em></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>SHA-1 HMAC context reset. </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">ctx</td><td>HMAC context to be reset </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a6c7ab0cbe82d72ef4d8c2b598573ebcd"></a><!-- doxytag: member="sha1.h::sha1_hmac_starts" ref="a6c7ab0cbe82d72ef4d8c2b598573ebcd" args="(sha1_context *ctx, const unsigned char *key, int keylen)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void sha1_hmac_starts </td> <td>(</td> <td class="paramtype"><a class="el" href="structsha1__context.html">sha1_context</a> * </td> <td class="paramname"><em>ctx</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const unsigned char * </td> <td class="paramname"><em>key</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>keylen</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>SHA-1 HMAC context setup. </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">ctx</td><td>HMAC context to be initialized </td></tr> <tr><td class="paramname">key</td><td>HMAC secret key </td></tr> <tr><td class="paramname">keylen</td><td>length of the HMAC key </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a2cc379af580ca3c6fa4c8191223bfa1a"></a><!-- doxytag: member="sha1.h::sha1_hmac_update" ref="a2cc379af580ca3c6fa4c8191223bfa1a" args="(sha1_context *ctx, const unsigned char *input, int ilen)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void sha1_hmac_update </td> <td>(</td> <td class="paramtype"><a class="el" href="structsha1__context.html">sha1_context</a> * </td> <td class="paramname"><em>ctx</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">int </td> <td class="paramname"><em>ilen</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>SHA-1 HMAC process buffer. </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">ctx</td><td>HMAC context </td></tr> <tr><td class="paramname">input</td><td>buffer holding the data </td></tr> <tr><td class="paramname">ilen</td><td>length of the input data </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a4f74b29e82caff3c6f73b4e13648effb"></a><!-- doxytag: member="sha1.h::sha1_self_test" ref="a4f74b29e82caff3c6f73b4e13648effb" args="(int verbose)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int sha1_self_test </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"><em>verbose</em></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Checkup routine. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>0 if successful, or 1 if the test failed </dd></dl> </div> </div> <a class="anchor" id="a1055bb44108c1e8d9692f3e3b8acd568"></a><!-- doxytag: member="sha1.h::sha1_starts" ref="a1055bb44108c1e8d9692f3e3b8acd568" args="(sha1_context *ctx)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void sha1_starts </td> <td>(</td> <td class="paramtype"><a class="el" href="structsha1__context.html">sha1_context</a> * </td> <td class="paramname"><em>ctx</em></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>SHA-1 context setup. </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">ctx</td><td>context to be initialized </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a86f218b14cbc26d1abc52968356cb516"></a><!-- doxytag: member="sha1.h::sha1_update" ref="a86f218b14cbc26d1abc52968356cb516" args="(sha1_context *ctx, const unsigned char *input, int ilen)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void sha1_update </td> <td>(</td> <td class="paramtype"><a class="el" href="structsha1__context.html">sha1_context</a> * </td> <td class="paramname"><em>ctx</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">int </td> <td class="paramname"><em>ilen</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>SHA-1 process buffer. </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">ctx</td><td>SHA-1 context </td></tr> <tr><td class="paramname">input</td><td>buffer holding the data </td></tr> <tr><td class="paramname">ilen</td><td>length of the input data </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>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Defines</a></div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="javascript:void(0)" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> <hr class="footer"/><address class="footer"><small>Generated on Mon May 16 2011 for PolarSSL by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address> </body> </html>