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
// MIT License // Copyright (c) 2018-2020 The orion Developers // Permission is hereby granted, free of charge, to any person obtaining a copy // of this software and associated documentation files (the "Software"), to deal // in the Software without restriction, including without limitation the rights // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell // copies of the Software, and to permit persons to whom the Software is // furnished to do so, subject to the following conditions: // The above copyright notice and this permission notice shall be included in // all copies or substantial portions of the Software. // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE // SOFTWARE. //! A usable pure-Rust cryptography library. //! //! ## Authenticated secret-key encryption //! [`orion::aead`] offers authenticated secret-key encryption using //! XChaCha20Poly1305. //! //! ## Password hashing and verification //! [`orion::pwhash`] offers password hashing and verification using Argon2i. //! //! ## Key derivation //! [`orion::kdf`] offers key derivation using Argon2i. //! //! ## Message authentication //! [`orion::auth`] offers message authentication and verification using BLAKE2b. //! //! ## Hashing //! [`orion::hash`] offers hashing using BLAKE2b. //! //! ### A note on `no_std`: //! When orion is used in a `no_std` context, the high-level API is not available, since it relies on access to the systems random number generator. //! //! More information about orion is available in the [wiki](https://github.com/brycx/orion/wiki). //! //! [`orion::aead`]: aead/index.html //! [`orion::pwhash`]: pwhash/index.html //! [`orion::kdf`]: kdf/index.html //! [`orion::auth`]: auth/index.html //! [`orion::hash`]: hash/index.html #![cfg_attr(not(feature = "safe_api"), no_std)] #![forbid(unsafe_code)] #![deny(clippy::mem_forget)] #![warn( missing_docs, rust_2018_idioms, trivial_casts, unused_qualifications, overflowing_literals )] #![doc(html_root_url = "https://docs.rs/orion/0.15.1")] #[cfg(test)] #[cfg(feature = "safe_api")] #[macro_use] extern crate quickcheck; #[macro_use] mod typedefs; #[macro_use] /// Utilities such as constant-time comparison. pub mod util; /// Errors for orion's cryptographic operations. pub mod errors; /// [__**Caution**__] Low-level API. pub mod hazardous; #[cfg(feature = "safe_api")] mod high_level; #[cfg(feature = "safe_api")] pub use high_level::hash; #[cfg(feature = "safe_api")] pub use high_level::aead; #[cfg(feature = "safe_api")] pub use high_level::auth; #[cfg(feature = "safe_api")] pub use high_level::pwhash; #[cfg(feature = "safe_api")] pub use high_level::kdf; #[doc(hidden)] /// Testing framework. pub mod test_framework;