1 ;;; sieve-manage.el --- Implementation of the managesive protocol in elisp
3 ;; Copyright (C) 2001-2011 Free Software Foundation, Inc.
5 ;; Author: Simon Josefsson <simon@josefsson.org>
7 ;; This file is part of GNU Emacs.
9 ;; GNU Emacs is free software: you can redistribute it and/or modify
10 ;; it under the terms of the GNU General Public License as published by
11 ;; the Free Software Foundation, either version 3 of the License, or
12 ;; (at your option) any later version.
14 ;; GNU Emacs is distributed in the hope that it will be useful,
15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 ;; GNU General Public License for more details.
19 ;; You should have received a copy of the GNU General Public License
20 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;; This library provides an elisp API for the managesieve network
27 ;; It uses the SASL library for authentication, which means it
28 ;; supports DIGEST-MD5, CRAM-MD5, SCRAM-MD5, NTLM, PLAIN and LOGIN
29 ;; methods. STARTTLS is not well tested, but should be easy to get to
30 ;; work if someone wants.
32 ;; The API should be fairly obvious for anyone familiar with the
33 ;; managesieve protocol, interface functions include:
35 ;; `sieve-manage-open'
36 ;; open connection to managesieve server, returning a buffer to be
37 ;; used by all other API functions.
39 ;; `sieve-manage-opened'
40 ;; check if a server is open or not
42 ;; `sieve-manage-close'
43 ;; close a server connection.
45 ;; `sieve-manage-listscripts'
46 ;; `sieve-manage-deletescript'
47 ;; `sieve-manage-getscript'
48 ;; performs managesieve protocol actions
50 ;; and that's it. Example of a managesieve session in *scratch*:
52 ;; (with-current-buffer (sieve-manage-open "mail.example.com")
53 ;; (sieve-manage-authenticate)
54 ;; (sieve-manage-listscripts))
56 ;; => ((active . "main") "vacation")
60 ;; draft-martin-managesieve-02.txt,
61 ;; "A Protocol for Remotely Managing Sieve Scripts",
66 ;; 2001-10-31 Committed to Oort Gnus.
67 ;; 2002-07-27 Added DELETESCRIPT. Suggested by Ned Ludd.
68 ;; 2002-08-03 Use SASL library.
72 ;; For Emacs <22.2 and XEmacs.
74 (unless (fboundp 'declare-function) (defmacro declare-function (&rest r))))
76 (if (locate-library "password-cache")
77 (require 'password-cache)
84 (autoload 'sasl-find-mechanism "sasl")
85 (autoload 'starttls-open-stream "starttls")
86 (autoload 'auth-source-user-or-password "auth-source")
88 ;; User customizable variables:
90 (defgroup sieve-manage nil
91 "Low-level Managesieve protocol issues."
95 (defcustom sieve-manage-log "*sieve-manage-log*"
96 "Name of buffer for managesieve session trace."
100 (defcustom sieve-manage-server-eol "\r\n"
101 "The EOL string sent from the server."
103 :group 'sieve-manage)
105 (defcustom sieve-manage-client-eol "\r\n"
106 "The EOL string we send to the server."
108 :group 'sieve-manage)
110 (defcustom sieve-manage-streams '(network starttls shell)
111 "Priority of streams to consider when opening connection to server."
112 :group 'sieve-manage)
114 (defcustom sieve-manage-stream-alist
115 '((network sieve-manage-network-p sieve-manage-network-open)
116 (shell sieve-manage-shell-p sieve-manage-shell-open)
117 (starttls sieve-manage-starttls-p sieve-manage-starttls-open))
118 "Definition of network streams.
122 NAME names the stream, CHECK is a function returning non-nil if the
123 server support the stream and OPEN is a function for opening the
125 :group 'sieve-manage)
127 (defcustom sieve-manage-authenticators '(digest-md5
133 "Priority of authenticators to consider when authenticating to server."
134 :group 'sieve-manage)
136 (defcustom sieve-manage-authenticator-alist
137 '((cram-md5 sieve-manage-cram-md5-p sieve-manage-cram-md5-auth)
138 (digest-md5 sieve-manage-digest-md5-p sieve-manage-digest-md5-auth)
139 (scram-md5 sieve-manage-scram-md5-p sieve-manage-scram-md5-auth)
140 (ntlm sieve-manage-ntlm-p sieve-manage-ntlm-auth)
141 (plain sieve-manage-plain-p sieve-manage-plain-auth)
142 (login sieve-manage-login-p sieve-manage-login-auth))
143 "Definition of authenticators.
145 \(NAME CHECK AUTHENTICATE)
147 NAME names the authenticator. CHECK is a function returning non-nil if
148 the server support the authenticator and AUTHENTICATE is a function
149 for doing the actual authentication."
150 :group 'sieve-manage)
152 (defcustom sieve-manage-default-port 2000
153 "Default port number or service name for managesieve protocol."
155 :group 'sieve-manage)
157 (defcustom sieve-manage-default-stream 'network
158 "Default stream type to use for `sieve-manage'.
159 Must be a name of a stream in `sieve-manage-stream-alist'."
161 :group 'sieve-manage)
163 ;; Internal variables:
165 (defconst sieve-manage-local-variables '(sieve-manage-server
170 sieve-manage-client-eol
171 sieve-manage-server-eol
172 sieve-manage-capability))
173 (defconst sieve-manage-coding-system-for-read 'binary)
174 (defconst sieve-manage-coding-system-for-write 'binary)
175 (defvar sieve-manage-stream nil)
176 (defvar sieve-manage-auth nil)
177 (defvar sieve-manage-server nil)
178 (defvar sieve-manage-port nil)
179 (defvar sieve-manage-state 'closed
181 Valid states are `closed', `initial', `nonauth', and `auth'.")
182 (defvar sieve-manage-process nil)
183 (defvar sieve-manage-capability nil)
185 ;; Internal utility functions
187 (defmacro sieve-manage-disable-multibyte ()
188 "Enable multibyte in the current buffer."
189 (unless (featurep 'xemacs)
190 '(set-buffer-multibyte nil)))
192 (defun sieve-manage-erase (&optional p buffer)
193 (let ((buffer (or buffer (current-buffer))))
194 (and sieve-manage-log
195 (with-current-buffer (get-buffer-create sieve-manage-log)
196 (sieve-manage-disable-multibyte)
197 (buffer-disable-undo)
198 (goto-char (point-max))
199 (insert-buffer-substring buffer (with-current-buffer buffer
201 (or p (with-current-buffer buffer
203 (delete-region (point-min) (or p (point-max))))
205 (defun sieve-manage-open-1 (buffer)
206 (with-current-buffer buffer
208 (setq sieve-manage-state 'initial
211 (funcall (nth 2 (assq sieve-manage-stream
212 sieve-manage-stream-alist))
213 "sieve" buffer sieve-manage-server sieve-manage-port)
215 (when sieve-manage-process
216 (while (and (eq sieve-manage-state 'initial)
217 (memq (process-status sieve-manage-process) '(open run)))
218 (message "Waiting for response from %s..." sieve-manage-server)
219 (accept-process-output sieve-manage-process 1))
220 (message "Waiting for response from %s...done" sieve-manage-server)
221 (and (memq (process-status sieve-manage-process) '(open run))
222 sieve-manage-process))))
226 (defun sieve-manage-network-p (buffer)
229 (defun sieve-manage-network-open (name buffer server port)
230 (let* ((port (or port sieve-manage-default-port))
231 (coding-system-for-read sieve-manage-coding-system-for-read)
232 (coding-system-for-write sieve-manage-coding-system-for-write)
233 (process (open-network-stream name buffer server port)))
235 (while (and (memq (process-status process) '(open run))
236 (set-buffer buffer) ;; XXX "blue moon" nntp.el bug
237 (goto-char (point-min))
238 (not (sieve-manage-parse-greeting-1)))
239 (accept-process-output process 1)
241 (sieve-manage-erase nil buffer)
242 (when (memq (process-status process) '(open run))
245 (defun sieve-manage-starttls-p (buffer)
249 (call-process "starttls"))
252 (defun sieve-manage-starttls-open (name buffer server port)
253 (let* ((port (or port sieve-manage-default-port))
254 (coding-system-for-read sieve-manage-coding-system-for-read)
255 (coding-system-for-write sieve-manage-coding-system-for-write)
256 (process (starttls-open-stream name buffer server port))
259 (while (and (memq (process-status process) '(open run))
260 (set-buffer buffer) ;; XXX "blue moon" nntp.el bug
261 (goto-char (point-min))
262 (not (sieve-manage-parse-greeting-1)))
263 (accept-process-output process 1)
265 (sieve-manage-erase nil buffer)
266 (sieve-manage-send "STARTTLS")
267 (starttls-negotiate process))
268 (when (memq (process-status process) '(open run))
272 (defun sieve-sasl-auth (buffer mech)
273 "Login to server using the SASL MECH method."
274 (message "sieve: Authenticating using %s..." mech)
275 (with-current-buffer buffer
276 (let* ((user-password (auth-source-user-or-password
277 '("login" "password")
280 (client (sasl-make-client (sasl-find-mechanism (list mech))
281 (car user-password) "sieve" sieve-manage-server))
282 (sasl-read-passphrase
283 ;; We *need* to copy the password, because sasl will modify it
285 `(lambda (prompt) ,(copy-sequence (cadr user-password))))
286 (step (sasl-next-step client nil))
287 (tag (sieve-manage-send
292 (and (sasl-step-data step)
295 (base64-encode-string
296 (sasl-step-data step)
303 (goto-char (point-min))
304 (while (null (or (progn
305 (setq rsp (sieve-manage-is-string))
306 (if (not (and rsp (looking-at
307 sieve-manage-server-eol)))
309 (goto-char (match-end 0))
311 (setq rsp (sieve-manage-is-okno))))
312 (accept-process-output sieve-manage-process 1)
313 (goto-char (point-min)))
315 (when (sieve-manage-ok-p rsp)
316 (when (and (cadr rsp)
317 (string-match "^SASL \"\\([^\"]+\\)\"" (cadr rsp)))
319 step (base64-decode-string (match-string 1 (cadr rsp)))))
320 (if (and (setq step (sasl-next-step client step))
321 (setq data (sasl-step-data step)))
322 ;; We got data for server but it's finished
323 (error "Server not ready for SASL data: %s" data)
324 ;; The authentication process is finished.
326 (unless (stringp rsp)
327 (error "Server aborted SASL authentication: %s" (caddr rsp)))
328 (sasl-step-set-data step (base64-decode-string rsp))
329 (setq step (sasl-next-step client step))
331 (if (sasl-step-data step)
333 (base64-encode-string (sasl-step-data step)
337 (message "sieve: Login using %s...done" mech))))
339 (defun sieve-manage-cram-md5-p (buffer)
340 (sieve-manage-capability "SASL" "CRAM-MD5" buffer))
342 (defun sieve-manage-cram-md5-auth (buffer)
343 "Login to managesieve server using the CRAM-MD5 SASL method."
344 (sieve-sasl-auth buffer "CRAM-MD5"))
346 (defun sieve-manage-digest-md5-p (buffer)
347 (sieve-manage-capability "SASL" "DIGEST-MD5" buffer))
349 (defun sieve-manage-digest-md5-auth (buffer)
350 "Login to managesieve server using the DIGEST-MD5 SASL method."
351 (sieve-sasl-auth buffer "DIGEST-MD5"))
353 (defun sieve-manage-scram-md5-p (buffer)
354 (sieve-manage-capability "SASL" "SCRAM-MD5" buffer))
356 (defun sieve-manage-scram-md5-auth (buffer)
357 "Login to managesieve server using the SCRAM-MD5 SASL method."
358 (sieve-sasl-auth buffer "SCRAM-MD5"))
360 (defun sieve-manage-ntlm-p (buffer)
361 (sieve-manage-capability "SASL" "NTLM" buffer))
363 (defun sieve-manage-ntlm-auth (buffer)
364 "Login to managesieve server using the NTLM SASL method."
365 (sieve-sasl-auth buffer "NTLM"))
367 (defun sieve-manage-plain-p (buffer)
368 (sieve-manage-capability "SASL" "PLAIN" buffer))
370 (defun sieve-manage-plain-auth (buffer)
371 "Login to managesieve server using the PLAIN SASL method."
372 (sieve-sasl-auth buffer "PLAIN"))
374 (defun sieve-manage-login-p (buffer)
375 (sieve-manage-capability "SASL" "LOGIN" buffer))
377 (defun sieve-manage-login-auth (buffer)
378 "Login to managesieve server using the LOGIN SASL method."
379 (sieve-sasl-auth buffer "LOGIN"))
383 (defun sieve-manage-open (server &optional port stream auth buffer)
384 "Open a network connection to a managesieve SERVER (string).
385 Optional argument PORT is port number (integer) on remote server.
386 Optional argument STREAM is any of `sieve-manage-streams' (a symbol).
387 Optional argument AUTH indicates authenticator to use, see
388 `sieve-manage-authenticators' for available authenticators.
389 If nil, chooses the best stream the server is capable of.
390 Optional argument BUFFER is buffer (buffer, or string naming buffer)
392 (or port (setq port sieve-manage-default-port))
393 (setq buffer (or buffer (format " *sieve* %s:%s" server port)))
394 (with-current-buffer (get-buffer-create buffer)
395 (mapc 'make-local-variable sieve-manage-local-variables)
396 (sieve-manage-disable-multibyte)
397 (buffer-disable-undo)
398 (setq sieve-manage-server (or server sieve-manage-server))
399 (setq sieve-manage-port port)
400 (setq sieve-manage-stream (or stream sieve-manage-stream))
401 (message "sieve: Connecting to %s..." sieve-manage-server)
402 (if (let ((sieve-manage-stream
403 (or sieve-manage-stream sieve-manage-default-stream)))
404 (sieve-manage-open-1 buffer))
406 (let (stream-changed)
407 (message "sieve: Connecting to %s...done" sieve-manage-server)
408 (when (null sieve-manage-stream)
409 (let ((streams sieve-manage-streams))
410 (while (setq stream (pop streams))
411 (if (funcall (nth 1 (assq stream
412 sieve-manage-stream-alist)) buffer)
414 (not (eq (or sieve-manage-stream
415 sieve-manage-default-stream)
417 sieve-manage-stream stream
419 (unless sieve-manage-stream
420 (error "Couldn't figure out a stream for server"))))
422 (message "sieve: Reconnecting with stream `%s'..."
424 (sieve-manage-close buffer)
425 (if (sieve-manage-open-1 buffer)
426 (message "sieve: Reconnecting with stream `%s'...done"
428 (message "sieve: Reconnecting with stream `%s'...failed"
429 sieve-manage-stream))
430 (setq sieve-manage-capability nil))
431 (if (sieve-manage-opened buffer)
432 ;; Choose authenticator
433 (when (and (null sieve-manage-auth)
434 (not (eq sieve-manage-state 'auth)))
435 (let ((auths sieve-manage-authenticators))
436 (while (setq auth (pop auths))
437 (if (funcall (nth 1 (assq
439 sieve-manage-authenticator-alist))
441 (setq sieve-manage-auth auth
443 (unless sieve-manage-auth
444 (error "Couldn't figure out authenticator for server"))))))
445 (message "sieve: Connecting to %s...failed" sieve-manage-server))
446 (when (sieve-manage-opened buffer)
450 (defun sieve-manage-authenticate (&optional buffer)
451 "Authenticate on server in BUFFER.
452 Return `sieve-manage-state' value."
453 (with-current-buffer (or buffer (current-buffer))
454 (if (eq sieve-manage-state 'nonauth)
455 (when (funcall (nth 2 (assq sieve-manage-auth
456 sieve-manage-authenticator-alist))
458 (setq sieve-manage-state 'auth))
459 sieve-manage-state)))
461 (defun sieve-manage-opened (&optional buffer)
462 "Return non-nil if connection to managesieve server in BUFFER is open.
463 If BUFFER is nil then the current buffer is used."
464 (and (setq buffer (get-buffer (or buffer (current-buffer))))
465 (buffer-live-p buffer)
466 (with-current-buffer buffer
467 (and sieve-manage-process
468 (memq (process-status sieve-manage-process) '(open run))))))
470 (defun sieve-manage-close (&optional buffer)
471 "Close connection to managesieve server in BUFFER.
472 If BUFFER is nil, the current buffer is used."
473 (with-current-buffer (or buffer (current-buffer))
474 (when (sieve-manage-opened)
475 (sieve-manage-send "LOGOUT")
477 (when (and sieve-manage-process
478 (memq (process-status sieve-manage-process) '(open run)))
479 (delete-process sieve-manage-process))
480 (setq sieve-manage-process nil)
484 (defun sieve-manage-capability (&optional name value buffer)
485 "Check if capability NAME of server BUFFER match VALUE.
486 If it does, return the server value of NAME. If not returns nil.
487 If VALUE is nil, do not check VALUE and return server value.
488 If NAME is nil, return the full server list of capabilities."
489 (with-current-buffer (or buffer (current-buffer))
491 sieve-manage-capability
492 (let ((server-value (cadr (assoc name sieve-manage-capability))))
493 (when (or (null value)
495 (string-match value server-value)))
498 (defun sieve-manage-listscripts (&optional buffer)
499 (with-current-buffer (or buffer (current-buffer))
500 (sieve-manage-send "LISTSCRIPTS")
501 (sieve-manage-parse-listscripts)))
503 (defun sieve-manage-havespace (name size &optional buffer)
504 (with-current-buffer (or buffer (current-buffer))
505 (sieve-manage-send (format "HAVESPACE \"%s\" %s" name size))
506 (sieve-manage-parse-okno)))
508 (defun sieve-manage-putscript (name content &optional buffer)
509 (with-current-buffer (or buffer (current-buffer))
510 (sieve-manage-send (format "PUTSCRIPT \"%s\" {%d+}%s%s" name
511 ;; Here we assume that the coding-system will
512 ;; replace each char with a single byte.
513 ;; This is always the case if `content' is
516 sieve-manage-client-eol content))
517 (sieve-manage-parse-okno)))
519 (defun sieve-manage-deletescript (name &optional buffer)
520 (with-current-buffer (or buffer (current-buffer))
521 (sieve-manage-send (format "DELETESCRIPT \"%s\"" name))
522 (sieve-manage-parse-okno)))
524 (defun sieve-manage-getscript (name output-buffer &optional buffer)
525 (with-current-buffer (or buffer (current-buffer))
526 (sieve-manage-send (format "GETSCRIPT \"%s\"" name))
527 (let ((script (sieve-manage-parse-string)))
528 (sieve-manage-parse-crlf)
529 (with-current-buffer output-buffer
531 (sieve-manage-parse-okno))))
533 (defun sieve-manage-setactive (name &optional buffer)
534 (with-current-buffer (or buffer (current-buffer))
535 (sieve-manage-send (format "SETACTIVE \"%s\"" name))
536 (sieve-manage-parse-okno)))
538 ;; Protocol parsing routines
540 (defun sieve-manage-ok-p (rsp)
541 (string= (downcase (or (car-safe rsp) "")) "ok"))
543 (defsubst sieve-manage-forward ()
544 (or (eobp) (forward-char)))
546 (defun sieve-manage-is-okno ()
547 (when (looking-at (concat
548 "^\\(OK\\|NO\\)\\( (\\([^)]+\\))\\)?\\( \\(.*\\)\\)?"
549 sieve-manage-server-eol))
550 (let ((status (match-string 1))
551 (resp-code (match-string 3))
552 (response (match-string 5)))
554 (goto-char (match-beginning 5))
555 (setq response (sieve-manage-is-string)))
556 (list status resp-code response))))
558 (defun sieve-manage-parse-okno ()
561 (accept-process-output (get-buffer-process (current-buffer)) 1)
562 (goto-char (point-min))
563 (setq rsp (sieve-manage-is-okno)))
567 (defun sieve-manage-parse-capability-1 ()
568 "Accept a managesieve greeting."
570 (while (setq str (sieve-manage-is-string))
571 (if (eq (char-after) ? )
573 (sieve-manage-forward)
574 (push (list str (sieve-manage-is-string))
575 sieve-manage-capability))
576 (push (list str) sieve-manage-capability))
578 (when (re-search-forward (concat "^OK.*" sieve-manage-server-eol) nil t)
579 (setq sieve-manage-state 'nonauth)))
581 (defalias 'sieve-manage-parse-greeting-1 'sieve-manage-parse-capability-1)
583 (defun sieve-manage-is-string ()
584 (cond ((looking-at "\"\\([^\"]+\\)\"")
587 (goto-char (match-end 0))))
588 ((looking-at (concat "{\\([0-9]+\\+?\\)}" sieve-manage-server-eol))
589 (let ((pos (match-end 0))
590 (len (string-to-number (match-string 1))))
591 (if (< (point-max) (+ pos len))
593 (goto-char (+ pos len))
594 (buffer-substring pos (+ pos len)))))))
596 (defun sieve-manage-parse-string ()
599 (accept-process-output (get-buffer-process (current-buffer)) 1)
600 (goto-char (point-min))
601 (setq rsp (sieve-manage-is-string)))
602 (sieve-manage-erase (point))
605 (defun sieve-manage-parse-crlf ()
606 (when (looking-at sieve-manage-server-eol)
607 (sieve-manage-erase (match-end 0))))
609 (defun sieve-manage-parse-listscripts ()
612 (while (null (or (setq rsp (sieve-manage-is-okno))
613 (setq tmp (sieve-manage-is-string))))
614 (accept-process-output (get-buffer-process (current-buffer)) 1)
615 (goto-char (point-min)))
617 (while (not (looking-at (concat "\\( ACTIVE\\)?"
618 sieve-manage-server-eol)))
619 (accept-process-output (get-buffer-process (current-buffer)) 1)
620 (goto-char (point-min)))
622 (push (cons 'active tmp) data)
624 (goto-char (match-end 0))
627 (if (sieve-manage-ok-p rsp)
631 (defun sieve-manage-send (cmdstr)
632 (setq cmdstr (concat cmdstr sieve-manage-client-eol))
633 (and sieve-manage-log
634 (with-current-buffer (get-buffer-create sieve-manage-log)
635 (sieve-manage-disable-multibyte)
636 (buffer-disable-undo)
637 (goto-char (point-max))
639 (process-send-string sieve-manage-process cmdstr))
641 (provide 'sieve-manage)
643 ;; sieve-manage.el ends here