Documentation for f1eddf4d65

This commit is contained in:
realstealthninja
2025-07-09 10:53:16 +00:00
parent e7edde96ab
commit b41207008f
2497 changed files with 31270 additions and 40283 deletions

View File

@@ -4,7 +4,7 @@
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.13.2"/>
<meta name="generator" content="Doxygen 1.14.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>TheAlgorithms/C++: hashing/sha256.cpp File Reference</title>
<link rel="icon" href="../../favicon.svg" type="image/x-icon" />
@@ -19,7 +19,6 @@
<link href="../../navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../navtreedata.js"></script>
<script type="text/javascript" src="../../navtree.js"></script>
<script type="text/javascript" src="../../resize.js"></script>
<script type="text/javascript" src="../../cookie.js"></script>
<link href="../../search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../search/searchdata.js"></script>
@@ -60,26 +59,20 @@ window.MathJax = {
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.13.2 -->
<!-- Generated by Doxygen 1.14.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "../../search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(1); });
/* @license-end */
$(function() { codefold.init(); });
</script>
<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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('../../',true,false,'search.php','Search',true);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
@@ -94,10 +87,9 @@ $(function() {
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('d4/d08/sha256_8cpp.html','../../'); initResizable(true); });
/* @license-end */
$(function(){initNavTree('d4/d08/sha256_8cpp.html','../../',''); });
</script>
<div id="container">
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
@@ -121,10 +113,6 @@ $(function(){initNavTree('d4/d08/sha256_8cpp.html','../../'); initResizable(true
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#namespaces">Namespaces</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">sha256.cpp File Reference</div></div>
</div><!--header-->
<div class="contents">
@@ -142,71 +130,55 @@ $(function(){initNavTree('d4/d08/sha256_8cpp.html','../../'); initResizable(true
</div><div class="textblock"><div class="dynheader">
Include dependency graph for sha256.cpp:</div>
<div class="dyncontent">
<div class="center"><div class="zoom"><iframe scrolling="no" frameborder="0" src="../../dc/dd2/sha256_8cpp__incl.svg" width="100%" height="383"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div></div>
<div class="center"><div class="zoom"><iframe scrolling="no" loading="lazy" frameborder="0" src="../../dc/dd2/sha256_8cpp__incl.svg" width="100%" height="383"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div></div>
</div>
</div>
<p><a href="../../d4/d08/sha256_8cpp_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
<tr class="heading"><td colspan="2"><h2 id="header-nested-classes" class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d6/d84/classhashing_1_1sha256_1_1_hash.html">hashing::sha256::Hash</a></td></tr>
<tr class="memitem:hashing_3A_3Asha256_3A_3AHash" id="r_hashing_3A_3Asha256_3A_3AHash"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d6/d84/classhashing_1_1sha256_1_1_hash.html">hashing::sha256::Hash</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Contains hash array and functions to update it and convert it to a hexadecimal string. <a href="../../d6/d84/classhashing_1_1sha256_1_1_hash.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="namespaces" name="namespaces"></a>
<tr class="heading"><td colspan="2"><h2 id="header-namespaces" class="groupheader"><a id="namespaces" name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d6/d0c/namespacehashing.html">hashing</a></td></tr>
<tr class="memitem:hashing" id="r_hashing"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d6/d0c/namespacehashing.html">hashing</a></td></tr>
<tr class="memdesc:d6/d0c/namespacehashing"><td class="mdescLeft">&#160;</td><td class="mdescRight">Used for assert. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/dd3/namespace_s_h_a.html">SHA</a></td></tr>
<tr class="memitem:SHA" id="r_SHA"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/dd3/namespace_s_h_a.html">SHA</a></td></tr>
<tr class="memdesc:de/dd3/namespace_s_h_a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Functions for the <a href="https://en.wikipedia.org/wiki/SHA-1" target="_blank">SHA-1</a> algorithm implementation. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
<tr class="heading"><td colspan="2"><h2 id="header-func-members" class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:adbcd504103c342a4da718f8fce6ff06c" id="r_adbcd504103c342a4da718f8fce6ff06c"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#adbcd504103c342a4da718f8fce6ff06c">hashing::sha256::right_rotate</a> (uint32_t n, size_t rotate)</td></tr>
<tr class="memdesc:adbcd504103c342a4da718f8fce6ff06c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Rotates the bits of a 32-bit unsigned integer. <br /></td></tr>
<tr class="separator:adbcd504103c342a4da718f8fce6ff06c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a28c1c6724dc6bcf91a39818699bbec27" id="r_a28c1c6724dc6bcf91a39818699bbec27"><td class="memItemLeft" align="right" valign="top">std::size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a28c1c6724dc6bcf91a39818699bbec27">hashing::sha256::compute_padded_size</a> (const std::size_t input_size)</td></tr>
<tr class="memdesc:a28c1c6724dc6bcf91a39818699bbec27"><td class="mdescLeft">&#160;</td><td class="mdescRight">Computes size of the padded input. <br /></td></tr>
<tr class="separator:a28c1c6724dc6bcf91a39818699bbec27"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afea411191ec5281f43e91ea327984627" id="r_afea411191ec5281f43e91ea327984627"><td class="memTemplParams" colspan="2">template&lt;typename T&gt; </td></tr>
<tr class="memitem:afea411191ec5281f43e91ea327984627"><td class="memTemplItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#afea411191ec5281f43e91ea327984627">hashing::sha256::extract_byte</a> (const T in_value, const std::size_t byte_num)</td></tr>
<tr class="memitem:afea411191ec5281f43e91ea327984627 template"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#afea411191ec5281f43e91ea327984627">hashing::sha256::extract_byte</a> (const T in_value, const std::size_t byte_num)</td></tr>
<tr class="memdesc:afea411191ec5281f43e91ea327984627"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the byte at position byte_num in in_value. <br /></td></tr>
<tr class="separator:afea411191ec5281f43e91ea327984627"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9e98c180d32b04aab6f767cb0c13e1da" id="r_a9e98c180d32b04aab6f767cb0c13e1da"><td class="memItemLeft" align="right" valign="top">char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9e98c180d32b04aab6f767cb0c13e1da">hashing::sha256::get_char</a> (const std::string &amp;input, std::size_t pos)</td></tr>
<tr class="memdesc:a9e98c180d32b04aab6f767cb0c13e1da"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the character at pos after the input is padded. <br /></td></tr>
<tr class="separator:a9e98c180d32b04aab6f767cb0c13e1da"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a525531b3939ed44fbf01674e21931b3a" id="r_a525531b3939ed44fbf01674e21931b3a"><td class="memItemLeft" align="right" valign="top">std::array&lt; uint32_t, 64 &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a525531b3939ed44fbf01674e21931b3a">hashing::sha256::create_message_schedule_array</a> (const std::string &amp;input, const size_t byte_num)</td></tr>
<tr class="memdesc:a525531b3939ed44fbf01674e21931b3a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates the message schedule array. <br /></td></tr>
<tr class="separator:a525531b3939ed44fbf01674e21931b3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a55475649a2bb7aae15de0716a217f43a" id="r_a55475649a2bb7aae15de0716a217f43a"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a55475649a2bb7aae15de0716a217f43a">hashing::sha256::sha256</a> (const std::string &amp;input)</td></tr>
<tr class="memdesc:a55475649a2bb7aae15de0716a217f43a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Computes the final hash value. <br /></td></tr>
<tr class="separator:a55475649a2bb7aae15de0716a217f43a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af9b52eba85d23e309035354141259f27" id="r_af9b52eba85d23e309035354141259f27"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af9b52eba85d23e309035354141259f27">test_compute_padded_size</a> ()</td></tr>
<tr class="memdesc:af9b52eba85d23e309035354141259f27"><td class="mdescLeft">&#160;</td><td class="mdescRight">Self-test implementations. <br /></td></tr>
<tr class="separator:af9b52eba85d23e309035354141259f27"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5afb183bc9072e33fed6c375ae6b7341" id="r_a5afb183bc9072e33fed6c375ae6b7341"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5afb183bc9072e33fed6c375ae6b7341">test_extract_byte</a> ()</td></tr>
<tr class="separator:a5afb183bc9072e33fed6c375ae6b7341"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad2776cb73ddf27e044f890b4a79ab947" id="r_ad2776cb73ddf27e044f890b4a79ab947"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad2776cb73ddf27e044f890b4a79ab947">test_get_char</a> ()</td></tr>
<tr class="separator:ad2776cb73ddf27e044f890b4a79ab947"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a33eb7fad4a4b36804c881e0ee98effc1" id="r_a33eb7fad4a4b36804c881e0ee98effc1"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a33eb7fad4a4b36804c881e0ee98effc1">test_right_rotate</a> ()</td></tr>
<tr class="separator:a33eb7fad4a4b36804c881e0ee98effc1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a51e22dc64aeeda7363a674627f37e966" id="r_a51e22dc64aeeda7363a674627f37e966"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a51e22dc64aeeda7363a674627f37e966">test_sha256</a> ()</td></tr>
<tr class="separator:a51e22dc64aeeda7363a674627f37e966"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa8dca7b867074164d5f45b0f3851269d" id="r_aa8dca7b867074164d5f45b0f3851269d"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa8dca7b867074164d5f45b0f3851269d">test</a> ()</td></tr>
<tr class="separator:aa8dca7b867074164d5f45b0f3851269d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae66f6b31b5ad750f1fe042a706a4e3d4" id="r_ae66f6b31b5ad750f1fe042a706a4e3d4"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae66f6b31b5ad750f1fe042a706a4e3d4">main</a> ()</td></tr>
<tr class="memdesc:ae66f6b31b5ad750f1fe042a706a4e3d4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Main function. <br /></td></tr>
<tr class="separator:ae66f6b31b5ad750f1fe042a706a4e3d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Simple C++ implementation of the [SHA-256 Hashing Algorithm] (<a href="https://en.wikipedia.org/wiki/SHA-2">https://en.wikipedia.org/wiki/SHA-2</a>) </p>
<dl class="section author"><dt>Author</dt><dd><a href="https://github.com/mdanisulh" target="_blank">Md. Anisul Haque</a> </dd></dl>
<p><a href="https://en.wikipedia.org/wiki/SHA-2" target="_blank">SHA-2</a> is a set of cryptographic hash functions that was designed by the <a href="https://en.wikipedia.org/wiki/National_Security_Agency" target="_blank">NSA</a> and first published in 2001. SHA-256 is a part of the SHA-2 family. SHA-256 is widely used for authenticating software packages and secure password hashing. </p>
<p class="definition">Definition in file <a class="el" href="../../d4/d08/sha256_8cpp_source.html">sha256.cpp</a>.</p>
</div><h2 class="groupheader">Function Documentation</h2>
</div><a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Function Documentation</h2>
<a id="a28c1c6724dc6bcf91a39818699bbec27" name="a28c1c6724dc6bcf91a39818699bbec27"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a28c1c6724dc6bcf91a39818699bbec27">&#9670;&#160;</a></span>compute_padded_size()</h2>
@@ -511,7 +483,7 @@ template&lt;typename T&gt; </div>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void test </td>
<td class="memname">void test </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
@@ -548,7 +520,7 @@ template&lt;typename T&gt; </div>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void test_compute_padded_size </td>
<td class="memname">void test_compute_padded_size </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
@@ -583,7 +555,7 @@ template&lt;typename T&gt; </div>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void test_extract_byte </td>
<td class="memname">void test_extract_byte </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
@@ -621,7 +593,7 @@ template&lt;typename T&gt; </div>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void test_get_char </td>
<td class="memname">void test_get_char </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
@@ -662,7 +634,7 @@ template&lt;typename T&gt; </div>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void test_right_rotate </td>
<td class="memname">void test_right_rotate </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
@@ -695,7 +667,7 @@ template&lt;typename T&gt; </div>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void test_sha256 </td>
<td class="memname">void test_sha256 </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
@@ -741,11 +713,19 @@ template&lt;typename T&gt; </div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="page-nav" class="page-nav-panel">
<div id="page-nav-resize-handle"></div>
<div id="page-nav-tree">
<div id="page-nav-contents">
</div><!-- page-nav-contents -->
</div><!-- page-nav-tree -->
</div><!-- page-nav -->
</div><!-- container -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="../../dir_ece9b94c107bbaa1dd68197a8c9983b9.html">hashing</a></li><li class="navelem"><a class="el" href="../../d4/d08/sha256_8cpp.html">sha256.cpp</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="../../doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.13.2 </li>
<li class="navelem"><a href="../../dir_ece9b94c107bbaa1dd68197a8c9983b9.html">hashing</a></li><li class="navelem"><a href="../../d4/d08/sha256_8cpp.html">sha256.cpp</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="../../doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.14.0 </li>
</ul>
</div>
</body>