2017-12-12 03:15:23 -05:00
# <img src="https://keepassxc.org/logo.png" width="40" height="40"/> KeePassXC
2017-12-26 07:46:33 -05:00
[![TeamCity Build Status ](https://ci.keepassxc.org/app/rest/builds/buildType:\(id:KeepassXC_TeamCityCi\ )/statusIcon?guest=1)](https://ci.keepassxc.org/viewType.html?buildTypeId=KeepassXC_TeamCityCi& guest=1) [![Coverage Status ](https://coveralls.io/repos/github/keepassxreboot/keepassxc/badge.svg )](https://coveralls.io/github/keepassxreboot/keepassxc)
2017-11-26 16:36:46 -05:00
## About KeePassXC
[KeePassXC ](https://keepassxc.org ) is a cross-platform community fork of
2017-12-12 03:15:23 -05:00
[KeePassX ](https://www.keepassx.org/ ).
Our goal is to extend and improve it with new features and bugfixes
to provide a feature-rich, fully cross-platform and modern
2017-11-26 16:36:46 -05:00
open-source password manager.
## Installation
2017-12-12 03:15:23 -05:00
The [KeePassXC QuickStart ](./docs/QUICKSTART.md ) gets you started using
KeePassXC on your Windows, Mac, or Linux computer using pre-compiled binaries
from the [downloads page ](https://keepassxc.org/download ).
Additionally, individual Linux distributions may ship their own versions,
2017-11-26 16:36:46 -05:00
so please check out your distribution's package list to see if KeePassXC is available.
2014-03-23 15:25:15 -04:00
2017-01-24 18:03:00 -05:00
## Additional features compared to KeePassX
2017-06-28 21:51:40 -04:00
- Auto-Type on all three major platforms (Linux, Windows, macOS)
- Twofish encryption
- YubiKey challenge-response support
- TOTP generation
- CSV import
- Command line interface
- DEP and ASLR hardening
- Stand-alone password and passphrase generator
2017-01-24 18:03:00 -05:00
- Password strength meter
2017-02-28 08:30:12 -05:00
- Using website favicons as entry icons
2017-01-24 18:03:00 -05:00
- Merging of databases
- Automatic reload when the database changed on disk
2017-12-12 03:15:23 -05:00
- Browser integration with KeePassHTTP-Connector for
[Mozilla Firefox ](https://addons.mozilla.org/en-US/firefox/addon/keepasshttp-connector/ ) and
[Google Chrome or Chromium ](https://chrome.google.com/webstore/detail/keepasshttp-connector/dafgdjggglmmknipkhngniifhplpcldb ), and
[passafari ](https://github.com/mmichaa/passafari.safariextension/ ) in Safari. [[See note about KeePassHTTP]](#Note_about_KeePassHTTP)
2018-01-17 07:55:13 -05:00
- Browser integration with KeePassXC-Browser using [native messaging ](https://developer.chrome.com/extensions/nativeMessaging ) for [Mozilla Firefox ](https://addons.mozilla.org/en-US/firefox/addon/keepassxc-browser/ ) and [Google Chrome or Chromium ](https://chrome.google.com/webstore/detail/keepassxc-browser/iopaggbpplllidnfmcghoonnokmjoicf )
2017-02-28 08:30:12 -05:00
- Many bug fixes
2016-10-17 22:16:37 -04:00
2017-01-24 18:03:00 -05:00
For a full list of features and changes, read the [CHANGELOG ](CHANGELOG ) document.
2016-10-05 23:03:13 -04:00
2017-11-26 16:36:46 -05:00
## Building KeePassXC
2014-04-18 13:44:47 -04:00
2017-12-12 03:15:23 -05:00
Detailed instructions are available in the [Build and Install ](./INSTALL.md )
2017-11-26 16:36:46 -05:00
page or on the [Wiki page ](https://github.com/keepassxreboot/keepassxc/wiki/Building-KeePassXC ).
2014-04-18 13:44:47 -04:00
2017-11-26 16:36:46 -05:00
## Contributing
2014-04-18 13:44:47 -04:00
2017-12-12 03:15:23 -05:00
We are always looking for suggestions how to improve our application.
If you find any bugs or have an idea for a new feature, please let us know by
opening a report in our [issue tracker ](https://github.com/keepassxreboot/keepassxc/issues )
2017-11-26 16:36:46 -05:00
on GitHub or join us on IRC on freenode channels #keepassxc or #keepassxc -dev.
2017-01-24 18:03:00 -05:00
You can of course also directly contribute your own code. We are happy to accept your pull requests.
2014-11-30 17:34:16 -05:00
2017-04-05 05:30:39 -04:00
Please read the [CONTRIBUTING document ](.github/CONTRIBUTING.md ) for further information.
2017-11-26 16:36:46 -05:00
### Note about KeePassHTTP
The KeePassHTTP protocol is not a highly secure protocol.
It has a certain flaw which could allow an attacker to decrypt your passwords
should they manage to impersonate the web browser extension from a remote address.
2017-12-12 03:15:23 -05:00
<!-- intercept communication between a KeePassHTTP server
2017-11-26 16:36:46 -05:00
and PassIFox/chromeIPass over a network connection -->
2017-12-12 03:15:23 -05:00
(See [here ](https://github.com/pfn/keepasshttp/issues/258 ) and [here ](https://github.com/keepassxreboot/keepassxc/issues/147 )).
2017-11-26 16:36:46 -05:00
2017-12-12 03:15:23 -05:00
To minimize the risk, KeePassXC strictly limits communication between itself
and the browser plugin to your local computer (localhost).
This makes your passwords quite safe,
2017-11-26 16:36:46 -05:00
but as with all open source software, use it at your own risk!