contrib/opie/opiekey.1

   1 .\" opiekey.1: Manual page for the opiekey(1) program.
   2 .\"
   3 .\" %%% portions-copyright-cmetz-96
   4 .\" Portions of this software are Copyright 1996-1999 by Craig Metz, All Rights
   5 .\" Reserved. The Inner Net License Version 2 applies to these portions of
   6 .\" the software.
   7 .\" You should have received a copy of the license with this software. If
   8 .\" you didn't get a copy, you may request one from <license@inner.net>.
   9 .\"
  10 .\" Portions of this software are Copyright 1995 by Randall Atkinson and Dan
  11 .\" McDonald, All Rights Reserved. All Rights under this copyright are assigned
  12 .\" to the U.S. Naval Research Laboratory (NRL). The NRL Copyright Notice and
  13 .\" License Agreement applies to this software.
  14 .\"
  15 .\"     History:
  16 .\"
  17 .\"     Modified by cmetz for OPIE 2.3. Added -t documentation. Removed
  18 .\"        opie-bugs pointer. Removed opie-md5 and opie-md4 names. Fixed
  19 .\"        a bolding bug. Added -f flag. Added escapes on flags. Minor
  20 .\"        editorial changes. Updated example.
  21 .\"     Modified by cmetz for OPIE 2.2. Removed MJR DES documentation.
  22 .\"        Re-worded retype documentation. Added opiegen reference.
  23 .\"        Added -x documentation.
  24 .\"     Modified at NRL for OPIE 2.0.
  25 .\"     Written at Bellcore for the S/Key Version 1 software distribution
  26 .\"             (key.1).
  27 .\"
  28 .\"     $FreeBSD: head/contrib/opie/opiekey.1 187920 2009-01-30 15:43:55Z gabor $
  29 .ll 6i
  30 .pl 10.5i
  31 .lt 6.0i
  32 .TH OPIEKEY 1 "February 20, 1996"
  33 .AT 3
  34 .SH NAME
  35 opiekey, otp-md4, otp-md5 \- Programs for computing responses to OTP challenges.
  36
  37 .SH SYNOPSIS
  38 .B opiekey
  39 |
  40 .B otp-md4
  41 |
  42 .B otp-md5
  43 [\-v] [\-h] [\-f] [\-x]
  44 .sp 0
  45 [\-t
  46 .I
  47 type
  48 ] [\-4|\-5]
  49 [\-a] [\-n
  50 .I count
  51 ]
  52 .I sequence_number seed
  53 .sp 0
  54
  55 .SH DESCRIPTION
  56 .I opiekey
  57 takes the optional count of the number of responses to
  58 print along with a (maximum) sequence number and seed as command line
  59 args. It prompts for the user's secret pass phrase and produces an OPIE
  60 response as six words. If compiled to do so, it can prompt for the user's
  61 secret pass phrase twice to help reduce errors due to mistypes. The second
  62 password entry can be circumvented by entering only an end of line.
  63 .I opiekey
  64 is downward compatible with the
  65 .IR key (1)
  66 program from the Bellcore S/Key Version 1 distribution and several of its
  67 variants.
  68
  69 .SH OPTIONS
  70 .TP
  71 .B \-v
  72 Display the version number and compile-time options, then exit.
  73 .TP
  74 .B \-h
  75 Display a brief help message and exit.
  76 .TP
  77 .B \-4, \-5
  78 Selects MD4 or MD5, respectively, as the response generation algorithm. The
  79 default for otp-md4 is MD4 and the default for opie-md5 is MD5. The default
  80 for opiekey depends on compile-time configuration, but should be MD5. MD4 is
  81 compatible with the Bellcore S/Key Version 1 distribution.
  82 .TP
  83 .B \-f
  84 Force
  85 .I opiekey
  86 to continue, even where it normally shouldn't. This is currently used to
  87 force opiekey to operate in even from terminals it believes to be insecure.
  88 It can also allow users to disclose their secret pass phrases to attackers.
  89 Use of the -f flag may be disabled by compile-time option in your particular
  90 build of OPIE.
  91 .TP
  92 .B \-a
  93 Allows you to input an arbitrary secret pass phrase, instead of running checks
  94 against it. Arbitrary currently does not include '\\0' or '\\n' characters. This
  95 can be used for backwards compatibility with key generators that do not check
  96 passwords.
  97 .TP
  98 .B \-n <count>
  99 the number of one time access passwords to print.
 100 The default is one.
 101 .TP
 102 .B \-x
 103 Output the OTPs as hexadecimal numbers instead of six words.
 104 .TP
 105 .B \-t <type>
 106 Generate an extended response of the specified type. Supported types are:
 107 .sp 1
 108 word                    six-word
 109 .sp 0
 110 hex                     hexadecimal
 111 .sp 0
 112 init                    hexadecimal re-initialization
 113 .sp 0
 114 init-word               six-word re-initialization
 115 .sp 1
 116 The re-initialization responses
 117 .I always
 118 generate the simple active attack protection.
 119 .TP
 120 .SH EXAMPLE
 121 .sp 0
 122 wintermute$ opiekey \-5 \-n 5 495 wi01309
 123 .sp 0
 124 Using MD5 algorithm to compute response.
 125 .sp 0
 126 Reminder: Don't use opiekey from telnet or dial-in sessions.
 127 .sp 0
 128 Enter secret pass phrase:
 129 .sp 0
 130 491: HOST VET FOWL SEEK IOWA YAP
 131 .sp 0
 132 492: JOB ARTS WERE FEAT TILE IBIS
 133 .sp 0
 134 493: TRUE BRED JOEL USER HALT EBEN
 135 .sp 0
 136 494: HOOD WED MOLT PAN FED RUBY
 137 .sp 0
 138 495: SUB YAW BILE GLEE OWE NOR
 139 .sp 0
 140 wintermute$
 141 .LP
 142
 143 .SH BUGS
 144 .BR opiekey(1)
 145 can lull a user into revealing his/her password when remotely logged in, thus
 146 defeating the purpose of OPIE. This is especially a problem with xterm.
 147 .BR opiekey(1)
 148 implements simple checks to reduce the risk of a user making
 149 this mistake. Better checks are needed.
 150 .LP
 151
 152 .SH SEE ALSO
 153 .BR ftpd (8),
 154 .BR login (1),
 155 .BR opie (4),
 156 .BR opiepasswd (1),
 157 .BR opieinfo (1),
 158 .BR opiekeys (5),
 159 .BR opieaccess (5),
 160 .BR su (1)
 161
 162 .SH AUTHOR
 163 Bellcore's S/Key was written by Phil Karn, Neil M. Haller, and John S. Walden
 164 of Bellcore. OPIE was created at NRL by Randall Atkinson, Dan McDonald, and
 165 Craig Metz.
 166
 167 S/Key is a trademark of Bell Communications Research (Bellcore).
 168
 169 .SH CONTACT
 170 OPIE is discussed on the Bellcore "S/Key Users" mailing list. To join,
 171 send an email request to:
 172 .sp
 173 skey-users-request@thumper.bellcore.com