1
0
Fork 0
mirror of https://gitlab.redox-os.org/CoffeeCode/redox-ssh.git synced 2025-12-28 22:12:19 +01:00
redox-ssh/crypto/pbkdf2/index.html

142 lines
No EOL
6 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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 `pbkdf2` mod in crate `crypto`.">
<meta name="keywords" content="rust, rustlang, rust-lang, pbkdf2">
<title>crypto::pbkdf2 - Rust</title>
<link rel="stylesheet" type="text/css" href="../../normalize.css">
<link rel="stylesheet" type="text/css" href="../../rustdoc.css">
<link rel="stylesheet" type="text/css" href="../../main.css">
</head>
<body class="rustdoc mod">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
<p class='location'>Module pbkdf2</p><div class="block items"><ul><li><a href="#functions">Functions</a></li></ul></div><p class='location'><a href='../index.html'>crypto</a></p><script>window.sidebarCurrent = {name: 'pbkdf2', ty: 'mod', relpath: '../'};</script><script defer src="../sidebar-items.js"></script>
</nav>
<nav class="sub">
<form class="search-form js-only">
<div class="search-container">
<input class="search-input" name="search"
autocomplete="off"
placeholder="Click or press S to search, ? for more options…"
type="search">
</div>
</form>
</nav>
<section id='main' class="content">
<h1 class='fqn'><span class='in-band'>Module <a href='../index.html'>crypto</a>::<wbr><a class="mod" href=''>pbkdf2</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'>&#x2212;</span>]
</a>
</span><a class='srclink' href='../../src/crypto/pbkdf2.rs.html#7-357' title='goto source code'>[src]</a></span></h1>
<div class='docblock'><p>This module implements the PBKDF2 Key Derivation Function as specified by
<a href="http://tools.ietf.org/html/rfc2898">http://tools.ietf.org/html/rfc2898</a>.</p>
</div><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
<table>
<tr class=' module-item'>
<td><a class="fn" href="fn.pbkdf2.html"
title='fn crypto::pbkdf2::pbkdf2'>pbkdf2</a></td>
<td class='docblock-short'>
<p>Execute the PBKDF2 Key Derivation Function. The Scrypt Key Derivation Function generally provides
better security, so, applications that do not have a requirement to use PBKDF2 specifically
should consider using that function instead.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.pbkdf2_check.html"
title='fn crypto::pbkdf2::pbkdf2_check'>pbkdf2_check</a></td>
<td class='docblock-short'>
<p>pbkdf2_check compares a password against the result of a previous call to pbkdf2_simple and
returns true if the passed in password hashes to the same value.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.pbkdf2_simple.html"
title='fn crypto::pbkdf2::pbkdf2_simple'>pbkdf2_simple</a></td>
<td class='docblock-short'>
<p>pbkdf2_simple is a helper function that should be sufficient for the majority of cases where
an application needs to use PBKDF2 to hash a password for storage. The result is a String that
contains the parameters used as part of its encoding. The pbkdf2_check function may be used on
a password to check if it is equal to a hashed value.</p>
</td>
</tr></table></section>
<section id='search' class="content hidden"></section>
<section class="footer"></section>
<aside id="help" class="hidden">
<div>
<h1 class="hidden">Help</h1>
<div class="shortcuts">
<h2>Keyboard Shortcuts</h2>
<dl>
<dt>?</dt>
<dd>Show this help dialog</dd>
<dt>S</dt>
<dd>Focus the search field</dd>
<dt>&larrb;</dt>
<dd>Move up in search results</dd>
<dt>&rarrb;</dt>
<dd>Move down in search results</dd>
<dt>&#9166;</dt>
<dd>Go to active search result</dd>
<dt>+</dt>
<dd>Collapse/expand all sections</dd>
</dl>
</div>
<div class="infos">
<h2>Search Tricks</h2>
<p>
Prefix searches with a type followed by a colon (e.g.
<code>fn:</code>) to restrict the search to a given type.
</p>
<p>
Accepted types are: <code>fn</code>, <code>mod</code>,
<code>struct</code>, <code>enum</code>,
<code>trait</code>, <code>type</code>, <code>macro</code>,
and <code>const</code>.
</p>
<p>
Search functions by type signature (e.g.
<code>vec -> usize</code> or <code>* -> vec</code>)
</p>
</div>
</div>
</aside>
<script>
window.rootPath = "../../";
window.currentCrate = "crypto";
</script>
<script src="../../main.js"></script>
<script defer src="../../search-index.js"></script>
</body>
</html>