Source-Changes-HG archive

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index][Old Index]

[src/trunk]: src PR/55747: Tobias Nygren: Install manpages for pam-u2f



details:   https://anonhg.NetBSD.org/src/rev/68f2da05d130
branches:  trunk
changeset: 956598:68f2da05d130
user:      khorben <khorben%NetBSD.org@localhost>
date:      Mon Nov 02 06:40:11 2020 +0000

description:
PR/55747: Tobias Nygren: Install manpages for pam-u2f

I have generated the manual pages and referenced them into the sets.
It would probably help to add a Makefile rule, indicating how to
generate the manual pages again.

Tested with "build.sh release" on amd64.

Reviewed by Tobias Nygren before the commit.

diffstat:

 distrib/sets/lists/man/mi                           |    8 +-
 external/bsd/pam-u2f/bin/pamu2fcfg/Makefile         |    4 +-
 external/bsd/pam-u2f/bin/pamu2fcfg/pamu2fcfg.1      |  103 ++++++++++++
 external/bsd/pam-u2f/lib/security/pam-u2f/Makefile  |    5 +-
 external/bsd/pam-u2f/lib/security/pam-u2f/pam_u2f.8 |  167 ++++++++++++++++++++
 5 files changed, 280 insertions(+), 7 deletions(-)

diffs (truncated from 366 to 300 lines):

diff -r 1485c46a9ff4 -r 68f2da05d130 distrib/sets/lists/man/mi
--- a/distrib/sets/lists/man/mi Mon Nov 02 06:25:24 2020 +0000
+++ b/distrib/sets/lists/man/mi Mon Nov 02 06:40:11 2020 +0000
@@ -1,4 +1,4 @@
-# $NetBSD: mi,v 1.1707 2020/10/27 08:57:10 ryo Exp $
+# $NetBSD: mi,v 1.1708 2020/11/02 06:40:11 khorben Exp $
 #
 # Note: don't delete entries from here - mark them as "obsolete" instead.
 #
@@ -421,6 +421,7 @@
 ./usr/share/man/cat1/openssl_x509v3_config.0   man-obsolete            obsolete
 ./usr/share/man/cat1/page.0                    man-util-catman         .cat
 ./usr/share/man/cat1/pagesize.0                        man-util-catman         .cat
+./usr/share/man/cat1/pamu2fcfg.0               man-util-catman         .cat
 ./usr/share/man/cat1/passwd.0                  man-util-catman         .cat
 ./usr/share/man/cat1/paste.0                   man-util-catman         .cat
 ./usr/share/man/cat1/patch.0                   man-util-catman         .cat
@@ -2940,6 +2941,7 @@
 ./usr/share/man/cat8/pam_self.0                        man-sysutil-catman      pam,.cat
 ./usr/share/man/cat8/pam_skey.0                        man-sysutil-catman      skey,pam,.cat
 ./usr/share/man/cat8/pam_ssh.0                 man-sysutil-catman      pam,.cat
+./usr/share/man/cat8/pam_u2f.0                 man-sysutil-catman      pam,.cat
 ./usr/share/man/cat8/pam_unix.0                        man-sysutil-catman      pam,.cat
 ./usr/share/man/cat8/paxctl.0                  man-sysutil-catman      .cat
 ./usr/share/man/cat8/pc532/MAKEDEV.0           man-obsolete            obsolete
@@ -3707,6 +3709,7 @@
 ./usr/share/man/html1/openssl_x509v3_config.html       man-obsolete    obsolete
 ./usr/share/man/html1/page.html                        man-util-htmlman        html
 ./usr/share/man/html1/pagesize.html            man-util-htmlman        html
+./usr/share/man/html1/pamu2fcfg.html           man-util-htmlman        html
 ./usr/share/man/html1/passwd.html              man-util-htmlman        html
 ./usr/share/man/html1/paste.html               man-util-htmlman        html
 ./usr/share/man/html1/patch.html               man-util-htmlman        html
@@ -5933,6 +5936,7 @@
 ./usr/share/man/html8/pam_self.html            man-sysutil-htmlman     pam,html
 ./usr/share/man/html8/pam_skey.html            man-sysutil-htmlman     skey,pam,html
 ./usr/share/man/html8/pam_ssh.html             man-sysutil-htmlman     pam,html
