levovix
/
Nim
mirror of https://github.com/nim-lang/Nim


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438
							<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!--  This file is generated by Nim. -->
<html xmlns="https://www.w3.org/1999/xhtml" xml:lang="en" lang="en" data-theme="auto">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>src/checksums/sha2</title>

<!-- Google fonts -->
<link href='https://fonts.googleapis.com/css?family=Lato:400,600,900' rel='stylesheet' type='text/css'/>
<link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>

<!-- Favicon -->
<link rel="shortcut icon" href="data:image/x-icon;base64,AAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAUAAAAF////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAIAAABbAAAAlQAAAKIAAACbAAAAmwAAAKIAAACVAAAAWwAAAAL///8A////AP///wD///8A////AAAAABQAAADAAAAAYwAAAA3///8A////AP///wD///8AAAAADQAAAGMAAADAAAAAFP///wD///8A////AP///wAAAACdAAAAOv///wD///8A////AP///wD///8A////AP///wD///8AAAAAOgAAAJ3///8A////AP///wAAAAAnAAAAcP///wAAAAAoAAAASv///wD///8A////AP///wAAAABKAAAAKP///wAAAABwAAAAJ////wD///8AAAAAgQAAABwAAACIAAAAkAAAAJMAAACtAAAAFQAAABUAAACtAAAAkwAAAJAAAACIAAAAHAAAAIH///8A////AAAAAKQAAACrAAAAaP///wD///8AAAAARQAAANIAAADSAAAARf///wD///8AAAAAaAAAAKsAAACk////AAAAADMAAACcAAAAnQAAABj///8A////AP///wAAAAAYAAAAGP///wD///8A////AAAAABgAAACdAAAAnAAAADMAAAB1AAAAwwAAAP8AAADpAAAAsQAAAE4AAAAb////AP///wAAAAAbAAAATgAAALEAAADpAAAA/wAAAMMAAAB1AAAAtwAAAOkAAAD/AAAA/wAAAP8AAADvAAAA3gAAAN4AAADeAAAA3gAAAO8AAAD/AAAA/wAAAP8AAADpAAAAtwAAAGUAAAA/AAAA3wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAADfAAAAPwAAAGX///8A////AAAAAEgAAADtAAAAvwAAAL0AAADGAAAA7wAAAO8AAADGAAAAvQAAAL8AAADtAAAASP///wD///8A////AP///wD///8AAAAAO////wD///8A////AAAAAIcAAACH////AP///wD///8AAAAAO////wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A//8AAP//AAD4HwAA7/cAAN/7AAD//wAAoYUAAJ55AACf+QAAh+EAAAAAAADAAwAA4AcAAP5/AAD//wAA//8AAA=="/>
<link rel="icon" type="image/png" sizes="32x32" href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAA3XAAAN1wFCKJt4AAAAB3RJTUUH4QQQEwksSS9ZWwAAAk1JREFUWMPtll2ITVEUx39nn/O7Y5qR8f05wtCUUr6ZIS++8pEnkZInPImneaCQ5METNdOkeFBKUhMPRIkHKfEuUZSUlGlKPN2TrgfncpvmnntnmlEyq1Z7t89/rf9a6+y99oZxGZf/XeIq61EdtgKXgdXA0xrYAvBjOIF1AI9zvjcC74BSpndrJPkBWDScTF8Aa4E3wDlgHbASaANmVqlcCnwHvgDvgVfAJ+AikAAvgfVZwLnSVZHZaOuKoQi3ZOMi4NkYkpe1p4J7A8BpYAD49hfIy/oqG0+hLomiKP2L5L+1ubn5115S+3OAn4EnwBlgMzCjyt6ZAnQCJ4A7wOs88iRJHvw50HoujuPBoCKwHWiosy8MdfZnAdcHk8dxXFJ3VQbQlCTJvRBCGdRbD4M6uc5glpY3eAihpN5S5w12diSEcCCEcKUO4ljdr15T76ur1FDDLIQQ3qv71EdDOe3Kxj3leRXyk+pxdWnFWod6Wt2bY3de3aSuUHcPBVimHs7mK9WrmeOF6lR1o9qnzskh2ar2qm1qizpfXaPeVGdlmGN5pb09qMxz1Xb1kLqgzn1RyH7JUXW52lr5e/Kqi9qpto7V1atuUzfnARrV7jEib1T76gG2qxdGmXyiekkt1GswPTtek0aBfJp6YySGBfWg2tPQ0FAYgf1stUfdmdcjarbYJEniKIq6gY/Aw+zWHAC+p2labGpqiorFYgGYCEzN7oQdQClN07O1/EfDyGgC0ALMBdYAi4FyK+4H3gLPsxfR1zRNi+NP7nH5J+QntnXe5B5mpfQAAAAASUVORK5CYII=">

