auth-source.el 47.5 KB
Newer Older
Miles Bader's avatar
Miles Bader committed
1 2
;;; auth-source.el --- authentication sources for Gnus and Emacs

3
;; Copyright (C) 2008-2011 Free Software Foundation, Inc.
Miles Bader's avatar
Miles Bader committed
4 5 6 7 8 9

;; Author: Ted Zlatanov <tzz@lifelogs.com>
;; Keywords: news

;; This file is part of GNU Emacs.

10
;; GNU Emacs is free software: you can redistribute it and/or modify
Miles Bader's avatar
Miles Bader committed
11
;; it under the terms of the GNU General Public License as published by
12 13
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
Miles Bader's avatar
Miles Bader committed
14 15 16

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
Miles Bader's avatar
Miles Bader committed
18 19 20
;; GNU General Public License for more details.

;; 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/>.
Miles Bader's avatar
Miles Bader committed
22 23 24 25 26 27 28

;;; Commentary:

;; This is the auth-source.el package.  It lets users tell Gnus how to
;; authenticate in a single place.  Simplicity is the goal.  Instead
;; of providing 5000 options, we'll stick to simple, easy to
;; understand options.
Miles Bader's avatar
Miles Bader committed
29

Katsumi Yamaoka's avatar
Katsumi Yamaoka committed
30
;; See the auth.info Info documentation for details.
Miles Bader's avatar
Miles Bader committed
31

32 33 34 35 36 37 38 39
;; TODO:

;; - never decode the backend file unless it's necessary
;; - a more generic way to match backends and search backend contents
;; - absorb netrc.el and simplify it
;; - protect passwords better
;; - allow creating and changing netrc lines (not files) e.g. change a password

Miles Bader's avatar
Miles Bader committed
40 41
;;; Code:

