CIRCL: Cloudflare Interoperable Reusable Cryptographic Library
OTHER License
CIRCL (Cloudflare Interoperable, Reusable Cryptographic Library) is a collection of cryptographic primitives written in Go. The goal of this library is to be used as a tool for experimental deployment of cryptographic algorithms targeting Post-Quantum (PQ) and Elliptic Curve Cryptography (ECC).
This library is offered as-is, and without a guarantee. Therefore, it is expected that changes in the code, repository, and API occur in the future. We recommend to take caution before using this library in a production application since part of its content is experimental. All security issues must be reported, please notify us immediately following the instructions given in our Security Policy.
You can get CIRCL by fetching:
go get -u github.com/cloudflare/circl
Alternatively, look at the Cloudflare Go fork to see how to integrate CIRCL natively in Go.
Diffie-Hellman Protocol |
---|
Digital Signature Schemes |
---|
Prime Groups |
---|
High-Level Protocols |
---|
KEM: Key Encapsulation Methods |
---|
Digital Signature Schemes |
---|
XOF: eXtendable Output Functions |
---|
LWC: Lightweight Cryptography |
---|
Integers |
---|
Finite Fields |
---|
Elliptic Curves |
---|
Library comes with number of make targets which can be used for testing and benchmarking:
test
performs testing of the binary.bench
runs benchmarks.cover
produces coverage.lint
runs set of linters on the code base.To contribute, fork this repository and make your changes, and then make a Pull Request. A Pull Request requires approval of the admin team and a successful CI build.
To cite CIRCL, use one of the following formats and update the version and date you accessed this project.
APA Style
Faz-Hernandez, A. and Kwiatkowski, K. (2019). Introducing CIRCL:
An Advanced Cryptographic Library. Cloudflare. Available at
https://github.com/cloudflare/circl. v1.4.0 Accessed Aug, 2024.
Bibtex Source
@manual{circl,
title = {Introducing CIRCL: An Advanced Cryptographic Library},
author = {Armando Faz-Hernandez and Kris Kwiatkowski},
organization = {Cloudflare},
abstract = {{CIRCL (Cloudflare Interoperable, Reusable Cryptographic Library) is
a collection of cryptographic primitives written in Go. The goal
of this library is to be used as a tool for experimental
deployment of cryptographic algorithms targeting Post-Quantum (PQ)
and Elliptic Curve Cryptography (ECC).}},
note = {Available at \url{https://github.com/cloudflare/circl}. v1.4.0 Accessed Aug, 2024},
month = jun,
year = {2019}
}
CFF Style
See attached CITATION.cff file.
The project is licensed under the BSD-3-Clause License.