safe

Password protected secret keeper
git clone git://git.z3bra.org/safe.git
Log | Files | Refs | README | LICENSE

commit 1a8146eb3d01081a1e74ece9c2d57ca0e585921e
parent a3a722de801c1dff63a7b662b852a6ef41cd6232
Author: Willy Goiffon <dev@z3bra.org>
Date:   Wed, 12 Jun 2019 13:32:21 +0200

Add manpage for safe-agent(1)

Diffstat:
makefile | 3+++
mkfile | 3+++
safe-agent.1 | 57+++++++++++++++++++++++++++++++++++++++++++++++++++++++++
3 files changed, 63 insertions(+), 0 deletions(-)

diff --git a/makefile b/makefile @@ -26,9 +26,12 @@ install: safe safe-agent mkdir -p ${DESTDIR}${MANPREFIX}/man1 cp safe.1 ${DESTDIR}${MANPREFIX}/man1/safe.1 chmod 644 ${DESTDIR}${MANPREFIX}/man1/safe.1 + cp safe-agent.1 ${DESTDIR}${MANPREFIX}/man1/safe-agent.1 + chmod 644 ${DESTDIR}${MANPREFIX}/man1/safe-agent.1 uninstall:: rm ${DESTDIR}${PREFIX}/bin/safe rm ${DESTDIR}${PREFIX}/bin/safe-agent rm ${DESTDIR}${MANPREFIX}/man1/safe.1 + rm ${DESTDIR}${MANPREFIX}/man1/safe-agent.1 diff --git a/mkfile b/mkfile @@ -32,8 +32,11 @@ install:V: safe safe-agent mkdir -p ${DESTDIR}${MANPREFIX}/man1 cp safe.1 ${DESTDIR}${MANPREFIX}/man1/safe.1 chmod 644 ${DESTDIR}${MANPREFIX}/man1/safe.1 + cp safe-agent.1 ${DESTDIR}${MANPREFIX}/man1/safe-agent.1 + chmod 644 ${DESTDIR}${MANPREFIX}/man1/safe-agent.1 uninstall:V: rm ${DESTDIR}${PREFIX}/bin/safe rm ${DESTDIR}${PREFIX}/bin/safe-agent rm ${DESTDIR}${MANPREFIX}/man1/safe.1 + rm ${DESTDIR}${MANPREFIX}/man1/safe-agent.1 diff --git a/safe-agent.1 b/safe-agent.1 @@ -0,0 +1,56 @@ +.Dd 2019-06-08 +.Dt SAFE-AGENT 1 +.Os POSIX.1-2008 +.Sh NAME +.Nm safe-agent +.Nd Digital safe for your secrets +.Sh SYNOPSIS +.Nm +.Op Fl h +.Op Fl t Ar timeout +.Op Fl f Ar socket +.Sh DESCRIPTION +.Nm +can retain a derivated key and its salt in memroy, and send it over a +UNIX-domain socket to whichever process can read this socket. +.Pp +Pushing a key and its salt is done by writing them to the socket. The +retained key can be instantly forgotten by sending signal +.Ar SIGUSR1 or SIGALRM +to the running agent. +.El +.Bl -tag -width Ds +.It Fl h +Print a quick usage text. +.It Fl t Ar timeout +Retain the key for +.Ar timeout +seconds. This will setup an +.Xr alarm 2 +timer, which make the agent forget the key after the timeout. +.It Fl f Ar socket +Bind agent to +.Ar socket +UNIX-domain socket. +(default: /tmp/safe-XXXXXX/agent.ppid) +.Pp +The agent prints will print commands ( +.Xr sh 1 ) +to stdout, that can be evaluated by the calling shell for exportation +to the environment. +.Pp +Later calls to +.Xr safe 1 +will use these environment variables internally to retrieve the key and +use it to encrypt/decrypt the stored secrets. +.Bd -literal +.Sh ENVIRONMENT +.Bl -tag -width "SAFE_SOCK" +.It Ev SAFE_SOCK +Stores the path to the UNIX-domain socket used to communicate with +the agent. +.It Ev SAFE_PID +Stores the PID of the currently running agent. + +.Sh AUTHORS +.An Willy Goiffon Aq Mt dev@z3bra.org+ \ No newline at end of file