tidy up a load of lintian warnings
[freeradius.git] / man / man8 / radcrypt.8
1 .TH RADCRYPT 8
2 .SH NAME
3 radcrypt - generate password hash for use with radius, or validates a password hash
4 .SH SYNOPSIS
5 .B radcrypt
6 .RB [ \-d | --des ]
7 .RB [ \-m | --md5 ]
8 .RB [ \-c | --check ]
9 \fIplaintext_password\fP [\fIhashed_password\fP]
10 .SH DESCRIPTION
11 \fBradcrypt\fP generates a hashed digest of a plaintext password, or can
12 validate if a password hash matches a plaintext password. DES and MD5
13 hashes are currently supported. When generating a password hash a random
14 salt is generated and applied.
15 .PP
16 A hashed password can be validated by specifying \fI-c\fP or \fI--check\fP and
17 passing \fIhashed_password\fP after \fIplaintext_password\fP on the command line.
18 In this case \fIhashed_password\fP will be checked to see if it matches
19 \fIplaintext_password\fP. If so "Password OK" will be printed and the exit
20 status will be 1, otherwise "Password BAD" will be printed and exit status
21 will be 0 (Note this is the opposite of a normal successful shell status).
22
23 .SH OPTIONS
24
25 .IP "\-d --des"
26 Use a DES (Data Encryption Standard) hash (default).
27 Ignored if performing a password check.
28 .IP "\-m --md5"
29 Use a MD5 (Message Digest 5) hash.
30 Ignored if performing a password check.
31 .IP "\-c --check"
32 Perform a validation check on a password hash to verify if it matches
33 the plantext password.
34
35 .SH EXAMPLES
36 .nf
37 $ radcrypt foobar
38 HaX0xn7Qy650Q
39 $ radcrypt \-c foobar HaX0xn7Qy650Q
40 Password OK
41 .fi
42 .SH SEE ALSO
43 radiusd(8), crypt(3)
44 .SH AUTHORS
45 Miquel van Smoorenburg <miquels@cistron-office.nl>