Your IP : 172.28.240.42
"""
backend.py
Keyring Backend implementations
"""
import getpass
import os
import stat
import sys
import ConfigParser
import base64
import StringIO
from keyring.util.escape import escape as escape_for_ini
import keyring.util.escape
from keyring.util import properties
import keyring.util.platform
import keyring.util.loc_compat
import keyring.py25compat
# use abstract base classes from the compat module
abc = keyring.py25compat.abc
# use json from the compat module
json = keyring.py25compat.json
class PasswordSetError(Exception):
"""Raised when the password can't be set.
"""
class KeyringBackend(object):
"""The abstract base class of the keyring, every backend must implement
this interface.
"""
__metaclass__ = abc.ABCMeta
@abc.abstractmethod
def supported(self):
"""Return if this keyring supports current environment:
-1: not applicable
0: suitable
1: recommended
"""
return -1
@abc.abstractmethod
def get_password(self, service, username):
"""Get password of the username for the service
"""
return None
@abc.abstractmethod
def set_password(self, service, username, password):
"""Set password for the username of the service
"""
raise PasswordSetError("reason")
class _ExtensionKeyring(KeyringBackend):
"""_ExtensionKeyring is a adaptor class for the platform related keyring
backends.
"""
def __init__(self):
try:
self.keyring_impl = self._init_backend()
except ImportError:
# keyring is not installed properly
self.keyring_impl = None
def _init_backend(self):
"""Return the keyring implementation handler
"""
return None
def _recommend(self):
"""If this keyring is recommended on current environment.
"""
return False
def supported(self):
"""Override the supported() in KeyringBackend.
"""
if self.keyring_impl is None:
return -1
elif self._recommend():
return 1
return 0
def get_password(self, service, username):
"""Override the get_password() in KeyringBackend.
"""
try:
password = self.keyring_impl.password_get(service, username)
except OSError:
password = None
return password
def set_password(self, service, username, password):
"""Override the set_password() in KeyringBackend.
"""
try:
self.keyring_impl.password_set(service, username, password)
except OSError, e:
raise PasswordSetError(e.message)
class OSXKeychain(_ExtensionKeyring):
"""Mac OS X Keychain"""
def _init_backend(self):
"""Return the handler: osx_keychain
"""
from backends import osx_keychain
return osx_keychain
def _recommend(self):
"""Recommended for all OSX environment.
"""
return sys.platform == 'darwin'
class GnomeKeyring(KeyringBackend):
"""Gnome Keyring"""
# Name of the keyring to store the passwords in.
# Use None for the default keyring.
KEYRING_NAME = None
def supported(self):
try:
__import__('gnomekeyring')
except ImportError:
return -1
else:
if ("GNOME_KEYRING_CONTROL" in os.environ and
"DISPLAY" in os.environ and
"DBUS_SESSION_BUS_ADDRESS" in os.environ):
return 1
else:
return 0
def get_password(self, service, username):
"""Get password of the username for the service
"""
import gnomekeyring
try:
items = gnomekeyring.find_network_password_sync(username, service)
except gnomekeyring.NoMatchError:
return None
except gnomekeyring.CancelledError:
# The user pressed "Cancel" when prompted to unlock their keyring.
return None
assert len(items) == 1, 'no more than one entry should ever match'
return items[0]['password']
def set_password(self, service, username, password):
"""Set password for the username of the service
"""
import gnomekeyring
try:
gnomekeyring.item_create_sync(
self.KEYRING_NAME, gnomekeyring.ITEM_NETWORK_PASSWORD,
"Password for '%s' on '%s'" % (username, service),
{'user': username, 'domain': service},
password, True)
except gnomekeyring.CancelledError:
# The user pressed "Cancel" when prompted to unlock their keyring.
raise PasswordSetError("cancelled by user")
class SecretServiceKeyring(KeyringBackend):
"""Secret Service Keyring"""
def supported(self):
try:
import dbus
except ImportError:
return -1
try:
bus = dbus.SessionBus()
bus.get_object('org.freedesktop.secrets',
'/org/freedesktop/secrets')
except dbus.exceptions.DBusException:
return -1
else:
return 1
def get_password(self, service, username):
"""Get password of the username for the service
"""
import dbus
bus = dbus.SessionBus()
service_obj = bus.get_object('org.freedesktop.secrets',
'/org/freedesktop/secrets')
service_iface = dbus.Interface(service_obj,
'org.freedesktop.Secret.Service')
unlocked, locked = service_iface.SearchItems(
{"username": username, "service": service})
_, session = service_iface.OpenSession("plain", "")
no_longer_locked, prompt = service_iface.Unlock(locked)
assert prompt == "/"
secrets = service_iface.GetSecrets(unlocked + locked, session)
for item_path, secret in secrets.iteritems():
return "".join([str(x) for x in secret[2]])
return None
def set_password(self, service, username, password):
"""Set password for the username of the service
"""
import dbus
bus = dbus.SessionBus()
service_obj = bus.get_object('org.freedesktop.secrets',
'/org/freedesktop/secrets')
service_iface = dbus.Interface(service_obj,
'org.freedesktop.Secret.Service')
collection_obj = bus.get_object(
'org.freedesktop.secrets',
'/org/freedesktop/secrets/aliases/default')
collection = dbus.Interface(collection_obj,
'org.freedesktop.Secret.Collection')
attributes = {
"service": service,
"username": username
}
_, session = service_iface.OpenSession("plain", "")
if isinstance(password, unicode):
password = password.encode('utf-8')
secret = dbus.Struct(
(session, "", dbus.ByteArray(password), "text/plain"))
properties = {
"org.freedesktop.Secret.Item.Label": "%s @ %s" % (
username, service),
"org.freedesktop.Secret.Item.Attributes": attributes}
(item, prompt) = collection.CreateItem(properties, secret,
True)
assert prompt == "/"
kwallet = None
def open_kwallet(kwallet_module=None, qt_module=None):
# If we specified the kwallet_module and/or qt_module, surely we won't need
# the cached kwallet object...
if kwallet_module is None and qt_module is None:
global kwallet
if not kwallet is None:
return kwallet
# Allow for the injection of module-like objects for testing purposes.
if kwallet_module is None:
kwallet_module = KWallet.Wallet
if qt_module is None:
qt_module = QtGui
# KDE wants us to instantiate an application object.
app = None
if qt_module.qApp.instance() == None:
app = qt_module.QApplication([])
try:
window = qt_module.QWidget()
kwallet = kwallet_module.openWallet(
kwallet_module.NetworkWallet(),
window.winId(),
kwallet_module.Synchronous)
if kwallet is not None:
if not kwallet.hasFolder('Python'):
kwallet.createFolder('Python')
kwallet.setFolder('Python')
return kwallet
finally:
if app:
app.exit()
try:
from PyKDE4.kdeui import KWallet
from PyQt4 import QtGui
except ImportError:
kwallet_support = False
else:
kwallet_support = True
class KDEKWallet(KeyringBackend):
"""KDE KWallet"""
def supported(self):
if kwallet_support and 'KDE_SESSION_UID' in os.environ:
return 1
elif kwallet_support:
return 0
else:
return -1
def get_password(self, service, username):
"""Get password of the username for the service
"""
key = username + '@' + service
network = KWallet.Wallet.NetworkWallet()
wallet = open_kwallet()
if wallet.keyDoesNotExist(network, 'Python', key):
return None
result = wallet.readPassword(key)[1]
# The string will be a PyQt4.QtCore.QString, so turn it into a unicode
# object.
return unicode(result)
def set_password(self, service, username, password):
"""Set password for the username of the service
"""
wallet = open_kwallet()
wallet.writePassword(username+'@'+service, password)
class BasicFileKeyring(KeyringBackend):
"""
BasicFileKeyring is a file-based implementation of keyring.
This keyring stores the password directly in the file and provides methods
which may be overridden by subclasses to support
encryption and decryption. The encrypted payload is stored in base64
format.
"""
@properties.NonDataProperty
def file_path(self):
"""
The path to the file where passwords are stored. This property
may be overridden by the subclass or at the instance level.
"""
return os.path.join(keyring.util.platform.data_root(), self.filename)
@abc.abstractproperty
def filename(self):
"""The filename used to store the passwords.
"""
pass
@abc.abstractmethod
def encrypt(self, password):
"""Encrypt the password.
"""
pass
@abc.abstractmethod
def decrypt(self, password_encrypted):
"""Decrypt the password.
"""
pass
def _migrate(self, keyring_password=None):
"""Convert older keyrings to the current format.
"""
pass
def _relocate_file(self):
old_location = os.path.join(os.path.expanduser('~'), self.filename)
new_location = self.file_path
keyring.util.loc_compat.relocate_file(old_location, new_location)
# disable this function - it only needs to be run once
self._relocate_file = lambda: None
def get_password(self, service, username):
"""Read the password from the file.
"""
self._relocate_file()
service = escape_for_ini(service)
username = escape_for_ini(username)
# load the passwords from the file
config = ConfigParser.RawConfigParser()
if os.path.exists(self.file_path):
self._migrate()
config.read(self.file_path)
# fetch the password
try:
password_base64 = config.get(service, username).encode()
# decode with base64
password_encrypted = base64.decodestring(password_base64)
# decrypted the password
password = self.decrypt(password_encrypted).decode('utf-8')
except (ConfigParser.NoOptionError, ConfigParser.NoSectionError):
password = None
return password
def set_password(self, service, username, password):
"""Write the password in the file.
"""
self._relocate_file()
service = escape_for_ini(service)
username = escape_for_ini(username)
# encrypt the password
password_encrypted = self.encrypt(password.encode('utf-8'))
# load the password from the disk
config = ConfigParser.RawConfigParser()
if os.path.exists(self.file_path):
config.read(self.file_path)
# encode with base64
password_base64 = base64.encodestring(password_encrypted).decode()
# write the modification
if not config.has_section(service):
config.add_section(service)
config.set(service, username, password_base64)
self._ensure_file_path()
config_file = open(self.file_path,'w')
config.write(config_file)
def _ensure_file_path(self):
"""ensure the storage path exists"""
storage_root = os.path.dirname(self.file_path)
if storage_root and not os.path.isdir(storage_root):
os.makedirs(storage_root)
os.chmod(storage_root, stat.S_IWRITE | stat.S_IREAD | stat.S_IEXEC)
class UncryptedFileKeyring(BasicFileKeyring):
"""Uncrypted File Keyring"""
filename = 'keyring_pass.cfg'
def encrypt(self, password):
"""Directly return the password itself.
"""
return password
def decrypt(self, password_encrypted):
"""Directly return encrypted password.
"""
return password_encrypted
def supported(self):
"""Applicable for all platforms, but do not recommend.
"""
return 0
class CryptedFileKeyring(BasicFileKeyring):
"""PyCrypto File Keyring"""
# a couple constants
block_size = 32
pad_char = '0'
filename = 'crypted_pass.cfg'
def supported(self):
"""Applicable for all platforms, but not recommend"
"""
try:
__import__('Crypto.Cipher.AES')
__import__('Crypto.Protocol.KDF')
__import__('Crypto.Random')
if not json:
raise AssertionError("JSON implementation needed (install "
"simplejson)")
status = 0
except (ImportError, AssertionError):
status = -1
return status
@properties.NonDataProperty
def keyring_key(self):
# _unlock or _init_file will set the key or raise an exception
if self._check_file():
self._unlock()
else:
self._init_file()
return self.keyring_key
def _get_new_password(self):
while True:
password = getpass.getpass(
"Please set a password for your new keyring: ")
confirm = getpass.getpass('Please confirm the password: ')
if password != confirm:
sys.stderr.write("Error: Your passwords didn't match\n")
continue
if '' == password.strip():
# forbid the blank password
sys.stderr.write("Error: blank passwords aren't allowed.\n")
continue
return password
def _init_file(self):
"""
Initialize a new password file and set the reference password.
"""
self.keyring_key = self._get_new_password()
# set a reference password, used to check that the password provided
# matches for subsequent checks.
self.set_password('keyring-setting', 'password reference',
'password reference value')
def _check_file(self):
"""
Check if the file exists and has the expected password reference.
"""
if not os.path.exists(self.file_path):
return False
self._migrate()
config = ConfigParser.RawConfigParser()
config.read(self.file_path)
try:
config.get(
escape_for_ini('keyring-setting'),
escape_for_ini('password reference'),
)
except (ConfigParser.NoSectionError, ConfigParser.NoOptionError):
return False
return True
def _unlock(self):
"""
Unlock this keyring by getting the password for the keyring from the
user.
"""
self.keyring_key = getpass.getpass(
'Please enter password for encrypted keyring: ')
try:
ref_pw = self.get_password('keyring-setting', 'password reference')
assert ref_pw == 'password reference value'
except AssertionError:
self._lock()
raise ValueError("Incorrect Password")
def _lock(self):
"""
Remove the keyring key from this instance.
"""
del self.keyring_key
def _create_cipher(self, password, salt, IV):
"""
Create the cipher object to encrypt or decrypt a payload.
"""
def PBKDF2(password, salt, dkLen=16, count=1000, prf=None):
import sys
import struct
from Crypto.Util.py3compat import b
from Crypto.Hash import SHA as SHA1, HMAC
from Crypto.Util.strxor import strxor
if sys.version_info[0] == 2:
def tobytes(s):
if isinstance(s, unicode):
return s.encode("latin-1")
else:
return ''.join(s)
else:
def tobytes(s):
if isinstance(s,bytes):
return s
else:
if isinstance(s,str):
return s.encode("latin-1")
else:
return bytes(s)
password = tobytes(password)
if prf is None:
prf = lambda p,s: HMAC.new(p,s,SHA1).digest()
key = b('')
i = 1
while len(key)<dkLen:
U = previousU = prf(password,salt+struct.pack(">I", i))
for j in xrange(count-1):
previousU = t = prf(password,previousU)
U = strxor(U,t)
key += U
i = i + 1
return key[:dkLen]
from Crypto.Cipher import AES
pw = PBKDF2(password, salt, dkLen=self.block_size)
return AES.new(pw[:self.block_size], AES.MODE_CFB, IV)
def encrypt(self, password):
from Crypto.Random import get_random_bytes
salt = get_random_bytes(self.block_size)
from Crypto.Cipher import AES
IV = get_random_bytes(AES.block_size)
cipher = self._create_cipher(self.keyring_key, salt, IV)
password_encrypted = cipher.encrypt('pw:' + password)
# Serialize the salt, IV, and encrypted password in a secure format
data = dict(
salt=salt, IV=IV, password_encrypted=password_encrypted,
)
for key in data:
data[key] = data[key].encode('base64')
return json.dumps(data)
def decrypt(self, password_encrypted):
# unpack the encrypted payload
data = json.loads(password_encrypted)
for key in data:
data[key] = data[key].decode('base64')
cipher = self._create_cipher(self.keyring_key, data['salt'],
data['IV'])
plaintext = cipher.decrypt(data['password_encrypted'])
assert plaintext.startswith('pw:')
return plaintext[3:]
def _migrate(self, keyring_password=None):
"""
Convert older keyrings to the current format.
"""
self.__convert_0_9_0(keyring_password)
self.__convert_0_9_1(keyring_password)
def __convert_0_9_1(self, keyring_password):
"""
Convert keyring from the 0.9.1 format to the current format.
"""
with open(self.file_path) as f:
encoded_lines = list(f)
try:
head, data = [line.decode('base64') for line in encoded_lines]
except Exception:
# not an 0.9.1 formatted file
return
print("Keyring from 0.9.1 detected. Upgrading...")
salt = head[:self.block_size]
IV = head[self.block_size:]
if keyring_password is None:
keyring_password = getpass.getpass(
"Please input your password for the keyring: ")
cipher = self._create_cipher(keyring_password, salt, IV)
config_file = StringIO.StringIO(cipher.decrypt(data))
config = ConfigParser.RawConfigParser()
try:
config.readfp(config_file)
except ConfigParser.Error:
sys.stderr.write("Wrong password for the keyring.\n")
raise ValueError("Wrong password")
self.keyring_key = keyring_password
# wipe the existing file
os.remove(self.file_path)
self.set_password('keyring-setting', 'password reference',
'password reference value')
for service in config.sections():
for user in config.options(service):
password = config.get(service, user).decode('utf-8')
service = keyring.util.escape.unescape(service)
user = keyring.util.escape.unescape(user)
self.set_password(service, user, password)
print("File upgraded successfully")
def __convert_0_9_0(self, keyring_password):
"""
Convert keyring from the 0.9.0 and earlier format to the current
format.
"""
KEYRING_SETTING = 'keyring-setting'
CRYPTED_PASSWORD = 'crypted-password'
try:
config = ConfigParser.RawConfigParser()
config.read(self.file_path)
config.get(KEYRING_SETTING, CRYPTED_PASSWORD)
except Exception:
return
print("Keyring from 0.9.0 or earlier detected. Upgrading...")
import crypt
if keyring_password is None:
keyring_password = getpass.getpass(
"Please input your password for the keyring: ")
hashed = crypt.crypt(keyring_password, keyring_password)
if config.get(KEYRING_SETTING, CRYPTED_PASSWORD) != hashed:
sys.stderr.write("Wrong password for the keyring.\n")
raise ValueError("Wrong password")
self.keyring_key = keyring_password
config.remove_option(KEYRING_SETTING, CRYPTED_PASSWORD)
with open(self.file_path, 'w') as f:
config.write(f)
self.set_password('keyring-setting', 'password reference',
'password reference value')
from Crypto.Cipher import AES
password = keyring_password + (
self.block_size - len(keyring_password) % self.block_size
) * self.pad_char
for service in config.sections():
for user in config.options(service):
cipher = AES.new(password, AES.MODE_CFB,
'\0' * AES.block_size)
password_c = config.get(service, user).decode('base64')
service = keyring.util.escape.unescape(service)
user = keyring.util.escape.unescape(user)
password_p = cipher.decrypt(password_c)
self.set_password(service, user, password_p)
print("File upgraded successfully")
class Win32CryptoKeyring(BasicFileKeyring):
"""Win32 Cryptography Keyring"""
filename = 'wincrypto_pass.cfg'
def __init__(self):
super(Win32CryptoKeyring, self).__init__()
try:
from backends import win32_crypto
self.crypt_handler = win32_crypto
except ImportError:
self.crypt_handler = None
def supported(self):
"""Recommended when other Windows backends are unavailable
"""
recommended = select_windows_backend()
if recommended == None:
return -1
elif recommended == 'file':
return 1
else:
return 0
def encrypt(self, password):
"""Encrypt the password using the CryptAPI.
"""
return self.crypt_handler.encrypt(password)
def decrypt(self, password_encrypted):
"""Decrypt the password using the CryptAPI.
"""
return self.crypt_handler.decrypt(password_encrypted)
class WinVaultKeyring(KeyringBackend):
"""
WinVaultKeyring stores encrypted passwords using the Windows Credential
Manager.
Requires pywin32
This backend does some gymnastics to simulate multi-user support,
which WinVault doesn't support natively. See
https://bitbucket.org/kang/python-keyring-lib/issue/47/winvaultkeyring-only-ever-returns-last#comment-731977
for details on the implementation, but here's the gist:
Passwords are stored under the service name unless there is a collision
(another password with the same service name but different user name),
in which case the previous password is moved into a compound name:
{username}@{service}
"""
def __init__(self):
super(WinVaultKeyring, self).__init__()
try:
import pywintypes
import win32cred
self.win32cred = win32cred
self.pywintypes = pywintypes
except ImportError:
self.win32cred = None
def supported(self):
'''Default Windows backend, when it is available
'''
recommended = select_windows_backend()
if recommended == None:
return -1
elif recommended == 'cred':
return 1
else:
return 0
@staticmethod
def _compound_name(username, service):
return u'%(username)s@%(service)s' % vars()
def get_password(self, service, username):
# first attempt to get the password under the service name
res = self._get_password(service)
if not res or res['UserName'] != username:
# It wasn't found so attempt to get it with the compound name
res = self._get_password(self._compound_name(username, service))
if not res:
return None
blob = res['CredentialBlob']
return blob.decode('utf-16')
def _get_password(self, target):
try:
res = self.win32cred.CredRead(
Type=self.win32cred.CRED_TYPE_GENERIC,
TargetName=target,
)
except self.pywintypes.error, e:
if e.winerror == 1168 and e.funcname == 'CredRead': # not found
return None
raise
return res
def set_password(self, service, username, password):
existing_pw = self._get_password(service)
if existing_pw:
# resave the existing password using a compound target
existing_username = existing_pw['UserName']
target = self._compound_name(existing_username, service)
self._set_password(target, existing_username,
existing_pw['CredentialBlob'].decode('utf-16'))
self._set_password(service, username, unicode(password))
def _set_password(self, target, username, password):
credential = dict(Type=self.win32cred.CRED_TYPE_GENERIC,
TargetName=target,
UserName=username,
CredentialBlob=password,
Comment="Stored using python-keyring",
Persist=self.win32cred.CRED_PERSIST_ENTERPRISE)
self.win32cred.CredWrite(credential, 0)
def delete_password(self, service, username):
compound = self._compound_name(username, service)
for target in service, compound:
existing_pw = self._get_password(target)
if existing_pw and existing_pw['UserName'] == username:
self._delete_password(target)
def _delete_password(self, target):
self.win32cred.CredDelete(
Type=self.win32cred.CRED_TYPE_GENERIC,
TargetName=target,
)
class Win32CryptoRegistry(KeyringBackend):
"""Win32CryptoRegistry is a keyring which use Windows CryptAPI to encrypt
the user's passwords and store them under registry keys
"""
def __init__(self):
super(Win32CryptoRegistry, self).__init__()
try:
from backends import win32_crypto
__import__('_winreg')
self.crypt_handler = win32_crypto
except ImportError:
self.crypt_handler = None
def supported(self):
"""Return if this keyring supports current enviroment.
-1: not applicable
0: suitable
1: recommended
"""
recommended = select_windows_backend()
if recommended == None:
return -1
elif recommended == 'reg':
return 1
else:
return 0
def get_password(self, service, username):
"""Get password of the username for the service
"""
from _winreg import HKEY_CURRENT_USER, OpenKey, QueryValueEx
try:
# fetch the password
key = r'Software\%s\Keyring' % service
hkey = OpenKey(HKEY_CURRENT_USER, key)
password_base64 = QueryValueEx(hkey, username)[0]
# decode with base64
password_encrypted = base64.decodestring(password_base64)
# decrypted the password
password = self.crypt_handler.decrypt(password_encrypted)
except EnvironmentError:
password = None
return password
def set_password(self, service, username, password):
"""Write the password to the registry
"""
# encrypt the password
password_encrypted = self.crypt_handler.encrypt(password)
# encode with base64
password_base64 = base64.encodestring(password_encrypted)
# store the password
from _winreg import HKEY_CURRENT_USER, CreateKey, SetValueEx, REG_SZ
hkey = CreateKey(HKEY_CURRENT_USER, r'Software\%s\Keyring' % service)
SetValueEx(hkey, username, 0, REG_SZ, password_base64)
def select_windows_backend():
if os.name != 'nt':
return None
major, minor, build, platform, text = sys.getwindowsversion()
try:
__import__('pywintypes')
__import__('win32cred')
if (major, minor) >= (5, 1):
# recommend for windows xp+
return 'cred'
except ImportError:
pass
try:
__import__('keyring.backends.win32_crypto')
__import__('_winreg')
if (major, minor) >= (5, 0):
# recommend for windows 2k+
return 'reg'
except ImportError:
pass
try:
__import__('keyring.backends.win32_crypto')
return 'file'
except ImportError:
pass
return None
_all_keyring = None
def get_all_keyring():
"""Return the list of all keyrings in the lib
"""
global _all_keyring
if _all_keyring is None:
_all_keyring = [OSXKeychain(), GnomeKeyring(), KDEKWallet(),
CryptedFileKeyring(), UncryptedFileKeyring(),
Win32CryptoKeyring(), Win32CryptoRegistry(),
WinVaultKeyring(), SecretServiceKeyring()]
return _all_keyring