xref: /netbsd-src/external/bsd/pam-u2f/dist/man/pamu2fcfg.1.txt (revision e6c7e151de239c49d2e38720a061ed9d1fa99309)
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 U2F registration procedure using a connected U2F token and output a configuration line that can be used with the U2F PAM module.
15
16== OPTIONS
17*-d*, *--debug*::
18Print debug information (highly verbose)
19
20*-h*, *--help*::
21Print help and exit
22
23*-o*, *--origin*=_STRING_::
24Origin URL to use during registration. Defaults to pam://hostname
25
26*-i*, *--appid*=_STRING_::
27Application ID to use during registration. Defaults to *origin*
28
29*-r*, *--resident*::
30Generate a resident credential. Defaults to off.
31
32*-t*, *--type*=_STRING_::
33COSE type to use during registration (ES256 or RS256). Defaults to ES256.
34
35*-N*, *--pin-verification*::
36Require PIN verification during authentication. Defaults to off.
37
38*-V*, *--user-verification*::
39Require user verification during authentication. Defaults to off.
40
41*--version*:
42*Print version and exit*
43
44Group: user (mutually exclusive)
45
46*-u*, *--username*=_STRING_::
47The name of the user registering the device. Defaults to the current user name
48
49*-n*, *--nouser*::
50Print only registration information (keyHandle and public key). Useful for appending
51
52== BUGS
53Report pamu2fcfg bugs in the issue tracker: https://github.com/Yubico/pam-u2f/issues
54
55== SEE ALSO
56*pam_u2f*(8), *pam*(7)
57
58The pam-u2f home page: https://developers.yubico.com/pam-u2f/
59
60YubiKeys can be obtained from Yubico: https://www.yubico.com/
61