mirror of
https://github.com/fofolee/uTools-Manuals.git
synced 2025-06-18 05:26:57 +08:00
144 lines
8.3 KiB
HTML
144 lines
8.3 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
<html>
|
|
<head>
|
|
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
|
|
<title>Derive a key from a password</title>
|
|
</head>
|
|
<body class="docs"><div id="layout">
|
|
<div id="layout-content"><div id="function.sodium-crypto-pwhash" class="refentry">
|
|
<div class="refnamediv">
|
|
<h1 class="refname">sodium_crypto_pwhash</h1>
|
|
<p class="verinfo">(PHP 7 >= 7.2.0)</p><p class="refpurpose"><span class="refname">sodium_crypto_pwhash</span> — <span class="dc-title">Derive a key from a password</span></p>
|
|
|
|
</div>
|
|
|
|
<div class="refsect1 description" id="refsect1-function.sodium-crypto-pwhash-description">
|
|
<h3 class="title">说明</h3>
|
|
<div class="methodsynopsis dc-description">
|
|
<span class="methodname"><strong>sodium_crypto_pwhash</strong></span>
|
|
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$length</code></span>
|
|
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$password</code></span>
|
|
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$salt</code></span>
|
|
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$opslimit</code></span>
|
|
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$memlimit</code></span>
|
|
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$alg</code></span>
|
|
] ) : <span class="type">string</span></div>
|
|
|
|
<p class="para rdfs-comment">
|
|
This function provides low-level access to libsodium's crypto_pwhash key derivation function. Unless you have specific reason to use this function, you should use <span class="function"><a href="sodium_crypto_pwhash_str.html" class="function">sodium_crypto_pwhash_str()</a></span> or <span class="function"><a href="password_hash.html" class="function">password_hash()</a></span> functions instead.
|
|
</p>
|
|
</div>
|
|
|
|
|
|
<div class="refsect1 parameters" id="refsect1-function.sodium-crypto-pwhash-parameters">
|
|
<h3 class="title">参数</h3>
|
|
<dl>
|
|
|
|
|
|
<dt>
|
|
<code class="parameter">length</code></dt>
|
|
|
|
<dd>
|
|
|
|
<p class="para">
|
|
<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>; The length of the password hash to generate, in bytes.
|
|
</p>
|
|
</dd>
|
|
|
|
|
|
|
|
<dt>
|
|
<code class="parameter">password</code></dt>
|
|
|
|
<dd>
|
|
|
|
<p class="para">
|
|
<span class="type"><a href="language.types.string.html" class="type string">string</a></span>; The password to generate a hash for.
|
|
</p>
|
|
</dd>
|
|
|
|
|
|
|
|
<dt>
|
|
<code class="parameter">salt</code></dt>
|
|
|
|
<dd>
|
|
|
|
<p class="para">
|
|
<span class="type"><a href="language.types.string.html" class="type string">string</a></span> A salt to add to the password before hashing. The salt should be unpredictable, ideally generated from a good random mumber source such as <span class="function"><a href="random_bytes.html" class="function">random_bytes()</a></span>, and have a length of at least <strong><code>SODIUM_CRYPTO_PWHASH_SALTBYTES</code></strong> bytes.
|
|
</p>
|
|
</dd>
|
|
|
|
|
|
|
|
<dt>
|
|
<code class="parameter">opslimit</code></dt>
|
|
|
|
<dd>
|
|
|
|
<p class="para">
|
|
Represents a maximum amount of computations to perform. Raising this number will make the function require more CPU cycles to compute a key. There are some constants available to set the operations limit to appropriate values depending on intended use, in order of strength: <strong><code>SODIUM_CRYPTO_PWHASH_OPSLIMIT_INTERACTIVE</code></strong>, <strong><code>SODIUM_CRYPTO_PWHASH_OPSLIMIT_MODERATE</code></strong> and <strong><code>SODIUM_CRYPTO_PWHASH_OPSLIMIT_SENSITIVE</code></strong>.
|
|
</p>
|
|
</dd>
|
|
|
|
|
|
|
|
<dt>
|
|
<code class="parameter">memlimit</code></dt>
|
|
|
|
<dd>
|
|
|
|
<p class="para">
|
|
The maximum amount of RAM that the function will use, in bytes. There are constants to help you choose an appropriate value, in order of size: <strong><code>SODIUM_CRYPTO_PWHASH_MEMLIMIT_INTERACTIVE</code></strong>, <strong><code>SODIUM_CRYPTO_PWHASH_MEMLIMIT_MODERATE</code></strong>, and <strong><code>SODIUM_CRYPTO_PWHASH_MEMLIMIT_SENSITIVE</code></strong>. Typically these should be paired with the matching <code class="parameter">opslimit</code> values.
|
|
</p>
|
|
</dd>
|
|
|
|
|
|
|
|
<dt>
|
|
<code class="parameter">alg</code></dt>
|
|
|
|
<dd>
|
|
|
|
<p class="para">
|
|
<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span> A number indicating the hash algorithm to use. By default <strong><code>SODIUM_CRYPTO_PWHASH_ALG_DEFAULT</code></strong> (the currently recommended algorithm, which can change from one version of libsodium to another), or explicitly using <strong><code>SODIUM_CRYPTO_PWHASH_ALG_ARGON2ID13</code></strong>, representing the Argon2id algorithm version 1.3.
|
|
</p>
|
|
</dd>
|
|
|
|
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="refsect1 returnvalues" id="refsect1-function.sodium-crypto-pwhash-returnvalues">
|
|
<h3 class="title">返回值</h3>
|
|
<p class="para">
|
|
Returns the derived key, 或者在失败时返回 <strong><code>FALSE</code></strong>. The return value is a binary string of the hash, not an ASCII-encoded representation, and does not contain additional information about the parameters used to create the hash, so you will need to keep that information if you are ever going to verify the password in future. Use <span class="function"><a href="sodium_crypto_pwhash_str.html" class="function">sodium_crypto_pwhash_str()</a></span> to avoid needing to do all that.
|
|
</p>
|
|
</div>
|
|
|
|
<div class="refsect1 examples" id="refsect1-function.sodium-crypto-pwhash-examples">
|
|
<h3 class="title">范例</h3>
|
|
<p class="para">
|
|
<div class="example" id="openssl_spki_verify.example.basic">
|
|
<p><strong>Example #1 <span class="function"><a href="password_hash.html" class="function">password_hash()</a></span> example</strong></p>
|
|
<div class="example-contents">
|
|
<div class="phpcode"><pre><span style="color: #000000">
|
|
<span style="color: #0000BB"><?php<br /></span><span style="color: #FF8000">//Need to keep the salt if we're ever going to be able to check this password<br /></span><span style="color: #0000BB">$salt </span><span style="color: #007700">= </span><span style="color: #0000BB">random_bytes</span><span style="color: #007700">(</span><span style="color: #0000BB">SODIUM_CRYPTO_PWHASH_SALTBYTES</span><span style="color: #007700">);<br /></span><span style="color: #FF8000">//Using bin2hex to keep output readable<br /></span><span style="color: #007700">echo </span><span style="color: #0000BB">bin2hex</span><span style="color: #007700">(<br /> </span><span style="color: #0000BB">sodium_crypto_pwhash</span><span style="color: #007700">(<br /> </span><span style="color: #0000BB">16</span><span style="color: #007700">, </span><span style="color: #FF8000">// == 128 bits<br /> </span><span style="color: #DD0000">'password'</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">$salt</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">SODIUM_CRYPTO_PWHASH_OPSLIMIT_INTERACTIVE</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">SODIUM_CRYPTO_PWHASH_MEMLIMIT_INTERACTIVE</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">SODIUM_CRYPTO_PWHASH_ALG_ARGON2ID13<br /> </span><span style="color: #007700">)<br />);<br /></span><span style="color: #0000BB">?></span>
|
|
</span>
|
|
</pre></div>
|
|
</div>
|
|
|
|
<div class="example-contents"><p>以上例程的输出类似于：</p></div>
|
|
<div class="example-contents screen">
|
|
<div class="cdata"><pre>
|
|
a18f346ba57992eb7e4ae6abf3fd30ee
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
|
|
|
|
</div></div></div></body></html> |