[PATCH v2] learn to support UTF-8 characters in usernames and passwords
Nicolas Sebrecht
nicolas.s-dev at laposte.net
Fri Jun 17 00:14:47 BST 2016
Assume and document the expected unicode type.
Signed-off-by: Nicolas Sebrecht <nicolas.s-dev at laposte.net>
---
The following changes since commit 4014f293a6f4f160d376bfcd1a3c2dfce1b34482:
offlineimap.conf: add more comments about decodefoldernames (2016-06-17 00:51:03 +0200)
are available in the git repository at:
https://github.com/nicolas33/offlineimap.git ns/passwd-username-encoding-2
for you to fetch changes up to 28696678e35553d89d76f3134d66da4329648a78:
learn to support UTF-8 characters in usernames and passwords (2016-06-17 01:00:40 +0200)
Interdiff:
diff --git a/offlineimap.conf b/offlineimap.conf
index 427b750..2f87c06 100644
--- a/offlineimap.conf
+++ b/offlineimap.conf
@@ -1,4 +1,4 @@
-# Offlineimap sample configuration file
+# Offlineimap sample configuration file.
# This file documents *all* possible options and can be quite scary.
# Looking for a quick start? Take a look at offlineimap.conf.minimal.
@@ -596,10 +596,10 @@ type = IMAP
# The returned value must be int type.
#remoteporteval = getcredentials("filename", "hostname", "port")
#
-# The returned value must be unicode type.
+# The returned value must be unicode type when there are non-ASCII characters.
#remoteusereval = getcredentials("filename", "hostname", "user")
#
-# The returned value must be unicode type.
+# The returned value must be unicode type when there are non-ASCII characters.
#remotepasseval = getcredentials("filename", "hostname", "passwd")
@@ -749,7 +749,8 @@ remotehost = examplehost
# This option stands in the [Repository RemoteExample] section.
#
-# Specify the remote user name. Must be unicode.
+# Specify the remote user name. Must be unicode when there are non-ASCII
+# characters.
#
remoteuser = u"username"
@@ -767,7 +768,7 @@ remoteuser = u"username"
# mechanism, so consider using auth_mechanisms to prioritize PLAIN
# or even make it the only mechanism to be tried.
#
-# Must be unicode type.
+# Must be unicode type when there are non-ASCII characters.
#
#remote_identity = u"authzuser"
@@ -1187,7 +1196,7 @@ type = Gmail
#
# Specify the Gmail user name. This is the only mandatory parameter.
#
-# Must be unicode type.
+# Must be unicode type when there are non-ASCII characters.
#
remoteuser = u"username at gmail.com"
diff --git a/offlineimap/imapserver.py b/offlineimap/imapserver.py
index 711c9ed..63b4acd 100644
--- a/offlineimap/imapserver.py
+++ b/offlineimap/imapserver.py
@@ -1,5 +1,5 @@
# IMAP server support
-# Copyright (C) 2002 - 2016 John Goerzen & contributors
+# Copyright (C) 2002-2016 John Goerzen & contributors
#
# 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
-----------------
offlineimap.conf | 32 ++++++++++++++++++++++----------
offlineimap/imapserver.py | 9 +++++----
offlineimap/repository/IMAP.py | 20 ++++++++++++--------
3 files changed, 39 insertions(+), 22 deletions(-)
diff --git a/offlineimap.conf b/offlineimap.conf
index d790848..2f87c06 100644
--- a/offlineimap.conf
+++ b/offlineimap.conf
@@ -1,4 +1,4 @@
-# Offlineimap sample configuration file
+# Offlineimap sample configuration file.
# This file documents *all* possible options and can be quite scary.
# Looking for a quick start? Take a look at offlineimap.conf.minimal.
@@ -590,9 +590,16 @@ type = IMAP
# "getcredentials" that parses a file "filename" and returns the account
# details for "hostname".
#
+#
#remotehosteval = getcredentials("filename", "hostname", "hostname")
+#
+# The returned value must be int type.
#remoteporteval = getcredentials("filename", "hostname", "port")
+#
+# The returned value must be unicode type when there are non-ASCII characters.
#remoteusereval = getcredentials("filename", "hostname", "user")
+#
+# The returned value must be unicode type when there are non-ASCII characters.
#remotepasseval = getcredentials("filename", "hostname", "passwd")
@@ -742,9 +749,10 @@ remotehost = examplehost
# This option stands in the [Repository RemoteExample] section.
#
-# Specify the remote user name.
+# Specify the remote user name. Must be unicode when there are non-ASCII
+# characters.
#
-remoteuser = username
+remoteuser = u"username"
# This option stands in the [Repository RemoteExample] section.
@@ -760,7 +768,9 @@ remoteuser = username
# mechanism, so consider using auth_mechanisms to prioritize PLAIN
# or even make it the only mechanism to be tried.
#
-#remote_identity = authzuser
+# Must be unicode type when there are non-ASCII characters.
+#
+#remote_identity = u"authzuser"
# This option stands in the [Repository RemoteExample] section.
@@ -842,11 +852,11 @@ remoteuser = username
#
# 2. The remote password stored in this file with the remotepass
# option. Any '%' needs to be encoded as '%%'. Example:
-# remotepass = mypassword
+#remotepass = u"mypassword"
#
# 3. The remote password stored as a single line in an external
# file, which is referenced by the remotefile option. Example:
-# remotepassfile = ~/Password.IMAP.Account1
+#remotepassfile = ~/Password.IMAP.Account1
#
# 4. With a preauth tunnel. With this method, you invoke an external
# program that is guaranteed *NOT* to ask for a password, but rather
@@ -855,7 +865,7 @@ remoteuser = username
# NOT specify a user or password (if you do, they'll be ignored.)
# Instead, you specify a preauthtunnel, as this example illustrates
# for Courier IMAP on Debian:
-# preauthtunnel = ssh -q imaphost '/usr/bin/imapd ./Maildir'
+#preauthtunnel = ssh -q imaphost '/usr/bin/imapd ./Maildir'
#
# 5. If you are using Kerberos and have the Python Kerberos package
# installed, you should not specify a remotepass. If the user has a
@@ -865,9 +875,9 @@ remoteuser = username
# 6. Using arbitrary python code. With this method, you invoke a
# function from your pythonfile. To use this method assign the name
# of the function to the variable 'remotepasseval'. Example:
-# remotepasseval = get_password("imap.example.net")
+#remotepasseval = get_password("imap.example.net")
# You can also query for the username:
-# remoteusereval = get_username("imap.example.net")
+#remoteusereval = get_username("imap.example.net")
# This method can be used to design more elaborate setups, e.g. by
# querying the gnome-keyring via its python bindings.
@@ -1186,7 +1196,9 @@ type = Gmail
#
# Specify the Gmail user name. This is the only mandatory parameter.
#
-remoteuser = username at gmail.com
+# Must be unicode type when there are non-ASCII characters.
+#
+remoteuser = u"username at gmail.com"
# This option stands in the [Repository GmailExample] section.
diff --git a/offlineimap/imapserver.py b/offlineimap/imapserver.py
index f373326..63b4acd 100644
--- a/offlineimap/imapserver.py
+++ b/offlineimap/imapserver.py
@@ -1,5 +1,5 @@
# IMAP server support
-# Copyright (C) 2002 - 2016 John Goerzen & contributors
+# Copyright (C) 2002-2016 John Goerzen & contributors
#
# 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
@@ -154,6 +154,7 @@ class IMAPServer(object):
def __getpassword(self):
"""Returns the server password or None"""
+
if self.goodpassword != None: # use cached good one first
return self.goodpassword
@@ -216,12 +217,12 @@ class IMAPServer(object):
authc = self.username
passwd = self.__getpassword()
- authz = ''
+ authz = b''
if self.user_identity != None:
authz = self.user_identity
NULL = u'\x00'
- retval = NULL.join((authz, authc, passwd)).encode('utf-8')
- logsafe_retval = NULL.join((authz, authc, "(passwd hidden for log)")).encode('utf-8')
+ retval = NULL.join((authz, authc, passwd))
+ logsafe_retval = NULL.join((authz, authc, "(passwd hidden for log)"))
self.ui.debug('imap', '__plainhandler: returning %s' % logsafe_retval)
return retval
diff --git a/offlineimap/repository/IMAP.py b/offlineimap/repository/IMAP.py
index 7cdc956..0138975 100644
--- a/offlineimap/repository/IMAP.py
+++ b/offlineimap/repository/IMAP.py
@@ -1,5 +1,5 @@
# IMAP repository support
-# Copyright (C) 2002-2015 John Goerzen & contributors
+# Copyright (C) 2002-2016 John Goerzen & contributors
#
# 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
@@ -21,6 +21,7 @@ from sys import exc_info
import netrc
import errno
import six
+import codecs
from offlineimap.repository.Base import BaseRepository
from offlineimap import folder, imaputil, imapserver, OfflineImapError
@@ -129,7 +130,10 @@ class IMAPRepository(BaseRepository):
(currently -- PLAIN) to inform server about the ID
we want to authorize as instead of our login name."""
- return self.getconf('remote_identity', default=None)
+ identity = self.getconf('remote_identity', default=None)
+ if identity != None:
+ identity = identity.encode('UTF-8')
+ return identity
def get_auth_mechanisms(self):
supported = ["GSSAPI", "XOAUTH2", "CRAM-MD5", "PLAIN", "LOGIN"]
@@ -159,12 +163,12 @@ class IMAPRepository(BaseRepository):
if self.config.has_option(self.getsection(), 'remoteusereval'):
user = self.getconf('remoteusereval')
if user != None:
- return localeval.eval(user)
+ return localeval.eval(user).encode('UTF-8')
if self.config.has_option(self.getsection(), 'remoteuser'):
user = self.getconf('remoteuser')
if user != None:
- return user
+ return user.encode('UTF-8')
try:
netrcentry = netrc.netrc().authenticators(self.gethost())
@@ -326,18 +330,18 @@ class IMAPRepository(BaseRepository):
# 1. evaluate Repository 'remotepasseval'
passwd = self.getconf('remotepasseval', None)
if passwd != None:
- return self.localeval.eval(passwd)
+ return self.localeval.eval(passwd).encode('UTF-8')
# 2. read password from Repository 'remotepass'
password = self.getconf('remotepass', None)
if password != None:
- return password
+ return password.encode('UTF-8')
# 3. read password from file specified in Repository 'remotepassfile'
passfile = self.getconf('remotepassfile', None)
if passfile != None:
- fd = open(os.path.expanduser(passfile))
+ fd = codecs.open(os.path.expanduser(passfile), 'r', 'UTF-8')
password = fd.readline().strip()
fd.close()
- return password
+ return password.encode('UTF-8')
# 4. read password from ~/.netrc
try:
netrcentry = netrc.netrc().authenticators(self.gethost())
--
2.7.4
More information about the OfflineIMAP-project
mailing list