8.2.x/tools/README.mkpasswd

$Id$

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

This version of mkpasswd can create both DES and MD5 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

Without the presence of any parameters, it'll behave like the old mkpasswd,
creating a DES 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 systems crypt()
  implementation, typically 8.

Supported Platforms (Known and tested):
Linux glibc (SHA 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:	1274
Committed:	Mon Jan 30 23:41:59 2012 UTC (14 years, 5 months ago) by michael
Original Path:	*ircd-hybrid-8/tools/README.mkpasswd*
File size:	1787 byte(s)
Log Message:	- minor documentation updates and fixes
#	Content
1	$Id$
2
3	This is documentation for the mkpasswd.c included in ircd-hybrid-8.
4
5	This version of mkpasswd can create both DES and MD5 passwords, with
6	either randomly generated or user provided salts.
7
8	Options:
9	-6 - Create a SHA-512 password
10	-5 - Create a SHA-256 password
11	-m - Create an MD5 password
12	-b - Create a BlowFish password
13	-d - Create a DES password
14	-e - Create an Extended DES password
15	-l - Specify the length of a random MD5 salt
16	-r - Specify a number of rounds for a BlowFish or Extended DES password
17	-p - Specify the plaintext password at the command line
18	-s - Specify the salt at the command line
19	-R - Specify a raw salt passed directly to crypt()
20	-h - Get help
21
22	Without the presence of any parameters, it'll behave like the old mkpasswd,
23	creating a DES password with a randomly generated salt and prompting for
24	the password (without echo).
25
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	The maximum length of an MD5 salt is limited to your systems crypt()
38	implementation, typically 8.
39
40	Supported Platforms (Known and tested):
41	Linux glibc (SHA since glibc 2.7, DES and MD5)
42	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.