113 lines
2.7 KiB
Markdown
113 lines
2.7 KiB
Markdown
# checkpw
|
|
|
|
checkpw is a program that checks the validity of a users password on a UNIX/[PAM](https://en.wikipedia.org/wiki/Pluggable_Authentication_Module)-based system.
|
|
|
|
Currently checkpw is only tested on Linux, but it should work on a [AIX](https://en.wikipedia.org/wiki/IBM_AIX), [DragonFly BSD](https://www.dragonflybsd.org/), [FreeBSD](https://www.freebsd.org/), [HP-UX](https://en.wikipedia.org/wiki/HP-UX), [Linux](https://kernel.org/), [macOS](https://en.wikipedia.org/wiki/MacOS), [NetBSD](https://netbsd.org/) and [Solaris](https://en.wikipedia.org/wiki/Oracle_Solaris) operating system too.
|
|
|
|
## The idea
|
|
|
|
I needed a program to verify passwords of users on Linux/UNIX systems using PAM that just returns 0 on success and 1 on error.
|
|
|
|
## Requirements
|
|
|
|
You need the PAM development package installed. On Alpine it is named linux-pam-dev, on Debian based systems it is libpam0g-dev.
|
|
|
|
## Building checkpw
|
|
|
|
```
|
|
git clone https://git.xw3.org/xw3/checkpw.git
|
|
cd checkpw
|
|
make
|
|
```
|
|
|
|
The code only supports verifying passwords for user id 1000 by default. Look at the file checkpw.h for some compile time options!
|
|
|
|
### Custom build example
|
|
|
|
Set MAX_UID and MIN_UID at compile time:
|
|
|
|
```
|
|
gcc -Wall -DMAX_UID=1000 -DMIN_UID=1000 -o checkpw checkpw.c -lpam -lpam_misc
|
|
```
|
|
|
|
## Installation
|
|
|
|
**WARNING:** Install this software with care. checkpw could easily be used for bruteforcing passwords from local users!
|
|
|
|
```
|
|
sudo make install
|
|
```
|
|
|
|
checkpw is installed to /usr/bin/.
|
|
|
|
checkpw.h is installed to /usr/include/ for use in other applications.
|
|
|
|
## Uninstall
|
|
|
|
```
|
|
sudo make uninstall
|
|
```
|
|
|
|
## Usage
|
|
|
|
```
|
|
checkpw -h
|
|
Usage: checkpw [-u <username>] [-p <password>] [-v] [-V] [-h]
|
|
|
|
Options:
|
|
-u <username> Set username.
|
|
-p <password> Set password.
|
|
-v Enable verbose mode.
|
|
-V Print program version.
|
|
-h Show this help.
|
|
```
|
|
|
|
You can also use checkpw even without installing by just running the following command:
|
|
|
|
```
|
|
./checkpw
|
|
```
|
|
|
|
### Return codes
|
|
|
|
checkpw returns 0 on success, 1 otherwise.
|
|
|
|
### Examples
|
|
|
|
|
|
#### Interactive mode asking for a username and a password
|
|
|
|
```
|
|
checkpw
|
|
```
|
|
|
|
#### Interactive mode only asking for a password
|
|
|
|
```
|
|
checkpw -u hanez
|
|
```
|
|
|
|
#### None interactive mode with username and password provided as arguments to checkpw
|
|
|
|
```
|
|
checkpw -u hanez -p password
|
|
```
|
|
|
|
#### Request the result from the above commands
|
|
|
|
```
|
|
echo $?
|
|
```
|
|
|
|
## License
|
|
|
|
checkpw is licensed under the Apache License, Version 2.0.
|
|
|
|
See LICENSE for details.
|
|
|
|
## Links
|
|
|
|
- [https://git.xw3.org/hanez/checkpw](https://git.xw3.org/hanez/checkpw)
|
|
- [https://cr.yp.to/checkpwd.html](https://cr.yp.to/checkpwd.html)
|
|
- [https://pamtester.sourceforge.net/](https://pamtester.sourceforge.net/)
|
|
|