mirror of https://github.com/str4d/rage.git synced 2025-04-04 03:17:42 +03:00

A simple, secure and modern file encryption tool (and Rust library) with small explicit keys, no config options, and UNIX-style composability. https://age-encryption.org/v1

age-encryption cli curve25519 encryption rust rust-library scrypt secure-by-default unix-philosophy yubikey zero-configuration

Find a file

Jack Grigg 72bd049b23 v0.1.0		2019-12-27 22:52:40 -06:00
.github	Interop: Fix feature flags	2019-12-27 22:38:26 -06:00
examples	Make GitHub recipients unstable	2019-12-27 22:07:30 -06:00
fuzz	Use cargo patch for rsa crate	2019-12-01 13:14:58 +00:00
src	Place ssh-rsa tests behind unstable feature flag	2019-12-27 22:41:33 -06:00
.gitignore	Initial empty binary crate	2019-10-06 16:52:50 +11:00
Cargo.lock	v0.1.0	2019-12-27 22:52:40 -06:00
Cargo.toml	v0.1.0	2019-12-27 22:52:40 -06:00
LICENSE-APACHE	Add README and license info	2019-10-08 21:59:02 +13:00
LICENSE-MIT	Add README and license info	2019-10-08 21:59:02 +13:00
README.md	Doc updates	2019-12-27 22:31:51 -06:00

README.md

rage: Rust implementation of age

age is a simple, secure and modern encryption tool with small explicit keys, no config options, and UNIX-style composability.

The spec is at https://age-encryption.org/v1.
The reference implementation is https://filippo.io/age.

rage is a Rust implementation of the age tool. It is pronounced like the Japanese らげ (with a hard g).

To discuss the spec or other age related topics, please email the mailing list at age-dev@googlegroups.com. Subscribe at groups.google.com/d/forum/age-dev or by emailing age-dev+subscribe@googlegroups.com.

Usage

Usage: rage [OPTIONS]

Positional arguments:
  input                      file to read input from (default stdin)

Optional arguments:
  -h, --help                 print help message
  -d, --decrypt              decrypt the input (default is to encrypt)
  -p, --passphrase           use a passphrase instead of public keys
  -a, --armor                create ASCII armored output (default is age binary format)
  -r, --recipient RECIPIENT  recipient to encrypt to (may be repeated)
  -i, --identity IDENTITY    identity to decrypt with (may be repeated)
  -o, --output OUTPUT        output to OUTPUT (default stdout)

Installation

The rage suite of tools are provided in the age Rust crate. If your system has Rust 1.37+ installed (either via rustup or a system package), you can build directly from source:

cargo install age

You can also use the age crate directly as a library, by adding this line to your Cargo.toml (which disables the CLI tools):

age = { version = "0.1", default-features = false }

Feature flags

cli enables the rage and rage-keygen tools, and is enabled by default.
mount enables the rage-mount tool, which can mount age-encrypted TAR or ZIP archives as read-only. It is currently only usable on Unix systems, as it relies on libfuse.
unstable enables in-development functionality. Anything behind this feature flag has no stability or interoperability guarantees.

License

Licensed under either of

Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.