mirrors/rage
1
0
Fork 0
mirror of https://github.com/str4d/rage.git synced 2025-04-04 11:27:43 +03:00
Code Issues Projects Releases Packages Wiki Activity

Update READMEs

Browse source
This commit is contained in:
Jack Grigg 2020-07-29 01:57:06 +12:00
parent 567d6e048f
commit a2002bc5b1
4 changed files with 28 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -1,13 +1,10 @@
# rage: Rust implementation of age # rage: Rust implementation of age
age is a simple, secure and modern encryption tool with small explicit keys, no rage is a simple, modern, and secure file encryption tool, using the *age*
config options, and UNIX-style composability. The format specification is at format. It features small explicit keys, no config options, and UNIX-style
[age-encryption.org/v1](https://age-encryption.org/v1). composability.
rage is a Rust implementation of the age tool. It is pronounced like the Japanese
[らげ](https://translate.google.com/#view=home&op=translate&sl=ja&tl=en&text=%E3%82%89%E3%81%92)
(with a hard g).
The format specification is at [age-encryption.org/v1](https://age-encryption.org/v1).
To discuss the spec or other age related topics, please email To discuss the spec or other age related topics, please email
[the mailing list](https://groups.google.com/d/forum/age-dev) at [the mailing list](https://groups.google.com/d/forum/age-dev) at
age-dev@googlegroups.com. age was designed by age-dev@googlegroups.com. age was designed by
@ -88,8 +85,6 @@ $ rage -r "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIIZDRcvS8PnhXr30WKSKmf7WKKi92ACUa
$ rage -d -i ~/.ssh/id_ed25519 example.png.age > example.png $ rage -d -i ~/.ssh/id_ed25519 example.png.age > example.png
``` ```
`ssh-rsa` support is currently behind the `unstable` feature flag.
Note that SSH key support employs more complex cryptography, and embeds a public Note that SSH key support employs more complex cryptography, and embeds a public
key tag in the encrypted file, making it possible to track files that are key tag in the encrypted file, making it possible to track files that are
encrypted to a specific public key. encrypted to a specific public key.
@ -124,6 +119,9 @@ Help from new packagers is very welcome.
ZIP archives as read-only. It is currently only usable on Unix systems, as it ZIP archives as read-only. It is currently only usable on Unix systems, as it
relies on `libfuse`. relies on `libfuse`.
- `ssh` (enabled by default) enables support for reusing existing SSH key files
for age encryption.
- `unstable` enables in-development functionality. Anything behind this feature - `unstable` enables in-development functionality. Anything behind this feature
flag has no stability or interoperability guarantees. flag has no stability or interoperability guarantees.

5
age-core/README.md
View file

@ -1,9 +1,10 @@
# age-core Rust library # age-core Rust library
This crate contains common functions used across the `age` crates. This crate contains common structs and functions used across the `age` crates.
You are probably looking for the [`age`](https://crates.io/crates/age) crate You are probably looking for the [`age`](https://crates.io/crates/age) crate
itself. itself. You should only need to directly depend on this crate if you are
implementing a custom recipient type.
## License ## License

20
age/README.md
View file

@ -1,9 +1,15 @@
# age Rust library # age Rust library
age is a simple, secure and modern encryption tool with small explicit keys, no age is a simple, modern, and secure file encryption library. It features small
config options, and UNIX-style composability. The format specification is at explicit keys, no config options, and UNIX-style composability.
[age-encryption.org/v1](https://age-encryption.org/v1).
This crate provides a set of Rust APIs that can be used to build more complex
tools based on the age format. The primary consumers of these APIs are the
[`rage`](https://crates.io/crates/rage) CLI tools, which provide straightforward
encryption and decryption of files or streams (e.g. in shell scripts), as well
as additional features such as mounting an encrypted archive.
The format specification is at [age-encryption.org/v1](https://age-encryption.org/v1).
To discuss the spec or other age related topics, please email To discuss the spec or other age related topics, please email
[the mailing list](https://groups.google.com/d/forum/age-dev) at [the mailing list](https://groups.google.com/d/forum/age-dev) at
age-dev@googlegroups.com. age was designed by age-dev@googlegroups.com. age was designed by
@ -25,8 +31,16 @@ See the [documentation](https://docs.rs/age) for examples.
### Feature flags ### Feature flags
- `armor` enables the `age::armor` module, which provides support for
ASCII-armored age files.
- `async` enables asynchronous APIs for encryption and decryption.
- `cli-common` enables common helper functions for building age CLI tools. - `cli-common` enables common helper functions for building age CLI tools.
- `ssh` enables the `age::ssh` module, which allows for reusing existing SSH key
files for age encryption.
- `unstable` enables in-development functionality. Anything behind this feature - `unstable` enables in-development functionality. Anything behind this feature
flag has no stability or interoperability guarantees. flag has no stability or interoperability guarantees.

2
rage/Cargo.toml
View file

@ -14,7 +14,7 @@ default-run = "rage"
[package.metadata.deb] [package.metadata.deb]
name = "rage" name = "rage"
extended-description = """\ extended-description = """\
age is a simple, secure and modern encryption format with small explicit keys, \ age is a simple, modern, and secure encryption format with small explicit keys, \
no config options, and UNIX-style composability. rage is a Rust implementation \ no config options, and UNIX-style composability. rage is a Rust implementation \
of the age specification.""" of the age specification."""
section = "utils" section = "utils"