1 ;;; sieve-manage.el --- Implementation of the managesive protocol in elisp
3 ;; Copyright (C) 2001, 2002, 2003, 2004, 2005 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 2, or (at your option)
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; see the file COPYING. If not, write to the
21 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
22 ;; Boston, MA 02110-1301, USA.
26 ;; This library provides an elisp API for the managesieve network
29 ;; It uses the SASL library for authentication, which means it
30 ;; supports DIGEST-MD5, CRAM-MD5, SCRAM-MD5, NTLM, PLAIN and LOGIN
31 ;; methods. STARTTLS is not well tested, but should be easy to get to
32 ;; work if someone wants.
34 ;; The API should be fairly obvious for anyone familiar with the
35 ;; managesieve protocol, interface functions include:
37 ;; `sieve-manage-open'
38 ;; open connection to managesieve server, returning a buffer to be
39 ;; used by all other API functions.
41 ;; `sieve-manage-opened'
42 ;; check if a server is open or not
44 ;; `sieve-manage-close'
45 ;; close a server connection.
47 ;; `sieve-manage-authenticate'
48 ;; `sieve-manage-listscripts'
49 ;; `sieve-manage-deletescript'
50 ;; `sieve-manage-getscript'
51 ;; performs managesieve protocol actions
53 ;; and that's it. Example of a managesieve session in *scratch*:
55 ;; (setq my-buf (sieve-manage-open "my.server.com"))
56 ;; " *sieve* my.server.com:2000*"
58 ;; (sieve-manage-authenticate "myusername" "mypassword" my-buf)
61 ;; (sieve-manage-listscripts my-buf)
62 ;; ("vacation" "testscript" ("splitmail") "badscript")
66 ;; draft-martin-managesieve-02.txt,
67 ;; "A Protocol for Remotely Managing Sieve Scripts",
72 ;; 2001-10-31 Committed to Oort Gnus.
73 ;; 2002-07-27 Added DELETESCRIPT. Suggested by Ned Ludd.
74 ;; 2002-08-03 Use SASL library.
83 (autoload 'sasl-find-mechanism "sasl")
84 (autoload 'starttls-open-stream "starttls"))
86 ;; User customizable variables:
88 (defgroup sieve-manage nil
89 "Low-level Managesieve protocol issues."
93 (defcustom sieve-manage-log "*sieve-manage-log*"
94 "Name of buffer for managesieve session trace."
98 (defcustom sieve-manage-default-user (user-login-name)
99 "Default username to use."
101 :group 'sieve-manage)
103 (defcustom sieve-manage-server-eol "\r\n"
104 "The EOL string sent from the server."
106 :group 'sieve-manage)
108 (defcustom sieve-manage-client-eol "\r\n"
109 "The EOL string we send to the server."
111 :group 'sieve-manage)
113 (defcustom sieve-manage-streams '(network starttls shell)
114 "Priority of streams to consider when opening connection to server."
115 :group 'sieve-manage)
117 (defcustom sieve-manage-stream-alist
118 '((network sieve-manage-network-p sieve-manage-network-open)
119 (shell sieve-manage-shell-p sieve-manage-shell-open)
120 (starttls sieve-manage-starttls-p sieve-manage-starttls-open))
121 "Definition of network streams.
125 NAME names the stream, CHECK is a function returning non-nil if the
126 server support the stream and OPEN is a function for opening the
128 :group 'sieve-manage)
130 (defcustom sieve-manage-authenticators '(digest-md5
136 "Priority of authenticators to consider when authenticating to server."
137 :group 'sieve-manage)
139 (defcustom sieve-manage-authenticator-alist
140 '((cram-md5 sieve-manage-cram-md5-p sieve-manage-cram-md5-auth)
141 (digest-md5 sieve-manage-digest-md5-p sieve-manage-digest-md5-auth)
142 (scram-md5 sieve-manage-scram-md5-p sieve-manage-scram-md5-auth)
143 (ntlm sieve-manage-ntlm-p sieve-manage-ntlm-auth)
144 (plain sieve-manage-plain-p sieve-manage-plain-auth)
145 (login sieve-manage-login-p sieve-manage-login-auth))
146 "Definition of authenticators.
148 \(NAME CHECK AUTHENTICATE)
150 NAME names the authenticator. CHECK is a function returning non-nil if
151 the server support the authenticator and AUTHENTICATE is a function
152 for doing the actual authentication."
153 :group 'sieve-manage)
155 (defcustom sieve-manage-default-port 2000
156 "Default port number for managesieve protocol."
158 :group 'sieve-manage)
160 ;; Internal variables:
162 (defconst sieve-manage-local-variables '(sieve-manage-server
166 sieve-manage-username
167 sieve-manage-password
169 sieve-manage-client-eol
170 sieve-manage-server-eol
171 sieve-manage-capability))
172 (defconst sieve-manage-default-stream 'network)
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-username nil)
180 (defvar sieve-manage-password nil)
181 (defvar sieve-manage-state 'closed
183 Valid states are `closed', `initial', `nonauth', and `auth'.")
184 (defvar sieve-manage-process nil)
185 (defvar sieve-manage-capability nil)
187 ;; Internal utility functions
189 (defsubst sieve-manage-disable-multibyte ()
190 "Enable multibyte in the current buffer."
191 (when (fboundp 'set-buffer-multibyte)
192 (set-buffer-multibyte nil)))
194 ;; Uses the dynamically bound `reason' variable.
196 (defun sieve-manage-interactive-login (buffer loginfunc)
197 "Login to server in BUFFER.
198 LOGINFUNC is passed a username and a password, it should return t if
199 it where sucessful authenticating itself to the server, nil otherwise.
200 Returns t if login was successful, nil otherwise."
201 (with-current-buffer buffer
202 (make-local-variable 'sieve-manage-username)
203 (make-local-variable 'sieve-manage-password)
204 (let (user passwd ret reason passwd-key)
206 (while (or (not user) (not passwd))
207 (setq user (or sieve-manage-username
208 (read-from-minibuffer
209 (concat "Managesieve username for "
210 sieve-manage-server ": ")
211 (or user sieve-manage-default-user)))
212 passwd-key (concat "managesieve:" user "@" sieve-manage-server
213 ":" sieve-manage-port)
214 passwd (or sieve-manage-password
215 (password-read (concat "Managesieve password for "
216 user "@" sieve-manage-server
219 (when (y-or-n-p "Store password for this session? ")
220 (password-cache-add passwd-key (copy-sequence passwd)))
221 (when (and user passwd)
222 (if (funcall loginfunc user passwd)
224 sieve-manage-username user)
226 (message "Login failed (reason given: %s)..." reason)
227 (message "Login failed..."))
228 (password-cache-remove passwd-key)
229 (setq sieve-manage-password nil)
233 (quit (with-current-buffer buffer
234 (password-cache-remove passwd-key)
237 sieve-manage-password nil)))
238 (error (with-current-buffer buffer
239 (password-cache-remove passwd-key)
242 sieve-manage-password nil))))
245 (defun sieve-manage-erase (&optional p buffer)
246 (let ((buffer (or buffer (current-buffer))))
247 (and sieve-manage-log
248 (with-current-buffer (get-buffer-create sieve-manage-log)
249 (sieve-manage-disable-multibyte)
250 (buffer-disable-undo)
251 (goto-char (point-max))
252 (insert-buffer-substring buffer (with-current-buffer buffer
254 (or p (with-current-buffer buffer
256 (delete-region (point-min) (or p (point-max))))
258 (defun sieve-manage-open-1 (buffer)
259 (with-current-buffer buffer
261 (setq sieve-manage-state 'initial
264 (funcall (nth 2 (assq sieve-manage-stream
265 sieve-manage-stream-alist))
266 "sieve" buffer sieve-manage-server sieve-manage-port)
268 (when sieve-manage-process
269 (while (and (eq sieve-manage-state 'initial)
270 (memq (process-status sieve-manage-process) '(open run)))
271 (message "Waiting for response from %s..." sieve-manage-server)
272 (accept-process-output sieve-manage-process 1))
273 (message "Waiting for response from %s...done" sieve-manage-server)
274 (and (memq (process-status sieve-manage-process) '(open run))
275 sieve-manage-process))))
279 (defun sieve-manage-network-p (buffer)
282 (defun sieve-manage-network-open (name buffer server port)
283 (let* ((port (or port sieve-manage-default-port))
284 (coding-system-for-read sieve-manage-coding-system-for-read)
285 (coding-system-for-write sieve-manage-coding-system-for-write)
286 (process (open-network-stream name buffer server port)))
288 (while (and (memq (process-status process) '(open run))
289 (set-buffer buffer) ;; XXX "blue moon" nntp.el bug
290 (goto-char (point-min))
291 (not (sieve-manage-parse-greeting-1)))
292 (accept-process-output process 1)
294 (sieve-manage-erase nil buffer)
295 (when (memq (process-status process) '(open run))
298 (defun imap-starttls-p (buffer)
299 ;; (and (imap-capability 'STARTTLS buffer)
303 (call-process "starttls"))
306 (defun imap-starttls-open (name buffer server port)
307 (let* ((port (or port sieve-manage-default-port))
308 (coding-system-for-read sieve-manage-coding-system-for-read)
309 (coding-system-for-write sieve-manage-coding-system-for-write)
310 (process (starttls-open-stream name buffer server port))
313 (while (and (memq (process-status process) '(open run))
314 (set-buffer buffer) ;; XXX "blue moon" nntp.el bug
315 (goto-char (point-min))
316 (not (sieve-manage-parse-greeting-1)))
317 (accept-process-output process 1)
319 (sieve-manage-erase nil buffer)
320 (sieve-manage-send "STARTTLS")
321 (starttls-negotiate process))
322 (when (memq (process-status process) '(open run))
327 (defun sieve-sasl-auth (buffer mech)
328 "Login to server using the SASL MECH method."
329 (message "sieve: Authenticating using %s..." mech)
330 (if (sieve-manage-interactive-login
332 (lambda (user passwd)
333 (let (client step tag data rsp)
334 (setq client (sasl-make-client (sasl-find-mechanism (list mech))
335 user "sieve" sieve-manage-server))
336 (setq sasl-read-passphrase (function (lambda (prompt) passwd)))
337 (setq step (sasl-next-step client nil))
344 (and (sasl-step-data step)
347 (base64-encode-string
348 (sasl-step-data step)
354 (goto-char (point-min))
355 (while (null (or (progn
356 (setq rsp (sieve-manage-is-string))
357 (if (not (and rsp (looking-at
358 sieve-manage-server-eol)))
360 (goto-char (match-end 0))
362 (setq rsp (sieve-manage-is-okno))))
363 (accept-process-output sieve-manage-process 1)
364 (goto-char (point-min)))
366 (when (sieve-manage-ok-p rsp)
367 (when (string-match "^SASL \"\\([^\"]+\\)\"" (cadr rsp))
369 step (base64-decode-string (match-string 1 (cadr rsp)))))
370 (if (and (setq step (sasl-next-step client step))
371 (setq data (sasl-step-data step)))
372 ;; We got data for server but it's finished
373 (error "Server not ready for SASL data: %s" data)
374 ;; The authentication process is finished.
376 (unless (stringp rsp)
377 (apply 'error "Server aborted SASL authentication: %s %s %s"
379 (sasl-step-set-data step (base64-decode-string rsp))
380 (setq step (sasl-next-step client step))
382 (if (sasl-step-data step)
384 (base64-encode-string (sasl-step-data step)
388 (message "sieve: Authenticating using %s...done" mech)
389 (message "sieve: Authenticating using %s...failed" mech)))
391 (defun sieve-manage-cram-md5-p (buffer)
392 (sieve-manage-capability "SASL" "CRAM-MD5" buffer))
394 (defun sieve-manage-cram-md5-auth (buffer)
395 "Login to managesieve server using the CRAM-MD5 SASL method."
396 (sieve-sasl-auth buffer "CRAM-MD5"))
398 (defun sieve-manage-digest-md5-p (buffer)
399 (sieve-manage-capability "SASL" "DIGEST-MD5" buffer))
401 (defun sieve-manage-digest-md5-auth (buffer)
402 "Login to managesieve server using the DIGEST-MD5 SASL method."
403 (sieve-sasl-auth buffer "DIGEST-MD5"))
405 (defun sieve-manage-scram-md5-p (buffer)
406 (sieve-manage-capability "SASL" "SCRAM-MD5" buffer))
408 (defun sieve-manage-scram-md5-auth (buffer)
409 "Login to managesieve server using the SCRAM-MD5 SASL method."
410 (sieve-sasl-auth buffer "SCRAM-MD5"))
412 (defun sieve-manage-ntlm-p (buffer)
413 (sieve-manage-capability "SASL" "NTLM" buffer))
415 (defun sieve-manage-ntlm-auth (buffer)
416 "Login to managesieve server using the NTLM SASL method."
417 (sieve-sasl-auth buffer "NTLM"))
419 (defun sieve-manage-plain-p (buffer)
420 (sieve-manage-capability "SASL" "PLAIN" buffer))
422 (defun sieve-manage-plain-auth (buffer)
423 "Login to managesieve server using the PLAIN SASL method."
424 (sieve-sasl-auth buffer "PLAIN"))
426 (defun sieve-manage-login-p (buffer)
427 (sieve-manage-capability "SASL" "LOGIN" buffer))
429 (defun sieve-manage-login-auth (buffer)
430 "Login to managesieve server using the LOGIN SASL method."
431 (sieve-sasl-auth buffer "LOGIN"))
435 (defun sieve-manage-open (server &optional port stream auth buffer)
436 "Open a network connection to a managesieve SERVER (string).
437 Optional variable PORT is port number (integer) on remote server.
438 Optional variable STREAM is any of `sieve-manage-streams' (a symbol).
439 Optional variable AUTH indicates authenticator to use, see
440 `sieve-manage-authenticators' for available authenticators. If nil, chooses
441 the best stream the server is capable of.
442 Optional variable BUFFER is buffer (buffer, or string naming buffer)
444 (setq buffer (or buffer (format " *sieve* %s:%d" server (or port 2000))))
445 (with-current-buffer (get-buffer-create buffer)
446 (mapc 'make-local-variable sieve-manage-local-variables)
447 (sieve-manage-disable-multibyte)
448 (buffer-disable-undo)
449 (setq sieve-manage-server (or server sieve-manage-server))
450 (setq sieve-manage-port (or port sieve-manage-port))
451 (setq sieve-manage-stream (or stream sieve-manage-stream))
452 (message "sieve: Connecting to %s..." sieve-manage-server)
453 (if (let ((sieve-manage-stream
454 (or sieve-manage-stream sieve-manage-default-stream)))
455 (sieve-manage-open-1 buffer))
457 (let (stream-changed)
458 (message "sieve: Connecting to %s...done" sieve-manage-server)
459 (when (null sieve-manage-stream)
460 (let ((streams sieve-manage-streams))
461 (while (setq stream (pop streams))
462 (if (funcall (nth 1 (assq stream
463 sieve-manage-stream-alist)) buffer)
465 (not (eq (or sieve-manage-stream
466 sieve-manage-default-stream)
468 sieve-manage-stream stream
470 (unless sieve-manage-stream
471 (error "Couldn't figure out a stream for server"))))
473 (message "sieve: Reconnecting with stream `%s'..."
475 (sieve-manage-close buffer)
476 (if (sieve-manage-open-1 buffer)
477 (message "sieve: Reconnecting with stream `%s'...done"
479 (message "sieve: Reconnecting with stream `%s'...failed"
480 sieve-manage-stream))
481 (setq sieve-manage-capability nil))
482 (if (sieve-manage-opened buffer)
483 ;; Choose authenticator
484 (when (and (null sieve-manage-auth)
485 (not (eq sieve-manage-state 'auth)))
486 (let ((auths sieve-manage-authenticators))
487 (while (setq auth (pop auths))
488 (if (funcall (nth 1 (assq
490 sieve-manage-authenticator-alist))
492 (setq sieve-manage-auth auth
494 (unless sieve-manage-auth
495 (error "Couldn't figure out authenticator for server"))))))
496 (message "sieve: Connecting to %s...failed" sieve-manage-server))
497 (when (sieve-manage-opened buffer)
501 (defun sieve-manage-opened (&optional buffer)
502 "Return non-nil if connection to managesieve server in BUFFER is open.
503 If BUFFER is nil then the current buffer is used."
504 (and (setq buffer (get-buffer (or buffer (current-buffer))))
505 (buffer-live-p buffer)
506 (with-current-buffer buffer
507 (and sieve-manage-process
508 (memq (process-status sieve-manage-process) '(open run))))))
510 (defun sieve-manage-close (&optional buffer)
511 "Close connection to managesieve server in BUFFER.
512 If BUFFER is nil, the current buffer is used."
513 (with-current-buffer (or buffer (current-buffer))
514 (when (sieve-manage-opened)
515 (sieve-manage-send "LOGOUT")
517 (when (and sieve-manage-process
518 (memq (process-status sieve-manage-process) '(open run)))
519 (delete-process sieve-manage-process))
520 (setq sieve-manage-process nil)
524 (defun sieve-manage-authenticate (&optional user passwd buffer)
525 "Authenticate to server in BUFFER, using current buffer if nil.
526 It uses the authenticator specified when opening the server. If the
527 authenticator requires username/passwords, they are queried from the
528 user and optionally stored in the buffer. If USER and/or PASSWD is
529 specified, the user will not be questioned and the username and/or
530 password is remembered in the buffer."
531 (with-current-buffer (or buffer (current-buffer))
532 (if (not (eq sieve-manage-state 'nonauth))
533 (eq sieve-manage-state 'auth)
534 (make-local-variable 'sieve-manage-username)
535 (make-local-variable 'sieve-manage-password)
536 (if user (setq sieve-manage-username user))
537 (if passwd (setq sieve-manage-password passwd))
538 (if (funcall (nth 2 (assq sieve-manage-auth
539 sieve-manage-authenticator-alist)) buffer)
540 (setq sieve-manage-state 'auth)))))
542 (defun sieve-manage-capability (&optional name value buffer)
543 (with-current-buffer (or buffer (current-buffer))
545 sieve-manage-capability
547 (nth 1 (assoc name sieve-manage-capability))
548 (when (string-match value (nth 1 (assoc name sieve-manage-capability)))
549 (nth 1 (assoc name sieve-manage-capability)))))))
551 (defun sieve-manage-listscripts (&optional buffer)
552 (with-current-buffer (or buffer (current-buffer))
553 (sieve-manage-send "LISTSCRIPTS")
554 (sieve-manage-parse-listscripts)))
556 (defun sieve-manage-havespace (name size &optional buffer)
557 (with-current-buffer (or buffer (current-buffer))
558 (sieve-manage-send (format "HAVESPACE \"%s\" %s" name size))
559 (sieve-manage-parse-okno)))
562 (if (fboundp 'string-bytes)
563 (defalias 'sieve-string-bytes 'string-bytes)
564 (defalias 'sieve-string-bytes 'length)))
566 (defun sieve-manage-putscript (name content &optional buffer)
567 (with-current-buffer (or buffer (current-buffer))
568 (sieve-manage-send (format "PUTSCRIPT \"%s\" {%d+}%s%s" name
569 (sieve-string-bytes content)
570 sieve-manage-client-eol content))
571 (sieve-manage-parse-okno)))
573 (defun sieve-manage-deletescript (name &optional buffer)
574 (with-current-buffer (or buffer (current-buffer))
575 (sieve-manage-send (format "DELETESCRIPT \"%s\"" name))
576 (sieve-manage-parse-okno)))
578 (defun sieve-manage-getscript (name output-buffer &optional buffer)
579 (with-current-buffer (or buffer (current-buffer))
580 (sieve-manage-send (format "GETSCRIPT \"%s\"" name))
581 (let ((script (sieve-manage-parse-string)))
582 (sieve-manage-parse-crlf)
583 (with-current-buffer output-buffer
585 (sieve-manage-parse-okno))))
587 (defun sieve-manage-setactive (name &optional buffer)
588 (with-current-buffer (or buffer (current-buffer))
589 (sieve-manage-send (format "SETACTIVE \"%s\"" name))
590 (sieve-manage-parse-okno)))
592 ;; Protocol parsing routines
594 (defun sieve-manage-ok-p (rsp)
595 (string= (downcase (or (car-safe rsp) "")) "ok"))
597 (defsubst sieve-manage-forward ()
598 (or (eobp) (forward-char)))
600 (defun sieve-manage-is-okno ()
601 (when (looking-at (concat
602 "^\\(OK\\|NO\\)\\( (\\([^)]+\\))\\)?\\( \\(.*\\)\\)?"
603 sieve-manage-server-eol))
604 (let ((status (match-string 1))
605 (resp-code (match-string 3))
606 (response (match-string 5)))
608 (goto-char (match-beginning 5))
609 (setq response (sieve-manage-is-string)))
610 (list status resp-code response))))
612 (defun sieve-manage-parse-okno ()
615 (accept-process-output (get-buffer-process (current-buffer)) 1)
616 (goto-char (point-min))
617 (setq rsp (sieve-manage-is-okno)))
621 (defun sieve-manage-parse-capability-1 ()
622 "Accept a managesieve greeting."
624 (while (setq str (sieve-manage-is-string))
625 (if (eq (char-after) ? )
627 (sieve-manage-forward)
628 (push (list str (sieve-manage-is-string))
629 sieve-manage-capability))
630 (push (list str) sieve-manage-capability))
632 (when (re-search-forward (concat "^OK" sieve-manage-server-eol) nil t)
633 (setq sieve-manage-state 'nonauth)))
635 (defalias 'sieve-manage-parse-greeting-1 'sieve-manage-parse-capability-1)
637 (defun sieve-manage-is-string ()
638 (cond ((looking-at "\"\\([^\"]+\\)\"")
641 (goto-char (match-end 0))))
642 ((looking-at (concat "{\\([0-9]+\\)}" sieve-manage-server-eol))
643 (let ((pos (match-end 0))
644 (len (string-to-number (match-string 1))))
645 (if (< (point-max) (+ pos len))
647 (goto-char (+ pos len))
648 (buffer-substring pos (+ pos len)))))))
650 (defun sieve-manage-parse-string ()
653 (accept-process-output (get-buffer-process (current-buffer)) 1)
654 (goto-char (point-min))
655 (setq rsp (sieve-manage-is-string)))
656 (sieve-manage-erase (point))
659 (defun sieve-manage-parse-crlf ()
660 (when (looking-at sieve-manage-server-eol)
661 (sieve-manage-erase (match-end 0))))
663 (defun sieve-manage-parse-listscripts ()
666 (while (null (or (setq rsp (sieve-manage-is-okno))
667 (setq tmp (sieve-manage-is-string))))
668 (accept-process-output (get-buffer-process (current-buffer)) 1)
669 (goto-char (point-min)))
671 (while (not (looking-at (concat "\\( ACTIVE\\)?"
672 sieve-manage-server-eol)))
673 (accept-process-output (get-buffer-process (current-buffer)) 1)
674 (goto-char (point-min)))
676 (push (cons 'active tmp) data)
678 (goto-char (match-end 0))
681 (if (sieve-manage-ok-p rsp)
685 (defun sieve-manage-send (cmdstr)
686 (setq cmdstr (concat cmdstr sieve-manage-client-eol))
687 (and sieve-manage-log
688 (with-current-buffer (get-buffer-create sieve-manage-log)
689 (sieve-manage-disable-multibyte)
690 (buffer-disable-undo)
691 (goto-char (point-max))
693 (process-send-string sieve-manage-process cmdstr))
695 (provide 'sieve-manage)
697 ;; sieve-manage.el ends here