source: openpam/trunk/bin/oathkey/oathkey.1 @ 827

Last change on this file since 827 was 827, checked in by Dag-Erling Smørgrav, 7 years ago

Add a calc command that prints the current code.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 3.2 KB
Line 
1.\"-
2.\" Copyright (c) 2013-2014 The University of 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 827 2014-10-22 10:03:14Z des $
30.\"
31.Dd October 22, 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
45The
46.Nm
47utility creates and manages OATH keys, and can be used to validate an
48OATH response.
49.Pp
50The following options are available:
51.Bl -tag -width Fl
52.It Fl h
53Print a usage message and exit.
54.It Fl k Ar keyfile
55Specify the location of the keyfile on which to operate.
56The default is
57.Pa /var/oath/ Ns Ar user Ns Pa .otpauth .
58.It Fl u Ar user
59Specify the user on which to operate.
60The default is the current user.
61Only root may operate on other users.
62.It Fl v
63Enable verbose mode.
64.It Fl w
65Enable writeback mode (see below).
66.El
67.Pp
68The commands are:
69.Bl -tag -width 6n
70.It Cm calc
71Compute and display the current code for the given key.
72If writeback mode is enabled, the user's keyfile is updated to prevent
73reuse.
74.It Cm genkey
75Generate a new key.
76If writeback mode is enabled, the user's key is set; otherwise, it is
77printed to standard output.
78.It Cm getkey
79Print the user's key.
80.It Cm geturi
81Print the user's key in otpauth URI form.
82.It Cm setkey Ar uri
83Set the user's key to the given otpauth URI.
84.It Cm uri
85Deprecated synonym for
86.Cm geturi .
87.It Cm verify Ar code
88Verify that the given code is the correct current response for the
89user's key.
90If writeback mode is enabled and the response matched, the user's
91keyfile is updated to prevent reuse.
92.El
93.Sh SEE ALSO
94.Xr oath_hotp 3 ,
95.Xr oath_key 3 ,
96.Xr oath_totp 3 ,
97.Xr pam_oath 8
98.Sh AUTHORS
99The
100.Nm
101utility and this manual page were written by
102.An Dag-Erling Sm\(/orgrav Aq des@des.no
103for the University of Oslo.
104.Sh BUGS
105Many.
Note: See TracBrowser for help on using the repository browser.