| 1 | .\"- |
|---|
| 2 | .\" Copyright (c) 2013-2014 Universitetet i Oslo |
|---|
| 3 | .\" All rights reserved. |
|---|
| 4 | .\" |
|---|
| 5 | .\" Redistribution and use in source and binary forms, with or without |
|---|
| 6 | .\" modification, are permitted provided that the following conditions |
|---|
| 7 | .\" are met: |
|---|
| 8 | .\" 1. Redistributions of source code must retain the above copyright |
|---|
| 9 | .\" notice, this list of conditions and the following disclaimer. |
|---|
| 10 | .\" 2. Redistributions in binary form must reproduce the above copyright |
|---|
| 11 | .\" notice, this list of conditions and the following disclaimer in the |
|---|
| 12 | .\" documentation and/or other materials provided with the distribution. |
|---|
| 13 | .\" 3. The name of the author may not be used to endorse or promote |
|---|
| 14 | .\" products derived from this software without specific prior written |
|---|
| 15 | .\" permission. |
|---|
| 16 | .\" |
|---|
| 17 | .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND |
|---|
| 18 | .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
|---|
| 19 | .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
|---|
| 20 | .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE |
|---|
| 21 | .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
|---|
| 22 | .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS |
|---|
| 23 | .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) |
|---|
| 24 | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT |
|---|
| 25 | .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY |
|---|
| 26 | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF |
|---|
| 27 | .\" SUCH DAMAGE. |
|---|
| 28 | .\" |
|---|
| 29 | .\" $Id: oathkey.1 784 2014-03-10 15:31:30Z des $ |
|---|
| 30 | .\" |
|---|
| 31 | .Dd March 9, 2014 |
|---|
| 32 | .Dt OATHKEY 1 |
|---|
| 33 | .Os |
|---|
| 34 | .Sh NAME |
|---|
| 35 | .Nm oathkey |
|---|
| 36 | .Nd OATH key management tool |
|---|
| 37 | .Sh SYNOPSIS |
|---|
| 38 | .Nm |
|---|
| 39 | .Op Fl hvw |
|---|
| 40 | .Op Fl u Ar user |
|---|
| 41 | .Op Fl k Ar keyfile |
|---|
| 42 | .Ar command |
|---|
| 43 | .Op Ar args |
|---|
| 44 | .Sh DESCRIPTION |
|---|
| 45 | The |
|---|
| 46 | .Nm |
|---|
| 47 | utility creates and manages OATH keys, and can be used to validate an |
|---|
| 48 | OATH response. |
|---|
| 49 | .Pp |
|---|
| 50 | The following options are available: |
|---|
| 51 | .Bl -tag -width Fl |
|---|
| 52 | .It Fl h |
|---|
| 53 | Print a usage message and exit. |
|---|
| 54 | .It Fl k Ar keyfile |
|---|
| 55 | Specify the location of the keyfile on which to operate. |
|---|
| 56 | The default is |
|---|
| 57 | .Pa /var/oath/ Ns Ar user Ns Pa .otpauth . |
|---|
| 58 | .It Fl u Ar user |
|---|
| 59 | Specify the user on which to operate. |
|---|
| 60 | The default is the current user. |
|---|
| 61 | Only root may operate on other users. |
|---|
| 62 | .It Fl v |
|---|
| 63 | Enable verbose mode. |
|---|
| 64 | .It Fl w |
|---|
| 65 | Enable writeback mode (see below). |
|---|
| 66 | .El |
|---|
| 67 | .Pp |
|---|
| 68 | The commands are: |
|---|
| 69 | .Bl -tag -width 6n |
|---|
| 70 | .It Cm genkey |
|---|
| 71 | Generate a new key. |
|---|
| 72 | If writeback mode is enabled, the user's key is set; otherwise, it is |
|---|
| 73 | printed to standard output. |
|---|
| 74 | .It Cm setkey Ar uri |
|---|
| 75 | Set the user's key to the given otpauth URI. |
|---|
| 76 | .It Cm uri |
|---|
| 77 | Print the user's key in otpauth URI form. |
|---|
| 78 | .It Cm verify Ar code |
|---|
| 79 | Verify that the given code is the correct current response for the |
|---|
| 80 | user's key. |
|---|
| 81 | If writeback mode is enabled and the response matched, the user's |
|---|
| 82 | keyfile is updated to prevent reuse. |
|---|
| 83 | .El |
|---|
| 84 | .Sh SEE ALSO |
|---|
| 85 | .Xr oath_hotp 3 , |
|---|
| 86 | .Xr oath_key 3 , |
|---|
| 87 | .Xr oath_totp 3 , |
|---|
| 88 | .Xr pam_oath 8 |
|---|
| 89 | .Sh AUTHORS |
|---|
| 90 | The |
|---|
| 91 | .Nm |
|---|
| 92 | utility and this manual page were written by |
|---|
| 93 | .An Dag-Erling Sm\(/orgrav Aq des@des.no |
|---|
| 94 | for the University of Oslo. |
|---|
| 95 | .Sh BUGS |
|---|
| 96 | Many. |
|---|
