err.no Git - yubikey-personalization.old/blob - ykchalresp.1

   1 .\" Copyright (c) 2011-2012 Yubico AB
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions are
   6 .\" met:
   7 .\"
   8 .\"     * Redistributions of source code must retain the above copyright
   9 .\"       notice, this list of conditions and the following disclaimer.
  10 .\"
  11 .\"     * Redistributions in binary form must reproduce the above
  12 .\"       copyright notice, this list of conditions and the following
  13 .\"       disclaimer in the documentation and/or other materials provided
  14 .\"       with the distribution.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  17 .\" "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  18 .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  19 .\" A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  20 .\" OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  21 .\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  22 .\" LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  26 .\" OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27 .\"
  28 .\" The following commands are required for all man pages.
  29 .de URL
  30 \\$2 \(laURL: \\$1 \(ra\\$3
  31 ..
  32 .if \n[.g] .mso www.tmac
  33 .TH ykchalresp "1" "Febuary 2011" "yubikey-personalization"
  34 .SH NAME
  35 ykchalresp - Perform challenge-response operation with YubiKey
  36 .SH SYNOPSIS
  37 .B ykchalresp
  38 [\fI-1\fR | \fI-2\fR] [\fI-H\fR] [\fI-Y\fR] [\fI-N\fR] [\fI-x\fR] [\fI-v\fR] [\fI-h\fR]
  39 .\".SH DESCRIPTION
  40 .\" Add any additional description here
  41 .SH OPTIONS
  42 .PP
  43 Send a challenge to a YubiKey, and read the response.  The YubiKey can be configured
  44 with two different C/R modes -- the standard one is a 160 bits HMAC-SHA1, and the other
  45 is a YubiKey OTP mimicing mode, meaning two subsequent calls with the same challenge
  46 will result in different responses.
  47 .TP
  48 \fB\-1\fR
  49 send the challenge to slot 1.  This is the default.
  50 .TP
  51 \fB\-2\fR
  52 send the challenge to slot 2.
  53 .TP
  54 \fB\-H\fR
  55 send a 64 byte HMAC challenge.  This is the default.
  56 .TP
  57 \fB\-Y\fR
  58 send a 6 byte Yubico OTP challenge.
  59 .TP
  60 \fB\-N\fR
  61 non-blocking mode -- abort if the YubiKey is configured to require a key press before
  62 sending the response.
  63 .TP
  64 \fB\-x\fR
  65 challenge is hex encoded.
  66 .TP
  67 \fB\-v\fR
  68 enable verbose mode.
  69
  70 .SH EXAMPLE
  71 The YubiKey challenge-response operation can be demonstrated using the
  72 \fBNIST PUB 198 A.2\fR test vector.
  73 .P
  74 First, program a YubiKey with the test vector :
  75 .HP
  76 .nf
  77 $ \fBykpersonalize \-2 \-ochal\-resp \-ochal\-hmac \-ohmac\-lt64 \-a 303132333435363738393a3b3c3d3e3f40414243\fR
  78  ...
  79 Commit? (y/n) [n]: y
  80 $
  81 .fi
  82 .HP
  83 Now, send the NIST test challenge to the YubiKey and verify the result matches the
  84 expected :
  85 .HP
  86 .nf
  87 $ \fBykchalresp \-2 'Sample #2'\fR
  88 0922d3405faa3d194f82a45830737d5cc6c75d24
  89 $
  90 .fi
  91
  92 .SH BUGS
  93 Report ykchalresp bugs in
  94 .URL "https://github.com/Yubico/yubikey-personalization/issues" "the issue tracker"
  95 .SH "SEE ALSO"
  96 The
  97 .URL "http://code.google.com/p/yubikey-personalization/" "ykpersonalize home page"
  98 .PP
  99 YubiKeys can be obtained from
 100 .URL "http://www.yubico.com/" "Yubico" "."