mercuryPQCrypto-README

1 mercuryPQCrypto: Mercury Cryptography Project

mercuryPQCrypto is a cryptography project conducted by Chongqing University, China, which considers crypto agility and integrates go 1.14.10 crypto¹, Open Quantum Safe (OQS) liboqs/liboqs-go 0.7.1² and tjfoc gmsm-1.4.1³. This project aims to study the migration and application adaptation of post quantum cryptography (PQC) algorithms and Chinese national commercial cryptography algorithms (sm-series).

We have integrated NIST Post-Quantum Cryptography Standardization round 3 digital signature finalists though OQS liboqs/liboqs-go, including:

• CRYSTALS-Dilithium: Dilithium2, Dilithium3, Dilithium5, Dilithium2-AES, Dilithium3-AES, Dilithium5-AES
• Falcon: Falcon-512, Falcon-1024
• Rainbow: Rainbow-III-Classic, Rainbow-III-Circumzenithal, Rainbow-III-Compressed, Rainbow-V-Classic, Rainbow-V-Circumzenithal, Rainbow-V-Compressed

It's important to note that since a new work⁴ makes key-recovery practical for the Rainbow SL 1 parameters become possible, we will not integrate SL 1 parameters in the future work.

And Chinese national commercial cryptography algorithms by tjfoc gmsm:

• SM2
• SM3
• SM4

Among the above algorithms, the post quantum signature algorithms not only support key generation, signature and verification, but also supports all operations in X509.go and private key format conversion in PKCS8.go. You can follow the instructions on crypto in go 1.14.10 to use them. The interfaces of mercuryPQCrypto methods are unchanged compared with go 1.14.10. Currently, the Chinese national commercial cryptography algorithms only supports simple key generation, encryption, decryption, signature, verification, and digest computation.

2 Instructions

2.1 Environment Variable

1. OS: ubuntu 18.04 +.
2. GoLang: Please make sure you have installed go 1.14.10 and/or above.
3. liboqs and liboqs-go: Please follow the project instructions of liboqs and liboqs-go and configure the corresponding environment variable, both of them must be configured correctly.

2.2 Clone the Project

git clone https://github.com/buyobuyo404/mercuryPQCrypto.git

Then put mercuryPQCrypto into $gopath/github.com/mercury folder.

2.3 Note

1. Import Package: when importing PQC algorithm packages, the package aliases need to be displayed, otherwise package conflicts may occur. You can do like this:

import (
	falcon1024 "github.com/mercury/mercuryPQCrypto/pqc/falcon/falcon1024"
	falcon512 "github.com/mercury/mercuryPQCrypto/pqc/falcon/falcon512"

	dilithium2 "github.com/mercury/mercuryPQCrypto/pqc/dilithium/dilithium2"
	dilithium2AES "github.com/mercury/mercuryPQCrypto/pqc/dilithium/dilithium2AES"
	dilithium3 "github.com/mercury/mercuryPQCrypto/pqc/dilithium/dilithium3"
	dilithium3AES "github.com/mercury/mercuryPQCrypto/pqc/dilithium/dilithium3AES"
	dilithium5 "github.com/mercury/mercuryPQCrypto/pqc/dilithium/dilithium5"
	dilithium5AES "github.com/mercury/mercuryPQCrypto/pqc/dilithium/dilithium5AES"

	rainbowIIICircumzenithal "github.com/mercury/mercuryPQCrypto/pqc/rainbow/rainbowIIICircumzenithal"
	rainbowIIIClassic "github.com/mercury/mercuryPQCrypto/pqc/rainbow/rainbowIIIClassic"
	rainbowIIICompressed "github.com/mercury/mercuryPQCrypto/pqc/rainbow/rainbowIIICompressed"
	rainbowVCircumzenithal "github.com/mercury/mercuryPQCrypto/pqc/rainbow/rainbowVCircumzenithal"
	rainbowVClassic "github.com/mercury/mercuryPQCrypto/pqc/rainbow/rainbowVClassic"
	rainbowVCompressed "github.com/mercury/mercuryPQCrypto/pqc/rainbow/rainbowVCompressed"
)

3 Future Work

1. Integrate NIST Post-Quantum Cryptography Standardization round 3 submissions digital signature algorithms alternate candidates, public-key encryption and key-establishment finalists and alternate candidates.
2. Keep a close eye on NIST Post-Quantum Cryptography Standardization round 4 and make quick adjustments accordingly.
3. Implement the algorithms in NIST PQC round 4 using go.
4. Use this project to study the pqc migration in PKI and blockchain.

4 About Us

We are post quantum cryptography research team, from School of Big Data and Software, Chongqing University, China. Our main research fields includes post quantum cryptography and its engineering migration and application.