<!-- CSS -->
<link rel="stylesheet" type="text/css" href="nimdoc.out.css?v=2.3.1">

<!-- JS -->
<script type="text/javascript" src="dochack.js?v=2.3.1"></script>
</head>
<body>
  <div class="document" id="documentId">
    <div class="container">
      <h1 class="title">src/checksums/sha2</h1>
      <div class="row">
  <div class="three columns">
    <div class="theme-select-wrapper">
      <label for="theme-select">Theme:&nbsp;</label>
      <select id="theme-select" onchange="setTheme(this.value)">
        <option value="auto">🌗 Match OS</option>
        <option value="dark">🌑 Dark</option>
        <option value="light">🌕 Light</option>
      </select>
    </div>
    <div id="global-links">
      <ul class="simple-boot">
        <li><a href="manual.html">Manual</a></li>
        <li><a href="lib.html">Standard library</a></li>
        <li> <a id="indexLink" href="theindex.html">Index</a></li>
        <li><a href="compiler/theindex.html">Compiler docs</a></li>
        <li><a href="https://nim-lang.github.io/fusion/theindex.html">Fusion docs</a></li>
        <li><a href="https://nim-lang.github.io/Nim/">devel</a>, <a href="https://nim-lang.org/documentation.html">stable</a></li>
      </ul>
    </div>
    <div id="searchInputDiv">
      Search: <input type="search" id="searchInput"
        oninput="search()" />
    </div>
    
    <ul class="simple simple-toc" id="toc-list">
  <li><a class="reference" id="implemented-algorithms_toc" href="#implemented-algorithms">Implemented Algorithms</a></li>
<li>
  <a class="reference reference-toplevel" href="#6" id="56">Imports</a>
</li>
<li>
  <details open>
    <summary><a class="reference reference-toplevel" href="#7" id="57">Types</a></summary>
    <ul class="simple simple-toc-section">
      <li><a class="reference" href="#ShaDigest_224" title="ShaDigest_224 = array[28, char]">ShaDigest_224</a></li>
<li><a class="reference" href="#ShaDigest_256" title="ShaDigest_256 = array[32, char]">ShaDigest_256</a></li>
<li><a class="reference" href="#ShaDigest_384" title="ShaDigest_384 = array[48, char]">ShaDigest_384</a></li>
<li><a class="reference" href="#ShaDigest_512" title="ShaDigest_512 = array[64, char]">ShaDigest_512</a></li>
<li><a class="reference" href="#ShaInstance" title="ShaInstance = enum
  Sha_224,                  ## SHA-224 with an output size of 28 bytes (truncated from SHA-256)
  Sha_256,                  ## SHA-256 with an output size of 32 bytes
  Sha_384,                  ## SHA-384 with an output size of 48 bytes (truncated from SHA-512)
  Sha_512                    ## SHA-512 with an output size of 64 bytes">ShaInstance</a></li>
<li><a class="reference" href="#ShaState" title="ShaState = distinct ShaContext">ShaState</a></li>
<li><a class="reference" href="#ShaStateStatic" title="ShaStateStatic[instance] = distinct ShaState">ShaStateStatic</a></li>

    </ul>
  </details>
</li>
<li>
  <details open>
    <summary><a class="reference reference-toplevel" href="#12" id="62">Procs</a></summary>
    <ul class="simple simple-toc-section">
      <ul class="simple nested-toc-section">digest
  <li><a class="reference" href="#digest%2CShaState%2CopenArray%5Bchar%5D" title="digest(state: var ShaState; dest: var openArray[char]): int">digest(state: var ShaState; dest: var openArray[char]): int</a></li>
