commit	c798728deed6d3f681c9e6bfd7fe8a6705f5638b	[log] [tgz]
author	Russ Housley <[email protected]>	Thu Oct 26 12:28:46 2023 -0400
committer	GitHub <[email protected]>	Thu Oct 26 12:28:46 2023 -0400
tree	bde0e8709e1b4fb850df0b5032cf96e551af43d2
parent	69baa46ec71545b8765c99e52f9b37a1ffef94c8 [diff]
parent	f384581ccf5b77a6b1eadcb5671ac28acd8312de [diff]

tree: bde0e8709e1b4fb850df0b5032cf96e551af43d2

README.md

pyhsslms

HSS/LMS Digital Signature library for Python

This Python package contains a free and open source implementation of HSS/LMS Hash-based Digital Signatures as defined in RFC 8554.

Features

Generate HSS/LMS private keys and then sign with them
Validate signatures with HSS/LMS public keys
100% Python, works with Python 2.7 and 3.5+

How to use pyhsslms

Generate a HSS/LMS private key:

priv_key = pyhsslms.HssLmsPrivateKey.genkey('mykey', levels=2)

The private key is stored in mykey.prv, and the public key is stored in mykey.pub. Of course, the mykey.prv must be protected from disclosure, and it gets updated every time a signature is created. Restoring mykey.prv from backup can cause a node in the tree to be used more that once, forfeiting all security.

Sign a file with a HSS/LMS private key:

priv_key.signFile('myfile.txt')

The private key was generated above is used to sign the content of myfile.txt, and the signature is stored in myfile.txt.sig.

Sign a buffer with a HSS/LMS private key:

sigbuf = prv_key.sign(buffer)

The private key was generated above is used to sign the content of buffer, and the signature is returned in sigbuf.

Verify a signature on a file with a HSS/LMS public key:

pub_key = pyhsslms.HssLmsPublicKey('mykey')
if pub_key.verifyFile('myfile.txt'):
    print('Signature is valid')
else:
    print('Signature is NOT valid!')

Verify a signature on a buffer with a HSS/LMS public key:

pub_key = pyhsslms.HssLmsPublicKey('mykey')
validity = pub_key.verify(buffer, sigbuf)
if validity:
    print('Signature is valid')
else:
    print('Signature is NOT valid!')

How to get pyhsslms

The pyhsslms package is distributed under terms and conditions of license.

Source code is freely available as a GitHub repo.

You could pip install pyhsslms or download it from PyPI.