Mercurial Repositories > eric / file diff

diff: src/eric7/Documentation/Source/eric7.EricUtilities.crypto.__init__.html

src/eric7/Documentation/Source/eric7.EricUtilities.crypto.__init__.html

branch
eric7
changeset 10928
46651e194fbe
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/eric7/Documentation/Source/eric7.EricUtilities.crypto.__init__.html	Thu Sep 26 15:49:36 2024 +0200
@@ -0,0 +1,421 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric7.EricUtilities.crypto.__init__</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>eric7.EricUtilities.crypto.__init__</h1>
+<p>
+Package implementing cryptography related functionality.
+</p>
+
+<h3>Global Attributes</h3>
+<table>
+<tr><td>CryptoMarker</td></tr>
+<tr><td>Delimiter</td></tr>
+<tr><td>EncodeMarker</td></tr>
+<tr><td>MainPassword</td></tr>
+</table>
+
+<h3>Classes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<h3>Functions</h3>
+<table>
+<tr>
+<td><a href="#__getMainPassword">__getMainPassword</a></td>
+<td>Private module function to get the password from the user.</td>
+</tr>
+<tr>
+<td><a href="#changeRememberedMain">changeRememberedMain</a></td>
+<td>Module function to change the remembered main password.</td>
+</tr>
+<tr>
+<td><a href="#dataDecrypt">dataDecrypt</a></td>
+<td>Module function to decrypt a password.</td>
+</tr>
+<tr>
+<td><a href="#dataEncrypt">dataEncrypt</a></td>
+<td>Module function to encrypt a password.</td>
+</tr>
+<tr>
+<td><a href="#pwConvert">pwConvert</a></td>
+<td>Module function to convert a plaintext password to the encoded form or vice versa.</td>
+</tr>
+<tr>
+<td><a href="#pwDecode">pwDecode</a></td>
+<td>Module function to decode a password.</td>
+</tr>
+<tr>
+<td><a href="#pwDecrypt">pwDecrypt</a></td>
+<td>Module function to decrypt a password.</td>
+</tr>
+<tr>
+<td><a href="#pwEncode">pwEncode</a></td>
+<td>Module function to encode a password.</td>
+</tr>
+<tr>
+<td><a href="#pwEncrypt">pwEncrypt</a></td>
+<td>Module function to encrypt a password.</td>
+</tr>
+<tr>
+<td><a href="#pwRecode">pwRecode</a></td>
+<td>Module function to re-encode a password.</td>
+</tr>
+<tr>
+<td><a href="#pwReencrypt">pwReencrypt</a></td>
+<td>Module function to re-encrypt a password.</td>
+</tr>
+</table>
+
+<hr />
+<hr />
+<a NAME="__getMainPassword" ID="__getMainPassword"></a>
+<h2>__getMainPassword</h2>
+<b>__getMainPassword</b>(<i></i>)
+<p>
+    Private module function to get the password from the user.
+</p>
+
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="changeRememberedMain" ID="changeRememberedMain"></a>
+<h2>changeRememberedMain</h2>
+<b>changeRememberedMain</b>(<i>newPassword</i>)
+<p>
+    Module function to change the remembered main password.
+</p>
+
+<dl>
+
+<dt><i>newPassword</i> (str)</dt>
+<dd>
+new password to be used
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="dataDecrypt" ID="dataDecrypt"></a>
+<h2>dataDecrypt</h2>
+<b>dataDecrypt</b>(<i>edata, password, keyLength=32</i>)
+<p>
+    Module function to decrypt a password.
+</p>
+
+<dl>
+
+<dt><i>edata</i> (str)</dt>
+<dd>
+hashed data to decrypt
+</dd>
+<dt><i>password</i> (str)</dt>
+<dd>
+password to be used for decryption
+</dd>
+<dt><i>keyLength</i> (int)</dt>
+<dd>
+length of the key to be generated for decryption (16, 24 or 32)
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+decrypted data (bytes) and flag indicating success
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="dataEncrypt" ID="dataEncrypt"></a>
+<h2>dataEncrypt</h2>
+<b>dataEncrypt</b>(<i>data, password, keyLength=32, hashIterations=10000</i>)
+<p>
+    Module function to encrypt a password.
+</p>
+
+<dl>
+
+<dt><i>data</i> (bytes)</dt>
+<dd>
+data to encrypt
+</dd>
+<dt><i>password</i> (str)</dt>
+<dd>
+password to be used for encryption
+</dd>
+<dt><i>keyLength</i> (int)</dt>
+<dd>
+length of the key to be generated for encryption (16, 24 or 32)
+</dd>
+<dt><i>hashIterations</i> (int)</dt>
+<dd>
+number of hashes to be applied to the password for
+        generating the encryption key
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+encrypted data (bytes) and flag indicating success
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="pwConvert" ID="pwConvert"></a>
+<h2>pwConvert</h2>
+<b>pwConvert</b>(<i>pw, encode=True</i>)
+<p>
+    Module function to convert a plaintext password to the encoded form or
+    vice versa.
+</p>
+<p>
+    If there is an error, an empty code is returned for the encode function
+    or the given encoded password for the decode function.
+</p>
+
+<dl>
+
+<dt><i>pw</i> (str)</dt>
+<dd>
+password to encode
+</dd>
+<dt><i>encode</i> (bool)</dt>
+<dd>
+flag indicating an encode or decode function
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+encoded or decoded password
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="pwDecode" ID="pwDecode"></a>
+<h2>pwDecode</h2>
+<b>pwDecode</b>(<i>epw</i>)
+<p>
+    Module function to decode a password.
+</p>
+
+<dl>
+
+<dt><i>epw</i> (str)</dt>
+<dd>
+encoded password to decode
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+decoded password
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="pwDecrypt" ID="pwDecrypt"></a>
+<h2>pwDecrypt</h2>
+<b>pwDecrypt</b>(<i>epw, mainPW=None</i>)
+<p>
+    Module function to decrypt a password.
+</p>
+
+<dl>
+
+<dt><i>epw</i> (str)</dt>
+<dd>
+hashed password to decrypt
+</dd>
+<dt><i>mainPW</i> (str)</dt>
+<dd>
+password to be used for decryption
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+decrypted password (string) and flag indicating success
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="pwEncode" ID="pwEncode"></a>
+<h2>pwEncode</h2>
+<b>pwEncode</b>(<i>pw</i>)
+<p>
+    Module function to encode a password.
+</p>
+
+<dl>
+
+<dt><i>pw</i> (str)</dt>
+<dd>
+password to encode
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+encoded password
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="pwEncrypt" ID="pwEncrypt"></a>
+<h2>pwEncrypt</h2>
+<b>pwEncrypt</b>(<i>pw, mainPW=None</i>)
+<p>
+    Module function to encrypt a password.
+</p>
+
+<dl>
+
+<dt><i>pw</i> (str)</dt>
+<dd>
+password to encrypt
+</dd>
+<dt><i>mainPW</i> (str)</dt>
+<dd>
+password to be used for encryption
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+encrypted password (string) and flag indicating success
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="pwRecode" ID="pwRecode"></a>
+<h2>pwRecode</h2>
+<b>pwRecode</b>(<i>epw, oldPassword, newPassword</i>)
+<p>
+    Module function to re-encode a password.
+</p>
+<p>
+    In case of an error the encoded password is returned unchanged.
+</p>
+
+<dl>
+
+<dt><i>epw</i> (str)</dt>
+<dd>
+encoded password to re-encode
+</dd>
+<dt><i>oldPassword</i> (str)</dt>
+<dd>
+password used to encode
+</dd>
+<dt><i>newPassword</i> (str)</dt>
+<dd>
+new password to be used
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+encoded password
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="pwReencrypt" ID="pwReencrypt"></a>
+<h2>pwReencrypt</h2>
+<b>pwReencrypt</b>(<i>epw, oldPassword, newPassword</i>)
+<p>
+    Module function to re-encrypt a password.
+</p>
+
+<dl>
+
+<dt><i>epw</i> (str)</dt>
+<dd>
+hashed password to re-encrypt
+</dd>
+<dt><i>oldPassword</i> (str)</dt>
+<dd>
+password used to encrypt
+</dd>
+<dt><i>newPassword</i> (str)</dt>
+<dd>
+new password to be used
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+encrypted password (string) and flag indicating success
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>

Mercurial Repository: eric

eric ide

mercurial