<li><a class="reference" href="#digest%2CShaStateStatic%5BShaInstance%5D" title="digest(state: var ShaStateStatic[Sha_224]): ShaDigest_224">digest(state: var ShaStateStatic[Sha_224]): ShaDigest_224</a></li>
<li><a class="reference" href="#digest%2CShaStateStatic%5BShaInstance%5D_2" title="digest(state: var ShaStateStatic[Sha_256]): ShaDigest_256">digest(state: var ShaStateStatic[Sha_256]): ShaDigest_256</a></li>
<li><a class="reference" href="#digest%2CShaStateStatic%5BShaInstance%5D_3" title="digest(state: var ShaStateStatic[Sha_384]): ShaDigest_384">digest(state: var ShaStateStatic[Sha_384]): ShaDigest_384</a></li>
<li><a class="reference" href="#digest%2CShaStateStatic%5BShaInstance%5D_4" title="digest(state: var ShaStateStatic[Sha_512]): ShaDigest_512">digest(state: var ShaStateStatic[Sha_512]): ShaDigest_512</a></li>

</ul>
<ul class="simple nested-toc-section">digestLength
  <li><a class="reference" href="#digestLength%2CShaInstance" title="digestLength(instance: ShaInstance): int">digestLength(instance: ShaInstance): int</a></li>

</ul>
<ul class="simple nested-toc-section">initSha
  <li><a class="reference" href="#initSha%2CShaInstance" title="initSha(instance: ShaInstance): ShaState">initSha(instance: ShaInstance): ShaState</a></li>

</ul>
<ul class="simple nested-toc-section">initSha_224
  <li><a class="reference" href="#initSha_224" title="initSha_224(): ShaStateStatic[Sha_224]">initSha_224(): ShaStateStatic[Sha_224]</a></li>

</ul>
<ul class="simple nested-toc-section">initSha_256
  <li><a class="reference" href="#initSha_256" title="initSha_256(): ShaStateStatic[Sha_256]">initSha_256(): ShaStateStatic[Sha_256]</a></li>

</ul>
<ul class="simple nested-toc-section">initSha_384
  <li><a class="reference" href="#initSha_384" title="initSha_384(): ShaStateStatic[Sha_384]">initSha_384(): ShaStateStatic[Sha_384]</a></li>

</ul>
<ul class="simple nested-toc-section">initSha_512
  <li><a class="reference" href="#initSha_512" title="initSha_512(): ShaStateStatic[Sha_512]">initSha_512(): ShaStateStatic[Sha_512]</a></li>

</ul>
<ul class="simple nested-toc-section">initShaStateStatic
  <li><a class="reference" href="#initShaStateStatic%2CstaticShaInstance" title="initShaStateStatic(instance: static ShaInstance): ShaStateStatic[instance]">initShaStateStatic(instance: static ShaInstance): ShaStateStatic[instance]</a></li>

</ul>
<ul class="simple nested-toc-section">secureHash
  <li><a class="reference" href="#secureHash%2CShaInstance%2CopenArray%5Bchar%5D" title="secureHash(instance: ShaInstance; data: openArray[char]): seq[char]">secureHash(instance: ShaInstance; data: openArray[char]): seq[char]</a></li>
<li><a class="reference" href="#secureHash%2CstaticShaInstance%2CopenArray%5Bchar%5D" title="secureHash(instance: static ShaInstance; data: openArray[char]): auto">secureHash(instance: static ShaInstance; data: openArray[char]): auto</a></li>

</ul>
<ul class="simple nested-toc-section">update
  <li><a class="reference" href="#update%2CShaState%2CopenArray%5Bchar%5D" title="update(state: var ShaState; data: openArray[char])">update(state: var ShaState; data: openArray[char])</a></li>
<li><a class="reference" href="#update%2CShaStateStatic%5Binstance%5D%2CopenArray%5Bchar%5D" title="update[instance: static ShaInstance](state: var ShaStateStatic[instance];
                                     data: openArray[char])">update[instance: static ShaInstance](state: var ShaStateStatic[instance];
                                     data: openArray[char])</a></li>

</ul>

    </ul>
  </details>
</li>

