https://github.com/hanez/checkpw
checkpw is a program that checks the validity of a users password on a UNIX/PAM-based system. (mirror from: https://git.xw3.org/xw3/checkpw)
https://github.com/hanez/checkpw
authentication cgi checkpassword checkpw linux pam passwd shadow shell unix
Last synced: about 1 year ago
JSON representation
checkpw is a program that checks the validity of a users password on a UNIX/PAM-based system. (mirror from: https://git.xw3.org/xw3/checkpw)
- Host: GitHub
- URL: https://github.com/hanez/checkpw
- Owner: hanez
- License: other
- Created: 2024-08-27T23:19:42.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-09T23:51:47.000Z (over 1 year ago)
- Last Synced: 2025-03-10T00:25:29.349Z (over 1 year ago)
- Topics: authentication, cgi, checkpassword, checkpw, linux, pam, passwd, shadow, shell, unix
- Language: C
- Homepage: https://git.xw3.org/xw3/checkpw
- Size: 55.7 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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.
## 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 ] [-p ] [-v] [-V] [-h]
Options:
-u Set username.
-p 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
- [Homepage of checkpw](https://git.xw3.org/xw3/checkpw)
- [https://cr.yp.to/checkpwd.html](https://cr.yp.to/checkpwd.html)
- [https://pamtester.sourceforge.net/](https://pamtester.sourceforge.net/)