<!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.14"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>Crypto++: seal.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 id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">Crypto++  <span id="projectnumber">7.0</span> </div> <div id="projectbrief">Free C++ class library of cryptographic schemes</div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.14 --> <script type="text/javascript" src="menudata.js"></script> <script type="text/javascript" src="menu.js"></script> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(function() { initMenu('',false,false,'search.php','Search'); }); /* @license-end */</script> <div id="main-nav"></div> </div><!-- top --> <div class="header"> <div class="headertitle"> <div class="title">seal.h</div> </div> </div><!--header--> <div class="contents"> <a href="seal_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> <span class="comment">// seal.h - originally written and placed in the public domain by Wei Dai</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"></span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">/// \file seal.h</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">/// \brief Classes for SEAL stream cipher</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">/// \since Crypto++ 2.2</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"></span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#ifndef CRYPTOPP_SEAL_H</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#define CRYPTOPP_SEAL_H</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> </div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#include "<a class="code" href="strciphr_8h.html">strciphr.h</a>"</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#include "<a class="code" href="secblock_8h.html">secblock.h</a>"</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> </div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> NAMESPACE_BEGIN(<a class="code" href="namespace_crypto_p_p.html">CryptoPP</a>)</div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> </div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">/// \brief SEAL stream cipher information</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"></span><span class="comment">/// \tparam B Endianness of the stream cipher</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"></span><span class="comment">/// \since Crypto++ 2.2</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"></span><span class="keyword">template</span> <<span class="keyword">class</span> B = BigEndian></div><div class="line"><a name="l00019"></a><span class="lineno"><a class="line" href="struct_s_e_a_l___info.html"> 19</a></span> <span class="keyword">struct </span><a class="code" href="struct_s_e_a_l___info.html">SEAL_Info</a> : <span class="keyword">public</span> <a class="code" href="class_fixed_key_length.html">FixedKeyLength</a><20, SimpleKeyingInterface::INTERNALLY_GENERATED_IV, 4></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> {</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  CRYPTOPP_STATIC_CONSTEXPR <span class="keyword">const</span> <span class="keywordtype">char</span>* StaticAlgorithmName() {<span class="keywordflow">return</span> B::ToEnum() == <a class="code" href="cryptlib_8h.html#aaeb92d42f5a6e27b8ba19f18d69d142baccd5b3585bd07d6bdae383aa8271b9d2">LITTLE_ENDIAN_ORDER</a> ? <span class="stringliteral">"SEAL-3.0-LE"</span> : <span class="stringliteral">"SEAL-3.0-BE"</span>;}</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> };</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"></span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment">/// \brief SEAL stream cipher operation</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment">/// \tparam B Endianness of the stream cipher</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment">/// \since Crypto++ 2.2</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"></span><span class="keyword">template</span> <<span class="keyword">class</span> B = BigEndian></div><div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="class_s_e_a_l___policy.html"> 28</a></span> <span class="keyword">class </span>CRYPTOPP_NO_VTABLE <a class="code" href="class_s_e_a_l___policy.html">SEAL_Policy</a> : <span class="keyword">public</span> <a class="code" href="struct_additive_cipher_concrete_policy.html">AdditiveCipherConcretePolicy</a><word32, 256>, <span class="keyword">public</span> <a class="code" href="struct_s_e_a_l___info.html">SEAL_Info</a><B></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> {</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">protected</span>:</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <span class="keywordtype">void</span> CipherSetKey(<span class="keyword">const</span> <a class="code" href="class_name_value_pairs.html">NameValuePairs</a> &params, <span class="keyword">const</span> byte *key, <span class="keywordtype">size_t</span> length);</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <span class="keywordtype">void</span> <a class="code" href="struct_additive_cipher_concrete_policy.html#a88ce0905757bcc373f028bfd9e0dec43">OperateKeystream</a>(<a class="code" href="strciphr_8h.html#ab4a226527d2bd01ff19bfa14d0974227">KeystreamOperation</a> operation, byte *output, <span class="keyword">const</span> byte *input, <span class="keywordtype">size_t</span> iterationCount);</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="keywordtype">void</span> CipherResynchronize(byte *keystreamBuffer, <span class="keyword">const</span> byte *<a class="code" href="namespace_name.html#a9b6839240a8bdf1f5bcbebf1866f4733">IV</a>, <span class="keywordtype">size_t</span> length);</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="keywordtype">bool</span> CipherIsRandomAccess()<span class="keyword"> const </span>{<span class="keywordflow">return</span> <span class="keyword">true</span>;}</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="keywordtype">void</span> SeekToIteration(lword iterationCount);</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <a class="code" href="class_fixed_size_sec_block.html">FixedSizeSecBlock<word32, 512></a> m_T;</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <a class="code" href="class_fixed_size_sec_block.html">FixedSizeSecBlock<word32, 256></a> m_S;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <a class="code" href="class_sec_block.html">SecBlock<word32></a> m_R;</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  word32 m_startCount, m_iterationsPerCount;</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  word32 m_outsideCounter, m_insideCounter;</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> };</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"></span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment">/// \brief SEAL stream cipher</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment">/// \tparam B Endianness of the stream cipher</span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment">/// \sa <a href="http://www.cryptopp.com/wiki/SEAL-3.0-BE">SEAL</a></span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment">/// \since Crypto++ 2.2</span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"></span><span class="keyword">template</span> <<span class="keyword">class</span> B = BigEndian></div><div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="struct_s_e_a_l.html"> 51</a></span> <span class="keyword">struct </span><a class="code" href="struct_s_e_a_l.html">SEAL</a> : <span class="keyword">public</span> <a class="code" href="struct_s_e_a_l___info.html">SEAL_Info</a><B>, <span class="keyword">public</span> <a class="code" href="struct_symmetric_cipher_documentation.html">SymmetricCipherDocumentation</a></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> {</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keyword">typedef</span> <a class="code" href="class_symmetric_cipher_final.html">SymmetricCipherFinal<ConcretePolicyHolder<SEAL_Policy<B></a>, <a class="code" href="class_additive_cipher_template.html">AdditiveCipherTemplate<></a> >, <a class="code" href="struct_s_e_a_l___info.html">SEAL_Info<B></a> > <a class="code" href="class_symmetric_cipher_final.html">Encryption</a>;</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keyword">typedef</span> <a class="code" href="class_symmetric_cipher_final.html">Encryption</a> <a class="code" href="class_symmetric_cipher_final.html">Decryption</a>;</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> };</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> NAMESPACE_END</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="class_s_e_a_l___policy_html"><div class="ttname"><a href="class_s_e_a_l___policy.html">SEAL_Policy</a></div><div class="ttdoc">SEAL stream cipher operation. </div><div class="ttdef"><b>Definition:</b> <a href="seal_8h_source.html#l00028">seal.h:28</a></div></div> <div class="ttc" id="class_fixed_key_length_html"><div class="ttname"><a href="class_fixed_key_length.html">FixedKeyLength</a></div><div class="ttdoc">Inherited by keyed algorithms with fixed key length. </div><div class="ttdef"><b>Definition:</b> <a href="seckey_8h_source.html#l00147">seckey.h:147</a></div></div> <div class="ttc" id="struct_additive_cipher_concrete_policy_html"><div class="ttname"><a href="struct_additive_cipher_concrete_policy.html">AdditiveCipherConcretePolicy</a></div><div class="ttdoc">Base class for additive stream ciphers. </div><div class="ttdef"><b>Definition:</b> <a href="strciphr_8h_source.html#l00181">strciphr.h:181</a></div></div> <div class="ttc" id="class_sec_block_html"><div class="ttname"><a href="class_sec_block.html">SecBlock< word32 ></a></div></div> <div class="ttc" id="cryptlib_8h_html_aaeb92d42f5a6e27b8ba19f18d69d142baccd5b3585bd07d6bdae383aa8271b9d2"><div class="ttname"><a href="cryptlib_8h.html#aaeb92d42f5a6e27b8ba19f18d69d142baccd5b3585bd07d6bdae383aa8271b9d2">LITTLE_ENDIAN_ORDER</a></div><div class="ttdoc">byte order is little-endian </div><div class="ttdef"><b>Definition:</b> <a href="cryptlib_8h_source.html#l00142">cryptlib.h:142</a></div></div> <div class="ttc" id="secblock_8h_html"><div class="ttname"><a href="secblock_8h.html">secblock.h</a></div><div class="ttdoc">Classes and functions for secure memory allocations. </div></div> <div class="ttc" id="struct_s_e_a_l___info_html"><div class="ttname"><a href="struct_s_e_a_l___info.html">SEAL_Info</a></div><div class="ttdoc">SEAL stream cipher information. </div><div class="ttdef"><b>Definition:</b> <a href="seal_8h_source.html#l00019">seal.h:19</a></div></div> <div class="ttc" id="struct_additive_cipher_concrete_policy_html_a88ce0905757bcc373f028bfd9e0dec43"><div class="ttname"><a href="struct_additive_cipher_concrete_policy.html#a88ce0905757bcc373f028bfd9e0dec43">AdditiveCipherConcretePolicy::OperateKeystream</a></div><div class="ttdeci">virtual void OperateKeystream(KeystreamOperation operation, byte *output, const byte *input, size_t iterationCount)=0</div><div class="ttdoc">Operates the keystream. </div></div> <div class="ttc" id="class_fixed_size_sec_block_html"><div class="ttname"><a href="class_fixed_size_sec_block.html">FixedSizeSecBlock< word32, 512 ></a></div></div> <div class="ttc" id="struct_s_e_a_l_html"><div class="ttname"><a href="struct_s_e_a_l.html">SEAL</a></div><div class="ttdoc">SEAL stream cipher. </div><div class="ttdef"><b>Definition:</b> <a href="seal_8h_source.html#l00051">seal.h:51</a></div></div> <div class="ttc" id="namespace_name_html_a9b6839240a8bdf1f5bcbebf1866f4733"><div class="ttname"><a href="namespace_name.html#a9b6839240a8bdf1f5bcbebf1866f4733">Name::IV</a></div><div class="ttdeci">const char * IV()</div><div class="ttdoc">ConstByteArrayParameter, also accepts const byte * for backwards compatibility. </div><div class="ttdef"><b>Definition:</b> <a href="argnames_8h_source.html#l00021">argnames.h:21</a></div></div> <div class="ttc" id="strciphr_8h_html"><div class="ttname"><a href="strciphr_8h.html">strciphr.h</a></div><div class="ttdoc">Classes for implementing stream ciphers. </div></div> <div class="ttc" id="struct_symmetric_cipher_documentation_html"><div class="ttname"><a href="struct_symmetric_cipher_documentation.html">SymmetricCipherDocumentation</a></div><div class="ttdoc">Provides Encryption and Decryption typedefs used by derived classes to implement a symmetric cipher...</div><div class="ttdef"><b>Definition:</b> <a href="seckey_8h_source.html#l00435">seckey.h:435</a></div></div> <div class="ttc" id="strciphr_8h_html_ab4a226527d2bd01ff19bfa14d0974227"><div class="ttname"><a href="strciphr_8h.html#ab4a226527d2bd01ff19bfa14d0974227">KeystreamOperation</a></div><div class="ttdeci">KeystreamOperation</div><div class="ttdoc">Keystream operation flags. </div><div class="ttdef"><b>Definition:</b> <a href="strciphr_8h_source.html#l00088">strciphr.h:88</a></div></div> <div class="ttc" id="namespace_crypto_p_p_html"><div class="ttname"><a href="namespace_crypto_p_p.html">CryptoPP</a></div><div class="ttdoc">Crypto++ library namespace. </div></div> <div class="ttc" id="class_symmetric_cipher_final_html"><div class="ttname"><a href="class_symmetric_cipher_final.html">SymmetricCipherFinal</a></div><div class="ttdoc">SymmetricCipher implementation. </div><div class="ttdef"><b>Definition:</b> <a href="strciphr_8h_source.html#l00571">strciphr.h:571</a></div></div> <div class="ttc" id="class_additive_cipher_template_html"><div class="ttname"><a href="class_additive_cipher_template.html">AdditiveCipherTemplate</a></div><div class="ttdoc">Base class for additive stream ciphers with SymmetricCipher interface. </div><div class="ttdef"><b>Definition:</b> <a href="strciphr_8h_source.html#l00261">strciphr.h:261</a></div></div> <div class="ttc" id="class_name_value_pairs_html"><div class="ttname"><a href="class_name_value_pairs.html">NameValuePairs</a></div><div class="ttdoc">Interface for retrieving values given their names. </div><div class="ttdef"><b>Definition:</b> <a href="cryptlib_8h_source.html#l00290">cryptlib.h:290</a></div></div> </div><!-- fragment --></div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated on Sun Sep 16 2018 07:58:02 for Crypto++ by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.14 </small></address> </body> </html>