README
¶
HPQC
HPQC is known as hpqc.
hybrid post quantum cryptography
Hybrid cryptographic constructions rely on a classical public key primitive and a post quantum public key cryptographic primitive, namely:
- hybrid KEMs
- hybrid NIKEs
- hybrid signature schemes
This entire cryptography library is rendered in serviced to the above post quantum trifecta of cryptographic primitives. However, our main contributions are the following:
- a set of generic NIKE interfaces for NIKE scheme, public key and private key types
- generic hybrid NIKE, combines any two NIKEs into one
- secure KEM combiner that can combine an arbtrary number of KEMs into one KEM
- a "NIKE to KEM adapter" which uses an ad hoc hashed elgamal construction
- cgo bindings for the Sphincs+ C reference source
- cgo bindings for the CTIDH C source
- generic hybrid signature scheme, combines any two signature schemes into one
All that having been said, we get our cryptographic primitives mostly from other cryptography projects such as circl, highctidh, katzenpost, various golang cryptography libraries on github etc.
If you want a well known hybrid KEM that has a paper about it then maybe Xwing is the KEM you are looking for. Otherwise you can construct your own using our secure KEM combiner and or NIKE to KEM adapter.
Our secure KEM combiner is based on the Split PRF KEM combiner from this paper:
Secure KEM Combiner https://eprint.iacr.org/2018/024.pdf
| NIKE: Non-Interactive Key Exchange |
|---|
- X25519
- CTIDH511, CTIDH512, CTIDH1024, CTIDH2048
- X25519_CTIDH511, X25519_CTIDH512, X25519_CTIDH1024, X25519_CTIDH2048
- NOBS_CSIDH-512
- X25519_NOBS_CSIDH-512
| KEM: Key Encapsulation Methods |
|---|
- X25519 (adapted via ad hoc hashed elgamal construction)
- CTIDH1024 (adapted via ad hoc hashed elgamal construction)
- MLKEM-768
- Xwing
- McEliece
- NTRUPrime
- Kyber
- FrodoKEM
| SIGN: Cryptographic Signature Schemes |
|---|
- ed25519
- sphincs+
- ed25519_sphincs+
- ed25519_dilithium2/3
licensing
hpqc is free libre open source software (FLOSS) under the AGPL-3.0 software license. This git repository provides a LICENSE file, here: https://github.com/katzenpost/hpqc/blob/main/LICENSE
Read about free software philosophy --> https://www.gnu.org/philosophy/free-sw.html
- There are precisely two files which were borrowed
from cloudflare's
circlcryptography library which provide the kem and signature interfaces:
- https://github.com/katzenpost/hpqc/blob/main/kem/interfaces.go
- https://github.com/katzenpost/hpqc/blob/main/sign/interfaces.go
Those two files have their licenses attached at the top in a code comment.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package kem provides a unified interface for KEM schemes.
|
Package kem provides a unified interface for KEM schemes. |
|
adapter
Package adapter provides an adhoc hashed ElGamal construction that essentially acts like an adapter, adapting a NIKE to KEM.
|
Package adapter provides an adhoc hashed ElGamal construction that essentially acts like an adapter, adapting a NIKE to KEM. |
|
combiner
Package combiner defines a KEM combiner type that can combine any number of KEMs.
|
Package combiner defines a KEM combiner type that can combine any number of KEMs. |
|
mlkem768
Package mlkem768 provides a KEM wrapper that uses our KEM interfaces.
|
Package mlkem768 provides a KEM wrapper that uses our KEM interfaces. |
|
sntrup
This package provide the Streamlined NTRU Prime KEM.
|
This package provide the Streamlined NTRU Prime KEM. |
|
xwing
Package xwing provides the xwing KEM using a KEM wrapper so that it obeys our KEM interfaces for Scheme, PrivateKey, PublicKey.
|
Package xwing provides the xwing KEM using a KEM wrapper so that it obeys our KEM interfaces for Scheme, PrivateKey, PublicKey. |
|
Package nike contains generic NIKE interfaces and many implementations.
|
Package nike contains generic NIKE interfaces and many implementations. |
|
Package rand provides various utitilies related to generating cryptographically secure random numbers and byte vectors.
|
Package rand provides various utitilies related to generating cryptographically secure random numbers and byte vectors. |
|
Package sign implements signature scheme interfaces and implementations.
|
Package sign implements signature scheme interfaces and implementations. |
|
ed25519
Package is our ed25519 wrapper type which also conforms to our generic interfaces for signature schemes.
|
Package is our ed25519 wrapper type which also conforms to our generic interfaces for signature schemes. |
|
sphincsplus
Package sphincsplus implements interface wrapper around a specific parameterization of Sphincs+.
|
Package sphincsplus implements interface wrapper around a specific parameterization of Sphincs+. |