diff --git a/sign/dilithium/dilithium.go b/sign/dilithium/dilithium.go index 9a4334e2..2814f34d 100644 --- a/sign/dilithium/dilithium.go +++ b/sign/dilithium/dilithium.go @@ -1,27 +1,31 @@ //go:generate go run gen.go -// dilithium implements the CRYSTALS-Dilithium signature schemes +// Deprecated. This package implements Dilithium, an early proposal +// for what is now ML-DSA (FIPS 204). An implementation of ML-DSA +// can be found in sign/mldsa. +// +// Dilithium implements the CRYSTALS-Dilithium signature schemes // as submitted to round3 of the NIST PQC competition and described in // // https://pq-crystals.org/dilithium/data/dilithium-specification-round3-20210208.pdf // -// Each of the eight different modes of Dilithium is implemented by a +// Each of the three different modes of Dilithium is implemented by a // subpackage. For instance, Dilithium2 (the recommended mode) // can be found in // // github.com/cloudflare/circl/sign/dilithium/mode2 // // If your choice for mode is fixed compile-time, use the subpackages. -// This package provides a convenient wrapper around all of the subpackages -// so one can be chosen at runtime. +// To choose a scheme at runtime, use the generic signatures API under +// +// github.com/cloudflare/circl/sign/schemes // -// The authors of Dilithium recommend to combine it with a "pre-quantum" -// signature scheme. The packages +// The packages // // github.com/cloudflare/circl/sign/eddilithium2 // github.com/cloudflare/circl/sign/eddilithium3 // -// implement such hybrids of Dilithium2 with Ed25519 respectively and +// implement hybrids of Dilithium2 with Ed25519 respectively and // Dilithium3 with Ed448. These packages are a drop in replacements for the // mode subpackages of this package. package dilithium diff --git a/sign/mldsa/doc.go b/sign/mldsa/doc.go index d5dce574..99b9c20b 100644 --- a/sign/mldsa/doc.go +++ b/sign/mldsa/doc.go @@ -1,2 +1,12 @@ -// mldsa implements NIST post-quantum signature scheme ML-DSA. +// mldsa implements NIST post-quantum signature scheme ML-DSA (FIPS204) +// +// Each of the three different security levels of ML-DSA is implemented by a +// subpackage. For instance, mldsa44 can be found in +// +// github.com/cloudflare/circl/sign/mldsa/mldsa44 +// +// If your choice for mode is fixed compile-time, use the subpackages. +// To choose a scheme at runtime, use the generic signatures API under +// +// github.com/cloudflare/circl/sign/schemes package mldsa