]> jfr.im git - solanum.git/blame - tools/README.mkpasswd
configure: add same msys check here
[solanum.git] / tools / README.mkpasswd
CommitLineData
212380e3 1mkpasswd.c documentation
212380e3
AC
2
3This is documentation for the updated mkpasswd.c included with a number
4of ircd, irc services, and non-IRC related programs
5
69b2e745 6This version of mkpasswd can create DES, Extended DES, Blowfish, and MD5
212380e3
AC
7passwords, with either randomly generated or user provided salts.
8
9Options:
10-m Generate an MD5 password
11-d Generate a DES password
69b2e745 12-b Generate a Blowfish password
212380e3 13-e Generate an Extended (BSDi) DES password
69b2e745
LS
14-l Specify a length for a random MD5 or Blowfish salt
15-r Specify a number of rounds for a Blowfish or Extended DES password
16 Blowfish: no more than 6 recommended, no less than 4 accepted
212380e3
AC
17 Extended DES: default of 25
18-s Specify a salt, 2 alphanumeric characters for DES, up to 16 for MD5,
69b2e745 19 up to 22 for Blowfish, 2 for Extended DES
212380e3
AC
20-p Specify a plaintext password to use
21-? Get brief help
22-h Get extended help
23
24Without the presence of any parameters, it'll behave like the old mkpasswd,
25creating a DES password with a randomly generated salt and prompting for
26the password (without echo).
27
28A DES salt is a pair of alphanumeric characters ('.' and '/' are permitted
29as well), such as 'a4' or 'Td'.
30
31An MD5 salt consists of up to 16 (though most implementations limit you to
328) alphanumeric characters (plus '.' and '/'),
33such as 'tGd' or 'J6d4dfG'.
34
69b2e745
LS
35A Blowfish salt consists of up to 22 alphanumeric characters (plus '.' and
36'/'). Blowfish also specifies a number of rounds*, by default 4.
212380e3
AC
37
38Known bugs:
39The encryption algorithms supported depend on your system's crypt()
40 implementation.
41The maximum length of an MD5 salt is limited to your systems crypt()
42 implementation, typically 8.
43
44Supported Platforms (Known and tested):
45Linux glibc (DES and MD5)
46FreeBSD 3.x (DES (MD5 maybe))
69b2e745 47FreeBSD 4.x (DES, MD5, Blowfish, Extended DES)
212380e3
AC
48Solaris 2.5-2.6 (DES only)
49Cygwin 1.1.4 (DES only)
50Prior Cygwin with the MD5 libcrypt (MD5 only)
51OpenBSD 2.7 (don't link with -lcrypt) (DES, MD5, Blowfish)
52Mac OS-X (Darwin) (don't link with -lcrypt) (DES only)
53
54An MMK build script is included, as well as an MD5 crypt() implementation
55
56Other systems probably work, but they haven't been amply tested.
57
69b2e745 58* Blowfish's rounds parameter is a logarithm, not an integer value