usr.bin/enigma/enigma.1

   1 .\"
   2 .\" enigma (aka. crypt) man page written by Joerg Wunsch.
   3 .\"
   4 .\" Since enigma itself is distributed in the Public Domain, this file
   5 .\" is also.
   6 .\"
   7 .\" $FreeBSD$
   8 .\" "
   9 .Dd May 8, 2018
  10 .Dt ENIGMA 1
  11 .Os
  12 .Sh NAME
  13 .Nm enigma ,
  14 .Nm crypt
  15 .Nd very simple file encryption
  16 .Sh SYNOPSIS
  17 .Nm
  18 .Op Fl s
  19 .Op Fl k
  20 .Op Ar password
  21 .Nm crypt
  22 .Op Fl s
  23 .Op Fl k
  24 .Op Ar password
  25 .Sh DESCRIPTION
  26 The
  27 .Nm
  28 utility, also known as
  29 .Nm crypt
  30 is a
  31 .Em very
  32 simple encryption program, working on a
  33 .Dq secret-key
  34 basis.
  35 It operates as a filter, i.e.,
  36 it encrypts or decrypts a
  37 stream of data from standard input, and writes the result to standard
  38 output.
  39 Since its operation is fully symmetrical, feeding the encrypted data
  40 stream again through the engine (using the same secret key) will
  41 decrypt it.
  42 .Pp
  43 There are several ways to provide the secret key to the program.
  44 By
  45 default, the program prompts the user on the controlling terminal for
  46 the key, using
  47 .Xr getpass 3 .
  48 This is the only safe way of providing it.
  49 .Pp
  50 Alternatively, the key can be provided as the sole command-line
  51 argument
  52 .Ar password
  53 when starting the program.
  54 Obviously, this way the key can easily be
  55 spotted by other users running
  56 .Xr ps 1 .
  57 As yet another alternative,
  58 .Nm
  59 can be given the option
  60 .Fl k ,
  61 and it will take the key from the environment variable
  62 .Ev CrYpTkEy .
  63 While this at a first glance seems to be more secure than the previous
  64 option, it actually is not since environment variables can also be
  65 examined with
  66 .Xr ps 1 .
  67 Thus this option is mainly provided for compatibility with other
  68 implementations of
  69 .Nm .
  70 .Pp
  71 When specifying the option
  72 .Fl s ,
  73 .Nm
  74 modifies the encryption engine in a way that is supposed to make it a
  75 little more secure, but incompatible with other implementations.
  76 .Pp
  77 .Ss Warning
  78 The cryptographic value of
  79 .Nm
  80 is rather small.
  81 This program is only provided here for compatibility
  82 with other operating systems that also provide an implementation
  83 (usually called
  84 .Xr crypt 1
  85 there).
  86 For real encryption, refer to
  87 .Xr openssl 1 ,
  88 or
  89 .Xr gpg 1 Pq Pa security/gnupg1 .
  90 .Sh ENVIRONMENT
  91 .Bl -tag -offset indent -width ".Ev CrYpTkEy"
  92 .It Ev CrYpTkEy
  93 used to obtain the secret key when option
  94 .Fl k
  95 has been given
  96 .El
  97 .Sh EXAMPLES
  98 .Bd -literal -offset indent
  99 man enigma | enigma > encrypted
 100 Enter key: (XXX \(em key not echoed)
 101 .Ed
 102 .Pp
 103 This will create an encrypted form of this man page, and store it in
 104 the file
 105 .Pa encrypted .
 106 .Bd -literal -offset indent
 107 enigma XXX < encrypted
 108 .Ed
 109 .Pp
 110 This displays the previously created file on the terminal.
 111 .Sh SEE ALSO
 112 .Xr gpg 1 ,
 113 .Xr openssl 1 ,
 114 .Xr ps 1 ,
 115 .Xr getpass 3
 116 .Sh HISTORY
 117 Implementations of
 118 .Nm crypt
 119 are very common among
 120 .Ux
 121 operating systems.
 122 This implementation has been taken from the
 123 .Em Cryptbreakers Workbench
 124 which is in the public domain.