1 ;;; sieve-manage.el --- Implementation of the managesive protocol in elisp
3 ;; Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009,
4 ;; 2010 Free Software Foundation, Inc.
6 ;; Author: Simon Josefsson <simon@josefsson.org>
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 library provides an elisp API for the managesieve network
28 ;; It uses the SASL library for authentication, which means it
29 ;; supports DIGEST-MD5, CRAM-MD5, SCRAM-MD5, NTLM, PLAIN and LOGIN
30 ;; methods. STARTTLS is not well tested, but should be easy to get to
31 ;; work if someone wants.
33 ;; The API should be fairly obvious for anyone familiar with the
34 ;; managesieve protocol, interface functions include:
36 ;; `sieve-manage-open'
37 ;; open connection to managesieve server, returning a buffer to be
38 ;; used by all other API functions.
40 ;; `sieve-manage-opened'
41 ;; check if a server is open or not
43 ;; `sieve-manage-close'
44 ;; close a server connection.
46 ;; `sieve-manage-listscripts'
47 ;; `sieve-manage-deletescript'
48 ;; `sieve-manage-getscript'
49 ;; performs managesieve protocol actions
51 ;; and that's it. Example of a managesieve session in *scratch*:
53 ;; (with-current-buffer (sieve-manage-open "mail.example.com")
54 ;; (sieve-manage-authenticate)
55 ;; (sieve-manage-listscripts))
57 ;; => ((active . "main") "vacation")
61 ;; draft-martin-managesieve-02.txt,
62 ;; "A Protocol for Remotely Managing Sieve Scripts",
67 ;; 2001-10-31 Committed to Oort Gnus.
68 ;; 2002-07-27 Added DELETESCRIPT. Suggested by Ned Ludd.
69 ;; 2002-08-03 Use SASL library.
73 ;; For Emacs <22.2 and XEmacs.
75 (unless (fboundp 'declare-function) (defmacro declare-function (&rest r))))
77 (if (locate-library "password-cache")
78 (require 'password-cache)
85 (autoload 'sasl-find-mechanism "sasl")
86 (autoload 'starttls-open-stream "starttls")
87 (autoload 'auth-source-user-or-password "auth-source")
89 ;; User customizable variables:
91 (defgroup sieve-manage nil
92 "Low-level Managesieve protocol issues."
96 (defcustom sieve-manage-log "*sieve-manage-log*"
97 "Name of buffer for managesieve session trace."
101 (defcustom sieve-manage-server-eol "\r\n"
102 "The EOL string sent from the server."
104 :group 'sieve-manage)
106 (defcustom sieve-manage-client-eol "\r\n"
107 "The EOL string we send to the server."
109 :group 'sieve-manage)
111 (defcustom sieve-manage-streams '(network starttls shell)
112 "Priority of streams to consider when opening connection to server."
113 :group 'sieve-manage)
115 (defcustom sieve-manage-stream-alist
116 '((network sieve-manage-network-p sieve-manage-network-open)
117 (shell sieve-manage-shell-p sieve-manage-shell-open)
118 (starttls sieve-manage-starttls-p sieve-manage-starttls-open))
119 "Definition of network streams.
123 NAME names the stream, CHECK is a function returning non-nil if the
124 server support the stream and OPEN is a function for opening the
126 :group 'sieve-manage)
128 (defcustom sieve-manage-authenticators '(digest-md5
134 "Priority of authenticators to consider when authenticating to server."
135 :group 'sieve-manage)
137 (defcustom sieve-manage-authenticator-alist
138 '((cram-md5 sieve-manage-cram-md5-p sieve-manage-cram-md5-auth)
139 (digest-md5 sieve-manage-digest-md5-p sieve-manage-digest-md5-auth)
140 (scram-md5 sieve-manage-scram-md5-p sieve-manage-scram-md5-auth)
141 (ntlm sieve-manage-ntlm-p sieve-manage-ntlm-auth)
142 (plain sieve-manage-plain-p sieve-manage-plain-auth)
143 (login sieve-manage-login-p sieve-manage-login-auth))
144 "Definition of authenticators.
146 \(NAME CHECK AUTHENTICATE)
148 NAME names the authenticator. CHECK is a function returning non-nil if
149 the server support the authenticator and AUTHENTICATE is a function
150 for doing the actual authentication."
151 :group 'sieve-manage)
153 (defcustom sieve-manage-default-port 2000
154 "Default port number or service name for managesieve protocol."
156 :group 'sieve-manage)
158 (defcustom sieve-manage-default-stream 'network
159 "Default stream type to use for `sieve-manage'.
160 Must be a name of a stream in `sieve-manage-stream-alist'."
162 :group 'sieve-manage)
164 ;; Internal variables:
166 (defconst sieve-manage-local-variables '(sieve-manage-server
171 sieve-manage-client-eol
172 sieve-manage-server-eol
173 sieve-manage-capability))
174 (defconst sieve-manage-coding-system-for-read 'binary)
175 (defconst sieve-manage-coding-system-for-write 'binary)
176 (defvar sieve-manage-stream nil)
177 (defvar sieve-manage-auth nil)
178 (defvar sieve-manage-server nil)
179 (defvar sieve-manage-port nil)
180 (defvar sieve-manage-state 'closed
182 Valid states are `closed', `initial', `nonauth', and `auth'.")
183 (defvar sieve-manage-process nil)
184 (defvar sieve-manage-capability nil)
186 ;; Internal utility functions
188 (defmacro sieve-manage-disable-multibyte ()
189 "Enable multibyte in the current buffer."
190 (unless (featurep 'xemacs)
191 '(set-buffer-multibyte nil)))
193 (defun sieve-manage-erase (&optional p buffer)
194 (let ((buffer (or buffer (current-buffer))))
195 (and sieve-manage-log
196 (with-current-buffer (get-buffer-create sieve-manage-log)
197 (sieve-manage-disable-multibyte)
198 (buffer-disable-undo)
199 (goto-char (point-max))
200 (insert-buffer-substring buffer (with-current-buffer buffer
202 (or p (with-current-buffer buffer
204 (delete-region (point-min) (or p (point-max))))
206 (defun sieve-manage-open-1 (buffer)
207 (with-current-buffer buffer
209 (setq sieve-manage-state 'initial
212 (funcall (nth 2 (assq sieve-manage-stream
213 sieve-manage-stream-alist))
214 "sieve" buffer sieve-manage-server sieve-manage-port)
216 (when sieve-manage-process
217 (while (and (eq sieve-manage-state 'initial)
218 (memq (process-status sieve-manage-process) '(open run)))
219 (message "Waiting for response from %s..." sieve-manage-server)
220 (accept-process-output sieve-manage-process 1))
221 (message "Waiting for response from %s...done" sieve-manage-server)
222 (and (memq (process-status sieve-manage-process) '(open run))
223 sieve-manage-process))))
227 (defun sieve-manage-network-p (buffer)
230 (defun sieve-manage-network-open (name buffer server port)
231 (let* ((port (or port sieve-manage-default-port))
232 (coding-system-for-read sieve-manage-coding-system-for-read)
233 (coding-system-for-write sieve-manage-coding-system-for-write)
234 (process (open-network-stream name buffer server port)))
236 (while (and (memq (process-status process) '(open run))
237 (set-buffer buffer) ;; XXX "blue moon" nntp.el bug
238 (goto-char (point-min))
239 (not (sieve-manage-parse-greeting-1)))
240 (accept-process-output process 1)
242 (sieve-manage-erase nil buffer)
243 (when (memq (process-status process) '(open run))
246 (defun sieve-manage-starttls-p (buffer)
250 (call-process "starttls"))
253 (defun sieve-manage-starttls-open (name buffer server port)
254 (let* ((port (or port sieve-manage-default-port))
255 (coding-system-for-read sieve-manage-coding-system-for-read)
256 (coding-system-for-write sieve-manage-coding-system-for-write)
257 (process (starttls-open-stream name buffer server port))
260 (while (and (memq (process-status process) '(open run))
261 (set-buffer buffer) ;; XXX "blue moon" nntp.el bug
262 (goto-char (point-min))
263 (not (sieve-manage-parse-greeting-1)))
264 (accept-process-output process 1)
266 (sieve-manage-erase nil buffer)
267 (sieve-manage-send "STARTTLS")
268 (starttls-negotiate process))
269 (when (memq (process-status process) '(open run))
273 (defun sieve-sasl-auth (buffer mech)
274 "Login to server using the SASL MECH method."
275 (message "sieve: Authenticating using %s..." mech)
276 (with-current-buffer buffer
277 (let* ((user-password (auth-source-user-or-password
278 '("login" "password")
281 (client (sasl-make-client (sasl-find-mechanism (list mech))
282 (car user-password) "sieve" sieve-manage-server))
283 (sasl-read-passphrase
284 ;; We *need* to copy the password, because sasl will modify it
286 `(lambda (prompt) ,(copy-sequence (cadr user-password))))
287 (step (sasl-next-step client nil))
288 (tag (sieve-manage-send
293 (and (sasl-step-data step)
296 (base64-encode-string
297 (sasl-step-data step)
304 (goto-char (point-min))
305 (while (null (or (progn
306 (setq rsp (sieve-manage-is-string))
307 (if (not (and rsp (looking-at
308 sieve-manage-server-eol)))
310 (goto-char (match-end 0))
312 (setq rsp (sieve-manage-is-okno))))
313 (accept-process-output sieve-manage-process 1)
314 (goto-char (point-min)))
316 (when (sieve-manage-ok-p rsp)
317 (when (and (cadr rsp)
318 (string-match "^SASL \"\\([^\"]+\\)\"" (cadr rsp)))
320 step (base64-decode-string (match-string 1 (cadr rsp)))))
321 (if (and (setq step (sasl-next-step client step))
322 (setq data (sasl-step-data step)))
323 ;; We got data for server but it's finished
324 (error "Server not ready for SASL data: %s" data)
325 ;; The authentication process is finished.
327 (unless (stringp rsp)
328 (error "Server aborted SASL authentication: %s" (caddr rsp)))
329 (sasl-step-set-data step (base64-decode-string rsp))
330 (setq step (sasl-next-step client step))
332 (if (sasl-step-data step)
334 (base64-encode-string (sasl-step-data step)
338 (message "sieve: Login using %s...done" mech))))
340 (defun sieve-manage-cram-md5-p (buffer)
341 (sieve-manage-capability "SASL" "CRAM-MD5" buffer))
343 (defun sieve-manage-cram-md5-auth (buffer)
344 "Login to managesieve server using the CRAM-MD5 SASL method."
345 (sieve-sasl-auth buffer "CRAM-MD5"))
347 (defun sieve-manage-digest-md5-p (buffer)
348 (sieve-manage-capability "SASL" "DIGEST-MD5" buffer))
350 (defun sieve-manage-digest-md5-auth (buffer)
351 "Login to managesieve server using the DIGEST-MD5 SASL method."
352 (sieve-sasl-auth buffer "DIGEST-MD5"))
354 (defun sieve-manage-scram-md5-p (buffer)
355 (sieve-manage-capability "SASL" "SCRAM-MD5" buffer))
357 (defun sieve-manage-scram-md5-auth (buffer)
358 "Login to managesieve server using the SCRAM-MD5 SASL method."
359 (sieve-sasl-auth buffer "SCRAM-MD5"))
361 (defun sieve-manage-ntlm-p (buffer)
362 (sieve-manage-capability "SASL" "NTLM" buffer))
364 (defun sieve-manage-ntlm-auth (buffer)
365 "Login to managesieve server using the NTLM SASL method."
366 (sieve-sasl-auth buffer "NTLM"))
368 (defun sieve-manage-plain-p (buffer)
369 (sieve-manage-capability "SASL" "PLAIN" buffer))
371 (defun sieve-manage-plain-auth (buffer)
372 "Login to managesieve server using the PLAIN SASL method."
373 (sieve-sasl-auth buffer "PLAIN"))
375 (defun sieve-manage-login-p (buffer)
376 (sieve-manage-capability "SASL" "LOGIN" buffer))
378 (defun sieve-manage-login-auth (buffer)
379 "Login to managesieve server using the LOGIN SASL method."
380 (sieve-sasl-auth buffer "LOGIN"))
384 (defun sieve-manage-open (server &optional port stream auth buffer)
385 "Open a network connection to a managesieve SERVER (string).
386 Optional argument PORT is port number (integer) on remote server.
387 Optional argument STREAM is any of `sieve-manage-streams' (a symbol).
388 Optional argument AUTH indicates authenticator to use, see
389 `sieve-manage-authenticators' for available authenticators.
390 If nil, chooses the best stream the server is capable of.
391 Optional argument BUFFER is buffer (buffer, or string naming buffer)
393 (setq buffer (or buffer (format " *sieve* %s:%s" server (or port sieve-manage-default-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 (or port sieve-manage-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