Annotation of src/usr.bin/encrypt/encrypt.1, Revision 1.23
1.23 ! tedu 1: .\" $OpenBSD: encrypt.1,v 1.22 2007/05/31 19:20:09 jmc Exp $
1.1 downsj 2: .\"
3: .\" Copyright (c) 1996, Jason Downs. All rights reserved.
4: .\"
5: .\" Redistribution and use in source and binary forms, with or without
6: .\" modification, are permitted provided that the following conditions
7: .\" are met:
8: .\" 1. Redistributions of source code must retain the above copyright
9: .\" notice, this list of conditions and the following disclaimer.
10: .\" 2. Redistributions in binary form must reproduce the above copyright
11: .\" notice, this list of conditions and the following disclaimer in the
12: .\" documentation and/or other materials provided with the distribution.
13: .\"
14: .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY EXPRESS
15: .\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
16: .\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
17: .\" DISCLAIMED. IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT,
18: .\" INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
19: .\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
20: .\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
21: .\" CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22: .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23: .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24: .\" SUCH DAMAGE.
25: .\"
1.23 ! tedu 26: .Dd $Mdocdate: May 31 2007 $
1.1 downsj 27: .Dt ENCRYPT 1
1.11 aaron 28: .Os
1.1 downsj 29: .Sh NAME
30: .Nm encrypt
1.4 downsj 31: .Nd encrypt passwords from the command line or standard input
1.1 downsj 32: .Sh SYNOPSIS
33: .Nm encrypt
1.19 jmc 34: .Op Fl km
1.5 provos 35: .Op Fl b Ar rounds
1.18 millert 36: .Op Fl c Ar class
1.19 jmc 37: .Op Fl p | Ar string
1.1 downsj 38: .Op Fl s Ar salt
1.4 downsj 39: .Nm makekey
1.1 downsj 40: .Sh DESCRIPTION
1.12 aaron 41: .Nm
1.1 downsj 42: prints the encrypted form of
43: .Ar string
1.15 aaron 44: to the standard output.
45: This is mostly useful for encrypting passwords from within scripts.
1.1 downsj 46: .Pp
1.20 jmc 47: When invoked as
48: .Nm makekey ,
49: a single combined key and salt are read from standard
50: input and the DES encrypted result is written to standard output without a
51: terminating newline.
52: .Pp
1.13 aaron 53: The options are as follows:
1.16 aaron 54: .Bl -tag -width Ds
1.5 provos 55: .It Fl b Ar rounds
1.23 ! tedu 56: Encrypt the string using Blowfish hashing with the specified number of
1.5 provos 57: .Ar rounds .
1.23 ! tedu 58: May also specify 'a' to request a variable number of rounds scaled to the
! 59: machine's CPU capabilities.
1.18 millert 60: .It Fl c Ar class
61: Use the cipher type specified in the given user login class.
62: See
63: .Xr login.conf 5
64: for more information.
1.21 jmc 65: .It Fl k
66: Run in
67: .Nm makekey
68: compatible mode.
1.1 downsj 69: .It Fl m
70: Encrypt the string using MD5.
1.10 alex 71: .It Fl p
72: Prompt for a single string with echo turned off.
1.1 downsj 73: .It Fl s Ar salt
74: Encrypt the string using DES, with the specified
75: .Ar salt .
76: .El
77: .Pp
78: If no
79: .Ar string
80: is specified,
1.12 aaron 81: .Nm
1.7 deraadt 82: reads one string per line from standard input, encrypting each one
1.14 aaron 83: with the chosen algorithm from above.
1.18 millert 84: In the case where no specific algorithm or specific user login class was given
85: as a command line option, the algorithm specified in the default class in
1.17 millert 86: .Pa /etc/login.conf
87: will be used.
1.5 provos 88: .Pp
1.18 millert 89: For MD5 and Blowfish, a new random salt is automatically generated for each
1.5 provos 90: password.
91: .Pp
1.11 aaron 92: Specifying the
1.3 downsj 93: .Ar string
94: on the command line should be discouraged; using the
95: standard input is more secure.
1.5 provos 96: .Sh FILES
1.17 millert 97: .Bl -tag -width /etc/login.conf -compact
98: .It Pa /etc/login.conf
1.5 provos 99: .El
1.1 downsj 100: .Sh SEE ALSO
1.5 provos 101: .Xr crypt 3 ,
1.17 millert 102: .Xr login.conf 5
1.1 downsj 103: .Sh HISTORY
1.12 aaron 104: .Nm
1.6 millert 105: first appeared in
106: .Ox 1.2 .
1.4 downsj 107: .Pp
108: A
109: .Nm makekey
1.11 aaron 110: command appeared in
1.4 downsj 111: .At v7 .