1 ;;; auth-source.el --- authentication sources for Gnus and Emacs
3 ;; Copyright (C) 2008 Free Software Foundation, Inc.
5 ;; Author: Ted Zlatanov <tzz@lifelogs.com>
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;; This is the auth-source.el package. It lets users tell Gnus how to
26 ;; authenticate in a single place. Simplicity is the goal. Instead
27 ;; of providing 5000 options, we'll stick to simple, easy to
28 ;; understand options.
31 ;; (require 'auth-source)
32 ;; (customize-variable 'auth-sources) ;; optional
34 ;; now, whatever sources you've defined for password have to be available
36 ;; if you want encrypted sources, which is strongly recommended, do
37 ;; (require 'epa-file)
39 ;; (setq epa-file-cache-passphrase-for-symmetric-encryption t) ; VERY important
41 ;; before you put some data in ~/.authinfo.gpg (the default place)
43 ;;; For url-auth authentication (HTTP/HTTPS), you need to use:
45 ;;; machine yourmachine.com:80 port http login testuser password testpass
47 ;;; This will match any realm and authentication method (basic or
48 ;;; digest). If you want finer controls, explore the url-auth source
49 ;;; code and variables.
51 ;;; For tramp authentication, use:
53 ;;; machine yourmachine.com port scp login testuser password testpass
55 ;;; Note that the port denotes the Tramp connection method. When you
56 ;;; don't use a port entry, you match any Tramp method.
62 (eval-when-compile (require 'cl))
63 (eval-when-compile (require 'netrc))
65 (defgroup auth-source nil
66 "Authentication sources."
67 :version "23.1" ;; No Gnus
70 (defcustom auth-source-protocols '((imap "imap" "imaps" "143" "993")
71 (pop3 "pop3" "pop" "pop3s" "110" "995")
75 "List of authentication protocols and their names"
78 :version "23.1" ;; No Gnus
79 :type '(repeat :tag "Authentication Protocols"
80 (cons :tag "Protocol Entry"
81 (symbol :tag "Protocol")
83 (string :tag "Name")))))
85 ;;; generate all the protocols in a format Customize can use
86 (defconst auth-source-protocols-customize
88 (let ((p (car-safe a)))
90 :tag (upcase (symbol-name p))
92 auth-source-protocols))
94 (defvar auth-source-cache (make-hash-table :test 'equal)
95 "Cache for auth-source data")
97 (defcustom auth-source-do-cache t
98 "Whether auth-source should cache information."
100 :version "23.1" ;; No Gnus
103 (defcustom auth-sources '((:source "~/.authinfo.gpg" :host t :protocol t))
104 "List of authentication sources.
106 Each entry is the authentication type with optional properties."
108 :version "23.1" ;; No Gnus
109 :type `(repeat :tag "Authentication Sources"
110 (list :tag "Source definition"
111 (const :format "" :value :source)
112 (string :tag "Authentication Source")
113 (const :format "" :value :host)
114 (choice :tag "Host (machine) choice"
116 (regexp :tag "Host (machine) regular expression (TODO)")
117 (const :tag "Fallback" nil))
118 (const :format "" :value :protocol)
119 (choice :tag "Protocol"
121 (const :tag "Fallback" nil)
122 ,@auth-source-protocols-customize))))
124 ;; temp for debugging
125 ;; (unintern 'auth-source-protocols)
126 ;; (unintern 'auth-sources)
127 ;; (customize-variable 'auth-sources)
128 ;; (setq auth-sources nil)
129 ;; (format "%S" auth-sources)
130 ;; (customize-variable 'auth-source-protocols)
131 ;; (setq auth-source-protocols nil)
132 ;; (format "%S" auth-source-protocols)
133 ;; (auth-source-pick "a" 'imap)
134 ;; (auth-source-user-or-password "login" "imap.myhost.com" 'imap)
135 ;; (auth-source-user-or-password "password" "imap.myhost.com" 'imap)
136 ;; (auth-source-user-or-password-imap "login" "imap.myhost.com")
137 ;; (auth-source-user-or-password-imap "password" "imap.myhost.com")
138 ;; (auth-source-protocol-defaults 'imap)
140 (defun auth-source-pick (host protocol &optional fallback)
141 "Parse `auth-sources' for HOST, and PROTOCOL matches.
143 Returns fallback choices (where PROTOCOL or HOST are nil) with FALLBACK t."
144 (interactive "sHost: \nsProtocol: \n") ;for testing
146 (dolist (choice auth-sources)
147 (let ((h (plist-get choice :host))
148 (p (plist-get choice :protocol)))
151 (and (stringp h) (string-match h host))
152 (and fallback (equal h nil)))
154 (and (symbolp p) (equal p protocol))
155 (and fallback (equal p nil))))
156 (push choice choices))))
160 (auth-source-pick host protocol t)))))
162 (defun auth-source-forget-user-or-password (mode host protocol)
163 (interactive "slogin/password: \nsHost: \nsProtocol: \n") ;for testing
164 (remhash (format "%s %s:%s" mode host protocol) auth-source-cache))
166 (defun auth-source-user-or-password (mode host protocol)
167 "Find user or password (from the string MODE) matching HOST and PROTOCOL."
169 "auth-source-user-or-password: get %s for %s (%s)"
171 (let* ((cname (format "%s %s:%s" mode host protocol))
172 (found (gethash cname auth-source-cache)))
176 "auth-source-user-or-password: cached %s=%s for %s (%s)"
178 ;; don't show the password
179 (if (equal mode "password") "SECRET" found)
182 (dolist (choice (auth-source-pick host protocol))
183 (setq found (netrc-machine-user-or-password
185 (plist-get choice :source)
187 (list (format "%s" protocol))
188 (auth-source-protocol-defaults protocol)))
191 "auth-source-user-or-password: found %s=%s for %s (%s)"
193 ;; don't show the password
194 (if (equal mode "password") "SECRET" found)
196 (when auth-source-do-cache
197 (puthash cname found auth-source-cache)))
200 (defun auth-source-protocol-defaults (protocol)
201 "Return a list of default ports and names for PROTOCOL."
202 (cdr-safe (assoc protocol auth-source-protocols)))
204 (defun auth-source-user-or-password-imap (mode host)
205 (auth-source-user-or-password mode host 'imap))
207 (defun auth-source-user-or-password-pop3 (mode host)
208 (auth-source-user-or-password mode host 'pop3))
210 (defun auth-source-user-or-password-ssh (mode host)
211 (auth-source-user-or-password mode host 'ssh))
213 (defun auth-source-user-or-password-sftp (mode host)
214 (auth-source-user-or-password mode host 'sftp))
216 (defun auth-source-user-or-password-smtp (mode host)
217 (auth-source-user-or-password mode host 'smtp))
219 (provide 'auth-source)
221 ;; arch-tag: ff1afe78-06e9-42c2-b693-e9f922cbe4ab
222 ;;; auth-source.el ends here