Halaman utama Jelajahi Bantuan
Masuk
levovix
/
Nim
cermin dari https://github.com/nim-lang/Nim
Liatin 1
Bintangi 0
Fork 1
Berkas Masalah 0 Wiki
Cabang: gh-pages
Ranting Tag
Nim
/
sha1.html

sha1.html 29 KB
Permalink Riwayat Mentahan

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339 
  1. <?xml version="1.0" encoding="utf-8" ?>
    2. 

  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    3. 

  3. <!--  This file is generated by Nim. -->
    4. 

  4. <html xmlns="https://www.w3.org/1999/xhtml" xml:lang="en" lang="en" data-theme="auto">
    5. 

  5. <head>
    6. 

  6. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    7. 

  7. <meta name="viewport" content="width=device-width, initial-scale=1.0">
    8. 

  8. <title>src/checksums/sha1</title>
    9. 

  9. 

  10. <!-- Google fonts -->
    11. 

  11. <link href='https://fonts.googleapis.com/css?family=Lato:400,600,900' rel='stylesheet' type='text/css'/>
    12. 

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

  13. 

  14. <!-- Favicon -->
    15. 

  15. <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=="/>
    16. 

  16. <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=">
    17. 

  17. 

  18. <!-- CSS -->
    19. 

  19. <link rel="stylesheet" type="text/css" href="nimdoc.out.css?v=2.3.1">
    20. 

  20. 

  21. <!-- JS -->
    22. 

  22. <script type="text/javascript" src="dochack.js?v=2.3.1"></script>
    23. 

  23. </head>
    24. 

  24. <body>
    25. 

  25.   <div class="document" id="documentId">
    26. 

  26.     <div class="container">
    27. 

  27.       <h1 class="title">src/checksums/sha1</h1>
    28. 

  28.       <div class="row">
    29. 

  29.   <div class="three columns">
    30. 

  30.     <div class="theme-select-wrapper">
    31. 

  31.       <label for="theme-select">Theme:&nbsp;</label>
    32. 

  32.       <select id="theme-select" onchange="setTheme(this.value)">
    33. 

  33.         <option value="auto">🌗 Match OS</option>
    34. 

  34.         <option value="dark">🌑 Dark</option>
    35. 

  35.         <option value="light">🌕 Light</option>
    36. 

  36.       </select>
    37. 

  37.     </div>
    38. 

  38.     <div id="global-links">
    39. 

  39.       <ul class="simple-boot">
    40. 

  40.         <li><a href="manual.html">Manual</a></li>
    41. 

  41.         <li><a href="lib.html">Standard library</a></li>
    42. 

  42.         <li> <a id="indexLink" href="theindex.html">Index</a></li>
    43. 

  43.         <li><a href="compiler/theindex.html">Compiler docs</a></li>
    44. 

  44.         <li><a href="https://nim-lang.github.io/fusion/theindex.html">Fusion docs</a></li>
    45. 

  45.         <li><a href="https://nim-lang.github.io/Nim/">devel</a>, <a href="https://nim-lang.org/documentation.html">stable</a></li>
    46. 

  46.       </ul>
    47. 

  47.     </div>
    48. 

  48.     <div id="searchInputDiv">
    49. 

  49.       Search: <input type="search" id="searchInput"
    50. 

  50.         oninput="search()" />
    51. 

  51.     </div>
    52. 

  52.     
    53. 

  53.     <ul class="simple simple-toc" id="toc-list">
    54. 

  54.   <li><a class="reference" id="see-also_toc" href="#see-also">See also</a></li>
    55. 

  55. <li>
    56. 

  56.   <details open>
    57. 

  57.     <summary><a class="reference reference-toplevel" href="#7" id="57">Types</a></summary>
    58. 

  58.     <ul class="simple simple-toc-section">
    59. 

  59.       <li><a class="reference" href="#SecureHash" title="SecureHash = distinct Sha1Digest">SecureHash</a></li>
    60. 

  60. <li><a class="reference" href="#Sha1Digest" title="Sha1Digest = array[0 .. 20 - 1, uint8]">Sha1Digest</a></li>
    61. 

  61. <li><a class="reference" href="#Sha1State" title="Sha1State = object">Sha1State</a></li>
    62. 

  62. 

  63.     </ul>
    64. 

  64.   </details>
    65. 

  65. </li>
    66. 

  66. <li>
    67. 

  67.   <details open>
    68. 

  68.     <summary><a class="reference reference-toplevel" href="#12" id="62">Procs</a></summary>
    69. 

  69.     <ul class="simple simple-toc-section">
    70. 

  70.       <ul class="simple nested-toc-section">$
    71. 

  71.   <li><a class="reference" href="#%24%2CSecureHash" title="`$`(self: SecureHash): string">`$`(self: SecureHash): string</a></li>
    72. 

  72. 

  73. </ul>
    74. 

  74. <ul class="simple nested-toc-section">==
    75. 

  75.   <li><a class="reference" href="#%3D%3D%2CSecureHash%2CSecureHash" title="`==`(a, b: SecureHash): bool">`==`(a, b: SecureHash): bool</a></li>
    76. 

  76. 

  77. </ul>
    78. 

  78. <ul class="simple nested-toc-section">finalize
    79. 

  79.   <li><a class="reference" href="#finalize%2CSha1State" title="finalize(ctx: var Sha1State): Sha1Digest">finalize(ctx: var Sha1State): Sha1Digest</a></li>
    80. 

  80. 

  81. </ul>
    82. 

  82. <ul class="simple nested-toc-section">isValidSha1Hash
    83. 

  83.   <li><a class="reference" href="#isValidSha1Hash%2Cstring" title="isValidSha1Hash(s: string): bool">isValidSha1Hash(s: string): bool</a></li>
    84. 

  84. 

  85. </ul>
    86. 

  86. <ul class="simple nested-toc-section">newSha1State
    87. 

  87.   <li><a class="reference" href="#newSha1State" title="newSha1State(): Sha1State">newSha1State(): Sha1State</a></li>
    88. 

  88. 

  89. </ul>
    90. 

  90. <ul class="simple nested-toc-section">parseSecureHash
    91. 

  91.   <li><a class="reference" href="#parseSecureHash%2Cstring" title="parseSecureHash(hash: string): SecureHash">parseSecureHash(hash: string): SecureHash</a></li>
    92. 

  92. 

  93. </ul>
    94. 

  94. <ul class="simple nested-toc-section">secureHash
    95. 

  95.   <li><a class="reference" href="#secureHash%2CopenArray%5Bchar%5D" title="secureHash(str: openArray[char]): SecureHash">secureHash(str: openArray[char]): SecureHash</a></li>
    96. 

  96. 

  97. </ul>
    98. 

  98. <ul class="simple nested-toc-section">secureHashFile
    99. 

  99.   <li><a class="reference" href="#secureHashFile%2Cstring" title="secureHashFile(filename: string): SecureHash">secureHashFile(filename: string): SecureHash</a></li>
    100. 

  100. 

  101. </ul>
    102. 

  102. <ul class="simple nested-toc-section">update
    103. 

  103.   <li><a class="reference" href="#update%2CSha1State%2CopenArray%5Bchar%5D" title="update(ctx: var Sha1State; data: openArray[char])">update(ctx: var Sha1State; data: openArray[char])</a></li>
    104. 

  104. 

  105. </ul>
    106. 

  106. 

  107.     </ul>
    108. 

  108.   </details>
    109. 

  109. </li>
    110. 

  110. 

  111. </ul>
    112. 

  112. 

  113.   </div>
    114. 

  114.   <div class="nine columns" id="content">
    115. 

  115.     
    116. 

  116.     <div id="tocRoot"></div>
    117. 

  117.     
    118. 

  118.     <p class="module-desc"><div class="admonition admonition-info"><span class="admonition-info-text"><b>Note:</b></span>
    119. 

  119. In order to use this module, run <tt class="docutils literal"><span class="pre"><span class="Identifier">nimble</span> <span class="Identifier">install</span> <span class="Identifier">checksums</span></span></tt>.</div>
    120. 

  120. <p><a class="reference external" href="https://en.wikipedia.org/wiki/SHA-1">SHA-1 (Secure Hash Algorithm 1)</a> is a cryptographic hash function which takes an input and produces a 160-bit (20-byte) hash value known as a message digest.</p>
    121. 

  121. <p>Please note that SHA-1 has been formally deprecated since 2011 and it is strongly recommended to switch to stronger hash functions such as the SHA-2 or SHA-3 family.</p>
    122. 

  122. <p>Even though SHA-1 is <em>formally</em> deprecated, this module itself is not deprecated and will continue to be usable.</p>
    123. 

  123. 

  124. <h1><a class="toc-backref" id="see-also" href="#see-also">See also</a></h1><ul class="simple"><li><a class="reference external" href="base64.html">base64 module</a> for a Base64 encoder and decoder</li>
    125. 

  125. <li><a class="reference external" href="hashes.html">hashes module</a> for efficient computations of hash values for diverse Nim types</li>
    126. 

  126. <li><a class="reference external" href="md5.html">md5 module</a> for the MD5 checksum algorithm</li>
    127. 

  127. <li><a class="reference external" href="sha2.html">sha2 module</a> for the newer hash familiy SHA-2</li>
    128. 

  128. <li><a class="reference external" href="sha3.html">sha3 module</a> for the newest hash family SHA-3</li>
    129. 

  129. </ul>
    130. 

  130. 

  131. <p><strong class="examples_text">Example:</strong></p>
    132. 

  132. <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">sha1</span>
    133. 

  133. <span class="Keyword">let</span> <span class="Identifier">accessName</span> <span class="Operator">=</span> <span class="Identifier">secureHash</span><span class="Punctuation">(</span><span class="StringLit">&quot;John Doe&quot;</span><span class="Punctuation">)</span>
    134. 

  134. <span class="Identifier">assert</span> <span class="Operator">$</span><span class="Identifier">accessName</span> <span class="Operator">==</span> <span class="StringLit">&quot;AE6E4D1209F17B460503904FAD297B31E9CF6362&quot;</span></pre>
    135. 

  135. <p><strong class="examples_text">Example: cmd: -r:off</strong></p>
    136. 

  136. <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">sha1</span>
    137. 

  137. <span class="Keyword">let</span>
    138. 

  138.   <span class="Identifier">a</span> <span class="Operator">=</span> <span class="Identifier">secureHashFile</span><span class="Punctuation">(</span><span class="StringLit">&quot;myFile.nim&quot;</span><span class="Punctuation">)</span>
    139. 

  139.   <span class="Identifier">b</span> <span class="Operator">=</span> <span class="Identifier">parseSecureHash</span><span class="Punctuation">(</span><span class="StringLit">&quot;10DFAEBF6BFDBC7939957068E2EFACEC4972933C&quot;</span><span class="Punctuation">)</span>
    140. 

  140. <span class="Identifier">assert</span> <span class="Identifier">a</span> <span class="Operator">==</span> <span class="Identifier">b</span><span class="Punctuation">,</span> <span class="StringLit">&quot;files don't match&quot;</span></pre></p>
    141. 

  141.     <div class="section" id="7">
    142. 

  142.   <h1><a class="toc-backref" href="#7">Types</a></h1>
    143. 

  143.   <dl class="item">
    144. 

  144.     <div id="SecureHash">
    145. 

  145.   <dt><pre><a href="sha1.html#SecureHash"><span class="Identifier">SecureHash</span></a> <span class="Other">=</span> <span class="Keyword">distinct</span> <a href="sha1.html#Sha1Digest"><span class="Identifier">Sha1Digest</span></a></pre></dt>
    146. 

  146.   <dd>
    147. 

  147.     
    148. 

  148.     
    149. 

  149.     
    150. 

  150.   </dd>
    151. 

  151. </div>
    152. 

  152. <div id="Sha1Digest">
    153. 

  153.   <dt><pre><a href="sha1.html#Sha1Digest"><span class="Identifier">Sha1Digest</span></a> <span class="Other">=</span> <span class="Identifier">array</span><span class="Other">[</span><span class="DecNumber">0</span> <span class="Operator">..</span> <span class="DecNumber">20</span> <span class="Operator">-</span> <span class="DecNumber">1</span><span class="Other">,</span> <span class="Identifier">uint8</span><span class="Other">]</span></pre></dt>
    154. 

  154.   <dd>
    155. 

  155.     
    156. 

  156.     
    157. 

  157.     
    158. 

  158.   </dd>
    159. 

  159. </div>
    160. 

  160. <div id="Sha1State">
    161. 

  161.   <dt><pre><a href="sha1.html#Sha1State"><span class="Identifier">Sha1State</span></a> <span class="Other">=</span> <span class="Keyword">object</span></pre></dt>
    162. 

  162.   <dd>
    163. 

  163.     
    164. 

  164.     
    165. 

  165.     
    166. 

  166.   </dd>
    167. 

  167. </div>
    168. 

  168. 

  169.   </dl>
    170. 

  170. </div>
    171. 

  171. <div class="section" id="12">
    172. 

  172.   <h1><a class="toc-backref" href="#12">Procs</a></h1>
    173. 

  173.   <dl class="item">
    174. 

  174.     <div id="$-procs-all">
    175. 

  175.   <div id="$,SecureHash">
    176. 

  176.   <dt><pre><span class="Keyword">proc</span> <a href="#%24%2CSecureHash"><span class="Identifier">`$`</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="sha1.html#SecureHash"><span class="Identifier">SecureHash</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">string</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>
    177. 

  177.   <dd>
    178. 

  178.     
    179. 

  179.     <p>Returns the string representation of a <tt class="docutils literal"><span class="pre"><span class="Identifier">SecureHash</span></span></tt>.</p>
    180. 

  180. <p><strong>See also:</strong></p>
    181. 

  181. <ul class="simple"><li><a class="reference external" href="#secureHash,openArray[char]">secureHash proc</a> for generating a <tt class="docutils literal"><span class="pre"><span class="Identifier">SecureHash</span></span></tt> from a string</li>
    182. 

  182. </ul>
    183. 

  183. 

  184. <p><strong class="examples_text">Example:</strong></p>
    185. 

  185. <pre class="listing"><span class="Keyword">let</span> <span class="Identifier">hash</span> <span class="Operator">=</span> <span class="Identifier">secureHash</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello World&quot;</span><span class="Punctuation">)</span>
    186. 

  186. <span class="Identifier">assert</span> <span class="Operator">$</span><span class="Identifier">hash</span> <span class="Operator">==</span> <span class="StringLit">&quot;0A4D55A8D778E5022FAB701977C5D840BBC486D0&quot;</span></pre>
    187. 

  187.     
    188. 

  188.   </dd>
    189. 

  189. </div>
    190. 

  190. 

  191. </div>
    192. 

  192. <div id="==-procs-all">
    193. 

  193.   <div id="==,SecureHash,SecureHash">
    194. 

  194.   <dt><pre><span class="Keyword">proc</span> <a href="#%3D%3D%2CSecureHash%2CSecureHash"><span class="Identifier">`==`</span></a><span class="Other">(</span><span class="Identifier">a</span><span class="Other">,</span> <span class="Identifier">b</span><span class="Other">:</span> <a href="sha1.html#SecureHash"><span class="Identifier">SecureHash</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">bool</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>
    195. 

  195.   <dd>
    196. 

  196.     
    197. 

  197.     Checks if two <tt class="docutils literal"><span class="pre"><span class="Identifier">SecureHash</span></span></tt> values are identical.
    198. 

  198. <p><strong class="examples_text">Example:</strong></p>
    199. 

  199. <pre class="listing"><span class="Keyword">let</span>
    200. 

  200.   <span class="Identifier">a</span> <span class="Operator">=</span> <span class="Identifier">secureHash</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello World&quot;</span><span class="Punctuation">)</span>
    201. 

  201.   <span class="Identifier">b</span> <span class="Operator">=</span> <span class="Identifier">secureHash</span><span class="Punctuation">(</span><span class="StringLit">&quot;Goodbye World&quot;</span><span class="Punctuation">)</span>
    202. 

  202.   <span class="Identifier">c</span> <span class="Operator">=</span> <span class="Identifier">parseSecureHash</span><span class="Punctuation">(</span><span class="StringLit">&quot;0A4D55A8D778E5022FAB701977C5D840BBC486D0&quot;</span><span class="Punctuation">)</span>
    203. 

  203. <span class="Identifier">assert</span> <span class="Identifier">a</span> <span class="Operator">!=</span> <span class="Identifier">b</span>
    204. 

  204. <span class="Identifier">assert</span> <span class="Identifier">a</span> <span class="Operator">==</span> <span class="Identifier">c</span></pre>
    205. 

  205.     
    206. 

  206.   </dd>
    207. 

  207. </div>
    208. 

  208. 

  209. </div>
    210. 

  210. <div id="finalize-procs-all">
    211. 

  211.   <div id="finalize,Sha1State">
    212. 

  212.   <dt><pre><span class="Keyword">proc</span> <a href="#finalize%2CSha1State"><span class="Identifier">finalize</span></a><span class="Other">(</span><span class="Identifier">ctx</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="sha1.html#Sha1State"><span class="Identifier">Sha1State</span></a><span class="Other">)</span><span class="Other">:</span> <a href="sha1.html#Sha1Digest"><span class="Identifier">Sha1Digest</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>
    213. 

  213.     <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    214. 

  214.   <dd>
    215. 

  215.     
    216. 

  216.     <p>Finalizes the <tt class="docutils literal"><span class="pre"><span class="Identifier">Sha1State</span></span></tt> and returns a <tt class="docutils literal"><span class="pre"><span class="Identifier">Sha1Digest</span></span></tt>.</p>
    217. 

  217. <p>If you use the <a class="reference external" href="#secureHash,openArray[char]">secureHash proc</a>, there's no need to call this function explicitly.</p>
    218. 

  218. 

  219.     
    220. 

  220.   </dd>
    221. 

  221. </div>
    222. 

  222. 

  223. </div>
    224. 

  224. <div id="isValidSha1Hash-procs-all">
    225. 

  225.   <div id="isValidSha1Hash,string">
    226. 

  226.   <dt><pre><span class="Keyword">proc</span> <a href="#isValidSha1Hash%2Cstring"><span class="Identifier">isValidSha1Hash</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">bool</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>
    227. 

  227.   <dd>
    228. 

  228.     
    229. 

  229.     Checks if a string is a valid sha1 hash sum.
    230. 

  230.     
    231. 

  231.   </dd>
    232. 

  232. </div>
    233. 

  233. 

  234. </div>
    235. 

  235. <div id="newSha1State-procs-all">
    236. 

  236.   <div id="newSha1State">
    237. 

  237.   <dt><pre><span class="Keyword">proc</span> <a href="#newSha1State"><span class="Identifier">newSha1State</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="sha1.html#Sha1State"><span class="Identifier">Sha1State</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>
    238. 

  238.   <dd>
    239. 

  239.     
    240. 

  240.     <p>Creates a <tt class="docutils literal"><span class="pre"><span class="Identifier">Sha1State</span></span></tt>.</p>
    241. 

  241. <p>If you use the <a class="reference external" href="#secureHash,openArray[char]">secureHash proc</a>, there's no need to call this function explicitly.</p>
    242. 

  242. 

  243.     
    244. 

  244.   </dd>
    245. 

  245. </div>
    246. 

  246. 

  247. </div>
    248. 

  248. <div id="parseSecureHash-procs-all">
    249. 

  249.   <div id="parseSecureHash,string">
    250. 

  250.   <dt><pre><span class="Keyword">proc</span> <a href="#parseSecureHash%2Cstring"><span class="Identifier">parseSecureHash</span></a><span class="Other">(</span><span class="Identifier">hash</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">)</span><span class="Other">:</span> <a href="sha1.html#SecureHash"><span class="Identifier">SecureHash</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="Identifier">ValueError</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>
    251. 

  251.     <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    252. 

  252.   <dd>
    253. 

  253.     
    254. 

  254.     <p>Converts a string <tt class="docutils literal"><span class="pre"><span class="Identifier">hash</span></span></tt> to a <tt class="docutils literal"><span class="pre"><span class="Identifier">SecureHash</span></span></tt>.</p>
    255. 

  255. <p><strong>See also:</strong></p>
    256. 

  256. <ul class="simple"><li><a class="reference external" href="#secureHash,openArray[char]">secureHash proc</a> for generating a <tt class="docutils literal"><span class="pre"><span class="Identifier">SecureHash</span></span></tt> from a string</li>
    257. 

  257. <li><a class="reference external" href="#secureHashFile,string">secureHashFile proc</a> for generating a <tt class="docutils literal"><span class="pre"><span class="Identifier">SecureHash</span></span></tt> from a file</li>
    258. 

  258. </ul>
    259. 

  259. 

  260. <p><strong class="examples_text">Example:</strong></p>
    261. 

  261. <pre class="listing"><span class="Keyword">let</span>
    262. 

  262.   <span class="Identifier">hashStr</span> <span class="Operator">=</span> <span class="StringLit">&quot;0A4D55A8D778E5022FAB701977C5D840BBC486D0&quot;</span>
    263. 

  263.   <span class="Identifier">secureHash</span> <span class="Operator">=</span> <span class="Identifier">secureHash</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello World&quot;</span><span class="Punctuation">)</span>
    264. 

  264. <span class="Identifier">assert</span> <span class="Identifier">secureHash</span> <span class="Operator">==</span> <span class="Identifier">parseSecureHash</span><span class="Punctuation">(</span><span class="Identifier">hashStr</span><span class="Punctuation">)</span></pre>
    265. 

  265.     
    266. 

  266.   </dd>
    267. 

  267. </div>
    268. 

  268. 

  269. </div>
    270. 

  270. <div id="secureHash-procs-all">
    271. 

  271.   <div id="secureHash,openArray[char]">
    272. 

  272.   <dt><pre><span class="Keyword">proc</span> <a href="#secureHash%2CopenArray%5Bchar%5D"><span class="Identifier">secureHash</span></a><span class="Other">(</span><span class="Identifier">str</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> <a href="sha1.html#SecureHash"><span class="Identifier">SecureHash</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>
    273. 

  273.     <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    274. 

  274.   <dd>
    275. 

  275.     
    276. 

  276.     <p>Generates a <tt class="docutils literal"><span class="pre"><span class="Identifier">SecureHash</span></span></tt> from <tt class="docutils literal"><span class="pre"><span class="Identifier">str</span></span></tt>.</p>
    277. 

  277. <p><strong>See also:</strong></p>
    278. 

  278. <ul class="simple"><li><a class="reference external" href="#secureHashFile,string">secureHashFile proc</a> for generating a <tt class="docutils literal"><span class="pre"><span class="Identifier">SecureHash</span></span></tt> from a file</li>
    279. 

  279. <li><a class="reference external" href="#parseSecureHash,string">parseSecureHash proc</a> for converting a string <tt class="docutils literal"><span class="pre"><span class="Identifier">hash</span></span></tt> to <tt class="docutils literal"><span class="pre"><span class="Identifier">SecureHash</span></span></tt></li>
    280. 

  280. </ul>
    281. 

  281. 

  282. <p><strong class="examples_text">Example:</strong></p>
    283. 

  283. <pre class="listing"><span class="Keyword">let</span> <span class="Identifier">hash</span> <span class="Operator">=</span> <span class="Identifier">secureHash</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello World&quot;</span><span class="Punctuation">)</span>
    284. 

  284. <span class="Identifier">assert</span> <span class="Identifier">hash</span> <span class="Operator">==</span> <span class="Identifier">parseSecureHash</span><span class="Punctuation">(</span><span class="StringLit">&quot;0A4D55A8D778E5022FAB701977C5D840BBC486D0&quot;</span><span class="Punctuation">)</span></pre>
    285. 

  285.     
    286. 

  286.   </dd>
    287. 

  287. </div>
    288. 

  288. 

  289. </div>
    290. 

  290. <div id="secureHashFile-procs-all">
    291. 

  291.   <div id="secureHashFile,string">
    292. 

  292.   <dt><pre><span class="Keyword">proc</span> <a href="#secureHashFile%2Cstring"><span class="Identifier">secureHashFile</span></a><span class="Other">(</span><span class="Identifier">filename</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">)</span><span class="Other">:</span> <a href="sha1.html#SecureHash"><span class="Identifier">SecureHash</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="Identifier">IOError</span><span class="Other">]</span><span class="Other">,</span>
    293. 

  293.     <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadIOEffect</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>
    294. 

  294.   <dd>
    295. 

  295.     
    296. 

  296.     <p>Generates a <tt class="docutils literal"><span class="pre"><span class="Identifier">SecureHash</span></span></tt> from a file.</p>
    297. 

  297. <p><strong>See also:</strong></p>
    298. 

  298. <ul class="simple"><li><a class="reference external" href="#secureHash,openArray[char]">secureHash proc</a> for generating a <tt class="docutils literal"><span class="pre"><span class="Identifier">SecureHash</span></span></tt> from a string</li>
    299. 

  299. <li><a class="reference external" href="#parseSecureHash,string">parseSecureHash proc</a> for converting a string <tt class="docutils literal"><span class="pre"><span class="Identifier">hash</span></span></tt> to <tt class="docutils literal"><span class="pre"><span class="Identifier">SecureHash</span></span></tt></li>
    300. 

  300. </ul>
    301. 

  301. 

  302.     
    303. 

  303.   </dd>
    304. 

  304. </div>
    305. 

  305. 

  306. </div>
    307. 

  307. <div id="update-procs-all">
    308. 

  308.   <div id="update,Sha1State,openArray[char]">
    309. 

  309.   <dt><pre><span class="Keyword">proc</span> <a href="#update%2CSha1State%2CopenArray%5Bchar%5D"><span class="Identifier">update</span></a><span class="Other">(</span><span class="Identifier">ctx</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="sha1.html#Sha1State"><span class="Identifier">Sha1State</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><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>
    310. 

  310.     <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    311. 

  311.   <dd>
    312. 

  312.     
    313. 

  313.     <p>Updates the <tt class="docutils literal"><span class="pre"><span class="Identifier">Sha1State</span></span></tt> with <tt class="docutils literal"><span class="pre"><span class="Identifier">data</span></span></tt>.</p>
    314. 

  314. <p>If you use the <a class="reference external" href="#secureHash,openArray[char]">secureHash proc</a>, there's no need to call this function explicitly.</p>
    315. 

  315. 

  316.     
    317. 

  317.   </dd>
    318. 

  318. </div>
    319. 

  319. 

  320. </div>
    321. 

  321. 

  322.   </dl>
    323. 

  323. </div>
    324. 

  324. 

  325.   </div>
    326. 

  326. </div>
    327. 

  327. 

  328.       <div class="twelve-columns footer">
    329. 

  329.         <span class="nim-sprite"></span>
    330. 

  330.         <br>
    331. 

  331.         <small style="color: var(--hint);">Made with Nim. Generated: 2025-02-06 22:28:42 UTC</small>
    332. 

  332.       </div>
    333. 

  333.     </div>
    334. 

  334.   </div>
    335. 

  335.       <script defer data-domain="nim-lang.org" src="https://plausible.io/js/plausible.js"></script>
    336. 

  336.     
    337. 

  337. </body>
    338. 

  338. </html>
    339. 

  339.