</ul>

  </div>
  <div class="nine columns" id="content">
    
    <div id="tocRoot"></div>
    
    <p class="module-desc"><p><a class="reference external" href="https://en.wikipedia.org/wiki/SHA-2">SHA-2 (Secure Hash Algorithm 2)</a> is a cryptographic hash function which takes an input and produces a value known as a message digest.</p>
<p>It provides fixed size algorithms that generate a one-shot message digest of a determinate size.</p>

<h1><a class="toc-backref" id="implemented-algorithms" href="#implemented-algorithms">Implemented Algorithms</a></h1><p>Fixed size functions:</p>
<ul class="simple"><li>SHA-224</li>
<li>SHA-256</li>
<li>SHA-384</li>
<li>SHA-512</li>
</ul>
<p>For convenience, this module provides output-length type checked functions for the implemented fixed size functions via <tt class="docutils literal"><span class="pre"><span class="Identifier">initSha_224</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="Identifier">initSha_256</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="Identifier">initSha_384</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">initSha_512</span></span></tt>. These functions provide a <tt class="docutils literal"><span class="pre"><span class="Identifier">digest</span></span></tt> overload returning a correctly sized message digest array.</p>
<p>If more relaxed types are required, an &quot;unchecked&quot; <tt class="docutils literal"><span class="pre"><span class="Identifier">Sha2State</span></span></tt> can be used, but care must be taken to provide <tt class="docutils literal"><span class="pre"><span class="Identifier">digest</span></span></tt> with a correctly sized <tt class="docutils literal"><span class="pre"><span class="Identifier">dest</span></span></tt> array. </p>

<p><strong class="examples_text">Example:</strong></p>
<pre class="listing"><span class="Keyword">import</span> <span class="Identifier">src</span><span class="Operator">/</span><span class="Identifier">checksums</span><span class="Operator">/</span><span class="Identifier">sha2</span>
<span class="Keyword">var</span> <span class="Identifier">hasher</span> <span class="Operator">=</span> <span class="Identifier">initSha_256</span><span class="Punctuation">(</span><span class="Punctuation">)</span>

<span class="Identifier">hasher</span><span class="Operator">.</span><span class="Identifier">update</span><span class="Punctuation">(</span><span class="StringLit">&quot;The quick brown fox &quot;</span><span class="Punctuation">)</span>
<span class="Identifier">hasher</span><span class="Operator">.</span><span class="Identifier">update</span><span class="Punctuation">(</span><span class="StringLit">&quot;jumps over the lazy dog&quot;</span><span class="Punctuation">)</span>

<span class="Keyword">let</span> <span class="Identifier">digest</span> <span class="Operator">=</span> <span class="Identifier">hasher</span><span class="Operator">.</span><span class="Identifier">digest</span><span class="Punctuation">(</span><span class="Punctuation">)</span>

<span class="Identifier">assert</span> <span class="Operator">$</span><span class="Identifier">digest</span> <span class="Operator">==</span> <span class="StringLit">&quot;d7a8fbb307d7809469ca9abcb0082e4f8d5651e46d3cdb762d02d0bf37c9e592&quot;</span></pre>
<p><strong class="examples_text">Example:</strong></p>
<pre class="listing"><span class="Keyword">import</span> <span class="Identifier">src</span><span class="Operator">/</span><span class="Identifier">checksums</span><span class="Operator">/</span><span class="Identifier">sha2</span>
<span class="Keyword">var</span> <span class="Identifier">hasher</span> <span class="Operator">=</span> <span class="Identifier">initSha_384</span><span class="Punctuation">(</span><span class="Punctuation">)</span>

<span class="Identifier">hasher</span><span class="Operator">.</span><span class="Identifier">update</span><span class="Punctuation">(</span><span class="StringLit">&quot;The quick brown fox &quot;</span><span class="Punctuation">)</span>
<span class="Identifier">hasher</span><span class="Operator">.</span><span class="Identifier">update</span><span class="Punctuation">(</span><span class="StringLit">&quot;jumps over the lazy dog&quot;</span><span class="Punctuation">)</span>

<span class="Keyword">let</span> <span class="Identifier">digest</span> <span class="Operator">=</span> <span class="Identifier">hasher</span><span class="Operator">.</span><span class="Identifier">digest</span><span class="Punctuation">(</span><span class="Punctuation">)</span>

