Skip to main content

License MIT

FIPS Standards Implementations

This repository contains a python implementation of:

  1. ML-DSA the NIST Module-Lattice-Based Digital Signature Standard following the FIPS 204.

Licenses

This project is licensed under the License MIT.

Disclaimer

This implementation follows instructions given in FIPS 204 as it is for all algorithms.

With sole exception of Algorithm 43 BitRev as zeta values are precomputed and hardcoded.

Documentation

Complete documentation of this repository is available at https://kyuuaditya.github.io/fips-collection-python/

Using fips

FIPS 204 - MLDSA

The MLDSA class contains 3 main functions:

  • MLDSAKeyGen(): generates a public-private keypair (public_key, secret_key)
  • MLDSASign(secret_key, Message, ctx): generates an MLDSA signature sigature from the message message and bit-packed secret key secret_key.
  • MLDSAVerify(public_key, message, signature): verifies a signature rho for a message M.

To use FIPS 204 - MLDSA simply import as follows:

from fips import MLDSA_44, MLDSA_65, MLDSA_87

Example Use Case

from fips import MLDSA_44

mldsa128 = MLDSA_44

# Generate the public-private key pair.
public_key, secret_key = mldsa128.MLDSAKeyGen()

context = b'ab'
message = "du bis gut"
message_spoof = "you are good"

# Generate the signature.
signature = mldsa128.MLDSASign(secret_key, mldsa128.auxilary.BytesToBits(message.encode()), context)

# Verification will only pass with the correct corresponding public key.
assert mldsa128.MLDSAVerify(public_key, mldsa128.auxilary.BytesToBits(message.encode()), signature, context)

# Verification will fail with an altered message.
assert not MLDSA_44.MLDSAVerify(public_key, MLDSA_44.auxilary.BytesToBits(message_spoof.encode()), signature, context)

# Verification will fail with any other public key.
public_key_new, secret_key_new = MLDSA_44.MLDSAKeyGen()
assert not MLDSA_44.MLDSAVerify(public_key_new, MLDSA_44.auxilary.BytesToBits(message.encode()), signature, context)

The above example would also work with the other NIST levels MLDSA_65 and MLDSA_87.

Hash ML-DSA

Algorithm 4 and 5 of FIPS 204 are not yet added to this implementation.

Benchmarks

FIPS 204 - MLDSA Performance:

MLDSA_44 MLDSA_65 MLDSA_87
KeyGen() Average Time 8.4 ms 14.1 ms 22.3 ms
Sign() Average Time 78.0 ms 127.1 ms 144.3 ms
Verify() Average Time 20.9 ms 29.9 ms 43.6 ms

Data recorded using a Ryzen 7 4800H CPU averaged over 1000 calls.

Colaborations

Feel free to modify and share improvements.

Metadata

Release files for fips-collection 1.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for fips-collection 1.0.0
File Size Uploaded Provenance Actions
fips_collection-1.0.0.tar.gz 33.4 kB Without provenance Details for fips_collection-1.0.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for fips-collection 1.0.0
File Interpreter ABI Platform Actions
fips_collection-1.0.0-py3-none-any.whl Python 3 none any Details for fips_collection-1.0.0-py3-none-any.whl

Total release size: 61.0 kB

Release files / fips_collection-1.0.0.tar.gz

Download URL fips_collection-1.0.0.tar.gz
Size 33.4 kB
Tags Source
SHA-256 checksum
How to use checksums
51698f83c91e069ec2daec712dfa8353aee6e3e981b740f2c8a5815042830775
BLAKE2b-256 checksum
How to use checksums
ff686bbbd713e04f1c9d0889f11ef3efec16e9ca5ce3b1b6dc2b241d7abea425
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.14.6

Release files / fips_collection-1.0.0-py3-none-any.whl

Download URL fips_collection-1.0.0-py3-none-any.whl
Size 27.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
dda7f67cd2ca6eaa53cdbebf4561ed2a29b916ce19c9d24b2fb2cce162dd1541
BLAKE2b-256 checksum
How to use checksums
d4cd87261e6f7febc5208cd332930f34298c977cd7242fe33255cac2c2fbc8cf
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.14.6

Security for fips-collection 1.0.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.0.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page