[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Emacs-diffs] master 157fced 13/13: * doc/misc/auth.texi (The Unix passw
From: |
Damien Cassou |
Subject: |
[Emacs-diffs] master 157fced 13/13: * doc/misc/auth.texi (The Unix password store): Complete rewrite |
Date: |
Mon, 24 Jun 2019 03:22:50 -0400 (EDT) |
branch: master
commit 157fced053601c993734c61078c42d7905389828
Author: Damien Cassou <address@hidden>
Commit: Damien Cassou <address@hidden>
* doc/misc/auth.texi (The Unix password store): Complete rewrite
---
doc/misc/auth.texi | 71 ++++++++++++++++++++++++++++++++++++++++++++++--------
1 file changed, 61 insertions(+), 10 deletions(-)
diff --git a/doc/misc/auth.texi b/doc/misc/auth.texi
index a46e3d7..bbb66ec 100644
--- a/doc/misc/auth.texi
+++ b/doc/misc/auth.texi
@@ -445,19 +445,60 @@ then fall back to @file{~/.authinfo.gpg}.
@uref{http://www.passwordstore.org,,The standard unix password
manager} (or just @code{pass}) stores your passwords in
-@code{gpg}-protected files following the Unix philosophy.
+@code{gpg}-protected files following the Unix philosophy. The store
+location (any directory) must be specified in the
+@code{auth-source-pass-filename} variable which defaults to
+@file{~/.password-store}.
-Emacs integration of @code{pass} follows the first approach suggested
-by the pass project itself for data organization to find data. This
-means that the filename of the file containing the password for a user
-on a particular host must contain the host name. The file itself must
-contain the password on the first line, as well as a @code{username}
-field containing the username on a subsequent line. A @code{port}
-field can be used to differentiate the authentication data for several
-services with the same username on the same host.
+Emacs integration of @code{pass} follows the approach suggested by the
+pass project itself for data organization to find data. In
+particular, to store a password for the user @code{rms} on the host
+@code{gnu.org} and port @code{22}, you should use one of the following
+filenames.
+
+@table @file
+@item gnu.org.gpg
+No username or port in the filename means that any username and port
+will match.
+
+@item gnu.org/rms.gpg
+The username to match can be expressed as filename inside a directory
+whose name matches the host. This is useful if the store has
+passwords for several users on the same host.
+
+@item rms@@gnu.org.gpg
+The username can also be expressed as a prefix, separated from the
+host with an at-sign (@code{@@}).
+
+@item gnu.org:22.gpg
+The port (aka. service) to match can only be expressed after the host and
separated with a colon (@code{:}). The separator can be changed through the
@code{auth-source-pass-port-separator} variable.
+
+@item gnu.org:22/rms.gpg
+
+@item rms@@gnu.org:22.gpg
+
+@item a/b/gnu.org.gpg
+Entries can be stored in arbitrary directories.
+
+@item a/b/gnu.org/rms.gpg
+
+@item a/b/rms@@gnu.org.gpg
+
+@item a/b/gnu.org:22.gpg
+
+@item a/b/gnu.org:22/rms.gpg
+
+@item a/b/rms@@gnu.org:22.gpg
+@end table
+
+If several entries match, the one matching the most items (where an
+``item'' is one of username, port or host) is preferred. For example,
+while searching for an entry matching the @code{rms} user on host
+@code{gnu.org} and port @code{22}, then the entry
+@file{gnu.org:22/rms.gpg} is preferred over @file{gnu.org.gpg}.
Users of @code{pass} may also be interested in functionality provided
-by other Emacs packages dealing with pass:
+by other Emacs packages:
@itemize
@item
@@ -468,6 +509,16 @@ by other Emacs packages dealing with pass:
@uref{https://github.com/jabranham/helm-pass,,helm-pass}: helm interface for
pass.
@end itemize
+@defvar auth-source-pass-filename
+Set this variable to a string locating the password store on the disk.
+Defaults to @file{~/.password-store}.
+@end defvar
+
+@defvar auth-source-pass-port-separator
+Set this variable to a string that should separate an host name from a
+port in an entry. Defaults to @samp{:}.
+@end defvar
+
@node Help for developers
@chapter Help for developers
- [Emacs-diffs] master updated (b9ac4f8 -> 157fced), Damien Cassou, 2019/06/24
- [Emacs-diffs] master 527efaf 01/13: Fix auth-source-pass to return nil if no entry found, Damien Cassou, 2019/06/24
- [Emacs-diffs] master a63cbb5 04/13: Add auth-source-pass-filename option, Damien Cassou, 2019/06/24
- [Emacs-diffs] master 9574565 03/13: * lisp/auth-source-pass.el (auth-source-pass-get): Add autoload, Damien Cassou, 2019/06/24
- [Emacs-diffs] master ba11be0 02/13: * lisp/auth-source-pass.el: Version 4.0.2, Damien Cassou, 2019/06/24
- [Emacs-diffs] master 94c9eb8 06/13: Fix auth-source-pass to search for hostname:port/username, Damien Cassou, 2019/06/24
- [Emacs-diffs] master e6fc02f 11/13: * lisp/auth-source-pass.el: Version 5.0.0, Damien Cassou, 2019/06/24
- [Emacs-diffs] master 57e763a 07/13: Split out the attribute retrieval form auth-source-pass-get, Damien Cassou, 2019/06/24
- [Emacs-diffs] master 736f78b 09/13: * lisp/auth-source-pass.el: Add Keith Amidon to authors, Damien Cassou, 2019/06/24
- [Emacs-diffs] master 34f01eb 12/13: * etc/NEWS: Describe changes to auth-source-pass, Damien Cassou, 2019/06/24
- [Emacs-diffs] master 157fced 13/13: * doc/misc/auth.texi (The Unix password store): Complete rewrite,
Damien Cassou <=
- [Emacs-diffs] master 0a580c1 08/13: Minimize entry parsing in auth-source-pass, Damien Cassou, 2019/06/24
- [Emacs-diffs] master 2a0a057 05/13: Add auth-source-pass-port-separator option, Damien Cassou, 2019/06/24
- [Emacs-diffs] master 7022e3f 10/13: Refactoring of auth-source-pass, Damien Cassou, 2019/06/24