vdirsyncer/docs/keyring.rst
Markus Unterwaditzer 306cee4946 Fix #65
2014-05-25 17:54:09 +02:00

55 lines
2 KiB
ReStructuredText

===============
Keyring Support
===============
*vdirsyncer* will try the following storages if no password (but a username) is
set in your config. If that fails too, it will prompt for the password and
store the password in the system keyring (if possible and wished).
netrc
=====
*vdirsyncer* can use ``~/.netrc`` for retrieving a password. An example
``.netrc`` looks like this::
machine owncloud.example.com
login foouser
password foopass
System Keyring
==============
*vdirsyncer* can also use your system's password storage for saving password in
a (more) secure way.
To use it, you must install keyring_.
.. _keyring: https://bitbucket.org/kang/python-keyring-lib
*vdirsyncer* will use the full resource URL as the key when saving.
When retrieving the key, it will try to remove segments of the URL's path until
it finds a password. For example, if you save a password under the key
``vdirsyncer:http://example.com``, it will be used as a fallback for all
resources on ``example.com``. If you additionally save a password under the key
``vdirsyncer:http://example.com/special/``, that password will be used for all
resources on ``example.com`` whose path starts with ``/special/``.
*keyring* support these keyrings:
- **OSXKeychain:** The Keychain service in Mac OS X.
- **KDEKWallet:** The KDE's Kwallet service.
- **GnomeKeyring** For Gnome 2 environment.
- **SecretServiceKeyring:** For newer GNOME and KDE environments.
- **WinVaultKeyring:** The Windows Credential Vault
- **Win32CryptoKeyring:** for Windows 2k+.
- **CryptedFileKeyring:** A command line interface keyring base on PyCrypto.
- **UncryptedFileKeyring:** A keyring which leaves passwords directly in file.
Changing the Password
---------------------
If your password on the server changed or you misspelled it you need to use
your system's password manager (e.g. seahorse for most Linux distrubutions) to
either delete or directly change it, *vdirsyncer* currently has no means to do
it for you.