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

//! This is a pure, safe Rust reimplementation of [LibSolraXandria][1]. It
//! provides implementations of the [Twofish][2] block cipher and the
//! [SHA-256][3] cryptographic hash function.
//!
//! Like its C99 ancestor, the library is fairly simple, runs with reasonable
//! speed, uses very little memory, and makes no use whatsoever of the heap
//! (but you are, of course, free to allocate its state objects on the heap
//! rather than the stack if you want to). Unlike its C99 ancestor, it is
//! written 100% in safe Rust code. This does not come at any cost in
//! performance; the Rust version and its C99 ancestor are generally neck and
//! neck in benchmarks.
//!
//! Theoretically, `std` is not required, but this has not been tested.
//!
//! [1]: https://github.com/SolraBizna/lsx
//! [2]: https://en.wikipedia.org/wiki/Twofish
//! [3]: https://en.wikipedia.org/wiki/SHA-2
//!
//! Usage
//! -----
//!
//! Add to your `Cargo.toml`, under `[dependencies]`:
//!
//! ```toml
//! lsx = "1.1"
//! ```
//!
//! Or, if you want only SHA-256 support:
//!
//! ```toml
//! lsx = {version = "1.1", default-features = false, features = ["sha256"]}
//! ```
//!
//! Or only Twofish:
//!
//! ```toml
//! lsx = {version = "1.1", default-features = false, features = ["twofish"]}
//! ```
//!
//! See the respective module documentation for further information.
//!
//! License
//! -------
//!
//! This library is distributed under the zlib license. This puts very few
//! restrictions on use. See `LICENSE.md` for the complete, very short text of
//! the license.

#![forbid(unsafe_code)]

#[macro_use]
extern crate arrayref;

#[cfg(feature="sha256")]
pub mod sha256;
#[cfg(feature="twofish")]
pub mod twofish;

#[cfg(feature="sha256")]
pub use sha256::{RawSha256, BufSha256};
#[cfg(feature="twofish")]
pub use twofish::Twofish;