summaryrefslogtreecommitdiff
path: root/contrib/pam_modules/pam_passwdqc/pwqgen.1
diff options
context:
space:
mode:
Diffstat (limited to 'contrib/pam_modules/pam_passwdqc/pwqgen.1')
-rw-r--r--contrib/pam_modules/pam_passwdqc/pwqgen.186
1 files changed, 86 insertions, 0 deletions
diff --git a/contrib/pam_modules/pam_passwdqc/pwqgen.1 b/contrib/pam_modules/pam_passwdqc/pwqgen.1
new file mode 100644
index 000000000000..50efe469a6cc
--- /dev/null
+++ b/contrib/pam_modules/pam_passwdqc/pwqgen.1
@@ -0,0 +1,86 @@
+.\" Copyright (c) 2009 Dmitry V. Levin
+.\" All rights reserved.
+.\" Copyright (c) 2019 Solar Designer
+.\" All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.Dd March 10, 2021
+.Dt PWQGEN 1
+.Os "Openwall Project"
+.Sh NAME
+.Nm pwqgen
+.Nd Generate quality controllable random passphrase
+.Sh SYNOPSIS
+.Nm Op Ar options
+.Sh DESCRIPTION
+The
+.Nm
+program generates a random passphrase using the libpasswdqc library.
+Strength of the generated passphrase depends on the amount of randomness
+read from
+.Pa /dev/urandom .
+.Sh OPTIONS
+.Bl -tag -width indent
+.It Cm random Ns = Ns Ar N
+.Pq default: Cm random Ns = Ns 47
+The size of randomly-generated passphrase in bits (24 to 136).
+.It Cm config Ns = Ns Ar FILE
+Load config
+.Ar FILE
+in the
+.Cm passwdqc.conf
+format. This file may define any options described in
+.Xr passwdqc.conf 5 , but only the
+.Cm random
+and
+.Cm config
+options are honored by
+.Nm .
+.It Cm --version
+Output
+.Nm
+program version and exit.
+.It Cm -h , --help
+Output
+.Nm
+help text and exit.
+.El
+.Sh EXIT STATUS
+.Nm
+exits with non-zero status when it encounters invalid config file,
+invalid option, invalid parameter value, when it fails to obtain enough
+randomness, and in any case when it fails to generate a passphrase.
+.Sh FILES
+.Pa /etc/passwdqc.conf
+(not read unless this suggested file location is specified with the
+.Cm config=/etc/passwdqc.conf
+option).
+.Sh SEE ALSO
+.Xr pwqcheck 1 ,
+.Xr libpasswdqc 3 ,
+.Xr urandom 4 ,
+.Xr passwdqc.conf 5 ,
+.Xr pam_passwdqc 8 .
+.Pp
+https://www.openwall.com/passwdqc/
+.Sh AUTHORS
+The pam_passwdqc module was written for Openwall GNU/*/Linux by Solar Designer.
+The
+.Nm
+program was originally written for ALT GNU/*/Linux by Dmitry V. Levin,
+indirectly reusing code from pam_passwdqc (via libpasswdqc).
+This manual page was written for Openwall GNU/*/Linux by Dmitry V. Levin.