mirror of
https://github.com/nim-lang/Nim.git
synced 2025-12-28 17:04:41 +00:00
276 lines
24 KiB
HTML
276 lines
24 KiB
HTML
<?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/bcrypt</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/bcrypt</h1>
|
|
<div class="row">
|
|
<div class="three columns">
|
|
<div class="theme-select-wrapper">
|
|
<label for="theme-select">Theme: </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>
|
|
<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="#CostFactor" title="CostFactor = range[4 .. 31]">CostFactor</a></li>
|
|
<li><a class="reference" href="#Hash" title="Hash = distinct HashBytes">Hash</a></li>
|
|
<li><a class="reference" href="#Salt" title="Salt = object
|
|
costFactor*: CostFactor">Salt</a></li>
|
|
<li><a class="reference" href="#SaltedHash" title="SaltedHash = tuple[salt: Salt, hash: Hash]">SaltedHash</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">$
|
|
<li><a class="reference" href="#%24%2CHash" title="`$`(s: Hash): string">`$`(s: Hash): string</a></li>
|
|
<li><a class="reference" href="#%24%2CSalt" title="`$`(s: Salt): string">`$`(s: Salt): string</a></li>
|
|
<li><a class="reference" href="#%24%2CSaltedHash" title="`$`(s: SaltedHash): string">`$`(s: SaltedHash): string</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">bcrypt
|
|
<li><a class="reference" href="#bcrypt%2CopenArray%5Bchar%5D%2CSalt" title="bcrypt(password: openArray[char]; salt: Salt): SaltedHash">bcrypt(password: openArray[char]; salt: Salt): SaltedHash</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">generateSalt
|
|
<li><a class="reference" href="#generateSalt%2CCostFactor" title="generateSalt(cost: CostFactor): Salt">generateSalt(cost: CostFactor): Salt</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">parseSalt
|
|
<li><a class="reference" href="#parseSalt%2Cstring" title="parseSalt(salt: string): Salt">parseSalt(salt: string): Salt</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">verify
|
|
<li><a class="reference" href="#verify%2CopenArray%5Bchar%5D%2Cstring" title="verify(password: openArray[char]; knownGood: string): bool">verify(password: openArray[char]; knownGood: string): bool</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/Bcrypt">bcrypt</a> is a <a class="reference external" href="https://en.wikipedia.org/wiki/Blowfish_(cipher)">Blowfish</a>-based password hashing algorithm that is designed to be adaptively expensive to provide resistance against brute force based attacks and additionally includes a salt for lookup table resistance.</p>
|
|
<p>Although bcrypt has been around for a long time, dating back to 1999, for many projects it is still a reasonable choice due to its adjustable cost factor that can provide security against all but the most well funded attackers.</p>
|
|
<p>This module's design is based loosely on Python's <tt class="docutils literal"><span class="pre"><span class="Identifier">bcrypt</span></span></tt> module and supports generating the newer version <tt class="docutils literal"><span class="pre"><span class="DecNumber">2</span><span class="Identifier">b</span></span></tt> hashes as well as verifying the older <tt class="docutils literal"><span class="pre"><span class="DecNumber">2</span><span class="Identifier">a</span></span></tt> and the PHP equivalent of <tt class="docutils literal"><span class="pre"><span class="DecNumber">2</span><span class="Identifier">b</span></span></tt> called <tt class="docutils literal"><span class="pre"><span class="DecNumber">2</span><span class="Identifier">y</span></span></tt>.</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">bcrypt</span>
|
|
|
|
<span class="Comment"># Generate a salt with a specific cost factor and use it to hash a password.</span>
|
|
<span class="Keyword">let</span> <span class="Identifier">hashed</span> <span class="Operator">=</span> <span class="Identifier">bcrypt</span><span class="Punctuation">(</span><span class="StringLit">"correct horse battery stape"</span><span class="Punctuation">,</span> <span class="Identifier">generateSalt</span><span class="Punctuation">(</span><span class="DecNumber">8</span><span class="Punctuation">)</span><span class="Punctuation">)</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">bcrypt</span>
|
|
|
|
<span class="Comment"># Verify a password against a known good hash from i.e. a database.</span>
|
|
<span class="Keyword">let</span> <span class="Identifier">knownGood</span> <span class="Operator">=</span> <span class="StringLit">"$2b$06$LzUyyYdKBoEy9V4NTvxDH.O11KQP30/Zyp5pQAQ.0Cy89WnkD5Jjy"</span>
|
|
|
|
<span class="Identifier">assert</span> <span class="Identifier">verify</span><span class="Punctuation">(</span><span class="StringLit">"correct horse battery staple"</span><span class="Punctuation">,</span> <span class="Identifier">knownGood</span><span class="Punctuation">)</span></pre></p>
|
|
<div class="section" id="7">
|
|
<h1><a class="toc-backref" href="#7">Types</a></h1>
|
|
<dl class="item">
|
|
<div id="CostFactor">
|
|
<dt><pre><a href="bcrypt.html#CostFactor"><span class="Identifier">CostFactor</span></a> <span class="Other">=</span> <span class="Identifier">range</span><span class="Other">[</span><span class="DecNumber">4</span> <span class="Operator">..</span> <span class="DecNumber">31</span><span class="Other">]</span></pre></dt>
|
|
<dd>
|
|
|
|
Adjustable cost factor. The value is a logarithm of 2, which means that a cost of 5 is twice as expensive as a cost of 4, and a cost of 16 is 2048 times more expensive than a cost of 5.
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="Hash">
|
|
<dt><pre><a href="bcrypt.html#Hash"><span class="Identifier">Hash</span></a> <span class="Other">=</span> <span class="Keyword">distinct</span> <span class="Identifier">HashBytes</span></pre></dt>
|
|
<dd>
|
|
|
|
A 192 bit hash value produced by the <tt class="docutils literal"><span class="pre"><span class="Identifier">bcrypt</span></span></tt> function.
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="Salt">
|
|
<dt><pre><a href="bcrypt.html#Salt"><span class="Identifier">Salt</span></a> <span class="Other">=</span> <span class="Keyword">object</span>
|
|
<span class="Identifier">costFactor</span><span class="Operator">*</span><span class="Other">:</span> <a href="bcrypt.html#CostFactor"><span class="Identifier">CostFactor</span></a></pre></dt>
|
|
<dd>
|
|
|
|
A random 128 bit salt used to provide security against rainbow table attacks that also includes the bcrypt version and cost factor.
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="SaltedHash">
|
|
<dt><pre><a href="bcrypt.html#SaltedHash"><span class="Identifier">SaltedHash</span></a> <span class="Other">=</span> <span class="Keyword">tuple</span><span class="Other">[</span><span class="Identifier">salt</span><span class="Other">:</span> <a href="bcrypt.html#Salt"><span class="Identifier">Salt</span></a><span class="Other">,</span> <span class="Identifier">hash</span><span class="Other">:</span> <a href="bcrypt.html#Hash"><span class="Identifier">Hash</span></a><span class="Other">]</span></pre></dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</dl>
|
|
</div>
|
|
<div class="section" id="12">
|
|
<h1><a class="toc-backref" href="#12">Procs</a></h1>
|
|
<dl class="item">
|
|
<div id="$-procs-all">
|
|
<div id="$,Hash">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#%24%2CHash"><span class="Identifier">`$`</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="bcrypt.html#Hash"><span class="Identifier">Hash</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>
|
|
<dd>
|
|
|
|
Renders the given <tt class="docutils literal"><span class="pre"><span class="Identifier">Hash</span></span></tt> into the canonical bcrypt-type Base64 representation.
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="$,Salt">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#%24%2CSalt"><span class="Identifier">`$`</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="bcrypt.html#Salt"><span class="Identifier">Salt</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>
|
|
<dd>
|
|
|
|
Renders the given <tt class="docutils literal"><span class="pre"><span class="Identifier">Salt</span></span></tt> into the canonical bcrypt-type Base64 representation along with its version and cost factor information.
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="$,SaltedHash">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#%24%2CSaltedHash"><span class="Identifier">`$`</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="bcrypt.html#SaltedHash"><span class="Identifier">SaltedHash</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>
|
|
<dd>
|
|
|
|
Renders the given <tt class="docutils literal"><span class="pre"><span class="Identifier">SaltedHash</span></span></tt> into the canonical bcrypt-type Base64 representation resulting in the actual hash string to be stored.
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="bcrypt-procs-all">
|
|
<div id="bcrypt,openArray[char],Salt">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#bcrypt%2CopenArray%5Bchar%5D%2CSalt"><span class="Identifier">bcrypt</span></a><span class="Other">(</span><span class="Identifier">password</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">salt</span><span class="Other">:</span> <a href="bcrypt.html#Salt"><span class="Identifier">Salt</span></a><span class="Other">)</span><span class="Other">:</span> <a href="bcrypt.html#SaltedHash"><span class="Identifier">SaltedHash</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>
|
|
|
|
<p>Produces a <tt class="docutils literal"><span class="pre"><span class="Identifier">SaltedHash</span></span></tt> from the given password string and salt.</p>
|
|
<p>Be careful when accepting a salt from a source outside of your control as a malicious user could pass in salts with a very high cost factor, resulting in denial of service attack.</p>
|
|
|
|
<p><strong class="examples_text">Example:</strong></p>
|
|
<pre class="listing"><span class="Keyword">let</span> <span class="Identifier">hashed</span> <span class="Operator">=</span> <span class="Identifier">bcrypt</span><span class="Punctuation">(</span><span class="StringLit">"correct horse battery stape"</span><span class="Punctuation">,</span> <span class="Identifier">generateSalt</span><span class="Punctuation">(</span><span class="DecNumber">8</span><span class="Punctuation">)</span><span class="Punctuation">)</span></pre>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="generateSalt-procs-all">
|
|
<div id="generateSalt,CostFactor">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#generateSalt%2CCostFactor"><span class="Identifier">generateSalt</span></a><span class="Other">(</span><span class="Identifier">cost</span><span class="Other">:</span> <a href="bcrypt.html#CostFactor"><span class="Identifier">CostFactor</span></a><span class="Other">)</span><span class="Other">:</span> <a href="bcrypt.html#Salt"><span class="Identifier">Salt</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Identifier">ResourceExhaustedError</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>
|
|
|
|
Generates a new, random salt with the provided <tt class="docutils literal"><span class="pre"><span class="Identifier">CostFactor</span></span></tt>. Only salts with subversion <tt class="docutils literal"><span class="pre"><span class="DecNumber">2</span><span class="Identifier">b</span></span></tt> are generated since it's the newest and default version of the reference bcrypt implementation.
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="parseSalt-procs-all">
|
|
<div id="parseSalt,string">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#parseSalt%2Cstring"><span class="Identifier">parseSalt</span></a><span class="Other">(</span><span class="Identifier">salt</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">)</span><span class="Other">:</span> <a href="bcrypt.html#Salt"><span class="Identifier">Salt</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Identifier">ValueError</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>Parses a <tt class="docutils literal"><span class="pre"><span class="Identifier">Salt</span></span></tt> from the given string (which may be a full bcrypt hash or only the preamble).</p>
|
|
<p>It accepts the <tt class="docutils literal"><span class="pre"><span class="DecNumber">2</span><span class="Identifier">a</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="DecNumber">2</span><span class="Identifier">b</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="DecNumber">2</span><span class="Identifier">y</span></span></tt> subversions.</p>
|
|
|
|
<p><strong class="examples_text">Example:</strong></p>
|
|
<pre class="listing"><span class="Comment"># Parse full hash</span>
|
|
<span class="Keyword">let</span> <span class="Identifier">salt1</span> <span class="Operator">=</span> <span class="Identifier">parseSalt</span> <span class="StringLit">"$2b$06$LzUyyYdKBoEy9V4NTvxDH."</span>
|
|
|
|
<span class="Comment"># Parse salt part</span>
|
|
<span class="Keyword">let</span> <span class="Identifier">salt2</span> <span class="Operator">=</span> <span class="Identifier">parseSalt</span> <span class="StringLit">"$2b$06$LzUyyYdKBoEy9V4NTvxDH.PvwrAArbP0DUvDUFf8ChnJl6/79lh3C"</span>
|
|
|
|
<span class="Identifier">assert</span> <span class="Operator">$</span><span class="Identifier">salt1</span> <span class="Operator">==</span> <span class="StringLit">"$2b$06$LzUyyYdKBoEy9V4NTvxDH."</span>
|
|
<span class="Identifier">assert</span> <span class="Operator">$</span><span class="Identifier">salt2</span> <span class="Operator">==</span> <span class="StringLit">"$2b$06$LzUyyYdKBoEy9V4NTvxDH."</span></pre>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="verify-procs-all">
|
|
<div id="verify,openArray[char],string">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#verify%2CopenArray%5Bchar%5D%2Cstring"><span class="Identifier">verify</span></a><span class="Other">(</span><span class="Identifier">password</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">knownGood</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="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> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
<p>Verifies a given plaintext password against a hash from a known good source such as a database or other data storage.</p>
|
|
<p>Be careful when accepting a hash from a source outside of your control as a malicious user could pass salts with a very high cost factor, resulting in denial of service attack.</p>
|
|
|
|
<p><strong class="examples_text">Example:</strong></p>
|
|
<pre class="listing"><span class="Keyword">let</span> <span class="Identifier">knownGood</span> <span class="Operator">=</span> <span class="StringLit">"$2b$06$LzUyyYdKBoEy9V4NTvxDH.O11KQP30/Zyp5pQAQ.0Cy89WnkD5Jjy"</span>
|
|
|
|
<span class="Identifier">assert</span> <span class="Identifier">verify</span><span class="Punctuation">(</span><span class="StringLit">"correct horse battery staple"</span><span class="Punctuation">,</span> <span class="Identifier">knownGood</span><span class="Punctuation">)</span></pre>
|
|
|
|
</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-12-25 20:14:12 UTC</small>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<script defer data-domain="nim-lang.org" src="https://plausible.io/js/plausible.js"></script>
|
|
|
|
</body>
|
|
</html>
|