12 releases

0.2.7 Aug 16, 2022
0.2.6 Aug 13, 2022
0.2.2 Jul 22, 2022
0.1.7 Jul 9, 2022
0.1.0 May 22, 2022

#784 in Magic Beans

Download history 357/week @ 2022-08-19 318/week @ 2022-08-26 324/week @ 2022-09-02 385/week @ 2022-09-09 235/week @ 2022-09-16 473/week @ 2022-09-23 333/week @ 2022-09-30 288/week @ 2022-10-07 99/week @ 2022-10-14 276/week @ 2022-10-21 353/week @ 2022-10-28 468/week @ 2022-11-04 288/week @ 2022-11-11 286/week @ 2022-11-18 156/week @ 2022-11-25 35/week @ 2022-12-02

865 downloads per month
Used in 104 crates (69 directly)

Apache-2.0

305KB
5K SLoC


id: crypto title: Crypto custom_edit_url: https://github.com/aptos-labs/aptos-core/edit/main/crypto/crypto/README.md

The crypto component hosts all the implementations of cryptographic primitives we use in Aptos: hashing, signatures, multisignatures, aggregate signatures, and key derivation/generation.

To enforce type-safety for signature schemes, we rely on traits from traits.rs and validatable.rs.

Overview

Aptos makes use of several cryptographic algorithms:

  • SHA-3 as the main hash function
  • HKDF: HMAC-based Extract-and-Expand Key Derivation Function
    • Standardized in RFC 5869
    • Used to generate keys from a salt (optional), seed, and application-info (optional)
  • Ed25519 signatures and (naive) multisignatures
    • Based on the ed25519-dalek crate with additional security checks (e.g., for malleability)
  • Boneh-Shacham-Lynn (BLS) multisignatures and aggregate signatures
    • Based on the blst crate
    • Implemented on top of Barreto-Lynn-Scott BLS12-381 elliptic curves
  • The Noise Protocol Framework
    • Used to create authenticated and encrypted communications channels between validators
  • X25519 key exchange

Traits for safer cryptography implementation

Before implementing a cryptographic primitive, be sure to read traits.rs and validatable.rs to understand how to comply with our API as well as some of the security concerns involved.

How is this module organized?

    crypto/src
    ├── bls12-381/          # Boneh-Lynn-Shacham (BLS) signatures over (Barreto-Lynn-Scott) BLS12-381 curves
    ├── unit_tests/         # Unit tests
    ├── lib.rs
    ├── ed25519.rs          # Ed25519 implementation of the signing/verification API in traits.rs
    ├── hash.rs             # Hash function (SHA-3)
    ├── hkdf.rs             # HKDF implementation
    ├── multi_ed25519.rs    # MultiEd25519 implementation of the signing/verification API in traits.rs
    ├── noise.rs            # Noise Protocol Framework implementation
    ├── test_utils.rs
    ├── traits.rs           # Traits for safer implementations of signature schemes
    ├── validatable.rs      # Traits for deferring validation of group elements (e.g., public keys, signatures)
    └── x25519.rs           # X25519 implementation

Changelog

  • This crate historically had support for (a different) BLS12-381, EC-VRF, and SLIP-0010, though were removed due to lack of use. The last git revision before the removal is 00301524.

Dependencies

~13MB
~358K SLoC