/usr/share/pyshared/keyring-0.7.1.egg-info/PKG-INFO is in python-keyring 0.7.1-1fakesync1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 | Metadata-Version: 1.1
Name: keyring
Version: 0.7.1
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 environment.
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 is not write properly, the lib will
look up in the home folder.
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
=============
In order to be able to run the tests of the project you first have to bootstrap it. In order
to do this you can do the following:
1. python bootstrap # generate the buildbot
2. bin/buildbot # run the builbot it self.
3. bin/test # execute the test runner.
For more information about the options that the script provides do execute
> python bin/test --help
If this is the first time you are using a buildbot you can get the bootstrap script
the following way:
> svn cat svn://svn.zope.org/repos/main/zc.buildout/trunk/bootstrap/bootstrap.py > /tmp/bootstrap
And from that point you can use the following as step 1:
> python /tmp/bootstrap
-------
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.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
|