Skip to content

Latest commit

 

History

History
40 lines (31 loc) · 1.75 KB

README.md

File metadata and controls

40 lines (31 loc) · 1.75 KB

SLH-DSA

Test And Build codecov PyPI - Downloads GitHub License

The SLH-DSA project implements the stateless-hash digital signing algorithm(standardizing fips 205, adopted on Sphincs-Plus algorithm) in pure Python.

This project offers those future:

  1. 🍻 Zero dependencies!
  2. 🏷️ 100% type hint for all the codes!
  3. ✅ Extreme good 99% test coverage!
  4. 🔖 Support any newer python version!
  5. ⚒️ Design for Human!
  6. 🎉 More futures coming soon!

The functionality is extremely simple to use, as demonstrated by the following example:

from slhdsa import KeyPair, shake_256f, PublicKey

kp = KeyPair.gen(shake_256f)  # generate the keypair
sig = kp.sign(b"Hello World!")  # sign the message
kp.verify(b"Hello World!", sig)  # -> True
kp.verify(b"Hello World!", b"I'm the hacker!") # -> False
kp.verify(b"hello world!", sig)  # -> False
sig = kp.sign(b"Hello World!", randomize = True)  # sign the message randomized
kp.verify(b"Hello World!", sig)  # -> True

digest = kp.pub.digest()  # generate the digest of the public key so that other device could verify the sign
pub = PublicKey.from_digest(digest)  # generate public key
pub.verify(b"Hello World!", sig)  # -> True
pub.verify(b"Hello World", sig)  # -> False

Copyright

Copyright(c) Colinxu2020 2024 All Rights Reserved.

This software is licensed under GNU Lesser General Public License Version 3 or later(on your option).