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 part of GNU Emacs.
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., 51 Franklin Street, Fifth Floor,
21 ;; Boston, MA 02110-1301, 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")
78 (autoload 'starttls-negotiate "starttls"))
80 ;; User customizable variables:
82 (defgroup sieve-manage nil
83 "Low-level Managesieve protocol issues."
87 (defcustom sieve-manage-log "*sieve-manage-log*"
88 "Name of buffer for managesieve session trace."
92 (defcustom sieve-manage-default-user (user-login-name)
93 "Default username to use."
97 (defcustom sieve-manage-server-eol "\r\n"
98 "The EOL string sent from the server."
100 :group 'sieve-manage)
102 (defcustom sieve-manage-client-eol "\r\n"
103 "The EOL string we send to the server."
105 :group 'sieve-manage)
107 (defcustom sieve-manage-streams '(network starttls shell)
108 "Priority of streams to consider when opening connection to server."
109 :group 'sieve-manage)
111 (defcustom sieve-manage-stream-alist
112 '((network sieve-manage-network-p sieve-manage-network-open)
113 (shell sieve-manage-shell-p sieve-manage-shell-open)
114 (starttls sieve-manage-starttls-p sieve-manage-starttls-open))
115 "Definition of network streams.
119 NAME names the stream, CHECK is a function returning non-nil if the
120 server support the stream and OPEN is a function for opening the
122 :group 'sieve-manage)
124 (defcustom sieve-manage-authenticators '(cram-md5 plain)
125 "Priority of authenticators to consider when authenticating to server."
126 :group 'sieve-manage)
128 (defcustom sieve-manage-authenticator-alist
129 '((cram-md5 sieve-manage-cram-md5-p sieve-manage-cram-md5-auth)
130 (plain sieve-manage-plain-p sieve-manage-plain-auth))
131 "Definition of authenticators.
133 \(NAME CHECK AUTHENTICATE)
135 NAME names the authenticator. CHECK is a function returning non-nil if
136 the server support the authenticator and AUTHENTICATE is a function
137 for doing the actual authentication."
138 :group 'sieve-manage)
140 (defcustom sieve-manage-default-port 2000
141 "Default port number for managesieve protocol."
143 :group 'sieve-manage)
145 ;; Internal variables:
147 (defconst sieve-manage-local-variables '(sieve-manage-server
151 sieve-manage-username
152 sieve-manage-password
154 sieve-manage-client-eol
155 sieve-manage-server-eol
156 sieve-manage-capability))
157 (defconst sieve-manage-default-stream 'network)
158 (defconst sieve-manage-coding-system-for-read 'binary)
159 (defconst sieve-manage-coding-system-for-write 'binary)
160 (defvar sieve-manage-stream nil)
161 (defvar sieve-manage-auth nil)
162 (defvar sieve-manage-server nil)
163 (defvar sieve-manage-port nil)
164 (defvar sieve-manage-username nil)
165 (defvar sieve-manage-password nil)
166 (defvar sieve-manage-state 'closed
168 Valid states are `closed', `initial', `nonauth', and `auth'.")
169 (defvar sieve-manage-process nil)
170 (defvar sieve-manage-capability nil)
172 ;; Internal utility functions
174 (defsubst sieve-manage-disable-multibyte ()
175 "Enable multibyte in the current buffer."
176 (when (fboundp 'set-buffer-multibyte)
177 (set-buffer-multibyte nil)))
179 ;; Uses the dynamically bound `reason' variable.
181 (defun sieve-manage-interactive-login (buffer loginfunc)
182 "Login to server in BUFFER.
183 LOGINFUNC is passed a username and a password, it should return t if
184 it where sucessful authenticating itself to the server, nil otherwise.
185 Returns t if login was successful, nil otherwise."
186 (with-current-buffer buffer
187 (make-variable-buffer-local 'sieve-manage-username)
188 (make-variable-buffer-local 'sieve-manage-password)
189 (let (user passwd ret reason)
190 ;; (condition-case ()
191 (while (or (not user) (not passwd))
192 (setq user (or sieve-manage-username
193 (read-from-minibuffer
194 (concat "Managesieve username for "
195 sieve-manage-server ": ")
196 (or user sieve-manage-default-user))))
197 (setq passwd (or sieve-manage-password
199 (concat "Managesieve password for " user "@"
200 sieve-manage-server ": "))))
201 (when (and user passwd)
202 (if (funcall loginfunc user passwd)
205 sieve-manage-username user)
206 (if (and (not sieve-manage-password)
207 (y-or-n-p "Store password for this session? "))
208 (setq sieve-manage-password passwd)))
210 (message "Login failed (reason given: %s)..." reason)
211 (message "Login failed..."))
215 ;; (quit (with-current-buffer buffer
218 ;; (error (with-current-buffer buffer
223 (defun sieve-manage-erase (&optional p buffer)
224 (let ((buffer (or buffer (current-buffer))))
225 (and sieve-manage-log
226 (with-current-buffer (get-buffer-create sieve-manage-log)
227 (sieve-manage-disable-multibyte)
228 (buffer-disable-undo)
229 (goto-char (point-max))
230 (insert-buffer-substring buffer (with-current-buffer buffer
232 (or p (with-current-buffer buffer
234 (delete-region (point-min) (or p (point-max))))
236 (defun sieve-manage-open-1 (buffer)
237 (with-current-buffer buffer
239 (setq sieve-manage-state 'initial
242 (funcall (nth 2 (assq sieve-manage-stream
243 sieve-manage-stream-alist))
244 "sieve" buffer sieve-manage-server sieve-manage-port)
246 (when sieve-manage-process
247 (while (and (eq sieve-manage-state 'initial)
248 (memq (process-status sieve-manage-process) '(open run)))
249 (message "Waiting for response from %s..." sieve-manage-server)
250 (accept-process-output sieve-manage-process 1))
251 (message "Waiting for response from %s...done" sieve-manage-server)
252 (and (memq (process-status sieve-manage-process) '(open run))
253 sieve-manage-process))))
257 (defun sieve-manage-network-p (buffer)
260 (defun sieve-manage-network-open (name buffer server port)
261 (let* ((port (or port sieve-manage-default-port))
262 (coding-system-for-read sieve-manage-coding-system-for-read)
263 (coding-system-for-write sieve-manage-coding-system-for-write)
264 (process (open-network-stream name buffer server port)))
266 (while (and (memq (process-status process) '(open run))
267 (set-buffer buffer) ;; XXX "blue moon" nntp.el bug
268 (goto-char (point-min))
269 (not (sieve-manage-parse-greeting-1)))
270 (accept-process-output process 1)
272 (sieve-manage-erase nil buffer)
273 (when (memq (process-status process) '(open run))
276 (defun imap-starttls-p (buffer)
277 ;; (and (imap-capability 'STARTTLS buffer)
281 (call-process "starttls"))
284 (defun imap-starttls-open (name buffer server port)
285 (let* ((port (or port sieve-manage-default-port))
286 (coding-system-for-read sieve-manage-coding-system-for-read)
287 (coding-system-for-write sieve-manage-coding-system-for-write)
288 (process (starttls-open-stream name buffer server port))
291 (while (and (memq (process-status process) '(open run))
292 (set-buffer buffer) ;; XXX "blue moon" nntp.el bug
293 (goto-char (point-min))
294 (not (sieve-manage-parse-greeting-1)))
295 (accept-process-output process 1)
297 (sieve-manage-erase nil buffer)
298 (sieve-manage-send "STARTTLS")
299 (starttls-negotiate process))
300 (when (memq (process-status process) '(open run))
305 (defun sieve-manage-plain-p (buffer)
306 (sieve-manage-capability "SASL" "PLAIN" buffer))
308 (defun sieve-manage-plain-auth (buffer)
309 "Login to managesieve server using the PLAIN SASL method."
310 (let* ((done (sieve-manage-interactive-login
312 (lambda (user passwd)
313 (sieve-manage-send (concat "AUTHENTICATE \"PLAIN\" \""
314 (base64-encode-string
315 (concat (char-to-string 0)
320 (let ((rsp (sieve-manage-parse-okno)))
321 (if (sieve-manage-ok-p rsp)
323 (setq reason (cdr-safe rsp))
326 (message "sieve: Authenticating using PLAIN...done")
327 (message "sieve: Authenticating using PLAIN...failed"))))
329 (defun sieve-manage-cram-md5-p (buffer)
330 (sieve-manage-capability "SASL" "CRAM-MD5" buffer))
332 (defun sieve-manage-cram-md5-auth (buffer)
333 "Login to managesieve server using the CRAM-MD5 SASL method."
334 (message "sieve: Authenticating using CRAM-MD5...")
335 (let* ((done (sieve-manage-interactive-login
337 (lambda (user passwd)
338 (sieve-manage-send "AUTHENTICATE \"CRAM-MD5\"")
342 (base64-encode-string
345 (rfc2104-hash 'md5 64 16 passwd
346 (base64-decode-string
348 (sieve-manage-parse-string)
349 (sieve-manage-erase))))))
351 (let ((rsp (sieve-manage-parse-okno)))
352 (if (sieve-manage-ok-p rsp)
354 (setq reason (cdr-safe rsp))
357 (message "sieve: Authenticating using CRAM-MD5...done")
358 (message "sieve: Authenticating using CRAM-MD5...failed"))))
362 (defun sieve-manage-open (server &optional port stream auth buffer)
363 "Open a network connection to a managesieve SERVER (string).
364 Optional variable PORT is port number (integer) on remote server.
365 Optional variable STREAM is any of `sieve-manage-streams' (a symbol).
366 Optional variable AUTH indicates authenticator to use, see
367 `sieve-manage-authenticators' for available authenticators. If nil, chooses
368 the best stream the server is capable of.
369 Optional variable BUFFER is buffer (buffer, or string naming buffer)
371 (setq buffer (or buffer (format " *sieve* %s:%d" server (or port 2000))))
372 (with-current-buffer (get-buffer-create buffer)
373 (mapcar 'make-variable-buffer-local sieve-manage-local-variables)
374 (sieve-manage-disable-multibyte)
375 (buffer-disable-undo)
376 (setq sieve-manage-server (or server sieve-manage-server))
377 (setq sieve-manage-port (or port sieve-manage-port))
378 (setq sieve-manage-stream (or stream sieve-manage-stream))
379 (message "sieve: Connecting to %s..." sieve-manage-server)
380 (if (let ((sieve-manage-stream
381 (or sieve-manage-stream sieve-manage-default-stream)))
382 (sieve-manage-open-1 buffer))
384 (let (stream-changed)
385 (message "sieve: Connecting to %s...done" sieve-manage-server)
386 (when (null sieve-manage-stream)
387 (let ((streams sieve-manage-streams))
388 (while (setq stream (pop streams))
389 (if (funcall (nth 1 (assq stream
390 sieve-manage-stream-alist)) buffer)
392 (not (eq (or sieve-manage-stream
393 sieve-manage-default-stream)
395 sieve-manage-stream stream
397 (unless sieve-manage-stream
398 (error "Couldn't figure out a stream for server"))))
400 (message "sieve: Reconnecting with stream `%s'..."
402 (sieve-manage-close buffer)
403 (if (sieve-manage-open-1 buffer)
404 (message "sieve: Reconnecting with stream `%s'...done"
406 (message "sieve: Reconnecting with stream `%s'...failed"
407 sieve-manage-stream))
408 (setq sieve-manage-capability nil))
409 (if (sieve-manage-opened buffer)
410 ;; Choose authenticator
411 (when (and (null sieve-manage-auth)
412 (not (eq sieve-manage-state 'auth)))
413 (let ((auths sieve-manage-authenticators))
414 (while (setq auth (pop auths))
415 (if (funcall (nth 1 (assq
417 sieve-manage-authenticator-alist))
419 (setq sieve-manage-auth auth
421 (unless sieve-manage-auth
422 (error "Couldn't figure out authenticator for server"))))))
423 (message "sieve: Connecting to %s...failed" sieve-manage-server))
424 (when (sieve-manage-opened buffer)
428 (defun sieve-manage-opened (&optional buffer)
429 "Return non-nil if connection to managesieve server in BUFFER is open.
430 If BUFFER is nil then the current buffer is used."
431 (and (setq buffer (get-buffer (or buffer (current-buffer))))
432 (buffer-live-p buffer)
433 (with-current-buffer buffer
434 (and sieve-manage-process
435 (memq (process-status sieve-manage-process) '(open run))))))
437 (defun sieve-manage-close (&optional buffer)
438 "Close connection to managesieve server in BUFFER.
439 If BUFFER is nil, the current buffer is used."
440 (with-current-buffer (or buffer (current-buffer))
441 (when (sieve-manage-opened)
442 (sieve-manage-send "LOGOUT")
444 (when (and sieve-manage-process
445 (memq (process-status sieve-manage-process) '(open run)))
446 (delete-process sieve-manage-process))
447 (setq sieve-manage-process nil)
451 (defun sieve-manage-authenticate (&optional user passwd buffer)
452 "Authenticate to server in BUFFER, using current buffer if nil.
453 It uses the authenticator specified when opening the server. If the
454 authenticator requires username/passwords, they are queried from the
455 user and optionally stored in the buffer. If USER and/or PASSWD is
456 specified, the user will not be questioned and the username and/or
457 password is remembered in the buffer."
458 (with-current-buffer (or buffer (current-buffer))
459 (if (not (eq sieve-manage-state 'nonauth))
460 (eq sieve-manage-state 'auth)
461 (make-variable-buffer-local 'sieve-manage-username)
462 (make-variable-buffer-local 'sieve-manage-password)
463 (if user (setq sieve-manage-username user))
464 (if passwd (setq sieve-manage-password passwd))
465 (if (funcall (nth 2 (assq sieve-manage-auth
466 sieve-manage-authenticator-alist)) buffer)
467 (setq sieve-manage-state 'auth)))))
469 (defun sieve-manage-capability (&optional name value buffer)
470 (with-current-buffer (or buffer (current-buffer))
472 sieve-manage-capability
474 (nth 1 (assoc name sieve-manage-capability))
475 (when (string-match value (nth 1 (assoc name sieve-manage-capability)))
476 (nth 1 (assoc name sieve-manage-capability)))))))
478 (defun sieve-manage-listscripts (&optional buffer)
479 (with-current-buffer (or buffer (current-buffer))
480 (sieve-manage-send "LISTSCRIPTS")
481 (sieve-manage-parse-listscripts)))
483 (defun sieve-manage-havespace (name size &optional buffer)
484 (with-current-buffer (or buffer (current-buffer))
485 (sieve-manage-send (format "HAVESPACE \"%s\" %s" name size))
486 (sieve-manage-parse-okno)))
489 (if (fboundp 'string-bytes)
490 (defalias 'sieve-string-bytes 'string-bytes)
491 (defalias 'sieve-string-bytes 'length)))
493 (defun sieve-manage-putscript (name content &optional buffer)
494 (with-current-buffer (or buffer (current-buffer))
495 (sieve-manage-send (format "PUTSCRIPT \"%s\" {%d+}%s%s" name
496 (sieve-string-bytes content)
497 sieve-manage-client-eol content))
498 (sieve-manage-parse-okno)))
500 (defun sieve-manage-deletescript (name &optional buffer)
501 (with-current-buffer (or buffer (current-buffer))
502 (sieve-manage-send (format "DELETESCRIPT \"%s\"" name))
503 (sieve-manage-parse-okno)))
505 (defun sieve-manage-getscript (name output-buffer &optional buffer)
506 (with-current-buffer (or buffer (current-buffer))
507 (sieve-manage-send (format "GETSCRIPT \"%s\"" name))
508 (let ((script (sieve-manage-parse-string)))
509 (sieve-manage-parse-crlf)
510 (with-current-buffer output-buffer
512 (sieve-manage-parse-okno))))
514 (defun sieve-manage-setactive (name &optional buffer)
515 (with-current-buffer (or buffer (current-buffer))
516 (sieve-manage-send (format "SETACTIVE \"%s\"" name))
517 (sieve-manage-parse-okno)))
519 ;; Protocol parsing routines
521 (defun sieve-manage-ok-p (rsp)
522 (string= (downcase (or (car-safe rsp) "")) "ok"))
524 (defsubst sieve-manage-forward ()
525 (or (eobp) (forward-char)))
527 (defun sieve-manage-is-okno ()
528 (when (looking-at (concat
529 "^\\(OK\\|NO\\)\\( (\\([^)]+\\))\\)?\\( \\(.*\\)\\)?"
530 sieve-manage-server-eol))
531 (let ((status (match-string 1))
532 (resp-code (match-string 3))
533 (response (match-string 5)))
535 (goto-char (match-beginning 5))
536 (setq response (sieve-manage-is-string)))
537 (list status resp-code response))))
539 (defun sieve-manage-parse-okno ()
542 (accept-process-output (get-buffer-process (current-buffer)) 1)
543 (goto-char (point-min))
544 (setq rsp (sieve-manage-is-okno)))
548 (defun sieve-manage-parse-capability-1 ()
549 "Accept a managesieve greeting."
551 (while (setq str (sieve-manage-is-string))
552 (if (eq (char-after) ? )
554 (sieve-manage-forward)
555 (push (list str (sieve-manage-is-string))
556 sieve-manage-capability))
557 (push (list str) sieve-manage-capability))
559 (when (re-search-forward (concat "^OK" sieve-manage-server-eol) nil t)
560 (setq sieve-manage-state 'nonauth)))
562 (defalias 'sieve-manage-parse-greeting-1 'sieve-manage-parse-capability-1)
564 (defun sieve-manage-is-string ()
565 (cond ((looking-at "\"\\([^\"]+\\)\"")
568 (goto-char (match-end 0))))
569 ((looking-at (concat "{\\([0-9]+\\)}" sieve-manage-server-eol))
570 (let ((pos (match-end 0))
571 (len (string-to-number (match-string 1))))
572 (if (< (point-max) (+ pos len))
574 (goto-char (+ pos len))
575 (buffer-substring pos (+ pos len)))))))
577 (defun sieve-manage-parse-string ()
580 (accept-process-output (get-buffer-process (current-buffer)) 1)
581 (goto-char (point-min))
582 (setq rsp (sieve-manage-is-string)))
583 (sieve-manage-erase (point))
586 (defun sieve-manage-parse-crlf ()
587 (when (looking-at sieve-manage-server-eol)
588 (sieve-manage-erase (match-end 0))))
590 (defun sieve-manage-parse-listscripts ()
593 (while (null (or (setq rsp (sieve-manage-is-okno))
594 (setq tmp (sieve-manage-is-string))))
595 (accept-process-output (get-buffer-process (current-buffer)) 1)
596 (goto-char (point-min)))
598 (while (not (looking-at (concat "\\( ACTIVE\\)?"
599 sieve-manage-server-eol)))
600 (accept-process-output (get-buffer-process (current-buffer)) 1)
601 (goto-char (point-min)))
603 (push (cons 'active tmp) data)
605 (goto-char (match-end 0))
608 (if (sieve-manage-ok-p rsp)
612 (defun sieve-manage-send (cmdstr)
613 (setq cmdstr (concat cmdstr sieve-manage-client-eol))
614 (and sieve-manage-log
615 (with-current-buffer (get-buffer-create sieve-manage-log)
616 (sieve-manage-disable-multibyte)
617 (buffer-disable-undo)
618 (goto-char (point-max))
620 (process-send-string sieve-manage-process cmdstr))
622 (provide 'sieve-manage)
624 ;;; arch-tag: 321c4640-1371-4495-9baf-8ccb71dd5bd1
625 ;; sieve-manage.el ends here