Skip to content

Commit a623244

Browse files
author
GitHub Actions
committed
doc: regenerate groff and html man pages
1 parent 4116747 commit a623244

File tree

2 files changed

+80
-4
lines changed

2 files changed

+80
-4
lines changed

doc/age-plugin-batchpass.1

Lines changed: 37 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,46 @@
77
\fBage\fR \fB\-e\fR \fB\-j\fR \fBbatchpass\fR
88
.br
99
\fBage\fR \fB\-d\fR \fB\-j\fR \fBbatchpass\fR
10+
.br
1011
.SH "DESCRIPTION"
1112
\fBage\-plugin\-batchpass\fR is an age(1) plugin that enables non\-interactive passphrase\-based encryption and decryption using environment variables\.
13+
.SH "WARNING"
14+
This functionality is not built into the age CLI because most applications should use native keys instead of scripting passphrase\-based encryption\.
15+
.P
16+
Humans are notoriously bad at remembering and generating strong passphrases\. age uses scrypt to partially mitigate this, which is necessarily very slow\.
17+
.P
18+
If a computer will be doing the remembering anyway, you can and should use native keys instead\. There is no need to manage separate public and private keys, you encrypt directly to the private key:
19+
.IP "" 4
20+
.nf
21+
$ age\-keygen \-o key\.txt
22+
$ age \-e \-i key\.txt file\.txt > file\.txt\.age
23+
$ age \-d \-i key\.txt file\.txt\.age > file\.txt
24+
.fi
25+
.IP "" 0
26+
.P
27+
Likewise, you can store a native identity string in an environment variable or through your CI secrets manager and use it to encrypt and decrypt files non\-interactively:
28+
.IP "" 4
29+
.nf
30+
$ export AGE_SECRET=$(age\-keygen)
31+
$ age \-e \-i <(echo "$AGE_SECRET") file\.txt > file\.txt\.age
32+
$ age \-d \-i <(echo "$AGE_SECRET") file\.txt\.age > file\.txt
33+
.fi
34+
.IP "" 0
35+
.P
36+
The age CLI also natively supports passphrase\-encrypted identity files, so you can use that functionality to non\-interactively encrypt multiple files such that you will be able to decrypt them later by entering the same passphrase:
37+
.IP "" 4
38+
.nf
39+
$ age\-keygen \-pq | age \-p \-o encrypted\-identity\.txt
40+
Public key: age1pq1cd[\|\.\|\.\|\. 1950 more characters \|\.\|\.\|\.]
41+
Enter passphrase (leave empty to autogenerate a secure one):
42+
age: using autogenerated passphrase "eternal\-erase\-keen\-suffer\-fog\-exclude\-huge\-scorpion\-escape\-scrub"
43+
$ age \-r age1pq1cd[\|\.\|\.\|\. 1950 more characters \|\.\|\.\|\.] file\.txt > file\.txt\.age
44+
$ age \-d \-i encrypted\-identity\.txt file\.txt\.age > file\.txt
45+
Enter passphrase for identity file "encrypted\-identity\.txt":
46+
.fi
47+
.IP "" 0
1248
.P
13-
It is not built into the age CLI because most applications should use native keys instead of scripting passphrase\-based encryption\.
49+
Finally, when using this plugin care should be taken not to let the password be persisted in the shell history or leaked to other users on multi\-user systems\.
1450
.SH "ENVIRONMENT"
1551
.TP
1652
\fBAGE_PASSPHRASE\fR

doc/age-plugin-batchpass.1.html

Lines changed: 43 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)