1 ;;; auth-source.el --- authentication sources for Gnus and Emacs
3 ;; Copyright (C) 2008-2011 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.
34 ;; - never decode the backend file unless it's necessary
35 ;; - a more generic way to match backends and search backend contents
36 ;; - absorb netrc.el and simplify it
37 ;; - protect passwords better
38 ;; - allow creating and changing netrc lines (not files) e.g. change a password
42 (require 'password-cache)
46 (eval-when-compile (require 'cl))
49 (autoload 'secrets-create-item "secrets")
50 (autoload 'secrets-delete-item "secrets")
51 (autoload 'secrets-get-alias "secrets")
52 (autoload 'secrets-get-attributes "secrets")
53 (autoload 'secrets-get-secret "secrets")
54 (autoload 'secrets-list-collections "secrets")
55 (autoload 'secrets-search-items "secrets")
57 (autoload 'rfc2104-hash "rfc2104")
59 (defvar secrets-enabled)
61 (defgroup auth-source nil
62 "Authentication sources."
63 :version "23.1" ;; No Gnus
67 (defcustom auth-source-cache-expiry 7200
68 "How many seconds passwords are cached, or nil to disable
69 expiring. Overrides `password-cache-expiry' through a
72 :type '(choice (const :tag "Never" nil)
73 (const :tag "All Day" 86400)
74 (const :tag "2 Hours" 7200)
75 (const :tag "30 Minutes" 1800)
76 (integer :tag "Seconds")))
78 (defclass auth-source-backend ()
83 :documentation "The backend type.")
84 (source :initarg :source
87 :documentation "The backend source.")
92 :documentation "The backend host.")
97 :documentation "The backend user.")
102 :documentation "The backend protocol.")
103 (create-function :initarg :create-function
107 :documentation "The create function.")
108 (search-function :initarg :search-function
112 :documentation "The search function.")))
114 (defcustom auth-source-protocols '((imap "imap" "imaps" "143" "993")
115 (pop3 "pop3" "pop" "pop3s" "110" "995")
119 "List of authentication protocols and their names"
122 :version "23.2" ;; No Gnus
123 :type '(repeat :tag "Authentication Protocols"
124 (cons :tag "Protocol Entry"
125 (symbol :tag "Protocol")
127 (string :tag "Name")))))
129 ;;; generate all the protocols in a format Customize can use
130 ;;; TODO: generate on the fly from auth-source-protocols
131 (defconst auth-source-protocols-customize
133 (let ((p (car-safe a)))
135 :tag (upcase (symbol-name p))
137 auth-source-protocols))
139 (defvar auth-source-creation-defaults nil
140 "Defaults for creating token values. Usually let-bound.")
142 (defvar auth-source-creation-prompts nil
143 "Default prompts for token values. Usually let-bound.")
145 (make-obsolete 'auth-source-hide-passwords nil "Emacs 24.1")
147 (defcustom auth-source-save-behavior 'ask
148 "If set, auth-source will respect it for save behavior."
150 :version "23.2" ;; No Gnus
152 :tag "auth-source new token save behavior"
153 (const :tag "Always save" t)
154 (const :tag "Never save" nil)
155 (const :tag "Ask" ask)))
157 ;; TODO: make the default (setq auth-source-netrc-use-gpg-tokens `((,(if (boundp 'epa-file-auto-mode-alist-entry) (car (symbol-value 'epa-file-auto-mode-alist-entry)) "\\.gpg\\'") never) (t gpg)))
158 ;; TODO: or maybe leave as (setq auth-source-netrc-use-gpg-tokens 'never)
160 (defcustom auth-source-netrc-use-gpg-tokens 'never
161 "Set this to tell auth-source when to create GPG password
162 tokens in netrc files. It's either an alist or `never'."
164 :version "23.2" ;; No Gnus
166 (const :tag "Always use GPG password tokens" (t gpg))
167 (const :tag "Never use GPG password tokens" never)
168 (repeat :tag "Use a lookup list"
170 (choice :tag "Matcher"
171 (const :tag "Match anything" t)
172 (const :tag "The EPA encrypted file extensions"
173 ,(if (boundp 'epa-file-auto-mode-alist-entry)
175 'epa-file-auto-mode-alist-entry))
177 (regexp :tag "Regular expression"))
178 (choice :tag "What to do"
179 (const :tag "Save GPG-encrypted password tokens" gpg)
180 (const :tag "Don't encrypt tokens" never))))))
182 (defvar auth-source-magic "auth-source-magic ")
184 (defcustom auth-source-do-cache t
185 "Whether auth-source should cache information with `password-cache'."
187 :version "23.2" ;; No Gnus
190 (defcustom auth-source-debug nil
191 "Whether auth-source should log debug messages.
193 If the value is nil, debug messages are not logged.
195 If the value is t, debug messages are logged with `message'. In
196 that case, your authentication data will be in the clear (except
199 If the value is a function, debug messages are logged by calling
200 that function using the same arguments as `message'."
202 :version "23.2" ;; No Gnus
204 :tag "auth-source debugging mode"
205 (const :tag "Log using `message' to the *Messages* buffer" t)
206 (const :tag "Log all trivia with `message' to the *Messages* buffer"
208 (function :tag "Function that takes arguments like `message'")
209 (const :tag "Don't log anything" nil)))
211 (defcustom auth-sources '("~/.authinfo" "~/.authinfo.gpg" "~/.netrc")
212 "List of authentication sources.
214 The default will get login and password information from
215 \"~/.authinfo.gpg\", which you should set up with the EPA/EPG
216 packages to be encrypted. If that file doesn't exist, it will
217 try the unencrypted version \"~/.authinfo\" and the famous
220 See the auth.info manual for details.
222 Each entry is the authentication type with optional properties.
224 It's best to customize this with `M-x customize-variable' because the choices
225 can get pretty complex."
227 :version "24.1" ;; No Gnus
228 :type `(repeat :tag "Authentication Sources"
230 (string :tag "Just a file")
231 (const :tag "Default Secrets API Collection" 'default)
232 (const :tag "Login Secrets API Collection" "secrets:Login")
233 (const :tag "Temp Secrets API Collection" "secrets:session")
234 (list :tag "Source definition"
235 (const :format "" :value :source)
236 (choice :tag "Authentication backend choice"
237 (string :tag "Authentication Source (file)")
239 :tag "Secret Service API/KWallet/GNOME Keyring"
240 (const :format "" :value :secrets)
241 (choice :tag "Collection to use"
242 (string :tag "Collection name")
243 (const :tag "Default" 'default)
244 (const :tag "Login" "Login")
246 :tag "Temporary" "session"))))
247 (repeat :tag "Extra Parameters" :inline t
248 (choice :tag "Extra parameter"
251 (const :format "" :value :host)
252 (choice :tag "Host (machine) choice"
255 :tag "Regular expression")))
258 (const :format "" :value :port)
262 ,@auth-source-protocols-customize))
263 (list :tag "User" :inline t
264 (const :format "" :value :user)
266 :tag "Personality/Username"
271 (defcustom auth-source-gpg-encrypt-to t
272 "List of recipient keys that `authinfo.gpg' encrypted to.
273 If the value is not a list, symmetric encryption will be used."
275 :version "24.1" ;; No Gnus
276 :type '(choice (const :tag "Symmetric encryption" t)
277 (repeat :tag "Recipient public keys"
278 (string :tag "Recipient public key"))))
280 ;; temp for debugging
281 ;; (unintern 'auth-source-protocols)
282 ;; (unintern 'auth-sources)
283 ;; (customize-variable 'auth-sources)
284 ;; (setq auth-sources nil)
285 ;; (format "%S" auth-sources)
286 ;; (customize-variable 'auth-source-protocols)
287 ;; (setq auth-source-protocols nil)
288 ;; (format "%S" auth-source-protocols)
289 ;; (auth-source-pick nil :host "a" :port 'imap)
290 ;; (auth-source-user-or-password "login" "imap.myhost.com" 'imap)
291 ;; (auth-source-user-or-password "password" "imap.myhost.com" 'imap)
292 ;; (auth-source-user-or-password-imap "login" "imap.myhost.com")
293 ;; (auth-source-user-or-password-imap "password" "imap.myhost.com")
294 ;; (auth-source-protocol-defaults 'imap)
296 ;; (let ((auth-source-debug 'debug)) (auth-source-do-debug "hello"))
297 ;; (let ((auth-source-debug t)) (auth-source-do-debug "hello"))
298 ;; (let ((auth-source-debug nil)) (auth-source-do-debug "hello"))
299 (defun auth-source-do-debug (&rest msg)
300 (when auth-source-debug
301 (apply 'auth-source-do-warn msg)))
303 (defun auth-source-do-trivia (&rest msg)
304 (when (or (eq auth-source-debug 'trivia)
305 (functionp auth-source-debug))
306 (apply 'auth-source-do-warn msg)))
308 (defun auth-source-do-warn (&rest msg)
310 ;; set logger to either the function in auth-source-debug or 'message
311 ;; note that it will be 'message if auth-source-debug is nil
312 (if (functionp auth-source-debug)
318 ;;; (auth-source-read-char-choice "enter choice? " '(?a ?b ?q))
319 (defun auth-source-read-char-choice (prompt choices)
320 "Read one of CHOICES by `read-char-choice', or `read-char'.
321 `dropdown-list' support is disabled because it doesn't work reliably.
322 Only one of CHOICES will be returned. The PROMPT is augmented
323 with \"[a/b/c] \" if CHOICES is '\(?a ?b ?c\)."
325 (let* ((prompt-choices
326 (apply 'concat (loop for c in choices
327 collect (format "%c/" c))))
328 (prompt-choices (concat "[" (substring prompt-choices 0 -1) "] "))
329 (full-prompt (concat prompt prompt-choices))
332 (while (not (memq k choices))
334 ((fboundp 'read-char-choice)
335 (read-char-choice full-prompt choices))
336 (t (message "%s" full-prompt)
337 (setq k (read-char))))))
340 ;; (auth-source-pick nil :host "any" :port 'imap :user "joe")
341 ;; (auth-source-pick t :host "any" :port 'imap :user "joe")
342 ;; (setq auth-sources '((:source (:secrets default) :host t :port t :user "joe")
343 ;; (:source (:secrets "session") :host t :port t :user "joe")
344 ;; (:source (:secrets "Login") :host t :port t)
345 ;; (:source "~/.authinfo.gpg" :host t :port t)))
347 ;; (setq auth-sources '((:source (:secrets default) :host t :port t :user "joe")
348 ;; (:source (:secrets "session") :host t :port t :user "joe")
349 ;; (:source (:secrets "Login") :host t :port t)
352 ;; (setq auth-sources '((:source "~/.authinfo.gpg" :host t :port t)))
354 ;; (auth-source-backend-parse "myfile.gpg")
355 ;; (auth-source-backend-parse 'default)
356 ;; (auth-source-backend-parse "secrets:Login")
358 (defun auth-source-backend-parse (entry)
359 "Creates an auth-source-backend from an ENTRY in `auth-sources'."
360 (auth-source-backend-parse-parameters
363 ;; take 'default and recurse to get it as a Secrets API default collection
364 ;; matching any user, host, and protocol
366 (auth-source-backend-parse '(:source (:secrets default))))
367 ;; take secrets:XYZ and recurse to get it as Secrets API collection "XYZ"
368 ;; matching any user, host, and protocol
369 ((and (stringp entry) (string-match "^secrets:\\(.+\\)" entry))
370 (auth-source-backend-parse `(:source (:secrets ,(match-string 1 entry)))))
371 ;; take just a file name and recurse to get it as a netrc file
372 ;; matching any user, host, and protocol
374 (auth-source-backend-parse `(:source ,entry)))
376 ;; a file name with parameters
377 ((stringp (plist-get entry :source))
379 (plist-get entry :source)
380 :source (plist-get entry :source)
382 :search-function 'auth-source-netrc-search
383 :create-function 'auth-source-netrc-create))
385 ;; the Secrets API. We require the package, in order to have a
386 ;; defined value for `secrets-enabled'.
388 (not (null (plist-get entry :source))) ; the source must not be nil
389 (listp (plist-get entry :source)) ; and it must be a list
390 (require 'secrets nil t) ; and we must load the Secrets API
391 secrets-enabled) ; and that API must be enabled
393 ;; the source is either the :secrets key in ENTRY or
394 ;; if that's missing or nil, it's "session"
395 (let ((source (or (plist-get (plist-get entry :source) :secrets)
398 ;; if the source is a symbol, we look for the alias named so,
399 ;; and if that alias is missing, we use "Login"
400 (when (symbolp source)
401 (setq source (or (secrets-get-alias (symbol-name source))
404 (if (featurep 'secrets)
406 (format "Secrets API (%s)" source)
409 :search-function 'auth-source-secrets-search
410 :create-function 'auth-source-secrets-create)
412 "auth-source-backend-parse: no Secrets API, ignoring spec: %S" entry)
414 (format "Ignored Secrets API (%s)" source)
421 "auth-source-backend-parse: invalid backend spec: %S" entry)
427 (defun auth-source-backend-parse-parameters (entry backend)
428 "Fills in the extra auth-source-backend parameters of ENTRY.
429 Using the plist ENTRY, get the :host, :port, and :user search
431 (let ((entry (if (stringp entry)
435 (when (setq val (plist-get entry :host))
436 (oset backend host val))
437 (when (setq val (plist-get entry :user))
438 (oset backend user val))
439 (when (setq val (plist-get entry :port))
440 (oset backend port val)))
443 ;; (mapcar 'auth-source-backend-parse auth-sources)
445 (defun* auth-source-search (&rest spec
446 &key type max host user port secret
447 require create delete
449 "Search or modify authentication backends according to SPEC.
451 This function parses `auth-sources' for matches of the SPEC
452 plist. It can optionally create or update an authentication
453 token if requested. A token is just a standard Emacs property
454 list with a :secret property that can be a function; all the
455 other properties will always hold scalar values.
457 Typically the :secret property, if present, contains a password.
459 Common search keys are :max, :host, :port, and :user. In
460 addition, :create specifies how tokens will be or created.
461 Finally, :type can specify which backend types you want to check.
463 A string value is always matched literally. A symbol is matched
464 as its string value, literally. All the SPEC values can be
465 single values (symbol or string) or lists thereof (in which case
466 any of the search terms matches).
468 :create t means to create a token if possible.
470 A new token will be created if no matching tokens were found.
471 The new token will have only the keys the backend requires. For
472 the netrc backend, for instance, that's the user, host, and
477 \(let ((auth-source-creation-defaults '((user . \"defaultUser\")
478 (A . \"default A\"))))
479 (auth-source-search :host \"mine\" :type 'netrc :max 1
480 :P \"pppp\" :Q \"qqqq\"
485 \"Search for any entry matching host 'mine' in backends of type
486 'netrc', maximum one result.
488 Create a new entry if you found none. The netrc backend will
489 automatically require host, user, and port. The host will be
490 'mine'. We prompt for the user with default 'defaultUser' and
491 for the port without a default. We will not prompt for A, Q,
492 or P. The resulting token will only have keys user, host, and
495 :create '(A B C) also means to create a token if possible.
497 The behavior is like :create t but if the list contains any
498 parameter, that parameter will be required in the resulting
499 token. The value for that parameter will be obtained from the
500 search parameters or from user input. If any queries are needed,
501 the alist `auth-source-creation-defaults' will be checked for the
502 default value. If the user, host, or port are missing, the alist
503 `auth-source-creation-prompts' will be used to look up the
504 prompts IN THAT ORDER (so the 'user prompt will be queried first,
505 then 'host, then 'port, and finally 'secret). Each prompt string
506 can use %u, %h, and %p to show the user, host, and port.
510 \(let ((auth-source-creation-defaults '((user . \"defaultUser\")
511 (A . \"default A\")))
512 (auth-source-creation-prompts
513 '((password . \"Enter IMAP password for %h:%p: \"))))
514 (auth-source-search :host '(\"nonesuch\" \"twosuch\") :type 'netrc :max 1
515 :P \"pppp\" :Q \"qqqq\"
520 \"Search for any entry matching host 'nonesuch'
521 or 'twosuch' in backends of type 'netrc', maximum one result.
523 Create a new entry if you found none. The netrc backend will
524 automatically require host, user, and port. The host will be
525 'nonesuch' and Q will be 'qqqq'. We prompt for the password
526 with the shown prompt. We will not prompt for Q. The resulting
527 token will have keys user, host, port, A, B, and Q. It will not
528 have P with any value, even though P is used in the search to
529 find only entries that have P set to 'pppp'.\"
531 When multiple values are specified in the search parameter, the
532 user is prompted for which one. So :host (X Y Z) would ask the
533 user to choose between X, Y, and Z.
535 This creation can fail if the search was not specific enough to
536 create a new token (it's up to the backend to decide that). You
537 should `catch' the backend-specific error as usual. Some
538 backends (netrc, at least) will prompt the user rather than throw
541 :require (A B C) means that only results that contain those
542 tokens will be returned. Thus for instance requiring :secret
543 will ensure that any results will actually have a :secret
546 :delete t means to delete any found entries. nil by default.
547 Use `auth-source-delete' in ELisp code instead of calling
548 `auth-source-search' directly with this parameter.
550 :type (X Y Z) will check only those backend types. 'netrc and
551 'secrets are the only ones supported right now.
553 :max N means to try to return at most N items (defaults to 1).
554 When 0 the function will return just t or nil to indicate if any
555 matches were found. More than N items may be returned, depending
556 on the search and the backend.
558 :host (X Y Z) means to match only hosts X, Y, or Z according to
559 the match rules above. Defaults to t.
561 :user (X Y Z) means to match only users X, Y, or Z according to
562 the match rules above. Defaults to t.
564 :port (P Q R) means to match only protocols P, Q, or R.
567 :K (V1 V2 V3) for any other key K will match values V1, V2, or
568 V3 (note the match rules above).
570 The return value is a list with at most :max tokens. Each token
571 is a plist with keys :backend :host :port :user, plus any other
572 keys provided by the backend (notably :secret). But note the
573 exception for :max 0, which see above.
575 The token can hold a :save-function key. If you call that, the
576 user will be prompted to save the data to the backend. You can't
577 request that this should happen right after creation, because
578 `auth-source-search' has no way of knowing if the token is
579 actually useful. So the caller must arrange to call this function.
581 The token's :secret key can hold a function. In that case you
582 must call it to obtain the actual value."
583 (let* ((backends (mapcar 'auth-source-backend-parse auth-sources))
585 (ignored-keys '(:require :create :delete :max))
586 (keys (loop for i below (length spec) by 2
587 unless (memq (nth i spec) ignored-keys)
588 collect (nth i spec)))
589 (cached (auth-source-remembered-p spec))
590 ;; note that we may have cached results but found is still nil
591 ;; (there were no results from the search)
592 (found (auth-source-recall spec))
593 filtered-backends accessor-key backend)
595 (if (and cached auth-source-do-cache)
596 (auth-source-do-debug
597 "auth-source-search: found %d CACHED results matching %S"
601 (or (eq t create) (listp create)) t
602 "Invalid auth-source :create parameter (must be t or a list): %s %s")
606 "Invalid auth-source :require parameter (must be a list): %s")
608 (setq filtered-backends (copy-sequence backends))
609 (dolist (backend backends)
611 ;; ignore invalid slots
612 (condition-case signal
613 (unless (eval `(auth-source-search-collection
615 (oref backend ,key)))
616 (setq filtered-backends (delq backend filtered-backends))
618 (invalid-slot-name))))
620 (auth-source-do-trivia
621 "auth-source-search: found %d backends matching %S"
622 (length filtered-backends) spec)
624 ;; (debug spec "filtered" filtered-backends)
625 ;; First go through all the backends without :create, so we can
627 (setq found (auth-source-search-backends filtered-backends
631 ;; create is always nil here
635 (auth-source-do-debug
636 "auth-source-search: found %d results (max %d) matching %S"
637 (length found) max spec)
639 ;; If we didn't find anything, then we allow the backend(s) to
640 ;; create the entries.
643 (setq found (auth-source-search-backends filtered-backends
649 (auth-source-do-debug
650 "auth-source-search: CREATED %d results (max %d) matching %S"
651 (length found) max spec))
653 ;; note we remember the lack of result too, if it's applicable
654 (when auth-source-do-cache
655 (auth-source-remember spec found)))
659 (defun auth-source-search-backends (backends spec max create delete require)
661 (dolist (backend backends)
662 (when (> max (length matches)) ; when we need more matches...
663 (let* ((bmatches (apply
664 (slot-value backend 'search-function)
666 ;; note we're overriding whatever the spec
667 ;; has for :require, :create, and :delete
673 (auth-source-do-trivia
674 "auth-source-search-backend: got %d (max %d) in %s:%s matching %S"
675 (length bmatches) max
676 (slot-value backend :type)
677 (slot-value backend :source)
679 (setq matches (append matches bmatches))))))
682 ;;; (auth-source-search :max 1)
683 ;;; (funcall (plist-get (nth 0 (auth-source-search :max 1)) :secret))
684 ;;; (auth-source-search :host "nonesuch" :type 'netrc :K 1)
685 ;;; (auth-source-search :host "nonesuch" :type 'secrets)
687 (defun* auth-source-delete (&rest spec
690 "Delete entries from the authentication backends according to SPEC.
691 Calls `auth-source-search' with the :delete property in SPEC set to t.
692 The backend may not actually delete the entries.
694 Returns the deleted entries."
695 (auth-source-search (plist-put spec :delete t)))
697 (defun auth-source-search-collection (collection value)
698 "Returns t is VALUE is t or COLLECTION is t or contains VALUE."
699 (when (and (atom collection) (not (eq t collection)))
700 (setq collection (list collection)))
702 ;; (debug :collection collection :value value)
703 (or (eq collection t)
705 (equal collection value)
706 (member value collection)))
708 (defvar auth-source-netrc-cache nil)
710 (defun auth-source-forget-all-cached ()
711 "Forget all cached auth-source data."
713 (loop for sym being the symbols of password-data
714 ;; when the symbol name starts with auth-source-magic
715 when (string-match (concat "^" auth-source-magic)
718 do (password-cache-remove (symbol-name sym)))
719 (setq auth-source-netrc-cache nil))
721 (defun auth-source-remember (spec found)
722 "Remember FOUND search results for SPEC."
723 (let ((password-cache-expiry auth-source-cache-expiry))
725 (concat auth-source-magic (format "%S" spec)) found)))
727 (defun auth-source-recall (spec)
728 "Recall FOUND search results for SPEC."
729 (password-read-from-cache
730 (concat auth-source-magic (format "%S" spec))))
732 (defun auth-source-remembered-p (spec)
733 "Check if SPEC is remembered."
735 (concat auth-source-magic (format "%S" spec))))
737 (defun auth-source-forget (spec)
738 "Forget any cached data matching SPEC exactly.
740 This is the same SPEC you passed to `auth-source-search'.
741 Returns t or nil for forgotten or not found."
742 (password-cache-remove (concat auth-source-magic (format "%S" spec))))
744 ;;; (loop for sym being the symbols of password-data when (string-match (concat "^" auth-source-magic) (symbol-name sym)) collect (symbol-name sym))
746 ;;; (auth-source-remember '(:host "wedd") '(4 5 6))
747 ;;; (auth-source-remembered-p '(:host "wedd"))
748 ;;; (auth-source-remember '(:host "xedd") '(1 2 3))
749 ;;; (auth-source-remembered-p '(:host "xedd"))
750 ;;; (auth-source-remembered-p '(:host "zedd"))
751 ;;; (auth-source-recall '(:host "xedd"))
752 ;;; (auth-source-recall '(:host t))
753 ;;; (auth-source-forget+ :host t)
755 (defun* auth-source-forget+ (&rest spec &allow-other-keys)
756 "Forget any cached data matching SPEC. Returns forgotten count.
758 This is not a full `auth-source-search' spec but works similarly.
759 For instance, \(:host \"myhost\" \"yourhost\") would find all the
760 cached data that was found with a search for those two hosts,
761 while \(:host t) would find all host entries."
764 (loop for sym being the symbols of password-data
765 ;; when the symbol name matches with auth-source-magic
766 when (and (setq sname (symbol-name sym))
767 (string-match (concat "^" auth-source-magic "\\(.+\\)")
769 ;; and the spec matches what was stored in the cache
770 (auth-source-specmatchp spec (read (match-string 1 sname))))
773 (password-cache-remove sname)
777 (defun auth-source-specmatchp (spec stored)
778 (let ((keys (loop for i below (length spec) by 2
779 collect (nth i spec))))
782 (unless (auth-source-search-collection (plist-get stored key)
783 (plist-get spec key))
787 ;;; (auth-source-pick-first-password :host "z.lifelogs.com")
788 ;;; (auth-source-pick-first-password :port "imap")
789 (defun auth-source-pick-first-password (&rest spec)
790 "Pick the first secret found from applying SPEC to `auth-source-search'."
791 (let* ((result (nth 0 (apply 'auth-source-search (plist-put spec :max 1))))
792 (secret (plist-get result :secret)))
794 (if (functionp secret)
798 ;; (auth-source-format-prompt "test %u %h %p" '((?u "user") (?h "host")))
799 (defun auth-source-format-prompt (prompt alist)
800 "Format PROMPT using %x (for any character x) specifiers in ALIST."
802 (let ((c (nth 0 cell))
805 (setq prompt (replace-regexp-in-string (format "%%%c" c)
810 (defun auth-source-ensure-strings (values)
811 (unless (listp values)
812 (setq values (list values)))
813 (mapcar (lambda (value)
819 ;;; Backend specific parsing: netrc/authinfo backend
821 ;;; (auth-source-netrc-parse "~/.authinfo.gpg")
822 (defun* auth-source-netrc-parse (&rest
824 &key file max host user port delete require
826 "Parse FILE and return a list of all entries in the file.
827 Note that the MAX parameter is used so we can exit the parse early."
829 ;; We got already parsed contents; just return it.
831 (when (file-exists-p file)
832 (setq port (auth-source-ensure-strings port))
834 (let* ((tokens '("machine" "host" "default" "login" "user"
835 "password" "account" "macdef" "force"
837 (max (or max 5000)) ; sanity check: default to stop at 5K
839 (cached (cdr-safe (assoc file auth-source-netrc-cache)))
840 (cached-mtime (plist-get cached :mtime))
841 (cached-secrets (plist-get cached :secret))
842 alist elem result pair)
844 (if (and (functionp cached-secrets)
846 (nth 5 (file-attributes file))))
848 (auth-source-do-trivia
849 "auth-source-netrc-parse: using CACHED file data for %s"
851 (insert (funcall cached-secrets)))
852 (insert-file-contents file)
853 ;; cache all netrc files (used to be just .gpg files)
854 ;; Store the contents of the file heavily encrypted in memory.
855 ;; (note for the irony-impaired: they are just obfuscated)
856 (aput 'auth-source-netrc-cache file
857 (list :mtime (nth 5 (file-attributes file))
858 :secret (lexical-let ((v (rot13-string
859 (base64-encode-string
861 (lambda () (base64-decode-string
862 (rot13-string v)))))))
863 (goto-char (point-min))
864 ;; Go through the file, line by line.
865 (while (and (not (eobp))
868 (narrow-to-region (point) (point-at-eol))
869 ;; For each line, get the tokens and values.
871 (skip-chars-forward "\t ")
872 ;; Skip lines that begin with a "#".
873 (if (eq (char-after) ?#)
874 (goto-char (point-max))
877 (if (= (following-char) ?\")
878 (read (current-buffer))
880 (point) (progn (skip-chars-forward "^\t ")
883 ((equal elem "macdef")
884 ;; We skip past the macro definition.
886 (while (and (zerop (forward-line 1))
888 (narrow-to-region (point) (point)))
889 ((member elem tokens)
890 ;; Tokens that don't have a following value are ignored,
892 (when (and pair (or (cdr pair)
893 (equal (car pair) "default")))
895 (setq pair (list elem)))
897 ;; Values that haven't got a preceding token are ignored.
901 (setq pair nil)))))))
905 (auth-source-search-collection
908 (aget alist "machine")
911 (auth-source-search-collection
915 (aget alist "account")
918 (auth-source-search-collection
922 (aget alist "protocol")
925 ;; the required list of keys is nil, or
927 ;; every element of require is in the normalized list
928 (let ((normalized (nth 0 (auth-source-netrc-normalize
929 (list alist) file))))
930 (loop for req in require
931 always (plist-get normalized req)))))
933 (push (nreverse alist) result)
934 ;; to delete a line, we just comment it out
936 (goto-char (point-min))
945 (when auth-source-gpg-encrypt-to
946 ;; (see bug#7487) making `epa-file-encrypt-to' local to
947 ;; this buffer lets epa-file skip the key selection query
948 ;; (see the `local-variable-p' check in
949 ;; `epa-file-write-region').
950 (unless (local-variable-p 'epa-file-encrypt-to (current-buffer))
951 (make-local-variable 'epa-file-encrypt-to))
952 (if (listp auth-source-gpg-encrypt-to)
953 (setq epa-file-encrypt-to auth-source-gpg-encrypt-to)))
955 ;; ask AFTER we've successfully opened the file
956 (when (y-or-n-p (format "Save file %s? (%d deletions)"
958 (write-region (point-min) (point-max) file nil 'silent)
959 (auth-source-do-debug
960 "auth-source-netrc-parse: modified %d lines in %s"
963 (nreverse result))))))
965 (defmacro with-auth-source-epa-overrides (&rest body)
966 `(let ((file-name-handler-alist
967 ',(if (boundp 'epa-file-handler)
968 (remove (symbol-value 'epa-file-handler)
969 file-name-handler-alist)
970 file-name-handler-alist))
971 (,(if (boundp 'find-file-hook) 'find-file-hook 'find-file-hooks)
973 'epa-file-find-file-hook
974 (if (boundp 'find-file-hook) 'find-file-hook 'find-file-hooks)))
976 ',(if (boundp 'epa-file-auto-mode-alist-entry)
977 (remove (symbol-value 'epa-file-auto-mode-alist-entry)
982 (defun auth-source-epa-make-gpg-token (secret file)
984 (unless (featurep 'epa)
985 (error "EPA could not be loaded."))
986 (let* ((base (file-name-sans-extension file))
987 (passkey (format "gpg:-%s" base))
988 (stash (concat base ".gpg"))
989 ;; temporarily disable EPA
991 (with-auth-source-epa-overrides
992 (make-temp-file "gpg-token" nil
994 (epa-file-passphrase-alist
998 "token pass for %s? "
1001 (write-region secret nil stashfile)
1002 ;; temporarily disable EPA
1004 (with-auth-source-epa-overrides
1006 (insert-file-contents stashfile)
1007 (base64-encode-region (point-min) (point-max) t)
1009 (buffer-substring-no-properties
1012 (delete-file stashfile))))
1014 (defun auth-source-netrc-normalize (alist filename)
1015 (mapcar (lambda (entry)
1017 (while (setq item (pop entry))
1018 (let ((k (car item))
1021 ;; apply key aliases
1022 (setq k (cond ((member k '("machine")) "host")
1023 ((member k '("login" "account")) "user")
1024 ((member k '("protocol")) "port")
1025 ((member k '("password")) "secret")
1028 ;; send back the secret in a function (lexical binding)
1029 (when (equal k "secret")
1030 (setq v (lexical-let ((v v)
1032 (base (file-name-nondirectory
1037 (setq stash (concat base ".gpg"))
1038 (when (string-match "gpg:\\(.+\\)" v)
1039 (require 'epa nil t)
1040 (unless (featurep 'epa)
1041 (error "EPA could not be loaded."))
1042 (setq gpgdata (base64-decode-string
1043 (match-string 1 v)))
1048 ;;; FIXME: this relies on .gpg files being handled by EPA/EPG
1049 (let* ((passkey (format "gpg:-%s" base))
1050 ;; temporarily disable EPA
1052 (with-auth-source-epa-overrides
1053 (make-temp-file "gpg-token" nil
1055 (epa-file-passphrase-alist
1059 "token pass for %s? "
1064 ;; temporarily disable EPA
1065 (with-auth-source-epa-overrides
1066 (write-region gpgdata
1072 (insert-file-contents stashfile)
1073 (buffer-substring-no-properties
1076 (delete-file stashfile)))
1077 ;; clear out the decoder at end
1078 (setq token-decoder nil
1082 (funcall token-decoder gpgdata))
1084 (setq ret (plist-put ret
1085 (intern (concat ":" k))
1090 ;;; (setq secret (plist-get (nth 0 (auth-source-search :host t :type 'netrc :K 1 :max 1)) :secret))
1091 ;;; (funcall secret)
1093 (defun* auth-source-netrc-search (&rest
1095 &key backend require create delete
1096 type max host user port
1098 "Given a property list SPEC, return search matches from the :backend.
1099 See `auth-source-search' for details on SPEC."
1100 ;; just in case, check that the type is correct (null or same as the backend)
1101 (assert (or (null type) (eq type (oref backend type)))
1102 t "Invalid netrc search: %s %s")
1104 (let ((results (auth-source-netrc-normalize
1105 (auth-source-netrc-parse
1109 :file (oref backend source)
1113 (oref backend source))))
1115 ;; if we need to create an entry AND none were found to match
1119 ;; create based on the spec and record the value
1121 ;; if the user did not want to create the entry
1122 ;; in the file, it will be returned
1123 (apply (slot-value backend 'create-function) spec)
1124 ;; if not, we do the search again without :create
1125 ;; to get the updated data.
1127 ;; the result will be returned, even if the search fails
1128 (apply 'auth-source-netrc-search
1129 (plist-put spec :create nil)))))
1132 (defun auth-source-netrc-element-or-first (v)
1137 ;;; (auth-source-search :host "nonesuch" :type 'netrc :max 1 :create t)
1138 ;;; (auth-source-search :host "nonesuch" :type 'netrc :max 1 :create t :create-extra-keys '((A "default A") (B)))
1140 (defun* auth-source-netrc-create (&rest spec
1142 secret host user port create
1144 (let* ((base-required '(host user port secret))
1145 ;; we know (because of an assertion in auth-source-search) that the
1146 ;; :create parameter is either t or a list (which includes nil)
1147 (create-extra (if (eq t create) nil create))
1148 (current-data (car (auth-source-search :max 1
1151 (required (append base-required create-extra))
1152 (file (oref backend source))
1154 ;; `valist' is an alist
1156 ;; `artificial' will be returned if no creation is needed
1159 ;; only for base required elements (defined as function parameters):
1160 ;; fill in the valist with whatever data we may have from the search
1161 ;; we complete the first value if it's a list and use the value otherwise
1162 (dolist (br base-required)
1163 (when (symbol-value br)
1164 (let ((br-choice (cond
1165 ;; all-accepting choice (predicate is t)
1166 ((eq t (symbol-value br)) nil)
1167 ;; just the value otherwise
1168 (t (symbol-value br)))))
1170 (aput 'valist br br-choice)))))
1172 ;; for extra required elements, see if the spec includes a value for them
1173 (dolist (er create-extra)
1174 (let ((name (concat ":" (symbol-name er)))
1175 (keys (loop for i below (length spec) by 2
1176 collect (nth i spec))))
1178 (when (equal (symbol-name k) name)
1179 (aput 'valist er (plist-get spec k))))))
1181 ;; for each required element
1182 (dolist (r required)
1183 (let* ((data (aget valist r))
1184 ;; take the first element if the data is a list
1185 (data (or (auth-source-netrc-element-or-first data)
1186 (plist-get current-data
1187 (intern (format ":%s" r) obarray))))
1188 ;; this is the default to be offered
1189 (given-default (aget auth-source-creation-defaults r))
1190 ;; the default supplementals are simple:
1191 ;; for the user, try `given-default' and then (user-login-name);
1192 ;; otherwise take `given-default'
1194 ((and (not given-default) (eq r 'user))
1197 (printable-defaults (list
1200 (auth-source-netrc-element-or-first
1201 (aget valist 'user))
1202 (plist-get artificial :user)
1206 (auth-source-netrc-element-or-first
1207 (aget valist 'host))
1208 (plist-get artificial :host)
1212 (auth-source-netrc-element-or-first
1213 (aget valist 'port))
1214 (plist-get artificial :port)
1216 (prompt (or (aget auth-source-creation-prompts r)
1218 (secret "%p password for %u@%h: ")
1219 (user "%p user name for %h: ")
1220 (host "%p host name for user %u: ")
1221 (port "%p port for %u@%h: "))
1222 (format "Enter %s (%%u@%%h:%%p): " r)))
1223 (prompt (auth-source-format-prompt
1225 `((?u ,(aget printable-defaults 'user))
1226 (?h ,(aget printable-defaults 'host))
1227 (?p ,(aget printable-defaults 'port))))))
1229 ;; Store the data, prompting for the password if needed.
1232 ((and (null data) (eq r 'secret))
1233 ;; Special case prompt for passwords.
1234 ;; TODO: make the default (setq auth-source-netrc-use-gpg-tokens `((,(if (boundp 'epa-file-auto-mode-alist-entry) (car (symbol-value 'epa-file-auto-mode-alist-entry)) "\\.gpg\\'") nil) (t gpg)))
1235 ;; TODO: or maybe leave as (setq auth-source-netrc-use-gpg-tokens 'never)
1236 (let* ((ep (format "Use GPG password tokens in %s?" file))
1239 ((eq auth-source-netrc-use-gpg-tokens 'never)
1241 ((listp auth-source-netrc-use-gpg-tokens)
1242 (let ((check (copy-sequence
1243 auth-source-netrc-use-gpg-tokens))
1246 (setq item (pop check))
1247 (when (or (eq (car item) t)
1248 (string-match (car item) file))
1249 (setq ret (cdr item))
1250 (setq check nil)))))
1252 (plain (read-passwd prompt)))
1253 ;; ask if we don't know what to do (in which case
1254 ;; auth-source-netrc-use-gpg-tokens must be a list)
1256 (setq gpg-encrypt (if (y-or-n-p ep) 'gpg 'never))
1257 ;; TODO: save the defcustom now? or ask?
1258 (setq auth-source-netrc-use-gpg-tokens
1259 (cons `(,file ,gpg-encrypt)
1260 auth-source-netrc-use-gpg-tokens)))
1261 (if (eq gpg-encrypt 'gpg)
1262 (auth-source-epa-make-gpg-token plain file)
1267 (if (string-match ": *\\'" prompt)
1268 (concat (substring prompt 0 (match-beginning 0))
1269 " (default " default "): ")
1270 (concat prompt "(default " default ") "))))
1271 (read-string prompt nil nil default))
1272 (t (or data default))))
1275 (setq artificial (plist-put artificial
1276 (intern (concat ":" (symbol-name r)))
1278 (lexical-let ((data data))
1282 ;; When r is not an empty string...
1283 (when (and (stringp data)
1284 (< 0 (length data)))
1285 ;; this function is not strictly necessary but I think it
1286 ;; makes the code clearer -tzz
1287 (let ((printer (lambda ()
1288 ;; append the key (the symbol name of r)
1289 ;; and the value in r
1292 (if (zerop (length add)) "" " ")
1293 ;; remap auth-source tokens to netrc
1298 (port "port") ; redundant but clearer
1299 (t (symbol-name r)))
1300 (if (string-match "[\" ]" data)
1303 (setq add (concat add (funcall printer)))))))
1308 (lexical-let ((file file)
1310 (lambda () (auth-source-netrc-saver file add))))
1314 ;;(funcall (plist-get (nth 0 (auth-source-search :host '("nonesuch2") :user "tzz" :port "imap" :create t :max 1)) :save-function))
1315 (defun auth-source-netrc-saver (file add)
1316 "Save a line ADD in FILE, prompting along the way.
1317 Respects `auth-source-save-behavior'. Uses
1318 `auth-source-netrc-cache' to avoid prompting more than once."
1319 (let* ((key (format "%s %s" file (rfc2104-hash 'md5 64 16 file add)))
1320 (cached (assoc key auth-source-netrc-cache)))
1323 (auth-source-do-trivia
1324 "auth-source-netrc-saver: found previous run for key %s, returning"
1327 (when (file-exists-p file)
1328 (insert-file-contents file))
1329 (when auth-source-gpg-encrypt-to
1330 ;; (see bug#7487) making `epa-file-encrypt-to' local to
1331 ;; this buffer lets epa-file skip the key selection query
1332 ;; (see the `local-variable-p' check in
1333 ;; `epa-file-write-region').
1334 (unless (local-variable-p 'epa-file-encrypt-to (current-buffer))
1335 (make-local-variable 'epa-file-encrypt-to))
1336 (if (listp auth-source-gpg-encrypt-to)
1337 (setq epa-file-encrypt-to auth-source-gpg-encrypt-to)))
1338 ;; we want the new data to be found first, so insert at beginning
1339 (goto-char (point-min))
1341 ;; Ask AFTER we've successfully opened the file.
1342 (let ((prompt (format "Save auth info to file %s? " file))
1343 (done (not (eq auth-source-save-behavior 'ask)))
1344 (bufname "*auth-source Help*")
1347 (setq k (auth-source-read-char-choice prompt '(?y ?n ?N ?e ??)))
1351 (with-output-to-temp-buffer bufname
1353 (concat "(y)es, save\n"
1354 "(n)o but use the info\n"
1355 "(N)o and don't ask to save again\n"
1357 "(?) for help as you can see.\n"))
1358 ;; Why? Doesn't with-output-to-temp-buffer already do
1359 ;; the exact same thing anyway? --Stef
1360 (set-buffer standard-output)
1366 auth-source-save-behavior nil))
1367 (?e (setq add (read-string "Line to add: " add)))
1370 (when (get-buffer-window bufname)
1371 (delete-window (get-buffer-window bufname)))
1373 ;; Make sure the info is not saved.
1374 (when (null auth-source-save-behavior)
1377 (when (< 0 (length add))
1382 (write-region (point-min) (point-max) file nil 'silent)
1383 (auth-source-do-debug
1384 "auth-source-netrc-create: wrote 1 new line to %s"
1386 (message "Saved new authentication information to %s" file)
1388 (aput 'auth-source-netrc-cache key "ran"))))
1390 ;;; Backend specific parsing: Secrets API backend
1392 ;;; (let ((auth-sources '(default))) (auth-source-search :max 1 :create t))
1393 ;;; (let ((auth-sources '(default))) (auth-source-search :max 1 :delete t))
1394 ;;; (let ((auth-sources '(default))) (auth-source-search :max 1))
1395 ;;; (let ((auth-sources '(default))) (auth-source-search))
1396 ;;; (let ((auth-sources '("secrets:Login"))) (auth-source-search :max 1))
1397 ;;; (let ((auth-sources '("secrets:Login"))) (auth-source-search :max 1 :signon_realm "https://git.gnus.org/Git"))
1399 (defun* auth-source-secrets-search (&rest
1401 &key backend create delete label
1402 type max host user port
1404 "Search the Secrets API; spec is like `auth-source'.
1406 The :label key specifies the item's label. It is the only key
1407 that can specify a substring. Any :label value besides a string
1408 will allow any label.
1410 All other search keys must match exactly. If you need substring
1411 matching, do a wider search and narrow it down yourself.
1413 You'll get back all the properties of the token as a plist.
1415 Here's an example that looks for the first item in the 'Login'
1418 \(let ((auth-sources '(\"secrets:Login\")))
1419 (auth-source-search :max 1)
1421 Here's another that looks for the first item in the 'Login'
1422 Secrets collection whose label contains 'gnus':
1424 \(let ((auth-sources '(\"secrets:Login\")))
1425 (auth-source-search :max 1 :label \"gnus\")
1427 And this one looks for the first item in the 'Login' Secrets
1428 collection that's a Google Chrome entry for the git.gnus.org site
1429 authentication tokens:
1431 \(let ((auth-sources '(\"secrets:Login\")))
1432 (auth-source-search :max 1 :signon_realm \"https://git.gnus.org/Git\"))
1436 (assert (not create) nil
1437 "The Secrets API auth-source backend doesn't support creation yet")
1439 ;; (secrets-delete-item coll elt)
1440 (assert (not delete) nil
1441 "The Secrets API auth-source backend doesn't support deletion yet")
1443 (let* ((coll (oref backend source))
1444 (max (or max 5000)) ; sanity check: default to stop at 5K
1445 (ignored-keys '(:create :delete :max :backend :label))
1446 (search-keys (loop for i below (length spec) by 2
1447 unless (memq (nth i spec) ignored-keys)
1448 collect (nth i spec)))
1449 ;; build a search spec without the ignored keys
1450 ;; if a search key is nil or t (match anything), we skip it
1451 (search-spec (apply 'append (mapcar
1453 (if (or (null (plist-get spec k))
1454 (eq t (plist-get spec k)))
1456 (list k (plist-get spec k))))
1458 ;; needed keys (always including host, login, port, and secret)
1459 (returned-keys (mm-delete-duplicates (append
1460 '(:host :login :port :secret)
1462 (items (loop for item in (apply 'secrets-search-items coll search-spec)
1463 unless (and (stringp label)
1464 (not (string-match label item)))
1466 ;; TODO: respect max in `secrets-search-items', not after the fact
1467 (items (butlast items (- (length items) max)))
1468 ;; convert the item name to a full plist
1469 (items (mapcar (lambda (item)
1471 ;; make an entry for the secret (password) element
1474 (lexical-let ((v (secrets-get-secret coll item)))
1476 ;; rewrite the entry from ((k1 v1) (k2 v2)) to plist
1478 (mapcar (lambda (entry)
1479 (list (car entry) (cdr entry)))
1480 (secrets-get-attributes coll item)))))
1482 ;; ensure each item has each key in `returned-keys'
1483 (items (mapcar (lambda (plist)
1486 (mapcar (lambda (req)
1487 (if (plist-get plist req)
1495 (defun* auth-source-secrets-create (&rest
1497 &key backend type max host user port
1500 ;; (apply 'secrets-create-item (auth-get-source entry) name passwd spec)
1505 ;;; (auth-source-user-or-password '("login" "password") "imap.myhost.com" t "tzz")
1507 ;; deprecate the old interface
1508 (make-obsolete 'auth-source-user-or-password
1509 'auth-source-search "Emacs 24.1")
1510 (make-obsolete 'auth-source-forget-user-or-password
1511 'auth-source-forget "Emacs 24.1")
1513 (defun auth-source-user-or-password
1514 (mode host port &optional username create-missing delete-existing)
1515 "Find MODE (string or list of strings) matching HOST and PORT.
1517 DEPRECATED in favor of `auth-source-search'!
1519 USERNAME is optional and will be used as \"login\" in a search
1520 across the Secret Service API (see secrets.el) if the resulting
1521 items don't have a username. This means that if you search for
1522 username \"joe\" and it matches an item but the item doesn't have
1523 a :user attribute, the username \"joe\" will be returned.
1525 A non nil DELETE-EXISTING means deleting any matching password
1526 entry in the respective sources. This is useful only when
1527 CREATE-MISSING is non nil as well; the intended use case is to
1528 remove wrong password entries.
1530 If no matching entry is found, and CREATE-MISSING is non nil,
1531 the password will be retrieved interactively, and it will be
1532 stored in the password database which matches best (see
1535 MODE can be \"login\" or \"password\"."
1536 (auth-source-do-debug
1537 "auth-source-user-or-password: DEPRECATED get %s for %s (%s) + user=%s"
1538 mode host port username)
1540 (let* ((listy (listp mode))
1541 (mode (if listy mode (list mode)))
1543 (format "%s %s:%s %s" mode host port username)
1544 (format "%s %s:%s" mode host port)))
1545 (search (list :host host :port port))
1546 (search (if username (append search (list :user username)) search))
1547 (search (if create-missing
1548 (append search (list :create t))
1550 (search (if delete-existing
1551 (append search (list :delete t))
1553 ;; (found (if (not delete-existing)
1554 ;; (gethash cname auth-source-cache)
1555 ;; (remhash cname auth-source-cache)
1560 (auth-source-do-debug
1561 "auth-source-user-or-password: DEPRECATED cached %s=%s for %s (%s) + %s"
1563 ;; don't show the password
1564 (if (and (member "password" mode) t)
1568 found) ; return the found data
1569 ;; else, if not found, search with a max of 1
1570 (let ((choice (nth 0 (apply 'auth-source-search
1571 (append '(:max 1) search)))))
1575 ((equal "password" m)
1576 (push (if (plist-get choice :secret)
1577 (funcall (plist-get choice :secret))
1580 (push (plist-get choice :user) found)))))
1581 (setq found (nreverse found))
1582 (setq found (if listy found (car-safe found)))))
1586 (provide 'auth-source)
1588 ;;; auth-source.el ends here