mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-02-23 15:49:49 +01:00
21 lines
4.9 KiB
HTML
21 lines
4.9 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="API documentation for the Rust `derive` fn in crate `ring`."><meta name="keywords" content="rust, rustlang, rust-lang, derive"><title>ring::pbkdf2::derive - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
|
||
<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png">
|
||
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc fn"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../ring/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><div class="sidebar-elems"><p class="location"><a href="../index.html">ring</a>::<wbr><a href="index.html">pbkdf2</a></p><div id="sidebar-vars" data-name="derive" data-ty="fn" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||
<a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Function <a href="../index.html">ring</a>::<wbr><a href="index.html">pbkdf2</a>::<wbr><a class="fn" href="">derive</a></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../../src/ring/pbkdf2.rs.html#155-181" title="goto source code">[src]</a></span></h1><pre class="rust fn">pub fn derive(<br> algorithm: <a class="struct" href="../../ring/pbkdf2/struct.Algorithm.html" title="struct ring::pbkdf2::Algorithm">Algorithm</a>, <br> iterations: <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/nonzero/struct.NonZeroU32.html" title="struct core::num::nonzero::NonZeroU32">NonZeroU32</a>, <br> salt: &[u8], <br> secret: &[u8], <br> out: &mut [u8]<br>)</pre><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>
|
||
<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>
|
||
<h1 id="panics" class="section-header"><a href="#panics">Panics</a></h1>
|
||
<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></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="ring"></div>
|
||
<script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |