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