mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-02-23 15:49:49 +01:00
49 lines
7.8 KiB
HTML
49 lines
7.8 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" 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 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"><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><p class="location">Crate ring</p><div class="block version"><p>Version 0.16.20</p></div><div class="sidebar-elems"><a id="all-types" href="all.html"><p>See all ring's items</p></a><div class="block items"><ul><li><a href="#modules">Modules</a></li><li><a href="#macros">Macros</a></li></ul></div><p class="location"></p><div id="sidebar-vars" data-name="ring" data-ty="mod" data-relpath="../"></div></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">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-135" title="goto source code">[src]</a></span></h1><div class="docblock"><p>Safe, fast, small crypto using Rust with BoringSSL's cryptography
|
||
primitives.</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>alloc (default)</code>
|
||
<td>Enable features that require use of the heap, RSA in particular.
|
||
<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>std</code>
|
||
<td>Enable features that use libstd, in particular
|
||
<code>std::error::Error</code> integration. Implies `alloc`.
|
||
<tr><td><code>wasm32_c</code>
|
||
<td>Enables features that require a C compiler on wasm32 targets, such as
|
||
the <code>constant_time</code> module, HMAC verification, and PBKDF2
|
||
verification. Without this feature, only a subset of functionality
|
||
is provided to wasm32 targets so that a C compiler isn't needed. A
|
||
typical invocation would be:
|
||
<code>TARGET_CC=clang-10 TARGET_AR=llvm-ar-10 cargo test --target=wasm32-unknown-unknown --features=wasm32_c</code>
|
||
with <code>llvm-ar-10</code> and <code>clang-10</code> in <code>$PATH</code>.
|
||
(Going forward more functionality should be enabled by default, without
|
||
requiring these hacks, and without requiring a C compiler.)
|
||
</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="ring::aead mod">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="ring::agreement mod">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="ring::constant_time mod">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="ring::digest mod">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="ring::error mod">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="ring::hkdf mod">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="ring::hmac mod">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="io/index.html" title="ring::io mod">io</a></td><td class="docblock-short"><p>Serialization and deserialization.</p>
|
||
</td></tr><tr class="module-item"><td><a class="mod" href="pbkdf2/index.html" title="ring::pbkdf2 mod">pbkdf2</a></td><td class="docblock-short"><p>PBKDF2 derivation and verification.</p>
|
||
</td></tr><tr class="module-item"><td><a class="mod" href="pkcs8/index.html" title="ring::pkcs8 mod">pkcs8</a></td><td class="docblock-short"><p>PKCS#8 is specified in <a href="https://tools.ietf.org/html/rfc5958.">RFC 5958</a>.</p>
|
||
</td></tr><tr class="module-item"><td><a class="mod" href="rand/index.html" title="ring::rand mod">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="ring::signature mod">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="ring::test mod">test</a></td><td class="docblock-short"><p>Testing framework.</p>
|
||
</td></tr></table><h2 id="macros" class="section-header"><a href="#macros">Macros</a></h2>
|
||
<table><tr class="module-item"><td><a class="macro" href="macro.test_file.html" title="ring::test_file macro">test_file</a></td><td class="docblock-short"><p>References a test input file.</p>
|
||
</td></tr></table></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> |