Skip to content

Commit

Permalink
docs(readme): improve intro
Browse files Browse the repository at this point in the history
  • Loading branch information
dbohdan committed Dec 9, 2024
1 parent 29d3f8c commit c02082f
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,18 @@
# stone-agent

This repository contains a crude decryption agent for
[age](https://github.com/FiloSottile/age)
inspired by
This repository houses **stone-agent**, a crude version of
[ssh-agent](https://en.wikipedia.org/wiki/Ssh-agent)
and
[gpg-agent](https://www.gnupg.org/documentation/manuals/gnupg/Invoking-GPG_002dAGENT.html).
or
[gpg-agent](https://www.gnupg.org/documentation/manuals/gnupg/Invoking-GPG_002dAGENT.html)
made by a third party for
[age](https://github.com/FiloSottile/age).
The agent only performs decryption.
It is meant as a proof of concept for password managers based on age and shell.
Bugs and security vulnerabilities are to be expected.
Bugs and security vulnerabilities are expected.

The agent uses a private key given on launch to decrypt anything sent through a Unix domain socket.
stone-agent uses a private key given on launch to take anything sent to a Unix domain socket and send it back decrypted.
It keeps the private key in memory and passes it to `age -d -i` using Bash process substitution.
It does not report errors to the socket user.
It does not report errors to the user accessing it directly through the socket or through `stone-agent decrypt`.

## Requirements

Expand Down

0 comments on commit c02082f

Please sign in to comment.