+./usr/share/man/html8/pam_u2f.html             man-sysutil-htmlman     pam,html
 ./usr/share/man/html8/pam_unix.html            man-sysutil-htmlman     pam,html
 ./usr/share/man/html8/paxctl.html              man-sysutil-htmlman     html
 ./usr/share/man/html8/pcictl.html              man-sysutil-htmlman     html
@@ -6635,6 +6639,7 @@
 ./usr/share/man/man1/openssl_x509v3_config.1   man-obsolete            obsolete
 ./usr/share/man/man1/page.1                    man-util-man            .man
 ./usr/share/man/man1/pagesize.1                        man-util-man            .man
+./usr/share/man/man1/pamu2fcfg.1               man-util-man            .man
 ./usr/share/man/man1/passwd.1                  man-util-man            .man
 ./usr/share/man/man1/paste.1                   man-util-man            .man
 ./usr/share/man/man1/patch.1                   man-util-man            .man
@@ -9154,6 +9159,7 @@
 ./usr/share/man/man8/pam_self.8                        man-sysutil-man         .man,pam
 ./usr/share/man/man8/pam_skey.8                        man-sysutil-man         skey,.man,pam
 ./usr/share/man/man8/pam_ssh.8                 man-sysutil-man         .man,pam
+./usr/share/man/man8/pam_u2f.8                 man-sysutil-man         .man,pam
 ./usr/share/man/man8/pam_unix.8                        man-sysutil-man         .man,pam
 ./usr/share/man/man8/paxctl.8                  man-sysutil-man         .man
 ./usr/share/man/man8/pc532/MAKEDEV.8           man-obsolete            obsolete
diff -r 1485c46a9ff4 -r 68f2da05d130 external/bsd/pam-u2f/bin/pamu2fcfg/Makefile
--- a/external/bsd/pam-u2f/bin/pamu2fcfg/Makefile       Mon Nov 02 06:25:24 2020 +0000
+++ b/external/bsd/pam-u2f/bin/pamu2fcfg/Makefile       Mon Nov 02 06:40:11 2020 +0000
@@ -1,6 +1,4 @@
-# $NetBSD: Makefile,v 1.2 2020/03/04 17:32:27 christos Exp $
-
-NOMAN=
+# $NetBSD: Makefile,v 1.3 2020/11/02 06:40:11 khorben Exp $
 
 .include <bsd.own.mk>
 
