xref: /freebsd/usr.bin/enigma/enigma.1 (revision c3aac50f284c6cca5b4f2eb46aaa13812cb8b630)
15dc67cd7SJoerg Wunsch.\"
25dc67cd7SJoerg Wunsch.\" enigma (aka. crypt) man page written by Joerg Wunsch.
35dc67cd7SJoerg Wunsch.\"
45dc67cd7SJoerg Wunsch.\" Since enigma itself is distributed in the Public Domain, this file
55dc67cd7SJoerg Wunsch.\" is also.
65dc67cd7SJoerg Wunsch.\"
7c3aac50fSPeter Wemm.\" $FreeBSD$
85dc67cd7SJoerg Wunsch.\" "
95dc67cd7SJoerg Wunsch.Dd October 30, 1998
105dc67cd7SJoerg Wunsch.Os
11a4cab7d3SMike Pritchard.Dt ENIGMA 1
125dc67cd7SJoerg Wunsch.Sh NAME
13a684cccdSMike Pritchard.Nm enigma ,
14a684cccdSMike Pritchard.Nm crypt
155dc67cd7SJoerg Wunsch.Nd very simple file encryption
165dc67cd7SJoerg Wunsch.Sh SYNOPSIS
175dc67cd7SJoerg Wunsch.Nm
185dc67cd7SJoerg Wunsch.Op Fl s
195dc67cd7SJoerg Wunsch.Op Fl k
205dc67cd7SJoerg Wunsch.Op Ar password
215dc67cd7SJoerg Wunsch.Nm crypt
225dc67cd7SJoerg Wunsch.Op Fl s
235dc67cd7SJoerg Wunsch.Op Fl k
245dc67cd7SJoerg Wunsch.Op Ar password
255dc67cd7SJoerg Wunsch.Sh DESCRIPTION
265dc67cd7SJoerg Wunsch.Nm Enigma ,
275dc67cd7SJoerg Wunschalso known as
285dc67cd7SJoerg Wunsch.Nm crypt
295dc67cd7SJoerg Wunschis a
305dc67cd7SJoerg Wunsch.Em very
315dc67cd7SJoerg Wunschsimple encryption program, working on a
325dc67cd7SJoerg Wunsch.Dq secret-key
335dc67cd7SJoerg Wunschbasis.  It operates as a filter, i. e. it encrypts or decrypts a
345dc67cd7SJoerg Wunschstream of data from standard input, and writes the result to standard
355dc67cd7SJoerg Wunschoutput.  It automatically detects whether the input data stream is
365dc67cd7SJoerg Wunschalready encrypted, and switches into decryption mode in this case.
375dc67cd7SJoerg Wunsch.Pp
385dc67cd7SJoerg WunschThere are several ways to provide the secret key to the program.  By
395dc67cd7SJoerg Wunschdefault, the program prompts the user on the controlling terminal for
405dc67cd7SJoerg Wunschthe key, using
415dc67cd7SJoerg Wunsch.Xr getpass 3 .
425dc67cd7SJoerg WunschThis is the only safe way of providing it.
435dc67cd7SJoerg Wunsch.Pp
445dc67cd7SJoerg WunschAlternatively, the key can be provided as the sole command-line
455dc67cd7SJoerg Wunschargument
465dc67cd7SJoerg Wunsch.Ar password
475dc67cd7SJoerg Wunschwhen starting the program.  Obviously, this way the key can easily be
485dc67cd7SJoerg Wunschspotted by other users running
495dc67cd7SJoerg Wunsch.Xr ps 1 .
505dc67cd7SJoerg WunschAs yet another alternative,
515dc67cd7SJoerg Wunsch.Nm
525dc67cd7SJoerg Wunschcan be given the option
535dc67cd7SJoerg Wunsch.Fl k ,
545dc67cd7SJoerg Wunschand it will take the key from the environment variable
555dc67cd7SJoerg Wunsch.Ev CrYpTkEy .
565dc67cd7SJoerg WunschWhile this at a first glance seems to be more secure than the previous
575dc67cd7SJoerg Wunschoption, it actually isn't since environment variables can also be
585dc67cd7SJoerg Wunschexamined with
595dc67cd7SJoerg Wunsch.Xr ps 1 .
605dc67cd7SJoerg WunschThus this option is mainly provided for compatibility with other
615dc67cd7SJoerg Wunschimplementations of
625dc67cd7SJoerg Wunsch.Nm enigma .
635dc67cd7SJoerg Wunsch.Pp
645dc67cd7SJoerg WunschWhen specifying the option
655dc67cd7SJoerg Wunsch.Fl s ,
665dc67cd7SJoerg Wunsch.Nm
675dc67cd7SJoerg Wunschmodifies the encryption engine in a way that is supposed to make it a
685dc67cd7SJoerg Wunschlittle more secure, but incompatible with other implementations.
695dc67cd7SJoerg Wunsch.Pp
705dc67cd7SJoerg Wunsch.Ss Warning
715dc67cd7SJoerg WunschThe cryptographic value of
725dc67cd7SJoerg Wunsch.Nm
735dc67cd7SJoerg Wunschis rather small.  This program is only provided here for compatibility
745dc67cd7SJoerg Wunschwith other operating systems that also provide an implementation.  For
755dc67cd7SJoerg Wunschreal encryption, refer to
765dc67cd7SJoerg Wunsch.Xr bdes 1
775dc67cd7SJoerg Wunsch(from the DES distribution package), or
785dc67cd7SJoerg Wunsch.Xr pgp 1
79cb7f0900SBill Fumerola(from the ports collection).  However, restrictions for exporting,
805dc67cd7SJoerg Wunschimporting or using such tools might exist in some countries, so those
815dc67cd7SJoerg Wunschstronger programs are not being shipped as part of the operating
825dc67cd7SJoerg Wunschsystem by default.
835dc67cd7SJoerg Wunsch.Sh ENVIRONMENT
845dc67cd7SJoerg Wunsch.Bl -tag -offset indent -width "XXCrYpTkEy"
855dc67cd7SJoerg Wunsch.It Ev CrYpTkEy
865dc67cd7SJoerg Wunschused to obtain the secret key when option
875dc67cd7SJoerg Wunsch.Fl k
885dc67cd7SJoerg Wunschhas been given
895dc67cd7SJoerg Wunsch.El
905dc67cd7SJoerg Wunsch.Sh EXAMPLES
915dc67cd7SJoerg Wunsch.Bd -literal -offset indent
925dc67cd7SJoerg Wunschman enigma | enigma > encrypted
935dc67cd7SJoerg WunschEnter key: (XXX \(em key not echoed)
945dc67cd7SJoerg Wunsch.Ed
955dc67cd7SJoerg Wunsch.Pp
965dc67cd7SJoerg WunschThis will create an encrypted form of this man page, and store it in
975dc67cd7SJoerg Wunschthe file
985dc67cd7SJoerg Wunsch.Ql encrypted .
995dc67cd7SJoerg Wunsch.Bd -literal -offset indent
1005dc67cd7SJoerg Wunschenigma XXX < encrypted
1015dc67cd7SJoerg Wunsch.Ed
1025dc67cd7SJoerg Wunsch.Pp
1035dc67cd7SJoerg WunschThis displays the previously created file on the terminal.
1045dc67cd7SJoerg Wunsch.Sh SEE ALSO
1055dc67cd7SJoerg Wunsch.Xr bdes 1 ,
1065dc67cd7SJoerg Wunsch.Xr pgp 1 ,
1075dc67cd7SJoerg Wunsch.Xr ps 1 ,
1085dc67cd7SJoerg Wunsch.Xr getpass 3
1095dc67cd7SJoerg Wunsch.Sh HISTORY
1105dc67cd7SJoerg WunschImplementations of
1115dc67cd7SJoerg Wunsch.Nm crypt
1125dc67cd7SJoerg Wunschare very common among
1135dc67cd7SJoerg Wunsch.Ux
1145dc67cd7SJoerg Wunschoperating systems.  This implementation has been taken from the
1155dc67cd7SJoerg Wunsch.Em Cryptbreakers Workbench
1165dc67cd7SJoerg Wunschwhich is in the public domain.
117