mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-02-23 15:49:49 +01:00
31 lines
8.4 KiB
HTML
31 lines
8.4 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="Safe, fast, small crypto using Rust with BoringSSL’s cryptography primitives."><title>ring - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-ac92e1bbe349e143.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="ring" data-themes="" data-resource-suffix="" data-rustdoc-version="1.76.0 (07dca489a 2024-02-04)" data-channel="1.76.0" data-search-js="search-2b6ce74ff89ae146.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-f2adc0d6ca4d09fb.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-305769736d49e732.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-feafe1bb7466e4bd.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc mod crate"><!--[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></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../ring/index.html">ring</a><span class="version">0.16.20</span></h2></div><div class="sidebar-elems"><ul class="block">
|
||
<li><a id="all-types" href="all.html">All Items</a></li></ul><section><ul class="block"><li><a href="#modules">Modules</a></li><li><a href="#macros">Macros</a></li></ul></section></div></nav><div class="sidebar-resizer"></div>
|
||
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../ring/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Crate <a class="mod" href="#">ring</a><button id="copy-path" title="Copy item path to clipboard"><img src="../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../src/ring/lib.rs.html#15-135">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Safe, fast, small crypto using Rust with BoringSSL’s cryptography
|
||
primitives.</p>
|
||
<h2 id="feature-flags"><a href="#feature-flags">Feature Flags</a></h2><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></details><h2 id="modules" class="section-header"><a href="#modules">Modules</a></h2><ul class="item-table"><li><div class="item-name"><a class="mod" href="aead/index.html" title="mod ring::aead">aead</a></div><div class="desc docblock-short">Authenticated Encryption with Associated Data (AEAD).</div></li><li><div class="item-name"><a class="mod" href="agreement/index.html" title="mod ring::agreement">agreement</a></div><div class="desc docblock-short">Key Agreement: ECDH, including X25519.</div></li><li><div class="item-name"><a class="mod" href="constant_time/index.html" title="mod ring::constant_time">constant_time</a></div><div class="desc docblock-short">Constant-time operations.</div></li><li><div class="item-name"><a class="mod" href="digest/index.html" title="mod ring::digest">digest</a></div><div class="desc docblock-short">SHA-2 and the legacy SHA-1 digest algorithm.</div></li><li><div class="item-name"><a class="mod" href="error/index.html" title="mod ring::error">error</a></div><div class="desc docblock-short">Error reporting.</div></li><li><div class="item-name"><a class="mod" href="hkdf/index.html" title="mod ring::hkdf">hkdf</a></div><div class="desc docblock-short">HMAC-based Extract-and-Expand Key Derivation Function.</div></li><li><div class="item-name"><a class="mod" href="hmac/index.html" title="mod ring::hmac">hmac</a></div><div class="desc docblock-short">HMAC is specified in <a href="https://tools.ietf.org/html/rfc2104">RFC 2104</a>.</div></li><li><div class="item-name"><a class="mod" href="io/index.html" title="mod ring::io">io</a></div><div class="desc docblock-short">Serialization and deserialization.</div></li><li><div class="item-name"><a class="mod" href="pbkdf2/index.html" title="mod ring::pbkdf2">pbkdf2</a></div><div class="desc docblock-short">PBKDF2 derivation and verification.</div></li><li><div class="item-name"><a class="mod" href="pkcs8/index.html" title="mod ring::pkcs8">pkcs8</a></div><div class="desc docblock-short">PKCS#8 is specified in <a href="https://tools.ietf.org/html/rfc5958.">RFC 5958</a>.</div></li><li><div class="item-name"><a class="mod" href="rand/index.html" title="mod ring::rand">rand</a></div><div class="desc docblock-short">Cryptographic pseudo-random number generation.</div></li><li><div class="item-name"><a class="mod" href="signature/index.html" title="mod ring::signature">signature</a></div><div class="desc docblock-short">Public key signatures: signing and verification.</div></li><li><div class="item-name"><a class="mod" href="test/index.html" title="mod ring::test">test</a></div><div class="desc docblock-short">Testing framework.</div></li></ul><h2 id="macros" class="section-header"><a href="#macros">Macros</a></h2><ul class="item-table"><li><div class="item-name"><a class="macro" href="macro.test_file.html" title="macro ring::test_file">test_file</a></div><div class="desc docblock-short">References a test input file.</div></li></ul></section></div></main></body></html> |