8.2.x/tools/README.mkpasswd

$Id$

This is documentation for the mkpasswd.c included in ircd-hybrid.

This version of mkpasswd can create DES, Extended DES, BlowFish, MD5,
SHA-256 and SHA-512 passwords, with either randomly generated or user
provided salts.

Options:
-6 - Create a SHA-512 password
-5 - Create a SHA-256 password
-m - Create an MD5 password
-b - Create a BlowFish password
-d - Create a DES password
-e - Create an Extended DES password
-l - Specify the length of a random MD5 salt
-r - Specify a number of rounds for a BlowFish or Extended DES password
-p - Specify the plaintext password at the command line
-s - Specify the salt at the command line
-R - Specify a raw salt passed directly to crypt()
-h - Get help

If no parameter is given, it will create an MD5 password with a randomly
generated salt and prompting for the password (without echo).

A DES salt is a pair of alphanumeric characters ('.' and '/' are permitted
as well), such as 'a4' or 'Td'.

An MD5 salt consists of up to 16 (though most implementations limit you to
8) alphanumeric characters (plus '.' and '/'),
such as 'tGd' or 'J6d4dfG'.

Known bugs:
Blowfish (on OpenBSD) is not yet supported
The encryption algorithms supported depend on your system's crypt()
  implementation.
The maximum length of an MD5 salt is limited to your system's crypt()
  implementation, typically 8.

Supported Platforms (Known and tested):
Linux glibc (SHA-256/SHA-512 since glibc 2.7, DES and MD5)
FreeBSD 3.x (DES (MD5 maybe))
FreeBSD 4.x (DES and MD5)
Solaris 2.5-2.6 (DES only)
Cygwin 1.1.4 (DES only)
Prior Cygwin with the MD5 libcrypt (MD5 only)
OpenBSD 2.7 (don't link with -lcrypt) (DES and MD5, no Blowfish support)
Mac OS-X (Darwin) (don't link with -lcrypt) (DES only)

Other systems probably work, but they haven't been amply tested.
Revision:	3377
Committed:	Thu Apr 24 16:15:51 2014 UTC (12 years, 2 months ago) by michael
File size:	1790 byte(s)
Log Message:	- Create 8.2.x branch
#	User	Rev	Content
1	knight	31	$Id$
2	adx	30
3	michael	3071	This is documentation for the mkpasswd.c included in ircd-hybrid.
4	adx	30
5	michael	3071	This version of mkpasswd can create DES, Extended DES, BlowFish, MD5,
6			SHA-256 and SHA-512 passwords, with either randomly generated or user
7			provided salts.
8	adx	30
9			Options:
10	michael	1272	-6 - Create a SHA-512 password
11			-5 - Create a SHA-256 password
12	adx	30	-m - Create an MD5 password
13	michael	1272	-b - Create a BlowFish password
14	adx	30	-d - Create a DES password
15	michael	1272	-e - Create an Extended DES password
16	adx	30	-l - Specify the length of a random MD5 salt
17	michael	1272	-r - Specify a number of rounds for a BlowFish or Extended DES password
18	adx	30	-p - Specify the plaintext password at the command line
19			-s - Specify the salt at the command line
20	michael	1272	-R - Specify a raw salt passed directly to crypt()
21	adx	30	-h - Get help
22
23	michael	3130	If no parameter is given, it will create an MD5 password with a randomly
24			generated salt and prompting for the password (without echo).
25	adx	30
26			A DES salt is a pair of alphanumeric characters ('.' and '/' are permitted
27			as well), such as 'a4' or 'Td'.
28
29			An MD5 salt consists of up to 16 (though most implementations limit you to
30			8) alphanumeric characters (plus '.' and '/'),
31			such as 'tGd' or 'J6d4dfG'.
32
33			Known bugs:
34			Blowfish (on OpenBSD) is not yet supported
35			The encryption algorithms supported depend on your system's crypt()
36			implementation.
37	michael	3130	The maximum length of an MD5 salt is limited to your system's crypt()
38	adx	30	implementation, typically 8.
39
40			Supported Platforms (Known and tested):
41	michael	3071	Linux glibc (SHA-256/SHA-512 since glibc 2.7, DES and MD5)
42	adx	30	FreeBSD 3.x (DES (MD5 maybe))
43			FreeBSD 4.x (DES and MD5)
44			Solaris 2.5-2.6 (DES only)
45			Cygwin 1.1.4 (DES only)
46			Prior Cygwin with the MD5 libcrypt (MD5 only)
47			OpenBSD 2.7 (don't link with -lcrypt) (DES and MD5, no Blowfish support)
48			Mac OS-X (Darwin) (don't link with -lcrypt) (DES only)
49
50			Other systems probably work, but they haven't been amply tested.