27 lines
5.0 KiB
HTML
27 lines
5.0 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Fills `out` with the key derived using PBKDF2 with the given inputs."><title>derive in ring::pbkdf2 - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="ring" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../static.files/storage-e2aeef58.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><rustdoc-topbar><h2><a href="#">derive</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../ring/index.html">ring</a><span class="version">0.17.14</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">derive</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#panics" title="Panics">Panics</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="index.html">In ring::<wbr>pbkdf2</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../index.html">ring</a>::<wbr><a href="index.html">pbkdf2</a></div><h1>Function <span class="fn">derive</span> <button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/ring/pbkdf2.rs.html#166-177">Source</a> </span></div><pre class="rust item-decl"><code>pub fn derive(
|
||
algorithm: <a class="struct" href="struct.Algorithm.html" title="struct ring::pbkdf2::Algorithm">Algorithm</a>,
|
||
iterations: <a class="type" href="https://doc.rust-lang.org/1.93.1/core/num/nonzero/type.NonZeroU32.html" title="type core::num::nonzero::NonZeroU32">NonZeroU32</a>,
|
||
salt: &[<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</a>],
|
||
secret: &[<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</a>],
|
||
out: &mut [<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</a>],
|
||
)</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Fills <code>out</code> with the key derived using PBKDF2 with the given inputs.</p>
|
||
<p>Do not use <code>derive</code> as part of verifying a secret; use <code>verify</code> instead, to
|
||
minimize the effectiveness of timing attacks.</p>
|
||
<p><code>out.len()</code> must be no larger than the digest length * (2**32 - 1), per the
|
||
PBKDF2 specification.</p>
|
||
<div><table><thead><tr><th>Parameter</th><th>RFC 2898 Section 5.2 Term</th></tr></thead><tbody>
|
||
<tr><td>digest_alg</td><td>PRF (HMAC with the given digest algorithm)</td></tr>
|
||
<tr><td>iterations</td><td>c (iteration count)</td></tr>
|
||
<tr><td>salt</td><td>S (salt)</td></tr>
|
||
<tr><td>secret</td><td>P (password)</td></tr>
|
||
<tr><td>out</td><td>dk (derived key)</td></tr>
|
||
<tr><td>out.len()</td><td>dkLen (derived key length)</td></tr>
|
||
</tbody></table>
|
||
</div><h2 id="panics"><a class="doc-anchor" href="#panics">§</a>Panics</h2>
|
||
<p>Panics if <code>out.len() > u32::MAX * digest_alg.output_len()</code>, where
|
||
<code>digest_alg</code> is the underlying HMAC/digest algorithm.</p>
|
||
<p>Panics if <code>salt</code> is so astronomically gigantic that it isn’t a valid input
|
||
to the underlying digest function.</p>
|
||
<p>Panics if <code>secret</code> is so astronomically gigantic that it isn’t a valid
|
||
input to the underlying digest function.</p>
|
||
</div></details></section></div></main></body></html> |