summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTomas Mraz <tmraz@fedoraproject.org>2021-04-01 17:34:52 +0200
committerTomas Mraz <tmraz@fedoraproject.org>2021-04-01 17:34:52 +0200
commit847716b053a8ce7bdf610819acb13772d1c981c3 (patch)
tree89e182631b883849651e8b35bf68d38feefeab79
parent42c4c7c880f73e0cc0a64af719fd2b3a3e07b9b2 (diff)
downloadlibpwquality-git-847716b053a8ce7bdf610819acb13772d1c981c3.tar.gz
Document the range of allowed entropy bits when generating passwords
-rw-r--r--doc/man/pwmake.1.pod3
-rw-r--r--doc/man/pwquality.3.pod4
2 files changed, 6 insertions, 1 deletions
diff --git a/doc/man/pwmake.1.pod b/doc/man/pwmake.1.pod
index 33efe9a..22e0939 100644
--- a/doc/man/pwmake.1.pod
+++ b/doc/man/pwmake.1.pod
@@ -25,6 +25,9 @@ the attacker might obtain the direct access to the password hash or the
password is used as an encryption key I<80> to I<128> bits should be
used depending on your level of paranoia.
+Any I<entropy-bits> value outside of the I<56> to I<256> bits range will be
+adjusted to fit within the allowed range.
+
=head1 OPTIONS
The first and only argument is the number of bits of entropy used to generate
diff --git a/doc/man/pwquality.3.pod b/doc/man/pwquality.3.pod
index 8e4ab79..2604845 100644
--- a/doc/man/pwquality.3.pod
+++ b/doc/man/pwquality.3.pod
@@ -61,7 +61,9 @@ manipulate the I<pwq> settings object.
The pwquality_generate() function generates a random password of
I<entropy_bits> entropy and checks it according to the settings. The
-I<*password> is allocated on the heap by the library.
+I<*password> is allocated on the heap by the library. The I<entropy_bits>
+value is adjusted to fit within the B<PWQ_MIN_ENTROPY_BITS> and
+B<PWQ_MAX_ENTROPY_BITS> range before generating a password.
The pwquality_check() function checks the I<password> according to the
settings. It returns either score (value between 0 and 100), negative