mirror of
https://gitlab.redox-os.org/CoffeeCode/redox-ssh.git
synced 2025-12-28 22:32:18 +01:00
211 lines
No EOL
9.1 KiB
HTML
211 lines
No EOL
9.1 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 `ring` crate.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, ring">
|
||
|
||
<title>ring - 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'>Crate ring</p><div class="block items"><ul><li><a href="#modules">Modules</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'ring', ty: 'mod', relpath: '../'};</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'>Crate <a class="mod" href=''>ring</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/lib.rs.html#15-186' title='goto source code'>[src]</a></span></h1>
|
||
<div class='docblock'><p>Safe, fast, small crypto using Rust with BoringSSL's cryptography
|
||
primitives.</p>
|
||
|
||
<p><code>git clone <a href="https://github.com/briansmith/ring">https://github.com/briansmith/ring</a></code></p>
|
||
|
||
<h1 id='feature-flags' class='section-header'><a href='#feature-flags'>Feature Flags</a></h1>
|
||
<table>
|
||
<tr><th>Feature
|
||
<th>Description
|
||
<tr><td><code>dev_urandom_fallback (default)</code>
|
||
<td>This is only applicable to Linux. On Linux, by default,
|
||
<code>ring::rand::SystemRandom</code> will fall back to reading
|
||
from <code>/dev/urandom</code> if the <code>getrandom()</code>
|
||
syscall isn't supported at runtime. When the
|
||
<code>dev_urandom_fallback</code> feature is disabled, such
|
||
fallbacks will not occur. See the documentation for
|
||
<code>rand::SystemRandom</code> for more details.
|
||
<tr><td><code>rsa_signing</code>
|
||
<td>Enable RSA signing (<code>RSAKeyPair</code> and related things).
|
||
</table>
|
||
</div><h2 id='modules' class='section-header'><a href="#modules">Modules</a></h2>
|
||
<table>
|
||
<tr class=' module-item'>
|
||
<td><a class="mod" href="aead/index.html"
|
||
title='mod ring::aead'>aead</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Authenticated Encryption with Associated Data (AEAD).</p>
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="mod" href="agreement/index.html"
|
||
title='mod ring::agreement'>agreement</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Key Agreement: ECDH, including X25519.</p>
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="mod" href="constant_time/index.html"
|
||
title='mod ring::constant_time'>constant_time</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Constant-time operations.</p>
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="mod" href="digest/index.html"
|
||
title='mod ring::digest'>digest</a></td>
|
||
<td class='docblock-short'>
|
||
<p>SHA-2 and the legacy SHA-1 digest algorithm.</p>
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="mod" href="error/index.html"
|
||
title='mod ring::error'>error</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Error reporting.</p>
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="mod" href="hkdf/index.html"
|
||
title='mod ring::hkdf'>hkdf</a></td>
|
||
<td class='docblock-short'>
|
||
<p>HMAC-based Extract-and-Expand Key Derivation Function.</p>
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="mod" href="hmac/index.html"
|
||
title='mod ring::hmac'>hmac</a></td>
|
||
<td class='docblock-short'>
|
||
<p>HMAC is specified in <a href="https://tools.ietf.org/html/rfc2104">RFC 2104</a>.</p>
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="mod" href="pbkdf2/index.html"
|
||
title='mod ring::pbkdf2'>pbkdf2</a></td>
|
||
<td class='docblock-short'>
|
||
<p>PBKDF2 derivation and verification.</p>
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="mod" href="rand/index.html"
|
||
title='mod ring::rand'>rand</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Cryptographic pseudo-random number generation.</p>
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="mod" href="signature/index.html"
|
||
title='mod ring::signature'>signature</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Public key signatures: signing and verification.</p>
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="mod" href="test/index.html"
|
||
title='mod ring::test'>test</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Testing framework.</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>⇤</dt>
|
||
<dd>Move up in search results</dd>
|
||
<dt>⇥</dt>
|
||
<dd>Move down in search results</dd>
|
||
<dt>⏎</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 = "ring";
|
||
</script>
|
||
<script src="../jquery.js"></script>
|
||
<script src="../main.js"></script>
|
||
<script defer src="../search-index.js"></script>
|
||
</body>
|
||
</html> |