8.2.x/tools/README.mkpasswd

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