diff -r 1485c46a9ff4 -r 68f2da05d130 external/bsd/pam-u2f/bin/pamu2fcfg/pamu2fcfg.1
--- /dev/null   Thu Jan 01 00:00:00 1970 +0000
+++ b/external/bsd/pam-u2f/bin/pamu2fcfg/pamu2fcfg.1    Mon Nov 02 06:40:11 2020 +0000
@@ -0,0 +1,103 @@
+'\" t
+.\"     Title: pamu2fcfg
+.\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
+.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
+.\"      Date: 11/01/2020
+.\"    Manual: PAM U2F Configuration Tool
+.\"    Source: pamu2fcfg
+.\"  Language: English
+.\"
+.TH "PAMU2FCFG" "1" "11/01/2020" "pamu2fcfg" "PAM U2F Configuration Tool"
+.\" -----------------------------------------------------------------
+.\" * Define some portability stuff
+.\" -----------------------------------------------------------------
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" http://bugs.debian.org/507673
+.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.ie \n(.g .ds Aq \(aq
+.el       .ds Aq '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
+pamu2fcfg \- Configuration tool for the U2F PAM module\&.
+.SH "SYNOPSIS"
+.sp
+\fBpamu2fcfg\fR [\fIOPTION\fR]\&...
+.SH "DESCRIPTION"
+.sp
+Perform a U2F registration procedure using a connected U2F token and output a configuration line that can be used with the U2F PAM module\&.
+.SH "OPTIONS"
+.PP
+\fB\-d\fR, \fB\-\-debug\fR
+.RS 4
+Print debug information (highly verbose)
+.RE
+.PP
+\fB\-h\fR, \fB\-\-help\fR
+.RS 4
+Print help and exit
+.RE
+.PP
+\fB\-o\fR, \fB\-\-origin\fR=\fISTRING\fR
+.RS 4
+Origin URL to use during registration\&. Defaults to pam://hostname
+.RE
+.PP
+\fB\-i\fR, \fB\-\-appid\fR=\fISTRING\fR
+.RS 4
+Application ID to use during registration\&. Defaults to
+\fBorigin\fR
+.RE
+.PP
+\fB\-r\fR, \fB\-\-resident\fR
+.RS 4
+Generate a resident credential\&. Defaults to off\&.
+.RE
+.PP
+\fB\-t\fR, \fB\-\-type\fR=\fISTRING\fR
+.RS 4
+COSE type to use during registration (ES256 or RS256)\&. Defaults to ES256\&.
+.RE
+.PP
+\fB\-N\fR, \fB\-\-pin\-verification\fR
+.RS 4
+Require PIN verification during authentication\&. Defaults to off\&.
+.RE
+.PP
+\fB\-V\fR, \fB\-\-user\-verification\fR
+.RS 4
+Require user verification during authentication\&. Defaults to off\&.
+.RE
+.sp
+\fB\-\-version\fR: \fBPrint version and exit\fR
+.sp
+Group: user (mutually exclusive)
+.PP
+\fB\-u\fR, \fB\-\-username\fR=\fISTRING\fR
+.RS 4
+The name of the user registering the device\&. Defaults to the current user name
+.RE
+.PP
+\fB\-n\fR, \fB\-\-nouser\fR
+.RS 4
+Print only registration information (keyHandle and public key)\&. Useful for appending
+.RE
+.SH "BUGS"
+.sp
+Report pamu2fcfg bugs in the issue tracker: \m[blue]\fBhttps://github\&.com/Yubico/pam\-u2f/issues\fR\m[]
+.SH "SEE ALSO"
+.sp
+\fBpam_u2f\fR(8), \fBpam\fR(7)
+.sp
+The pam\-u2f home page: \m[blue]\fBhttps://developers\&.yubico\&.com/pam\-u2f/\fR\m[]
+.sp
+YubiKeys can be obtained from Yubico: \m[blue]\fBhttps://www\&.yubico\&.com/\fR\m[]
diff -r 1485c46a9ff4 -r 68f2da05d130 external/bsd/pam-u2f/lib/security/pam-u2f/Makefile
--- a/external/bsd/pam-u2f/lib/security/pam-u2f/Makefile        Mon Nov 02 06:25:24 2020 +0000
+++ b/external/bsd/pam-u2f/lib/security/pam-u2f/Makefile        Mon Nov 02 06:40:11 2020 +0000
@@ -1,6 +1,5 @@
-# $NetBSD: Makefile,v 1.3 2020/03/04 17:32:27 christos Exp $
+# $NetBSD: Makefile,v 1.4 2020/11/02 06:40:11 khorben Exp $
 
-NOMAN=
 .include <bsd.own.mk>
 .PATH: ${NETBSDSRCDIR}/external/bsd/pam-u2f/dist
 
@@ -9,7 +8,7 @@
 
 LIB=   pam_u2f
 SRCS=  pam-u2f.c drop_privs.c util.c b64.c explicit_bzero.c
-#MAN=  pam_u2f.8
+MAN=   pam_u2f.8
 
 COPTS.util.c += -Wno-error=stack-protector
 
diff -r 1485c46a9ff4 -r 68f2da05d130 external/bsd/pam-u2f/lib/security/pam-u2f/pam_u2f.8
--- /dev/null   Thu Jan 01 00:00:00 1970 +0000
+++ b/external/bsd/pam-u2f/lib/security/pam-u2f/pam_u2f.8       Mon Nov 02 06:40:11 2020 +0000
@@ -0,0 +1,167 @@
+'\" t
+.\"     Title: pam_u2f
+.\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
+.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
+.\"      Date: 11/01/2020
+.\"    Manual: PAM U2F Module Manual
+.\"    Source: pam-u2f
+.\"  Language: English
+.\"
+.TH "PAM_U2F" "8" "11/01/2020" "pam\-u2f" "PAM U2F Module Manual"
+.\" -----------------------------------------------------------------
+.\" * Define some portability stuff
+.\" -----------------------------------------------------------------
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" http://bugs.debian.org/507673
+.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.ie \n(.g .ds Aq \(aq
+.el       .ds Aq '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
+pam_u2f \- Module for U2F authentication
+.SH "SYNOPSIS"
+.sp
+\fBpam_u2f\fR [\&...]
+.SH "DESCRIPTION"
+.sp
+The module provides U2F authentication against Yubikeys and other compliant authenticators\&.
+.SH "OPTIONS"
+.PP
+\fBdebug\fR
+.RS 4
+Enables debug output
+.RE
+.PP
+\fBdebug_file\fR
+.RS 4
+Filename to write debugging messages to\&.
+\fBIf this file is missing, nothing will be logged\fR\&. This regular file
+\fBhas to be created by the user\fR
+or
+\fBmust exist and be a regular file\fR
+for anything getting logged to it\&. It is not created by pam\-u2f on purpose (for security considerations)\&. This filename may be alternatively set to "stderr" (default), "stdout", or "syslog"\&.
+.RE
+.PP
+\fBorigin\fR=\fIorigin\fR
+.RS 4
+Set the origin for the U2F authentication procedure\&. If no value is specified, the origin "pam://$HOSTNAME" is used\&.
+.RE
+.PP
+\fBappid\fR=\fIappid\fR
+.RS 4
+Set the application ID for the U2F authentication procedure\&. If no value is specified, the same value used for origin is taken ("pam://$HOSTNAME" if also origin is not specified)\&.
+.RE
+.PP
+\fBauthfile\fR=\fIfile\fR
+.RS 4
+Set the location of the file that holds the mappings of user names to keyHandles and user keys\&. The format is username:keyHandle1,public_key1:keyHandle2,public_key2:\&... the default location of 
the file is $XDG_CONFIG_HOME/Yubico/u2f_keys\&. If the environment variable is not set, $HOME/\&.config/Yubico/u2f_keys is used\&. An individual (per user) file may be configured relative to the 
users\*(Aq home dirs, i\&.e\&. "\&.ssh/u2f_keys"\&.
+.RE
+.PP
+\fBauthpending_file\fR=\fIfile\fR
+.RS 4
+Set the location of the file that is used for touch request notifications\&. This file will be opened when pam\-u2f starts waiting for a user to touch the device, and will be closed when it no 
longer waits for a touch\&. Use inotify to listen on these events, or a more high\-level tool like yubikey\-touch\-detector\&. Default value: /var/run/user/$UID/pam\-u2f\-authpending\&. Set an empty 
value in order to disable this functionality, like so: "authpending_file="\&.
+.RE
+.PP
+\fBnouserok\fR
+.RS 4
+Set to enable authentication attempts to succeed even if the user trying to authenticate is not found inside authfile or if authfile is missing/malformed\&.
+.RE
+.PP
+\fBopenasuser\fR
+.RS 4
+Setuid to the authenticating user when opening the authfile\&. Useful when the user\(cqs home is stored on an NFS volume mounted with the root_squash option (which maps root to nobody which will not 
be able to read the file)\&. Note that after release 1\&.0\&.8 this is done by default when no global authfile or XDG_CONFIG_HOME environment variable has been set\&.
+.RE
+.PP
+\fBalwaysok\fR
+.RS 4
+Set to enable all authentication attempts to succeed (aka presentation mode)\&.
+.RE
+.PP
+\fBmax_devices\fR=\fIn_devices\fR
+.RS 4
+Maximum number of devices allowed per user (default is 24)\&. Devices specified in the authentication file that exceed this value will be ignored\&.
+.RE
+.PP
+\fBinteractive\fR
+.RS 4
+Set to prompt a message and wait before testing the presence of a U2F device\&. Recommended if your device doesn\(cqt have tactile trigger\&.
+.RE
+.PP
+\fB[prompt=your prompt here]\fR
+.RS 4



Home | Main Index | Thread Index | Old Index