age-plugin-simplepq

Crates.ioage-plugin-simplepq
lib.rsage-plugin-simplepq
version0.1.2
sourcesrc
created_at2023-08-28 08:37:33.400025
updated_at2023-08-28 17:50:20.704075
descriptionSimple Post-Quantum plugin for age clients based on ML-KEM.
homepagehttps://github.com/thibmeu/age-plugin-simplepq
repositoryhttps://github.com/thibmeu/age-plugin-simplepq
max_upload_size
id956695
size56,760
Thibault (thibmeu)

documentation

README

age-plugin-simplepq: Simple Post Quantum plugin for age

Documentation License crates.io

age-plugin-simplepq is a plugin for age. It provides an age Identity and Recipient consuming X25519Kyber768Draft00 encoded files.

age-plugin are defined by C2SP.

Tables of Content

Features

  • Post Quantum recipients and identities with X25519Kyber768Draft00
  • Plugin cli for age
  • Cross platform (Linux, Windows, macOS)

What's next

  • Agree on age format

Installation

Environment CLI Command
Cargo (Rust 1.67+) cargo install age-plugin-simplepq

Read age installation instructions to install age.

Usage

You can use the --help option to get more details about the command and its options.

age-plugin-simplepq [-o OUTPUT]
age-keygen-simplepq -y [-o OUTPUT] [INPUT]

Generate recipient and identity

age-plugin-simplepq -o my_id.key

For convenience, you can also create an associated recipient

age-plugin-simplepq -y -o my_id.key my_id.key

The recipient and identity size are going to be large.

Encrypt and decrypt

Encrypt Hello age-plugin-simplepq! string with your new key.

echo 'Hello age-plugin-simplepq!' | age -a -R my_id.key.pub > data.age
age --decrypt -i my_id.key data.age
Hello age-plugin-simplepq!

Security Considerations

This software has not been audited. Please use at your sole discretion. With this in mind, age-plugin-simplepq security relies on the following:

FAQ

Empty

License

This project is under the MIT license.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you shall be MIT licensed as above, without any additional terms or conditions.

Commit count: 7

cargo fmt