817c09a460
Patch from Eric Dorland Closes: #470875 From: Wouter Verhelst Subject: kerberos authentication works only the first time Date: Fri, 14 Mar 2008 09:28:37 +0100 Package: offlineimap Version: 5.99.8 Severity: normal Hi, I have the "autorefresh" configuration option specified in my .offlineimaprc, and am now using the kerberos authentication. However, this kerberos authentication seems to work only the first time offlineimap tries to fetch mails. The next time, it fails with this output: Thread 'Account sync Test' terminated with exception: Traceback (most recent call last): File "/var/lib/python-support/python2.4/offlineimap/threadutil.py", line 153, in run Thread.run(self) File "/usr/lib/python2.4/threading.py", line 422, in run self.__target(*self.__args, **self.__kwargs) File "/var/lib/python-support/python2.4/offlineimap/accounts.py", line 119, in syncrunner self.sync() File "/var/lib/python-support/python2.4/offlineimap/accounts.py", line 148, in sync remoterepos.syncfoldersto(localrepos, [statusrepos]) File "/var/lib/python-support/python2.4/offlineimap/repository/Base.py", line 135, in syncfoldersto srcfolders = src.getfolders() File "/var/lib/python-support/python2.4/offlineimap/repository/IMAP.py", line 192, in getfolders listresult = imapobj.list(directory = self.imapserver.reference)[1] File "/usr/lib/python2.4/imaplib.py", line 469, in list typ, dat = self._simple_command(name, directory, pattern) File "/usr/lib/python2.4/imaplib.py", line 1028, in _simple_command return self._command_complete(name, self._command(name, *args)) File "/usr/lib/python2.4/imaplib.py", line 787, in _command raise self.error( error: command LIST illegal in state NONAUTH
491 lines
19 KiB
Python
491 lines
19 KiB
Python
# IMAP server support
|
|
# Copyright (C) 2002 - 2007 John Goerzen
|
|
# <jgoerzen@complete.org>
|
|
#
|
|
# This program is free software; you can redistribute it and/or modify
|
|
# it under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation; either version 2 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# This program is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with this program; if not, write to the Free Software
|
|
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
|
|
|
|
from offlineimap import imaplib2, imaplibutil, imaputil, threadutil
|
|
from offlineimap.ui import UIBase
|
|
from offlineimap.accounts import syncfolder
|
|
from threading import *
|
|
import thread, hmac, os, time
|
|
import base64
|
|
|
|
from StringIO import StringIO
|
|
from platform import system
|
|
|
|
try:
|
|
# do we have a recent pykerberos?
|
|
have_gss = False
|
|
import kerberos
|
|
if 'authGSSClientWrap' in dir(kerberos):
|
|
have_gss = True
|
|
except ImportError:
|
|
pass
|
|
|
|
class UsefulIMAPMixIn:
|
|
def getstate(self):
|
|
return self.state
|
|
def getselectedfolder(self):
|
|
if self.getstate() == 'SELECTED':
|
|
return self.selectedfolder
|
|
return None
|
|
|
|
def select(self, mailbox='INBOX', readonly=None, force = 0):
|
|
if (not force) and self.getselectedfolder() == mailbox \
|
|
and self.is_readonly == readonly:
|
|
# No change; return.
|
|
return
|
|
result = self.__class__.__bases__[1].select(self, mailbox, readonly)
|
|
if result[0] != 'OK':
|
|
raise ValueError, "Error from select: %s" % str(result)
|
|
if self.getstate() == 'SELECTED':
|
|
self.selectedfolder = mailbox
|
|
else:
|
|
self.selectedfolder = None
|
|
|
|
def _mesg(self, s, tn=None, secs=None):
|
|
imaplibutil.new_mesg(self, s, tn, secs)
|
|
|
|
class UsefulIMAP4(UsefulIMAPMixIn, imaplib2.IMAP4):
|
|
# This is a hack around Darwin's implementation of realloc() (which
|
|
# Python uses inside the socket code). On Darwin, we split the
|
|
# message into 100k chunks, which should be small enough - smaller
|
|
# might start seriously hurting performance ...
|
|
|
|
def read(self, size):
|
|
if (system() == 'Darwin') and (size>0) :
|
|
read = 0
|
|
io = StringIO()
|
|
while read < size:
|
|
sz = min(size-read, 8192)
|
|
data = imaplib2.IMAP4.read (self, sz)
|
|
read += len(data)
|
|
io.write(data)
|
|
if len(data) < sz:
|
|
break
|
|
return io.getvalue()
|
|
else:
|
|
return imaplib2.IMAP4.read (self, size)
|
|
|
|
class UsefulIMAP4_SSL(UsefulIMAPMixIn, imaplibutil.WrappedIMAP4_SSL):
|
|
# This is the same hack as above, to be used in the case of an SSL
|
|
# connexion.
|
|
|
|
def read(self, size):
|
|
if (system() == 'Darwin') and (size>0) :
|
|
read = 0
|
|
io = StringIO()
|
|
while read < size:
|
|
sz = min(size-read,8192)
|
|
data = imaplibutil.WrappedIMAP4_SSL.read (self, sz)
|
|
read += len(data)
|
|
io.write(data)
|
|
if len(data) < sz:
|
|
break
|
|
return io.getvalue()
|
|
else:
|
|
return imaplibutil.WrappedIMAP4_SSL.read (self,size)
|
|
|
|
class UsefulIMAP4_Tunnel(UsefulIMAPMixIn, imaplibutil.IMAP4_Tunnel): pass
|
|
|
|
class IMAPServer:
|
|
GSS_STATE_STEP = 0
|
|
GSS_STATE_WRAP = 1
|
|
def __init__(self, config, reposname,
|
|
username = None, password = None, hostname = None,
|
|
port = None, ssl = 1, maxconnections = 1, tunnel = None,
|
|
reference = '""', sslclientcert = None, sslclientkey = None,
|
|
idlefolders = []):
|
|
self.reposname = reposname
|
|
self.config = config
|
|
self.username = username
|
|
self.password = password
|
|
self.passworderror = None
|
|
self.goodpassword = None
|
|
self.hostname = hostname
|
|
self.tunnel = tunnel
|
|
self.port = port
|
|
self.usessl = ssl
|
|
self.sslclientcert = sslclientcert
|
|
self.sslclientkey = sslclientkey
|
|
self.delim = None
|
|
self.root = None
|
|
if port == None:
|
|
if ssl:
|
|
self.port = 993
|
|
else:
|
|
self.port = 143
|
|
self.maxconnections = maxconnections
|
|
self.availableconnections = []
|
|
self.assignedconnections = []
|
|
self.lastowner = {}
|
|
self.semaphore = BoundedSemaphore(self.maxconnections)
|
|
self.connectionlock = Lock()
|
|
self.reference = reference
|
|
self.idlefolders = idlefolders
|
|
self.gss_step = self.GSS_STATE_STEP
|
|
self.gss_vc = None
|
|
self.gssapi = False
|
|
|
|
def getpassword(self):
|
|
if self.goodpassword != None:
|
|
return self.goodpassword
|
|
|
|
if self.password != None and self.passworderror == None:
|
|
return self.password
|
|
|
|
self.password = UIBase.getglobalui().getpass(self.reposname,
|
|
self.config,
|
|
self.passworderror)
|
|
self.passworderror = None
|
|
|
|
return self.password
|
|
|
|
def getdelim(self):
|
|
"""Returns this server's folder delimiter. Can only be called
|
|
after one or more calls to acquireconnection."""
|
|
return self.delim
|
|
|
|
def getroot(self):
|
|
"""Returns this server's folder root. Can only be called after one
|
|
or more calls to acquireconnection."""
|
|
return self.root
|
|
|
|
|
|
def releaseconnection(self, connection):
|
|
"""Releases a connection, returning it to the pool."""
|
|
self.connectionlock.acquire()
|
|
self.assignedconnections.remove(connection)
|
|
self.availableconnections.append(connection)
|
|
self.connectionlock.release()
|
|
self.semaphore.release()
|
|
|
|
def md5handler(self, response):
|
|
ui = UIBase.getglobalui()
|
|
challenge = response.strip()
|
|
ui.debug('imap', 'md5handler: got challenge %s' % challenge)
|
|
|
|
passwd = self.getpassword()
|
|
retval = self.username + ' ' + hmac.new(passwd, challenge).hexdigest()
|
|
ui.debug('imap', 'md5handler: returning %s' % retval)
|
|
return retval
|
|
|
|
def plainauth(self, imapobj):
|
|
UIBase.getglobalui().debug('imap',
|
|
'Attempting plain authentication')
|
|
imapobj.login(self.username, self.getpassword())
|
|
|
|
def gssauth(self, response):
|
|
data = base64.b64encode(response)
|
|
try:
|
|
if self.gss_step == self.GSS_STATE_STEP:
|
|
if not self.gss_vc:
|
|
rc, self.gss_vc = kerberos.authGSSClientInit('imap@' +
|
|
self.hostname)
|
|
response = kerberos.authGSSClientResponse(self.gss_vc)
|
|
rc = kerberos.authGSSClientStep(self.gss_vc, data)
|
|
if rc != kerberos.AUTH_GSS_CONTINUE:
|
|
self.gss_step = self.GSS_STATE_WRAP
|
|
elif self.gss_step == self.GSS_STATE_WRAP:
|
|
rc = kerberos.authGSSClientUnwrap(self.gss_vc, data)
|
|
response = kerberos.authGSSClientResponse(self.gss_vc)
|
|
rc = kerberos.authGSSClientWrap(self.gss_vc, response,
|
|
self.username)
|
|
response = kerberos.authGSSClientResponse(self.gss_vc)
|
|
except kerberos.GSSError, err:
|
|
# Kerberos errored out on us, respond with None to cancel the
|
|
# authentication
|
|
UIBase.getglobalui().debug('imap',
|
|
'%s: %s' % (err[0][0], err[1][0]))
|
|
return None
|
|
|
|
if not response:
|
|
response = ''
|
|
return base64.b64decode(response)
|
|
|
|
def acquireconnection(self):
|
|
"""Fetches a connection from the pool, making sure to create a new one
|
|
if needed, to obey the maximum connection limits, etc.
|
|
Opens a connection to the server and returns an appropriate
|
|
object."""
|
|
|
|
self.semaphore.acquire()
|
|
self.connectionlock.acquire()
|
|
imapobj = None
|
|
|
|
if len(self.availableconnections): # One is available.
|
|
# Try to find one that previously belonged to this thread
|
|
# as an optimization. Start from the back since that's where
|
|
# they're popped on.
|
|
threadid = thread.get_ident()
|
|
imapobj = None
|
|
for i in range(len(self.availableconnections) - 1, -1, -1):
|
|
tryobj = self.availableconnections[i]
|
|
if self.lastowner[tryobj] == threadid:
|
|
imapobj = tryobj
|
|
del(self.availableconnections[i])
|
|
break
|
|
if not imapobj:
|
|
imapobj = self.availableconnections[0]
|
|
del(self.availableconnections[0])
|
|
self.assignedconnections.append(imapobj)
|
|
self.lastowner[imapobj] = thread.get_ident()
|
|
self.connectionlock.release()
|
|
return imapobj
|
|
|
|
self.connectionlock.release() # Release until need to modify data
|
|
|
|
success = 0
|
|
while not success:
|
|
# Generate a new connection.
|
|
if self.tunnel:
|
|
UIBase.getglobalui().connecting('tunnel', self.tunnel)
|
|
imapobj = UsefulIMAP4_Tunnel(self.tunnel)
|
|
success = 1
|
|
elif self.usessl:
|
|
UIBase.getglobalui().connecting(self.hostname, self.port)
|
|
imapobj = UsefulIMAP4_SSL(self.hostname, self.port,
|
|
self.sslclientkey, self.sslclientcert)
|
|
else:
|
|
UIBase.getglobalui().connecting(self.hostname, self.port)
|
|
imapobj = UsefulIMAP4(self.hostname, self.port)
|
|
|
|
imapobj.mustquote = imaplibutil.mustquote
|
|
|
|
if not self.tunnel:
|
|
try:
|
|
# Try GSSAPI and continue if it fails
|
|
if 'AUTH=GSSAPI' in imapobj.capabilities and have_gss:
|
|
UIBase.getglobalui().debug('imap',
|
|
'Attempting GSSAPI authentication')
|
|
try:
|
|
imapobj.authenticate('GSSAPI', self.gssauth)
|
|
except imapobj.error, val:
|
|
UIBase.getglobalui().debug('imap',
|
|
'GSSAPI Authentication failed')
|
|
else:
|
|
self.gssapi = True
|
|
self.password = None
|
|
|
|
if not self.gssapi:
|
|
if 'AUTH=CRAM-MD5' in imapobj.capabilities:
|
|
UIBase.getglobalui().debug('imap',
|
|
'Attempting CRAM-MD5 authentication')
|
|
try:
|
|
imapobj.authenticate('CRAM-MD5', self.md5handler)
|
|
except imapobj.error, val:
|
|
self.plainauth(imapobj)
|
|
else:
|
|
self.plainauth(imapobj)
|
|
# Would bail by here if there was a failure.
|
|
success = 1
|
|
self.goodpassword = self.password
|
|
except imapobj.error, val:
|
|
self.passworderror = str(val)
|
|
self.password = None
|
|
|
|
if self.delim == None:
|
|
listres = imapobj.list(self.reference, '""')[1]
|
|
if listres == [None] or listres == None:
|
|
# Some buggy IMAP servers do not respond well to LIST "" ""
|
|
# Work around them.
|
|
listres = imapobj.list(self.reference, '"*"')[1]
|
|
self.delim, self.root = \
|
|
imaputil.imapsplit(listres[0])[1:]
|
|
self.delim = imaputil.dequote(self.delim)
|
|
self.root = imaputil.dequote(self.root)
|
|
|
|
self.connectionlock.acquire()
|
|
self.assignedconnections.append(imapobj)
|
|
self.lastowner[imapobj] = thread.get_ident()
|
|
self.connectionlock.release()
|
|
return imapobj
|
|
|
|
def connectionwait(self):
|
|
"""Waits until there is a connection available. Note that between
|
|
the time that a connection becomes available and the time it is
|
|
requested, another thread may have grabbed it. This function is
|
|
mainly present as a way to avoid spawning thousands of threads
|
|
to copy messages, then have them all wait for 3 available connections.
|
|
It's OK if we have maxconnections + 1 or 2 threads, which is what
|
|
this will help us do."""
|
|
threadutil.semaphorewait(self.semaphore)
|
|
|
|
def close(self):
|
|
# Make sure I own all the semaphores. Let the threads finish
|
|
# their stuff. This is a blocking method.
|
|
self.connectionlock.acquire()
|
|
threadutil.semaphorereset(self.semaphore, self.maxconnections)
|
|
for imapobj in self.assignedconnections + self.availableconnections:
|
|
imapobj.logout()
|
|
self.assignedconnections = []
|
|
self.availableconnections = []
|
|
self.lastowner = {}
|
|
# reset kerberos state
|
|
self.gss_step = self.GSS_STATE_STEP
|
|
self.gss_vc = None
|
|
self.gssapi = False
|
|
self.connectionlock.release()
|
|
|
|
def keepalive(self, timeout, event):
|
|
"""Sends a NOOP to each connection recorded. It will wait a maximum
|
|
of timeout seconds between doing this, and will continue to do so
|
|
until the Event object as passed is true. This method is expected
|
|
to be invoked in a separate thread, which should be join()'d after
|
|
the event is set."""
|
|
ui = UIBase.getglobalui()
|
|
ui.debug('imap', 'keepalive thread started')
|
|
while 1:
|
|
ui.debug('imap', 'keepalive: top of loop')
|
|
if event.isSet():
|
|
ui.debug('imap', 'keepalive: event is set; exiting')
|
|
return
|
|
ui.debug('imap', 'keepalive: acquiring connectionlock')
|
|
self.connectionlock.acquire()
|
|
numconnections = len(self.assignedconnections) + \
|
|
len(self.availableconnections)
|
|
self.connectionlock.release()
|
|
ui.debug('imap', 'keepalive: connectionlock released')
|
|
threads = []
|
|
|
|
for i in range(numconnections):
|
|
ui.debug('imap', 'keepalive: processing connection %d of %d' % (i, numconnections))
|
|
if len(self.idlefolders) > i:
|
|
idler = IdleThread(self, self.idlefolders[i])
|
|
else:
|
|
idler = IdleThread(self)
|
|
idler.start()
|
|
threads.append(idler)
|
|
ui.debug('imap', 'keepalive: thread started')
|
|
|
|
ui.debug('imap', 'keepalive: waiting for timeout')
|
|
event.wait(timeout)
|
|
|
|
ui.debug('imap', 'keepalive: joining threads')
|
|
|
|
for idler in threads:
|
|
# Make sure all the commands have completed.
|
|
idler.stop()
|
|
idler.join()
|
|
|
|
ui.debug('imap', 'keepalive: bottom of loop')
|
|
|
|
class IdleThread(object):
|
|
def __init__(self, parent, folder=None):
|
|
self.parent = parent
|
|
self.folder = folder
|
|
self.event = Event()
|
|
if folder is None:
|
|
self.thread = Thread(target=self.noop)
|
|
else:
|
|
self.thread = Thread(target=self.idle)
|
|
self.thread.setDaemon(1)
|
|
|
|
def start(self):
|
|
self.thread.start()
|
|
|
|
def stop(self):
|
|
self.event.set()
|
|
|
|
def join(self):
|
|
self.thread.join()
|
|
|
|
def noop(self):
|
|
imapobj = self.parent.acquireconnection()
|
|
imapobj.noop()
|
|
self.event.wait()
|
|
self.parent.releaseconnection(imapobj)
|
|
|
|
def dosync(self):
|
|
remoterepos = self.parent.repos
|
|
account = remoterepos.account
|
|
localrepos = account.localrepos
|
|
remoterepos = account.remoterepos
|
|
statusrepos = account.statusrepos
|
|
remotefolder = remoterepos.getfolder(self.folder)
|
|
syncfolder(account.name, remoterepos, remotefolder, localrepos, statusrepos, quick=False)
|
|
ui = UIBase.getglobalui()
|
|
ui.unregisterthread(currentThread())
|
|
|
|
def idle(self):
|
|
imapobj = self.parent.acquireconnection()
|
|
imapobj.select(self.folder)
|
|
self.parent.releaseconnection(imapobj)
|
|
while True:
|
|
if self.event.isSet():
|
|
return
|
|
self.needsync = False
|
|
def callback(args):
|
|
if not self.event.isSet():
|
|
self.needsync = True
|
|
self.event.set()
|
|
imapobj = self.parent.acquireconnection()
|
|
if "IDLE" in imapobj.capabilities:
|
|
imapobj.idle(callback=callback)
|
|
else:
|
|
imapobj.noop()
|
|
self.event.wait()
|
|
if self.event.isSet():
|
|
imapobj.noop()
|
|
self.parent.releaseconnection(imapobj)
|
|
if self.needsync:
|
|
self.event.clear()
|
|
self.dosync()
|
|
|
|
class ConfigedIMAPServer(IMAPServer):
|
|
"""This class is designed for easier initialization given a ConfigParser
|
|
object and an account name. The passwordhash is used if
|
|
passwords for certain accounts are known. If the password for this
|
|
account is listed, it will be obtained from there."""
|
|
def __init__(self, repository, passwordhash = {}):
|
|
"""Initialize the object. If the account is not a tunnel,
|
|
the password is required."""
|
|
self.repos = repository
|
|
self.config = self.repos.getconfig()
|
|
usetunnel = self.repos.getpreauthtunnel()
|
|
if not usetunnel:
|
|
host = self.repos.gethost()
|
|
user = self.repos.getuser()
|
|
port = self.repos.getport()
|
|
ssl = self.repos.getssl()
|
|
sslclientcert = self.repos.getsslclientcert()
|
|
sslclientkey = self.repos.getsslclientkey()
|
|
reference = self.repos.getreference()
|
|
idlefolders = self.repos.getidlefolders()
|
|
server = None
|
|
password = None
|
|
|
|
if repository.getname() in passwordhash:
|
|
password = passwordhash[repository.getname()]
|
|
|
|
# Connect to the remote server.
|
|
if usetunnel:
|
|
IMAPServer.__init__(self, self.config, self.repos.getname(),
|
|
tunnel = usetunnel,
|
|
reference = reference,
|
|
idlefolders = idlefolders,
|
|
maxconnections = self.repos.getmaxconnections())
|
|
else:
|
|
if not password:
|
|
password = self.repos.getpassword()
|
|
IMAPServer.__init__(self, self.config, self.repos.getname(),
|
|
user, password, host, port, ssl,
|
|
self.repos.getmaxconnections(),
|
|
reference = reference,
|
|
idlefolders = idlefolders,
|
|
sslclientcert = sslclientcert,
|
|
sslclientkey = sslclientkey)
|