Mercurial > emacs
annotate lisp/gnus/auth-source.el @ 103008:b41af984adfa
*** empty log message ***
author | Kenichi Handa <handa@m17n.org> |
---|---|
date | Fri, 17 Apr 2009 02:31:20 +0000 |
parents | d775b84fdd71 |
children | aa77db41a051 |
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 |
30 ;; Easy setup: | |
31 ;; (require 'auth-source) | |
32 ;; (customize-variable 'auth-sources) ;; optional | |
33 | |
34 ;; now, whatever sources you've defined for password have to be available | |
35 | |
36 ;; if you want encrypted sources, which is strongly recommended, do | |
37 ;; (require 'epa-file) | |
101281 | 38 ;; (epa-file-enable) |
95193 | 39 ;; (setq epa-file-cache-passphrase-for-symmetric-encryption t) ; VERY important |
94209 | 40 |
41 ;; before you put some data in ~/.authinfo.gpg (the default place) | |
42 | |
94837 | 43 ;;; For url-auth authentication (HTTP/HTTPS), you need to use: |
44 | |
45 ;;; machine yourmachine.com:80 port http login testuser password testpass | |
46 | |
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. | |
50 | |
94980 | 51 ;;; For tramp authentication, use: |
52 | |
95665
20496e1c594a
* auth-source.el: Precise Tramp doc.
Michael Albinus <michael.albinus@gmx.de>
parents:
95193
diff
changeset
|
53 ;;; machine yourmachine.com port scp login testuser password testpass |
94980 | 54 |
95665
20496e1c594a
* auth-source.el: Precise Tramp doc.
Michael Albinus <michael.albinus@gmx.de>
parents:
95193
diff
changeset
|
55 ;;; Note that the port denotes the Tramp connection method. When you |
20496e1c594a
* auth-source.el: Precise Tramp doc.
Michael Albinus <michael.albinus@gmx.de>
parents:
95193
diff
changeset
|
56 ;;; don't use a port entry, you match any Tramp method. |
94980 | 57 |
92694 | 58 ;;; Code: |
59 | |
94837 | 60 (require 'gnus-util) |
61 | |
92694 | 62 (eval-when-compile (require 'cl)) |
93386 | 63 (eval-when-compile (require 'netrc)) |
92694 | 64 |
65 (defgroup auth-source nil | |
66 "Authentication sources." | |
93386 | 67 :version "23.1" ;; No Gnus |
92694 | 68 :group 'gnus) |
69 | |
93386 | 70 (defcustom auth-source-protocols '((imap "imap" "imaps" "143" "993") |
71 (pop3 "pop3" "pop" "pop3s" "110" "995") | |
72 (ssh "ssh" "22") | |
73 (sftp "sftp" "115") | |
74 (smtp "smtp" "25")) | |
75 "List of authentication protocols and their names" | |
76 | |
77 :group 'auth-source | |
78 :version "23.1" ;; No Gnus | |
79 :type '(repeat :tag "Authentication Protocols" | |
80 (cons :tag "Protocol Entry" | |
81 (symbol :tag "Protocol") | |
82 (repeat :tag "Names" | |
83 (string :tag "Name"))))) | |
84 | |
85 ;;; generate all the protocols in a format Customize can use | |
86 (defconst auth-source-protocols-customize | |
87 (mapcar (lambda (a) | |
88 (let ((p (car-safe a))) | |
95665
20496e1c594a
* auth-source.el: Precise Tramp doc.
Michael Albinus <michael.albinus@gmx.de>
parents:
95193
diff
changeset
|
89 (list 'const |
93386 | 90 :tag (upcase (symbol-name p)) |
91 p))) | |
92 auth-source-protocols)) | |
93 | |
99402 | 94 (defvar auth-source-cache (make-hash-table :test 'equal) |
95 "Cache for auth-source data") | |
96 | |
97 (defcustom auth-source-do-cache t | |
98 "Whether auth-source should cache information." | |
99 :group 'auth-source | |
100 :version "23.1" ;; No Gnus | |
101 :type `boolean) | |
102 | |
94980 | 103 (defcustom auth-sources '((:source "~/.authinfo.gpg" :host t :protocol t)) |
92694 | 104 "List of authentication sources. |
105 | |
106 Each entry is the authentication type with optional properties." | |
107 :group 'auth-source | |
93386 | 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) | |
94209 | 114 (choice :tag "Host (machine) choice" |
93386 | 115 (const :tag "Any" t) |
94209 | 116 (regexp :tag "Host (machine) regular expression (TODO)") |
93386 | 117 (const :tag "Fallback" nil)) |
118 (const :format "" :value :protocol) | |
119 (choice :tag "Protocol" | |
120 (const :tag "Any" t) | |
121 (const :tag "Fallback" nil) | |
122 ,@auth-source-protocols-customize)))) | |
92694 | 123 |
124 ;; temp for debugging | |
93386 | 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) | |
139 | |
94369 | 140 (defun auth-source-pick (host protocol &optional fallback) |
141 "Parse `auth-sources' for HOST, and PROTOCOL matches. | |
93386 | 142 |
94369 | 143 Returns fallback choices (where PROTOCOL or HOST are nil) with FALLBACK t." |
93386 | 144 (interactive "sHost: \nsProtocol: \n") ;for testing |
145 (let (choices) | |
146 (dolist (choice auth-sources) | |
94369 | 147 (let ((h (plist-get choice :host)) |
93386 | 148 (p (plist-get choice :protocol))) |
149 (when (and | |
150 (or (equal t h) | |
151 (and (stringp h) (string-match h host)) | |
152 (and fallback (equal h nil))) | |
153 (or (equal t p) | |
154 (and (symbolp p) (equal p protocol)) | |
155 (and fallback (equal p nil)))) | |
156 (push choice choices)))) | |
157 (if choices | |
158 choices | |
159 (unless fallback | |
94369 | 160 (auth-source-pick host protocol t))))) |
93386 | 161 |
99402 | 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)) | |
165 | |
101804 | 166 (defun auth-source-forget-all-cached () |
167 "Forget all cached auth-source authentication tokens." | |
168 (interactive) | |
169 (setq auth-source-cache (make-hash-table :test 'equal))) | |
170 | |
94369 | 171 (defun auth-source-user-or-password (mode host protocol) |
101804 | 172 "Find MODE (string or list of strings) matching HOST and PROTOCOL. |
173 MODE can be \"login\" or \"password\" for example." | |
95665
20496e1c594a
* auth-source.el: Precise Tramp doc.
Michael Albinus <michael.albinus@gmx.de>
parents:
95193
diff
changeset
|
174 (gnus-message 9 |
94837 | 175 "auth-source-user-or-password: get %s for %s (%s)" |
176 mode host protocol) | |
101804 | 177 (let* ((listy (listp mode)) |
178 (mode (if listy mode (list mode))) | |
179 (cname (format "%s %s:%s" mode host protocol)) | |
99402 | 180 (found (gethash cname auth-source-cache))) |
181 (if found | |
182 (progn | |
183 (gnus-message 9 | |
184 "auth-source-user-or-password: cached %s=%s for %s (%s)" | |
185 mode | |
186 ;; don't show the password | |
101804 | 187 (if (member "password" mode) "SECRET" found) |
99402 | 188 host protocol) |
189 found) | |
190 (dolist (choice (auth-source-pick host protocol)) | |
191 (setq found (netrc-machine-user-or-password | |
192 mode | |
193 (plist-get choice :source) | |
194 (list host) | |
195 (list (format "%s" protocol)) | |
196 (auth-source-protocol-defaults protocol))) | |
197 (when found | |
198 (gnus-message 9 | |
199 "auth-source-user-or-password: found %s=%s for %s (%s)" | |
200 mode | |
201 ;; don't show the password | |
101804 | 202 (if (member "password" mode) "SECRET" found) |
99402 | 203 host protocol) |
101804 | 204 (setq found (if listy found (car-safe found))) |
99402 | 205 (when auth-source-do-cache |
206 (puthash cname found auth-source-cache))) | |
93386 | 207 (return found))))) |
208 | |
209 (defun auth-source-protocol-defaults (protocol) | |
210 "Return a list of default ports and names for PROTOCOL." | |
211 (cdr-safe (assoc protocol auth-source-protocols))) | |
212 | |
94369 | 213 (defun auth-source-user-or-password-imap (mode host) |
214 (auth-source-user-or-password mode host 'imap)) | |
93386 | 215 |
94369 | 216 (defun auth-source-user-or-password-pop3 (mode host) |
217 (auth-source-user-or-password mode host 'pop3)) | |
93386 | 218 |
94369 | 219 (defun auth-source-user-or-password-ssh (mode host) |
220 (auth-source-user-or-password mode host 'ssh)) | |
93386 | 221 |
94369 | 222 (defun auth-source-user-or-password-sftp (mode host) |
223 (auth-source-user-or-password mode host 'sftp)) | |
93386 | 224 |
94369 | 225 (defun auth-source-user-or-password-smtp (mode host) |
226 (auth-source-user-or-password mode host 'smtp)) | |
92694 | 227 |
228 (provide 'auth-source) | |
229 | |
230 ;; arch-tag: ff1afe78-06e9-42c2-b693-e9f922cbe4ab | |
231 ;;; auth-source.el ends here |