33 lines
7.0 KiB
HTML
33 lines
7.0 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="Feature Flags"><title>ring - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-ca0dd0c4.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.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../static.files/storage-e2aeef58.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.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]--><rustdoc-topbar><h2><a href="#">Crate ring</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../ring/index.html">ring</a><span class="version">0.17.14</span></h2></div><div class="sidebar-elems"><ul class="block"><li><a id="all-types" href="all.html">All Items</a></li></ul><section id="rustdoc-toc"><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#feature-flags" title="Feature Flags">Feature Flags</a></li></ul><h3><a href="#modules">Crate Items</a></h3><ul class="block"><li><a href="#modules" title="Modules">Modules</a></li><li><a href="#macros" title="Macros">Macros</a></li></ul></section><div id="rustdoc-modnav"></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><h1>Crate <span>ring</span> <button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/ring/lib.rs.html#15-177">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><h2 id="feature-flags"><a class="doc-anchor" href="#feature-flags">§</a>Feature Flags</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>less-safe-getrandom-custom-or-rdrand</code>
|
|
<td>Treat user-provided ("custom") and RDRAND-based <code>getrandom</code>
|
|
implementations as secure random number generators (see
|
|
<code>SecureRandom</code>). This feature only works with
|
|
<code>os = "none"</code> targets. See
|
|
<a href="https://docs.rs/getrandom/0.2.10/getrandom/macro.register_custom_getrandom.html">
|
|
<code>register_custom_getrandom</code>
|
|
</a> and <a href="https://docs.rs/getrandom/0.2.10/getrandom/#rdrand-on-x86">
|
|
RDRAND on x86
|
|
</a> for additional details.
|
|
<tr><td><code>less-safe-getrandom-espidf</code>
|
|
<td>Treat getrandom as a secure random number generator (see
|
|
<code>SecureRandom</code>) on the esp-idf target. While the esp-idf
|
|
target does have hardware RNG, it is beyond the scope of ring to
|
|
ensure its configuration. This feature allows ring to build
|
|
on esp-idf despite the likelihood that RNG is not secure.
|
|
This feature only works with <code>os = espidf</code> targets.
|
|
See <a href="https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/system/random.html">
|
|
<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_unknown_unknown_js</code>
|
|
<td>When this feature is enabled, for the wasm32-unknown-unknown target,
|
|
Web APIs will be used to implement features like `ring::rand` that
|
|
require an operating environment of some kind. This has no effect
|
|
for any other target. This enables the `getrandom` crate's `js`
|
|
feature.
|
|
</table></div></details><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><dl class="item-table"><dt><a class="mod" href="aead/index.html" title="mod ring::aead">aead</a></dt><dd>Authenticated Encryption with Associated Data (AEAD).</dd><dt><a class="mod" href="agreement/index.html" title="mod ring::agreement">agreement</a></dt><dd>Key Agreement: ECDH, including X25519.</dd><dt><a class="mod" href="digest/index.html" title="mod ring::digest">digest</a></dt><dd>SHA-2 and the legacy SHA-1 digest algorithm.</dd><dt><a class="mod" href="error/index.html" title="mod ring::error">error</a></dt><dd>Error reporting.</dd><dt><a class="mod" href="hkdf/index.html" title="mod ring::hkdf">hkdf</a></dt><dd>HMAC-based Extract-and-Expand Key Derivation Function.</dd><dt><a class="mod" href="hmac/index.html" title="mod ring::hmac">hmac</a></dt><dd>HMAC is specified in <a href="https://tools.ietf.org/html/rfc2104">RFC 2104</a>.</dd><dt><a class="mod" href="io/index.html" title="mod ring::io">io</a></dt><dd>Serialization and deserialization.</dd><dt><a class="mod" href="pbkdf2/index.html" title="mod ring::pbkdf2">pbkdf2</a></dt><dd>PBKDF2 derivation and verification.</dd><dt><a class="mod" href="pkcs8/index.html" title="mod ring::pkcs8">pkcs8</a></dt><dd>PKCS#8 is specified in <a href="https://tools.ietf.org/html/rfc5958">RFC 5958</a>.</dd><dt><a class="mod" href="rand/index.html" title="mod ring::rand">rand</a></dt><dd>Cryptographic pseudo-random number generation.</dd><dt><a class="mod" href="rsa/index.html" title="mod ring::rsa">rsa</a></dt><dd>RSA.</dd><dt><a class="mod" href="signature/index.html" title="mod ring::signature">signature</a></dt><dd>Public key signatures: signing and verification.</dd></dl><h2 id="macros" class="section-header">Macros<a href="#macros" class="anchor">§</a></h2><dl class="item-table"><dt><a class="macro" href="macro.test_file.html" title="macro ring::test_file">test_<wbr>file</a><wbr><span class="stab deprecated" title="">Deprecated</span></dt><dd>References a test input file.</dd></dl></section></div></main></body></html> |