support CRAM-MD5 for IMAPS

Author: Richard Jones

CHANGES.txt

@@ -3,6 +3,9 @@ are given with the most recent entry first.
 
 2010-XX-XX 1.4.12 (rXXXX)
 
+Features:
+- Support IMAP CRAM-MD5, thanks Jochen Maes
+
 Fixes:
 - Proper handling of 'Create' permissions in both mail gateway (earlier
   commit r4405 by Richard), web interface, and xmlrpc. This used to

doc/acknowledgements.txt

@@ -76,6 +76,7 @@ Henrik Levkowetz,
 David Linke,
 Martin v. Löwis,
 Fredrik Lundh,
+Jochen Maes,
 Will Maier,
 Ksenia Marasanova,
 Georges Martin,

roundup/mailgw.py

@@ -569,7 +569,8 @@ def do_mailbox(self, filename):
         fcntl.flock(f.fileno(), FCNTL.LOCK_UN)
         return 0
 
-    def do_imap(self, server, user='', password='', mailbox='', ssl=0):
+    def do_imap(self, server, user='', password='', mailbox='', ssl=0,
+            cram=0):
         ''' Do an IMAP connection
         '''
         import getpass, imaplib, socket
@@ -595,7 +596,10 @@ def do_imap(self, server, user='', password='', mailbox='', ssl=0):
             return 1
 
         try:
-            server.login(user, password)
+            if cram:
+                server.login_cram_md5(user, password)
+            else:
+                server.login(user, password)
         except imaplib.IMAP4.error, e:
             self.logger.exception('IMAP login failure')
             return 1

roundup/scripts/roundup_mailgw.py

@@ -105,6 +105,11 @@ def usage(args, message=None):
  This supports the same notation as IMAP.
     imaps username:password@server [mailbox]
 
+IMAPS_CRAM:
+ Connect to an IMAP server over ssl using CRAM-MD5 authentication.
+ This supports the same notation as IMAP.
+    imaps_cram username:password@server [mailbox]
+
 """)%{'program': args[0]}
     return 1
 
@@ -153,7 +158,7 @@ def main(argv):
     source, specification = args[1:3]
 
     # time out net connections after a minute if we can
-    if source not in ('mailbox', 'imaps'):
+    if source not in ('mailbox', 'imaps', 'imaps_cram'):
         if hasattr(socket, 'setdefaulttimeout'):
             socket.setdefaulttimeout(60)
 
@@ -189,14 +194,19 @@ def main(argv):
     elif source == 'apop':
         return handler.do_apop(server, username, password)
     elif source.startswith('imap'):
-        ssl = source.endswith('s')
+        ssl = cram = 0
+        if source.endswith('s'):
+            ssl = 1
+        elif source.endswith('s_cram'):
+            ssl = cram = 1
         mailbox = ''
         if len(args) > 3:
             mailbox = args[3]
-        return handler.do_imap(server, username, password, mailbox, ssl)
+        return handler.do_imap(server, username, password, mailbox, ssl,
+            cram)
 
     return usage(argv, _('Error: The source must be either "mailbox",'
-        ' "pop", "pops", "apop", "imap" or "imaps"'))
+        ' "pop", "pops", "apop", "imap", "imaps" or "imaps_cram'))
 
 def run():
     sys.exit(main(sys.argv))