Skip to content

Commit 775335d

Browse files
committed
update docs about ssh support
Signed-off-by: haoqixu <hq.xu0o0@gmail.com>
1 parent 1efd203 commit 775335d

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

README.rst

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -233,7 +233,13 @@ The contents of this key file should be a list of age X25519 identities, one
233233
per line. Lines beginning with ``#`` are considered comments and ignored. Each
234234
identity will be tried in sequence until one is able to decrypt the data.
235235

236-
Encrypting with SSH keys via age is not yet supported by SOPS.
236+
Encrypting with SSH keys via age is also supported by SOPS. You can use SSH public keys
237+
("ssh-ed25519 AAAA...", "ssh-rsa AAAA...") as age recipients when encrypting a file.
238+
When decrypting a file, SOPS will look for `~/.ssh/id_ed25519` and fallbacks to
239+
`~/.ssh/id_rsa`. You can specify the location of the private key manually by setting
240+
the environment variableuse **SOPS_AGE_SSH_PRIVATE_KEY_FILE**.
241+
242+
Note that only `ssh-rsa` and `ssh-ed25519` are supported.
237243

238244
A list of age recipients can be added to the ``.sops.yaml``:
239245

0 commit comments

Comments
 (0)