Metadata-Version: 1.1
Name: keyring
Version: 0.9.2
Summary: Store and access your passwords safely.
Home-page: http://bitbucket.org/kang/python-keyring-lib
Author: Jason R. Coombs
Author-email: jaraco@jaraco.com
License: PSF
Description: =======================================

        Installing and Using Python Keyring Lib

        =======================================

        

        .. contents:: **Table of Contents**

        

        ---------------------------

        What is Python keyring lib?

        ---------------------------

        

        The Python keyring lib provides a easy way to access the system keyring service

        from python. It can be used in any application that needs safe password storage.

        

        The keyring services supported by the Python keyring lib:

        

        * **OSXKeychain**: supports the Keychain service in Mac OS X.

        * **KDEKWallet**: supports the KDE's Kwallet service.

        * **GnomeKeyring**: for Gnome 2 environment.

        * **SecretServiceKeyring**: for newer GNOME and KDE environments.

        

        Besides these native password storing services provided by operating systems.

        Python keyring lib also provides following build-in keyrings.

        

        * **Win32CryptoKeyring**: for Windows 2k+.

        * **CryptedFileKeyring**: a command line interface keyring base on PyCrypto.

        * **UncryptedFileKeyring**: a keyring which leaves passwords directly in file.

        

        -------------------------

        Installation Instructions

        -------------------------

        

        easy_install or pip

        ===================

        

        Run easy_install or pip::

        

            $ easy_install keyring

            $ pip install keyring

        

        Source installation

        ===================

        

        Download the source tarball, and uncompress it, then run the install command::

        

            $ wget http://pypi.python.org/packages/source/k/keyring/keyring-0.3.tar.gz

            $ tar -xzvf keyring-0.3.tar.gz

            $ cd keyring-0.3

            $ python setup.py install

        

        

        --------------------------

        Configure your keyring lib

        --------------------------

        

        The python keyring lib contains implementations for several backends, including

        **OSX Keychain**, **Gnome Keyring**, **KDE Kwallet** and etc. The lib will

        automatically choose the keyring that is most suitable for your current

        environment. You can also specify the keyring you like to be used in the config

        file or by calling the ``set_keyring()`` function.

        

        Customize your keyring by config file

        =====================================

        

        This section is about how to change your option in the config file.

        

        Config file path

        ----------------

        

        The configuration of the lib is stored in a file named "keyringrc.cfg". The file

        can be stored in either of following two paths.

        

        1. The working directory of the python

        2. The home directory for current user

        

        The lib will first look for the config file in the working directory. If no

        config file exists **or** the config file cannot be written properly, keyring

        will reference the config in the home directory.

        

        Beginning with keyring 0.8, the config root is platform specific. To determine

        where in the home directory the config file (and other data files) are stored,

        run the following::

        

            python -c "import keyring.util.platform; print(keyring.util.platform.data_root())"

        

        Config file content

        -------------------

        

        To specify a keyring backend, you need tell the lib the module name of the

        backend, such as ``keyring.backend.OSXKeychain``. If the backend is not shipped

        with the lib, in another word, is made by you own, you need also tell the lib

        the path of your own backend module. The module name should be written after the

        **default-keyring** option, while the module path belongs the **keyring-path**

        option.

        

        Here's a sample config file(The full demo can be accessed in the ``demo/keyring.py``):

        ::

        

            [backend]

            default-keyring=simplekeyring.SimpleKeyring

            keyring-path=/home/kang/pyworkspace/python-keyring-lib/demo/

        

        

        Write your own keyring backend

        ==============================

        

        The interface for the backend is defined by ``keyring.backend.KeyringBackend``.

        By extending this base class and implementing the three functions

        ``supported()``, ``get_password()`` and ``set_password()``, you can easily create

        your own backend for keyring lib.

        

        The usage of the three functions:

        

        * ``supported(self)`` : Return if this backend is supported in current

          environment. The returned value can be **0**, **1** , or **-1**. **0** means

          suitable; **1** means recommended and **-1** means this backend is not

          available for current environment.

        * ``get_password(self, service, username)`` : Return the stored password for the

          ``username`` of the ``service``.

        * ``set_password(self, service, username, password)`` : Store the ``password``

          for ``username`` of the ``service`` in the backend.

        

        For an instance, there's the source code of the demo mentioned above. It's a

        simple keyring which stores the password directly in memory.

        

        ::

        

            """

            simplekeyring.py

        

            A simple keyring class for the keyring_demo.py

        

            Created by Kang Zhang on 2009-07-12

            """

            from keyring.backend import KeyringBackend

        

            class SimpleKeyring(KeyringBackend):

                """Simple Keyring is a keyring which can store only one

                password in memory.

                """

                def __init__(self):

                    self.password = ''

        

                def supported(self):

                    return 0

        

                def get_password(self, service, username):

                    return self.password

        

                def set_password(self, service, username, password):

                    self.password = password

                    return 0

        

        

        Set the keyring in runtime

        ==========================

        

        Besides setting the backend through the config file, you can also set the

        backend to use by calling the api ``set_keyring()``. The backend you passed in

        will be used to store the password in your application.

        

        Here's a code snippet from the ``keyringdemo.py``. It shows the usage of

        ``set_keyring()``

        ::

        

            # define a new keyring class which extends the KeyringBackend

            import keyring.backend

            class TestKeyring(keyring.backend.KeyringBackend):

                """A test keyring which always outputs same password

                """

                def supported(self): return 0

                def set_password(self, servicename, username, password): return 0

                def get_password(self, servicename, username):

                    return "password from TestKeyring"

        

            # set the keyring for keyring lib

            import keyring

            keyring.set_keyring(TestKeyring())

        

            # invoke the keyring lib

            try:

                keyring.set_password("demo-service", "tarek", "passexample")

                print "password stored sucessfully"

            except keyring.backend.PasswordError:

                print "failed to store password"

            print "password", keyring.get_password("demo-service", "tarek")

        

        

        -----------------------------------------------

        Integrate the keyring lib with your application

        -----------------------------------------------

        

        API interface

        =============

        

        The keyring lib has two functions:

        

        * ``get_password(service, username)`` : Returns the password stored in keyring.

          If the password does not exist, it will return None.

        * ``set_password(service, username, password)`` : Store the password in the

          keyring.

        

        Example

        =======

        

        Here's an example of using keyring for application authorization. It can be

        found in the demo folder of the repository. Note that the faked auth function

        only returns true when the password equals to the username.

        ::

        

            """

            auth_demo.py

        

            Created by Kang Zhang 2009-08-14

            """

        

            import keyring

            import getpass

            import ConfigParser

        

            def auth(username, password):

                """A faked authorization function.

                """

                return username == password

        

            def main():

                """This scrip demos how to use keyring facilite the authorization. The

                username is stored in a config named 'auth_demo.cfg'

                """

                # config file init

                config_file = 'auth_demo.cfg'

                config = ConfigParser.SafeConfigParser({

                            'username':'',

                            })

                config.read(config_file)

                if not config.has_section('auth_demo_login'):

                    config.add_section('auth_demo_login')

        

                username = config.get('auth_demo_login','username')

                password = None

                if username != '':

                    password = keyring.get_password('auth_demo_login', username)

        

                if password == None or not auth(username, password):

        

                    while 1:

                        username = raw_input("Username:\n")

                        password = getpass.getpass("Password:\n")

        

                        if auth(username, password):

                            break

                        else:

                            print "Authorization failed."

        

                    # store the username

                    config.set('auth_demo_login', 'username', username)

                    config.write(open(config_file, 'w'))

        

                    # store the password

                    keyring.set_password('auth_demo_login', username, password)

        

                # the stuff that needs authorization here

                print "Authorization successful."

        

            if __name__ == "__main__":

                main()

        

        ------------

        Get involved

        ------------

        

        Python keyring lib is an open community project and highly welcomes new

        contributors.

        

        * Repository: http://bitbucket.org/kang/python-keyring-lib/

        * Bug Tracker: http://bitbucket.org/kang/python-keyring-lib/issues/

        * Mailing list: http://groups.google.com/group/python-keyring

        

        Running Tests

        =============

        

        To run the tests, you'll want keyring installed to some environment in which

        it can be tested. Two recommended techniques are described below.

        

        Using virtualenv and pytest/nose/unittest2

        ------------------------------------------

        

        Pytest and Nose are two popular test runners that will discover tests and run

        them. Unittest2 (also known as simply unittest in Python 3) also has a mode

        to discover tests.

        

        First, however, these test runners typically need a test environment in which

        to run. It is recommended that you install keyring to a virtual environment

        to avoid interfering with your system environment. For more information, see

        the `virtualenv homepage <http://www.virtualenv.org>`_.

        

        After you've created (or designated) your environment, install keyring into

        the environment by running::

        

            python setup.py develop

        

        Then, invoke your favorite test runner, e.g.::

        

            py.test

        

        or::

        

            nosetests

        

        Using buildout

        --------------

        

        The keyring repo bundles buildout's bootstrap script as a subrepo, so using

        buildout is three easy steps::

        

            1. python buildout/bootstrap  # bootstrap the buildout.

            2. bin/buildout  # prepare the buildout.

            3. bin/test  # execute the test runner.

        

        For more information about the options that the script provides do execute::

        

            python bin/test --help

        

        -------

        Credits

        -------

        

        The project was based on Tarek Ziade's idea in `this post`_. Kang Zhang

        initially carried it out as a `Google Summer of Code`_ project, and Tarek

        mentored Kang on this project.

        

        .. _this post: http://tarekziade.wordpress.com/2009/03/27/pycon-hallway-session-1-a-keyring-library-for-python/

        .. _Google Summer of Code: http://socghop.appspot.com/

        

        See CONTRIBUTORS.txt for a complete list of contributors.

        

        =======

        CHANGES

        =======

        

        -----

        0.9.2

        -----

        

        * Keyring 0.9.1 introduced a whole different storage format for the

          CryptedFileKeyring, but this introduced some potential compatibility issues.

          This release incorporates the security updates but reverts to the INI file

          format for storage, only encrypting the passwords and leaving the service

          and usernames in plaintext. Subsequent releases may incorporate a new

          keyring to implement a whole-file encrypted version. Fixes #64.

        * The CryptedFileKeyring now requires simplejson for Python 2.5 clients.

        

        -----

        0.9.1

        -----

        

        * Fix for issue where SecretServiceBackend.set_password would raise a

          UnicodeError on Python 3 or when a unicode password was provided on Python

          2.

        * CryptedFileKeyring now uses PBKDF2 to derive the key from the user's

          password and a random hash. The IV is chosen randomly as well. All the

          stored passwords are encrypted at once. Any keyrings using the old format

          will be automatically converted to the new format (but will no longer be

          compatible with 0.9 and earlier). The user's password is no longer limited

          to 32 characters. PyCrypto 2.5 or greater is now required for this keyring.

        

        ---

        0.9

        ---

        

        * Add support for GTK 3 and secret service D-Bus. Fixes #52.

        * Issue #60 - Use correct method for decoding.

        

        -----

        0.8.1

        -----

        

        * Fix regression in keyring lib on Windows XP where the LOCALAPPDATA

          environment variable is not present.

        

        ---

        0.8

        ---

        

        * Mac OS X keyring backend now uses subprocess calls to the `security`

          command instead of calling the API, which with the latest updates, no

          longer allows Python to invoke from a virtualenv. Fixes issue #13.

        * When using file-based storage, the keyring files are no longer stored

          in the user's home directory, but are instead stored in platform-friendly

          locations (`%localappdata%\Python Keyring` on Windows and according to

          the freedesktop.org Base Dir Specification

          (`$XDG_DATA_HOME/python_keyring` or `$HOME/.local/share/python_keyring`)

          on other operating systems). This fixes #21.

        

        *Backward Compatibility Notice*

        

        Due to the new storage location for file-based keyrings, keyring 0.8

        supports backward compatibility by automatically moving the password

        files to the updated location. In general, users can upgrade to 0.8 and

        continue to operate normally. Any applications that customize the storage

        location or make assumptions about the storage location will need to take

        this change into consideration. Additionally, after upgrading to 0.8,

        it is not possible to downgrade to 0.7 without manually moving

        configuration files. In 1.0, the backward compatibilty

        will be removed.

        

        -----

        0.7.1

        -----

        

        * Removed non-ASCII characters from README and CHANGES docs (required by

          distutils if we're to include them in the long_description). Fixes #55.

        

        ---

        0.7

        ---

        

        * Python 3 is now supported. All tests now pass under Python 3.2 on

          Windows and Linux (although Linux backend support is limited). Fixes #28.

        * Extension modules on Mac and Windows replaced by pure-Python ctypes

          implementations. Thanks to Jerome Laheurte.

        * WinVaultKeyring now supports multiple passwords for the same service. Fixes

          #47.

        * Most of the tests don't require user interaction anymore.

        * Entries stored in Gnome Keyring appears now with a meaningful name if you try

          to browser your keyring (for ex. with Seahorse)

        * Tests from Gnome Keyring no longer pollute the user own keyring.

        * `keyring.util.escape` now accepts only unicode strings. Don't try to encode

          strings passed to it.

        

        -----

        0.6.2

        -----

        

        * fix compiling on OSX with XCode 4.0

        

        -----

        0.6.1

        -----

        

        * Gnome keyring should not be used if there is no DISPLAY or if the dbus is

          not around (https://bugs.launchpad.net/launchpadlib/+bug/752282).

        

        ---

        0.6

        ---

        

        * Added `keyring.http` for facilitating HTTP Auth using keyring.

        

        * Add a utility to access the keyring from the command line.

        

        -----

        0.5.1

        -----

        

        * Remove a spurious KDE debug message when using KWallet

        

        * Fix a bug that caused an exception if the user canceled the KWallet dialog

          (https://bitbucket.org/kang/python-keyring-lib/issue/37/user-canceling-of-kde-wallet-dialogs).

        

        ---

        0.5

        ---

        

        * Now using the existing Gnome and KDE python libs instead of custom C++

          code.

        

        * Using the getpass module instead of custom code

        

        ---

        0.4

        ---

        

        * Fixed the setup script (some subdirs were not included in the release.)

        

        ---

        0.3

        ---

        

        * Fixed keyring.core when the user doesn't have a cfg, or is not

          properly configured.

        

        * Fixed escaping issues for usernames with non-ascii characters

        

        ---

        0.2

        ---

        

        * Add support for Python 2.4+

          http://bitbucket.org/kang/python-keyring-lib/issue/2

        

        * Fix the bug in KDE Kwallet extension compiling

          http://bitbucket.org/kang/python-keyring-lib/issue/3

        
Keywords: keyring Keychain GnomeKeyring Kwallet password storage
Platform: Many
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 2.4
Classifier: Programming Language :: Python :: 2.5
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
