Mercurial > emacs
annotate lisp/gnus/auth-source.el @ 105741:90bde63d7310
(file-cache-completions-keymap): Bind mouse-2 to
file-cache-choose-completion.
(file-cache-choose-completion): Handle an optional event argument.
(file-cache-mouse-choose-completion): Make it an obsolete alias.
author | Glenn Morris <rgm@gnu.org> |
---|---|
date | Sat, 24 Oct 2009 03:51:51 +0000 |
parents | aa77db41a051 |
children | 1d1d5d9bd884 |
rev | line source |
---|---|
92694 | 1 ;;; auth-source.el --- authentication sources for Gnus and Emacs |
2 | |
100908 | 3 ;; Copyright (C) 2008, 2009 Free Software Foundation, Inc. |
92694 | 4 |
5 ;; Author: Ted Zlatanov <tzz@lifelogs.com> | |
6 ;; Keywords: news | |
7 | |
8 ;; This file is part of GNU Emacs. | |
9 | |
94662
f42ef85caf91
Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents:
94369
diff
changeset
|
10 ;; GNU Emacs is free software: you can redistribute it and/or modify |
92694 | 11 ;; it under the terms of the GNU General Public License as published by |
94662
f42ef85caf91
Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents:
94369
diff
changeset
|
12 ;; the Free Software Foundation, either version 3 of the License, or |
f42ef85caf91
Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents:
94369
diff
changeset
|
13 ;; (at your option) any later version. |
92694 | 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 | |
94662
f42ef85caf91
Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents:
94369
diff
changeset
|
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
92694 | 18 ;; GNU General Public License for more details. |
19 | |
20 ;; You should have received a copy of the GNU General Public License | |
94662
f42ef85caf91
Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents:
94369
diff
changeset
|
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |
92694 | 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. | |
94209 | 29 |
103944
aa77db41a051
Synch with Gnus trunk:
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
101804
diff
changeset
|
30 ;; See the auth.info Info documentation for details. |
94980 | 31 |
92694 | 32 ;;; Code: |
33 | |
94837 | 34 (require 'gnus-util) |
35 | |
92694 | 36 (eval-when-compile (require 'cl)) |
93386 | 37 (eval-when-compile (require 'netrc)) |
92694 | 38 |
39 (defgroup auth-source nil | |
40 "Authentication sources." | |
93386 | 41 :version "23.1" ;; No Gnus |
92694 | 42 :group 'gnus) |
43 | |
93386 | 44 (defcustom auth-source-protocols '((imap "imap" "imaps" "143" "993") |
45 (pop3 "pop3" "pop" "pop3s" "110" "995") | |
46 (ssh "ssh" "22") | |
47 (sftp "sftp" "115") | |
48 (smtp "smtp" "25")) | |
49 "List of authentication protocols and their names" | |
50 | |
51 :group 'auth-source | |
52 :version "23.1" ;; No Gnus | |
53 :type '(repeat :tag "Authentication Protocols" | |
54 (cons :tag "Protocol Entry" | |
55 (symbol :tag "Protocol") | |
56 (repeat :tag "Names" | |
57 (string :tag "Name"))))) | |
58 | |
59 ;;; generate all the protocols in a format Customize can use | |
60 (defconst auth-source-protocols-customize | |
61 (mapcar (lambda (a) | |
62 (let ((p (car-safe a))) | |
95665
20496e1c594a
* auth-source.el: Precise Tramp doc.
Michael Albinus <michael.albinus@gmx.de>
parents:
95193
diff
changeset
|
63 (list 'const |
93386 | 64 :tag (upcase (symbol-name p)) |
65 p))) | |
66 auth-source-protocols)) | |
67 | |
99402 | 68 (defvar auth-source-cache (make-hash-table :test 'equal) |
69 "Cache for auth-source data") | |
70 | |
71 (defcustom auth-source-do-cache t | |
72 "Whether auth-source should cache information." | |
73 :group 'auth-source | |
74 :version "23.1" ;; No Gnus | |
75 :type `boolean) | |
76 | |
103944
aa77db41a051
Synch with Gnus trunk:
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
101804
diff
changeset
|
77 (defcustom auth-source-debug nil |
aa77db41a051
Synch with Gnus trunk:
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
101804
diff
changeset
|
78 "Whether auth-source should log debug messages. |
aa77db41a051
Synch with Gnus trunk:
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
101804
diff
changeset
|
79 Also see `auth-source-hide-passwords'. |
aa77db41a051
Synch with Gnus trunk:
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
101804
diff
changeset
|
80 |
aa77db41a051
Synch with Gnus trunk:
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
101804
diff
changeset
|
81 If the value is nil, debug messages are not logged. |
aa77db41a051
Synch with Gnus trunk:
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
101804
diff
changeset
|
82 If the value is t, debug messages are logged with `message'. |
aa77db41a051
Synch with Gnus trunk:
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
101804
diff
changeset
|
83 In that case, your authentication data will be in the |
aa77db41a051
Synch with Gnus trunk:
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
101804
diff
changeset
|
84 clear (except for passwords, which are always stripped out). |
aa77db41a051
Synch with Gnus trunk:
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
101804
diff
changeset
|
85 If the value is a function, debug messages are logged by calling |
aa77db41a051
Synch with Gnus trunk:
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
101804
diff
changeset
|
86 that function using the same arguments as `message'." |
aa77db41a051
Synch with Gnus trunk:
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
101804
diff
changeset
|
87 :group 'auth-source |
aa77db41a051
Synch with Gnus trunk:
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
101804
diff
changeset
|
88 :version "23.1" ;; No Gnus |
aa77db41a051
Synch with Gnus trunk:
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
101804
diff
changeset
|
89 :type `(choice |
aa77db41a051
Synch with Gnus trunk:
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
101804
diff
changeset
|
90 :tag "auth-source debugging mode" |
aa77db41a051
Synch with Gnus trunk:
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
101804
diff
changeset
|
91 (const :tag "Log using `message' to the *Messages* buffer" t) |
aa77db41a051
Synch with Gnus trunk:
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
101804
diff
changeset
|
92 (function :tag "Function that takes arguments like `message'") |
aa77db41a051
Synch with Gnus trunk:
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
101804
diff
changeset
|
93 (const :tag "Don't log anything" nil))) |
aa77db41a051
Synch with Gnus trunk:
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
101804
diff
changeset
|
94 |
aa77db41a051
Synch with Gnus trunk:
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
101804
diff
changeset
|
95 (defcustom auth-source-hide-passwords t |
aa77db41a051
Synch with Gnus trunk:
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
101804
diff
changeset
|
96 "Whether auth-source should hide passwords in log messages. |
aa77db41a051
Synch with Gnus trunk:
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
101804
diff
changeset
|
97 Only relevant if `auth-source-debug' is not nil." |
aa77db41a051
Synch with Gnus trunk:
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
101804
diff
changeset
|
98 :group 'auth-source |
aa77db41a051
Synch with Gnus trunk:
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
101804
diff
changeset
|
99 :version "23.1" ;; No Gnus |
aa77db41a051
Synch with Gnus trunk:
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
101804
diff
changeset
|
100 :type `boolean) |
aa77db41a051
Synch with Gnus trunk:
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
101804
diff
changeset
|
101 |
94980 | 102 (defcustom auth-sources '((:source "~/.authinfo.gpg" :host t :protocol t)) |
92694 | 103 "List of authentication sources. |
104 | |
105 Each entry is the authentication type with optional properties." | |
106 :group 'auth-source | |
93386 | 107 :version "23.1" ;; No Gnus |
108 :type `(repeat :tag "Authentication Sources" | |
109 (list :tag "Source definition" | |
110 (const :format "" :value :source) | |
111 (string :tag "Authentication Source") | |
112 (const :format "" :value :host) | |
94209 | 113 (choice :tag "Host (machine) choice" |
93386 | 114 (const :tag "Any" t) |
94209 | 115 (regexp :tag "Host (machine) regular expression (TODO)") |
93386 | 116 (const :tag "Fallback" nil)) |
117 (const :format "" :value :protocol) | |
118 (choice :tag "Protocol" | |
119 (const :tag "Any" t) | |
120 (const :tag "Fallback" nil) | |
121 ,@auth-source-protocols-customize)))) | |
92694 | 122 |
123 ;; temp for debugging | |
93386 | 124 ;; (unintern 'auth-source-protocols) |
125 ;; (unintern 'auth-sources) | |
126 ;; (customize-variable 'auth-sources) | |
127 ;; (setq auth-sources nil) | |
128 ;; (format "%S" auth-sources) | |
129 ;; (customize-variable 'auth-source-protocols) | |
130 ;; (setq auth-source-protocols nil) | |
131 ;; (format "%S" auth-source-protocols) | |
132 ;; (auth-source-pick "a" 'imap) | |
133 ;; (auth-source-user-or-password "login" "imap.myhost.com" 'imap) | |
134 ;; (auth-source-user-or-password "password" "imap.myhost.com" 'imap) | |
135 ;; (auth-source-user-or-password-imap "login" "imap.myhost.com") | |
136 ;; (auth-source-user-or-password-imap "password" "imap.myhost.com") | |
137 ;; (auth-source-protocol-defaults 'imap) | |
138 | |
103944
aa77db41a051
Synch with Gnus trunk:
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
101804
diff
changeset
|
139 ;; (let ((auth-source-debug 'debug)) (auth-source-debug "hello")) |
aa77db41a051
Synch with Gnus trunk:
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
101804
diff
changeset
|
140 ;; (let ((auth-source-debug t)) (auth-source-debug "hello")) |
aa77db41a051
Synch with Gnus trunk:
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
101804
diff
changeset
|
141 ;; (let ((auth-source-debug nil)) (auth-source-debug "hello")) |
aa77db41a051
Synch with Gnus trunk:
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
101804
diff
changeset
|
142 (defun auth-source-do-debug (&rest msg) |
aa77db41a051
Synch with Gnus trunk:
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
101804
diff
changeset
|
143 ;; set logger to either the function in auth-source-debug or 'message |
aa77db41a051
Synch with Gnus trunk:
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
101804
diff
changeset
|
144 ;; note that it will be 'message if auth-source-debug is nil, so |
aa77db41a051
Synch with Gnus trunk:
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
101804
diff
changeset
|
145 ;; we also check the value |
aa77db41a051
Synch with Gnus trunk:
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
101804
diff
changeset
|
146 (when auth-source-debug |
aa77db41a051
Synch with Gnus trunk:
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
101804
diff
changeset
|
147 (let ((logger (if (functionp auth-source-debug) |
aa77db41a051
Synch with Gnus trunk:
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
101804
diff
changeset
|
148 auth-source-debug |
aa77db41a051
Synch with Gnus trunk:
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
101804
diff
changeset
|
149 'message))) |
aa77db41a051
Synch with Gnus trunk:
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
101804
diff
changeset
|
150 (apply logger msg)))) |
aa77db41a051
Synch with Gnus trunk:
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
101804
diff
changeset
|
151 |
94369 | 152 (defun auth-source-pick (host protocol &optional fallback) |
153 "Parse `auth-sources' for HOST, and PROTOCOL matches. | |
93386 | 154 |
94369 | 155 Returns fallback choices (where PROTOCOL or HOST are nil) with FALLBACK t." |
93386 | 156 (interactive "sHost: \nsProtocol: \n") ;for testing |
157 (let (choices) | |
158 (dolist (choice auth-sources) | |
94369 | 159 (let ((h (plist-get choice :host)) |
93386 | 160 (p (plist-get choice :protocol))) |
161 (when (and | |
162 (or (equal t h) | |
163 (and (stringp h) (string-match h host)) | |
164 (and fallback (equal h nil))) | |
165 (or (equal t p) | |
166 (and (symbolp p) (equal p protocol)) | |
167 (and fallback (equal p nil)))) | |
168 (push choice choices)))) | |
169 (if choices | |
170 choices | |
171 (unless fallback | |
94369 | 172 (auth-source-pick host protocol t))))) |
93386 | 173 |
99402 | 174 (defun auth-source-forget-user-or-password (mode host protocol) |
175 (interactive "slogin/password: \nsHost: \nsProtocol: \n") ;for testing | |
176 (remhash (format "%s %s:%s" mode host protocol) auth-source-cache)) | |
177 | |
101804 | 178 (defun auth-source-forget-all-cached () |
179 "Forget all cached auth-source authentication tokens." | |
180 (interactive) | |
181 (setq auth-source-cache (make-hash-table :test 'equal))) | |
182 | |
94369 | 183 (defun auth-source-user-or-password (mode host protocol) |
101804 | 184 "Find MODE (string or list of strings) matching HOST and PROTOCOL. |
185 MODE can be \"login\" or \"password\" for example." | |
103944
aa77db41a051
Synch with Gnus trunk:
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
101804
diff
changeset
|
186 (auth-source-do-debug |
aa77db41a051
Synch with Gnus trunk:
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
101804
diff
changeset
|
187 "auth-source-user-or-password: get %s for %s (%s)" |
aa77db41a051
Synch with Gnus trunk:
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
101804
diff
changeset
|
188 mode host protocol) |
101804 | 189 (let* ((listy (listp mode)) |
190 (mode (if listy mode (list mode))) | |
191 (cname (format "%s %s:%s" mode host protocol)) | |
99402 | 192 (found (gethash cname auth-source-cache))) |
193 (if found | |
194 (progn | |
103944
aa77db41a051
Synch with Gnus trunk:
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
101804
diff
changeset
|
195 (auth-source-do-debug |
aa77db41a051
Synch with Gnus trunk:
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
101804
diff
changeset
|
196 "auth-source-user-or-password: cached %s=%s for %s (%s)" |
aa77db41a051
Synch with Gnus trunk:
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
101804
diff
changeset
|
197 mode |
aa77db41a051
Synch with Gnus trunk:
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
101804
diff
changeset
|
198 ;; don't show the password |
aa77db41a051
Synch with Gnus trunk:
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
101804
diff
changeset
|
199 (if (and (member "password" mode) auth-source-hide-passwords) "SECRET" found) |
aa77db41a051
Synch with Gnus trunk:
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
101804
diff
changeset
|
200 host protocol) |
99402 | 201 found) |
202 (dolist (choice (auth-source-pick host protocol)) | |
203 (setq found (netrc-machine-user-or-password | |
204 mode | |
205 (plist-get choice :source) | |
206 (list host) | |
207 (list (format "%s" protocol)) | |
208 (auth-source-protocol-defaults protocol))) | |
209 (when found | |
103944
aa77db41a051
Synch with Gnus trunk:
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
101804
diff
changeset
|
210 (auth-source-do-debug |
aa77db41a051
Synch with Gnus trunk:
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
101804
diff
changeset
|
211 "auth-source-user-or-password: found %s=%s for %s (%s)" |
aa77db41a051
Synch with Gnus trunk:
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
101804
diff
changeset
|
212 mode |
aa77db41a051
Synch with Gnus trunk:
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
101804
diff
changeset
|
213 ;; don't show the password |
aa77db41a051
Synch with Gnus trunk:
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
101804
diff
changeset
|
214 (if (and (member "password" mode) auth-source-hide-passwords) "SECRET" found) |
aa77db41a051
Synch with Gnus trunk:
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
101804
diff
changeset
|
215 host protocol) |
101804 | 216 (setq found (if listy found (car-safe found))) |
99402 | 217 (when auth-source-do-cache |
218 (puthash cname found auth-source-cache))) | |
93386 | 219 (return found))))) |
220 | |
221 (defun auth-source-protocol-defaults (protocol) | |
222 "Return a list of default ports and names for PROTOCOL." | |
223 (cdr-safe (assoc protocol auth-source-protocols))) | |
224 | |
94369 | 225 (defun auth-source-user-or-password-imap (mode host) |
226 (auth-source-user-or-password mode host 'imap)) | |
93386 | 227 |
94369 | 228 (defun auth-source-user-or-password-pop3 (mode host) |
229 (auth-source-user-or-password mode host 'pop3)) | |
93386 | 230 |
94369 | 231 (defun auth-source-user-or-password-ssh (mode host) |
232 (auth-source-user-or-password mode host 'ssh)) | |
93386 | 233 |
94369 | 234 (defun auth-source-user-or-password-sftp (mode host) |
235 (auth-source-user-or-password mode host 'sftp)) | |
93386 | 236 |
94369 | 237 (defun auth-source-user-or-password-smtp (mode host) |
238 (auth-source-user-or-password mode host 'smtp)) | |
92694 | 239 |
240 (provide 'auth-source) | |
241 | |
242 ;; arch-tag: ff1afe78-06e9-42c2-b693-e9f922cbe4ab | |
243 ;;; auth-source.el ends here |