0
0
mirror of https://github.com/keepassxreboot/keepassxc.git synced 2024-09-20 12:22:16 +02:00
KeePassXC is a cross-platform community-driven port of the Windows application “Keepass Password Safe”.
Go to file
Janek Bevendorff a298d2976f Merge pull request #1097 from keepassxreboot/meta/contributing
Remove emoji in commit messages from style guide
2017-10-21 13:40:16 +02:00
.github Remove emoji in commit messages from style guide 2017-10-21 13:27:25 +02:00
.tx Moved transifex to new url 2016-11-11 16:30:57 -05:00
cmake Update and fix copyright headers 2017-06-14 15:54:43 +02:00
share Merge branch 'release/2.2.2' into develop 2017-10-19 21:45:49 +02:00
src Merge branch 'release/2.2.2' into develop 2017-10-20 23:08:04 +02:00
tests Implement recursive resolving for placeholders 2017-10-19 22:40:26 +03:00
utils add fix for mac qt build environment 2017-05-14 09:19:35 -04:00
.clang-format Updating .clang-format (#915) 2017-08-31 09:24:36 -04:00
.gitattributes Add github-linguist language hints. 2017-02-15 16:36:02 -05:00
.gitignore Merge branch 'release/2.2.2' into develop 2017-10-19 21:45:49 +02:00
.travis.yml Fixing travis build (#969) 2017-09-19 10:41:38 -04:00
AppImage-Recipe.sh Merge branch 'release/2.2.2' into develop 2017-10-19 21:45:49 +02:00
CHANGELOG Version number bump 2017-10-01 10:58:00 -04:00
CMakeLists.txt Merge branch 'release/2.2.2' into develop 2017-10-19 21:45:49 +02:00
COPYING New base32 implementation (#984) 2017-09-24 18:00:12 -04:00
Dockerfile Use the renamed QT ppa (with packages named the same) 2017-10-07 23:37:34 +01:00
INSTALL.md Typo fix 2017-09-05 10:39:20 +02:00
LICENSE.BOOST-1.0 Display git revision in about dialog. 2015-07-18 13:14:13 +02:00
LICENSE.BSD Add crypto classes and tests. Link to libgcrypt. 2010-09-11 19:49:30 +02:00
LICENSE.CC0 Fix database icons license issues. 2013-03-23 21:50:23 +01:00
LICENSE.GPL-2 Add "LICENSE" prefix to license filenames. 2010-08-15 12:33:42 +02:00
LICENSE.GPL-3 Add "LICENSE" prefix to license filenames. 2010-08-15 12:33:42 +02:00
LICENSE.LGPL-2.1 Fix typo in filename. 2013-03-24 14:16:34 +01:00
LICENSE.LGPL-3 Add LGPL-3 license text for the Oxygen icons. 2013-03-24 11:54:20 +01:00
LICENSE.NOKIA-LGPL-EXCEPTION Add support for gzip compressed databases. 2010-09-23 22:27:59 +02:00
README.md Merge branch 'release/2.2.2' into develop 2017-10-20 23:08:04 +02:00
release-tool Enhance lupdate-qt5 check 2017-10-19 21:24:31 +02:00
snapcraft.yaml Extend desktop file and name it according to the freedesktop specification 2017-10-19 21:24:31 +02:00

KeePassXC Travis Build Status Coverage Status

KeePass Cross-platform Community Edition

About

KeePassXC is a community fork of KeePassX with the goal to extend and improve it with new features and bugfixes to provide a feature-rich, fully cross-platform and modern open-source password manager.

Additional features compared to KeePassX

  • 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
  • Password strength meter
  • Using website favicons as entry icons
  • Merging of databases
  • Automatic reload when the database changed on disk
  • KeePassHTTP support for use with KeePassHTTP-Connector for Mozilla Firefox and Google Chrome or Chromium, and passafari in Safari.
  • Many bug fixes

For a full list of features and changes, read the CHANGELOG document.

Note about KeePassHTTP

KeePassHTTP is not a highly secure protocol and has certain flaw which allow an attacker to decrypt your passwords when they manage to intercept communication between a KeePassHTTP server and PassIFox/chromeIPass over a network connection (see here and here). KeePassXC therefore strictly limits communication between itself and the browser plugin to your local computer. As long as your computer is not compromised, your passwords are fairly safe that way, but use it at your own risk!

Installation

Pre-compiled binaries can be found on the downloads page. Additionally, individual Linux distributions may ship their own versions, so please check out your distribution's package list to see if KeePassXC is available.

Building KeePassXC

More detailed instructions are available in the INSTALL file or on the Wiki page.

First, you must download the KeePassXC source tarball or check out the latest version from our Git repository.

To clone the project from Git, cd to a suitable location and run

git clone https://github.com/keepassxreboot/keepassxc.git

This will clone the entire contents of the repository and check out the current develop branch.

To update the project from within the project's folder, you can run the following command:

git pull

Once you have downloaded the source code, you can cd into the source code directory, build and install KeePassXC:

mkdir build
cd build
cmake -DWITH_TESTS=OFF ..
make -j8
sudo make install

cmake accepts the following options:

  -DWITH_XC_AUTOTYPE=[ON|OFF] Enable/Disable Auto-Type (default: ON)
  -DWITH_XC_HTTP=[ON|OFF] Enable/Disable KeePassHTTP and custom icon downloads (default: OFF)
  -DWITH_XC_YUBIKEY=[ON|OFF] Enable/Disable YubiKey HMAC-SHA1 authentication support (default: OFF)

  -DWITH_TESTS=[ON|OFF] Enable/Disable building of unit tests (default: ON)
  -DWITH_GUI_TESTS=[ON|OFF] Enable/Disable building of GUI tests (default: OFF)
  -DWITH_DEV_BUILD=[ON|OFF] Enable/Disable deprecated method warnings (default: OFF)
  -DWITH_ASAN=[ON|OFF] Enable/Disable address sanitizer checks (Linux only) (default: OFF)
  -DWITH_COVERAGE=[ON|OFF] Enable/Disable coverage tests (GCC only) (default: OFF)

Contributing

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 on GitHub or join us on IRC on freenode channels #keepassxc or #keepassxc-dev.

You can of course also directly contribute your own code. We are happy to accept your pull requests.

Please read the CONTRIBUTING document for further information.