<span class="Identifier">assert</span> <span class="Operator">$</span><span class="Identifier">digest</span> <span class="Operator">==</span> <span class="StringLit">&quot;ca737f1014a48f4c0b6dd43cb177b0afd9e5169367544c494011e3317dbf9a509cb1e5dc1e85a941bbee3d7f2afbc9b1&quot;</span></pre></p>
    <div class="section" id="6">
  <h1><a class="toc-backref" href="#6">Imports</a></h1>
  <dl class="item">
    <a class="reference external" href="sha_utils.html">sha_utils</a>
  </dl>
</div>
<div class="section" id="7">
  <h1><a class="toc-backref" href="#7">Types</a></h1>
  <dl class="item">
    <div id="ShaDigest_224">
  <dt><pre><a href="sha2.html#ShaDigest_224"><span class="Identifier">ShaDigest_224</span></a> <span class="Other">=</span> <span class="Identifier">array</span><span class="Other">[</span><span class="DecNumber">28</span><span class="Other">,</span> <span class="Identifier">char</span><span class="Other">]</span></pre></dt>
  <dd>
    
    SHA-224 output digest.
    
  </dd>
</div>
<div id="ShaDigest_256">
  <dt><pre><a href="sha2.html#ShaDigest_256"><span class="Identifier">ShaDigest_256</span></a> <span class="Other">=</span> <span class="Identifier">array</span><span class="Other">[</span><span class="DecNumber">32</span><span class="Other">,</span> <span class="Identifier">char</span><span class="Other">]</span></pre></dt>
  <dd>
    
    SHA-256 output digest.
    
  </dd>
</div>
<div id="ShaDigest_384">
  <dt><pre><a href="sha2.html#ShaDigest_384"><span class="Identifier">ShaDigest_384</span></a> <span class="Other">=</span> <span class="Identifier">array</span><span class="Other">[</span><span class="DecNumber">48</span><span class="Other">,</span> <span class="Identifier">char</span><span class="Other">]</span></pre></dt>
  <dd>
    
    SHA-384 output digest.
    
  </dd>
</div>
<div id="ShaDigest_512">
  <dt><pre><a href="sha2.html#ShaDigest_512"><span class="Identifier">ShaDigest_512</span></a> <span class="Other">=</span> <span class="Identifier">array</span><span class="Other">[</span><span class="DecNumber">64</span><span class="Other">,</span> <span class="Identifier">char</span><span class="Other">]</span></pre></dt>
  <dd>
    
    SHA-512 output digest.
    
  </dd>
</div>
<div id="ShaInstance">
  <dt><pre><a href="sha2.html#ShaInstance"><span class="Identifier">ShaInstance</span></a> <span class="Other">=</span> <span class="Keyword">enum</span>
  <span class="Identifier">Sha_224</span><span class="Other">,</span>                  <span class="Comment">## SHA-224 with an output size of 28 bytes (truncated from SHA-256)</span>
  <span class="Identifier">Sha_256</span><span class="Other">,</span>                  <span class="Comment">## SHA-256 with an output size of 32 bytes</span>
  <span class="Identifier">Sha_384</span><span class="Other">,</span>                  <span class="Comment">## SHA-384 with an output size of 48 bytes (truncated from SHA-512)</span>
  <span class="Identifier">Sha_512</span>                    <span class="Comment">## SHA-512 with an output size of 64 bytes</span></pre></dt>
  <dd>
    
    Selects a specific SHA instance with well known message digest lengths and properties.
    
  </dd>
</div>
<div id="ShaState">
  <dt><pre><a href="sha2.html#ShaState"><span class="Identifier">ShaState</span></a> <span class="Other">=</span> <span class="Keyword">distinct</span> <span class="Identifier">ShaContext</span></pre></dt>
  <dd>
    
    <p>An unchecked SHA state created from a specific <tt class="docutils literal"><span class="pre"><span class="Identifier">ShaInstance</span></span></tt>.</p>
<p>Unchecked meaning the user has to make sure that the target buffer has enough room to store the resulting digest, otherwise <tt class="docutils literal"><span class="pre"><span class="Identifier">digest</span></span></tt> will truncate the output.</p>

    
  </dd>
