code.delx.au - gnu-emacs/blob - lisp/gnus/auth-source.el

   1 ;;; auth-source.el --- authentication sources for Gnus and Emacs
   2
   3 ;; Copyright (C) 2008-2012 Free Software Foundation, Inc.
   4
   5 ;; Author: Ted Zlatanov <tzz@lifelogs.com>
   6 ;; Keywords: news
   7
   8 ;; This file is part of GNU Emacs.
   9
  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.
  14
  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.
  19
  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/>.
  22
  23 ;;; Commentary:
  24
  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.
  29
  30 ;; See the auth.info Info documentation for details.
  31
  32 ;; TODO:
  33
  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
  39
  40 ;;; Code:
  41
  42 (require 'password-cache)
  43 (require 'mm-util)
  44 (require 'gnus-util)
  45
  46 (eval-when-compile (require 'cl))
  47 (require 'eieio)
  48
  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")
  56
  57 (autoload 'rfc2104-hash "rfc2104")
  58
  59 (autoload 'plstore-open "plstore")
  60 (autoload 'plstore-find "plstore")
  61 (autoload 'plstore-put "plstore")
  62 (autoload 'plstore-delete "plstore")
  63 (autoload 'plstore-save "plstore")
  64 (autoload 'plstore-get-file "plstore")
  65
  66 (autoload 'epg-make-context "epg")
  67 (autoload 'epg-context-set-passphrase-callback "epg")
  68 (autoload 'epg-decrypt-string "epg")
  69 (autoload 'epg-context-set-armor "epg")
  70 (autoload 'epg-encrypt-string "epg")
  71
  72 (autoload 'help-mode "help-mode" nil t)
  73
  74 (defvar secrets-enabled)
  75
  76 (defgroup auth-source nil
  77   "Authentication sources."
  78   :version "23.1" ;; No Gnus
  79   :group 'gnus)
  80
  81 ;;;###autoload
  82 (defcustom auth-source-cache-expiry 7200
  83   "How many seconds passwords are cached, or nil to disable
  84 expiring.  Overrides `password-cache-expiry' through a
  85 let-binding."
  86   :version "24.1"
  87   :group 'auth-source
  88   :type '(choice (const :tag "Never" nil)
  89                  (const :tag "All Day" 86400)
  90                  (const :tag "2 Hours" 7200)
  91                  (const :tag "30 Minutes" 1800)
  92                  (integer :tag "Seconds")))
  93
  94 ;; The slots below correspond with the `auth-source-search' spec,
  95 ;; so a backend with :host set, for instance, would match only
  96 ;; searches for that host.  Normally they are nil.
  97 (defclass auth-source-backend ()
  98   ((type :initarg :type
  99          :initform 'netrc
 100          :type symbol
 101          :custom symbol
 102          :documentation "The backend type.")
 103    (source :initarg :source
 104            :type string
 105            :custom string
 106            :documentation "The backend source.")
 107    (host :initarg :host
 108          :initform t
 109          :type t
 110          :custom string
 111          :documentation "The backend host.")
 112    (user :initarg :user
 113          :initform t
 114          :type t
 115          :custom string
 116          :documentation "The backend user.")
 117    (port :initarg :port
 118          :initform t
 119          :type t
 120          :custom string
 121          :documentation "The backend protocol.")
 122    (data :initarg :data
 123          :initform nil
 124          :documentation "Internal backend data.")
 125    (create-function :initarg :create-function
 126                     :initform ignore
 127                     :type function
 128                     :custom function
 129                     :documentation "The create function.")
 130    (search-function :initarg :search-function
 131                     :initform ignore
 132                     :type function
 133                     :custom function
 134                     :documentation "The search function.")))
 135
 136 (defcustom auth-source-protocols '((imap "imap" "imaps" "143" "993")
 137                                    (pop3 "pop3" "pop" "pop3s" "110" "995")
 138                                    (ssh  "ssh" "22")
 139                                    (sftp "sftp" "115")
 140                                    (smtp "smtp" "25"))
 141   "List of authentication protocols and their names"
 142
 143   :group 'auth-source
 144   :version "23.2" ;; No Gnus
 145   :type '(repeat :tag "Authentication Protocols"
 146                  (cons :tag "Protocol Entry"
 147                        (symbol :tag "Protocol")
 148                        (repeat :tag "Names"
 149                                (string :tag "Name")))))
 150
 151 ;; Generate all the protocols in a format Customize can use.
 152 ;; TODO: generate on the fly from auth-source-protocols
 153 (defconst auth-source-protocols-customize
 154   (mapcar (lambda (a)
 155             (let ((p (car-safe a)))
 156               (list 'const
 157                     :tag (upcase (symbol-name p))
 158                     p)))
 159           auth-source-protocols))
 160
 161 (defvar auth-source-creation-defaults nil
 162   "Defaults for creating token values.  Usually let-bound.")
 163
 164 (defvar auth-source-creation-prompts nil
 165   "Default prompts for token values.  Usually let-bound.")
 166
 167 (make-obsolete 'auth-source-hide-passwords nil "Emacs 24.1")
 168
 169 (defcustom auth-source-save-behavior 'ask
 170   "If set, auth-source will respect it for save behavior."
 171   :group 'auth-source
 172   :version "23.2" ;; No Gnus
 173   :type `(choice
 174           :tag "auth-source new token save behavior"
 175           (const :tag "Always save" t)
 176           (const :tag "Never save" nil)
 177           (const :tag "Ask" ask)))
 178
 179 ;; 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)))
 180 ;; TODO: or maybe leave as (setq auth-source-netrc-use-gpg-tokens 'never)
 181
 182 (defcustom auth-source-netrc-use-gpg-tokens 'never
 183   "Set this to tell auth-source when to create GPG password
 184 tokens in netrc files.  It's either an alist or `never'.
 185 Note that if EPA/EPG is not available, this should NOT be used."
 186   :group 'auth-source
 187   :version "23.2" ;; No Gnus
 188   :type `(choice
 189           (const :tag "Always use GPG password tokens" (t gpg))
 190           (const :tag "Never use GPG password tokens" never)
 191           (repeat :tag "Use a lookup list"
 192                   (list
 193                    (choice :tag "Matcher"
 194                            (const :tag "Match anything" t)
 195                            (const :tag "The EPA encrypted file extensions"
 196                                   ,(if (boundp 'epa-file-auto-mode-alist-entry)
 197                                        (car (symbol-value
 198                                              'epa-file-auto-mode-alist-entry))
 199                                      "\\.gpg\\'"))
 200                            (regexp :tag "Regular expression"))
 201                    (choice :tag "What to do"
 202                            (const :tag "Save GPG-encrypted password tokens" gpg)
 203                            (const :tag "Don't encrypt tokens" never))))))
 204
 205 (defvar auth-source-magic "auth-source-magic ")
 206
 207 (defcustom auth-source-do-cache t
 208   "Whether auth-source should cache information with `password-cache'."
 209   :group 'auth-source
 210   :version "23.2" ;; No Gnus
 211   :type `boolean)
 212
 213 (defcustom auth-source-debug nil
 214   "Whether auth-source should log debug messages.
 215
 216 If the value is nil, debug messages are not logged.
 217
 218 If the value is t, debug messages are logged with `message'.  In
 219 that case, your authentication data will be in the clear (except
 220 for passwords).
 221
 222 If the value is a function, debug messages are logged by calling
 223  that function using the same arguments as `message'."
 224   :group 'auth-source
 225   :version "23.2" ;; No Gnus
 226   :type `(choice
 227           :tag "auth-source debugging mode"
 228           (const :tag "Log using `message' to the *Messages* buffer" t)
 229           (const :tag "Log all trivia with `message' to the *Messages* buffer"
 230                  trivia)
 231           (function :tag "Function that takes arguments like `message'")
 232           (const :tag "Don't log anything" nil)))
 233
 234 (defcustom auth-sources '("~/.authinfo" "~/.authinfo.gpg" "~/.netrc")
 235   "List of authentication sources.
 236
 237 The default will get login and password information from
 238 \"~/.authinfo.gpg\", which you should set up with the EPA/EPG
 239 packages to be encrypted.  If that file doesn't exist, it will
 240 try the unencrypted version \"~/.authinfo\" and the famous
 241 \"~/.netrc\" file.
 242
 243 See the auth.info manual for details.
 244
 245 Each entry is the authentication type with optional properties.
 246
 247 It's best to customize this with `M-x customize-variable' because the choices
 248 can get pretty complex."
 249   :group 'auth-source
 250   :version "24.1" ;; No Gnus
 251   :type `(repeat :tag "Authentication Sources"
 252                  (choice
 253                   (string :tag "Just a file")
 254                   (const :tag "Default Secrets API Collection" 'default)
 255                   (const :tag "Login Secrets API Collection" "secrets:Login")
 256                   (const :tag "Temp Secrets API Collection" "secrets:session")
 257                   (list :tag "Source definition"
 258                         (const :format "" :value :source)
 259                         (choice :tag "Authentication backend choice"
 260                                 (string :tag "Authentication Source (file)")
 261                                 (list
 262                                  :tag "Secret Service API/KWallet/GNOME Keyring"
 263                                  (const :format "" :value :secrets)
 264                                  (choice :tag "Collection to use"
 265                                          (string :tag "Collection name")
 266                                          (const :tag "Default" 'default)
 267                                          (const :tag "Login" "Login")
 268                                          (const
 269                                           :tag "Temporary" "session"))))
 270                         (repeat :tag "Extra Parameters" :inline t
 271                                 (choice :tag "Extra parameter"
 272                                         (list
 273                                          :tag "Host"
 274                                          (const :format "" :value :host)
 275                                          (choice :tag "Host (machine) choice"
 276                                                  (const :tag "Any" t)
 277                                                  (regexp
 278                                                   :tag "Regular expression")))
 279                                         (list
 280                                          :tag "Protocol"
 281                                          (const :format "" :value :port)
 282                                          (choice
 283                                           :tag "Protocol"
 284                                           (const :tag "Any" t)
 285                                           ,@auth-source-protocols-customize))
 286                                         (list :tag "User" :inline t
 287                                               (const :format "" :value :user)
 288                                               (choice
 289                                                :tag "Personality/Username"
 290                                                (const :tag "Any" t)
 291                                                (string
 292                                                 :tag "Name")))))))))
 293
 294 (defcustom auth-source-gpg-encrypt-to t
 295   "List of recipient keys that `authinfo.gpg' encrypted to.
 296 If the value is not a list, symmetric encryption will be used."
 297   :group 'auth-source
 298   :version "24.1" ;; No Gnus
 299   :type '(choice (const :tag "Symmetric encryption" t)
 300                  (repeat :tag "Recipient public keys"
 301                          (string :tag "Recipient public key"))))
 302
 303 ;; temp for debugging
 304 ;; (unintern 'auth-source-protocols)
 305 ;; (unintern 'auth-sources)
 306 ;; (customize-variable 'auth-sources)
 307 ;; (setq auth-sources nil)
 308 ;; (format "%S" auth-sources)
 309 ;; (customize-variable 'auth-source-protocols)
 310 ;; (setq auth-source-protocols nil)
 311 ;; (format "%S" auth-source-protocols)
 312 ;; (auth-source-pick nil :host "a" :port 'imap)
 313 ;; (auth-source-user-or-password "login" "imap.myhost.com" 'imap)
 314 ;; (auth-source-user-or-password "password" "imap.myhost.com" 'imap)
 315 ;; (auth-source-user-or-password-imap "login" "imap.myhost.com")
 316 ;; (auth-source-user-or-password-imap "password" "imap.myhost.com")
 317 ;; (auth-source-protocol-defaults 'imap)
 318
 319 ;; (let ((auth-source-debug 'debug)) (auth-source-do-debug "hello"))
 320 ;; (let ((auth-source-debug t)) (auth-source-do-debug "hello"))
 321 ;; (let ((auth-source-debug nil)) (auth-source-do-debug "hello"))
 322 (defun auth-source-do-debug (&rest msg)
 323   (when auth-source-debug
 324     (apply 'auth-source-do-warn msg)))
 325
 326 (defun auth-source-do-trivia (&rest msg)
 327   (when (or (eq auth-source-debug 'trivia)
 328             (functionp auth-source-debug))
 329     (apply 'auth-source-do-warn msg)))
 330
 331 (defun auth-source-do-warn (&rest msg)
 332   (apply
 333    ;; set logger to either the function in auth-source-debug or 'message
 334    ;; note that it will be 'message if auth-source-debug is nil
 335    (if (functionp auth-source-debug)
 336        auth-source-debug
 337      'message)
 338    msg))
 339
 340
 341 ;; (auth-source-read-char-choice "enter choice? " '(?a ?b ?q))
 342 (defun auth-source-read-char-choice (prompt choices)
 343   "Read one of CHOICES by `read-char-choice', or `read-char'.
 344 `dropdown-list' support is disabled because it doesn't work reliably.
 345 Only one of CHOICES will be returned.  The PROMPT is augmented
 346 with \"[a/b/c] \" if CHOICES is '\(?a ?b ?c\)."
 347   (when choices
 348     (let* ((prompt-choices
 349             (apply 'concat (loop for c in choices
 350                                  collect (format "%c/" c))))
 351            (prompt-choices (concat "[" (substring prompt-choices 0 -1) "] "))
 352            (full-prompt (concat prompt prompt-choices))
 353            k)
 354
 355       (while (not (memq k choices))
 356         (setq k (cond
 357                  ((fboundp 'read-char-choice)
 358                   (read-char-choice full-prompt choices))
 359                  (t (message "%s" full-prompt)
 360                     (setq k (read-char))))))
 361       k)))
 362
 363 ;; (auth-source-pick nil :host "any" :port 'imap :user "joe")
 364 ;; (auth-source-pick t :host "any" :port 'imap :user "joe")
 365 ;; (setq auth-sources '((:source (:secrets default) :host t :port t :user "joe")
 366 ;;                   (:source (:secrets "session") :host t :port t :user "joe")
 367 ;;                   (:source (:secrets "Login") :host t :port t)
 368 ;;                   (:source "~/.authinfo.gpg" :host t :port t)))
 369
 370 ;; (setq auth-sources '((:source (:secrets default) :host t :port t :user "joe")
 371 ;;                   (:source (:secrets "session") :host t :port t :user "joe")
 372 ;;                   (:source (:secrets "Login") :host t :port t)
 373 ;;                   ))
 374
 375 ;; (setq auth-sources '((:source "~/.authinfo.gpg" :host t :port t)))
 376
 377 ;; (auth-source-backend-parse "myfile.gpg")
 378 ;; (auth-source-backend-parse 'default)
 379 ;; (auth-source-backend-parse "secrets:Login")
 380
 381 (defun auth-source-backend-parse (entry)
 382   "Creates an auth-source-backend from an ENTRY in `auth-sources'."
 383   (auth-source-backend-parse-parameters
 384    entry
 385    (cond
 386     ;; take 'default and recurse to get it as a Secrets API default collection
 387     ;; matching any user, host, and protocol
 388     ((eq entry 'default)
 389      (auth-source-backend-parse '(:source (:secrets default))))
 390     ;; take secrets:XYZ and recurse to get it as Secrets API collection "XYZ"
 391     ;; matching any user, host, and protocol
 392     ((and (stringp entry) (string-match "^secrets:\\(.+\\)" entry))
 393      (auth-source-backend-parse `(:source (:secrets ,(match-string 1 entry)))))
 394     ;; take just a file name and recurse to get it as a netrc file
 395     ;; matching any user, host, and protocol
 396     ((stringp entry)
 397      (auth-source-backend-parse `(:source ,entry)))
 398
 399     ;; a file name with parameters
 400     ((stringp (plist-get entry :source))
 401      (if (equal (file-name-extension (plist-get entry :source)) "plist")
 402          (auth-source-backend
 403           (plist-get entry :source)
 404           :source (plist-get entry :source)
 405           :type 'plstore
 406           :search-function 'auth-source-plstore-search
 407           :create-function 'auth-source-plstore-create
 408           :data (plstore-open (plist-get entry :source)))
 409        (auth-source-backend
 410         (plist-get entry :source)
 411         :source (plist-get entry :source)
 412         :type 'netrc
 413         :search-function 'auth-source-netrc-search
 414         :create-function 'auth-source-netrc-create)))
 415
 416     ;; the Secrets API.  We require the package, in order to have a
 417     ;; defined value for `secrets-enabled'.
 418     ((and
 419       (not (null (plist-get entry :source))) ; the source must not be nil
 420       (listp (plist-get entry :source))      ; and it must be a list
 421       (require 'secrets nil t)               ; and we must load the Secrets API
 422       secrets-enabled)                       ; and that API must be enabled
 423
 424      ;; the source is either the :secrets key in ENTRY or
 425      ;; if that's missing or nil, it's "session"
 426      (let ((source (or (plist-get (plist-get entry :source) :secrets)
 427                        "session")))
 428
 429        ;; if the source is a symbol, we look for the alias named so,
 430        ;; and if that alias is missing, we use "Login"
 431        (when (symbolp source)
 432          (setq source (or (secrets-get-alias (symbol-name source))
 433                           "Login")))
 434
 435        (if (featurep 'secrets)
 436            (auth-source-backend
 437             (format "Secrets API (%s)" source)
 438             :source source
 439             :type 'secrets
 440             :search-function 'auth-source-secrets-search
 441             :create-function 'auth-source-secrets-create)
 442          (auth-source-do-warn
 443           "auth-source-backend-parse: no Secrets API, ignoring spec: %S" entry)
 444          (auth-source-backend
 445           (format "Ignored Secrets API (%s)" source)
 446           :source ""
 447           :type 'ignore))))
 448
 449     ;; none of them
 450     (t
 451      (auth-source-do-warn
 452       "auth-source-backend-parse: invalid backend spec: %S" entry)
 453      (auth-source-backend
 454       "Empty"
 455       :source ""
 456       :type 'ignore)))))
 457
 458 (defun auth-source-backend-parse-parameters (entry backend)
 459   "Fills in the extra auth-source-backend parameters of ENTRY.
 460 Using the plist ENTRY, get the :host, :port, and :user search
 461 parameters."
 462   (let ((entry (if (stringp entry)
 463                    nil
 464                  entry))
 465         val)
 466     (when (setq val (plist-get entry :host))
 467       (oset backend host val))
 468     (when (setq val (plist-get entry :user))
 469       (oset backend user val))
 470     (when (setq val (plist-get entry :port))
 471       (oset backend port val)))
 472   backend)
 473
 474 ;; (mapcar 'auth-source-backend-parse auth-sources)
 475
 476 (defun* auth-source-search (&rest spec
 477                                   &key type max host user port secret
 478                                   require create delete
 479                                   &allow-other-keys)
 480   "Search or modify authentication backends according to SPEC.
 481
 482 This function parses `auth-sources' for matches of the SPEC
 483 plist.  It can optionally create or update an authentication
 484 token if requested.  A token is just a standard Emacs property
 485 list with a :secret property that can be a function; all the
 486 other properties will always hold scalar values.
 487
 488 Typically the :secret property, if present, contains a password.
 489
 490 Common search keys are :max, :host, :port, and :user.  In
 491 addition, :create specifies how tokens will be or created.
 492 Finally, :type can specify which backend types you want to check.
 493
 494 A string value is always matched literally.  A symbol is matched
 495 as its string value, literally.  All the SPEC values can be
 496 single values (symbol or string) or lists thereof (in which case
 497 any of the search terms matches).
 498
 499 :create t means to create a token if possible.
 500
 501 A new token will be created if no matching tokens were found.
 502 The new token will have only the keys the backend requires.  For
 503 the netrc backend, for instance, that's the user, host, and
 504 port keys.
 505
 506 Here's an example:
 507
 508 \(let ((auth-source-creation-defaults '((user . \"defaultUser\")
 509                                         (A    . \"default A\"))))
 510   (auth-source-search :host \"mine\" :type 'netrc :max 1
 511                       :P \"pppp\" :Q \"qqqq\"
 512                       :create t))
 513
 514 which says:
 515
 516 \"Search for any entry matching host 'mine' in backends of type
 517  'netrc', maximum one result.
 518
 519  Create a new entry if you found none.  The netrc backend will
 520  automatically require host, user, and port.  The host will be
 521  'mine'.  We prompt for the user with default 'defaultUser' and
 522  for the port without a default.  We will not prompt for A, Q,
 523  or P.  The resulting token will only have keys user, host, and
 524  port.\"
 525
 526 :create '(A B C) also means to create a token if possible.
 527
 528 The behavior is like :create t but if the list contains any
 529 parameter, that parameter will be required in the resulting
 530 token.  The value for that parameter will be obtained from the
 531 search parameters or from user input.  If any queries are needed,
 532 the alist `auth-source-creation-defaults' will be checked for the
 533 default value.  If the user, host, or port are missing, the alist
 534 `auth-source-creation-prompts' will be used to look up the
 535 prompts IN THAT ORDER (so the 'user prompt will be queried first,
 536 then 'host, then 'port, and finally 'secret).  Each prompt string
 537 can use %u, %h, and %p to show the user, host, and port.
 538
 539 Here's an example:
 540
 541 \(let ((auth-source-creation-defaults '((user . \"defaultUser\")
 542                                         (A    . \"default A\")))
 543        (auth-source-creation-prompts
 544         '((password . \"Enter IMAP password for %h:%p: \"))))
 545   (auth-source-search :host '(\"nonesuch\" \"twosuch\") :type 'netrc :max 1
 546                       :P \"pppp\" :Q \"qqqq\"
 547                       :create '(A B Q)))
 548
 549 which says:
 550
 551 \"Search for any entry matching host 'nonesuch'
 552  or 'twosuch' in backends of type 'netrc', maximum one result.
 553
 554  Create a new entry if you found none.  The netrc backend will
 555  automatically require host, user, and port.  The host will be
 556  'nonesuch' and Q will be 'qqqq'.  We prompt for the password
 557  with the shown prompt.  We will not prompt for Q.  The resulting
 558  token will have keys user, host, port, A, B, and Q.  It will not
 559  have P with any value, even though P is used in the search to
 560  find only entries that have P set to 'pppp'.\"
 561
 562 When multiple values are specified in the search parameter, the
 563 user is prompted for which one.  So :host (X Y Z) would ask the
 564 user to choose between X, Y, and Z.
 565
 566 This creation can fail if the search was not specific enough to
 567 create a new token (it's up to the backend to decide that).  You
 568 should `catch' the backend-specific error as usual.  Some
 569 backends (netrc, at least) will prompt the user rather than throw
 570 an error.
 571
 572 :require (A B C) means that only results that contain those
 573 tokens will be returned.  Thus for instance requiring :secret
 574 will ensure that any results will actually have a :secret
 575 property.
 576
 577 :delete t means to delete any found entries.  nil by default.
 578 Use `auth-source-delete' in ELisp code instead of calling
 579 `auth-source-search' directly with this parameter.
 580
 581 :type (X Y Z) will check only those backend types.  'netrc and
 582 'secrets are the only ones supported right now.
 583
 584 :max N means to try to return at most N items (defaults to 1).
 585 When 0 the function will return just t or nil to indicate if any
 586 matches were found.  More than N items may be returned, depending
 587 on the search and the backend.
 588
 589 :host (X Y Z) means to match only hosts X, Y, or Z according to
 590 the match rules above.  Defaults to t.
 591
 592 :user (X Y Z) means to match only users X, Y, or Z according to
 593 the match rules above.  Defaults to t.
 594
 595 :port (P Q R) means to match only protocols P, Q, or R.
 596 Defaults to t.
 597
 598 :K (V1 V2 V3) for any other key K will match values V1, V2, or
 599 V3 (note the match rules above).
 600
 601 The return value is a list with at most :max tokens.  Each token
 602 is a plist with keys :backend :host :port :user, plus any other
 603 keys provided by the backend (notably :secret).  But note the
 604 exception for :max 0, which see above.
 605
 606 The token can hold a :save-function key.  If you call that, the
 607 user will be prompted to save the data to the backend.  You can't
 608 request that this should happen right after creation, because
 609 `auth-source-search' has no way of knowing if the token is
 610 actually useful.  So the caller must arrange to call this function.
 611
 612 The token's :secret key can hold a function.  In that case you
 613 must call it to obtain the actual value."
 614   (let* ((backends (mapcar 'auth-source-backend-parse auth-sources))
 615          (max (or max 1))
 616          (ignored-keys '(:require :create :delete :max))
 617          (keys (loop for i below (length spec) by 2
 618                      unless (memq (nth i spec) ignored-keys)
 619                      collect (nth i spec)))
 620          (cached (auth-source-remembered-p spec))
 621          ;; note that we may have cached results but found is still nil
 622          ;; (there were no results from the search)
 623          (found (auth-source-recall spec))
 624          filtered-backends accessor-key backend)
 625
 626     (if (and cached auth-source-do-cache)
 627         (auth-source-do-debug
 628          "auth-source-search: found %d CACHED results matching %S"
 629          (length found) spec)
 630
 631       (assert
 632        (or (eq t create) (listp create)) t
 633        "Invalid auth-source :create parameter (must be t or a list): %s %s")
 634
 635       (assert
 636        (listp require) t
 637        "Invalid auth-source :require parameter (must be a list): %s")
 638
 639       (setq filtered-backends (copy-sequence backends))
 640       (dolist (backend backends)
 641         (dolist (key keys)
 642           ;; ignore invalid slots
 643           (condition-case signal
 644               (unless (eval `(auth-source-search-collection
 645                               (plist-get spec key)
 646                               (oref backend ,key)))
 647                 (setq filtered-backends (delq backend filtered-backends))
 648                 (return))
 649             (invalid-slot-name))))
 650
 651       (auth-source-do-trivia
 652        "auth-source-search: found %d backends matching %S"
 653        (length filtered-backends) spec)
 654
 655       ;; (debug spec "filtered" filtered-backends)
 656       ;; First go through all the backends without :create, so we can
 657       ;; query them all.
 658       (setq found (auth-source-search-backends filtered-backends
 659                                                spec
 660                                                ;; to exit early
 661                                                max
 662                                                ;; create is always nil here
 663                                                nil delete
 664                                                require))
 665
 666       (auth-source-do-debug
 667        "auth-source-search: found %d results (max %d) matching %S"
 668        (length found) max spec)
 669
 670       ;; If we didn't find anything, then we allow the backend(s) to
 671       ;; create the entries.
 672       (when (and create
 673                  (not found))
 674         (setq found (auth-source-search-backends filtered-backends
 675                                                  spec
 676                                                  ;; to exit early
 677                                                  max
 678                                                  create delete
 679                                                  require))
 680         (auth-source-do-debug
 681          "auth-source-search: CREATED %d results (max %d) matching %S"
 682          (length found) max spec))
 683
 684       ;; note we remember the lack of result too, if it's applicable
 685       (when auth-source-do-cache
 686         (auth-source-remember spec found)))
 687
 688     found))
 689
 690 (defun auth-source-search-backends (backends spec max create delete require)
 691   (let (matches)
 692     (dolist (backend backends)
 693       (when (> max (length matches))   ; when we need more matches...
 694         (let* ((bmatches (apply
 695                           (slot-value backend 'search-function)
 696                           :backend backend
 697                           ;; note we're overriding whatever the spec
 698                           ;; has for :require, :create, and :delete
 699                           :require require
 700                           :create create
 701                           :delete delete
 702                           spec)))
 703           (when bmatches
 704             (auth-source-do-trivia
 705              "auth-source-search-backend: got %d (max %d) in %s:%s matching %S"
 706              (length bmatches) max
 707              (slot-value backend :type)
 708              (slot-value backend :source)
 709              spec)
 710             (setq matches (append matches bmatches))))))
 711     matches))
 712
 713 ;; (auth-source-search :max 1)
 714 ;; (funcall (plist-get (nth 0 (auth-source-search :max 1)) :secret))
 715 ;; (auth-source-search :host "nonesuch" :type 'netrc :K 1)
 716 ;; (auth-source-search :host "nonesuch" :type 'secrets)
 717
 718 (defun* auth-source-delete (&rest spec
 719                                   &key delete
 720                                   &allow-other-keys)
 721   "Delete entries from the authentication backends according to SPEC.
 722 Calls `auth-source-search' with the :delete property in SPEC set to t.
 723 The backend may not actually delete the entries.
 724
 725 Returns the deleted entries."
 726   (auth-source-search (plist-put spec :delete t)))
 727
 728 (defun auth-source-search-collection (collection value)
 729   "Returns t is VALUE is t or COLLECTION is t or contains VALUE."
 730   (when (and (atom collection) (not (eq t collection)))
 731     (setq collection (list collection)))
 732
 733   ;; (debug :collection collection :value value)
 734   (or (eq collection t)
 735       (eq value t)
 736       (equal collection value)
 737       (member value collection)))
 738
 739 (defvar auth-source-netrc-cache nil)
 740
 741 (defun auth-source-forget-all-cached ()
 742   "Forget all cached auth-source data."
 743   (interactive)
 744   (loop for sym being the symbols of password-data
 745         ;; when the symbol name starts with auth-source-magic
 746         when (string-match (concat "^" auth-source-magic)
 747                            (symbol-name sym))
 748         ;; remove that key
 749         do (password-cache-remove (symbol-name sym)))
 750   (setq auth-source-netrc-cache nil))
 751
 752 (defun auth-source-format-cache-entry (spec)
 753   "Format SPEC entry to put it in the password cache."
 754   (concat auth-source-magic (format "%S" spec)))
 755
 756 (defun auth-source-remember (spec found)
 757   "Remember FOUND search results for SPEC."
 758   (let ((password-cache-expiry auth-source-cache-expiry))
 759     (password-cache-add
 760      (auth-source-format-cache-entry spec) found)))
 761
 762 (defun auth-source-recall (spec)
 763   "Recall FOUND search results for SPEC."
 764   (password-read-from-cache (auth-source-format-cache-entry spec)))
 765
 766 (defun auth-source-remembered-p (spec)
 767   "Check if SPEC is remembered."
 768   (password-in-cache-p
 769    (auth-source-format-cache-entry spec)))
 770
 771 (defun auth-source-forget (spec)
 772   "Forget any cached data matching SPEC exactly.
 773
 774 This is the same SPEC you passed to `auth-source-search'.
 775 Returns t or nil for forgotten or not found."
 776   (password-cache-remove (auth-source-format-cache-entry spec)))
 777
 778 ;; (loop for sym being the symbols of password-data when (string-match (concat "^" auth-source-magic) (symbol-name sym)) collect (symbol-name sym))
 779
 780 ;; (auth-source-remember '(:host "wedd") '(4 5 6))
 781 ;; (auth-source-remembered-p '(:host "wedd"))
 782 ;; (auth-source-remember '(:host "xedd") '(1 2 3))
 783 ;; (auth-source-remembered-p '(:host "xedd"))
 784 ;; (auth-source-remembered-p '(:host "zedd"))
 785 ;; (auth-source-recall '(:host "xedd"))
 786 ;; (auth-source-recall '(:host t))
 787 ;; (auth-source-forget+ :host t)
 788
 789 (defun* auth-source-forget+ (&rest spec &allow-other-keys)
 790   "Forget any cached data matching SPEC.  Returns forgotten count.
 791
 792 This is not a full `auth-source-search' spec but works similarly.
 793 For instance, \(:host \"myhost\" \"yourhost\") would find all the
 794 cached data that was found with a search for those two hosts,
 795 while \(:host t) would find all host entries."
 796   (let ((count 0)
 797         sname)
 798     (loop for sym being the symbols of password-data
 799           ;; when the symbol name matches with auth-source-magic
 800           when (and (setq sname (symbol-name sym))
 801                     (string-match (concat "^" auth-source-magic "\\(.+\\)")
 802                                   sname)
 803                     ;; and the spec matches what was stored in the cache
 804                     (auth-source-specmatchp spec (read (match-string 1 sname))))
 805           ;; remove that key
 806           do (progn
 807                (password-cache-remove sname)
 808                (incf count)))
 809     count))
 810
 811 (defun auth-source-specmatchp (spec stored)
 812   (let ((keys (loop for i below (length spec) by 2
 813                     collect (nth i spec))))
 814     (not (eq
 815           (dolist (key keys)
 816             (unless (auth-source-search-collection (plist-get stored key)
 817                                                    (plist-get spec key))
 818               (return 'no)))
 819           'no))))
 820
 821 ;; (auth-source-pick-first-password :host "z.lifelogs.com")
 822 ;; (auth-source-pick-first-password :port "imap")
 823 (defun auth-source-pick-first-password (&rest spec)
 824   "Pick the first secret found from applying SPEC to `auth-source-search'."
 825   (let* ((result (nth 0 (apply 'auth-source-search (plist-put spec :max 1))))
 826          (secret (plist-get result :secret)))
 827
 828     (if (functionp secret)
 829         (funcall secret)
 830       secret)))
 831
 832 ;; (auth-source-format-prompt "test %u %h %p" '((?u "user") (?h "host")))
 833 (defun auth-source-format-prompt (prompt alist)
 834   "Format PROMPT using %x (for any character x) specifiers in ALIST."
 835   (dolist (cell alist)
 836     (let ((c (nth 0 cell))
 837           (v (nth 1 cell)))
 838       (when (and c v)
 839         (setq prompt (replace-regexp-in-string (format "%%%c" c)
 840                                                (format "%s" v)
 841                                                prompt)))))
 842   prompt)
 843
 844 (defun auth-source-ensure-strings (values)
 845   (unless (listp values)
 846     (setq values (list values)))
 847   (mapcar (lambda (value)
 848             (if (numberp value)
 849                 (format "%s" value)
 850               value))
 851           values))
 852
 853 ;;; Backend specific parsing: netrc/authinfo backend
 854
 855 (defun auth-source--aput-1 (alist key val)
 856   (let ((seen ())
 857         (rest alist))
 858     (while (and (consp rest) (not (equal key (caar rest))))
 859       (push (pop rest) seen))
 860     (cons (cons key val)
 861           (if (null rest) alist
 862             (nconc (nreverse seen)
 863                    (if (equal key (caar rest)) (cdr rest) rest))))))
 864 (defmacro auth-source--aput (var key val)
 865   `(setq ,var (auth-source--aput-1 ,var ,key ,val)))
 866
 867 (defun auth-source--aget (alist key)
 868   (cdr (assoc key alist)))
 869
 870 ;; (auth-source-netrc-parse "~/.authinfo.gpg")
 871 (defun* auth-source-netrc-parse (&rest
 872                                  spec
 873                                  &key file max host user port delete require
 874                                  &allow-other-keys)
 875   "Parse FILE and return a list of all entries in the file.
 876 Note that the MAX parameter is used so we can exit the parse early."
 877   (if (listp file)
 878       ;; We got already parsed contents; just return it.
 879       file
 880     (when (file-exists-p file)
 881       (setq port (auth-source-ensure-strings port))
 882       (with-temp-buffer
 883         (let* ((tokens '("machine" "host" "default" "login" "user"
 884                          "password" "account" "macdef" "force"
 885                          "port" "protocol"))
 886                (max (or max 5000))       ; sanity check: default to stop at 5K
 887                (modified 0)
 888                (cached (cdr-safe (assoc file auth-source-netrc-cache)))
 889                (cached-mtime (plist-get cached :mtime))
 890                (cached-secrets (plist-get cached :secret))
 891                alist elem result pair)
 892
 893           (if (and (functionp cached-secrets)
 894                    (equal cached-mtime
 895                           (nth 5 (file-attributes file))))
 896               (progn
 897                 (auth-source-do-trivia
 898                  "auth-source-netrc-parse: using CACHED file data for %s"
 899                  file)
 900                 (insert (funcall cached-secrets)))
 901             (insert-file-contents file)
 902             ;; cache all netrc files (used to be just .gpg files)
 903             ;; Store the contents of the file heavily encrypted in memory.
 904             ;; (note for the irony-impaired: they are just obfuscated)
 905             (auth-source--aput
 906              auth-source-netrc-cache file
 907              (list :mtime (nth 5 (file-attributes file))
 908                    :secret (lexical-let ((v (mapcar '1+ (buffer-string))))
 909                              (lambda () (apply 'string (mapcar '1- v)))))))
 910           (goto-char (point-min))
 911           ;; Go through the file, line by line.
 912           (while (and (not (eobp))
 913                       (> max 0))
 914
 915             (narrow-to-region (point) (point-at-eol))
 916             ;; For each line, get the tokens and values.
 917             (while (not (eobp))
 918               (skip-chars-forward "\t ")
 919               ;; Skip lines that begin with a "#".
 920               (if (eq (char-after) ?#)
 921                   (goto-char (point-max))
 922                 (unless (eobp)
 923                   (setq elem
 924                         (if (= (following-char) ?\")
 925                             (read (current-buffer))
 926                           (buffer-substring
 927                            (point) (progn (skip-chars-forward "^\t ")
 928                                           (point)))))
 929                   (cond
 930                    ((equal elem "macdef")
 931                     ;; We skip past the macro definition.
 932                     (widen)
 933                     (while (and (zerop (forward-line 1))
 934                                 (looking-at "$")))
 935                     (narrow-to-region (point) (point)))
 936                    ((member elem tokens)
 937                     ;; Tokens that don't have a following value are ignored,
 938                     ;; except "default".
 939                     (when (and pair (or (cdr pair)
 940                                         (equal (car pair) "default")))
 941                       (push pair alist))
 942                     (setq pair (list elem)))
 943                    (t
 944                     ;; Values that haven't got a preceding token are ignored.
 945                     (when pair
 946                       (setcdr pair elem)
 947                       (push pair alist)
 948                       (setq pair nil)))))))
 949
 950             (when (and alist
 951                        (> max 0)
 952                        (auth-source-search-collection
 953                         host
 954                         (or
 955                          (auth-source--aget alist "machine")
 956                          (auth-source--aget alist "host")
 957                          t))
 958                        (auth-source-search-collection
 959                         user
 960                         (or
 961                          (auth-source--aget alist "login")
 962                          (auth-source--aget alist "account")
 963                          (auth-source--aget alist "user")
 964                          t))
 965                        (auth-source-search-collection
 966                         port
 967                         (or
 968                          (auth-source--aget alist "port")
 969                          (auth-source--aget alist "protocol")
 970                          t))
 971                        (or
 972                         ;; the required list of keys is nil, or
 973                         (null require)
 974                         ;; every element of require is in the normalized list
 975                         (let ((normalized (nth 0 (auth-source-netrc-normalize
 976                                                   (list alist) file))))
 977                           (loop for req in require
 978                                 always (plist-get normalized req)))))
 979               (decf max)
 980               (push (nreverse alist) result)
 981               ;; to delete a line, we just comment it out
 982               (when delete
 983                 (goto-char (point-min))
 984                 (insert "#")
 985                 (incf modified)))
 986             (setq alist nil
 987                   pair nil)
 988             (widen)
 989             (forward-line 1))
 990
 991           (when (< 0 modified)
 992             (when auth-source-gpg-encrypt-to
 993               ;; (see bug#7487) making `epa-file-encrypt-to' local to
 994               ;; this buffer lets epa-file skip the key selection query
 995               ;; (see the `local-variable-p' check in
 996               ;; `epa-file-write-region').
 997               (unless (local-variable-p 'epa-file-encrypt-to (current-buffer))
 998                 (make-local-variable 'epa-file-encrypt-to))
 999               (if (listp auth-source-gpg-encrypt-to)
1000                   (setq epa-file-encrypt-to auth-source-gpg-encrypt-to)))
1001
1002             ;; ask AFTER we've successfully opened the file
1003             (when (y-or-n-p (format "Save file %s? (%d deletions)"
1004                                     file modified))
1005               (write-region (point-min) (point-max) file nil 'silent)
1006               (auth-source-do-debug
1007                "auth-source-netrc-parse: modified %d lines in %s"
1008                modified file)))
1009
1010           (nreverse result))))))
1011
1012 (defvar auth-source-passphrase-alist nil)
1013
1014 (defun auth-source-token-passphrase-callback-function (context key-id file)
1015   (let* ((file (file-truename file))
1016          (entry (assoc file auth-source-passphrase-alist))
1017          passphrase)
1018     ;; return the saved passphrase, calling a function if needed
1019     (or (copy-sequence (if (functionp (cdr entry))
1020                            (funcall (cdr entry))
1021                          (cdr entry)))
1022         (progn
1023           (unless entry
1024             (setq entry (list file))
1025             (push entry auth-source-passphrase-alist))
1026           (setq passphrase
1027                 (read-passwd
1028                  (format "Passphrase for %s tokens: " file)
1029                  t))
1030           (setcdr entry (lexical-let ((p (copy-sequence passphrase)))
1031                           (lambda () p)))
1032           passphrase))))
1033
1034 ;; (auth-source-epa-extract-gpg-token "gpg:LS0tLS1CRUdJTiBQR1AgTUVTU0FHRS0tLS0tClZlcnNpb246IEdudVBHIHYxLjQuMTEgKEdOVS9MaW51eCkKCmpBMEVBd01DT25qMjB1ak9rZnRneVI3K21iNm9aZWhuLzRad3cySkdlbnVaKzRpeEswWDY5di9icDI1U1dsQT0KPS9yc2wKLS0tLS1FTkQgUEdQIE1FU1NBR0UtLS0tLQo=" "~/.netrc")
1035 (defun auth-source-epa-extract-gpg-token (secret file)
1036   "Pass either the decoded SECRET or the gpg:BASE64DATA version.
1037 FILE is the file from which we obtained this token."
1038   (when (string-match "^gpg:\\(.+\\)" secret)
1039     (setq secret (base64-decode-string (match-string 1 secret))))
1040   (let ((context (epg-make-context 'OpenPGP))
1041         plain)
1042     (epg-context-set-passphrase-callback
1043      context
1044      (cons #'auth-source-token-passphrase-callback-function
1045            file))
1046     (epg-decrypt-string context secret)))
1047
1048 ;; (insert (auth-source-epa-make-gpg-token "mysecret" "~/.netrc"))
1049 (defun auth-source-epa-make-gpg-token (secret file)
1050   (let ((context (epg-make-context 'OpenPGP))
1051         (pp-escape-newlines nil)
1052         cipher)
1053     (epg-context-set-armor context t)
1054     (epg-context-set-passphrase-callback
1055      context
1056      (cons #'auth-source-token-passphrase-callback-function
1057            file))
1058     (setq cipher (epg-encrypt-string context secret nil))
1059     (with-temp-buffer
1060       (insert cipher)
1061       (base64-encode-region (point-min) (point-max) t)
1062       (concat "gpg:" (buffer-substring-no-properties
1063                       (point-min)
1064                       (point-max))))))
1065
1066 (defun auth-source-netrc-normalize (alist filename)
1067   (mapcar (lambda (entry)
1068             (let (ret item)
1069               (while (setq item (pop entry))
1070                 (let ((k (car item))
1071                       (v (cdr item)))
1072
1073                   ;; apply key aliases
1074                   (setq k (cond ((member k '("machine")) "host")
1075                                 ((member k '("login" "account")) "user")
1076                                 ((member k '("protocol")) "port")
1077                                 ((member k '("password")) "secret")
1078                                 (t k)))
1079
1080                   ;; send back the secret in a function (lexical binding)
1081                   (when (equal k "secret")
1082                     (setq v (lexical-let ((lexv v)
1083                                           (token-decoder nil))
1084                               (when (string-match "^gpg:" lexv)
1085                                 ;; it's a GPG token: create a token decoder
1086                                 ;; which unsets itself once
1087                                 (setq token-decoder
1088                                       (lambda (val)
1089                                         (prog1
1090                                             (auth-source-epa-extract-gpg-token
1091                                              val
1092                                              filename)
1093                                           (setq token-decoder nil)))))
1094                               (lambda ()
1095                                 (when token-decoder
1096                                   (setq lexv (funcall token-decoder lexv)))
1097                                 lexv))))
1098                   (setq ret (plist-put ret
1099                                        (intern (concat ":" k))
1100                                        v))))
1101               ret))
1102           alist))
1103
1104 ;; (setq secret (plist-get (nth 0 (auth-source-search :host t :type 'netrc :K 1 :max 1)) :secret))
1105 ;; (funcall secret)
1106
1107 (defun* auth-source-netrc-search (&rest
1108                                   spec
1109                                   &key backend require create delete
1110                                   type max host user port
1111                                   &allow-other-keys)
1112   "Given a property list SPEC, return search matches from the :backend.
1113 See `auth-source-search' for details on SPEC."
1114   ;; just in case, check that the type is correct (null or same as the backend)
1115   (assert (or (null type) (eq type (oref backend type)))
1116           t "Invalid netrc search: %s %s")
1117
1118   (let ((results (auth-source-netrc-normalize
1119                   (auth-source-netrc-parse
1120                    :max max
1121                    :require require
1122                    :delete delete
1123                    :file (oref backend source)
1124                    :host (or host t)
1125                    :user (or user t)
1126                    :port (or port t))
1127                   (oref backend source))))
1128
1129     ;; if we need to create an entry AND none were found to match
1130     (when (and create
1131                (not results))
1132
1133       ;; create based on the spec and record the value
1134       (setq results (or
1135                      ;; if the user did not want to create the entry
1136                      ;; in the file, it will be returned
1137                      (apply (slot-value backend 'create-function) spec)
1138                      ;; if not, we do the search again without :create
1139                      ;; to get the updated data.
1140
1141                      ;; the result will be returned, even if the search fails
1142                      (apply 'auth-source-netrc-search
1143                             (plist-put spec :create nil)))))
1144     results))
1145
1146 (defun auth-source-netrc-element-or-first (v)
1147   (if (listp v)
1148       (nth 0 v)
1149     v))
1150
1151 ;; (auth-source-search :host "nonesuch" :type 'netrc :max 1 :create t)
1152 ;; (auth-source-search :host "nonesuch" :type 'netrc :max 1 :create t :create-extra-keys '((A "default A") (B)))
1153
1154 (defun* auth-source-netrc-create (&rest spec
1155                                         &key backend
1156                                         secret host user port create
1157                                         &allow-other-keys)
1158   (let* ((base-required '(host user port secret))
1159          ;; we know (because of an assertion in auth-source-search) that the
1160          ;; :create parameter is either t or a list (which includes nil)
1161          (create-extra (if (eq t create) nil create))
1162          (current-data (car (auth-source-search :max 1
1163                                                 :host host
1164                                                 :port port)))
1165          (required (append base-required create-extra))
1166          (file (oref backend source))
1167          (add "")
1168          ;; `valist' is an alist
1169          valist
1170          ;; `artificial' will be returned if no creation is needed
1171          artificial)
1172
1173     ;; only for base required elements (defined as function parameters):
1174     ;; fill in the valist with whatever data we may have from the search
1175     ;; we complete the first value if it's a list and use the value otherwise
1176     (dolist (br base-required)
1177       (when (symbol-value br)
1178         (let ((br-choice (cond
1179                           ;; all-accepting choice (predicate is t)
1180                           ((eq t (symbol-value br)) nil)
1181                           ;; just the value otherwise
1182                           (t (symbol-value br)))))
1183           (when br-choice
1184             (auth-source--aput valist br br-choice)))))
1185
1186     ;; for extra required elements, see if the spec includes a value for them
1187     (dolist (er create-extra)
1188       (let ((name (concat ":" (symbol-name er)))
1189             (keys (loop for i below (length spec) by 2
1190                         collect (nth i spec))))
1191         (dolist (k keys)
1192           (when (equal (symbol-name k) name)
1193             (auth-source--aput valist er (plist-get spec k))))))
1194
1195     ;; for each required element
1196     (dolist (r required)
1197       (let* ((data (auth-source--aget valist r))
1198              ;; take the first element if the data is a list
1199              (data (or (auth-source-netrc-element-or-first data)
1200                        (plist-get current-data
1201                                   (intern (format ":%s" r) obarray))))
1202              ;; this is the default to be offered
1203              (given-default (auth-source--aget
1204                              auth-source-creation-defaults r))
1205              ;; the default supplementals are simple:
1206              ;; for the user, try `given-default' and then (user-login-name);
1207              ;; otherwise take `given-default'
1208              (default (cond
1209                        ((and (not given-default) (eq r 'user))
1210                         (user-login-name))
1211                        (t given-default)))
1212              (printable-defaults (list
1213                                   (cons 'user
1214                                         (or
1215                                          (auth-source-netrc-element-or-first
1216                                           (auth-source--aget valist 'user))
1217                                          (plist-get artificial :user)
1218                                          "[any user]"))
1219                                   (cons 'host
1220                                         (or
1221                                          (auth-source-netrc-element-or-first
1222                                           (auth-source--aget valist 'host))
1223                                          (plist-get artificial :host)
1224                                          "[any host]"))
1225                                   (cons 'port
1226                                         (or
1227                                          (auth-source-netrc-element-or-first
1228                                           (auth-source--aget valist 'port))
1229                                          (plist-get artificial :port)
1230                                          "[any port]"))))
1231              (prompt (or (auth-source--aget auth-source-creation-prompts r)
1232                          (case r
1233                            (secret "%p password for %u@%h: ")
1234                            (user "%p user name for %h: ")
1235                            (host "%p host name for user %u: ")
1236                            (port "%p port for %u@%h: "))
1237                          (format "Enter %s (%%u@%%h:%%p): " r)))
1238              (prompt (auth-source-format-prompt
1239                       prompt
1240                       `((?u ,(auth-source--aget printable-defaults 'user))
1241                         (?h ,(auth-source--aget printable-defaults 'host))
1242                         (?p ,(auth-source--aget printable-defaults 'port))))))
1243
1244         ;; Store the data, prompting for the password if needed.
1245         (setq data (or data
1246                        (if (eq r 'secret)
1247                            ;; Special case prompt for passwords.
1248                            ;; 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)))
1249                            ;; TODO: or maybe leave as (setq auth-source-netrc-use-gpg-tokens 'never)
1250                            (let* ((ep (format "Use GPG password tokens in %s?" file))
1251                                   (gpg-encrypt
1252                                    (cond
1253                                     ((eq auth-source-netrc-use-gpg-tokens 'never)
1254                                      'never)
1255                                     ((listp auth-source-netrc-use-gpg-tokens)
1256                                      (let ((check (copy-sequence
1257                                                    auth-source-netrc-use-gpg-tokens))
1258                                            item ret)
1259                                        (while check
1260                                          (setq item (pop check))
1261                                          (when (or (eq (car item) t)
1262                                                    (string-match (car item) file))
1263                                            (setq ret (cdr item))
1264                                            (setq check nil)))))
1265                                     (t 'never)))
1266                                   (plain (or (eval default) (read-passwd prompt))))
1267                              ;; ask if we don't know what to do (in which case
1268                              ;; auth-source-netrc-use-gpg-tokens must be a list)
1269                              (unless gpg-encrypt
1270                                (setq gpg-encrypt (if (y-or-n-p ep) 'gpg 'never))
1271                                ;; TODO: save the defcustom now? or ask?
1272                                (setq auth-source-netrc-use-gpg-tokens
1273                                      (cons `(,file ,gpg-encrypt)
1274                                            auth-source-netrc-use-gpg-tokens)))
1275                              (if (eq gpg-encrypt 'gpg)
1276                                  (auth-source-epa-make-gpg-token plain file)
1277                                plain))
1278                          (if (stringp default)
1279                              (read-string (if (string-match ": *\\'" prompt)
1280                                               (concat (substring prompt 0 (match-beginning 0))
1281                                                       " (default " default "): ")
1282                                             (concat prompt "(default " default ") "))
1283                                           nil nil default)
1284                            (eval default)))))
1285
1286         (when data
1287           (setq artificial (plist-put artificial
1288                                       (intern (concat ":" (symbol-name r)))
1289                                       (if (eq r 'secret)
1290                                           (lexical-let ((data data))
1291                                             (lambda () data))
1292                                         data))))
1293
1294         ;; When r is not an empty string...
1295         (when (and (stringp data)
1296                    (< 0 (length data)))
1297           ;; this function is not strictly necessary but I think it
1298           ;; makes the code clearer -tzz
1299           (let ((printer (lambda ()
1300                            ;; append the key (the symbol name of r)
1301                            ;; and the value in r
1302                            (format "%s%s %s"
1303                                    ;; prepend a space
1304                                    (if (zerop (length add)) "" " ")
1305                                    ;; remap auth-source tokens to netrc
1306                                    (case r
1307                                      (user   "login")
1308                                      (host   "machine")
1309                                      (secret "password")
1310                                      (port   "port") ; redundant but clearer
1311                                      (t (symbol-name r)))
1312                                    (if (string-match "[\"# ]" data)
1313                                        (format "%S" data)
1314                                      data)))))
1315             (setq add (concat add (funcall printer)))))))
1316
1317     (plist-put
1318      artificial
1319      :save-function
1320      (lexical-let ((file file)
1321                    (add add))
1322        (lambda () (auth-source-netrc-saver file add))))
1323
1324     (list artificial)))
1325
1326 ;;(funcall (plist-get (nth 0 (auth-source-search :host '("nonesuch2") :user "tzz" :port "imap" :create t :max 1)) :save-function))
1327 (defun auth-source-netrc-saver (file add)
1328   "Save a line ADD in FILE, prompting along the way.
1329 Respects `auth-source-save-behavior'.  Uses
1330 `auth-source-netrc-cache' to avoid prompting more than once."
1331   (let* ((key (format "%s %s" file (rfc2104-hash 'md5 64 16 file add)))
1332          (cached (assoc key auth-source-netrc-cache)))
1333
1334     (if cached
1335         (auth-source-do-trivia
1336          "auth-source-netrc-saver: found previous run for key %s, returning"
1337          key)
1338       (with-temp-buffer
1339         (when (file-exists-p file)
1340           (insert-file-contents file))
1341         (when auth-source-gpg-encrypt-to
1342           ;; (see bug#7487) making `epa-file-encrypt-to' local to
1343           ;; this buffer lets epa-file skip the key selection query
1344           ;; (see the `local-variable-p' check in
1345           ;; `epa-file-write-region').
1346           (unless (local-variable-p 'epa-file-encrypt-to (current-buffer))
1347             (make-local-variable 'epa-file-encrypt-to))
1348           (if (listp auth-source-gpg-encrypt-to)
1349               (setq epa-file-encrypt-to auth-source-gpg-encrypt-to)))
1350         ;; we want the new data to be found first, so insert at beginning
1351         (goto-char (point-min))
1352
1353         ;; Ask AFTER we've successfully opened the file.
1354         (let ((prompt (format "Save auth info to file %s? " file))
1355               (done (not (eq auth-source-save-behavior 'ask)))
1356               (bufname "*auth-source Help*")
1357               k)
1358           (while (not done)
1359             (setq k (auth-source-read-char-choice prompt '(?y ?n ?N ?e ??)))
1360             (case k
1361               (?y (setq done t))
1362               (?? (save-excursion
1363                     (with-output-to-temp-buffer bufname
1364                       (princ
1365                        (concat "(y)es, save\n"
1366                                "(n)o but use the info\n"
1367                                "(N)o and don't ask to save again\n"
1368                                "(e)dit the line\n"
1369                                "(?) for help as you can see.\n"))
1370                       ;; Why?  Doesn't with-output-to-temp-buffer already do
1371                       ;; the exact same thing anyway?  --Stef
1372                       (set-buffer standard-output)
1373                       (help-mode))))
1374               (?n (setq add ""
1375                         done t))
1376               (?N
1377                (setq add ""
1378                      done t)
1379                (customize-save-variable 'auth-source-save-behavior nil))
1380               (?e (setq add (read-string "Line to add: " add)))
1381               (t nil)))
1382
1383           (when (get-buffer-window bufname)
1384             (delete-window (get-buffer-window bufname)))
1385
1386           ;; Make sure the info is not saved.
1387           (when (null auth-source-save-behavior)
1388             (setq add ""))
1389
1390           (when (< 0 (length add))
1391             (progn
1392               (unless (bolp)
1393                 (insert "\n"))
1394               (insert add "\n")
1395               (write-region (point-min) (point-max) file nil 'silent)
1396               ;; Make the .authinfo file non-world-readable.
1397               (set-file-modes file #o600)
1398               (auth-source-do-debug
1399                "auth-source-netrc-create: wrote 1 new line to %s"
1400                file)
1401               (message "Saved new authentication information to %s" file)
1402               nil))))
1403       (auth-source--aput auth-source-netrc-cache key "ran"))))
1404
1405 ;;; Backend specific parsing: Secrets API backend
1406
1407 ;; (let ((auth-sources '(default))) (auth-source-search :max 1 :create t))
1408 ;; (let ((auth-sources '(default))) (auth-source-search :max 1 :delete t))
1409 ;; (let ((auth-sources '(default))) (auth-source-search :max 1))
1410 ;; (let ((auth-sources '(default))) (auth-source-search))
1411 ;; (let ((auth-sources '("secrets:Login"))) (auth-source-search :max 1))
1412 ;; (let ((auth-sources '("secrets:Login"))) (auth-source-search :max 1 :signon_realm "https://git.gnus.org/Git"))
1413
1414 (defun* auth-source-secrets-search (&rest
1415                                     spec
1416                                     &key backend create delete label
1417                                     type max host user port
1418                                     &allow-other-keys)
1419   "Search the Secrets API; spec is like `auth-source'.
1420
1421 The :label key specifies the item's label.  It is the only key
1422 that can specify a substring.  Any :label value besides a string
1423 will allow any label.
1424
1425 All other search keys must match exactly.  If you need substring
1426 matching, do a wider search and narrow it down yourself.
1427
1428 You'll get back all the properties of the token as a plist.
1429
1430 Here's an example that looks for the first item in the 'Login'
1431 Secrets collection:
1432
1433  \(let ((auth-sources '(\"secrets:Login\")))
1434     (auth-source-search :max 1)
1435
1436 Here's another that looks for the first item in the 'Login'
1437 Secrets collection whose label contains 'gnus':
1438
1439  \(let ((auth-sources '(\"secrets:Login\")))
1440     (auth-source-search :max 1 :label \"gnus\")
1441
1442 And this one looks for the first item in the 'Login' Secrets
1443 collection that's a Google Chrome entry for the git.gnus.org site
1444 authentication tokens:
1445
1446  \(let ((auth-sources '(\"secrets:Login\")))
1447     (auth-source-search :max 1 :signon_realm \"https://git.gnus.org/Git\"))
1448 "
1449
1450   ;; TODO
1451   (assert (not create) nil
1452           "The Secrets API auth-source backend doesn't support creation yet")
1453   ;; TODO
1454   ;; (secrets-delete-item coll elt)
1455   (assert (not delete) nil
1456           "The Secrets API auth-source backend doesn't support deletion yet")
1457
1458   (let* ((coll (oref backend source))
1459          (max (or max 5000))     ; sanity check: default to stop at 5K
1460          (ignored-keys '(:create :delete :max :backend :label))
1461          (search-keys (loop for i below (length spec) by 2
1462                             unless (memq (nth i spec) ignored-keys)
1463                             collect (nth i spec)))
1464          ;; build a search spec without the ignored keys
1465          ;; if a search key is nil or t (match anything), we skip it
1466          (search-spec (apply 'append (mapcar
1467                                       (lambda (k)
1468                                         (if (or (null (plist-get spec k))
1469                                                 (eq t (plist-get spec k)))
1470                                             nil
1471                                           (list k (plist-get spec k))))
1472                                       search-keys)))
1473          ;; needed keys (always including host, login, port, and secret)
1474          (returned-keys (mm-delete-duplicates (append
1475                                                '(:host :login :port :secret)
1476                                                search-keys)))
1477          (items (loop for item in (apply 'secrets-search-items coll search-spec)
1478                       unless (and (stringp label)
1479                                   (not (string-match label item)))
1480                       collect item))
1481          ;; TODO: respect max in `secrets-search-items', not after the fact
1482          (items (butlast items (- (length items) max)))
1483          ;; convert the item name to a full plist
1484          (items (mapcar (lambda (item)
1485                           (append
1486                            ;; make an entry for the secret (password) element
1487                            (list
1488                             :secret
1489                             (lexical-let ((v (secrets-get-secret coll item)))
1490                               (lambda () v)))
1491                            ;; rewrite the entry from ((k1 v1) (k2 v2)) to plist
1492                            (apply 'append
1493                                   (mapcar (lambda (entry)
1494                                             (list (car entry) (cdr entry)))
1495                                           (secrets-get-attributes coll item)))))
1496                         items))
1497          ;; ensure each item has each key in `returned-keys'
1498          (items (mapcar (lambda (plist)
1499                           (append
1500                            (apply 'append
1501                                   (mapcar (lambda (req)
1502                                             (if (plist-get plist req)
1503                                                 nil
1504                                               (list req nil)))
1505                                           returned-keys))
1506                            plist))
1507                         items)))
1508     items))
1509
1510 (defun* auth-source-secrets-create (&rest
1511                                     spec
1512                                     &key backend type max host user port
1513                                     &allow-other-keys)
1514   ;; TODO
1515   ;; (apply 'secrets-create-item (auth-get-source entry) name passwd spec)
1516   (debug spec))
1517
1518 ;;; Backend specific parsing: PLSTORE backend
1519
1520 (defun* auth-source-plstore-search (&rest
1521                                     spec
1522                                     &key backend create delete label
1523                                     type max host user port
1524                                     &allow-other-keys)
1525   "Search the PLSTORE; spec is like `auth-source'."
1526   (let* ((store (oref backend data))
1527          (max (or max 5000))     ; sanity check: default to stop at 5K
1528          (ignored-keys '(:create :delete :max :backend :require))
1529          (search-keys (loop for i below (length spec) by 2
1530                             unless (memq (nth i spec) ignored-keys)
1531                             collect (nth i spec)))
1532          ;; build a search spec without the ignored keys
1533          ;; if a search key is nil or t (match anything), we skip it
1534          (search-spec (apply 'append (mapcar
1535                                       (lambda (k)
1536                                         (let ((v (plist-get spec k)))
1537                                           (if (or (null v)
1538                                                   (eq t v))
1539                                               nil
1540                                             (if (stringp v)
1541                                                 (setq v (list v)))
1542                                             (list k v))))
1543                                       search-keys)))
1544          ;; needed keys (always including host, login, port, and secret)
1545          (returned-keys (mm-delete-duplicates (append
1546                                                '(:host :login :port :secret)
1547                                                search-keys)))
1548          (items (plstore-find store search-spec))
1549          (item-names (mapcar #'car items))
1550          (items (butlast items (- (length items) max)))
1551          ;; convert the item to a full plist
1552          (items (mapcar (lambda (item)
1553                           (let* ((plist (copy-tree (cdr item)))
1554                                  (secret (plist-member plist :secret)))
1555                             (if secret
1556                                 (setcar
1557                                  (cdr secret)
1558                                  (lexical-let ((v (car (cdr secret))))
1559                                    (lambda () v))))
1560                             plist))
1561                         items))
1562          ;; ensure each item has each key in `returned-keys'
1563          (items (mapcar (lambda (plist)
1564                           (append
1565                            (apply 'append
1566                                   (mapcar (lambda (req)
1567                                             (if (plist-get plist req)
1568                                                 nil
1569                                               (list req nil)))
1570                                           returned-keys))
1571                            plist))
1572                         items)))
1573     (cond
1574      ;; if we need to create an entry AND none were found to match
1575      ((and create
1576            (not items))
1577
1578       ;; create based on the spec and record the value
1579       (setq items (or
1580                    ;; if the user did not want to create the entry
1581                    ;; in the file, it will be returned
1582                    (apply (slot-value backend 'create-function) spec)
1583                    ;; if not, we do the search again without :create
1584                    ;; to get the updated data.
1585
1586                    ;; the result will be returned, even if the search fails
1587                    (apply 'auth-source-plstore-search
1588                           (plist-put spec :create nil)))))
1589      ((and delete
1590            item-names)
1591       (dolist (item-name item-names)
1592         (plstore-delete store item-name))
1593       (plstore-save store)))
1594     items))
1595
1596 (defun* auth-source-plstore-create (&rest spec
1597                                           &key backend
1598                                           secret host user port create
1599                                           &allow-other-keys)
1600   (let* ((base-required '(host user port secret))
1601          (base-secret '(secret))
1602          ;; we know (because of an assertion in auth-source-search) that the
1603          ;; :create parameter is either t or a list (which includes nil)
1604          (create-extra (if (eq t create) nil create))
1605          (current-data (car (auth-source-search :max 1
1606                                                 :host host
1607                                                 :port port)))
1608          (required (append base-required create-extra))
1609          (file (oref backend source))
1610          (add "")
1611          ;; `valist' is an alist
1612          valist
1613          ;; `artificial' will be returned if no creation is needed
1614          artificial
1615          secret-artificial)
1616
1617     ;; only for base required elements (defined as function parameters):
1618     ;; fill in the valist with whatever data we may have from the search
1619     ;; we complete the first value if it's a list and use the value otherwise
1620     (dolist (br base-required)
1621       (when (symbol-value br)
1622         (let ((br-choice (cond
1623                           ;; all-accepting choice (predicate is t)
1624                           ((eq t (symbol-value br)) nil)
1625                           ;; just the value otherwise
1626                           (t (symbol-value br)))))
1627           (when br-choice
1628             (auth-source--aput valist br br-choice)))))
1629
1630     ;; for extra required elements, see if the spec includes a value for them
1631     (dolist (er create-extra)
1632       (let ((name (concat ":" (symbol-name er)))
1633             (keys (loop for i below (length spec) by 2
1634                         collect (nth i spec))))
1635         (dolist (k keys)
1636           (when (equal (symbol-name k) name)
1637             (auth-source--aput valist er (plist-get spec k))))))
1638
1639     ;; for each required element
1640     (dolist (r required)
1641       (let* ((data (auth-source--aget valist r))
1642              ;; take the first element if the data is a list
1643              (data (or (auth-source-netrc-element-or-first data)
1644                        (plist-get current-data
1645                                   (intern (format ":%s" r) obarray))))
1646              ;; this is the default to be offered
1647              (given-default (auth-source--aget
1648                              auth-source-creation-defaults r))
1649              ;; the default supplementals are simple:
1650              ;; for the user, try `given-default' and then (user-login-name);
1651              ;; otherwise take `given-default'
1652              (default (cond
1653                        ((and (not given-default) (eq r 'user))
1654                         (user-login-name))
1655                        (t given-default)))
1656              (printable-defaults (list
1657                                   (cons 'user
1658                                         (or
1659                                          (auth-source-netrc-element-or-first
1660                                           (auth-source--aget valist 'user))
1661                                          (plist-get artificial :user)
1662                                          "[any user]"))
1663                                   (cons 'host
1664                                         (or
1665                                          (auth-source-netrc-element-or-first
1666                                           (auth-source--aget valist 'host))
1667                                          (plist-get artificial :host)
1668                                          "[any host]"))
1669                                   (cons 'port
1670                                         (or
1671                                          (auth-source-netrc-element-or-first
1672                                           (auth-source--aget valist 'port))
1673                                          (plist-get artificial :port)
1674                                          "[any port]"))))
1675              (prompt (or (auth-source--aget auth-source-creation-prompts r)
1676                          (case r
1677                            (secret "%p password for %u@%h: ")
1678                            (user "%p user name for %h: ")
1679                            (host "%p host name for user %u: ")
1680                            (port "%p port for %u@%h: "))
1681                          (format "Enter %s (%%u@%%h:%%p): " r)))
1682              (prompt (auth-source-format-prompt
1683                       prompt
1684                       `((?u ,(auth-source--aget printable-defaults 'user))
1685                         (?h ,(auth-source--aget printable-defaults 'host))
1686                         (?p ,(auth-source--aget printable-defaults 'port))))))
1687
1688         ;; Store the data, prompting for the password if needed.
1689         (setq data (or data
1690                        (if (eq r 'secret)
1691                            (or (eval default) (read-passwd prompt))
1692                          (if (stringp default)
1693                              (read-string
1694                               (if (string-match ": *\\'" prompt)
1695                                   (concat (substring prompt 0 (match-beginning 0))
1696                                           " (default " default "): ")
1697                                 (concat prompt "(default " default ") "))
1698                               nil nil default)
1699                            (eval default)))))
1700
1701         (when data
1702           (if (member r base-secret)
1703               (setq secret-artificial
1704                     (plist-put secret-artificial
1705                                (intern (concat ":" (symbol-name r)))
1706                                data))
1707             (setq artificial (plist-put artificial
1708                                         (intern (concat ":" (symbol-name r)))
1709                                         data))))))
1710     (plstore-put (oref backend data)
1711                  (sha1 (format "%s@%s:%s"
1712                                (plist-get artificial :user)
1713                                (plist-get artificial :host)
1714                                (plist-get artificial :port)))
1715                  artificial secret-artificial)
1716     (if (y-or-n-p (format "Save auth info to file %s? "
1717                           (plstore-get-file (oref backend data))))
1718         (plstore-save (oref backend data)))))
1719
1720 ;;; older API
1721
1722 ;; (auth-source-user-or-password '("login" "password") "imap.myhost.com" t "tzz")
1723
1724 ;; deprecate the old interface
1725 (make-obsolete 'auth-source-user-or-password
1726                'auth-source-search "Emacs 24.1")
1727 (make-obsolete 'auth-source-forget-user-or-password
1728                'auth-source-forget "Emacs 24.1")
1729
1730 (defun auth-source-user-or-password
1731   (mode host port &optional username create-missing delete-existing)
1732   "Find MODE (string or list of strings) matching HOST and PORT.
1733
1734 DEPRECATED in favor of `auth-source-search'!
1735
1736 USERNAME is optional and will be used as \"login\" in a search
1737 across the Secret Service API (see secrets.el) if the resulting
1738 items don't have a username.  This means that if you search for
1739 username \"joe\" and it matches an item but the item doesn't have
1740 a :user attribute, the username \"joe\" will be returned.
1741
1742 A non nil DELETE-EXISTING means deleting any matching password
1743 entry in the respective sources.  This is useful only when
1744 CREATE-MISSING is non nil as well; the intended use case is to
1745 remove wrong password entries.
1746
1747 If no matching entry is found, and CREATE-MISSING is non nil,
1748 the password will be retrieved interactively, and it will be
1749 stored in the password database which matches best (see
1750 `auth-sources').
1751
1752 MODE can be \"login\" or \"password\"."
1753   (auth-source-do-debug
1754    "auth-source-user-or-password: DEPRECATED get %s for %s (%s) + user=%s"
1755    mode host port username)
1756
1757   (let* ((listy (listp mode))
1758          (mode (if listy mode (list mode)))
1759          (cname (if username
1760                     (format "%s %s:%s %s" mode host port username)
1761                   (format "%s %s:%s" mode host port)))
1762          (search (list :host host :port port))
1763          (search (if username (append search (list :user username)) search))
1764          (search (if create-missing
1765                      (append search (list :create t))
1766                    search))
1767          (search (if delete-existing
1768                      (append search (list :delete t))
1769                    search))
1770          ;; (found (if (not delete-existing)
1771          ;;            (gethash cname auth-source-cache)
1772          ;;          (remhash cname auth-source-cache)
1773          ;;          nil)))
1774          (found nil))
1775     (if found
1776         (progn
1777           (auth-source-do-debug
1778            "auth-source-user-or-password: DEPRECATED cached %s=%s for %s (%s) + %s"
1779            mode
1780            ;; don't show the password
1781            (if (and (member "password" mode) t)
1782                "SECRET"
1783              found)
1784            host port username)
1785           found)                        ; return the found data
1786       ;; else, if not found, search with a max of 1
1787       (let ((choice (nth 0 (apply 'auth-source-search
1788                                   (append '(:max 1) search)))))
1789         (when choice
1790           (dolist (m mode)
1791             (cond
1792              ((equal "password" m)
1793               (push (if (plist-get choice :secret)
1794                         (funcall (plist-get choice :secret))
1795                       nil) found))
1796              ((equal "login" m)
1797               (push (plist-get choice :user) found)))))
1798         (setq found (nreverse found))
1799         (setq found (if listy found (car-safe found)))))
1800
1801     found))
1802
1803 (defun auth-source-user-and-password (host &optional user)
1804   (let* ((auth-info (car
1805                      (if user
1806                          (auth-source-search
1807                           :host host
1808                           :user "yourusername"
1809                           :max 1
1810                           :require '(:user :secret)
1811                           :create nil)
1812                        (auth-source-search
1813                         :host host
1814                         :max 1
1815                         :require '(:user :secret)
1816                         :create nil))))
1817          (user (plist-get auth-info :user))
1818          (password (plist-get auth-info :secret)))
1819     (when (functionp password)
1820       (setq password (funcall password)))
1821     (list user password auth-info)))
1822
1823 (provide 'auth-source)
1824
1825 ;;; auth-source.el ends here