<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.15"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>Crypto++: oaep.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.15 --> <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">oaep.h</div> </div> </div><!--header--> <div class="contents"> <a href="oaep_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">// oaep.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 oaep.h</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">/// \brief Classes for optimal asymmetric encryption padding</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">/// \since Crypto++ 2.1</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_OAEP_H</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#define CRYPTOPP_OAEP_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="cryptlib_8h.html">cryptlib.h</a>"</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#include "<a class="code" href="pubkey_8h.html">pubkey.h</a>"</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#include "<a class="code" href="sha_8h.html">sha.h</a>"</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> </div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> NAMESPACE_BEGIN(<a class="code" href="namespace_crypto_p_p.html">CryptoPP</a>)</div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> </div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">/// \brief OAEP padding base class</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"></span><span class="comment">/// \since Crypto++ 2.1</span></div><div class="line"><a name="l00018"></a><span class="lineno"><a class="line" href="class_o_a_e_p___base.html"> 18</a></span> <span class="comment"></span>class CRYPTOPP_DLL <a class="code" href="class_o_a_e_p___base.html">OAEP_Base</a> : public <a class="code" href="class_p_k___encryption_message_encoding_method.html">PK_EncryptionMessageEncodingMethod</a></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> {</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  <span class="keywordtype">bool</span> ParameterSupported(<span class="keyword">const</span> <span class="keywordtype">char</span> *name)<span class="keyword"> const </span>{<span class="keywordflow">return</span> strcmp(name, <a class="code" href="namespace_name.html#abfc2af8f8cc15abc866b9a48478c763f">Name::EncodingParameters</a>()) == 0;}</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  <span class="keywordtype">size_t</span> MaxUnpaddedLength(<span class="keywordtype">size_t</span> paddedLength) <span class="keyword">const</span>;</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  <span class="keywordtype">void</span> <a class="code" href="namespace_name.html#ab7fb5e98db5dda84252e01a7d06492a5">Pad</a>(<a class="code" href="class_random_number_generator.html">RandomNumberGenerator</a> &rng, <span class="keyword">const</span> <span class="keywordtype">byte</span> *raw, <span class="keywordtype">size_t</span> inputLength, <span class="keywordtype">byte</span> *padded, <span class="keywordtype">size_t</span> paddedLength, <span class="keyword">const</span> <a class="code" href="class_name_value_pairs.html">NameValuePairs</a> &parameters) <span class="keyword">const</span>;</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  <a class="code" href="struct_decoding_result.html">DecodingResult</a> Unpad(<span class="keyword">const</span> <span class="keywordtype">byte</span> *padded, <span class="keywordtype">size_t</span> paddedLength, <span class="keywordtype">byte</span> *raw, <span class="keyword">const</span> <a class="code" href="class_name_value_pairs.html">NameValuePairs</a> &parameters) <span class="keyword">const</span>;</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="keyword">protected</span>:</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  <span class="keyword">virtual</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="namespace_name.html#ae065e5d1d16c399ad5404659e649bfec">DigestSize</a>() <span class="keyword">const</span> =0;</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  <span class="keyword">virtual</span> <a class="code" href="class_hash_transformation.html">HashTransformation</a> * NewHash() <span class="keyword">const</span> =0;</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <span class="keyword">virtual</span> <a class="code" href="class_mask_generating_function.html">MaskGeneratingFunction</a> * NewMGF() <span class="keyword">const</span> =0;</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> };</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"></span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment">/// \brief OAEP padding</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment">/// \tparam H HashTransformation derived class</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment">/// \tparam MGF MaskGeneratingFunction derived class</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment">/// \sa <a href="http://www.weidai.com/scan-mirror/ca.html#cem_OAEP-MGF1">EME-OAEP</a>, for use with classes derived from TF_ES</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment">/// \since Crypto++ 2.1</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"></span><span class="keyword">template</span> <<span class="keyword">class</span> H, <span class="keyword">class</span> MGF=P1363_MGF1></div><div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="class_o_a_e_p.html"> 38</a></span> <span class="keyword">class </span><a class="code" href="class_o_a_e_p.html">OAEP</a> : <span class="keyword">public</span> <a class="code" href="class_o_a_e_p___base.html">OAEP_Base</a>, <span class="keyword">public</span> <a class="code" href="struct_encryption_standard.html">EncryptionStandard</a></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> {</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keyword">static</span> std::string CRYPTOPP_API StaticAlgorithmName() {<span class="keywordflow">return</span> std::string(<span class="stringliteral">"OAEP-"</span>) + MGF::StaticAlgorithmName() + <span class="stringliteral">"("</span> + H::StaticAlgorithmName() + <span class="stringliteral">")"</span>;}</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keyword">typedef</span> <a class="code" href="class_o_a_e_p.html">OAEP<H, MGF></a> <a class="code" href="class_o_a_e_p.html">EncryptionMessageEncodingMethod</a>;</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="keyword">protected</span>:</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> DigestSize()<span class="keyword"> const </span>{<span class="keywordflow">return</span> H::DIGESTSIZE;}</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <a class="code" href="class_hash_transformation.html">HashTransformation</a> * NewHash()<span class="keyword"> const </span>{<span class="keywordflow">return</span> <span class="keyword">new</span> H;}</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <a class="code" href="class_mask_generating_function.html">MaskGeneratingFunction</a> * NewMGF()<span class="keyword"> const </span>{<span class="keywordflow">return</span> <span class="keyword">new</span> MGF;}</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> };</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> CRYPTOPP_DLL_TEMPLATE_CLASS <a class="code" href="class_o_a_e_p.html">OAEP<SHA1></a>;</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> NAMESPACE_END</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="namespace_name_html_ae065e5d1d16c399ad5404659e649bfec"><div class="ttname"><a href="namespace_name.html#ae065e5d1d16c399ad5404659e649bfec">Name::DigestSize</a></div><div class="ttdeci">const char * DigestSize()</div><div class="ttdoc">int, in bytes</div><div class="ttdef"><b>Definition:</b> <a href="argnames_8h_source.html#l00079">argnames.h:79</a></div></div> <div class="ttc" id="class_o_a_e_p___base_html"><div class="ttname"><a href="class_o_a_e_p___base.html">OAEP_Base</a></div><div class="ttdoc">OAEP padding base class.</div><div class="ttdef"><b>Definition:</b> <a href="oaep_8h_source.html#l00018">oaep.h:18</a></div></div> <div class="ttc" id="namespace_name_html_ab7fb5e98db5dda84252e01a7d06492a5"><div class="ttname"><a href="namespace_name.html#ab7fb5e98db5dda84252e01a7d06492a5">Name::Pad</a></div><div class="ttdeci">const char * Pad()</div><div class="ttdoc">bool</div><div class="ttdef"><b>Definition:</b> <a href="argnames_8h_source.html#l00072">argnames.h:72</a></div></div> <div class="ttc" id="pubkey_8h_html"><div class="ttname"><a href="pubkey_8h.html">pubkey.h</a></div><div class="ttdoc">This file contains helper classes/functions for implementing public key algorithms.</div></div> <div class="ttc" id="cryptlib_8h_html"><div class="ttname"><a href="cryptlib_8h.html">cryptlib.h</a></div><div class="ttdoc">Abstract base classes that provide a uniform interface to this library.</div></div> <div class="ttc" id="class_p_k___encryption_message_encoding_method_html"><div class="ttname"><a href="class_p_k___encryption_message_encoding_method.html">PK_EncryptionMessageEncodingMethod</a></div><div class="ttdoc">Message encoding method for public key encryption.</div><div class="ttdef"><b>Definition:</b> <a href="pubkey_8h_source.html#l00208">pubkey.h:208</a></div></div> <div class="ttc" id="class_random_number_generator_html"><div class="ttname"><a href="class_random_number_generator.html">RandomNumberGenerator</a></div><div class="ttdoc">Interface for random number generators.</div><div class="ttdef"><b>Definition:</b> <a href="cryptlib_8h_source.html#l01330">cryptlib.h:1330</a></div></div> <div class="ttc" id="struct_decoding_result_html"><div class="ttname"><a href="struct_decoding_result.html">DecodingResult</a></div><div class="ttdoc">Returns a decoding results.</div><div class="ttdef"><b>Definition:</b> <a href="cryptlib_8h_source.html#l00252">cryptlib.h:252</a></div></div> <div class="ttc" id="namespace_name_html_abfc2af8f8cc15abc866b9a48478c763f"><div class="ttname"><a href="namespace_name.html#abfc2af8f8cc15abc866b9a48478c763f">Name::EncodingParameters</a></div><div class="ttdeci">const char * EncodingParameters()</div><div class="ttdoc">ConstByteArrayParameter.</div><div class="ttdef"><b>Definition:</b> <a href="argnames_8h_source.html#l00066">argnames.h:66</a></div></div> <div class="ttc" id="struct_encryption_standard_html"><div class="ttname"><a href="struct_encryption_standard.html">EncryptionStandard</a></div><div class="ttdoc">Base class for public key encryption standard classes.</div><div class="ttdef"><b>Definition:</b> <a href="pubkey_8h_source.html#l02218">pubkey.h:2218</a></div></div> <div class="ttc" id="class_mask_generating_function_html"><div class="ttname"><a href="class_mask_generating_function.html">MaskGeneratingFunction</a></div><div class="ttdoc">Mask generation function interface.</div><div class="ttdef"><b>Definition:</b> <a href="pubkey_8h_source.html#l00685">pubkey.h:685</a></div></div> <div class="ttc" id="sha_8h_html"><div class="ttname"><a href="sha_8h.html">sha.h</a></div><div class="ttdoc">Classes for SHA-1 and SHA-2 family of message digests.</div></div> <div class="ttc" id="class_hash_transformation_html"><div class="ttname"><a href="class_hash_transformation.html">HashTransformation</a></div><div class="ttdoc">Interface for hash functions and data processing part of MACs.</div><div class="ttdef"><b>Definition:</b> <a href="cryptlib_8h_source.html#l01065">cryptlib.h:1065</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_o_a_e_p_html"><div class="ttname"><a href="class_o_a_e_p.html">OAEP</a></div><div class="ttdoc">OAEP padding.</div><div class="ttdef"><b>Definition:</b> <a href="oaep_8h_source.html#l00038">oaep.h:38</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 Wed Nov 27 2019 15:03:38 for Crypto++ by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.15 </small></address> </body> </html>