1<!-- HTML header for doxygen 1.8.10--> 2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 3<html xmlns="http://www.w3.org/1999/xhtml"> 4<head> 5<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> 6<meta http-equiv="X-UA-Compatible" content="IE=9"/> 7<meta name="generator" content="Doxygen 1.8.14"/> 8<title>Intel® Enhanced Privacy ID SDK: epid/member/tiny/math/sha256.h File Reference</title> 9<link href="tabs.css" rel="stylesheet" type="text/css"/> 10<script type="text/javascript" src="jquery.js"></script> 11<script type="text/javascript" src="dynsections.js"></script> 12<link href="navtree.css" rel="stylesheet" type="text/css"/> 13<script type="text/javascript" src="resize.js"></script> 14<script type="text/javascript" src="navtreedata.js"></script> 15<script type="text/javascript" src="navtree.js"></script> 16<script type="text/javascript"> 17/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ 18 $(document).ready(initResizable); 19/* @license-end */</script> 20<link href="doxygen.css" rel="stylesheet" type="text/css" /> 21<link href="epidstyle.css" rel="stylesheet" type="text/css"/> 22</head> 23<body> 24<div id="top"><!-- do not remove this div, it is closed by doxygen! --> 25<div id="titlearea"> 26<table cellspacing="0" cellpadding="0"> 27 <tbody> 28 <tr style="height: 56px;"> 29 <td id="projectalign" style="padding-left: 0.5em;"> 30 <div id="projectname"><a 31 onclick="storeLink('index.html')" 32 id="projectlink" 33 class="index.html" 34 href="index.html">Intel® Enhanced Privacy ID SDK</a> 35 <span id="projectnumber">6.0.1</span> 36</div> 37 </td> 38 </tr> 39 </tbody> 40</table> 41</div> 42<!-- end header part --> 43<!-- Generated by Doxygen 1.8.14 --> 44</div><!-- top --> 45<div id="side-nav" class="ui-resizable side-nav-resizable"> 46 <div id="nav-tree"> 47 <div id="nav-tree-contents"> 48 <div id="nav-sync" class="sync"></div> 49 </div> 50 </div> 51 <div id="splitbar" style="-moz-user-select:none;" 52 class="ui-resizable-handle"> 53 </div> 54</div> 55<script type="text/javascript"> 56/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ 57$(document).ready(function(){initNavTree('sha256_8h.html','');}); 58/* @license-end */ 59</script> 60<div id="doc-content"> 61<div class="header"> 62 <div class="summary"> 63<a href="#define-members">Macros</a> | 64<a href="#func-members">Functions</a> </div> 65 <div class="headertitle"> 66<div class="title">sha256.h File Reference</div> </div> 67</div><!--header--> 68<div class="contents"> 69 70<p>Interface to a SHA-256 implementation. 71<a href="#details">More...</a></p> 72<div class="textblock"><code>#include <stddef.h></code><br /> 73<code>#include <stdint.h></code><br /> 74</div><table class="memberdecls"> 75<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a> 76Macros</h2></td></tr> 77<tr class="memitem:a9c1fe69ad43d4ca74b84303a0ed64f2f"><td class="memItemLeft" align="right" valign="top"><a id="a9c1fe69ad43d4ca74b84303a0ed64f2f"></a> 78#define </td><td class="memItemRight" valign="bottom"><a class="el" href="sha256_8h.html#a9c1fe69ad43d4ca74b84303a0ed64f2f">SHA256_BLOCK_SIZE</a>   (64)</td></tr> 79<tr class="memdesc:a9c1fe69ad43d4ca74b84303a0ed64f2f"><td class="mdescLeft"> </td><td class="mdescRight">Block size. <br /></td></tr> 80<tr class="separator:a9c1fe69ad43d4ca74b84303a0ed64f2f"><td class="memSeparator" colspan="2"> </td></tr> 81<tr class="memitem:a81efbc0fc101b06a914f7ff9e2fbc0e9"><td class="memItemLeft" align="right" valign="top"><a id="a81efbc0fc101b06a914f7ff9e2fbc0e9"></a> 82#define </td><td class="memItemRight" valign="bottom"><a class="el" href="sha256_8h.html#a81efbc0fc101b06a914f7ff9e2fbc0e9">SHA256_DIGEST_SIZE</a>   (32)</td></tr> 83<tr class="memdesc:a81efbc0fc101b06a914f7ff9e2fbc0e9"><td class="mdescLeft"> </td><td class="mdescRight">Digest size. <br /></td></tr> 84<tr class="separator:a81efbc0fc101b06a914f7ff9e2fbc0e9"><td class="memSeparator" colspan="2"> </td></tr> 85<tr class="memitem:a0558ee82699b60132c23e0a049ab7a56"><td class="memItemLeft" align="right" valign="top"><a id="a0558ee82699b60132c23e0a049ab7a56"></a> 86#define </td><td class="memItemRight" valign="bottom"><a class="el" href="sha256_8h.html#a0558ee82699b60132c23e0a049ab7a56">SHA256_STATE_BLOCKS</a>   (<a class="el" href="sha256_8h.html#a81efbc0fc101b06a914f7ff9e2fbc0e9">SHA256_DIGEST_SIZE</a> / 4)</td></tr> 87<tr class="memdesc:a0558ee82699b60132c23e0a049ab7a56"><td class="mdescLeft"> </td><td class="mdescRight">Number of blocks in state. <br /></td></tr> 88<tr class="separator:a0558ee82699b60132c23e0a049ab7a56"><td class="memSeparator" colspan="2"> </td></tr> 89</table><table class="memberdecls"> 90<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> 91Functions</h2></td></tr> 92<tr class="memitem:a05aad282287c226a9ab8a2eb65d10d1b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sha256_8h.html#a05aad282287c226a9ab8a2eb65d10d1b">tc_sha256_init</a> (sha256_state *s)</td></tr> 93<tr class="memdesc:a05aad282287c226a9ab8a2eb65d10d1b"><td class="mdescLeft"> </td><td class="mdescRight">The SHA state. <a href="#a05aad282287c226a9ab8a2eb65d10d1b">More...</a><br /></td></tr> 94<tr class="separator:a05aad282287c226a9ab8a2eb65d10d1b"><td class="memSeparator" colspan="2"> </td></tr> 95<tr class="memitem:ab42ecba529c48040c34e70cee8d98096"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sha256_8h.html#ab42ecba529c48040c34e70cee8d98096">tc_sha256_update</a> (sha256_state *s, const uint8_t *data, size_t datalen)</td></tr> 96<tr class="memdesc:ab42ecba529c48040c34e70cee8d98096"><td class="mdescLeft"> </td><td class="mdescRight">SHA256 update procedure Hashes data_length bytes addressed by data into state s. <a href="#ab42ecba529c48040c34e70cee8d98096">More...</a><br /></td></tr> 97<tr class="separator:ab42ecba529c48040c34e70cee8d98096"><td class="memSeparator" colspan="2"> </td></tr> 98<tr class="memitem:a8013bed3e0b388ec654f991b45c00bbf"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sha256_8h.html#a8013bed3e0b388ec654f991b45c00bbf">tc_sha256_final</a> (uint8_t *digest, sha256_state *s)</td></tr> 99<tr class="memdesc:a8013bed3e0b388ec654f991b45c00bbf"><td class="mdescLeft"> </td><td class="mdescRight">SHA256 final procedure Inserts the completed hash computation into digest. <a href="#a8013bed3e0b388ec654f991b45c00bbf">More...</a><br /></td></tr> 100<tr class="separator:a8013bed3e0b388ec654f991b45c00bbf"><td class="memSeparator" colspan="2"> </td></tr> 101</table> 102<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> 103<div class="textblock"><p>Interface to a SHA-256 implementation. </p> 104<p>Overview: SHA-256 is a NIST approved cryptographic hashing algorithm specified in FIPS 180. A hash algorithm maps data of arbitrary size to data of fixed length.</p> 105<p>Security: SHA-256 provides 128 bits of security against collision attacks and 256 bits of security against pre-image attacks. SHA-256 does NOT behave like a random oracle, but it can be used as one if the string being hashed is prefix-free encoded before hashing.</p> 106<p>Usage: 1) call tc_sha256_init to initialize a struct tc_sha256_state_struct before hashing a new string.</p> 107<p>2) call tc_sha256_update to hash the next string segment; tc_sha256_update can be called as many times as needed to hash all of the segments of a string; the order is important.</p> 108<p>3) call tc_sha256_final to out put the digest from a hashing operation. </p> 109</div><h2 class="groupheader">Function Documentation</h2> 110<a id="a8013bed3e0b388ec654f991b45c00bbf"></a> 111<h2 class="memtitle"><span class="permalink"><a href="#a8013bed3e0b388ec654f991b45c00bbf">◆ </a></span>tc_sha256_final()</h2> 112 113<div class="memitem"> 114<div class="memproto"> 115 <table class="memname"> 116 <tr> 117 <td class="memname">void tc_sha256_final </td> 118 <td>(</td> 119 <td class="paramtype">uint8_t * </td> 120 <td class="paramname"><em>digest</em>, </td> 121 </tr> 122 <tr> 123 <td class="paramkey"></td> 124 <td></td> 125 <td class="paramtype">sha256_state * </td> 126 <td class="paramname"><em>s</em> </td> 127 </tr> 128 <tr> 129 <td></td> 130 <td>)</td> 131 <td></td><td></td> 132 </tr> 133 </table> 134</div><div class="memdoc"> 135 136<p>SHA256 final procedure Inserts the completed hash computation into digest. </p> 137<dl class="section return"><dt>Returns</dt><dd>returns 1 returns 0 if: s == NULL, s->iv == NULL, digest == NULL </dd></dl> 138<dl class="section note"><dt>Note</dt><dd>Assumes: s has been initialized by tc_sha256_init digest points to at least SHA256_DIGEST_SIZE bytes </dd></dl> 139<dl class="section warning"><dt>Warning</dt><dd>The state buffer 'leftover' is left in memory after processing If your application intends to have sensitive data in this buffer, remind to erase it after the data has been processed </dd></dl> 140<dl class="params"><dt>Parameters</dt><dd> 141 <table class="params"> 142 <tr><td class="paramname">digest</td><td>unsigned eight bit integer </td></tr> 143 <tr><td class="paramname">s</td><td>Sha256 state struct </td></tr> 144 </table> 145 </dd> 146</dl> 147 148</div> 149</div> 150<a id="a05aad282287c226a9ab8a2eb65d10d1b"></a> 151<h2 class="memtitle"><span class="permalink"><a href="#a05aad282287c226a9ab8a2eb65d10d1b">◆ </a></span>tc_sha256_init()</h2> 152 153<div class="memitem"> 154<div class="memproto"> 155 <table class="memname"> 156 <tr> 157 <td class="memname">void tc_sha256_init </td> 158 <td>(</td> 159 <td class="paramtype">sha256_state * </td> 160 <td class="paramname"><em>s</em></td><td>)</td> 161 <td></td> 162 </tr> 163 </table> 164</div><div class="memdoc"> 165 166<p>The SHA state. </p> 167<p>SHA256 initialization procedure Initializes s </p><dl class="params"><dt>Parameters</dt><dd> 168 <table class="params"> 169 <tr><td class="paramname">s</td><td>Sha256 state struct </td></tr> 170 </table> 171 </dd> 172</dl> 173 174</div> 175</div> 176<a id="ab42ecba529c48040c34e70cee8d98096"></a> 177<h2 class="memtitle"><span class="permalink"><a href="#ab42ecba529c48040c34e70cee8d98096">◆ </a></span>tc_sha256_update()</h2> 178 179<div class="memitem"> 180<div class="memproto"> 181 <table class="memname"> 182 <tr> 183 <td class="memname">void tc_sha256_update </td> 184 <td>(</td> 185 <td class="paramtype">sha256_state * </td> 186 <td class="paramname"><em>s</em>, </td> 187 </tr> 188 <tr> 189 <td class="paramkey"></td> 190 <td></td> 191 <td class="paramtype">const uint8_t * </td> 192 <td class="paramname"><em>data</em>, </td> 193 </tr> 194 <tr> 195 <td class="paramkey"></td> 196 <td></td> 197 <td class="paramtype">size_t </td> 198 <td class="paramname"><em>datalen</em> </td> 199 </tr> 200 <tr> 201 <td></td> 202 <td>)</td> 203 <td></td><td></td> 204 </tr> 205 </table> 206</div><div class="memdoc"> 207 208<p>SHA256 update procedure Hashes data_length bytes addressed by data into state s. </p> 209<dl class="section note"><dt>Note</dt><dd>Assumes s has been initialized by tc_sha256_init </dd></dl> 210<dl class="section warning"><dt>Warning</dt><dd>The state buffer 'leftover' is left in memory after processing If your application intends to have sensitive data in this buffer, remind to erase it after the data has been processed </dd></dl> 211<dl class="params"><dt>Parameters</dt><dd> 212 <table class="params"> 213 <tr><td class="paramname">s</td><td>Sha256 state struct </td></tr> 214 <tr><td class="paramname">data</td><td>message to hash </td></tr> 215 <tr><td class="paramname">datalen</td><td>length of message to hash </td></tr> 216 </table> 217 </dd> 218</dl> 219 220</div> 221</div> 222</div><!-- contents --> 223</div><!-- doc-content --> 224<!-- HTML footer for doxygen 1.8.10--> 225<!-- start footer part --> 226<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> 227 <ul> 228 <li class="navelem"><a class="el" href="dir_12b90d9c027aaf878a834df729679a56.html">epid</a></li><li class="navelem"><a class="el" href="dir_512d3e62841a8535b716ec4cf8b9e950.html">member</a></li><li class="navelem"><a class="el" href="dir_ea12d375fc1eb79df248c0adf953af4f.html">tiny</a></li><li class="navelem"><a class="el" href="dir_5f2fc2cf41db41de2b55e03ffa7a1d16.html">math</a></li><li class="navelem"><a class="el" href="sha256_8h.html">sha256.h</a></li> 229 <li class="footer"> 230 © 2016-2017 Intel Corporation 231 </li> 232 </ul> 233</div> 234</body> 235</html> 236