<!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"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.5"/> <title>PolarSSL v1.3.8: gcm.h Source File</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">PolarSSL v1.3.8 </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.5 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="modules.html"><span>Modules</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> </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 id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="dir_6a9bbd12bf4e19a18c45e270f8fae3fd.html">include</a></li><li class="navelem"><a class="el" href="dir_04272d44da4745cf8b8bfc767d6c6523.html">polarssl</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="headertitle"> <div class="title">gcm.h</div> </div> </div><!--header--> <div class="contents"> <a href="gcm_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> </div> <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#ifndef POLARSSL_GCM_H</span></div> <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor"></span><span class="preprocessor">#define POLARSSL_GCM_H</span></div> <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#include "<a class="code" href="cipher_8h.html">cipher.h</a>"</span></div> <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div> <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#if defined(_MSC_VER) && !defined(EFIX64) && !defined(EFI32)</span></div> <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor"></span><span class="preprocessor">#include <basetsd.h></span></div> <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">typedef</span> UINT32 uint32_t;</div> <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">typedef</span> UINT64 uint64_t;</div> <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor">#else</span></div> <div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="preprocessor"></span><span class="preprocessor">#include <stdint.h></span></div> <div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="preprocessor">#endif</span></div> <div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="gcm_8h.html#a9ec162612f0f3a8b7e380c02ffc35867"> 40</a></span> <span class="preprocessor">#define GCM_ENCRYPT 1</span></div> <div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="gcm_8h.html#a65cecb8f0fb02b51814bfbbae65fdd9c"> 41</a></span> <span class="preprocessor"></span><span class="preprocessor">#define GCM_DECRYPT 0</span></div> <div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="gcm_8h.html#a489a0823c71a0855d61f649bd1c7f4b0"> 43</a></span> <span class="preprocessor">#define POLARSSL_ERR_GCM_AUTH_FAILED -0x0012 </span></div> <div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="gcm_8h.html#a5dccf47b81f81ee37869f170613e8a91"> 44</a></span> <span class="preprocessor">#define POLARSSL_ERR_GCM_BAD_INPUT -0x0014 </span></div> <div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="preprocessor">#ifdef __cplusplus</span></div> <div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div> <div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="preprocessor">#endif</span></div> <div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="structgcm__context.html"> 53</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span>{</div> <div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="structgcm__context.html#a79965b2636e2621a9673bf177d582b9a"> 54</a></span>  <a class="code" href="structcipher__context__t.html">cipher_context_t</a> <a class="code" href="structgcm__context.html#a79965b2636e2621a9673bf177d582b9a">cipher_ctx</a>;</div> <div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="structgcm__context.html#ad8d8763f708c0d6637b4836a0b4d2e64"> 55</a></span>  uint64_t HL[16]; </div> <div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="structgcm__context.html#a934c2a6dffb1763a50a2fa1dc5ca549f"> 56</a></span>  uint64_t HH[16]; </div> <div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="structgcm__context.html#a5a0d2cab13a86f13f604041c446d4845"> 57</a></span>  uint64_t <a class="code" href="structgcm__context.html#a5a0d2cab13a86f13f604041c446d4845">len</a>; </div> <div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="structgcm__context.html#a074ada6bd04ba63daedd5188cdcb7991"> 58</a></span>  uint64_t <a class="code" href="structgcm__context.html#a074ada6bd04ba63daedd5188cdcb7991">add_len</a>; </div> <div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="structgcm__context.html#a8c5e7f00c665595616a123b119e5f6f2"> 59</a></span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> base_ectr[16];</div> <div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="structgcm__context.html#aef9b8dc7a1c219de0550a09031662ecf"> 60</a></span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> y[16]; </div> <div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="structgcm__context.html#a8c2b92e4c44ca18ae7d50e2b886add0b"> 61</a></span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> buf[16]; </div> <div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="structgcm__context.html#aef8b995d4df128137da5c4e7f7211bc3"> 62</a></span>  <span class="keywordtype">int</span> <a class="code" href="structgcm__context.html#aef8b995d4df128137da5c4e7f7211bc3">mode</a>; </div> <div class="line"><a name="l00063"></a><span class="lineno"> 63</span> }</div> <div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <a class="code" href="structgcm__context.html">gcm_context</a>;</div> <div class="line"><a name="l00065"></a><span class="lineno"> 65</span> </div> <div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="keywordtype">int</span> <a class="code" href="gcm_8h.html#aa51998d315ab0c99cff40bbe7dd7f200">gcm_init</a>( <a class="code" href="structgcm__context.html">gcm_context</a> *ctx, <a class="code" href="cipher_8h.html#a373f5d3a0a42c77ff4f5fe4fe7da0560">cipher_id_t</a> cipher, <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *key,</div> <div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> keysize );</div> <div class="line"><a name="l00078"></a><span class="lineno"> 78</span> </div> <div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="keywordtype">int</span> <a class="code" href="gcm_8h.html#ad87f8fd2a45b5b32c545443779c48c2d">gcm_crypt_and_tag</a>( <a class="code" href="structgcm__context.html">gcm_context</a> *ctx,</div> <div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <span class="keywordtype">int</span> mode,</div> <div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <span class="keywordtype">size_t</span> length,</div> <div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *iv,</div> <div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="keywordtype">size_t</span> iv_len,</div> <div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *add,</div> <div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  <span class="keywordtype">size_t</span> add_len,</div> <div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *input,</div> <div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *output,</div> <div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <span class="keywordtype">size_t</span> tag_len,</div> <div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *tag );</div> <div class="line"><a name="l00112"></a><span class="lineno"> 112</span> </div> <div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="keywordtype">int</span> <a class="code" href="gcm_8h.html#a61dae452f29231fe46c1bacee4c60e72">gcm_auth_decrypt</a>( <a class="code" href="structgcm__context.html">gcm_context</a> *ctx,</div> <div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  <span class="keywordtype">size_t</span> length,</div> <div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *iv,</div> <div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  <span class="keywordtype">size_t</span> iv_len,</div> <div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *add,</div> <div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  <span class="keywordtype">size_t</span> add_len,</div> <div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *tag,</div> <div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  <span class="keywordtype">size_t</span> tag_len,</div> <div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *input,</div> <div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *output );</div> <div class="line"><a name="l00144"></a><span class="lineno"> 144</span> </div> <div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="keywordtype">int</span> <a class="code" href="gcm_8h.html#a44f5d26e87eda4ef3fd6ca33bdddc17a">gcm_starts</a>( <a class="code" href="structgcm__context.html">gcm_context</a> *ctx,</div> <div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  <span class="keywordtype">int</span> mode,</div> <div class="line"><a name="l00159"></a><span class="lineno"> 159</span>  <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *iv,</div> <div class="line"><a name="l00160"></a><span class="lineno"> 160</span>  <span class="keywordtype">size_t</span> iv_len,</div> <div class="line"><a name="l00161"></a><span class="lineno"> 161</span>  <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *add,</div> <div class="line"><a name="l00162"></a><span class="lineno"> 162</span>  <span class="keywordtype">size_t</span> add_len );</div> <div class="line"><a name="l00163"></a><span class="lineno"> 163</span> </div> <div class="line"><a name="l00181"></a><span class="lineno"> 181</span> <span class="keywordtype">int</span> <a class="code" href="gcm_8h.html#ac27c1ae819964e256ad31076bf8be0ac">gcm_update</a>( <a class="code" href="structgcm__context.html">gcm_context</a> *ctx,</div> <div class="line"><a name="l00182"></a><span class="lineno"> 182</span>  <span class="keywordtype">size_t</span> length,</div> <div class="line"><a name="l00183"></a><span class="lineno"> 183</span>  <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *input,</div> <div class="line"><a name="l00184"></a><span class="lineno"> 184</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *output );</div> <div class="line"><a name="l00185"></a><span class="lineno"> 185</span> </div> <div class="line"><a name="l00197"></a><span class="lineno"> 197</span> <span class="keywordtype">int</span> <a class="code" href="gcm_8h.html#a6544ce0fa5390ced146b041cfa8a4f88">gcm_finish</a>( <a class="code" href="structgcm__context.html">gcm_context</a> *ctx,</div> <div class="line"><a name="l00198"></a><span class="lineno"> 198</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *tag,</div> <div class="line"><a name="l00199"></a><span class="lineno"> 199</span>  <span class="keywordtype">size_t</span> tag_len );</div> <div class="line"><a name="l00200"></a><span class="lineno"> 200</span> </div> <div class="line"><a name="l00206"></a><span class="lineno"> 206</span> <span class="keywordtype">void</span> <a class="code" href="gcm_8h.html#a087a5c5e531806928a57f465447bc6f5">gcm_free</a>( <a class="code" href="structgcm__context.html">gcm_context</a> *ctx );</div> <div class="line"><a name="l00207"></a><span class="lineno"> 207</span> </div> <div class="line"><a name="l00213"></a><span class="lineno"> 213</span> <span class="keywordtype">int</span> <a class="code" href="gcm_8h.html#a63019d9ec7edd51b02793cdade88054a">gcm_self_test</a>( <span class="keywordtype">int</span> verbose );</div> <div class="line"><a name="l00214"></a><span class="lineno"> 214</span> </div> <div class="line"><a name="l00215"></a><span class="lineno"> 215</span> <span class="preprocessor">#ifdef __cplusplus</span></div> <div class="line"><a name="l00216"></a><span class="lineno"> 216</span> <span class="preprocessor"></span>}</div> <div class="line"><a name="l00217"></a><span class="lineno"> 217</span> <span class="preprocessor">#endif</span></div> <div class="line"><a name="l00218"></a><span class="lineno"> 218</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00219"></a><span class="lineno"> 219</span> <span class="preprocessor">#endif </span><span class="comment">/* gcm.h */</span><span class="preprocessor"></span></div> <div class="ttc" id="gcm_8h_html_a61dae452f29231fe46c1bacee4c60e72"><div class="ttname"><a href="gcm_8h.html#a61dae452f29231fe46c1bacee4c60e72">gcm_auth_decrypt</a></div><div class="ttdeci">int gcm_auth_decrypt(gcm_context *ctx, size_t length, const unsigned char *iv, size_t iv_len, const unsigned char *add, size_t add_len, const unsigned char *tag, size_t tag_len, const unsigned char *input, unsigned char *output)</div><div class="ttdoc">GCM buffer authenticated decryption using a block cipher. </div></div> <div class="ttc" id="structgcm__context_html_a5a0d2cab13a86f13f604041c446d4845"><div class="ttname"><a href="structgcm__context.html#a5a0d2cab13a86f13f604041c446d4845">gcm_context::len</a></div><div class="ttdeci">uint64_t len</div><div class="ttdef"><b>Definition:</b> <a href="gcm_8h_source.html#l00057">gcm.h:57</a></div></div> <div class="ttc" id="structcipher__context__t_html"><div class="ttname"><a href="structcipher__context__t.html">cipher_context_t</a></div><div class="ttdoc">Generic cipher context. </div><div class="ttdef"><b>Definition:</b> <a href="cipher_8h_source.html#l00258">cipher.h:258</a></div></div> <div class="ttc" id="gcm_8h_html_a63019d9ec7edd51b02793cdade88054a"><div class="ttname"><a href="gcm_8h.html#a63019d9ec7edd51b02793cdade88054a">gcm_self_test</a></div><div class="ttdeci">int gcm_self_test(int verbose)</div><div class="ttdoc">Checkup routine. </div></div> <div class="ttc" id="gcm_8h_html_ad87f8fd2a45b5b32c545443779c48c2d"><div class="ttname"><a href="gcm_8h.html#ad87f8fd2a45b5b32c545443779c48c2d">gcm_crypt_and_tag</a></div><div class="ttdeci">int gcm_crypt_and_tag(gcm_context *ctx, int mode, size_t length, const unsigned char *iv, size_t iv_len, const unsigned char *add, size_t add_len, const unsigned char *input, unsigned char *output, size_t tag_len, unsigned char *tag)</div><div class="ttdoc">GCM buffer encryption/decryption using a block cipher. </div></div> <div class="ttc" id="structgcm__context_html_aef8b995d4df128137da5c4e7f7211bc3"><div class="ttname"><a href="structgcm__context.html#aef8b995d4df128137da5c4e7f7211bc3">gcm_context::mode</a></div><div class="ttdeci">int mode</div><div class="ttdef"><b>Definition:</b> <a href="gcm_8h_source.html#l00062">gcm.h:62</a></div></div> <div class="ttc" id="structgcm__context_html"><div class="ttname"><a href="structgcm__context.html">gcm_context</a></div><div class="ttdoc">GCM context structure. </div><div class="ttdef"><b>Definition:</b> <a href="gcm_8h_source.html#l00053">gcm.h:53</a></div></div> <div class="ttc" id="gcm_8h_html_aa51998d315ab0c99cff40bbe7dd7f200"><div class="ttname"><a href="gcm_8h.html#aa51998d315ab0c99cff40bbe7dd7f200">gcm_init</a></div><div class="ttdeci">int gcm_init(gcm_context *ctx, cipher_id_t cipher, const unsigned char *key, unsigned int keysize)</div><div class="ttdoc">GCM initialization (encryption) </div></div> <div class="ttc" id="cipher_8h_html"><div class="ttname"><a href="cipher_8h.html">cipher.h</a></div><div class="ttdoc">Generic cipher wrapper. </div></div> <div class="ttc" id="cipher_8h_html_a373f5d3a0a42c77ff4f5fe4fe7da0560"><div class="ttname"><a href="cipher_8h.html#a373f5d3a0a42c77ff4f5fe4fe7da0560">cipher_id_t</a></div><div class="ttdeci">cipher_id_t</div><div class="ttdef"><b>Definition:</b> <a href="cipher_8h_source.html#l00071">cipher.h:71</a></div></div> <div class="ttc" id="gcm_8h_html_ac27c1ae819964e256ad31076bf8be0ac"><div class="ttname"><a href="gcm_8h.html#ac27c1ae819964e256ad31076bf8be0ac">gcm_update</a></div><div class="ttdeci">int gcm_update(gcm_context *ctx, size_t length, const unsigned char *input, unsigned char *output)</div><div class="ttdoc">Generic GCM update function. </div></div> <div class="ttc" id="gcm_8h_html_a087a5c5e531806928a57f465447bc6f5"><div class="ttname"><a href="gcm_8h.html#a087a5c5e531806928a57f465447bc6f5">gcm_free</a></div><div class="ttdeci">void gcm_free(gcm_context *ctx)</div><div class="ttdoc">Free a GCM context and underlying cipher sub-context. </div></div> <div class="ttc" id="gcm_8h_html_a44f5d26e87eda4ef3fd6ca33bdddc17a"><div class="ttname"><a href="gcm_8h.html#a44f5d26e87eda4ef3fd6ca33bdddc17a">gcm_starts</a></div><div class="ttdeci">int gcm_starts(gcm_context *ctx, int mode, const unsigned char *iv, size_t iv_len, const unsigned char *add, size_t add_len)</div><div class="ttdoc">Generic GCM stream start function. </div></div> <div class="ttc" id="gcm_8h_html_a6544ce0fa5390ced146b041cfa8a4f88"><div class="ttname"><a href="gcm_8h.html#a6544ce0fa5390ced146b041cfa8a4f88">gcm_finish</a></div><div class="ttdeci">int gcm_finish(gcm_context *ctx, unsigned char *tag, size_t tag_len)</div><div class="ttdoc">Generic GCM finalisation function. </div></div> <div class="ttc" id="structgcm__context_html_a79965b2636e2621a9673bf177d582b9a"><div class="ttname"><a href="structgcm__context.html#a79965b2636e2621a9673bf177d582b9a">gcm_context::cipher_ctx</a></div><div class="ttdeci">cipher_context_t cipher_ctx</div><div class="ttdef"><b>Definition:</b> <a href="gcm_8h_source.html#l00054">gcm.h:54</a></div></div> <div class="ttc" id="structgcm__context_html_a074ada6bd04ba63daedd5188cdcb7991"><div class="ttname"><a href="structgcm__context.html#a074ada6bd04ba63daedd5188cdcb7991">gcm_context::add_len</a></div><div class="ttdeci">uint64_t add_len</div><div class="ttdef"><b>Definition:</b> <a href="gcm_8h_source.html#l00058">gcm.h:58</a></div></div> </div><!-- fragment --></div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated on Thu Jul 31 2014 11:35:51 for PolarSSL v1.3.8 by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.5 </small></address> </body> </html>