| <!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."><meta name="keywords" content="rust, rustlang, rust-lang, derive"><title>derive in ring::pbkdf2 - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.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]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../../ring/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../ring/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><div class="sidebar-elems"><h2><a href="index.html">In ring::pbkdf2</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Function <a href="../index.html">ring</a>::<wbr><a href="index.html">pbkdf2</a>::<wbr><a class="fn" href="#">derive</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../../src/ring/pbkdf2.rs.html#155-181">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="item-decl"><pre class="rust fn"><code>pub fn derive(<br> algorithm: <a class="struct" href="struct.Algorithm.html" title="struct ring::pbkdf2::Algorithm">Algorithm</a>,<br> iterations: NonZeroU32,<br> salt: &[u8],<br> secret: &[u8],<br> out: &mut [u8]<br>)</code></pre></div><details class="rustdoc-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 href="#panics">Panics</a></h2> |
| <p><code>derive</code> panics if <code>out.len()</code> is larger than (2**32 - 1) * the digest |
| algorithm’s output length, per the PBKDF2 specification.</p> |
| </div></details></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="ring" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
