sha1.html 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339
  1. <?xml version="1.0" encoding="utf-8" ?>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <!-- This file is generated by Nim. -->
  4. <html xmlns="https://www.w3.org/1999/xhtml" xml:lang="en" lang="en" data-theme="auto">
  5. <head>
  6. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  7. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  8. <title>src/checksums/sha1</title>
  9. <!-- Google fonts -->
  10. <link href='https://fonts.googleapis.com/css?family=Lato:400,600,900' rel='stylesheet' type='text/css'/>
  11. <link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>
  12. <!-- Favicon -->
  13. <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=="/>
  14. <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=">
  15. <!-- CSS -->
  16. <link rel="stylesheet" type="text/css" href="nimdoc.out.css?v=2.3.1">
  17. <!-- JS -->
  18. <script type="text/javascript" src="dochack.js?v=2.3.1"></script>
  19. </head>
  20. <body>
  21. <div class="document" id="documentId">
  22. <div class="container">
  23. <h1 class="title">src/checksums/sha1</h1>
  24. <div class="row">
  25. <div class="three columns">
  26. <div class="theme-select-wrapper">
  27. <label for="theme-select">Theme:&nbsp;</label>
  28. <select id="theme-select" onchange="setTheme(this.value)">
  29. <option value="auto">🌗 Match OS</option>
  30. <option value="dark">🌑 Dark</option>
  31. <option value="light">🌕 Light</option>
  32. </select>
  33. </div>
  34. <div id="global-links">
  35. <ul class="simple-boot">
  36. <li><a href="manual.html">Manual</a></li>
  37. <li><a href="lib.html">Standard library</a></li>
  38. <li> <a id="indexLink" href="theindex.html">Index</a></li>
  39. <li><a href="compiler/theindex.html">Compiler docs</a></li>
  40. <li><a href="https://nim-lang.github.io/fusion/theindex.html">Fusion docs</a></li>
  41. <li><a href="https://nim-lang.github.io/Nim/">devel</a>, <a href="https://nim-lang.org/documentation.html">stable</a></li>
  42. </ul>
  43. </div>
  44. <div id="searchInputDiv">
  45. Search: <input type="search" id="searchInput"
  46. oninput="search()" />
  47. </div>
  48. <ul class="simple simple-toc" id="toc-list">
  49. <li><a class="reference" id="see-also_toc" href="#see-also">See also</a></li>
  50. <li>
  51. <details open>
  52. <summary><a class="reference reference-toplevel" href="#7" id="57">Types</a></summary>
  53. <ul class="simple simple-toc-section">
  54. <li><a class="reference" href="#SecureHash" title="SecureHash = distinct Sha1Digest">SecureHash</a></li>
  55. <li><a class="reference" href="#Sha1Digest" title="Sha1Digest = array[0 .. 20 - 1, uint8]">Sha1Digest</a></li>
  56. <li><a class="reference" href="#Sha1State" title="Sha1State = object">Sha1State</a></li>
  57. </ul>
  58. </details>
  59. </li>
  60. <li>
  61. <details open>
  62. <summary><a class="reference reference-toplevel" href="#12" id="62">Procs</a></summary>
  63. <ul class="simple simple-toc-section">
  64. <ul class="simple nested-toc-section">$
  65. <li><a class="reference" href="#%24%2CSecureHash" title="`$`(self: SecureHash): string">`$`(self: SecureHash): string</a></li>
  66. </ul>
  67. <ul class="simple nested-toc-section">==
  68. <li><a class="reference" href="#%3D%3D%2CSecureHash%2CSecureHash" title="`==`(a, b: SecureHash): bool">`==`(a, b: SecureHash): bool</a></li>
  69. </ul>
  70. <ul class="simple nested-toc-section">finalize
  71. <li><a class="reference" href="#finalize%2CSha1State" title="finalize(ctx: var Sha1State): Sha1Digest">finalize(ctx: var Sha1State): Sha1Digest</a></li>
  72. </ul>
  73. <ul class="simple nested-toc-section">isValidSha1Hash
  74. <li><a class="reference" href="#isValidSha1Hash%2Cstring" title="isValidSha1Hash(s: string): bool">isValidSha1Hash(s: string): bool</a></li>
  75. </ul>
  76. <ul class="simple nested-toc-section">newSha1State
  77. <li><a class="reference" href="#newSha1State" title="newSha1State(): Sha1State">newSha1State(): Sha1State</a></li>
  78. </ul>
  79. <ul class="simple nested-toc-section">parseSecureHash
  80. <li><a class="reference" href="#parseSecureHash%2Cstring" title="parseSecureHash(hash: string): SecureHash">parseSecureHash(hash: string): SecureHash</a></li>
  81. </ul>
  82. <ul class="simple nested-toc-section">secureHash
  83. <li><a class="reference" href="#secureHash%2CopenArray%5Bchar%5D" title="secureHash(str: openArray[char]): SecureHash">secureHash(str: openArray[char]): SecureHash</a></li>
  84. </ul>
  85. <ul class="simple nested-toc-section">secureHashFile
  86. <li><a class="reference" href="#secureHashFile%2Cstring" title="secureHashFile(filename: string): SecureHash">secureHashFile(filename: string): SecureHash</a></li>
  87. </ul>
  88. <ul class="simple nested-toc-section">update
  89. <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>
  90. </ul>
  91. </ul>
  92. </details>
  93. </li>
  94. </ul>
  95. </div>
  96. <div class="nine columns" id="content">
  97. <div id="tocRoot"></div>
  98. <p class="module-desc"><div class="admonition admonition-info"><span class="admonition-info-text"><b>Note:</b></span>
  99. 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>
  100. <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>
  101. <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>
  102. <p>Even though SHA-1 is <em>formally</em> deprecated, this module itself is not deprecated and will continue to be usable.</p>
  103. <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>
  104. <li><a class="reference external" href="hashes.html">hashes module</a> for efficient computations of hash values for diverse Nim types</li>
  105. <li><a class="reference external" href="md5.html">md5 module</a> for the MD5 checksum algorithm</li>
  106. <li><a class="reference external" href="sha2.html">sha2 module</a> for the newer hash familiy SHA-2</li>
  107. <li><a class="reference external" href="sha3.html">sha3 module</a> for the newest hash family SHA-3</li>
  108. </ul>
  109. <p><strong class="examples_text">Example:</strong></p>
  110. <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>
  111. <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>
  112. <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>
  113. <p><strong class="examples_text">Example: cmd: -r:off</strong></p>
  114. <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>
  115. <span class="Keyword">let</span>
  116. <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>
  117. <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>
  118. <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>
  119. <div class="section" id="7">
  120. <h1><a class="toc-backref" href="#7">Types</a></h1>
  121. <dl class="item">
  122. <div id="SecureHash">
  123. <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>
  124. <dd>
  125. </dd>
  126. </div>
  127. <div id="Sha1Digest">
  128. <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>
  129. <dd>
  130. </dd>
  131. </div>
  132. <div id="Sha1State">
  133. <dt><pre><a href="sha1.html#Sha1State"><span class="Identifier">Sha1State</span></a> <span class="Other">=</span> <span class="Keyword">object</span></pre></dt>
  134. <dd>
  135. </dd>
  136. </div>
  137. </dl>
  138. </div>
  139. <div class="section" id="12">
  140. <h1><a class="toc-backref" href="#12">Procs</a></h1>
  141. <dl class="item">
  142. <div id="$-procs-all">
  143. <div id="$,SecureHash">
  144. <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>
  145. <dd>
  146. <p>Returns the string representation of a <tt class="docutils literal"><span class="pre"><span class="Identifier">SecureHash</span></span></tt>.</p>
  147. <p><strong>See also:</strong></p>
  148. <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>
  149. </ul>
  150. <p><strong class="examples_text">Example:</strong></p>
  151. <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>
  152. <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>
  153. </dd>
  154. </div>
  155. </div>
  156. <div id="==-procs-all">
  157. <div id="==,SecureHash,SecureHash">
  158. <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>
  159. <dd>
  160. Checks if two <tt class="docutils literal"><span class="pre"><span class="Identifier">SecureHash</span></span></tt> values are identical.
  161. <p><strong class="examples_text">Example:</strong></p>
  162. <pre class="listing"><span class="Keyword">let</span>
  163. <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>
  164. <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>
  165. <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>
  166. <span class="Identifier">assert</span> <span class="Identifier">a</span> <span class="Operator">!=</span> <span class="Identifier">b</span>
  167. <span class="Identifier">assert</span> <span class="Identifier">a</span> <span class="Operator">==</span> <span class="Identifier">c</span></pre>
  168. </dd>
  169. </div>
  170. </div>
  171. <div id="finalize-procs-all">
  172. <div id="finalize,Sha1State">
  173. <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>
  174. <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  175. <dd>
  176. <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>
  177. <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>
  178. </dd>
  179. </div>
  180. </div>
  181. <div id="isValidSha1Hash-procs-all">
  182. <div id="isValidSha1Hash,string">
  183. <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>
  184. <dd>
  185. Checks if a string is a valid sha1 hash sum.
  186. </dd>
  187. </div>
  188. </div>
  189. <div id="newSha1State-procs-all">
  190. <div id="newSha1State">
  191. <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>
  192. <dd>
  193. <p>Creates a <tt class="docutils literal"><span class="pre"><span class="Identifier">Sha1State</span></span></tt>.</p>
  194. <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>
  195. </dd>
  196. </div>
  197. </div>
  198. <div id="parseSecureHash-procs-all">
  199. <div id="parseSecureHash,string">
  200. <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>
  201. <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  202. <dd>
  203. <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>
  204. <p><strong>See also:</strong></p>
  205. <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>
  206. <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>
  207. </ul>
  208. <p><strong class="examples_text">Example:</strong></p>
  209. <pre class="listing"><span class="Keyword">let</span>
  210. <span class="Identifier">hashStr</span> <span class="Operator">=</span> <span class="StringLit">&quot;0A4D55A8D778E5022FAB701977C5D840BBC486D0&quot;</span>
  211. <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>
  212. <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>
  213. </dd>
  214. </div>
  215. </div>
  216. <div id="secureHash-procs-all">
  217. <div id="secureHash,openArray[char]">
  218. <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>
  219. <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  220. <dd>
  221. <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>
  222. <p><strong>See also:</strong></p>
  223. <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>
  224. <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>
  225. </ul>
  226. <p><strong class="examples_text">Example:</strong></p>
  227. <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>
  228. <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>
  229. </dd>
  230. </div>
  231. </div>
  232. <div id="secureHashFile-procs-all">
  233. <div id="secureHashFile,string">
  234. <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>
  235. <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>
  236. <dd>
  237. <p>Generates a <tt class="docutils literal"><span class="pre"><span class="Identifier">SecureHash</span></span></tt> from a file.</p>
  238. <p><strong>See also:</strong></p>
  239. <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>
  240. <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>
  241. </ul>
  242. </dd>
  243. </div>
  244. </div>
  245. <div id="update-procs-all">
  246. <div id="update,Sha1State,openArray[char]">
  247. <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>
  248. <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  249. <dd>
  250. <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>
  251. <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>
  252. </dd>
  253. </div>
  254. </div>
  255. </dl>
  256. </div>
  257. </div>
  258. </div>
  259. <div class="twelve-columns footer">
  260. <span class="nim-sprite"></span>
  261. <br>
  262. <small style="color: var(--hint);">Made with Nim. Generated: 2025-02-06 22:28:42 UTC</small>
  263. </div>
  264. </div>
  265. </div>
  266. <script defer data-domain="nim-lang.org" src="https://plausible.io/js/plausible.js"></script>
  267. </body>
  268. </html>