Crate bc_crypto

Introduction

bc-crypto is a exposes a uniform API for the cryptographic primitives used in higher-level Blockchain Commons projects such as Gordian 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
Cryptographic digest	SHA-512	sha2
Hashed Message Authentication Codes	HMAC-SHA-256	hmac
Hashed Message Authentication Codes	HMAC-SHA-512	hmac
Password Expansion	PBKDF2-HMAC-SHA-256	pbkdf2
Key Derivation	HKDF-HMAC-SHA-256	hkdf
Symmetric Encryption	IETF-ChaCha20-Poly1305	chacha20poly1305
Key Agreement	X25519	x25519-dalek
Signing/Verification	ECDSA	secp256k1
Signing/Verification	Schnorr	secp256k1
Secure Random Number Generation	NA	getrandom, rand
Pseudorandom Number Generation	Xoshiro256**	rand_xoshiro

Getting Started

[dependencies]
bc-crypto = "0.3.4"

Modules

• hash
  The hash module contains functions for hashing data.

Enums

• Error

Constants

• CRC32_SIZE
• ECDSA_MESSAGE_HASH_SIZE
• ECDSA_PRIVATE_KEY_SIZE
• ECDSA_PUBLIC_KEY_SIZE
• ECDSA_SIGNATURE_SIZE
• ECDSA_UNCOMPRESSED_PUBLIC_KEY_SIZE
• SCHNORR_PUBLIC_KEY_SIZE
• SCHNORR_SIGNATURE_SIZE
• SHA256_SIZE
• SHA512_SIZE
• SYMMETRIC_AUTH_SIZE
• SYMMETRIC_KEY_SIZE
• SYMMETRIC_NONCE_SIZE
• X25519_PRIVATE_KEY_SIZE
• X25519_PUBLIC_KEY_SIZE

Functions

• aead_chacha20_poly1305_decrypt
  Symmetrically decrypts the given ciphertext using ChaCha20-Poly1305.
• aead_chacha20_poly1305_decrypt_with_aad
  Symmetrically decrypts the given ciphertext using ChaCha20-Poly1305 and the given additional authenticated data (AAD).
• aead_chacha20_poly1305_encrypt
  Symmetrically encrypts the given plaintext using ChaCha20-Poly1305.
• aead_chacha20_poly1305_encrypt_with_aad
  Symmetrically encrypts the given plaintext using ChaCha20-Poly1305 and the given additional authenticated data (AAD).
• ecdsa_compress_public_key
  Compresses the given ECDSA public key.
• ecdsa_decompress_public_key
  Decompresses the given ECDSA public key.
• ecdsa_derive_private_key
  Derives the ECDSA private key from the given key material.
• ecdsa_new_private_key_using
  Generate a new ECDSA private key using the given random number generator.
• ecdsa_public_key_from_private_key
  Derives the ECDSA public key from the given private key.
• ecdsa_sign
  ECDSA signs the given message using the given private key.
• ecdsa_verify
  Verifies the given ECDSA signature using the given public key.
• memzero
  Zero out a slice of bytes
• memzero_vec_vec_u8
  Zero out a vector of vector of bytes
• schnorr_public_key_from_private_key
  Derives the Schnorr public key from the given private key.
• schnorr_sign
  Schnorr signs the given message using the given private key and user-defined tag.
• schnorr_sign_using
  Schnorr signs the given message using the given private key, user-defined tag, and random number generator.
• schnorr_verify
  Verifies the given Schnorr signature against the given message, public key, and user-defined tag, which must match the tag used to create the signature.
• x25519_agreement_public_key_from_private_key
  Derive a X25519 public key from a private key.
• x25519_derive_agreement_private_key
  Derive an X25519 agreement private key from the given key material.
• x25519_derive_signing_private_key
  Derive an X25519 signing private key from the given key material.
• x25519_new_agreement_private_key_using
  Create a new X25519 private key using the given random number generator.
• x25519_shared_key
  Compute the shared symmetric key from the given agreement private key and agreement public key.