source: openpam/branches/oath/modules/pam_oath/pam_oath.8 @ 911

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

merge r910: correct markup for email addresses

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 2.8 KB
Line 
1.\"-
2.\" Copyright (c) 2012-2016 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.\"
30.\" $Id: pam_oath.8 911 2017-01-21 12:37:15Z des $
31.\"
32.Dd January 11, 2016
33.Dt PAM_OATH 8
34.Os
35.Sh NAME
36.Nm pam_oath
37.Nd OATH service module
38.Sh SYNOPSIS
39.Op Ar service
40.Ar module-type
41.Ar control-flag
42.Cm Nm
43.Op Ar arguments
44.Sh DESCRIPTION
45The
46.Nm
47service module implements counter-based and time-based one-time
48passwords.
49.Pp
50The
51.Nm
52service module recognizes the following options:
53.Bl -tag -width ".Cm echo_pass"
54.It Cm nokey = Ar fail | fake | ignore
55Specifies how the module should behave when no key is available for
56the user: either fail immediately, prompt for a code but fail anyway,
57or let authentication proceed by other means.
58\" .It Cm nouser = Ar fail | fake | ignore
59\" Specifies how the module should behave when the user does not exist.
60\" See
61\" .Bm nokey
62\" above.
63\" .It Cm badkey = Ar fail | fake | ignore
64\" Specifies how the module should behave when the user exists and has a
65\" key, but the key could not be loaded (e.g. due to a syntax error in
66\" the keyfile).
67\" See
68\" .Bm nokey
69\" above.
70.El
71.Pp
72The
73.Nm
74service module uses
75.Xr pam_get_authtok 3
76to prompt the user, and will therefore also be affected by the
77standard options
78.Sh SEE ALSO
79.Xr oathkey 1 ,
80.Xr pam.conf 5 ,
81.Xr pam 8
82.Sh AUTHORS
83The
84.Nm
85module and this manual page were developed by
86.An Dag-Erling Sm\(/orgrav Aq Mt des@des.no
87for the University of Oslo.
Note: See TracBrowser for help on using the repository browser.