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

// MIT License

// Copyright (c) 2018 brycx

// 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.

//! orion - A usable pure-Rust cryptography library.
//!
//! Most functionality that you would need access to should be available through orion's `default`
//! API. This API includes authenticated secret-key encryption, password hashing and more.
//!
//! Usage of the `hazardous` module is only intended for advanced users.
//!
//! You can read more about orion in the project [wiki](https://github.com/brycx/orion/wiki).
#![cfg_attr(not(feature = "safe_api"), no_std)]
#![forbid(unsafe_code)]
#![deny(overflowing_literals)]
#![deny(missing_docs)]

extern crate byteorder;
#[cfg(feature = "safe_api")]
extern crate rand;
extern crate seckey;
extern crate sha2;
extern crate subtle;
extern crate tiny_keccak;

/// Core functionality such as generating a salt/key/IV/nonce.
pub mod util;

/// Errors for orion's cryptographic operations.
pub mod errors;

#[cfg(feature = "safe_api")]
/// High-level API with safer defaults. Not available in a `no_std` context.
pub mod default;

/// Low-level API.
pub mod hazardous;