xref: /netbsd-src/external/bsd/pam-u2f/dist/man/pamu2fcfg.1.txt (revision 6db267571823ee3b0a1d61478df085a087f2e990)
1PAMU2FCFG(1)
2============
3:doctype:      manpage
4:man source:   pamu2fcfg
5:man manual:   PAM U2F Configuration Tool
6
7== NAME
8pamu2fcfg - Configuration tool for the U2F PAM module.
9
10== SYNOPSIS
11*pamu2fcfg* [_OPTION_]...
12
13== DESCRIPTION
14Perform a FIDO2/U2F registration procedure using a connected authenticator and
15output a configuration line that can be used with the U2F PAM module.
16
17== OPTIONS
18*-d*, *--debug*::
19Print debug information (highly verbose)
20
21*-h*, *--help*::
22Print help and exit
23
24*-o*, *--origin*=_STRING_::
25Set the FIDO2 relying party ID to use during registration. Defaults to
26pam://hostname. Before pamu2fcfg v1.1.0, this set the U2F origin URL.
27
28*-i*, *--appid*=_STRING_::
29Set the FIDO2 relying party name to use during registration. Defaults
30to *origin*. Before pamu2fcfg v1.1.0, this set the U2F application ID.
31
32*-r*, *--resident*::
33Generate a resident credential. Defaults to off.
34
35*-t*, *--type*=_STRING_::
36COSE type to use during registration (ES256, EDDSA, or RS256). Defaults to ES256.
37
38*-P*, *--no-user-presence*::
39Allow using the credential without ensuring the user's presence.
40Defaults to off.
41
42*-N*, *--pin-verification*::
43Require PIN verification during authentication. Defaults to off.
44
45*-V*, *--user-verification*::
46Require user verification during authentication. Defaults to off.
47
48*--version*:
49*Print version and exit*
50
51Group: user (mutually exclusive)
52
53*-u*, *--username*=_STRING_::
54The name of the user registering the device. Defaults to the current user name
55
56*-n*, *--nouser*::
57Print only registration information (keyHandle and public key). Useful for appending
58
59== BUGS
60Report pamu2fcfg bugs in the issue tracker: https://github.com/Yubico/pam-u2f/issues
61
62== SEE ALSO
63*pam_u2f*(8), *pam*(7)
64
65The pam-u2f home page: https://developers.yubico.com/pam-u2f/
66
67YubiKeys can be obtained from Yubico: https://www.yubico.com/
68