<!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++: fips140.cpp 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">fips140.cpp</div> </div> </div><!--header--> <div class="contents"> <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// fips140.cpp - 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> </div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="preprocessor">#include "<a class="code" href="pch_8h.html">pch.h</a>"</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> </div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#ifndef CRYPTOPP_IMPORTS</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> </div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#include "<a class="code" href="fips140_8h.html">fips140.h</a>"</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#include "<a class="code" href="misc_8h.html">misc.h</a>"</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#include "trdlocal.h"</span> <span class="comment">// needs to be included last for cygwin</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> </div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> NAMESPACE_BEGIN(<a class="code" href="namespace_crypto_p_p.html">CryptoPP</a>)</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> <span class="comment">// Define this to 1 to turn on FIPS 140-2 compliance features, including additional tests during</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">// startup, random number generation, and key generation. These tests may affect performance.</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#ifndef CRYPTOPP_ENABLE_COMPLIANCE_WITH_FIPS_140_2</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#define CRYPTOPP_ENABLE_COMPLIANCE_WITH_FIPS_140_2 0</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#if (CRYPTOPP_ENABLE_COMPLIANCE_WITH_FIPS_140_2 && !defined(THREADS_AVAILABLE))</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#error FIPS 140-2 compliance requires the availability of thread local storage.</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#endif</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="preprocessor">#if (CRYPTOPP_ENABLE_COMPLIANCE_WITH_FIPS_140_2 && !defined(OS_RNG_AVAILABLE))</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#error FIPS 140-2 compliance requires the availability of OS provided RNG.</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <a class="code" href="fips140_8h.html#a8ccac50ac3bfc5abaa6cb457f0ded35d">PowerUpSelfTestStatus</a> g_powerUpSelfTestStatus = <a class="code" href="fips140_8h.html#a8ccac50ac3bfc5abaa6cb457f0ded35da50805cb51444d59eb747962fa279ad27">POWER_UP_SELF_TEST_NOT_DONE</a>;</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div><div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="fips140_8h.html#afcc971af5af431d1528a09f52c195d64"> 29</a></span> <span class="keywordtype">bool</span> <a class="code" href="fips140_8h.html#afcc971af5af431d1528a09f52c195d64">FIPS_140_2_ComplianceEnabled</a>()</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="keywordflow">return</span> CRYPTOPP_ENABLE_COMPLIANCE_WITH_FIPS_140_2;</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> }</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div><div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="fips140_8h.html#a8899256483ab45e1fc1ac856a04495fa"> 34</a></span> <span class="keywordtype">void</span> <a class="code" href="fips140_8h.html#a8899256483ab45e1fc1ac856a04495fa">SimulatePowerUpSelfTestFailure</a>()</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> {</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  g_powerUpSelfTestStatus = <a class="code" href="fips140_8h.html#a8ccac50ac3bfc5abaa6cb457f0ded35da7fdf030b911a428fda600038ef914c95">POWER_UP_SELF_TEST_FAILED</a>;</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> }</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div><div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="fips140_8h.html#a4c02704f811a57301d998fabd8bcf5ae"> 39</a></span> <a class="code" href="fips140_8h.html#a8ccac50ac3bfc5abaa6cb457f0ded35d">PowerUpSelfTestStatus</a> CRYPTOPP_API <a class="code" href="fips140_8h.html#a4c02704f811a57301d998fabd8bcf5ae">GetPowerUpSelfTestStatus</a>()</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> {</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keywordflow">return</span> g_powerUpSelfTestStatus;</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> }</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="preprocessor">#if CRYPTOPP_ENABLE_COMPLIANCE_WITH_FIPS_140_2</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <a class="code" href="class_thread_local_storage.html">ThreadLocalStorage</a> & AccessPowerUpSelfTestInProgress()</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> {</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keyword">static</span> <a class="code" href="class_thread_local_storage.html">ThreadLocalStorage</a> selfTestInProgress;</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keywordflow">return</span> selfTestInProgress;</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> <span class="preprocessor">#endif</span></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> <span class="keywordtype">bool</span> PowerUpSelfTestInProgressOnThisThread()</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">#if CRYPTOPP_ENABLE_COMPLIANCE_WITH_FIPS_140_2</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keywordflow">return</span> AccessPowerUpSelfTestInProgress().GetValue() != NULLPTR;</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="preprocessor">#else</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <a class="code" href="trap_8h.html#adf3b392588bc94cbeae9f415a78c7b95">CRYPTOPP_ASSERT</a>(<span class="keyword">false</span>); <span class="comment">// should not be called</span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keywordflow">return</span> <span class="keyword">false</span>;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> }</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="keywordtype">void</span> SetPowerUpSelfTestInProgressOnThisThread(<span class="keywordtype">bool</span> inProgress)</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>  CRYPTOPP_UNUSED(inProgress);</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="preprocessor">#if CRYPTOPP_ENABLE_COMPLIANCE_WITH_FIPS_140_2</span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  AccessPowerUpSelfTestInProgress().SetValue((<span class="keywordtype">void</span> *)inProgress);</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> }</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="keywordtype">void</span> EncryptionPairwiseConsistencyTest_FIPS_140_Only(<span class="keyword">const</span> <a class="code" href="class_p_k___encryptor.html">PK_Encryptor</a> &encryptor, <span class="keyword">const</span> <a class="code" href="class_p_k___decryptor.html">PK_Decryptor</a> &decryptor)</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> {</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  CRYPTOPP_UNUSED(encryptor), CRYPTOPP_UNUSED(decryptor);</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="preprocessor">#if CRYPTOPP_ENABLE_COMPLIANCE_WITH_FIPS_140_2</span></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  EncryptionPairwiseConsistencyTest(encryptor, decryptor);</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> }</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="keywordtype">void</span> SignaturePairwiseConsistencyTest_FIPS_140_Only(<span class="keyword">const</span> <a class="code" href="class_p_k___signer.html">PK_Signer</a> &signer, <span class="keyword">const</span> <a class="code" href="class_p_k___verifier.html">PK_Verifier</a> &verifier)</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> {</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  CRYPTOPP_UNUSED(signer), CRYPTOPP_UNUSED(verifier);</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="preprocessor">#if CRYPTOPP_ENABLE_COMPLIANCE_WITH_FIPS_140_2</span></div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  SignaturePairwiseConsistencyTest(signer, verifier);</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> }</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> </div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> NAMESPACE_END</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> </div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="misc_8h_html"><div class="ttname"><a href="misc_8h.html">misc.h</a></div><div class="ttdoc">Utility functions for the Crypto++ library. </div></div> <div class="ttc" id="class_p_k___signer_html"><div class="ttname"><a href="class_p_k___signer.html">PK_Signer</a></div><div class="ttdoc">Interface for public-key signers. </div><div class="ttdef"><b>Definition:</b> <a href="cryptlib_8h_source.html#l02705">cryptlib.h:2705</a></div></div> <div class="ttc" id="class_p_k___encryptor_html"><div class="ttname"><a href="class_p_k___encryptor.html">PK_Encryptor</a></div><div class="ttdoc">Interface for public-key encryptors. </div><div class="ttdef"><b>Definition:</b> <a href="cryptlib_8h_source.html#l02526">cryptlib.h:2526</a></div></div> <div class="ttc" id="fips140_8h_html_a8ccac50ac3bfc5abaa6cb457f0ded35da7fdf030b911a428fda600038ef914c95"><div class="ttname"><a href="fips140_8h.html#a8ccac50ac3bfc5abaa6cb457f0ded35da7fdf030b911a428fda600038ef914c95">POWER_UP_SELF_TEST_FAILED</a></div><div class="ttdoc">The self tests were executed via DoPowerUpSelfTest() or DoDllPowerUpSelfTest(), but the result was fa...</div><div class="ttdef"><b>Definition:</b> <a href="fips140_8h_source.html#l00043">fips140.h:43</a></div></div> <div class="ttc" id="fips140_8h_html_afcc971af5af431d1528a09f52c195d64"><div class="ttname"><a href="fips140_8h.html#afcc971af5af431d1528a09f52c195d64">FIPS_140_2_ComplianceEnabled</a></div><div class="ttdeci">bool FIPS_140_2_ComplianceEnabled()</div><div class="ttdoc">Determines whether the library provides FIPS validated cryptography. </div><div class="ttdef"><b>Definition:</b> <a href="fips140_8cpp_source.html#l00029">fips140.cpp:29</a></div></div> <div class="ttc" id="class_p_k___decryptor_html"><div class="ttname"><a href="class_p_k___decryptor.html">PK_Decryptor</a></div><div class="ttdoc">Interface for public-key decryptors. </div><div class="ttdef"><b>Definition:</b> <a href="cryptlib_8h_source.html#l02561">cryptlib.h:2561</a></div></div> <div class="ttc" id="pch_8h_html"><div class="ttname"><a href="pch_8h.html">pch.h</a></div><div class="ttdoc">Precompiled header file. </div></div> <div class="ttc" id="class_thread_local_storage_html"><div class="ttname"><a href="class_thread_local_storage.html">ThreadLocalStorage</a></div><div class="ttdoc">thread local storage </div><div class="ttdef"><b>Definition:</b> <a href="trdlocal_8h_source.html#l00020">trdlocal.h:20</a></div></div> <div class="ttc" id="fips140_8h_html_a8899256483ab45e1fc1ac856a04495fa"><div class="ttname"><a href="fips140_8h.html#a8899256483ab45e1fc1ac856a04495fa">SimulatePowerUpSelfTestFailure</a></div><div class="ttdeci">void SimulatePowerUpSelfTestFailure()</div><div class="ttdoc">Sets the power-up self test status to POWER_UP_SELF_TEST_FAILED. </div><div class="ttdef"><b>Definition:</b> <a href="fips140_8cpp_source.html#l00034">fips140.cpp:34</a></div></div> <div class="ttc" id="trap_8h_html_adf3b392588bc94cbeae9f415a78c7b95"><div class="ttname"><a href="trap_8h.html#adf3b392588bc94cbeae9f415a78c7b95">CRYPTOPP_ASSERT</a></div><div class="ttdeci">#define CRYPTOPP_ASSERT(exp)</div><div class="ttdoc">Debugging and diagnostic assertion. </div><div class="ttdef"><b>Definition:</b> <a href="trap_8h_source.html#l00060">trap.h:60</a></div></div> <div class="ttc" id="fips140_8h_html_a4c02704f811a57301d998fabd8bcf5ae"><div class="ttname"><a href="fips140_8h.html#a4c02704f811a57301d998fabd8bcf5ae">GetPowerUpSelfTestStatus</a></div><div class="ttdeci">PowerUpSelfTestStatus GetPowerUpSelfTestStatus()</div><div class="ttdoc">Provides the current power-up self test status. </div><div class="ttdef"><b>Definition:</b> <a href="fips140_8cpp_source.html#l00039">fips140.cpp:39</a></div></div> <div class="ttc" id="fips140_8h_html_a8ccac50ac3bfc5abaa6cb457f0ded35da50805cb51444d59eb747962fa279ad27"><div class="ttname"><a href="fips140_8h.html#a8ccac50ac3bfc5abaa6cb457f0ded35da50805cb51444d59eb747962fa279ad27">POWER_UP_SELF_TEST_NOT_DONE</a></div><div class="ttdoc">The self tests have not been performed. </div><div class="ttdef"><b>Definition:</b> <a href="fips140_8h_source.html#l00040">fips140.h:40</a></div></div> <div class="ttc" id="class_p_k___verifier_html"><div class="ttname"><a href="class_p_k___verifier.html">PK_Verifier</a></div><div class="ttdoc">Interface for public-key signature verifiers. </div><div class="ttdef"><b>Definition:</b> <a href="cryptlib_8h_source.html#l02769">cryptlib.h:2769</a></div></div> <div class="ttc" id="fips140_8h_html"><div class="ttname"><a href="fips140_8h.html">fips140.h</a></div><div class="ttdoc">Classes and functions for the FIPS 140-2 validated library. </div></div> <div class="ttc" id="fips140_8h_html_a8ccac50ac3bfc5abaa6cb457f0ded35d"><div class="ttname"><a href="fips140_8h.html#a8ccac50ac3bfc5abaa6cb457f0ded35d">PowerUpSelfTestStatus</a></div><div class="ttdeci">PowerUpSelfTestStatus</div><div class="ttdoc">Status of the power-up self test. </div><div class="ttdef"><b>Definition:</b> <a href="fips140_8h_source.html#l00037">fips140.h:37</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><!-- fragment --></div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated on Sun Sep 16 2018 07:57:51 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>