qtkeychain/ReadMe.txt

QtKeychain
==========

QtKeychain is a Qt API to store passwords and other secret data securely. How the data is stored depends on the platform:

 * **Mac OS X:** Passwords are stored in the OS X Keychain.

 * **Linux/Unix:** If running, KWallet (via D-Bus) is used.
Support for the GNOME Keyring via freedesktop.org's
[Secret Storage D-Bus specification](http://freedesktop.org/wiki/Specifications/secret-storage-spec "Secret Storage specification") is planned but not yet implemented.

 * **Windows:** Windows does not provide a service for secure storage. QtKeychain uses the Windows API function [CryptProtectData](http://msdn.microsoft.com/en-us/library/windows/desktop/aa380261%28v=vs.85%29.aspx "CryptProtectData function") to encrypt the password with the user's logon credentials. The encrypted data is then persisted via QSettings.

In unsupported environments QtKeychain will report an error. It will not store any data unencrypted unless explicitly requested (setInsecureFallback( true )).

**License:** QtKeychain is available under the [Modified BSD License](http://www.gnu.org/licenses/license-list.html#ModifiedBSD). See the file COPYING for details.
Add readme 2012-05-08 16:14:23 +00:00			`QtKeychain`
			`==========`

Rewrite README some more. 2012-05-09 17:47:50 +00:00			`QtKeychain is a Qt API to store passwords and other secret data securely. How the data is stored depends on the platform:`
Add readme 2012-05-08 16:14:23 +00:00
Restructure README, add license information. 2012-05-09 17:38:59 +00:00			`* Mac OS X: Passwords are stored in the OS X Keychain.`
Add readme 2012-05-08 16:14:23 +00:00
Restructure README, add license information. 2012-05-09 17:38:59 +00:00			`* Linux/Unix: If running, KWallet (via D-Bus) is used.`
			`Support for the GNOME Keyring via freedesktop.org's`
Add readme 2012-05-08 16:14:23 +00:00			`[Secret Storage D-Bus specification](http://freedesktop.org/wiki/Specifications/secret-storage-spec "Secret Storage specification") is planned but not yet implemented.`

Restructure README, add license information. 2012-05-09 17:38:59 +00:00			`* Windows: Windows does not provide a service for secure storage. QtKeychain uses the Windows API function [CryptProtectData](http://msdn.microsoft.com/en-us/library/windows/desktop/aa380261%28v=vs.85%29.aspx "CryptProtectData function") to encrypt the password with the user's logon credentials. The encrypted data is then persisted via QSettings.`
Add readme 2012-05-08 16:14:23 +00:00
Mention the insecure fallback option 2012-12-27 12:37:58 +00:00			`In unsupported environments QtKeychain will report an error. It will not store any data unencrypted unless explicitly requested (setInsecureFallback( true )).`
Rewrite README some more. 2012-05-09 17:47:50 +00:00
Restructure README, add license information. 2012-05-09 17:38:59 +00:00			`License: QtKeychain is available under the [Modified BSD License](http://www.gnu.org/licenses/license-list.html#ModifiedBSD). See the file COPYING for details.`