bc-crypto 0.14.0

A uniform API for cryptographic primitives used in Blockchain Commons projects
Documentation 
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

#![doc(html_root_url = "https://docs.rs/bc-crypto/0.14.0")]
#![warn(rust_2018_idioms)]

//! # Introduction
//!
//! `bc-crypto` is a exposes a uniform API for the cryptographic primitives used in higher-level [Blockchain Commons](https://blockchaincommons.com) projects such as [Gordian Envelope](https://crates.io/crates/bc-envelope). The various providers listed below may change, but the API this package provides should be stable.
//!
//! | Category | Algorithm | Provider
//! |---|---|---
//! | Cryptographic digest | SHA-256 | [sha2](https://crates.io/crates/sha2)
//! | Cryptographic digest | SHA-512 | [sha2](https://crates.io/crates/sha2)
//! | Hashed Message Authentication Codes | HMAC-SHA-256 | [hmac](https://crates.io/crates/hmac)
//! | Hashed Message Authentication Codes | HMAC-SHA-512 | [hmac](https://crates.io/crates/hmac)
//! | Password Expansion | PBKDF2-HMAC-SHA-256 | [pbkdf2](https://crates.io/crates/pbkdf2)
//! | Key Derivation | HKDF-HMAC-SHA-256 |  [hkdf](https://crates.io/crates/hkdf)
//! | Symmetric Encryption | IETF-ChaCha20-Poly1305 | [chacha20poly1305](https://crates.io/crates/chacha20poly1305)
//! | Key Agreement | X25519 | [x25519-dalek](https://crates.io/crates/x25519-dalek)
//! | Signing/Verification | ECDSA | [secp256k1](https://crates.io/crates/secp256k1)
//! | Signing/Verification | Schnorr | [secp256k1](https://crates.io/crates/secp256k1)
//! | Secure Random Number Generation | NA | [getrandom](https://crates.io/crates/getrandom), [rand](https://crates.io/crates/rand)
//! | Pseudorandom Number Generation | Xoshiro256** | [rand_xoshiro](https://crates.io/crates/rand_xoshiro)
//!
//! # Getting Started
//!
//! ```toml
//! [dependencies]
//! bc-crypto = "0.14.0"
//! ```

pub mod error;
pub use error::{Error, Result};

/// The `hash` module contains functions for hashing data.
pub mod hash;
pub use hash::{
    CRC32_SIZE, SHA256_SIZE, SHA512_SIZE, double_sha256, hkdf_hmac_sha256,
    hmac_sha256, hmac_sha512, pbkdf2_hmac_sha256, sha256, sha512,
};

mod memzero;
pub use memzero::{memzero, memzero_vec_vec_u8};

mod symmetric_encryption;
pub use symmetric_encryption::{
    SYMMETRIC_AUTH_SIZE, SYMMETRIC_KEY_SIZE, SYMMETRIC_NONCE_SIZE,
    aead_chacha20_poly1305_decrypt, aead_chacha20_poly1305_decrypt_with_aad,
    aead_chacha20_poly1305_encrypt, aead_chacha20_poly1305_encrypt_with_aad,
};

mod public_key_encryption;
pub use public_key_encryption::{
    X25519_PRIVATE_KEY_SIZE, X25519_PUBLIC_KEY_SIZE,
    derive_agreement_private_key, derive_signing_private_key,
    x25519_new_private_key_using, x25519_public_key_from_private_key,
    x25519_shared_key,
};

#[cfg(feature = "secp256k1")]
mod ecdsa_keys;
#[cfg(feature = "secp256k1")]
pub use ecdsa_keys::{
    ECDSA_MESSAGE_HASH_SIZE, ECDSA_PRIVATE_KEY_SIZE, ECDSA_PUBLIC_KEY_SIZE,
    ECDSA_SIGNATURE_SIZE, ECDSA_UNCOMPRESSED_PUBLIC_KEY_SIZE,
    SCHNORR_PUBLIC_KEY_SIZE, ecdsa_compress_public_key,
    ecdsa_decompress_public_key, ecdsa_derive_private_key,
    ecdsa_new_private_key_using, ecdsa_public_key_from_private_key,
    schnorr_public_key_from_private_key,
};

#[cfg(feature = "secp256k1")]
mod ecdsa_signing;
#[cfg(feature = "secp256k1")]
pub use ecdsa_signing::{ecdsa_sign, ecdsa_verify};

#[cfg(feature = "secp256k1")]
mod schnorr_signing;
#[cfg(feature = "secp256k1")]
pub use schnorr_signing::{
    SCHNORR_SIGNATURE_SIZE, schnorr_sign, schnorr_sign_using,
    schnorr_sign_with_aux_rand, schnorr_verify,
};

#[cfg(feature = "ed25519")]
mod ed25519_signing;
#[cfg(feature = "ed25519")]
pub use ed25519_signing::{
    ED25519_PRIVATE_KEY_SIZE, ED25519_PUBLIC_KEY_SIZE, ED25519_SIGNATURE_SIZE,
    ed25519_new_private_key_using, ed25519_public_key_from_private_key,
    ed25519_sign, ed25519_verify,
};

mod scrypt;
pub use scrypt::{scrypt, scrypt_opt};

mod argon;
pub use argon::argon2id;

#[cfg(test)]
mod tests {
    #[test]
    fn test_readme_deps() {
        version_sync::assert_markdown_deps_updated!("README.md");
    }

    #[test]
    fn test_html_root_url() {
        version_sync::assert_html_root_url_updated!("src/lib.rs");
    }
}