freebsd-skq/usr.bin/enigma/enigma.1

.\"
.\" enigma (aka. crypt) man page written by Joerg Wunsch.
.\"
.\" Since enigma itself is distributed in the Public Domain, this file
.\" is also.
.\"
.\" $FreeBSD$
.\" "
.Dd October 30, 1998
.Os
.Dt ENIGMA 1
.Sh NAME
.Nm enigma ,
.Nm crypt
.Nd very simple file encryption
.Sh SYNOPSIS
.Nm
.Op Fl s
.Op Fl k
.Op Ar password
.Nm crypt
.Op Fl s
.Op Fl k
.Op Ar password
.Sh DESCRIPTION
.Nm Enigma ,
also known as
.Nm crypt
is a
.Em very
simple encryption program, working on a
.Dq secret-key
basis.  It operates as a filter, i. e. it encrypts or decrypts a
stream of data from standard input, and writes the result to standard
output.  It automatically detects whether the input data stream is
already encrypted, and switches into decryption mode in this case.
.Pp
There are several ways to provide the secret key to the program.  By
default, the program prompts the user on the controlling terminal for
the key, using
.Xr getpass 3 .
This is the only safe way of providing it.
.Pp
Alternatively, the key can be provided as the sole command-line
argument
.Ar password
when starting the program.  Obviously, this way the key can easily be
spotted by other users running
.Xr ps 1 .
As yet another alternative,
.Nm
can be given the option
.Fl k ,
and it will take the key from the environment variable
.Ev CrYpTkEy .
While this at a first glance seems to be more secure than the previous
option, it actually isn't since environment variables can also be
examined with
.Xr ps 1 .
Thus this option is mainly provided for compatibility with other
implementations of
.Nm .
.Pp
When specifying the option
.Fl s ,
.Nm
modifies the encryption engine in a way that is supposed to make it a
little more secure, but incompatible with other implementations.
.Pp
.Ss Warning
The cryptographic value of
.Nm
is rather small.  This program is only provided here for compatibility
with other operating systems that also provide an implementation.  For
real encryption, refer to
.Xr bdes 1
(from the DES distribution package), or
.Xr pgp 1
(from the ports collection).  However, restrictions for exporting,
importing or using such tools might exist in some countries, so those
stronger programs are not being shipped as part of the operating
system by default.
.Sh ENVIRONMENT
.Bl -tag -offset indent -width "XXCrYpTkEy"
.It Ev CrYpTkEy
used to obtain the secret key when option
.Fl k
has been given
.El
.Sh EXAMPLES
.Bd -literal -offset indent
man enigma | enigma > encrypted
Enter key: (XXX \(em key not echoed)
.Ed
.Pp
This will create an encrypted form of this man page, and store it in
the file
.Ql encrypted .
.Bd -literal -offset indent
enigma XXX < encrypted
.Ed
.Pp
This displays the previously created file on the terminal.
.Sh SEE ALSO
.Xr bdes 1 ,
.Xr pgp 1 ,
.Xr ps 1 ,
.Xr getpass 3
.Sh HISTORY
Implementations of
.Nm crypt
are very common among
.Ux
operating systems.  This implementation has been taken from the
.Em Cryptbreakers Workbench
which is in the public domain.
Fix some of the more blatant bugs in the original code, provide a BSD-able Makefile, add a man page (that also puts a bold warning about the weakness of the encryption), and implement the -k option for compatibility with other vendor's implementations. (Unlike those other vendors, we actually also document this option and its problems.) There are more violations of style(9) in it, like the not-use of getopt(3), but it's not worth the while fixing all of this. 1998-10-30 18:24:54 +00:00			`.\"`
			`.\" enigma (aka. crypt) man page written by Joerg Wunsch.`
			`.\"`
			`.\" Since enigma itself is distributed in the Public Domain, this file`
			`.\" is also.`
			`.\"`
$Id$ -> $FreeBSD$ 1999-08-28 01:08:13 +00:00			`.\" $FreeBSD$`
Fix some of the more blatant bugs in the original code, provide a BSD-able Makefile, add a man page (that also puts a bold warning about the weakness of the encryption), and implement the -k option for compatibility with other vendor's implementations. (Unlike those other vendors, we actually also document this option and its problems.) There are more violations of style(9) in it, like the not-use of getopt(3), but it's not worth the while fixing all of this. 1998-10-30 18:24:54 +00:00			`.\" "`
			`.Dd October 30, 1998`
			`.Os`
Various man page cleanup: - Sort xrefs - Be consistent with section names as outlines in mdoc(7). - Other misc mdoc cleanup. PR: doc/13144 Submitted by: Alexey M. Zelkin <phantom@cris.net> 1999-08-15 08:25:34 +00:00			`.Dt ENIGMA 1`
Fix some of the more blatant bugs in the original code, provide a BSD-able Makefile, add a man page (that also puts a bold warning about the weakness of the encryption), and implement the -k option for compatibility with other vendor's implementations. (Unlike those other vendors, we actually also document this option and its problems.) There are more violations of style(9) in it, like the not-use of getopt(3), but it's not worth the while fixing all of this. 1998-10-30 18:24:54 +00:00			`.Sh NAME`
Some man page cleanup. Make the NAME and SYNOPSIS sections agree so that whatis(1) will produce the expected results. Pointed-out-by: Jesus Monroy <jesus.monroy@usa.net> in freebsd-doc 1999-06-24 06:22:24 +00:00			`.Nm enigma ,`
			`.Nm crypt`
Fix some of the more blatant bugs in the original code, provide a BSD-able Makefile, add a man page (that also puts a bold warning about the weakness of the encryption), and implement the -k option for compatibility with other vendor's implementations. (Unlike those other vendors, we actually also document this option and its problems.) There are more violations of style(9) in it, like the not-use of getopt(3), but it's not worth the while fixing all of this. 1998-10-30 18:24:54 +00:00			`.Nd very simple file encryption`
			`.Sh SYNOPSIS`
			`.Nm`
			`.Op Fl s`
			`.Op Fl k`
			`.Op Ar password`
			`.Nm crypt`
			`.Op Fl s`
			`.Op Fl k`
			`.Op Ar password`
			`.Sh DESCRIPTION`
			`.Nm Enigma ,`
			`also known as`
			`.Nm crypt`
			`is a`
			`.Em very`
			`simple encryption program, working on a`
			`.Dq secret-key`
			`basis. It operates as a filter, i. e. it encrypts or decrypts a`
			`stream of data from standard input, and writes the result to standard`
			`output. It automatically detects whether the input data stream is`
			`already encrypted, and switches into decryption mode in this case.`
			`.Pp`
			`There are several ways to provide the secret key to the program. By`
			`default, the program prompts the user on the controlling terminal for`
			`the key, using`
			`.Xr getpass 3 .`
			`This is the only safe way of providing it.`
			`.Pp`
			`Alternatively, the key can be provided as the sole command-line`
			`argument`
			`.Ar password`
			`when starting the program. Obviously, this way the key can easily be`
			`spotted by other users running`
			`.Xr ps 1 .`
			`As yet another alternative,`
			`.Nm`
			`can be given the option`
			`.Fl k ,`
			`and it will take the key from the environment variable`
			`.Ev CrYpTkEy .`
			`While this at a first glance seems to be more secure than the previous`
			`option, it actually isn't since environment variables can also be`
			`examined with`
			`.Xr ps 1 .`
			`Thus this option is mainly provided for compatibility with other`
			`implementations of`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 19:21:22 +00:00			`.Nm .`
Fix some of the more blatant bugs in the original code, provide a BSD-able Makefile, add a man page (that also puts a bold warning about the weakness of the encryption), and implement the -k option for compatibility with other vendor's implementations. (Unlike those other vendors, we actually also document this option and its problems.) There are more violations of style(9) in it, like the not-use of getopt(3), but it's not worth the while fixing all of this. 1998-10-30 18:24:54 +00:00			`.Pp`
			`When specifying the option`
			`.Fl s ,`
			`.Nm`
			`modifies the encryption engine in a way that is supposed to make it a`
			`little more secure, but incompatible with other implementations.`
			`.Pp`
			`.Ss Warning`
			`The cryptographic value of`
			`.Nm`
			`is rather small. This program is only provided here for compatibility`
			`with other operating systems that also provide an implementation. For`
			`real encryption, refer to`
			`.Xr bdes 1`
			`(from the DES distribution package), or`
			`.Xr pgp 1`
Typo. PR: docs/9752 Submitted by: horikawa@jp.FreeBSD.org 1999-01-28 19:22:22 +00:00			`(from the ports collection). However, restrictions for exporting,`
Fix some of the more blatant bugs in the original code, provide a BSD-able Makefile, add a man page (that also puts a bold warning about the weakness of the encryption), and implement the -k option for compatibility with other vendor's implementations. (Unlike those other vendors, we actually also document this option and its problems.) There are more violations of style(9) in it, like the not-use of getopt(3), but it's not worth the while fixing all of this. 1998-10-30 18:24:54 +00:00			`importing or using such tools might exist in some countries, so those`
			`stronger programs are not being shipped as part of the operating`
			`system by default.`
			`.Sh ENVIRONMENT`
			`.Bl -tag -offset indent -width "XXCrYpTkEy"`
			`.It Ev CrYpTkEy`
			`used to obtain the secret key when option`
			`.Fl k`
			`has been given`
			`.El`
			`.Sh EXAMPLES`
			`.Bd -literal -offset indent`
			`man enigma \| enigma > encrypted`
			`Enter key: (XXX \(em key not echoed)`
			`.Ed`
			`.Pp`
			`This will create an encrypted form of this man page, and store it in`
			`the file`
			`.Ql encrypted .`
			`.Bd -literal -offset indent`
			`enigma XXX < encrypted`
			`.Ed`
			`.Pp`
			`This displays the previously created file on the terminal.`
			`.Sh SEE ALSO`
			`.Xr bdes 1 ,`
			`.Xr pgp 1 ,`
			`.Xr ps 1 ,`
			`.Xr getpass 3`
			`.Sh HISTORY`
			`Implementations of`
			`.Nm crypt`
			`are very common among`
			`.Ux`
			`operating systems. This implementation has been taken from the`
			`.Em Cryptbreakers Workbench`
			`which is in the public domain.`