hanez/chkusr
1
1
Fork 0
Code Issues 3 Pull requests Projects Releases 7 Packages Wiki Activity

Renamed project from checkpw to chkpw. (1.2.0)

Browse source
This commit is contained in:
Johannes Findeisen 2025-06-01 19:23:47 +02:00
commit 22e4f0790a
7 changed files with 58 additions and 58 deletions
Download patch file Download diff file Expand all files Collapse all files

34
README.md
View file

@ -1,6 +1,6 @@
# checkpw
# chkpw
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.
chkpw 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.
@ -15,32 +15,32 @@ You need the PAM development package installed. On Alpine it is named linux-pam-
## Building checkpw
```
git clone https://git.xw3.org/hanez/checkpw.git
git clone https://git.xw3.org/hanez/chkpw.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!
The code only supports verifying passwords for user id 1000 by default. Look at the file chkpw.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
gcc -Wall -DMAX_UID=1000 -DMIN_UID=1000 -o chkpw chkpw.c -lpam -lpam_misc
```
## Installation
**WARNING:** Install this software with care. checkpw could easily be used for bruteforcing passwords from local users!
**WARNING:** Install this software with care. chkpw could easily be used for bruteforcing passwords from local users!
```
sudo make install
```
checkpw is installed to /usr/bin/.
chkpw is installed to /usr/bin/.
checkpw.h is installed to /usr/include/ for use in other applications.
chkpw.h is installed to /usr/include/ for use in other applications.
## Uninstall
@ -52,7 +52,7 @@ sudo make uninstall
```
checkpw -h
Usage: checkpw [-u <username>] [-p <password>] [-v] [-V] [-h]
Usage: chkpw [-u <username>] [-p <password>] [-v] [-V] [-h]
Options:
-u <username> Set username.
@ -62,15 +62,15 @@ Options:
-h Show this help.
```
You can also use checkpw even without installing by just running the following command:
You can also use chkpw even without installing by just running the following command:
```
./checkpw
./chkpw
```
### Return codes
checkpw returns 0 on success, 1 otherwise.
chkpw returns 0 on success, 1 otherwise.
### Examples
@ -78,19 +78,19 @@ checkpw returns 0 on success, 1 otherwise.
#### Interactive mode asking for a username and a password
```
checkpw
chkpw
```
#### Interactive mode only asking for a password
```
checkpw -u hanez
chkpw -u hanez
```
#### None interactive mode with username and password provided as arguments to checkpw
```
checkpw -u hanez -p password
chkpw -u hanez -p password
```
#### Request the result from the above commands
@ -101,13 +101,13 @@ echo $?
## License
checkpw is licensed under the Apache License, Version 2.0.
chkpw 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://git.xw3.org/hanez/chkpw](https://git.xw3.org/hanez/chkpw)
- [https://cr.yp.to/checkpwd.html](https://cr.yp.to/checkpwd.html)
- [https://pamtester.sourceforge.net/](https://pamtester.sourceforge.net/)