github.com/cloudflare/circl@v1.5.0/sign/dilithium/dilithium.go (about)

     1  //go:generate go run gen.go
     2  
     3  // Deprecated. This package implements Dilithium, an early proposal
     4  // for what is now ML-DSA (FIPS 204). An implementation of ML-DSA
     5  // can be found in sign/mldsa.
     6  //
     7  // Dilithium implements the CRYSTALS-Dilithium signature schemes
     8  // as submitted to round3 of the NIST PQC competition and described in
     9  //
    10  // https://pq-crystals.org/dilithium/data/dilithium-specification-round3-20210208.pdf
    11  //
    12  // Each of the three different modes of Dilithium is implemented by a
    13  // subpackage.  For instance, Dilithium2 (the recommended mode)
    14  // can be found in
    15  //
    16  //	github.com/cloudflare/circl/sign/dilithium/mode2
    17  //
    18  // If your choice for mode is fixed compile-time, use the subpackages.
    19  // To choose a scheme at runtime, use the generic signatures API under
    20  //
    21  //	github.com/cloudflare/circl/sign/schemes
    22  //
    23  // The packages
    24  //
    25  //	github.com/cloudflare/circl/sign/eddilithium2
    26  //	github.com/cloudflare/circl/sign/eddilithium3
    27  //
    28  // implement hybrids of Dilithium2 with Ed25519 respectively and
    29  // Dilithium3 with Ed448.  These packages are a drop in replacements for the
    30  // mode subpackages of this package.
    31  package dilithium