QtPass  1.2.0
Multi-platform GUI for pass, the standard unix password manager.
README.md
Go to the documentation of this file.
1 QtPass
2 ======
3 
4 [![Build Status](https://travis-ci.org/IJHack/QtPass.svg?branch=master)](https://travis-ci.org/IJHack/QtPass)
5 [![Build status](https://ci.appveyor.com/api/projects/status/9rjnj72rdir7u9eg/branch/master?svg=true)](https://ci.appveyor.com/project/annejan/qtpass/branch/master)
6 [![Coverity scan](https://scan.coverity.com/projects/5266/badge.svg)](https://scan.coverity.com/projects/ijhack-qtpass)
7 [![Coverage Status](https://coveralls.io/repos/github/IJHack/QtPass/badge.svg)](https://coveralls.io/github/IJHack/QtPass)
8 [![codecov](https://codecov.io/gh/IJhack/QtPass/branch/master/graph/badge.svg)](https://codecov.io/gh/IJhack/QtPass)
9 
10 QtPass is a GUI for [pass](https://www.passwordstore.org/),
11 the standard unix password manager.
12 
13 Features
14 --------
15 
16 * Using `pass` or `git` and `gpg2` directly
17 * Configurable shoulder surfing protection options
18 * Cross platform: Linux, BSD, OS X and Windows
19 * Per-folder user selection for multi recipient encryption
20 * Multiple profiles
21 * Easy onboarding
22 
23 Logo based on [Heart-padlock by AnonMoos](https://commons.wikimedia.org/wiki/File:Heart-padlock.svg).
24 
25 Installation
26 ------------
27 
28 ### From package
29 
30 OpenSUSE & Fedora
31 `yum install qtpass`
32 `dnf install qtpass`
33 
34 Debian, Ubuntu and derivates like Mint, Kali & Raspbian
35 `apt-get install qtpass`
36 
37 Arch Linux
38 `pacman -S qtpass`
39 
40 Gentoo
41 `emerge -atv qtpass`
42 
43 Sabayon
44 `equo install qtpass`
45 
46 FreeBSD
47 `pkg install qtpass`
48 
49 macOS
50 `brew cask install qtpass`
51 
52 Windows
53 `choco install qtpass`
54 
55 ### From Source
56 
57 **Dependencies**
58 
59 * QtPass requires Qt 5.
60 * The Linguist package is required to compile the translations.
61 * For use of the fallback icons the SVG library is required.
62 
63 At runtime the only real dependency is `gpg2` but to make the most of it, you'll need `git` and `pass` too.
64 
65 Your GPG has to be set-up with a graphical pinentry when applicable, same goes for git authentication.
66 On Mac OS X this currently seems to only work with MacGPG2 from gpgtools.
67 
68 On most unix systems all you need is:
69 ```
70 qmake && make && make install
71 ```
72 
73 Testing
74 -------
75 
76 This is done with `make check`
77 
78 Codecoverage can be done with `make lcov`, `make gcov`, `make coveralls` and/or `make codecov`.
79 
80 Be sure to first run: `make distclean && qmake CONFIG+=coverage qtpass.pro`
81 
82 Security considerations
83 -----------------------
84 
85 Using this program will not magically keep your passwords secure against
86 compromised computers even if you use it in combination with a smartcard.
87 
88 It does protect future and changed passwords though against anyone with access to
89 your password store only but not your keys.
90 Used with a smartcard it also protects against anyone just monitoring/copying
91 all files/keystrokes on that machine and such an attacker would only gain access
92 to the passwords you actually use.
93 Once you plug in your smartcard and enter your PIN (or due to CVE-2015-3298
94 even without your PIN) all your passwords available to the machine can be
95 decrypted by it, if there is malicious software targeted specifically against
96 it installed (or at least one that knows how to use a smartcard).
97 
98 To get better protection out of use with a smartcard even against a targeted
99 attack I can think of at least two options:
100 
101 * The smartcard must require explicit confirmation for each decryption operation.
102  Or if it just provides a counter for decrypted data you could at least notice
103  an attack afterwards, though at quite some effort on your part.
104 * Use a different smartcard for each (group of) key.
105 * If using a YubiKey or U2F module or similar that requires a "button" press for
106  other authentication methods you can use one OTP/U2F enabled WebDAV account per
107  password (or groups of passwords) as a quite inconvenient workaround.
108  Unfortunately I do not know of any WebDAV service with OTP support except ownCloud
109  (so you would have to run your own server).
110 
111 Known issues
112 ------------
113 
114 * Filtering (searching) breaks the tree/model sometimes
115 * Starting without a correctly set password-store folder
116  gives weird results in the tree view
117 * On Mac OS X only the gpgtools MacGPG2 version works with passphrase or PIN
118 
119 Planned features
120 ----------------
121 
122 * Plugins based on field name, plugins follow same format as password files
123 * Colour coding folders (possibly disabling folders you can't decrypt)
124 * Optional table view of decrypted folder contents
125 * Opening of (basic auth) urls in default browser?
126  Possibly with helper plugin for filling out forms?
127 * WebDAV (configuration) support
128 * Some other form of remote storage that allows for
129  accountability / auditing (web API to retrieve the .gpg files?)
130 
131 Further reading
132 ---------------
133 
134 [FAQ](FAQ.md) and [CONTRIBUTING](CONTRIBUTING.md) documentation.
135 [CHANGELOG](CHANGELOG.md)
136 
137 [Website](https://qtpass.org/)
138 [Source code](https://github.com/IJHack/qtpass)
139 [Issue queue](https://github.com/IJHack/qtpass/issues)
140 [Chat](https://gitter.im/IJHack/qtpass)