Use correct arguments to the .TH command. |
||
---|---|---|
lib | ||
m4 | ||
man | ||
po | ||
src | ||
.gitignore | ||
AUTHORS | ||
COPYING | ||
Makefile.am | ||
NEWS | ||
README.md | ||
configure.ac |
README.md
Scorepw - A password strength meter
Scorepw is a command line tool to check the quality of a password.
This project has been inspired by the pwscore tool from the libpwquality project.
The main difference from pwscore is that scorepw is not limited to a single password strength estimation engine. It currently supports three different engines (zxcvbn, zxcvbn-cpp, and the library behind pwscore, libpwquality) and will use of all of them (if they are available on the system where scorepw is installed) to produce several estimations of the strength of a given password.
When used with the zxcvbn or zxcvbncpp libraries, scorepw can also print more details about the checked password than just a score, such as the password’s entropy and estimated crack times.
Install
Scorepw has no dependency beyong the following password strength estimation libraries, which should be automatically detected by the configure script:
- zxcvbn-c, a C implementation of the CoffeeScript zxcvbn;
- zxcvbn-cpp, a C++ implementation of the same library;
- libpwquality.
At least one of those libraries must be present.
Custom dictionaries
Both the zxcvbn-c and the zxcvbn-cpp engines allow to use a custom dictionary of passwords (in addition to the one already built in those libraries).
A custom dictionary may be embedded in the program at build
time with the configure option --with-dict=foo
, where foo
is the path to the dictionary to embed. The file should be a
simple text file containing one word per line.
In addition, a custom dictionary may also be read from file at
run-time, using the -d foo
or --dict foo
option. Again, the
foo file is expected to be a text file containing one word
per line.
Copying
Scorepw is distributed under the terms of the GNU General Public License, version 3 or higher. The full license is included in the COPYING file of the source distribution.
Homepage and repository
The project is located at https://incenp.org/dvlpt/scorepw.html. The latest source code is available in a Git repository at https://git.incenp.org/damien/scorepw.