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