src/eric7/Documentation/Source/eric7.Utilities.crypto.py3PBKDF2.html

branch
eric7
changeset 10433
328f3ec4b77a
parent 9209
b99e7fd55fd3
child 10479
856476537696
diff -r 2fe91fe443dd -r 328f3ec4b77a src/eric7/Documentation/Source/eric7.Utilities.crypto.py3PBKDF2.html
--- a/src/eric7/Documentation/Source/eric7.Utilities.crypto.py3PBKDF2.html	Thu Dec 21 15:46:22 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.Utilities.crypto.py3PBKDF2.html	Thu Dec 21 19:50:01 2023 +0100
@@ -57,27 +57,33 @@
 </p>
 <dl>
 
-<dt><i>password</i></dt>
+<dt><i>password</i> (str)</dt>
 <dd>
-clear text password (string)
+clear text password
 </dd>
-<dt><i>digestMod</i></dt>
+<dt><i>digestMod</i> (function)</dt>
 <dd>
 hash function
 </dd>
-<dt><i>iterations</i></dt>
+<dt><i>iterations</i> (int)</dt>
 <dd>
-number of times hash function should be applied (integer)
+number of times hash function should be applied
 </dd>
-<dt><i>saltSize</i></dt>
+<dt><i>saltSize</i> (int)</dt>
 <dd>
-size of the salt (integer)
+size of the salt
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-hashed password entry according to PBKDF2 specification (string)
+hashed password entry according to PBKDF2 specification
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -92,28 +98,33 @@
 </p>
 <dl>
 
-<dt><i>password</i></dt>
+<dt><i>password</i> (str)</dt>
 <dd>
-clear text password (string)
+clear text password
 </dd>
-<dt><i>digestMod</i></dt>
+<dt><i>digestMod</i> (function)</dt>
 <dd>
 hash function
 </dd>
-<dt><i>iterations</i></dt>
+<dt><i>iterations</i> (int)</dt>
 <dd>
-number of times hash function should be applied (integer)
+number of times hash function should be applied
 </dd>
-<dt><i>saltSize</i></dt>
+<dt><i>saltSize</i> (int)</dt>
 <dd>
-size of the salt (integer)
+size of the salt
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-tuple of digestname (string), number of iterations (integer),
-        salt (bytes) and hashed password (bytes)
+tuple of digestname, number of iterations, salt and hashed password
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (str, int, bytes, bytes)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -128,19 +139,19 @@
 </p>
 <dl>
 
-<dt><i>password</i></dt>
+<dt><i>password</i> (bytes)</dt>
 <dd>
-clear text password (bytes)
+clear text password
 </dd>
-<dt><i>salt</i></dt>
+<dt><i>salt</i> (bytes)</dt>
 <dd>
-salt value (bytes)
+salt value
 </dd>
-<dt><i>iterations</i></dt>
+<dt><i>iterations</i> (int)</dt>
 <dd>
-number of times hash function should be applied (integer)
+number of times hash function should be applied
 </dd>
-<dt><i>digestMod</i></dt>
+<dt><i>digestMod</i> (function)</dt>
 <dd>
 hash function
 </dd>
@@ -148,7 +159,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-hashed password (bytes)
+hashed password
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bytes
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -163,20 +180,26 @@
 </p>
 <dl>
 
-<dt><i>password</i></dt>
+<dt><i>password</i> (str)</dt>
 <dd>
-clear text password (string)
+clear text password
 </dd>
-<dt><i>hashParameters</i></dt>
+<dt><i>hashParameters</i> (str)</dt>
 <dd>
 hash parameters in the form
-        'digestmod$iterations$salt' (string)
+        'digestmod$iterations$salt'
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-hashed password (bytes)
+hashed password
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bytes
 </dd>
 </dl>
 <dl>
@@ -199,21 +222,27 @@
 </p>
 <dl>
 
-<dt><i>password</i></dt>
+<dt><i>password</i> (str)</dt>
 <dd>
-clear text password (string)
+clear text password
 </dd>
-<dt><i>pwHash</i></dt>
+<dt><i>pwHash</i> (str)</dt>
 <dd>
 hash encoded password in the form
         'digestmod$iterations$salt$hashed_password' as produced by the
-        hashPassword function (string)
+        hashPassword function
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating a successfull verification (boolean)
+flag indicating a successfull verification
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <dl>

eric ide

mercurial