1 ;;; sieve-manage.el --- Implementation of the managesive protocol in elisp
2 ;; Copyright (C) 2001, 2003 Free Software Foundation, Inc.
4 ;; Author: Simon Josefsson <simon@josefsson.org>
6 ;; This file is not part of GNU Emacs, but the same permissions apply.
8 ;; GNU Emacs is free software; you can redistribute it and/or modify
9 ;; it under the terms of the GNU General Public License as published by
10 ;; the Free Software Foundation; either version 2, or (at your option)
13 ;; GNU Emacs is distributed in the hope that it will be useful,
14 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
15 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 ;; GNU General Public License for more details.
18 ;; You should have received a copy of the GNU General Public License
19 ;; along with GNU Emacs; see the file COPYING. If not, write to the
20 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21 ;; Boston, MA 02111-1307, USA.
25 ;; This library provides an elisp API for the managesieve network
28 ;; Currently only the CRAM-MD5 authentication mechanism is supported.
30 ;; The API should be fairly obvious for anyone familiar with the
31 ;; managesieve protocol, interface functions include:
33 ;; `sieve-manage-open'
34 ;; open connection to managesieve server, returning a buffer to be
35 ;; used by all other API functions.
37 ;; `sieve-manage-opened'
38 ;; check if a server is open or not
40 ;; `sieve-manage-close'
41 ;; close a server connection.
43 ;; `sieve-manage-authenticate'
44 ;; `sieve-manage-listscripts'
45 ;; `sieve-manage-deletescript'
46 ;; `sieve-manage-getscript'
47 ;; performs managesieve protocol actions
49 ;; and that's it. Example of a managesieve session in *scratch*:
51 ;; (setq my-buf (sieve-manage-open "my.server.com"))
52 ;; " *sieve* my.server.com:2000*"
54 ;; (sieve-manage-authenticate "myusername" "mypassword" my-buf)
57 ;; (sieve-manage-listscripts my-buf)
58 ;; ("vacation" "testscript" ("splitmail") "badscript")
62 ;; draft-martin-managesieve-02.txt,
63 ;; "A Protocol for Remotely Managing Sieve Scripts",
68 ;; 2001-10-31 Committed to Oort Gnus.
69 ;; 2002-07-27 Added DELETESCRIPT. Suggested by Ned Ludd.
77 (autoload 'starttls-open-stream "starttls"))
79 ;; User customizable variables:
81 (defgroup sieve-manage nil
82 "Low-level Managesieve protocol issues."
86 (defcustom sieve-manage-log "*sieve-manage-log*"
87 "Name of buffer for managesieve session trace."
90 (defcustom sieve-manage-default-user (user-login-name)
91 "Default username to use."
94 (defcustom sieve-manage-server-eol "\r\n"
95 "The EOL string sent from the server."
98 (defcustom sieve-manage-client-eol "\r\n"
99 "The EOL string we send to the server."
102 (defcustom sieve-manage-streams '(network starttls shell)
103 "Priority of streams to consider when opening connection to server.")
105 (defcustom sieve-manage-stream-alist
106 '((network sieve-manage-network-p sieve-manage-network-open)
107 (shell sieve-manage-shell-p sieve-manage-shell-open)
108 (starttls sieve-manage-starttls-p sieve-manage-starttls-open))
109 "Definition of network streams.
113 NAME names the stream, CHECK is a function returning non-nil if the
114 server support the stream and OPEN is a function for opening the
117 (defcustom sieve-manage-authenticators '(cram-md5 plain)
118 "Priority of authenticators to consider when authenticating to server.")
120 (defcustom sieve-manage-authenticator-alist
121 '((cram-md5 sieve-manage-cram-md5-p sieve-manage-cram-md5-auth)
122 (plain sieve-manage-plain-p sieve-manage-plain-auth))
123 "Definition of authenticators.
125 \(NAME CHECK AUTHENTICATE)
127 NAME names the authenticator. CHECK is a function returning non-nil if
128 the server support the authenticator and AUTHENTICATE is a function
129 for doing the actual authentication.")
131 (defcustom sieve-manage-default-port 2000
132 "Default port number for managesieve protocol."
135 ;; Internal variables:
137 (defconst sieve-manage-local-variables '(sieve-manage-server
141 sieve-manage-username
142 sieve-manage-password
144 sieve-manage-client-eol
145 sieve-manage-server-eol
146 sieve-manage-capability))
147 (defconst sieve-manage-default-stream 'network)
148 (defconst sieve-manage-coding-system-for-read 'binary)
149 (defconst sieve-manage-coding-system-for-write 'binary)
150 (defvar sieve-manage-stream nil)
151 (defvar sieve-manage-auth nil)
152 (defvar sieve-manage-server nil)
153 (defvar sieve-manage-port nil)
154 (defvar sieve-manage-username nil)
155 (defvar sieve-manage-password nil)
156 (defvar sieve-manage-state 'closed
158 Valid states are `closed', `initial', `nonauth', and `auth'.")
159 (defvar sieve-manage-process nil)
160 (defvar sieve-manage-capability nil)
162 ;; Internal utility functions
164 (defsubst sieve-manage-disable-multibyte ()
165 "Enable multibyte in the current buffer."
166 (when (fboundp 'set-buffer-multibyte)
167 (set-buffer-multibyte nil)))
169 ;; Uses the dynamically bound `reason' variable.
171 (defun sieve-manage-interactive-login (buffer loginfunc)
172 "Login to server in BUFFER.
173 LOGINFUNC is passed a username and a password, it should return t if
174 it where sucessful authenticating itself to the server, nil otherwise.
175 Returns t if login was successful, nil otherwise."
176 (with-current-buffer buffer
177 (make-variable-buffer-local 'sieve-manage-username)
178 (make-variable-buffer-local 'sieve-manage-password)
179 (let (user passwd ret reason)
180 ;; (condition-case ()
181 (while (or (not user) (not passwd))
182 (setq user (or sieve-manage-username
183 (read-from-minibuffer
184 (concat "Managesieve username for "
185 sieve-manage-server ": ")
186 (or user sieve-manage-default-user))))
187 (setq passwd (or sieve-manage-password
189 (concat "Managesieve password for " user "@"
190 sieve-manage-server ": "))))
191 (when (and user passwd)
192 (if (funcall loginfunc user passwd)
195 sieve-manage-username user)
196 (if (and (not sieve-manage-password)
197 (y-or-n-p "Store password for this session? "))
198 (setq sieve-manage-password passwd)))
200 (message "Login failed (reason given: %s)..." reason)
201 (message "Login failed..."))
205 ;; (quit (with-current-buffer buffer
208 ;; (error (with-current-buffer buffer
213 (defun sieve-manage-erase (&optional p buffer)
214 (let ((buffer (or buffer (current-buffer))))
215 (and sieve-manage-log
216 (with-current-buffer (get-buffer-create sieve-manage-log)
217 (sieve-manage-disable-multibyte)
218 (buffer-disable-undo)
219 (goto-char (point-max))
220 (insert-buffer-substring buffer (with-current-buffer buffer
222 (or p (with-current-buffer buffer
224 (delete-region (point-min) (or p (point-max))))
226 (defun sieve-manage-open-1 (buffer)
227 (with-current-buffer buffer
229 (setq sieve-manage-state 'initial
232 (funcall (nth 2 (assq sieve-manage-stream
233 sieve-manage-stream-alist))
234 "sieve" buffer sieve-manage-server sieve-manage-port)
236 (when sieve-manage-process
237 (while (and (eq sieve-manage-state 'initial)
238 (memq (process-status sieve-manage-process) '(open run)))
239 (message "Waiting for response from %s..." sieve-manage-server)
240 (accept-process-output sieve-manage-process 1))
241 (message "Waiting for response from %s...done" sieve-manage-server)
242 (and (memq (process-status sieve-manage-process) '(open run))
243 sieve-manage-process))))
247 (defun sieve-manage-network-p (buffer)
250 (defun sieve-manage-network-open (name buffer server port)
251 (let* ((port (or port sieve-manage-default-port))
252 (coding-system-for-read sieve-manage-coding-system-for-read)
253 (coding-system-for-write sieve-manage-coding-system-for-write)
254 (process (open-network-stream name buffer server port)))
256 (while (and (memq (process-status process) '(open run))
257 (set-buffer buffer) ;; XXX "blue moon" nntp.el bug
258 (goto-char (point-min))
259 (not (sieve-manage-parse-greeting-1)))
260 (accept-process-output process 1)
262 (sieve-manage-erase nil buffer)
263 (when (memq (process-status process) '(open run))
266 (defun imap-starttls-p (buffer)
267 ;; (and (imap-capability 'STARTTLS buffer)
271 (call-process "starttls"))
274 (defun imap-starttls-open (name buffer server port)
275 (let* ((port (or port sieve-manage-default-port))
276 (coding-system-for-read sieve-manage-coding-system-for-read)
277 (coding-system-for-write sieve-manage-coding-system-for-write)
278 (process (starttls-open-stream name buffer server port))
281 (while (and (memq (process-status process) '(open run))
282 (set-buffer buffer) ;; XXX "blue moon" nntp.el bug
283 (goto-char (point-min))
284 (not (sieve-manage-parse-greeting-1)))
285 (accept-process-output process 1)
287 (sieve-manage-erase nil buffer)
288 (sieve-manage-send "STARTTLS")
289 (starttls-negotiate process))
290 (when (memq (process-status process) '(open run))
295 (defun sieve-manage-plain-p (buffer)
296 (sieve-manage-capability "SASL" "PLAIN" buffer))
298 (defun sieve-manage-plain-auth (buffer)
299 "Login to managesieve server using the PLAIN SASL method."
300 (let* ((done (sieve-manage-interactive-login
302 (lambda (user passwd)
303 (sieve-manage-send (concat "AUTHENTICATE \"PLAIN\" \""
304 (base64-encode-string
305 (concat (char-to-string 0)
310 (let ((rsp (sieve-manage-parse-okno)))
311 (if (sieve-manage-ok-p rsp)
313 (setq reason (cdr-safe rsp))
316 (message "sieve: Authenticating using PLAIN...done")
317 (message "sieve: Authenticating using PLAIN...failed"))))
319 (defun sieve-manage-cram-md5-p (buffer)
320 (sieve-manage-capability "SASL" "CRAM-MD5" buffer))
322 (defun sieve-manage-cram-md5-auth (buffer)
323 "Login to managesieve server using the CRAM-MD5 SASL method."
324 (message "sieve: Authenticating using CRAM-MD5...")
325 (let* ((done (sieve-manage-interactive-login
327 (lambda (user passwd)
328 (sieve-manage-send "AUTHENTICATE \"CRAM-MD5\"")
332 (base64-encode-string
335 (rfc2104-hash 'md5 64 16 passwd
336 (base64-decode-string
338 (sieve-manage-parse-string)
339 (sieve-manage-erase))))))
341 (let ((rsp (sieve-manage-parse-okno)))
342 (if (sieve-manage-ok-p rsp)
344 (setq reason (cdr-safe rsp))
347 (message "sieve: Authenticating using CRAM-MD5...done")
348 (message "sieve: Authenticating using CRAM-MD5...failed"))))
352 (defun sieve-manage-open (server &optional port stream auth buffer)
353 "Open a network connection to a managesieve SERVER (string).
354 Optional variable PORT is port number (integer) on remote server.
355 Optional variable STREAM is any of `sieve-manage-streams' (a symbol).
356 Optional variable AUTH indicates authenticator to use, see
357 `sieve-manage-authenticators' for available authenticators. If nil, chooses
358 the best stream the server is capable of.
359 Optional variable BUFFER is buffer (buffer, or string naming buffer)
361 (setq buffer (or buffer (format " *sieve* %s:%d" server (or port 2000))))
362 (with-current-buffer (get-buffer-create buffer)
363 (mapcar 'make-variable-buffer-local sieve-manage-local-variables)
364 (sieve-manage-disable-multibyte)
365 (buffer-disable-undo)
366 (setq sieve-manage-server (or server sieve-manage-server))
367 (setq sieve-manage-port (or port sieve-manage-port))
368 (setq sieve-manage-stream (or stream sieve-manage-stream))
369 (message "sieve: Connecting to %s..." sieve-manage-server)
370 (if (let ((sieve-manage-stream
371 (or sieve-manage-stream sieve-manage-default-stream)))
372 (sieve-manage-open-1 buffer))
374 (let (stream-changed)
375 (message "sieve: Connecting to %s...done" sieve-manage-server)
376 (when (null sieve-manage-stream)
377 (let ((streams sieve-manage-streams))
378 (while (setq stream (pop streams))
379 (if (funcall (nth 1 (assq stream
380 sieve-manage-stream-alist)) buffer)
382 (not (eq (or sieve-manage-stream
383 sieve-manage-default-stream)
385 sieve-manage-stream stream
387 (unless sieve-manage-stream
388 (error "Couldn't figure out a stream for server"))))
390 (message "sieve: Reconnecting with stream `%s'..."
392 (sieve-manage-close buffer)
393 (if (sieve-manage-open-1 buffer)
394 (message "sieve: Reconnecting with stream `%s'...done"
396 (message "sieve: Reconnecting with stream `%s'...failed"
397 sieve-manage-stream))
398 (setq sieve-manage-capability nil))
399 (if (sieve-manage-opened buffer)
400 ;; Choose authenticator
401 (when (and (null sieve-manage-auth)
402 (not (eq sieve-manage-state 'auth)))
403 (let ((auths sieve-manage-authenticators))
404 (while (setq auth (pop auths))
405 (if (funcall (nth 1 (assq
407 sieve-manage-authenticator-alist))
409 (setq sieve-manage-auth auth
411 (unless sieve-manage-auth
412 (error "Couldn't figure out authenticator for server"))))))
413 (message "sieve: Connecting to %s...failed" sieve-manage-server))
414 (when (sieve-manage-opened buffer)
418 (defun sieve-manage-opened (&optional buffer)
419 "Return non-nil if connection to managesieve server in BUFFER is open.
420 If BUFFER is nil then the current buffer is used."
421 (and (setq buffer (get-buffer (or buffer (current-buffer))))
422 (buffer-live-p buffer)
423 (with-current-buffer buffer
424 (and sieve-manage-process
425 (memq (process-status sieve-manage-process) '(open run))))))
427 (defun sieve-manage-close (&optional buffer)
428 "Close connection to managesieve server in BUFFER.
429 If BUFFER is nil, the current buffer is used."
430 (with-current-buffer (or buffer (current-buffer))
431 (when (sieve-manage-opened)
432 (sieve-manage-send "LOGOUT")
434 (when (and sieve-manage-process
435 (memq (process-status sieve-manage-process) '(open run)))
436 (delete-process sieve-manage-process))
437 (setq sieve-manage-process nil)
441 (defun sieve-manage-authenticate (&optional user passwd buffer)
442 "Authenticate to server in BUFFER, using current buffer if nil.
443 It uses the authenticator specified when opening the server. If the
444 authenticator requires username/passwords, they are queried from the
445 user and optionally stored in the buffer. If USER and/or PASSWD is
446 specified, the user will not be questioned and the username and/or
447 password is remembered in the buffer."
448 (with-current-buffer (or buffer (current-buffer))
449 (if (not (eq sieve-manage-state 'nonauth))
450 (eq sieve-manage-state 'auth)
451 (make-variable-buffer-local 'sieve-manage-username)
452 (make-variable-buffer-local 'sieve-manage-password)
453 (if user (setq sieve-manage-username user))
454 (if passwd (setq sieve-manage-password passwd))
455 (if (funcall (nth 2 (assq sieve-manage-auth
456 sieve-manage-authenticator-alist)) buffer)
457 (setq sieve-manage-state 'auth)))))
459 (defun sieve-manage-capability (&optional name value buffer)
460 (with-current-buffer (or buffer (current-buffer))
462 sieve-manage-capability
464 (nth 1 (assoc name sieve-manage-capability))
465 (when (string-match value (nth 1 (assoc name sieve-manage-capability)))
466 (nth 1 (assoc name sieve-manage-capability)))))))
468 (defun sieve-manage-listscripts (&optional buffer)
469 (with-current-buffer (or buffer (current-buffer))
470 (sieve-manage-send "LISTSCRIPTS")
471 (sieve-manage-parse-listscripts)))
473 (defun sieve-manage-havespace (name size &optional buffer)
474 (with-current-buffer (or buffer (current-buffer))
475 (sieve-manage-send (format "HAVESPACE \"%s\" %s" name size))
476 (sieve-manage-parse-okno)))
479 (if (fboundp 'string-bytes)
480 (defalias 'sieve-string-bytes 'string-bytes)
481 (defalias 'sieve-string-bytes 'length)))
483 (defun sieve-manage-putscript (name content &optional buffer)
484 (with-current-buffer (or buffer (current-buffer))
485 (sieve-manage-send (format "PUTSCRIPT \"%s\" {%d+}%s%s" name
486 (sieve-string-bytes content)
487 sieve-manage-client-eol content))
488 (sieve-manage-parse-okno)))
490 (defun sieve-manage-deletescript (name &optional buffer)
491 (with-current-buffer (or buffer (current-buffer))
492 (sieve-manage-send (format "DELETESCRIPT \"%s\"" name))
493 (sieve-manage-parse-okno)))
495 (defun sieve-manage-getscript (name output-buffer &optional buffer)
496 (with-current-buffer (or buffer (current-buffer))
497 (sieve-manage-send (format "GETSCRIPT \"%s\"" name))
498 (let ((script (sieve-manage-parse-string)))
499 (sieve-manage-parse-crlf)
500 (with-current-buffer output-buffer
502 (sieve-manage-parse-okno))))
504 (defun sieve-manage-setactive (name &optional buffer)
505 (with-current-buffer (or buffer (current-buffer))
506 (sieve-manage-send (format "SETACTIVE \"%s\"" name))
507 (sieve-manage-parse-okno)))
509 ;; Protocol parsing routines
511 (defun sieve-manage-ok-p (rsp)
512 (string= (downcase (or (car-safe rsp) "")) "ok"))
514 (defsubst sieve-manage-forward ()
515 (or (eobp) (forward-char)))
517 (defun sieve-manage-is-okno ()
518 (when (looking-at (concat
519 "^\\(OK\\|NO\\)\\( (\\([^)]+\\))\\)?\\( \\(.*\\)\\)?"
520 sieve-manage-server-eol))
521 (let ((status (match-string 1))
522 (resp-code (match-string 3))
523 (response (match-string 5)))
525 (goto-char (match-beginning 5))
526 (setq response (sieve-manage-is-string)))
527 (list status resp-code response))))
529 (defun sieve-manage-parse-okno ()
532 (accept-process-output (get-buffer-process (current-buffer)) 1)
533 (goto-char (point-min))
534 (setq rsp (sieve-manage-is-okno)))
538 (defun sieve-manage-parse-capability-1 ()
539 "Accept a managesieve greeting."
541 (while (setq str (sieve-manage-is-string))
542 (if (eq (char-after) ? )
544 (sieve-manage-forward)
545 (push (list str (sieve-manage-is-string))
546 sieve-manage-capability))
547 (push (list str) sieve-manage-capability))
549 (when (re-search-forward (concat "^OK" sieve-manage-server-eol) nil t)
550 (setq sieve-manage-state 'nonauth)))
552 (defalias 'sieve-manage-parse-greeting-1 'sieve-manage-parse-capability-1)
554 (defun sieve-manage-is-string ()
555 (cond ((looking-at "\"\\([^\"]+\\)\"")
558 (goto-char (match-end 0))))
559 ((looking-at (concat "{\\([0-9]+\\)}" sieve-manage-server-eol))
560 (let ((pos (match-end 0))
561 (len (string-to-number (match-string 1))))
562 (if (< (point-max) (+ pos len))
564 (goto-char (+ pos len))
565 (buffer-substring pos (+ pos len)))))))
567 (defun sieve-manage-parse-string ()
570 (accept-process-output (get-buffer-process (current-buffer)) 1)
571 (goto-char (point-min))
572 (setq rsp (sieve-manage-is-string)))
573 (sieve-manage-erase (point))
576 (defun sieve-manage-parse-crlf ()
577 (when (looking-at sieve-manage-server-eol)
578 (sieve-manage-erase (match-end 0))))
580 (defun sieve-manage-parse-listscripts ()
583 (while (null (or (setq rsp (sieve-manage-is-okno))
584 (setq tmp (sieve-manage-is-string))))
585 (accept-process-output (get-buffer-process (current-buffer)) 1)
586 (goto-char (point-min)))
588 (while (not (looking-at (concat "\\( ACTIVE\\)?"
589 sieve-manage-server-eol)))
590 (accept-process-output (get-buffer-process (current-buffer)) 1)
591 (goto-char (point-min)))
593 (push (cons 'active tmp) data)
595 (goto-char (match-end 0))
598 (if (sieve-manage-ok-p rsp)
602 (defun sieve-manage-send (cmdstr)
603 (setq cmdstr (concat cmdstr sieve-manage-client-eol))
604 (and sieve-manage-log
605 (with-current-buffer (get-buffer-create sieve-manage-log)
606 (sieve-manage-disable-multibyte)
607 (buffer-disable-undo)
608 (goto-char (point-max))
610 (process-send-string sieve-manage-process cmdstr))
612 (provide 'sieve-manage)
614 ;; sieve-manage.el ends here