1 ;;; auth-source.el --- authentication sources for Gnus and Emacs
3 ;; Copyright (C) 2008, 2009, 2010 Free Software Foundation, Inc.
5 ;; Author: Ted Zlatanov <tzz@lifelogs.com>
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;; This is the auth-source.el package. It lets users tell Gnus how to
26 ;; authenticate in a single place. Simplicity is the goal. Instead
27 ;; of providing 5000 options, we'll stick to simple, easy to
28 ;; understand options.
30 ;; See the auth.info Info documentation for details.
36 (eval-when-compile (require 'cl))
37 (autoload 'netrc-machine-user-or-password "netrc")
38 (autoload 'secrets-create-item "secrets")
39 (autoload 'secrets-delete-item "secrets")
40 (autoload 'secrets-get-alias "secrets")
41 (autoload 'secrets-get-attribute "secrets")
42 (autoload 'secrets-get-secret "secrets")
43 (autoload 'secrets-list-collections "secrets")
44 (autoload 'secrets-search-items "secrets")
46 (defgroup auth-source nil
47 "Authentication sources."
48 :version "23.1" ;; No Gnus
51 (defcustom auth-source-protocols '((imap "imap" "imaps" "143" "993")
52 (pop3 "pop3" "pop" "pop3s" "110" "995")
56 "List of authentication protocols and their names"
59 :version "23.2" ;; No Gnus
60 :type '(repeat :tag "Authentication Protocols"
61 (cons :tag "Protocol Entry"
62 (symbol :tag "Protocol")
64 (string :tag "Name")))))
66 ;;; generate all the protocols in a format Customize can use
67 ;;; TODO: generate on the fly from auth-source-protocols
68 (defconst auth-source-protocols-customize
70 (let ((p (car-safe a)))
72 :tag (upcase (symbol-name p))
74 auth-source-protocols))
76 (defvar auth-source-cache (make-hash-table :test 'equal)
77 "Cache for auth-source data")
79 (defcustom auth-source-do-cache t
80 "Whether auth-source should cache information."
82 :version "23.2" ;; No Gnus
85 (defcustom auth-source-debug nil
86 "Whether auth-source should log debug messages.
87 Also see `auth-source-hide-passwords'.
89 If the value is nil, debug messages are not logged.
90 If the value is t, debug messages are logged with `message'.
91 In that case, your authentication data will be in the
92 clear (except for passwords, which are always stripped out).
93 If the value is a function, debug messages are logged by calling
94 that function using the same arguments as `message'."
96 :version "23.2" ;; No Gnus
98 :tag "auth-source debugging mode"
99 (const :tag "Log using `message' to the *Messages* buffer" t)
100 (function :tag "Function that takes arguments like `message'")
101 (const :tag "Don't log anything" nil)))
103 (defcustom auth-source-hide-passwords t
104 "Whether auth-source should hide passwords in log messages.
105 Only relevant if `auth-source-debug' is not nil."
107 :version "23.2" ;; No Gnus
110 (defcustom auth-sources '((:source "~/.authinfo.gpg"))
111 "List of authentication sources.
113 The default will get login and password information from a .gpg
114 file, which you should set up with the EPA/EPG packages to be
115 encrypted. See the auth.info manual for details.
117 Each entry is the authentication type with optional properties.
119 It's best to customize this with `M-x customize-variable' because the choices
120 can get pretty complex."
122 :version "23.2" ;; No Gnus
123 :type `(repeat :tag "Authentication Sources"
124 (list :tag "Source definition"
125 (const :format "" :value :source)
126 (choice :tag "Authentication backend choice"
127 (string :tag "Authentication Source (file)")
128 (list :tag "secrets.el (Secret Service API/KWallet/GNOME Keyring)"
129 (const :format "" :value :secrets)
130 (choice :tag "Collection to use"
131 (string :tag "Collection name")
132 (const :tag "Default" 'default)
133 (const :tag "Login" "login")
134 (const :tag "Temporary" "session"))))
135 (repeat :tag "Extra Parameters" :inline t
136 (choice :tag "Extra parameter"
137 (list :tag "Host (omit to match as a fallback)"
138 (const :format "" :value :host)
139 (choice :tag "Host (machine) choice"
141 (regexp :tag "Host (machine) regular expression")))
142 (list :tag "Protocol (omit to match as a fallback)"
143 (const :format "" :value :protocol)
144 (choice :tag "Protocol"
146 ,@auth-source-protocols-customize))
147 (list :tag "User (omit to match as a fallback)" :inline t
148 (const :format "" :value :user)
149 (choice :tag "Personality or username"
151 (string :tag "Specific user name"))))))))
153 ;; temp for debugging
154 ;; (unintern 'auth-source-protocols)
155 ;; (unintern 'auth-sources)
156 ;; (customize-variable 'auth-sources)
157 ;; (setq auth-sources nil)
158 ;; (format "%S" auth-sources)
159 ;; (customize-variable 'auth-source-protocols)
160 ;; (setq auth-source-protocols nil)
161 ;; (format "%S" auth-source-protocols)
162 ;; (auth-source-pick nil :host "a" :port 'imap)
163 ;; (auth-source-user-or-password "login" "imap.myhost.com" 'imap)
164 ;; (auth-source-user-or-password "password" "imap.myhost.com" 'imap)
165 ;; (auth-source-user-or-password-imap "login" "imap.myhost.com")
166 ;; (auth-source-user-or-password-imap "password" "imap.myhost.com")
167 ;; (auth-source-protocol-defaults 'imap)
169 ;; (let ((auth-source-debug 'debug)) (auth-source-debug "hello"))
170 ;; (let ((auth-source-debug t)) (auth-source-debug "hello"))
171 ;; (let ((auth-source-debug nil)) (auth-source-debug "hello"))
172 (defun auth-source-do-debug (&rest msg)
173 ;; set logger to either the function in auth-source-debug or 'message
174 ;; note that it will be 'message if auth-source-debug is nil, so
175 ;; we also check the value
176 (when auth-source-debug
177 (let ((logger (if (functionp auth-source-debug)
180 (apply logger msg))))
182 ;; (auth-source-pick nil :host "any" :protocol 'imap :user "joe")
183 ;; (auth-source-pick t :host "any" :protocol 'imap :user "joe")
184 ;; (setq auth-sources '((:source (:secrets default) :host t :protocol t :user "joe")
185 ;; (:source (:secrets "session") :host t :protocol t :user "joe")
186 ;; (:source (:secrets "login") :host t :protocol t)
187 ;; (:source "~/.authinfo.gpg" :host t :protocol t)))
189 ;; (setq auth-sources '((:source (:secrets default) :host t :protocol t :user "joe")
190 ;; (:source (:secrets "session") :host t :protocol t :user "joe")
191 ;; (:source (:secrets "login") :host t :protocol t)
194 ;; (setq auth-sources '((:source "~/.authinfo.gpg" :host t :protocol t)))
196 (defun auth-get-source (entry)
197 "Return the source string of ENTRY, which is one entry in `auth-sources'.
198 If it is a Secret Service API, return the collection name, otherwise
200 (let ((source (plist-get entry :source)))
203 ;; Secret Service API.
204 (setq source (plist-get source :secrets))
205 (when (eq source 'default)
206 (setq source (or (secrets-get-alias "default") "login")))
207 (or source "session"))))
209 (defun auth-source-pick (&rest spec)
210 "Parse `auth-sources' for matches of the SPEC plist.
212 Common keys are :host, :protocol, and :user. A value of t in
213 SPEC means to always succeed in the match. A string value is
215 (let ((keys (loop for i below (length spec) by 2 collect (nth i spec)))
217 (dolist (choice (copy-tree auth-sources) choices)
218 (let ((source (plist-get choice :source))
222 ;; Check existence of source.
224 ;; Secret Service API.
225 (member (auth-get-source choice) (secrets-list-collections))
227 (file-exists-p source))
230 (dolist (k keys match)
231 (let* ((v (plist-get spec k))
232 (choicev (plist-get choice k)))
236 ;; source always matches spec key
238 ;; source key gives regex to match against spec
239 (and (stringp choicev) (string-match choicev v))
240 ;; source key gives symbol to match against spec
241 (and (symbolp choicev) (eq choicev v))))))))
243 (add-to-list 'choices choice 'append))))))
245 (defun auth-source-retrieve (mode entry &rest spec)
246 "Retrieve MODE credentials according to SPEC from ENTRY."
248 (let ((host (plist-get spec :host))
249 (user (plist-get spec :user))
250 (prot (plist-get spec :protocol))
251 (source (plist-get entry :source))
254 ;; Secret Service API.
256 (let ((coll (auth-get-source entry))
258 ;; Loop over candidates with a matching host attribute.
259 (dolist (elt (secrets-search-items coll :host host) item)
260 (when (and (or (not user)
262 user (secrets-get-attribute coll elt :user)))
265 prot (secrets-get-attribute coll elt :protocol))))
272 (if (string-equal "password" m)
273 (or (secrets-get-secret coll item)
274 ;; When we do not find a password,
275 ;; we return nil anyway.
276 (throw 'no-password nil))
277 (or (secrets-get-attribute coll item :user)
279 (if (consp mode) mode (list mode)))))
280 (if (consp mode) result (car result))))
281 ;; Anything else is netrc.
283 (let ((search (list source (list host) (list (format "%s" prot))
284 (auth-source-protocol-defaults prot))))
287 (if (string-equal "password" m)
289 'netrc-machine-user-or-password m search)
290 ;; When we do not find a password, we
291 ;; return nil anyway.
292 (throw 'no-password nil))
294 'netrc-machine-user-or-password m search)
296 (if (consp mode) mode (list mode)))))
297 (if (consp mode) result (car result)))))))
299 (defun auth-source-create (mode entry &rest spec)
300 "Create interactively credentials according to SPEC in ENTRY.
301 Return structure as specified by MODE."
302 (let* ((host (plist-get spec :host))
303 (user (plist-get spec :user))
304 (prot (plist-get spec :protocol))
305 (source (plist-get entry :source))
306 (name (concat (if user (format "%s@" user))
308 (if prot (format ":%s" prot))))
313 (if (equal "password" m)
314 (let ((passwd (read-passwd "Password: ")))
316 ;; Secret Service API.
320 (auth-get-source entry) name passwd spec))
321 (t)) ;; netrc not implemented yes.
324 ;; the originally requested :user
327 (if (consp mode) mode (list mode))))
328 (if (consp mode) result (car result))))
330 (defun auth-source-delete (entry &rest spec)
331 "Delete credentials according to SPEC in ENTRY."
332 (let ((host (plist-get spec :host))
333 (user (plist-get spec :user))
334 (prot (plist-get spec :protocol))
335 (source (plist-get entry :source)))
337 ;; Secret Service API.
339 (let ((coll (auth-get-source entry)))
340 ;; Loop over candidates with a matching host attribute.
341 (dolist (elt (secrets-search-items coll :host host))
342 (when (and (or (not user)
344 user (secrets-get-attribute coll elt :user)))
347 prot (secrets-get-attribute coll elt :protocol))))
348 (secrets-delete-item coll elt)))))
349 (t)))) ;; netrc not implemented yes.
351 (defun auth-source-forget-user-or-password
352 (mode host protocol &optional username)
353 "Remove cached authentication token."
354 (interactive "slogin/password: \nsHost: \nsProtocol: \n") ;for testing
357 (format "%s %s:%s %s" mode host protocol username)
358 (format "%s %s:%s" mode host protocol))
361 (defun auth-source-forget-all-cached ()
362 "Forget all cached auth-source authentication tokens."
364 (setq auth-source-cache (make-hash-table :test 'equal)))
367 ;; (auth-source-forget-all-cached)
369 ;; (auth-source-user-or-password '("login" "password") "imap.myhost.com" "other")
370 ;; (auth-source-user-or-password '("login" "password") "imap.myhost.com" "other" "tzz")
371 ;; (auth-source-user-or-password '("login" "password") "imap.myhost.com" "other" "joe")))
373 (defun auth-source-user-or-password
374 (mode host protocol &optional username create-missing delete-existing)
375 "Find MODE (string or list of strings) matching HOST and PROTOCOL.
377 USERNAME is optional and will be used as \"login\" in a search
378 across the Secret Service API (see secrets.el) if the resulting
379 items don't have a username. This means that if you search for
380 username \"joe\" and it matches an item but the item doesn't have
381 a :user attribute, the username \"joe\" will be returned.
383 A non nil DELETE-EXISTING means deleting any matching password
384 entry in the respective sources. This is useful only when
385 CREATE-MISSING is non nil as well; the intended use case is to
386 remove wrong password entries.
388 If no matching entry is found, and CREATE-MISSING is non nil,
389 the password will be retrieved interactively, and it will be
390 stored in the password database which matches best (see
393 MODE can be \"login\" or \"password\"."
394 (auth-source-do-debug
395 "auth-source-user-or-password: get %s for %s (%s) + user=%s"
396 mode host protocol username)
397 (let* ((listy (listp mode))
398 (mode (if listy mode (list mode)))
400 (format "%s %s:%s %s" mode host protocol username)
401 (format "%s %s:%s" mode host protocol)))
402 (search (list :host host :protocol protocol))
403 (search (if username (append search (list :user username)) search))
404 (found (if (not delete-existing)
405 (gethash cname auth-source-cache)
406 (remhash cname auth-source-cache)
410 (auth-source-do-debug
411 "auth-source-user-or-password: cached %s=%s for %s (%s) + %s"
413 ;; don't show the password
414 (if (and (member "password" mode) auth-source-hide-passwords)
417 host protocol username)
418 found) ; return the found data
419 ;; else, if not found
420 (let ((choices (apply 'auth-source-pick search)))
421 (dolist (choice choices)
423 (apply 'auth-source-delete choice search)
424 (setq found (apply 'auth-source-retrieve mode choice search)))
425 (and found (return found)))
427 ;; We haven't found something, so we will create it interactively.
428 (when (and (not found) choices create-missing)
429 (setq found (apply 'auth-source-create mode (car choices) search)))
433 (auth-source-do-debug
434 "auth-source-user-or-password: found %s=%s for %s (%s) + %s"
436 ;; don't show the password
437 (if (and (member "password" mode) auth-source-hide-passwords)
439 host protocol username)
440 (setq found (if listy found (car-safe found)))
441 (when auth-source-do-cache
442 (puthash cname found auth-source-cache)))
446 (defun auth-source-protocol-defaults (protocol)
447 "Return a list of default ports and names for PROTOCOL."
448 (cdr-safe (assoc protocol auth-source-protocols)))
450 (defun auth-source-user-or-password-imap (mode host)
451 (auth-source-user-or-password mode host 'imap))
453 (defun auth-source-user-or-password-pop3 (mode host)
454 (auth-source-user-or-password mode host 'pop3))
456 (defun auth-source-user-or-password-ssh (mode host)
457 (auth-source-user-or-password mode host 'ssh))
459 (defun auth-source-user-or-password-sftp (mode host)
460 (auth-source-user-or-password mode host 'sftp))
462 (defun auth-source-user-or-password-smtp (mode host)
463 (auth-source-user-or-password mode host 'smtp))
465 (provide 'auth-source)
467 ;; arch-tag: ff1afe78-06e9-42c2-b693-e9f922cbe4ab
468 ;;; auth-source.el ends here