tRemove empty lines from manpages - safe - password protected secret keeper
(HTM) git clone git://git.z3bra.org/safe.git
(DIR) Log
(DIR) Files
(DIR) Refs
(DIR) README
(DIR) LICENSE
---
(DIR) commit 27ff858581ea50790034bd24fe035934bcce5237
(DIR) parent 24514eac0b2b9b1d5d8cc8d9e25d667b6eacd6e5
(HTM) Author: Willy Goiffon <dev@z3bra.org>
Date: Fri, 29 May 2020 18:57:08 +0200
Remove empty lines from manpages
Diffstat:
M safe-agent.1 | 7 -------
M safe-store.5 | 13 +------------
M safe.1 | 9 ---------
3 files changed, 1 insertion(+), 28 deletions(-)
---
(DIR) diff --git a/safe-agent.1 b/safe-agent.1
t@@ -1,17 +1,14 @@
.Dd 2019-06-08
.Dt SAFE-AGENT 1
.Os POSIX.1-2017
-
.Sh NAME
.Nm safe-agent
.Nd decryption key agent
-
.Sh SYNOPSIS
.Nm
.Op Fl hdv
.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
t@@ -53,7 +50,6 @@ 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.
-
.Sh EXAMPLES
Retrieve a secret from your safe, using the agent
.Bd -literal
t@@ -62,7 +58,6 @@ Retrieve a secret from your safe, using the agent
password:
$ safe secret/file > kitten.gif
.Ed
-
.Sh ENVIRONMENT
.Bl -tag -width "SAFE_SOCK"
.It Ev SAFE_PID
t@@ -71,11 +66,9 @@ Stores the PID of the currently running agent.
Stores the path to the UNIX-domain socket used to communicate with
the agent.
.El
-
.Sh SEE ALSO
.Xr safe 1
.Xr safe-store 5
-
.Sh AUTHORS
.An Willy Goiffon Aq Mt dev@z3bra.org
(DIR) diff --git a/safe-store.5 b/safe-store.5
t@@ -1,11 +1,9 @@
.Dd 2020-05-28
.Dt SAFE-STORE 5
.Os POSIX.1-2017
-
.Sh NAME
.Nm safe-store
.Nd Encrypted file storage for your secrets.
-
.Sh DESCRIPTION
The
.Nm
t@@ -15,7 +13,6 @@ There can be any number of sub-directories in the
.Nm ,
in which case the secret shall be refered to by its path relative to the
.Nm .
-
.Bd -literal
$ find .secrets -type f
.secrets/master
t@@ -23,8 +20,6 @@ in which case the secret shall be refered to by its path relative to the
.secrets/subdir/name
.secrets/subdir/othername
.Ed
-
-
.Sh FILES
.Bl -tag -width "/etc/mail/smtpd.confXXX" -compact
.It Pa .secrets
t@@ -36,7 +31,6 @@ A random secret named "cipher"
.It Pa .secrets/master
A special secret used as a reference for salting and verifying the master password
.El
-
.Pa secrets
are the concatenation of a 16 bytes
.Em salt
t@@ -44,7 +38,7 @@ and arbitraty data encrypted
using the
.Em XChaCha20
stream cipher.
-
+.Pp
The key used for encryption is derived from a salt and a master
password. Every secret is be encrypted using the same key.
.Pp
t@@ -53,9 +47,7 @@ is a special secret containing the master password.
It is used to check the master password, and as a reference salt
for new secrets. Its content is however never checked for, and could
be anything, as long as it can be decrypted properly.
-
.Sh SECURITY CONSIDERATIONS
-
The master secret is used to check that your salt and master password
are correct. If it is not absent, no secret can be decrypted, and the
.Xr safe 1
t@@ -65,7 +57,6 @@ secrets created with a different salt will not be decrypted properly.
To recover from a lost master secret, you can do the following (assuming that
.Em random_entry
is an existing secret):
-
.Bd -literal
cd $SAFE_DIR
cp random_entry master
t@@ -74,10 +65,8 @@ is an existing secret):
chmod 400 master
safe master
.Ed
-
.Sh SEE ALSO
.Xr safe 1 ,
.Xr safe-agent 1
-
.Sh AUTHORS
.An Willy Goiffon Aq Mt dev@z3bra.org
(DIR) diff --git a/safe.1 b/safe.1
t@@ -1,11 +1,9 @@
.Dd 2019-02-20
.Dt SAFE 1
.Os POSIX.1-2017
-
.Sh NAME
.Nm safe
.Nd digital safe for your secrets
-
.Sh SYNOPSIS
.Nm
.Op Fl hr
t@@ -13,7 +11,6 @@
.Op Fl s Ar safe
.Op Fl a
.Ar secret
-
.Sh DESCRIPTION
.Nm
stores secrets (files) encrypted on your disk, and lets you retrieve them,
t@@ -44,7 +41,6 @@ Encrypt stdin to your safe as
.Ar secret .
.It Fl k
Prompt user for password using an external program (see: SAFE_ASKPASS).
-
.Sh AGENT
When the agent is started,
.Nm
t@@ -57,7 +53,6 @@ variable is set in the environment.
When the agent is first started, you can push the key to it using the
.Fl p
flag.
-
.Sh MASTER PASSWORD
When you add your first secret to the safe, a
.Ar master
t@@ -66,7 +61,6 @@ password, and is used to check that you typed the master password
correctly on the next calls.
.Pp
Do not delete this entry as it could lead to a corrupted safe.
-
.Sh EXAMPLES
Store a secret in your safe
.Bd -literal
t@@ -86,7 +80,6 @@ Retrieve a secret from your safe
$ safe secret/file > kitten.gif
password:
.Ed
-
.Sh ENVIRONMENT
.Bl -tag -width "SAFE_SOCK"
.It Ev SAFE_DIR
t@@ -96,10 +89,8 @@ Path to the UNIX-domain socket used to communicate with the agent.
.It Ev SAFE_ASKPASS
If no TTY is available, the program specified by this variable will be
used to read the master password (default: thingaskpass)
-
.Sh SEE ALSO
.Xr safe-agent 1 ,
.Xr safe-store 5
-
.Sh AUTHORS
.An Willy Goiffon Aq Mt dev@z3bra.org