Platform-independent Qt API for storing passwords securely.
Go to file
Elvis Angelaccio c9f5bb0cba Add doxygen docs to ReadPasswordJob class 2016-08-17 15:26:34 +02:00
cmake/Modules Install library and headers 2012-05-02 02:35:03 +02:00
translations Updated translation files 2014-08-17 18:49:22 +03:00
.gitignore Enabled static builds on Windows. 2016-04-06 10:32:55 +02:00
CMakeLists.txt Extract PlainTextStore 2016-08-12 10:34:05 +02:00
COPYING Initial OS X impl. 2011-10-28 09:17:18 +02:00
ChangeLog Update ChangeLog 2016-05-23 11:30:23 +02:00
QtKeychainBuildTreeSettings.cmake.in Add CMake config file 2012-07-29 11:25:06 -04:00
QtKeychainConfig.cmake.in Fix osx usage 2016-08-05 11:38:59 +02:00
QtKeychainConfigVersion.cmake.in Add CMake config file 2012-07-29 11:25:06 -04:00
ReadMe.markdown Add readme 2012-05-08 18:14:23 +02:00
ReadMe.txt Update changelog and ReadMe 2016-03-17 11:02:15 +01:00
appveyor.yml Add appveyor ci support 2016-08-05 11:49:49 +02:00
appveyorHelp.psm1 Add appveyor ci support 2016-08-05 11:49:49 +02:00
gnomekeyring.cpp Build fixes for disabled implicit string casts 2016-08-12 10:08:12 +02:00
gnomekeyring_p.h Add missing Q_OBJECT macro 2016-08-12 10:08:12 +02:00
keychain.cpp Refactored code to simplify classes. 2015-12-04 11:41:06 +01:00
keychain.h Add doxygen docs to ReadPasswordJob class 2016-08-17 15:26:34 +02:00
keychain_mac.cpp Whitespace fix 2016-07-28 11:37:07 +02:00
keychain_p.h Extract PlainTextStore 2016-08-12 10:34:05 +02:00
keychain_unix.cpp Extract PlainTextStore 2016-08-12 10:34:05 +02:00
keychain_win.cpp Extract PlainTextStore 2016-08-12 10:34:05 +02:00
org.kde.KWallet.xml Start DBus-based KWAllet backend 2012-05-07 18:21:22 +02:00
plaintextstore.cpp Extract PlainTextStore 2016-08-12 10:34:05 +02:00
plaintextstore_p.h Extract PlainTextStore 2016-08-12 10:34:05 +02:00
testclient.cpp Added binary / text mode password support. 2016-01-12 13:17:46 +01:00

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, GNOME Keyring is used, otherwise qtkeychain tries to use KWallet (via D-Bus), if available.

 * **Windows:** By default, the Windows Credential Store is used (requires Windows 7 or newer).
Pass -DUSE_CREDENTIAL_STORE=OFF to cmake use disable it. If disabled, 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.