From 51d168019f1420b0d025f825abf17f25287cf0d9 Mon Sep 17 00:00:00 2001 From: Arthur Schiwon Date: Wed, 22 Jan 2020 17:45:27 +0100 Subject: [PATCH] extended documentation Signed-off-by: Arthur Schiwon --- config/config.sample.php | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/config/config.sample.php b/config/config.sample.php index 0daa0f9310..e1c6208710 100644 --- a/config/config.sample.php +++ b/config/config.sample.php @@ -1442,19 +1442,25 @@ $CONFIG = array( */ /** - * The allowed maximum memory to be used by the algorithm for computing a hash. + * The allowed maximum memory in KiB to be used by the algorithm for computing a + * hash. The smallest possible value is 8. Values that undershoot the minimum + * will be ignored in favor of the default. */ 'hashingMemoryCost' => PASSWORD_ARGON2_DEFAULT_MEMORY_COST, /** - * The allowed maximum time that can be used by the algorithm for computing a - * hash. + * The allowed maximum time in seconds that can be used by the algorithm for + * computing a hash. The value must be an integer, and the minimum value is 1. + * Values that undershoot the minimum will be ignored in favor of the default. */ 'hashingTimeCost' => PASSWORD_ARGON2_DEFAULT_TIME_COST, /** * The allowed number of CPU threads that can be used by the algorithm for - * computing a hash. + * computing a hash. The value must be an integer, and the minimum value is 1. + * Rationally it does not help to provide a number higher than the available + * threads on the machine. Values that undershoot the minimum will be ignored + * in favor of the default. */ 'hashingThreads' => PASSWORD_ARGON2_DEFAULT_THREADS,