</div>
<div id="ShaStateStatic">
  <dt><pre><a href="sha2.html#ShaStateStatic"><span class="Identifier">ShaStateStatic</span></a><span class="Other">[</span><span class="Identifier">instance</span><span class="Other">]</span> <span class="Other">=</span> <span class="Keyword">distinct</span> <a href="sha2.html#ShaState"><span class="Identifier">ShaState</span></a></pre></dt>
  <dd>
    
    A statically checked SHA state created from a specific <tt class="docutils literal"><span class="pre"><span class="Identifier">ShaInstance</span></span></tt>.
    
  </dd>
</div>

  </dl>
</div>
<div class="section" id="12">
  <h1><a class="toc-backref" href="#12">Procs</a></h1>
  <dl class="item">
    <div id="digest-procs-all">
  <div id="digest,ShaState,openArray[char]">
  <dt><pre><span class="Keyword">proc</span> <a href="#digest%2CShaState%2CopenArray%5Bchar%5D"><span class="Identifier">digest</span></a><span class="Other">(</span><span class="Identifier">state</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="sha2.html#ShaState"><span class="Identifier">ShaState</span></a><span class="Other">;</span> <span class="Identifier">dest</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Identifier">openArray</span><span class="Other">[</span><span class="Identifier">char</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">int</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  <dd>
    
    <p>Finishes, stores the completed message digest in <tt class="docutils literal"><span class="pre"><span class="Identifier">dest</span></span></tt> and returns the number of bytes written in <tt class="docutils literal"><span class="pre"><span class="Identifier">dest</span></span></tt>.</p>
<p>If <tt class="docutils literal"><span class="pre"><span class="Identifier">dest</span></span></tt> is not big enough to contain the digest produced by the selected instance, everything that would overflow is truncated.</p>

    
  </dd>
</div>
<div id="digest,ShaStateStatic[ShaInstance]">
  <dt><pre><span class="Keyword">proc</span> <a href="#digest%2CShaStateStatic%5BShaInstance%5D"><span class="Identifier">digest</span></a><span class="Other">(</span><span class="Identifier">state</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="sha2.html#ShaStateStatic"><span class="Identifier">ShaStateStatic</span></a><span class="Other">[</span><span class="Identifier">Sha_224</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="sha2.html#ShaDigest_224"><span class="Identifier">ShaDigest_224</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  <dd>
    
    Finishes and returns the completed SHA-224 message digest.
    
  </dd>
</div>
<div id="digest,ShaStateStatic[ShaInstance]_2">
  <dt><pre><span class="Keyword">proc</span> <a href="#digest%2CShaStateStatic%5BShaInstance%5D_2"><span class="Identifier">digest</span></a><span class="Other">(</span><span class="Identifier">state</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="sha2.html#ShaStateStatic"><span class="Identifier">ShaStateStatic</span></a><span class="Other">[</span><span class="Identifier">Sha_256</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="sha2.html#ShaDigest_256"><span class="Identifier">ShaDigest_256</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  <dd>
    
    Finishes and returns the completed SHA-256 message digest.
    
  </dd>
</div>
<div id="digest,ShaStateStatic[ShaInstance]_3">
  <dt><pre><span class="Keyword">proc</span> <a href="#digest%2CShaStateStatic%5BShaInstance%5D_3"><span class="Identifier">digest</span></a><span class="Other">(</span><span class="Identifier">state</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="sha2.html#ShaStateStatic"><span class="Identifier">ShaStateStatic</span></a><span class="Other">[</span><span class="Identifier">Sha_384</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="sha2.html#ShaDigest_384"><span class="Identifier">ShaDigest_384</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  <dd>
    
    Finishes and returns the completed SHA-284 message digest.
    
  </dd>
</div>
<div id="digest,ShaStateStatic[ShaInstance]_4">
  <dt><pre><span class="Keyword">proc</span> <a href="#digest%2CShaStateStatic%5BShaInstance%5D_4"><span class="Identifier">digest</span></a><span class="Other">(</span><span class="Identifier">state</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="sha2.html#ShaStateStatic"><span class="Identifier">ShaStateStatic</span></a><span class="Other">[</span><span class="Identifier">Sha_512</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="sha2.html#ShaDigest_512"><span class="Identifier">ShaDigest_512</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  <dd>
    
    Finishes and returns the completed SHA-512 message digest.
    
  </dd>
</div>

</div>
<div id="digestLength-procs-all">
  <div id="digestLength,ShaInstance">
  <dt><pre><span class="Keyword">func</span> <a href="#digestLength%2CShaInstance"><span class="Identifier">digestLength</span></a><span class="Other">(</span><span class="Identifier">instance</span><span class="Other">:</span> <a href="sha2.html#ShaInstance"><span class="Identifier">ShaInstance</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">int</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  <dd>
    
    Returns the message digest size for the selected SHA instance.
    
  </dd>
</div>

</div>
<div id="initSha-procs-all">
  <div id="initSha,ShaInstance">
  <dt><pre><span class="Keyword">func</span> <a href="#initSha%2CShaInstance"><span class="Identifier">initSha</span></a><span class="Other">(</span><span class="Identifier">instance</span><span class="Other">:</span> <a href="sha2.html#ShaInstance"><span class="Identifier">ShaInstance</span></a><span class="Other">)</span><span class="Other">:</span> <a href="sha2.html#ShaState"><span class="Identifier">ShaState</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  <dd>
    
    Constructs a new unchecked SHA state for the selected instance <tt class="docutils literal"><span class="pre"><span class="Identifier">instance</span></span></tt>.
    
  </dd>
</div>

</div>
<div id="initSha_224-procs-all">
  <div id="initSha_224">
  <dt><pre><span class="Keyword">func</span> <a href="#initSha_224"><span class="Identifier">initSha_224</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="sha2.html#ShaStateStatic"><span class="Identifier">ShaStateStatic</span></a><span class="Other">[</span><span class="Identifier">Sha_224</span><span class="Other">]</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  <dd>
    
    Constructs a new statically checked state for the SHA-224 instance.
    
  </dd>
</div>

</div>
<div id="initSha_256-procs-all">
  <div id="initSha_256">
  <dt><pre><span class="Keyword">func</span> <a href="#initSha_256"><span class="Identifier">initSha_256</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="sha2.html#ShaStateStatic"><span class="Identifier">ShaStateStatic</span></a><span class="Other">[</span><span class="Identifier">Sha_256</span><span class="Other">]</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  <dd>
    
    Constructs a new statically checked state for the SHA-256 instance.
    
  </dd>
</div>

</div>
<div id="initSha_384-procs-all">
  <div id="initSha_384">
  <dt><pre><span class="Keyword">func</span> <a href="#initSha_384"><span class="Identifier">initSha_384</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="sha2.html#ShaStateStatic"><span class="Identifier">ShaStateStatic</span></a><span class="Other">[</span><span class="Identifier">Sha_384</span><span class="Other">]</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  <dd>
    
    Constructs a new statically checked state for the SHA-384 instance.
    
  </dd>
</div>

</div>
<div id="initSha_512-procs-all">
  <div id="initSha_512">
  <dt><pre><span class="Keyword">func</span> <a href="#initSha_512"><span class="Identifier">initSha_512</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="sha2.html#ShaStateStatic"><span class="Identifier">ShaStateStatic</span></a><span class="Other">[</span><span class="Identifier">Sha_512</span><span class="Other">]</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  <dd>
    
    Constructs a new statically checked state for the SHA-512 instance.
    
  </dd>
</div>

</div>
<div id="initShaStateStatic-procs-all">
  <div id="initShaStateStatic,staticShaInstance">
  <dt><pre><span class="Keyword">func</span> <a href="#initShaStateStatic%2CstaticShaInstance"><span class="Identifier">initShaStateStatic</span></a><span class="Other">(</span><span class="Identifier">instance</span><span class="Other">:</span> <span class="Identifier">static</span> <span class="Identifier">ShaInstance</span><span class="Other">)</span><span class="Other">:</span> <a href="sha2.html#ShaStateStatic"><span class="Identifier">ShaStateStatic</span></a><span class="Other">[</span><span class="Identifier">instance</span><span class="Other">]</span></pre></dt>
  <dd>
    
    Constructs a new statically checked SHA state for the selected instance <tt class="docutils literal"><span class="pre"><span class="Identifier">instance</span></span></tt>.
    
  </dd>
</div>

</div>
<div id="secureHash-procs-all">
  <div id="secureHash,ShaInstance,openArray[char]">
  <dt><pre><span class="Keyword">proc</span> <a href="#secureHash%2CShaInstance%2CopenArray%5Bchar%5D"><span class="Identifier">secureHash</span></a><span class="Other">(</span><span class="Identifier">instance</span><span class="Other">:</span> <a href="sha2.html#ShaInstance"><span class="Identifier">ShaInstance</span></a><span class="Other">;</span> <span class="Identifier">data</span><span class="Other">:</span> <span class="Identifier">openArray</span><span class="Other">[</span><span class="Identifier">char</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">char</span><span class="Other">]</span> {.
    <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  <dd>
    
    Convenience wrapper around the standard &quot;init, update, digest&quot; sequence with a runtime selected SHA instance.
    
  </dd>
</div>
<div id="secureHash,staticShaInstance,openArray[char]">
  <dt><pre><span class="Keyword">proc</span> <a href="#secureHash%2CstaticShaInstance%2CopenArray%5Bchar%5D"><span class="Identifier">secureHash</span></a><span class="Other">(</span><span class="Identifier">instance</span><span class="Other">:</span> <span class="Identifier">static</span> <span class="Identifier">ShaInstance</span><span class="Other">;</span> <span class="Identifier">data</span><span class="Other">:</span> <span class="Identifier">openArray</span><span class="Other">[</span><span class="Identifier">char</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">auto</span></pre></dt>
  <dd>
    
    Convenience wrapper around the standard &quot;init, update, digest&quot; sequence with a statically selected SHA instance.
    
  </dd>
</div>

</div>
<div id="update-procs-all">
  <div id="update,ShaState,openArray[char]">
  <dt><pre><span class="Keyword">proc</span> <a href="#update%2CShaState%2CopenArray%5Bchar%5D"><span class="Identifier">update</span></a><span class="Other">(</span><span class="Identifier">state</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="sha2.html#ShaState"><span class="Identifier">ShaState</span></a><span class="Other">;</span> <span class="Identifier">data</span><span class="Other">:</span> <span class="Identifier">openArray</span><span class="Other">[</span><span class="Identifier">char</span><span class="Other">]</span><span class="Other">)</span> {.<span class="Identifier">borrow</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  <dd>
    
    Updates the given <tt class="docutils literal"><span class="pre"><span class="Identifier">ShaState</span></span></tt> with the provided buffer <tt class="docutils literal"><span class="pre"><span class="Identifier">data</span></span></tt>.
    
  </dd>
</div>
<div id="update,ShaStateStatic[instance],openArray[char]">
  <dt><pre><span class="Keyword">proc</span> <a href="#update%2CShaStateStatic%5Binstance%5D%2CopenArray%5Bchar%5D"><span class="Identifier">update</span></a><span class="Other">[</span><span class="Identifier">instance</span><span class="Other">:</span> <span class="Identifier">static</span> <span class="Identifier">ShaInstance</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">state</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="sha2.html#ShaStateStatic"><span class="Identifier">ShaStateStatic</span></a><span class="Other">[</span><span class="Identifier">instance</span><span class="Other">]</span><span class="Other">;</span>
    <span class="Identifier">data</span><span class="Other">:</span> <span class="Identifier">openArray</span><span class="Other">[</span><span class="Identifier">char</span><span class="Other">]</span><span class="Other">)</span></pre></dt>
  <dd>
    
    Updates the given <tt class="docutils literal"><span class="pre"><span class="Identifier">ShaStateStatic</span></span></tt> with the provided buffer <tt class="docutils literal"><span class="pre"><span class="Identifier">data</span></span></tt>.
    
  </dd>
</div>

</div>

  </dl>
</div>

  </div>
</div>

      <div class="twelve-columns footer">
        <span class="nim-sprite"></span>
        <br>
        <small style="color: var(--hint);">Made with Nim. Generated: 2025-02-03 14:57:40 UTC</small>
      </div>
    </div>
  </div>
      <script defer data-domain="nim-lang.org" src="https://plausible.io/js/plausible.js"></script>
    
</body>
</html>