      1
      2
      3
      4
      5
      6
      7
      8
      9
     10
     11
     12
     13
     14
     15
     16
     17
     18
     19
     20
     21
     22
     23
     24
     25
     26
     27
     28
     29
     30
     31
     32
     33
     34
     35
     36
     37
     38
     39
     40
     41
     42
     43
     44
     45
     46
     47
     48
     49
     50
     51
     52
     53
     54
     55
     56
     57
     58
     59
     60
     61
     62
     63
     64
     65
     66
     67
     68
     69
     70
     71
     72
     73
     74
     75
     76
     77
     78
     79
     80
     81
     82
     83
     84
     85
     86
     87
     88
     89
     90
     91
     92
     93
     94
     95
     96
     97
     98
     99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186

    // Copyright 2015-2016 Brian Smith.
    //
    // Permission to use, copy, modify, and/or distribute this software for any
    // purpose with or without fee is hereby granted, provided that the above
    // copyright notice and this permission notice appear in all copies.
    //
    // THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
    // WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
    // MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY
    // SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
    // WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
    // OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
    // CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

    //! Safe, fast, small crypto using Rust with BoringSSL's cryptography
    //! primitives.
    //!
    //! <code>git clone https://github.com/briansmith/ring</code>
    //!
    //! # Feature Flags
    //!
    //! <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>

    #![doc(html_root_url="https://briansmith.org/rustdoc/")]

    #![allow(
        legacy_directory_ownership,
        missing_copy_implementations,
        missing_debug_implementations,
        unknown_lints,
        unsafe_code,
    )]
    #![deny(
        const_err,
        dead_code,
        deprecated,
        exceeding_bitshifts,
        fat_ptr_transmutes,
        improper_ctypes,
        missing_docs,
        mutable_transmutes,
        no_mangle_const_items,
        non_camel_case_types,
        non_shorthand_field_patterns,
        non_snake_case,
        non_upper_case_globals,
        overflowing_literals,
        path_statements,
        plugin_as_library,
        private_no_mangle_fns,
        private_no_mangle_statics,
        stable_features,
        trivial_casts,
        trivial_numeric_casts,
        unconditional_recursion,
        unknown_crate_types,
        unreachable_code,
        unstable_features,
        unused_allocation,
        unused_assignments,
        unused_attributes,
        unused_comparisons,
        unused_extern_crates,
        unused_features,
        unused_imports,
        unused_import_braces,
        unused_qualifications,
        unused_must_use,
        unused_mut,
        unused_parens,
        unused_results,
        unused_unsafe,
        unused_variables,
        variant_size_differences,
        warnings,
        while_true,
    )]

    #![no_std]

    #![cfg_attr(feature = "internal_benches", allow(unstable_features))]
    #![cfg_attr(feature = "internal_benches", feature(test))]

    #[cfg(any(feature = "use_heap", target_os = "linux"))]
    extern crate libc;

    #[cfg(feature = "internal_benches")]
    extern crate test as bench;

    #[cfg(any(target_os = "redox",
              all(unix,
                  not(any(target_os = "macos", target_os = "ios")),
                  any(not(target_os = "linux"),
                      feature = "dev_urandom_fallback"))))]
    #[macro_use]
    extern crate lazy_static;

    // `ring::test` uses the formatting & printing stuff in non-test mode.
    #[macro_use]
    extern crate std;

    extern crate untrusted;

    #[path = "arithmetic/arithmetic.rs"]
    mod arithmetic;

    #[macro_use]
    mod bssl;

    #[macro_use]
    mod polyfill;

    #[path = "aead/aead.rs"]
    pub mod aead;

    pub mod agreement;

    #[cfg(feature = "use_heap")]
    mod bits;

    mod c;
    mod chacha;
    pub mod constant_time;

    #[doc(hidden)]
    pub mod der;

    #[path = "digest/digest.rs"]
    pub mod digest;

    #[path = "ec/ec.rs"]
    mod ec;

    pub mod error;
    pub mod hkdf;
    pub mod hmac;
    mod init;
    mod limb;
    pub mod pbkdf2;
    mod pkcs8;
    mod poly1305;
    pub mod rand;

    #[cfg(feature = "use_heap")]
    #[path = "rsa/rsa.rs"]
    mod rsa;

    pub mod signature;
    mod signature_impl;

    #[cfg(any(feature = "use_heap", test))]
    pub mod test;

    mod private {
        /// Traits that are designed to only be implemented internally in *ring*.
        //
        // Usage:
        // ```
        // use private;
        //
        // pub trait MyType : private::Private {
        //     // [...]
        // }
        //
        // impl private::Private for MyType { }
        // ```
        pub trait Private {}
    }

    #[cfg(test)]
    mod tests {
        bssl_test!(test_constant_time, bssl_constant_time_test_main);
    }

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
⇤
  Move up in search results
⇥
  Move down in search results
⏎
  Go to active search result
+
  Collapse/expand all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)