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)
47 (eval-when-compile (require 'cl))
49 (or (ignore-errors (require 'eieio))
50 ;; gnus-fallback-lib/ from gnus/lisp/gnus-fallback-lib
52 (let ((load-path (cons (expand-file-name
53 "gnus-fallback-lib/eieio"
54 (file-name-directory (locate-library "gnus")))
58 "eieio not found in `load-path' or gnus-fallback-lib/ directory.")))
60 (autoload 'secrets-create-item "secrets")
61 (autoload 'secrets-delete-item "secrets")
62 (autoload 'secrets-get-alias "secrets")
63 (autoload 'secrets-get-attributes "secrets")
64 (autoload 'secrets-get-secret "secrets")
65 (autoload 'secrets-list-collections "secrets")
66 (autoload 'secrets-search-items "secrets")
68 (defvar secrets-enabled)
70 (defgroup auth-source nil
71 "Authentication sources."
72 :version "23.1" ;; No Gnus
76 (defcustom auth-source-cache-expiry 7200
77 "How many seconds passwords are cached, or nil to disable
78 expiring. Overrides `password-cache-expiry' through a
81 :type '(choice (const :tag "Never" nil)
82 (const :tag "All Day" 86400)
83 (const :tag "2 Hours" 7200)
84 (const :tag "30 Minutes" 1800)
85 (integer :tag "Seconds")))
87 (defclass auth-source-backend ()
92 :documentation "The backend type.")
93 (source :initarg :source
96 :documentation "The backend source.")
101 :documentation "The backend host.")
106 :documentation "The backend user.")
111 :documentation "The backend protocol.")
112 (create-function :initarg :create-function
116 :documentation "The create function.")
117 (search-function :initarg :search-function
121 :documentation "The search function.")))
123 (defcustom auth-source-protocols '((imap "imap" "imaps" "143" "993")
124 (pop3 "pop3" "pop" "pop3s" "110" "995")
128 "List of authentication protocols and their names"
131 :version "23.2" ;; No Gnus
132 :type '(repeat :tag "Authentication Protocols"
133 (cons :tag "Protocol Entry"
134 (symbol :tag "Protocol")
136 (string :tag "Name")))))
138 ;;; generate all the protocols in a format Customize can use
139 ;;; TODO: generate on the fly from auth-source-protocols
140 (defconst auth-source-protocols-customize
142 (let ((p (car-safe a)))
144 :tag (upcase (symbol-name p))
146 auth-source-protocols))
148 (defvar auth-source-creation-defaults nil
149 "Defaults for creating token values. Usually let-bound.")
151 (make-obsolete 'auth-source-hide-passwords nil "Emacs 24.1")
153 (defvar auth-source-magic "auth-source-magic ")
155 (defcustom auth-source-do-cache t
156 "Whether auth-source should cache information with `password-cache'."
158 :version "23.2" ;; No Gnus
161 (defcustom auth-source-debug nil
162 "Whether auth-source should log debug messages.
164 If the value is nil, debug messages are not logged.
166 If the value is t, debug messages are logged with `message'. In
167 that case, your authentication data will be in the clear (except
170 If the value is a function, debug messages are logged by calling
171 that function using the same arguments as `message'."
173 :version "23.2" ;; No Gnus
175 :tag "auth-source debugging mode"
176 (const :tag "Log using `message' to the *Messages* buffer" t)
177 (function :tag "Function that takes arguments like `message'")
178 (const :tag "Don't log anything" nil)))
180 (defcustom auth-sources '("~/.authinfo.gpg" "~/.authinfo")
181 "List of authentication sources.
183 The default will get login and password information from
184 \"~/.authinfo.gpg\", which you should set up with the EPA/EPG
185 packages to be encrypted. If that file doesn't exist, it will
186 try the unencrypted version \"~/.authinfo\".
188 See the auth.info manual for details.
190 Each entry is the authentication type with optional properties.
192 It's best to customize this with `M-x customize-variable' because the choices
193 can get pretty complex."
195 :version "24.1" ;; No Gnus
196 :type `(repeat :tag "Authentication Sources"
198 (string :tag "Just a file")
199 (const :tag "Default Secrets API Collection" 'default)
200 (const :tag "Login Secrets API Collection" "secrets:Login")
201 (const :tag "Temp Secrets API Collection" "secrets:session")
202 (list :tag "Source definition"
203 (const :format "" :value :source)
204 (choice :tag "Authentication backend choice"
205 (string :tag "Authentication Source (file)")
207 :tag "Secret Service API/KWallet/GNOME Keyring"
208 (const :format "" :value :secrets)
209 (choice :tag "Collection to use"
210 (string :tag "Collection name")
211 (const :tag "Default" 'default)
212 (const :tag "Login" "Login")
214 :tag "Temporary" "session"))))
215 (repeat :tag "Extra Parameters" :inline t
216 (choice :tag "Extra parameter"
219 (const :format "" :value :host)
220 (choice :tag "Host (machine) choice"
223 :tag "Regular expression")))
226 (const :format "" :value :port)
230 ,@auth-source-protocols-customize))
231 (list :tag "User" :inline t
232 (const :format "" :value :user)
233 (choice :tag "Personality/Username"
235 (string :tag "Name")))))))))
237 (defcustom auth-source-gpg-encrypt-to t
238 "List of recipient keys that `authinfo.gpg' encrypted to.
239 If the value is not a list, symmetric encryption will be used."
241 :version "24.1" ;; No Gnus
242 :type '(choice (const :tag "Symmetric encryption" t)
243 (repeat :tag "Recipient public keys"
244 (string :tag "Recipient public key"))))
246 ;; temp for debugging
247 ;; (unintern 'auth-source-protocols)
248 ;; (unintern 'auth-sources)
249 ;; (customize-variable 'auth-sources)
250 ;; (setq auth-sources nil)
251 ;; (format "%S" auth-sources)
252 ;; (customize-variable 'auth-source-protocols)
253 ;; (setq auth-source-protocols nil)
254 ;; (format "%S" auth-source-protocols)
255 ;; (auth-source-pick nil :host "a" :port 'imap)
256 ;; (auth-source-user-or-password "login" "imap.myhost.com" 'imap)
257 ;; (auth-source-user-or-password "password" "imap.myhost.com" 'imap)
258 ;; (auth-source-user-or-password-imap "login" "imap.myhost.com")
259 ;; (auth-source-user-or-password-imap "password" "imap.myhost.com")
260 ;; (auth-source-protocol-defaults 'imap)
262 ;; (let ((auth-source-debug 'debug)) (auth-source-do-debug "hello"))
263 ;; (let ((auth-source-debug t)) (auth-source-do-debug "hello"))
264 ;; (let ((auth-source-debug nil)) (auth-source-do-debug "hello"))
265 (defun auth-source-do-debug (&rest msg)
266 (when auth-source-debug
267 (apply 'auth-source-do-warn msg)))
269 (defun auth-source-do-warn (&rest msg)
271 ;; set logger to either the function in auth-source-debug or 'message
272 ;; note that it will be 'message if auth-source-debug is nil
273 (if (functionp auth-source-debug)
279 ;; (auth-source-pick nil :host "any" :port 'imap :user "joe")
280 ;; (auth-source-pick t :host "any" :port 'imap :user "joe")
281 ;; (setq auth-sources '((:source (:secrets default) :host t :port t :user "joe")
282 ;; (:source (:secrets "session") :host t :port t :user "joe")
283 ;; (:source (:secrets "Login") :host t :port t)
284 ;; (:source "~/.authinfo.gpg" :host t :port t)))
286 ;; (setq auth-sources '((:source (:secrets default) :host t :port t :user "joe")
287 ;; (:source (:secrets "session") :host t :port t :user "joe")
288 ;; (:source (:secrets "Login") :host t :port t)
291 ;; (setq auth-sources '((:source "~/.authinfo.gpg" :host t :port t)))
293 ;; (auth-source-backend-parse "myfile.gpg")
294 ;; (auth-source-backend-parse 'default)
295 ;; (auth-source-backend-parse "secrets:Login")
297 (defun auth-source-backend-parse (entry)
298 "Creates an auth-source-backend from an ENTRY in `auth-sources'."
299 (auth-source-backend-parse-parameters
302 ;; take 'default and recurse to get it as a Secrets API default collection
303 ;; matching any user, host, and protocol
305 (auth-source-backend-parse '(:source (:secrets default))))
306 ;; take secrets:XYZ and recurse to get it as Secrets API collection "XYZ"
307 ;; matching any user, host, and protocol
308 ((and (stringp entry) (string-match "^secrets:\\(.+\\)" entry))
309 (auth-source-backend-parse `(:source (:secrets ,(match-string 1 entry)))))
310 ;; take just a file name and recurse to get it as a netrc file
311 ;; matching any user, host, and protocol
313 (auth-source-backend-parse `(:source ,entry)))
315 ;; a file name with parameters
316 ((stringp (plist-get entry :source))
318 (plist-get entry :source)
319 :source (plist-get entry :source)
321 :search-function 'auth-source-netrc-search
322 :create-function 'auth-source-netrc-create))
324 ;; the Secrets API. We require the package, in order to have a
325 ;; defined value for `secrets-enabled'.
327 (not (null (plist-get entry :source))) ; the source must not be nil
328 (listp (plist-get entry :source)) ; and it must be a list
329 (require 'secrets nil t) ; and we must load the Secrets API
330 secrets-enabled) ; and that API must be enabled
332 ;; the source is either the :secrets key in ENTRY or
333 ;; if that's missing or nil, it's "session"
334 (let ((source (or (plist-get (plist-get entry :source) :secrets)
337 ;; if the source is a symbol, we look for the alias named so,
338 ;; and if that alias is missing, we use "Login"
339 (when (symbolp source)
340 (setq source (or (secrets-get-alias (symbol-name source))
343 (if (featurep 'secrets)
345 (format "Secrets API (%s)" source)
348 :search-function 'auth-source-secrets-search
349 :create-function 'auth-source-secrets-create)
351 "auth-source-backend-parse: no Secrets API, ignoring spec: %S" entry)
353 (format "Ignored Secrets API (%s)" source)
360 "auth-source-backend-parse: invalid backend spec: %S" entry)
366 (defun auth-source-backend-parse-parameters (entry backend)
367 "Fills in the extra auth-source-backend parameters of ENTRY.
368 Using the plist ENTRY, get the :host, :port, and :user search
370 (let ((entry (if (stringp entry)
374 (when (setq val (plist-get entry :host))
375 (oset backend host val))
376 (when (setq val (plist-get entry :user))
377 (oset backend user val))
378 (when (setq val (plist-get entry :port))
379 (oset backend port val)))
382 ;; (mapcar 'auth-source-backend-parse auth-sources)
384 (defun* auth-source-search (&rest spec
385 &key type max host user port secret
388 "Search or modify authentication backends according to SPEC.
390 This function parses `auth-sources' for matches of the SPEC
391 plist. It can optionally create or update an authentication
392 token if requested. A token is just a standard Emacs property
393 list with a :secret property that can be a function; all the
394 other properties will always hold scalar values.
396 Typically the :secret property, if present, contains a password.
398 Common search keys are :max, :host, :port, and :user. In
399 addition, :create specifies how tokens will be or created.
400 Finally, :type can specify which backend types you want to check.
402 A string value is always matched literally. A symbol is matched
403 as its string value, literally. All the SPEC values can be
404 single values (symbol or string) or lists thereof (in which case
405 any of the search terms matches).
407 :create t means to create a token if possible.
409 A new token will be created if no matching tokens were found.
410 The new token will have only the keys the backend requires. For
411 the netrc backend, for instance, that's the user, host, and
416 \(let ((auth-source-creation-defaults '((user . \"defaultUser\")
417 (A . \"default A\"))))
418 (auth-source-search :host \"mine\" :type 'netrc :max 1
419 :P \"pppp\" :Q \"qqqq\"
424 \"Search for any entry matching host 'mine' in backends of type
425 'netrc', maximum one result.
427 Create a new entry if you found none. The netrc backend will
428 automatically require host, user, and port. The host will be
429 'mine'. We prompt for the user with default 'defaultUser' and
430 for the port without a default. We will not prompt for A, Q,
431 or P. The resulting token will only have keys user, host, and
434 :create '(A B C) also means to create a token if possible.
436 The behavior is like :create t but if the list contains any
437 parameter, that parameter will be required in the resulting
438 token. The value for that parameter will be obtained from the
439 search parameters or from user input. If any queries are needed,
440 the alist `auth-source-creation-defaults' will be checked for the
445 \(let ((auth-source-creation-defaults '((user . \"defaultUser\")
446 (A . \"default A\"))))
447 (auth-source-search :host '(\"nonesuch\" \"twosuch\") :type 'netrc :max 1
448 :P \"pppp\" :Q \"qqqq\"
453 \"Search for any entry matching host 'nonesuch'
454 or 'twosuch' in backends of type 'netrc', maximum one result.
456 Create a new entry if you found none. The netrc backend will
457 automatically require host, user, and port. The host will be
458 'nonesuch' and Q will be 'qqqq'. We prompt for A with default
459 'default A', for B and port with default nil, and for the
460 user with default 'defaultUser'. We will not prompt for Q. The
461 resulting token will have keys user, host, port, A, B, and Q.
462 It will not have P with any value, even though P is used in the
463 search to find only entries that have P set to 'pppp'.\"
465 When multiple values are specified in the search parameter, the
466 user is prompted for which one. So :host (X Y Z) would ask the
467 user to choose between X, Y, and Z.
469 This creation can fail if the search was not specific enough to
470 create a new token (it's up to the backend to decide that). You
471 should `catch' the backend-specific error as usual. Some
472 backends (netrc, at least) will prompt the user rather than throw
475 :delete t means to delete any found entries. nil by default.
476 Use `auth-source-delete' in ELisp code instead of calling
477 `auth-source-search' directly with this parameter.
479 :type (X Y Z) will check only those backend types. 'netrc and
480 'secrets are the only ones supported right now.
482 :max N means to try to return at most N items (defaults to 1).
483 When 0 the function will return just t or nil to indicate if any
484 matches were found. More than N items may be returned, depending
485 on the search and the backend.
487 :host (X Y Z) means to match only hosts X, Y, or Z according to
488 the match rules above. Defaults to t.
490 :user (X Y Z) means to match only users X, Y, or Z according to
491 the match rules above. Defaults to t.
493 :port (P Q R) means to match only protocols P, Q, or R.
496 :K (V1 V2 V3) for any other key K will match values V1, V2, or
497 V3 (note the match rules above).
499 The return value is a list with at most :max tokens. Each token
500 is a plist with keys :backend :host :port :user, plus any other
501 keys provided by the backend (notably :secret). But note the
502 exception for :max 0, which see above.
504 The token's :secret key can hold a function. In that case you
505 must call it to obtain the actual value."
506 (let* ((backends (mapcar 'auth-source-backend-parse auth-sources))
508 (ignored-keys '(:create :delete :max))
509 (keys (loop for i below (length spec) by 2
510 unless (memq (nth i spec) ignored-keys)
511 collect (nth i spec)))
512 (found (auth-source-recall spec))
513 filtered-backends accessor-key found-here goal matches backend)
515 (if (and found auth-source-do-cache)
516 (auth-source-do-debug
517 "auth-source-search: found %d CACHED results matching %S"
521 (or (eq t create) (listp create)) t
522 "Invalid auth-source :create parameter (must be nil, t, or a list): %s %s")
524 (setq filtered-backends (copy-sequence backends))
525 (dolist (backend backends)
527 ;; ignore invalid slots
528 (condition-case signal
529 (unless (eval `(auth-source-search-collection
531 (oref backend ,key)))
532 (setq filtered-backends (delq backend filtered-backends))
534 (invalid-slot-name))))
536 (auth-source-do-debug
537 "auth-source-search: found %d backends matching %S"
538 (length filtered-backends) spec)
540 ;; (debug spec "filtered" filtered-backends)
542 ;; First go through all the backends without :create, so we can
544 (let ((uspec (copy-sequence spec)))
545 (plist-put uspec :create nil)
546 (dolist (backend filtered-backends)
548 (slot-value backend 'search-function)
552 (push (list backend match) matches)))))
553 ;; If we didn't find anything, then we allow the backend(s) to
554 ;; create the entries.
557 (dolist (backend filtered-backends)
560 (slot-value backend 'search-function)
566 (push (list backend match) matches))))))
568 (setq backend (caar matches)
569 found-here (cadar matches))
572 ;; if max is 0, as soon as we find something, return it
573 (when (and (zerop max) (> 0 (length found-here)))
576 ;; decrement the goal by the number of new results
577 (decf goal (length found-here))
578 ;; and append the new results to the full list
579 (setq found (append found found-here))
581 (auth-source-do-debug
582 "auth-source-search: found %d results (max %d/%d) in %S matching %S"
583 (length found-here) max goal backend spec)
585 ;; return full list if the goal is 0 or negative
586 (when (zerop (max 0 goal))
589 ;; change the :max parameter in the spec to the goal
590 (setq spec (plist-put spec :max goal))
592 (when (and found auth-source-do-cache)
593 (auth-source-remember spec found))))
597 ;;; (auth-source-search :max 1)
598 ;;; (funcall (plist-get (nth 0 (auth-source-search :max 1)) :secret))
599 ;;; (auth-source-search :host "nonesuch" :type 'netrc :K 1)
600 ;;; (auth-source-search :host "nonesuch" :type 'secrets)
602 (defun* auth-source-delete (&rest spec
605 "Delete entries from the authentication backends according to SPEC.
606 Calls `auth-source-search' with the :delete property in SPEC set to t.
607 The backend may not actually delete the entries.
609 Returns the deleted entries."
610 (auth-source-search (plist-put spec :delete t)))
612 (defun auth-source-search-collection (collection value)
613 "Returns t is VALUE is t or COLLECTION is t or contains VALUE."
614 (when (and (atom collection) (not (eq t collection)))
615 (setq collection (list collection)))
617 ;; (debug :collection collection :value value)
618 (or (eq collection t)
620 (equal collection value)
621 (member value collection)))
623 (defun auth-source-forget-all-cached ()
624 "Forget all cached auth-source data."
626 (loop for sym being the symbols of password-data
627 ;; when the symbol name starts with auth-source-magic
628 when (string-match (concat "^" auth-source-magic)
631 do (password-cache-remove (symbol-name sym))))
633 (defun auth-source-remember (spec found)
634 "Remember FOUND search results for SPEC."
635 (let ((password-cache-expiry auth-source-cache-expiry))
637 (concat auth-source-magic (format "%S" spec)) found)))
639 (defun auth-source-recall (spec)
640 "Recall FOUND search results for SPEC."
641 (password-read-from-cache
642 (concat auth-source-magic (format "%S" spec))))
644 (defun auth-source-forget (spec)
645 "Forget any cached data matching SPEC exactly.
647 This is the same SPEC you passed to `auth-source-search'.
648 Returns t or nil for forgotten or not found."
649 (password-cache-remove (concat auth-source-magic (format "%S" spec))))
651 ;;; (loop for sym being the symbols of password-data when (string-match (concat "^" auth-source-magic) (symbol-name sym)) collect (symbol-name sym))
653 ;;; (auth-source-remember '(:host "wedd") '(4 5 6))
654 ;;; (auth-source-remember '(:host "xedd") '(1 2 3))
655 ;;; (auth-source-recall '(:host "xedd"))
656 ;;; (auth-source-recall '(:host t))
657 ;;; (auth-source-forget+ :host t)
659 (defun* auth-source-forget+ (&rest spec &allow-other-keys)
660 "Forget any cached data matching SPEC. Returns forgotten count.
662 This is not a full `auth-source-search' spec but works similarly.
663 For instance, \(:host \"myhost\" \"yourhost\") would find all the
664 cached data that was found with a search for those two hosts,
665 while \(:host t) would find all host entries."
668 (loop for sym being the symbols of password-data
669 ;; when the symbol name matches with auth-source-magic
670 when (and (setq sname (symbol-name sym))
671 (string-match (concat "^" auth-source-magic "\\(.+\\)")
673 ;; and the spec matches what was stored in the cache
674 (auth-source-specmatchp spec (read (match-string 1 sname))))
677 (password-cache-remove sname)
681 (defun auth-source-specmatchp (spec stored)
682 (let ((keys (loop for i below (length spec) by 2
683 collect (nth i spec))))
686 (unless (auth-source-search-collection (plist-get stored key)
687 (plist-get spec key))
691 ;;; Backend specific parsing: netrc/authinfo backend
693 (defvar auth-source-netrc-cache nil)
695 ;;; (auth-source-netrc-parse "~/.authinfo.gpg")
696 (defun* auth-source-netrc-parse (&rest
698 &key file max host user port delete
700 "Parse FILE and return a list of all entries in the file.
701 Note that the MAX parameter is used so we can exit the parse early."
703 ;; We got already parsed contents; just return it.
705 (when (file-exists-p file)
707 (let ((tokens '("machine" "host" "default" "login" "user"
708 "password" "account" "macdef" "force"
710 (max (or max 5000)) ; sanity check: default to stop at 5K
712 alist elem result pair)
713 (if (and auth-source-netrc-cache
714 (equal (car auth-source-netrc-cache)
715 (nth 5 (file-attributes file))))
716 (insert (base64-decode-string
717 (rot13-string (cdr auth-source-netrc-cache))))
718 (insert-file-contents file)
719 (when (string-match "\\.gpg\\'" file)
720 ;; Store the contents of the file heavily encrypted in memory.
721 (setq auth-source-netrc-cache
722 (cons (nth 5 (file-attributes file))
724 (base64-encode-string
725 (buffer-string)))))))
726 (goto-char (point-min))
727 ;; Go through the file, line by line.
728 (while (and (not (eobp))
731 (narrow-to-region (point) (point-at-eol))
732 ;; For each line, get the tokens and values.
734 (skip-chars-forward "\t ")
735 ;; Skip lines that begin with a "#".
736 (if (eq (char-after) ?#)
737 (goto-char (point-max))
740 (if (= (following-char) ?\")
741 (read (current-buffer))
743 (point) (progn (skip-chars-forward "^\t ")
746 ((equal elem "macdef")
747 ;; We skip past the macro definition.
749 (while (and (zerop (forward-line 1))
751 (narrow-to-region (point) (point)))
752 ((member elem tokens)
753 ;; Tokens that don't have a following value are ignored,
755 (when (and pair (or (cdr pair)
756 (equal (car pair) "default")))
758 (setq pair (list elem)))
760 ;; Values that haven't got a preceding token are ignored.
764 (setq pair nil)))))))
768 (auth-source-search-collection
771 (aget alist "machine")
774 (auth-source-search-collection
778 (aget alist "account")
781 (auth-source-search-collection
785 (aget alist "protocol")
788 (push (nreverse alist) result)
789 ;; to delete a line, we just comment it out
791 (goto-char (point-min))
800 (when auth-source-gpg-encrypt-to
801 ;; (see bug#7487) making `epa-file-encrypt-to' local to
802 ;; this buffer lets epa-file skip the key selection query
803 ;; (see the `local-variable-p' check in
804 ;; `epa-file-write-region').
805 (unless (local-variable-p 'epa-file-encrypt-to (current-buffer))
806 (make-local-variable 'epa-file-encrypt-to))
807 (if (listp auth-source-gpg-encrypt-to)
808 (setq epa-file-encrypt-to auth-source-gpg-encrypt-to)))
810 ;; ask AFTER we've successfully opened the file
811 (when (y-or-n-p (format "Save file %s? (%d modifications)"
813 (write-region (point-min) (point-max) file nil 'silent)
814 (auth-source-do-debug
815 "auth-source-netrc-parse: modified %d lines in %s"
818 (nreverse result))))))
820 (defun auth-source-netrc-normalize (alist)
821 (mapcar (lambda (entry)
823 (while (setq item (pop entry))
828 (setq k (cond ((member k '("machine")) "host")
829 ((member k '("login" "account")) "user")
830 ((member k '("protocol")) "port")
831 ((member k '("password")) "secret")
834 ;; send back the secret in a function (lexical binding)
835 (when (equal k "secret")
836 (setq v (lexical-let ((v v))
839 (setq ret (plist-put ret
840 (intern (concat ":" k))
846 ;;; (setq secret (plist-get (nth 0 (auth-source-search :host t :type 'netrc :K 1 :max 1)) :secret))
849 (defun* auth-source-netrc-search (&rest
851 &key backend create delete
852 type max host user port
854 "Given a property list SPEC, return search matches from the :backend.
855 See `auth-source-search' for details on SPEC."
856 ;; just in case, check that the type is correct (null or same as the backend)
857 (assert (or (null type) (eq type (oref backend type)))
858 t "Invalid netrc search: %s %s")
860 (let ((results (auth-source-netrc-normalize
861 (auth-source-netrc-parse
864 :file (oref backend source)
867 :port (or port t)))))
869 ;; if we need to create an entry AND none were found to match
871 (= 0 (length results)))
873 ;; create based on the spec and record the value
875 ;; if the user did not want to create the entry
876 ;; in the file, it will be returned
877 (apply (slot-value backend 'create-function) spec)
878 ;; if not, we do the search again without :create
879 ;; to get the updated data.
881 ;; the result will be returned, even if the search fails
882 (apply 'auth-source-netrc-search
883 (plist-put spec :create nil)))))
886 ;;; (auth-source-search :host "nonesuch" :type 'netrc :max 1 :create t)
887 ;;; (auth-source-search :host "nonesuch" :type 'netrc :max 1 :create t :create-extra-keys '((A "default A") (B)))
889 (defun* auth-source-netrc-create (&rest spec
891 secret host user port create
893 (let* ((base-required '(host user port secret))
894 ;; we know (because of an assertion in auth-source-search) that the
895 ;; :create parameter is either t or a list (which includes nil)
896 (create-extra (if (eq t create) nil create))
897 (required (append base-required create-extra))
898 (file (oref backend source))
901 ;; `valist' is an alist
903 ;; `artificial' will be returned if no creation is needed
906 ;; only for base required elements (defined as function parameters):
907 ;; fill in the valist with whatever data we may have from the search
908 ;; we complete the first value if it's a list and use the value otherwise
909 (dolist (br base-required)
910 (when (symbol-value br)
911 (let ((br-choice (cond
912 ;; all-accepting choice (predicate is t)
913 ((eq t (symbol-value br)) nil)
914 ;; just the value otherwise
915 (t (symbol-value br)))))
917 (aput 'valist br br-choice)))))
919 ;; for extra required elements, see if the spec includes a value for them
920 (dolist (er create-extra)
921 (let ((name (concat ":" (symbol-name er)))
922 (keys (loop for i below (length spec) by 2
923 collect (nth i spec))))
925 (when (equal (symbol-name k) name)
926 (aput 'valist er (plist-get spec k))))))
928 ;; for each required element
930 (let* ((data (aget valist r))
931 (given-default (aget auth-source-creation-defaults r))
932 ;; the defaults are simple
934 ((and (not given-default) (eq r 'user))
936 ;; note we need this empty string
937 ((and (not given-default) (eq r 'port))
940 ;; the prompt's default string depends on the data so far
941 (default-string (if (and default (< 0 (length default)))
942 (format " (default %s)" default)
944 ;; the prompt should also show what's entered so far
945 (user-value (aget valist 'user))
946 (host-value (aget valist 'host))
947 (port-value (aget valist 'port))
948 ;; note this handles lists by just printing them
949 ;; later we allow the user to use completing-read to pick
950 (info-so-far (concat (if user-value
951 (format "%s@" user-value)
954 (format "%s" host-value)
957 ;; this distinguishes protocol between
958 (if (zerop (length port-value))
959 "" ; 'entered as "no default"' vs.
960 (format ":%s" port-value)) ; given
961 ;; and this is when the protocol is unknown
964 ;; now prompt if the search SPEC did not include a required key;
965 ;; take the result and put it in `data' AND store it in `valist'
969 ((and (null data) (eq r 'secret))
970 ;; special case prompt for passwords
971 (read-passwd (format "Password for %s: " info-so-far)))
974 (format "Enter %s for %s%s: "
975 r info-so-far default-string)
979 (format "Enter %s for %s (TAB to see the choices): "
984 ;; note the default is nil, but if the user
985 ;; hits RET we'll get "", which is handled OK later
990 (setq artificial (plist-put artificial
991 (intern (concat ":" (symbol-name r)))
993 (lexical-let ((data data))
997 ;; when r is not an empty string...
998 (when (and (stringp data)
1000 (let ((printer (lambda (hide)
1001 ;; append the key (the symbol name of r)
1002 ;; and the value in r
1005 (if (zerop (length add)) "" " ")
1006 ;; remap auth-source tokens to netrc
1010 ('secret "password")
1011 ('port "port") ; redundant but clearer
1012 (t (symbol-name r)))
1013 ;; the value will be printed in %S format
1014 (if (and hide (eq r 'secret))
1017 (setq add (concat add (funcall printer nil)))
1018 (setq show (concat show (funcall printer t)))))))
1021 (when (file-exists-p file)
1022 (insert-file-contents file))
1023 (when auth-source-gpg-encrypt-to
1024 ;; (see bug#7487) making `epa-file-encrypt-to' local to
1025 ;; this buffer lets epa-file skip the key selection query
1026 ;; (see the `local-variable-p' check in
1027 ;; `epa-file-write-region').
1028 (unless (local-variable-p 'epa-file-encrypt-to (current-buffer))
1029 (make-local-variable 'epa-file-encrypt-to))
1030 (if (listp auth-source-gpg-encrypt-to)
1031 (setq epa-file-encrypt-to auth-source-gpg-encrypt-to)))
1032 (goto-char (point-max))
1034 ;; ask AFTER we've successfully opened the file
1035 (if (y-or-n-p (format "Add to file %s: line [%s]" file show))
1040 (write-region (point-min) (point-max) file nil 'silent)
1041 (auth-source-do-debug
1042 "auth-source-netrc-create: wrote 1 new line to %s"
1045 (list artificial)))))
1047 ;;; Backend specific parsing: Secrets API backend
1049 ;;; (let ((auth-sources '(default))) (auth-source-search :max 1 :create t))
1050 ;;; (let ((auth-sources '(default))) (auth-source-search :max 1 :delete t))
1051 ;;; (let ((auth-sources '(default))) (auth-source-search :max 1))
1052 ;;; (let ((auth-sources '(default))) (auth-source-search))
1053 ;;; (let ((auth-sources '("secrets:Login"))) (auth-source-search :max 1))
1054 ;;; (let ((auth-sources '("secrets:Login"))) (auth-source-search :max 1 :signon_realm "https://git.gnus.org/Git"))
1056 (defun* auth-source-secrets-search (&rest
1058 &key backend create delete label
1059 type max host user port
1061 "Search the Secrets API; spec is like `auth-source'.
1063 The :label key specifies the item's label. It is the only key
1064 that can specify a substring. Any :label value besides a string
1065 will allow any label.
1067 All other search keys must match exactly. If you need substring
1068 matching, do a wider search and narrow it down yourself.
1070 You'll get back all the properties of the token as a plist.
1072 Here's an example that looks for the first item in the 'Login'
1075 \(let ((auth-sources '(\"secrets:Login\")))
1076 (auth-source-search :max 1)
1078 Here's another that looks for the first item in the 'Login'
1079 Secrets collection whose label contains 'gnus':
1081 \(let ((auth-sources '(\"secrets:Login\")))
1082 (auth-source-search :max 1 :label \"gnus\")
1084 And this one looks for the first item in the 'Login' Secrets
1085 collection that's a Google Chrome entry for the git.gnus.org site
1086 authentication tokens:
1088 \(let ((auth-sources '(\"secrets:Login\")))
1089 (auth-source-search :max 1 :signon_realm \"https://git.gnus.org/Git\"))
1093 (assert (not create) nil
1094 "The Secrets API auth-source backend doesn't support creation yet")
1096 ;; (secrets-delete-item coll elt)
1097 (assert (not delete) nil
1098 "The Secrets API auth-source backend doesn't support deletion yet")
1100 (let* ((coll (oref backend source))
1101 (max (or max 5000)) ; sanity check: default to stop at 5K
1102 (ignored-keys '(:create :delete :max :backend :label))
1103 (search-keys (loop for i below (length spec) by 2
1104 unless (memq (nth i spec) ignored-keys)
1105 collect (nth i spec)))
1106 ;; build a search spec without the ignored keys
1107 ;; if a search key is nil or t (match anything), we skip it
1108 (search-spec (apply 'append (mapcar
1110 (if (or (null (plist-get spec k))
1111 (eq t (plist-get spec k)))
1113 (list k (plist-get spec k))))
1115 ;; needed keys (always including host, login, port, and secret)
1116 (returned-keys (mm-delete-duplicates (append
1117 '(:host :login :port :secret)
1119 (items (loop for item in (apply 'secrets-search-items coll search-spec)
1120 unless (and (stringp label)
1121 (not (string-match label item)))
1123 ;; TODO: respect max in `secrets-search-items', not after the fact
1124 (items (butlast items (- (length items) max)))
1125 ;; convert the item name to a full plist
1126 (items (mapcar (lambda (item)
1128 ;; make an entry for the secret (password) element
1131 (lexical-let ((v (secrets-get-secret coll item)))
1133 ;; rewrite the entry from ((k1 v1) (k2 v2)) to plist
1135 (mapcar (lambda (entry)
1136 (list (car entry) (cdr entry)))
1137 (secrets-get-attributes coll item)))))
1139 ;; ensure each item has each key in `returned-keys'
1140 (items (mapcar (lambda (plist)
1143 (mapcar (lambda (req)
1144 (if (plist-get plist req)
1152 (defun* auth-source-secrets-create (&rest
1154 &key backend type max host user port
1157 ;; (apply 'secrets-create-item (auth-get-source entry) name passwd spec)
1162 ;;; (auth-source-user-or-password '("login" "password") "imap.myhost.com" t "tzz")
1164 ;; deprecate the old interface
1165 (make-obsolete 'auth-source-user-or-password
1166 'auth-source-search "Emacs 24.1")
1167 (make-obsolete 'auth-source-forget-user-or-password
1168 'auth-source-forget "Emacs 24.1")
1170 (defun auth-source-user-or-password
1171 (mode host port &optional username create-missing delete-existing)
1172 "Find MODE (string or list of strings) matching HOST and PORT.
1174 DEPRECATED in favor of `auth-source-search'!
1176 USERNAME is optional and will be used as \"login\" in a search
1177 across the Secret Service API (see secrets.el) if the resulting
1178 items don't have a username. This means that if you search for
1179 username \"joe\" and it matches an item but the item doesn't have
1180 a :user attribute, the username \"joe\" will be returned.
1182 A non nil DELETE-EXISTING means deleting any matching password
1183 entry in the respective sources. This is useful only when
1184 CREATE-MISSING is non nil as well; the intended use case is to
1185 remove wrong password entries.
1187 If no matching entry is found, and CREATE-MISSING is non nil,
1188 the password will be retrieved interactively, and it will be
1189 stored in the password database which matches best (see
1192 MODE can be \"login\" or \"password\"."
1193 (auth-source-do-debug
1194 "auth-source-user-or-password: DEPRECATED get %s for %s (%s) + user=%s"
1195 mode host port username)
1197 (let* ((listy (listp mode))
1198 (mode (if listy mode (list mode)))
1200 (format "%s %s:%s %s" mode host port username)
1201 (format "%s %s:%s" mode host port)))
1202 (search (list :host host :port port))
1203 (search (if username (append search (list :user username)) search))
1204 (search (if create-missing
1205 (append search (list :create t))
1207 (search (if delete-existing
1208 (append search (list :delete t))
1210 ;; (found (if (not delete-existing)
1211 ;; (gethash cname auth-source-cache)
1212 ;; (remhash cname auth-source-cache)
1217 (auth-source-do-debug
1218 "auth-source-user-or-password: DEPRECATED cached %s=%s for %s (%s) + %s"
1220 ;; don't show the password
1221 (if (and (member "password" mode) t)
1225 found) ; return the found data
1226 ;; else, if not found, search with a max of 1
1227 (let ((choice (nth 0 (apply 'auth-source-search
1228 (append '(:max 1) search)))))
1232 ((equal "password" m)
1233 (push (if (plist-get choice :secret)
1234 (funcall (plist-get choice :secret))
1237 (push (plist-get choice :user) found)))))
1238 (setq found (nreverse found))
1239 (setq found (if listy found (car-safe found)))))
1243 (provide 'auth-source)
1245 ;;; auth-source.el ends here