42
(require 'password-cache)
43
(require 'mm-util)
Miles Bader's avatar
Miles Bader committed
44
(require 'gnus-util)
45
(require 'netrc)
46
(require 'assoc)
Miles Bader's avatar
Miles Bader committed
47
(eval-when-compile (require 'cl))
48 49
(require 'eieio)

50 51
(autoload 'secrets-create-item "secrets")
(autoload 'secrets-delete-item "secrets")
Katsumi Yamaoka's avatar
Katsumi Yamaoka committed
52
(autoload 'secrets-get-alias "secrets")
53
(autoload 'secrets-get-attributes "secrets")
54
(autoload 'secrets-get-secret "secrets")
55 56
(autoload 'secrets-list-collections "secrets")
(autoload 'secrets-search-items "secrets")
Miles Bader's avatar
Miles Bader committed
57

58 59
(defvar secrets-enabled)

Miles Bader's avatar
Miles Bader committed
60 61
(defgroup auth-source nil
  "Authentication sources."
Miles Bader's avatar
Miles Bader committed
62
  :version "23.1" ;; No Gnus
Miles Bader's avatar
Miles Bader committed
63 64
  :group 'gnus)

65 66 67 68 69 70 71 72 73 74 75 76
;;;###autoload
(defcustom auth-source-cache-expiry 7200
  "How many seconds passwords are cached, or nil to disable
expiring.  Overrides `password-cache-expiry' through a
let-binding."
  :group 'auth-source
  :type '(choice (const :tag "Never" nil)
                 (const :tag "All Day" 86400)
                 (const :tag "2 Hours" 7200)
                 (const :tag "30 Minutes" 1800)
                 (integer :tag "Seconds")))

77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96
(defclass auth-source-backend ()
  ((type :initarg :type
         :initform 'netrc
         :type symbol
         :custom symbol
         :documentation "The backend type.")
   (source :initarg :source
           :type string
           :custom string
           :documentation "The backend source.")
   (host :initarg :host
         :initform t
         :type t
         :custom string
         :documentation "The backend host.")
   (user :initarg :user
         :initform t
         :type t
         :custom string
         :documentation "The backend user.")
97 98 99 100 101
   (port :initarg :port
         :initform t
         :type t
         :custom string
         :documentation "The backend protocol.")
102 103 104 105 106 107 108 109 110 111 112
   (create-function :initarg :create-function
                    :initform ignore
                    :type function
                    :custom function
                    :documentation "The create function.")
   (search-function :initarg :search-function
                    :initform ignore
                    :type function
                    :custom function
                    :documentation "The search function.")))

Miles Bader's avatar
Miles Bader committed
113
(defcustom auth-source-protocols '((imap "imap" "imaps" "143" "993")
114 115 116 117
                                   (pop3 "pop3" "pop" "pop3s" "110" "995")
                                   (ssh  "ssh" "22")
                                   (sftp "sftp" "115")
                                   (smtp "smtp" "25"))
Miles Bader's avatar
Miles Bader committed
118 119 120
  "List of authentication protocols and their names"

  :group 'auth-source
Katsumi Yamaoka's avatar
Katsumi Yamaoka committed
121
  :version "23.2" ;; No Gnus
Miles Bader's avatar
Miles Bader committed
122
  :type '(repeat :tag "Authentication Protocols"
123 124 125 126
                 (cons :tag "Protocol Entry"
                       (symbol :tag "Protocol")
                       (repeat :tag "Names"
                               (string :tag "Name")))))
Miles Bader's avatar
Miles Bader committed
127 128

;;; generate all the protocols in a format Customize can use
129
;;; TODO: generate on the fly from auth-source-protocols
Miles Bader's avatar
Miles Bader committed
130 131
(defconst auth-source-protocols-customize
  (mapcar (lambda (a)
132 133 134 135 136
            (let ((p (car-safe a)))
              (list 'const
                    :tag (upcase (symbol-name p))
                    p)))
          auth-source-protocols))
Miles Bader's avatar
Miles Bader committed
137

138 139 140 141 142 143
(defvar auth-source-creation-defaults nil
  "Defaults for creating token values.  Usually let-bound.")

(make-obsolete 'auth-source-hide-passwords nil "Emacs 24.1")

(defvar auth-source-magic "auth-source-magic ")
Miles Bader's avatar
Miles Bader committed
144 145

(defcustom auth-source-do-cache t
146
  "Whether auth-source should cache information with `password-cache'."
Miles Bader's avatar
Miles Bader committed
147
  :group 'auth-source
Katsumi Yamaoka's avatar
Katsumi Yamaoka committed
148
  :version "23.2" ;; No Gnus
Miles Bader's avatar
Miles Bader committed
149 150
  :type `boolean)

151
(defcustom auth-source-debug t
Katsumi Yamaoka's avatar
Katsumi Yamaoka committed
152 153 154
  "Whether auth-source should log debug messages.

If the value is nil, debug messages are not logged.
155 156 157 158 159

If the value is t, debug messages are logged with `message'.  In
that case, your authentication data will be in the clear (except
for passwords).

Katsumi Yamaoka's avatar
Katsumi Yamaoka committed
160 161 162
If the value is a function, debug messages are logged by calling
 that function using the same arguments as `message'."
  :group 'auth-source
Katsumi Yamaoka's avatar
Katsumi Yamaoka committed
163
  :version "23.2" ;; No Gnus
164 165 166 167 168
  :type `(choice
          :tag "auth-source debugging mode"
          (const :tag "Log using `message' to the *Messages* buffer" t)
          (function :tag "Function that takes arguments like `message'")
          (const :tag "Don't log anything" nil)))
Katsumi Yamaoka's avatar
Katsumi Yamaoka committed
169

170
(defcustom auth-sources '("~/.authinfo.gpg" "~/.authinfo")
Miles Bader's avatar
Miles Bader committed
171 172
  "List of authentication sources.

173 174 175 176 177 178
The default will get login and password information from
\"~/.authinfo.gpg\", which you should set up with the EPA/EPG
packages to be encrypted.  If that file doesn't exist, it will
try the unencrypted version \"~/.authinfo\".

See the auth.info manual for details.
179

Katsumi Yamaoka's avatar
Katsumi Yamaoka committed
180 181 182 183
Each entry is the authentication type with optional properties.

It's best to customize this with `M-x customize-variable' because the choices
can get pretty complex."
Miles Bader's avatar
Miles Bader committed
184
  :group 'auth-source
185
  :version "24.1" ;; No Gnus
Miles Bader's avatar
Miles Bader committed
186
  :type `(repeat :tag "Authentication Sources"
187 188 189
                 (choice
                  (string :tag "Just a file")
                  (const :tag "Default Secrets API Collection" 'default)
190
                  (const :tag "Login Secrets API Collection" "secrets:Login")
191 192 193 194 195 196 197 198 199 200 201
                  (const :tag "Temp Secrets API Collection" "secrets:session")
                  (list :tag "Source definition"
                        (const :format "" :value :source)
                        (choice :tag "Authentication backend choice"
                                (string :tag "Authentication Source (file)")
                                (list
                                 :tag "Secret Service API/KWallet/GNOME Keyring"
                                 (const :format "" :value :secrets)
                                 (choice :tag "Collection to use"
                                         (string :tag "Collection name")
                                         (const :tag "Default" 'default)
202
                                         (const :tag "Login" "Login")
203 204 205 206 207 208 209 210 211 212 213 214 215
                                         (const
                                          :tag "Temporary" "session"))))
                        (repeat :tag "Extra Parameters" :inline t
                                (choice :tag "Extra parameter"
                                        (list
                                         :tag "Host"
                                         (const :format "" :value :host)
                                         (choice :tag "Host (machine) choice"
                                                 (const :tag "Any" t)
                                                 (regexp
                                                  :tag "Regular expression")))
                                        (list
                                         :tag "Protocol"
216
                                         (const :format "" :value :port)
217 218 219 220 221 222 223 224 225
                                         (choice
                                          :tag "Protocol"
                                          (const :tag "Any" t)
                                          ,@auth-source-protocols-customize))
                                        (list :tag "User" :inline t
                                              (const :format "" :value :user)
                                              (choice :tag "Personality/Username"
                                                      (const :tag "Any" t)
                                                      (string :tag "Name")))))))))
Miles Bader's avatar
Miles Bader committed
226

227 228 229 230
(defcustom auth-source-gpg-encrypt-to t
  "List of recipient keys that `authinfo.gpg' encrypted to.
If the value is not a list, symmetric encryption will be used."
  :group 'auth-source
231
  :version "24.1" ;; No Gnus
232
  :type '(choice (const :tag "Symmetric encryption" t)
233 234
                 (repeat :tag "Recipient public keys"
                         (string :tag "Recipient public key"))))
235

Miles Bader's avatar
Miles Bader committed
236
;; temp for debugging
Miles Bader's avatar
Miles Bader committed
237 238 239 240 241 242 243 244
;; (unintern 'auth-source-protocols)
;; (unintern 'auth-sources)
;; (customize-variable 'auth-sources)
;; (setq auth-sources nil)
;; (format "%S" auth-sources)
;; (customize-variable 'auth-source-protocols)
;; (setq auth-source-protocols nil)
;; (format "%S" auth-source-protocols)
245
;; (auth-source-pick nil :host "a" :port 'imap)
Miles Bader's avatar
Miles Bader committed
246 247 248 249 250 251
;; (auth-source-user-or-password "login" "imap.myhost.com" 'imap)
;; (auth-source-user-or-password "password" "imap.myhost.com" 'imap)
;; (auth-source-user-or-password-imap "login" "imap.myhost.com")
;; (auth-source-user-or-password-imap "password" "imap.myhost.com")
;; (auth-source-protocol-defaults 'imap)

252 253 254
;; (let ((auth-source-debug 'debug)) (auth-source-do-debug "hello"))
;; (let ((auth-source-debug t)) (auth-source-do-debug "hello"))
;; (let ((auth-source-debug nil)) (auth-source-do-debug "hello"))
Katsumi Yamaoka's avatar
Katsumi Yamaoka committed
255 256
(defun auth-source-do-debug (&rest msg)
  (when auth-source-debug
257 258 259 260 261 262 263 264 265 266 267
    (apply 'auth-source-do-warn msg)))

(defun auth-source-do-warn (&rest msg)
  (apply
    ;; set logger to either the function in auth-source-debug or 'message
    ;; note that it will be 'message if auth-source-debug is nil
   (if (functionp auth-source-debug)
       auth-source-debug
     'message)
   msg))

Katsumi Yamaoka's avatar
Katsumi Yamaoka committed
268

269 270 271 272 273 274
;; (auth-source-pick nil :host "any" :port 'imap :user "joe")
;; (auth-source-pick t :host "any" :port 'imap :user "joe")
;; (setq auth-sources '((:source (:secrets default) :host t :port t :user "joe")
;;                   (:source (:secrets "session") :host t :port t :user "joe")
;;                   (:source (:secrets "Login") :host t :port t)
;;                   (:source "~/.authinfo.gpg" :host t :port t)))
275

276 277 278
;; (setq auth-sources '((:source (:secrets default) :host t :port t :user "joe")
;;                   (:source (:secrets "session") :host t :port t :user "joe")
;;                   (:source (:secrets "Login") :host t :port t)
279
;;                   ))
280

281
;; (setq auth-sources '((:source "~/.authinfo.gpg" :host t :port t)))
282

283 284
;; (auth-source-backend-parse "myfile.gpg")
;; (auth-source-backend-parse 'default)
285
;; (auth-source-backend-parse "secrets:Login")
286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327

(defun auth-source-backend-parse (entry)
  "Creates an auth-source-backend from an ENTRY in `auth-sources'."
  (auth-source-backend-parse-parameters
   entry
   (cond
    ;; take 'default and recurse to get it as a Secrets API default collection
    ;; matching any user, host, and protocol
    ((eq entry 'default)
     (auth-source-backend-parse '(:source (:secrets default))))
    ;; take secrets:XYZ and recurse to get it as Secrets API collection "XYZ"
    ;; matching any user, host, and protocol
    ((and (stringp entry) (string-match "^secrets:\\(.+\\)" entry))
     (auth-source-backend-parse `(:source (:secrets ,(match-string 1 entry)))))
    ;; take just a file name and recurse to get it as a netrc file
    ;; matching any user, host, and protocol
    ((stringp entry)
     (auth-source-backend-parse `(:source ,entry)))

    ;; a file name with parameters
    ((stringp (plist-get entry :source))
     (auth-source-backend
      (plist-get entry :source)
      :source (plist-get entry :source)
      :type 'netrc
      :search-function 'auth-source-netrc-search
      :create-function 'auth-source-netrc-create))

    ;; the Secrets API.  We require the package, in order to have a
    ;; defined value for `secrets-enabled'.
    ((and
      (not (null (plist-get entry :source))) ; the source must not be nil
      (listp (plist-get entry :source))      ; and it must be a list
      (require 'secrets nil t)               ; and we must load the Secrets API
      secrets-enabled)                       ; and that API must be enabled

     ;; the source is either the :secrets key in ENTRY or
     ;; if that's missing or nil, it's "session"
     (let ((source (or (plist-get (plist-get entry :source) :secrets)
                       "session")))

       ;; if the source is a symbol, we look for the alias named so,
328
       ;; and if that alias is missing, we use "Login"
329 330
       (when (symbolp source)
         (setq source (or (secrets-get-alias (symbol-name source))
331
                          "Login")))
332

333 334 335 336 337 338 339 340 341 342 343 344 345
       (if (featurep 'secrets)
           (auth-source-backend
            (format "Secrets API (%s)" source)
            :source source
            :type 'secrets
            :search-function 'auth-source-secrets-search
            :create-function 'auth-source-secrets-create)
         (auth-source-do-warn
          "auth-source-backend-parse: no Secrets API, ignoring spec: %S" entry)
         (auth-source-backend
          (format "Ignored Secrets API (%s)" source)
          :source ""
          :type 'ignore))))
346 347 348

    ;; none of them
    (t
349
     (auth-source-do-warn
350 351 352 353 354 355 356 357
      "auth-source-backend-parse: invalid backend spec: %S" entry)
     (auth-source-backend
      "Empty"
      :source ""
      :type 'ignore)))))

(defun auth-source-backend-parse-parameters (entry backend)
  "Fills in the extra auth-source-backend parameters of ENTRY.
358 359
Using the plist ENTRY, get the :host, :port, and :user search
parameters."
360 361 362 363
  (let ((entry (if (stringp entry)
                   nil
                 entry))
        val)
364 365 366 367
    (when (setq val (plist-get entry :host))
      (oset backend host val))
    (when (setq val (plist-get entry :user))
      (oset backend user val))
368 369
    (when (setq val (plist-get entry :port))
      (oset backend port val)))
370 371 372 373 374
  backend)

;; (mapcar 'auth-source-backend-parse auth-sources)

(defun* auth-source-search (&rest spec
375
                                  &key type max host user port secret
376 377 378 379 380 381 382 383 384 385 386 387
                                  create delete
                                  &allow-other-keys)
  "Search or modify authentication backends according to SPEC.

This function parses `auth-sources' for matches of the SPEC
plist.  It can optionally create or update an authentication
token if requested.  A token is just a standard Emacs property
list with a :secret property that can be a function; all the
other properties will always hold scalar values.

Typically the :secret property, if present, contains a password.

388
Common search keys are :max, :host, :port, and :user.  In
389 390 391 392 393 394 395 396 397 398 399 400 401
addition, :create specifies how tokens will be or created.
Finally, :type can specify which backend types you want to check.

A string value is always matched literally.  A symbol is matched
as its string value, literally.  All the SPEC values can be
single values (symbol or string) or lists thereof (in which case
any of the search terms matches).

:create t means to create a token if possible.

A new token will be created if no matching tokens were found.
The new token will have only the keys the backend requires.  For
the netrc backend, for instance, that's the user, host, and
402
port keys.
403 404 405 406 407 408 409 410 411 412 413 414 415 416 417

Here's an example:

\(let ((auth-source-creation-defaults '((user . \"defaultUser\")
                                        (A    . \"default A\"))))
  (auth-source-search :host \"mine\" :type 'netrc :max 1
                      :P \"pppp\" :Q \"qqqq\"
                      :create t))

which says:

\"Search for any entry matching host 'mine' in backends of type
 'netrc', maximum one result.

 Create a new entry if you found none.  The netrc backend will
418
 automatically require host, user, and port.  The host will be
419
 'mine'.  We prompt for the user with default 'defaultUser' and
420
 for the port without a default.  We will not prompt for A, Q,
421
 or P.  The resulting token will only have keys user, host, and
422
 port.\"
423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446

:create '(A B C) also means to create a token if possible.

The behavior is like :create t but if the list contains any
parameter, that parameter will be required in the resulting
token.  The value for that parameter will be obtained from the
search parameters or from user input.  If any queries are needed,
the alist `auth-source-creation-defaults' will be checked for the
default prompt.

Here's an example:

\(let ((auth-source-creation-defaults '((user . \"defaultUser\")
                                        (A    . \"default A\"))))
  (auth-source-search :host '(\"nonesuch\" \"twosuch\") :type 'netrc :max 1
                      :P \"pppp\" :Q \"qqqq\"
                      :create '(A B Q)))

which says:

\"Search for any entry matching host 'nonesuch'
 or 'twosuch' in backends of type 'netrc', maximum one result.

 Create a new entry if you found none.  The netrc backend will
447
 automatically require host, user, and port.  The host will be
448
 'nonesuch' and Q will be 'qqqq'.  We prompt for A with default
449
 'default A', for B and port with default nil, and for the
450
 user with default 'defaultUser'.  We will not prompt for Q.  The
451
 resulting token will have keys user, host, port, A, B, and Q.
452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482
 It will not have P with any value, even though P is used in the
 search to find only entries that have P set to 'pppp'.\"

When multiple values are specified in the search parameter, the
first one is used for creation.  So :host (X Y Z) would create a
token for host X, for instance.

This creation can fail if the search was not specific enough to
create a new token (it's up to the backend to decide that).  You
should `catch' the backend-specific error as usual.  Some
backends (netrc, at least) will prompt the user rather than throw
an error.

:delete t means to delete any found entries.  nil by default.
Use `auth-source-delete' in ELisp code instead of calling
`auth-source-search' directly with this parameter.

:type (X Y Z) will check only those backend types.  'netrc and
'secrets are the only ones supported right now.

:max N means to try to return at most N items (defaults to 1).
When 0 the function will return just t or nil to indicate if any
matches were found.  More than N items may be returned, depending
on the search and the backend.

:host (X Y Z) means to match only hosts X, Y, or Z according to
the match rules above.  Defaults to t.

:user (X Y Z) means to match only users X, Y, or Z according to
the match rules above.  Defaults to t.

483
:port (P Q R) means to match only protocols P, Q, or R.
484 485 486 487 488 489
Defaults to t.

:K (V1 V2 V3) for any other key K will match values V1, V2, or
V3 (note the match rules above).

The return value is a list with at most :max tokens.  Each token
490
is a plist with keys :backend :host :port :user, plus any other
491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511
keys provided by the backend (notably :secret).  But note the
exception for :max 0, which see above.

The token's :secret key can hold a function.  In that case you
must call it to obtain the actual value."
  (let* ((backends (mapcar 'auth-source-backend-parse auth-sources))
         (max (or max 1))
         (ignored-keys '(:create :delete :max))
         (keys (loop for i below (length spec) by 2
                     unless (memq (nth i spec) ignored-keys)
                     collect (nth i spec)))
         (found (auth-source-recall spec))
         filtered-backends accessor-key found-here goal)

    (if (and found auth-source-do-cache)
        (auth-source-do-debug
         "auth-source-search: found %d CACHED results matching %S"
         (length found) spec)

      (assert
       (or (eq t create) (listp create)) t
512
       "Invalid auth-source :create parameter (must be nil, t, or a list): %s %s")
513

514
      (setq filtered-backends (copy-sequence backends))
515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589
      (dolist (backend backends)
        (dolist (key keys)
          ;; ignore invalid slots
          (condition-case signal
              (unless (eval `(auth-source-search-collection
                              (plist-get spec key)
                              (oref backend ,key)))
                (setq filtered-backends (delq backend filtered-backends))
                (return))
            (invalid-slot-name))))

      (auth-source-do-debug
       "auth-source-search: found %d backends matching %S"
       (length filtered-backends) spec)

      ;; (debug spec "filtered" filtered-backends)
      (setq goal max)
      (dolist (backend filtered-backends)
        (setq found-here (apply
                          (slot-value backend 'search-function)
                          :backend backend
                          :create create
                          :delete delete
                          spec))

        ;; if max is 0, as soon as we find something, return it
        (when (and (zerop max) (> 0 (length found-here)))
          (return t))

        ;; decrement the goal by the number of new results
        (decf goal (length found-here))
        ;; and append the new results to the full list
        (setq found (append found found-here))

        (auth-source-do-debug
         "auth-source-search: found %d results (max %d/%d) in %S matching %S"
         (length found-here) max goal backend spec)

        ;; return full list if the goal is 0 or negative
        (when (zerop (max 0 goal))
          (return found))

        ;; change the :max parameter in the spec to the goal
        (setq spec (plist-put spec :max goal)))

      (when (and found auth-source-do-cache)
        (auth-source-remember spec found)))

      found))

;;; (auth-source-search :max 1)
;;; (funcall (plist-get (nth 0 (auth-source-search :max 1)) :secret))
;;; (auth-source-search :host "nonesuch" :type 'netrc :K 1)
;;; (auth-source-search :host "nonesuch" :type 'secrets)

(defun* auth-source-delete (&rest spec
                                  &key delete
                                  &allow-other-keys)
  "Delete entries from the authentication backends according to SPEC.
Calls `auth-source-search' with the :delete property in SPEC set to t.
The backend may not actually delete the entries.

Returns the deleted entries."
  (auth-source-search (plist-put spec :delete t)))

(defun auth-source-search-collection (collection value)
  "Returns t is VALUE is t or COLLECTION is t or contains VALUE."
  (when (and (atom collection) (not (eq t collection)))
    (setq collection (list collection)))

  ;; (debug :collection collection :value value)
  (or (eq collection t)
      (eq value t)
      (equal collection value)
      (member value collection)))
Miles Bader's avatar
Miles Bader committed
590

Miles Bader's avatar
Miles Bader committed
591
(defun auth-source-forget-all-cached ()
592
  "Forget all cached auth-source data."
Miles Bader's avatar
Miles Bader committed
593
  (interactive)
594 595 596 597 598 599 600 601 602
  (loop for sym being the symbols of password-data
        ;; when the symbol name starts with auth-source-magic
        when (string-match (concat "^" auth-source-magic)
                           (symbol-name sym))
        ;; remove that key
        do (password-cache-remove (symbol-name sym))))

(defun auth-source-remember (spec found)
  "Remember FOUND search results for SPEC."
603 604 605
  (let ((password-cache-expiry auth-source-cache-expiry))
    (password-cache-add
     (concat auth-source-magic (format "%S" spec)) found)))
606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663

(defun auth-source-recall (spec)
  "Recall FOUND search results for SPEC."
  (password-read-from-cache
   (concat auth-source-magic (format "%S" spec))))

(defun auth-source-forget (spec)
  "Forget any cached data matching SPEC exactly.

This is the same SPEC you passed to `auth-source-search'.
Returns t or nil for forgotten or not found."
  (password-cache-remove (concat auth-source-magic (format "%S" spec))))

;;; (loop for sym being the symbols of password-data when (string-match (concat "^" auth-source-magic) (symbol-name sym)) collect (symbol-name sym))

;;; (auth-source-remember '(:host "wedd") '(4 5 6))
;;; (auth-source-remember '(:host "xedd") '(1 2 3))
;;; (auth-source-recall '(:host "xedd"))
;;; (auth-source-recall '(:host t))
;;; (auth-source-forget+ :host t)

(defun* auth-source-forget+ (&rest spec &allow-other-keys)
  "Forget any cached data matching SPEC.  Returns forgotten count.

This is not a full `auth-source-search' spec but works similarly.
For instance, \(:host \"myhost\" \"yourhost\") would find all the
cached data that was found with a search for those two hosts,
while \(:host t) would find all host entries."
  (let ((count 0)
        sname)
    (loop for sym being the symbols of password-data
          ;; when the symbol name matches with auth-source-magic
          when (and (setq sname (symbol-name sym))
                    (string-match (concat "^" auth-source-magic "\\(.+\\)")
                                  sname)
                    ;; and the spec matches what was stored in the cache
                    (auth-source-specmatchp spec (read (match-string 1 sname))))
          ;; remove that key
          do (progn
               (password-cache-remove sname)
               (incf count)))
    count))

(defun auth-source-specmatchp (spec stored)
  (let ((keys (loop for i below (length spec) by 2
                   collect (nth i spec))))
    (not (eq
          (dolist (key keys)
            (unless (auth-source-search-collection (plist-get stored key)
                                                   (plist-get spec key))
              (return 'no)))
          'no))))

;;; Backend specific parsing: netrc/authinfo backend

;;; (auth-source-netrc-parse "~/.authinfo.gpg")
(defun* auth-source-netrc-parse (&rest
                                 spec
664
                                 &key file max host user port delete
665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725
                                 &allow-other-keys)
  "Parse FILE and return a list of all entries in the file.
Note that the MAX parameter is used so we can exit the parse early."
  (if (listp file)
      ;; We got already parsed contents; just return it.
      file
    (when (file-exists-p file)
      (with-temp-buffer
        (let ((tokens '("machine" "host" "default" "login" "user"
                        "password" "account" "macdef" "force"
                        "port" "protocol"))
              (max (or max 5000))       ; sanity check: default to stop at 5K
              (modified 0)
              alist elem result pair)
          (insert-file-contents file)
          (goto-char (point-min))
          ;; Go through the file, line by line.
          (while (and (not (eobp))
                      (> max 0))

            (narrow-to-region (point) (point-at-eol))
            ;; For each line, get the tokens and values.
            (while (not (eobp))
              (skip-chars-forward "\t ")
              ;; Skip lines that begin with a "#".
              (if (eq (char-after) ?#)
                  (goto-char (point-max))
                (unless (eobp)
                  (setq elem
                        (if (= (following-char) ?\")
                            (read (current-buffer))
                          (buffer-substring
                           (point) (progn (skip-chars-forward "^\t ")
                                          (point)))))
                  (cond
                   ((equal elem "macdef")
                    ;; We skip past the macro definition.
                    (widen)
                    (while (and (zerop (forward-line 1))
                                (looking-at "$")))
                    (narrow-to-region (point) (point)))
                   ((member elem tokens)
                    ;; Tokens that don't have a following value are ignored,
                    ;; except "default".
                    (when (and pair (or (cdr pair)
                                        (equal (car pair) "default")))
                      (push pair alist))
                    (setq pair (list elem)))
                   (t
                    ;; Values that haven't got a preceding token are ignored.
                    (when pair
                      (setcdr pair elem)
                      (push pair alist)
                      (setq pair nil)))))))

            (when (and alist
                       (> max 0)
                       (auth-source-search-collection
                        host
                        (or
                         (aget alist "machine")
726 727
                         (aget alist "host")
                         t))
728 729 730 731 732
                       (auth-source-search-collection
                        user
                        (or
                         (aget alist "login")
                         (aget alist "account")
733 734
                         (aget alist "user")
                         t))
735
                       (auth-source-search-collection
736
                        port
737 738
                        (or
                         (aget alist "port")
739 740
                         (aget alist "protocol")
                         t)))
741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805
              (decf max)
              (push (nreverse alist) result)
              ;; to delete a line, we just comment it out
              (when delete
                (goto-char (point-min))
                (insert "#")
                (incf modified)))
            (setq alist nil
                  pair nil)
            (widen)
            (forward-line 1))

          (when (< 0 modified)
            (when auth-source-gpg-encrypt-to
              ;; (see bug#7487) making `epa-file-encrypt-to' local to
              ;; this buffer lets epa-file skip the key selection query
              ;; (see the `local-variable-p' check in
              ;; `epa-file-write-region').
              (unless (local-variable-p 'epa-file-encrypt-to (current-buffer))
                (make-local-variable 'epa-file-encrypt-to))
              (if (listp auth-source-gpg-encrypt-to)
                  (setq epa-file-encrypt-to auth-source-gpg-encrypt-to)))

            ;; ask AFTER we've successfully opened the file
            (when (y-or-n-p (format "Save file %s? (%d modifications)"
                                    file modified))
              (write-region (point-min) (point-max) file nil 'silent)
              (auth-source-do-debug
               "auth-source-netrc-parse: modified %d lines in %s"
               modified file)))

          (nreverse result))))))

(defun auth-source-netrc-normalize (alist)
  (mapcar (lambda (entry)
            (let (ret item)
              (while (setq item (pop entry))
                (let ((k (car item))
                      (v (cdr item)))

                  ;; apply key aliases
                  (setq k (cond ((member k '("machine")) "host")
                                ((member k '("login" "account")) "user")
                                ((member k '("protocol")) "port")
                                ((member k '("password")) "secret")
                                (t k)))

                  ;; send back the secret in a function (lexical binding)
                  (when (equal k "secret")
                    (setq v (lexical-let ((v v))
                              (lambda () v))))

                  (setq ret (plist-put ret
                                       (intern (concat ":" k))
                                       v))
                  ))
              ret))
          alist))

;;; (setq secret (plist-get (nth 0 (auth-source-search :host t :type 'netrc :K 1 :max 1)) :secret))
;;; (funcall secret)

(defun* auth-source-netrc-search (&rest
                                  spec
                                  &key backend create delete
806
                                  type max host user port
807 808 809 810 811
                                  &allow-other-keys)
"Given a property list SPEC, return search matches from the :backend.
See `auth-source-search' for details on SPEC."
  ;; just in case, check that the type is correct (null or same as the backend)
  (assert (or (null type) (eq type (oref backend type)))
812
          t "Invalid netrc search: %s %s")
813 814 815 816 817 818 819 820

  (let ((results (auth-source-netrc-normalize
                  (auth-source-netrc-parse
                   :max max
                   :delete delete
                   :file (oref backend source)
                   :host (or host t)
                   :user (or user t)
821
                   :port (or port t)))))
822 823 824 825 826

    ;; if we need to create an entry AND none were found to match
    (when (and create
               (= 0 (length results)))

827 828 829 830 831 832 833 834 835 836 837
      ;; create based on the spec and record the value
      (setq results (or
                     ;; if the user did not want to create the entry
                     ;; in the file, it will be returned
                     (apply (slot-value backend 'create-function) spec)
                     ;; if not, we do the search again without :create
                     ;; to get the updated data.

                     ;; the result will be returned, even if the search fails
                     (apply 'auth-source-netrc-search
                            (plist-put spec :create nil)))))
838 839 840 841 842 843 844
    results))

;;; (auth-source-search :host "nonesuch" :type 'netrc :max 1 :create t)
;;; (auth-source-search :host "nonesuch" :type 'netrc :max 1 :create t :create-extra-keys '((A "default A") (B)))

(defun* auth-source-netrc-create (&rest spec
                                        &key backend
845
                                        secret host user port create
846
                                        &allow-other-keys)
847
  (let* ((base-required '(host user port secret))
848 849 850 851 852 853 854
         ;; we know (because of an assertion in auth-source-search) that the
         ;; :create parameter is either t or a list (which includes nil)
         (create-extra (if (eq t create) nil create))
         (required (append base-required create-extra))
         (file (oref backend source))
         (add "")
         ;; `valist' is an alist
855 856 857
         valist
         ;; `artificial' will be returned if no creation is needed
         artificial)
858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885

    ;; only for base required elements (defined as function parameters):
    ;; fill in the valist with whatever data we may have from the search
    ;; we take the first value if it's a list, the whole value otherwise
    (dolist (br base-required)
      (when (symbol-value br)
        (aput 'valist br (if (listp (symbol-value br))
                             (nth 0 (symbol-value br))
                           (symbol-value br)))))

    ;; for extra required elements, see if the spec includes a value for them
    (dolist (er create-extra)
      (let ((name (concat ":" (symbol-name er)))
            (keys (loop for i below (length spec) by 2
                        collect (nth i spec))))
        (dolist (k keys)
          (when (equal (symbol-name k) name)
            (aput 'valist er (plist-get spec k))))))

    ;; for each required element
    (dolist (r required)
      (let* ((data (aget valist r))
             (given-default (aget auth-source-creation-defaults r))
             ;; the defaults are simple
             (default (cond
                       ((and (not given-default) (eq r 'user))
                        (user-login-name))
                       ;; note we need this empty string
886
                       ((and (not given-default) (eq r 'port))
887 888 889 890 891 892 893 894 895
                        "")
                       (t given-default)))
             ;; the prompt's default string depends on the data so far
             (default-string (if (and default (< 0 (length default)))
                                 (format " (default %s)" default)
                               " (no default)"))
             ;; the prompt should also show what's entered so far
             (user-value (aget valist 'user))
             (host-value (aget valist 'host))
896
             (port-value (aget valist 'port))
897 898 899 900 901 902
             (info-so-far (concat (if user-value
                                      (format "%s@" user-value)
                                    "[USER?]")
                                  (if host-value
                                      (format "%s" host-value)
                                    "[HOST?]")
903
                                  (if port-value
904
                                      ;; this distinguishes protocol between
905
                                      (if (zerop (length port-value))
906
                                          "" ; 'entered as "no default"' vs.
907
                                        (format ":%s" port-value)) ; given
908
                                    ;; and this is when the protocol is unknown
909
                                    "[PORT?]"))))
Miles Bader's avatar
Miles Bader committed
910

911 912 913 914 915 916 917 918 919 920 921 922 923 924 925
        ;; now prompt if the search SPEC did not include a required key;
        ;; take the result and put it in `data' AND store it in `valist'
        (aput 'valist r
              (setq data
                    (cond
                     ((and (null data) (eq r 'secret))
                      ;; special case prompt for passwords
                      (read-passwd (format "Password for %s: " info-so-far)))
                     ((null data)
                      (read-string
                       (format "Enter %s for %s%s: "
                               r info-so-far default-string)
                       nil nil default))
                     (t data))))

926 927 928 929 930 931 932 933
        (when data
          (setq artificial (plist-put artificial
                                      (intern (concat ":" (symbol-name r)))
                                      (if (eq r 'secret)
                                          (lexical-let ((data data))
                                            (lambda () data))
                                        data))))

934 935 936 937 938 939 940 941 942 943 944 945 946
        ;; when r is not an empty string...
        (when (and (stringp data)
                   (< 0 (length data)))
          ;; append the key (the symbol name of r) and the value in r
          (setq add (concat add
                            (format "%s%s %S"
                                    ;; prepend a space
                                    (if (zerop (length add)) "" " ")
                                    ;; remap auth-source tokens to netrc
                                    (case r
                                     ('user "login")
                                     ('host "machine")
                                     ('secret "password")
947
                                     ('port "port") ; redundant but clearer
948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966
                                     (t (symbol-name r)))
                                    ;; the value will be printed in %S format
                                    data))))))

    (with-temp-buffer
      (when (file-exists-p file)
        (insert-file-contents file))
      (when auth-source-gpg-encrypt-to
        ;; (see bug#7487) making `epa-file-encrypt-to' local to
        ;; this buffer lets epa-file skip the key selection query
        ;; (see the `local-variable-p' check in
        ;; `epa-file-write-region').
        (unless (local-variable-p 'epa-file-encrypt-to (current-buffer))
          (make-local-variable 'epa-file-encrypt-to))
        (if (listp auth-source-gpg-encrypt-to)
            (setq epa-file-encrypt-to auth-source-gpg-encrypt-to)))
      (goto-char (point-max))

      ;; ask AFTER we've successfully opened the file
967 968 969 970 971 972 973 974 975 976 977
      (if (y-or-n-p (format "Add to file %s: line [%s]" file add))
          (progn
            (unless (bolp)
              (insert "\n"))
            (insert add "\n")
            (write-region (point-min) (point-max) file nil 'silent)
            (auth-source-do-debug
             "auth-source-netrc-create: wrote 1 new line to %s"
             file)
            nil)
        (list artificial)))))
978 979 980 981 982 983 984

;;; Backend specific parsing: Secrets API backend

;;; (let ((auth-sources '(default))) (auth-source-search :max 1 :create t))
;;; (let ((auth-sources '(default))) (auth-source-search :max 1 :delete t))
;;; (let ((auth-sources '(default))) (auth-source-search :max 1))
;;; (let ((auth-sources '(default))) (auth-source-search))
985 986
;;; (let ((auth-sources '("secrets:Login"))) (auth-source-search :max 1))
;;; (let ((auth-sources '("secrets:Login"))) (auth-source-search :max 1 :signon_realm "https://git.gnus.org/Git"))
987 988 989 990

(defun* auth-source-secrets-search (&rest
                                    spec
                                    &key backend create delete label
991
                                    type max host user port
992 993 994 995 996 997 998 999 1000 1001 1002 1003
                                    &allow-other-keys)
  "Search the Secrets API; spec is like `auth-source'.

The :label key specifies the item's label.  It is the only key
that can specify a substring.  Any :label value besides a string
will allow any label.

All other search keys must match exactly.  If you need substring
matching, do a wider search and narrow it down yourself.

You'll get back all the properties of the token as a plist.

1004
Here's an example that looks for the first item in the 'Login'
1005 1006
Secrets collection:

1007
 \(let ((auth-sources '(\"secrets:Login\")))
1008 1009
    (auth-source-search :max 1)

1010
Here's another that looks for the first item in the 'Login'
1011 1012
Secrets collection whose label contains 'gnus':

1013
 \(let ((auth-sources '(\"secrets:Login\")))
1014 1015
    (auth-source-search :max 1 :label \"gnus\")

1016
And this one looks for the first item in the 'Login' Secrets
1017
collection that's a Google Chrome entry for the git.gnus.org site
1018
authentication tokens:
1019

1020
 \(let ((auth-sources '(\"secrets:Login\")))
1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039
    (auth-source-search :max 1 :signon_realm \"https://git.gnus.org/Git\"))
"

  ;; TODO
  (assert (not create) nil
          "The Secrets API auth-source backend doesn't support creation yet")
  ;; TODO
  ;; (secrets-delete-item coll elt)
  (assert (not delete) nil
          "The Secrets API auth-source backend doesn't support deletion yet")

  (let* ((coll (oref backend source))
         (max (or max 5000))     ; sanity check: default to stop at 5K
         (ignored-keys '(:create :delete :max :backend :label))
         (search-keys (loop for i below (length spec) by 2
                            unless (memq (nth i spec) ignored-keys)
                            collect (nth i spec)))
         ;; build a search spec without the ignored keys
         ;; if a search key is nil or t (match anything), we skip it
1040 1041 1042 1043 1044 1045 1046
         (search-spec (apply 'append (mapcar
                                      (lambda (k)
                                        (if (or (null (plist-get spec k))
                                                (eq t (plist-get spec k)))
                                            nil
                                          (list k (plist-get spec k))))
                              search-keys)))
1047
         ;; needed keys (always including host, login, port, and secret)
1048
         (returned-keys (mm-delete-duplicates (append
1049
					       '(:host :login :port :secret)
1050
					       search-keys)))
1051 1052 1053 1054 1055
         (items (loop for item in (apply 'secrets-search-items coll search-spec)
                      unless (and (stringp label)
                                  (not (string-match label item)))
                      collect item))
         ;; TODO: respect max in `secrets-search-items', not after the fact
1056
         (items (butlast items (- (length items) max)))
1057 1058 1059 1060 1061 1062 1063 1064 1065
         ;; convert the item name to a full plist
         (items (mapcar (lambda (item)
                          (append
                           ;; make an entry for the secret (password) element
                           (list
                            :secret
                            (lexical-let ((v (secrets-get-secret coll item)))
                              (lambda () v)))
                           ;; rewrite the entry from ((k1 v1) (k2 v2)) to plist
1066 1067 1068 1069
                           (apply 'append
                                  (mapcar (lambda (entry)
                                            (list (car entry) (cdr entry)))
                                          (secrets-get-attributes coll item)))))
1070 1071 1072 1073
                        items))
         ;; ensure each item has each key in `returned-keys'
         (items (mapcar (lambda (plist)
                          (append
1074 1075 1076 1077 1078 1079
                           (apply 'append
                                  (mapcar (lambda (req)
                                            (if (plist-get plist req)
                                                nil
                                              (list req nil)))
                                          returned-keys))
1080 1081 1082 1083 1084 1085
                           plist))
                        items)))
    items))

(defun* auth-source-secrets-create (&rest
                                    spec
1086
                                    &key backend type max host user port
1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100
                                    &allow-other-keys)
  ;; TODO
  ;; (apply 'secrets-create-item (auth-get-source entry) name passwd spec)
  (debug spec))

;;; older API

;;; (auth-source-user-or-password '("login" "password") "imap.myhost.com" t "tzz")

;; deprecate the old interface
(make-obsolete 'auth-source-user-or-password
               'auth-source-search "Emacs 24.1")
(make-obsolete 'auth-source-forget-user-or-password
               'auth-source-forget "Emacs 24.1")
1101

1102
(defun auth-source-user-or-password
1103 1104
  (mode host port &optional username create-missing delete-existing)
  "Find MODE (string or list of strings) matching HOST and PORT.
1105

1106 1107
DEPRECATED in favor of `auth-source-search'!

1108 1109 1110 1111 1112 1113
USERNAME is optional and will be used as \"login\" in a search
across the Secret Service API (see secrets.el) if the resulting
items don't have a username.  This means that if you search for
username \"joe\" and it matches an item but the item doesn't have
a :user attribute, the username \"joe\" will be returned.

1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124
A non nil DELETE-EXISTING means deleting any matching password
entry in the respective sources.  This is useful only when
CREATE-MISSING is non nil as well; the intended use case is to
remove wrong password entries.

If no matching entry is found, and CREATE-MISSING is non nil,
the password will be retrieved interactively, and it will be
stored in the password database which matches best (see
`auth-sources').

MODE can be \"login\" or \"password\"."
Katsumi Yamaoka's avatar
Katsumi Yamaoka committed
1125
  (auth-source-do-debug
1126
   "auth-source-user-or-password: DEPRECATED get %s for %s (%s) + user=%s"
1127
   mode host port username)
1128

Miles Bader's avatar
Miles Bader committed
1129
  (let* ((listy (listp mode))
1130 1131
         (mode (if listy mode (list mode)))
         (cname (if username
1132 1133 1134
                    (format "%s %s:%s %s" mode host port username)
                  (format "%s %s:%s" mode host port)))
         (search (list :host host :port port))
1135
         (search (if username (append search (list :user username)) search))
1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146
         (search (if create-missing
                     (append search (list :create t))
                   search))
         (search (if delete-existing
                     (append search (list :delete t))
                   search))
         ;; (found (if (not delete-existing)
         ;;            (gethash cname auth-source-cache)
         ;;          (remhash cname auth-source-cache)
         ;;          nil)))
         (found nil))
Miles Bader's avatar
Miles Bader committed
1147
    (if found
1148 1149
        (progn
          (auth-source-do-debug
1150
           "auth-source-user-or-password: DEPRECATED cached %s=%s for %s (%s) + %s"
1151 1152
           mode
           ;; don't show the password
1153
           (if (and (member "password" mode) t)
1154 1155
               "SECRET"
             found)
1156
           host port username)
1157
          found)                        ; return the found data
1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171
      ;; else, if not found, search with a max of 1
      (let ((choice (nth 0 (apply 'auth-source-search
                                  (append '(:max 1) search)))))
        (when choice
          (dolist (m mode)
            (cond
             ((equal "password" m)
              (push (if (plist-get choice :secret)
                      (funcall (plist-get choice :secret))
                    nil) found))
             ((equal "login" m)
              (push (plist-get choice :user) found)))))
        (setq found (nreverse found))
        (setq found (if listy found (car-safe found)))))
Miles Bader's avatar
Miles Bader committed
1172

1173
        found))
Miles Bader's avatar
Miles Bader committed
1174 1175 1176 1177

(provide 'auth-source)

;;; auth-source.el ends here