Mercurial Repositories > eric / file diff

--- a/src/eric7/Documentation/Source/eric7.Utilities.crypto.py3AES.html	Thu Dec 21 15:46:22 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.Utilities.crypto.py3AES.html	Thu Dec 21 19:50:01 2023 +0100
@@ -171,19 +171,25 @@
 </p>
 <dl>
 
-<dt><i>state</i></dt>
+<dt><i>state</i> (bytearray)</dt>
 <dd>
-state to be changed (bytearray)
+state to be changed
 </dd>
-<dt><i>roundKey</i></dt>
+<dt><i>roundKey</i> (bytearray)</dt>
 <dd>
-key to be used for the modification (bytearray)
+key to be used for the modification
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-modified state (bytearray)
+modified state
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bytearray
 </dd>
 </dl>
 <a NAME="AES.__aes_invMain" ID="AES.__aes_invMain"></a>
@@ -200,23 +206,29 @@
 </p>
 <dl>
 
-<dt><i>state</i></dt>
+<dt><i>state</i> (bytearray)</dt>
 <dd>
-state to be worked on (bytearray)
+state to be worked on
 </dd>
-<dt><i>expandedKey</i></dt>
+<dt><i>expandedKey</i> (bytearray)</dt>
 <dd>
-expanded key to be used (bytearray)
+expanded key to be used
 </dd>
-<dt><i>nbrRounds</i></dt>
+<dt><i>nbrRounds</i> (int)</dt>
 <dd>
-number of rounds to be done (integer)
+number of rounds to be done
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-modified state (bytearray)
+modified state
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bytearray
 </dd>
 </dl>
 <a NAME="AES.__aes_invRound" ID="AES.__aes_invRound"></a>
@@ -229,19 +241,25 @@
 </p>
 <dl>
 
-<dt><i>state</i></dt>
+<dt><i>state</i> (bytearray)</dt>
 <dd>
-state to be worked on (bytearray)
+state to be worked on
 </dd>
-<dt><i>roundKey</i></dt>
+<dt><i>roundKey</i> (bytearray)</dt>
 <dd>
-round key to be used (bytearray)
+round key to be used
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-modified state (bytearray)
+modified state
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bytearray
 </dd>
 </dl>
 <a NAME="AES.__aes_main" ID="AES.__aes_main"></a>
@@ -258,23 +276,29 @@
 </p>
 <dl>
 
-<dt><i>state</i></dt>
+<dt><i>state</i> (bytearray)</dt>
 <dd>
-state to be worked on (bytearray)
+state to be worked on
 </dd>
-<dt><i>expandedKey</i></dt>
+<dt><i>expandedKey</i> (bytearray)</dt>
 <dd>
-expanded key to be used (bytearray)
+expanded key to be used
 </dd>
-<dt><i>nbrRounds</i></dt>
+<dt><i>nbrRounds</i> (int)</dt>
 <dd>
-number of rounds to be done (integer)
+number of rounds to be done
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-modified state (bytearray)
+modified state
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bytearray
 </dd>
 </dl>
 <a NAME="AES.__aes_round" ID="AES.__aes_round"></a>
@@ -287,19 +311,25 @@
 </p>
 <dl>
 
-<dt><i>state</i></dt>
+<dt><i>state</i> (bytearray)</dt>
 <dd>
-state to be worked on (bytearray)
+state to be worked on
 </dd>
-<dt><i>roundKey</i></dt>
+<dt><i>roundKey</i> (bytearray)</dt>
 <dd>
-round key to be used (bytearray)
+round key to be used
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-modified state (bytearray)
+modified state
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bytearray
 </dd>
 </dl>
 <a NAME="AES.__core" ID="AES.__core"></a>
@@ -311,19 +341,25 @@
 </p>
 <dl>
 
-<dt><i>data</i></dt>
+<dt><i>data</i> (bytearray)</dt>
 <dd>
-data to operate on (bytearray)
+data to operate on
 </dd>
-<dt><i>iteration</i></dt>
+<dt><i>iteration</i> (int)</dt>
 <dd>
-iteration counter (integer)
+iteration counter
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-modified data (bytearray)
+modified data
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bytearray
 </dd>
 </dl>
 <a NAME="AES.__createRoundKey" ID="AES.__createRoundKey"></a>
@@ -335,19 +371,25 @@
 </p>
 <dl>
 
-<dt><i>expandedKey</i></dt>
+<dt><i>expandedKey</i> (bytearray)</dt>
 <dd>
-expanded key to be used (bytearray)
+expanded key to be used
 </dd>
-<dt><i>roundKeyPointer</i></dt>
+<dt><i>roundKeyPointer</i> (int)</dt>
 <dd>
-position within the expanded key (integer)
+position within the expanded key
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-round key (bytearray)
+round key
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bytearray
 </dd>
 </dl>
 <a NAME="AES.__expandKey" ID="AES.__expandKey"></a>
@@ -362,23 +404,29 @@
 </p>
 <dl>
 
-<dt><i>key</i></dt>
+<dt><i>key</i> (bytes or bytearray)</dt>
 <dd>
-key to be expanded (bytes or bytearray)
+key to be expanded
 </dd>
-<dt><i>size</i></dt>
+<dt><i>size</i> (int)</dt>
 <dd>
 size of the key in bytes (16, 24 or 32)
 </dd>
-<dt><i>expandedKeySize</i></dt>
+<dt><i>expandedKeySize</i> (int)</dt>
 <dd>
-size of the expanded key (integer)
+size of the expanded key
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-expanded key (bytearray)
+expanded key
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bytearray
 </dd>
 </dl>
 <a NAME="AES.__galois_multiplication" ID="AES.__galois_multiplication"></a>
@@ -391,19 +439,25 @@
 </p>
 <dl>
 
-<dt><i>a</i></dt>
+<dt><i>a</i> (bytes)</dt>
 <dd>
-first factor (byte)
+first factor
 </dd>
-<dt><i>b</i></dt>
+<dt><i>b</i> (bytes)</dt>
 <dd>
-second factor (byte)
+second factor
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-result (byte)
+result
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bytes
 </dd>
 </dl>
 <a NAME="AES.__getRconValue" ID="AES.__getRconValue"></a>
@@ -415,15 +469,21 @@
 </p>
 <dl>
 
-<dt><i>num</i></dt>
+<dt><i>num</i> (int)</dt>
 <dd>
-position of the value (integer)
+position of the value
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-Rcon value (integer)
+Rcon value
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+int
 </dd>
 </dl>
 <a NAME="AES.__getSBoxInvert" ID="AES.__getSBoxInvert"></a>
@@ -435,15 +495,21 @@
 </p>
 <dl>
 
-<dt><i>num</i></dt>
+<dt><i>num</i> (int)</dt>
 <dd>
-position of the value (integer)
+position of the value
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-value of the Inverted S-Box (integer)
+value of the Inverted S-Box
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+int
 </dd>
 </dl>
 <a NAME="AES.__getSBoxValue" ID="AES.__getSBoxValue"></a>
@@ -455,15 +521,21 @@
 </p>
 <dl>
 
-<dt><i>num</i></dt>
+<dt><i>num</i> (int)</dt>
 <dd>
-position of the value (integer)
+position of the value
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-value of the S-Box (integer)
+value of the S-Box
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+int
 </dd>
 </dl>
 <a NAME="AES.__mixColumn" ID="AES.__mixColumn"></a>
@@ -476,19 +548,25 @@
 </p>
 <dl>
 
-<dt><i>column</i></dt>
+<dt><i>column</i> (bytearray)</dt>
 <dd>
-column to be worked on (bytearray)
+column to be worked on
 </dd>
-<dt><i>isInv</i></dt>
+<dt><i>isInv</i> (bool)</dt>
 <dd>
-flag indicating an inverse operation (boolean)
+flag indicating an inverse operation
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-modified column (bytearray)
+modified column
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bytearray
 </dd>
 </dl>
 <a NAME="AES.__mixColumns" ID="AES.__mixColumns"></a>
@@ -500,19 +578,25 @@
 </p>
 <dl>
 
-<dt><i>state</i></dt>
+<dt><i>state</i> (bytearray)</dt>
 <dd>
-state to be worked on (bytearray)
+state to be worked on
 </dd>
-<dt><i>isInv</i></dt>
+<dt><i>isInv</i> (bool)</dt>
 <dd>
-flag indicating an inverse operation (boolean)
+flag indicating an inverse operation
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-modified state (bytearray)
+modified state
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bytearray
 </dd>
 </dl>
 <a NAME="AES.__rotate" ID="AES.__rotate"></a>
@@ -528,15 +612,21 @@
 </p>
 <dl>
 
-<dt><i>data</i></dt>
+<dt><i>data</i> (bytearray)</dt>
 <dd>
-data of size 4 (bytearray)
+data of size 4
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-rotated data (bytearray)
+rotated data
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bytearray
 </dd>
 </dl>
 <a NAME="AES.__shiftRow" ID="AES.__shiftRow"></a>
@@ -548,27 +638,33 @@
 </p>
 <dl>
 
-<dt><i>state</i></dt>
+<dt><i>state</i> (bytearray)</dt>
 <dd>
-state to be worked on (bytearray)
+state to be worked on
 </dd>
-<dt><i>statePointer</i></dt>
+<dt><i>statePointer</i> (int)</dt>
 <dd>
-index into the state (integer)
+index into the state
 </dd>
-<dt><i>nbr</i></dt>
+<dt><i>nbr</i> (int)</dt>
 <dd>
-number of positions to shift (integer)
+number of positions to shift
 </dd>
-<dt><i>isInv</i></dt>
+<dt><i>isInv</i> (bool)</dt>
 <dd>
-flag indicating an inverse operation (boolean)
+flag indicating an inverse operation
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-modified state (bytearray)
+modified state
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bytearray
 </dd>
 </dl>
 <a NAME="AES.__shiftRows" ID="AES.__shiftRows"></a>
@@ -581,19 +677,25 @@
 </p>
 <dl>
 
-<dt><i>state</i></dt>
+<dt><i>state</i> (bytearray)</dt>
 <dd>
-state to be worked on (bytearray)
+state to be worked on
 </dd>
-<dt><i>isInv</i></dt>
+<dt><i>isInv</i> (bool)</dt>
 <dd>
-flag indicating an inverse operation (boolean)
+flag indicating an inverse operation
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-modified state (bytearray)
+modified state
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bytearray
 </dd>
 </dl>
 <a NAME="AES.__subBytes" ID="AES.__subBytes"></a>
@@ -606,19 +708,25 @@
 </p>
 <dl>
 
-<dt><i>state</i></dt>
+<dt><i>state</i> (bytearray)</dt>
 <dd>
-state to be worked on (bytearray)
+state to be worked on
 </dd>
-<dt><i>isInv</i></dt>
+<dt><i>isInv</i> (bool)</dt>
 <dd>
-flag indicating an inverse operation (boolean)
+flag indicating an inverse operation
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-modified state (bytearray)
+modified state
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bytearray
 </dd>
 </dl>
 <a NAME="AES.decrypt" ID="AES.decrypt"></a>
@@ -631,15 +739,15 @@
 </p>
 <dl>
 
-<dt><i>iput</i></dt>
+<dt><i>iput</i> (bytearray)</dt>
 <dd>
-input data (bytearray)
+input data
 </dd>
-<dt><i>key</i></dt>
+<dt><i>key</i> (bytes or bytearray)</dt>
 <dd>
-key to be used (bytes or bytearray)
+key to be used
 </dd>
-<dt><i>size</i></dt>
+<dt><i>size</i> (int)</dt>
 <dd>
 key size (16, 24 or 32)
 </dd>
@@ -647,7 +755,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-decrypted data (bytes)
+decrypted data
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bytes
 </dd>
 </dl>
 <dl>
@@ -667,15 +781,15 @@
 </p>
 <dl>
 
-<dt><i>iput</i></dt>
+<dt><i>iput</i> (bytearray)</dt>
 <dd>
-input data (bytearray)
+input data
 </dd>
-<dt><i>key</i></dt>
+<dt><i>key</i> (bytes or bytearray)</dt>
 <dd>
-key to be used (bytes or bytearray)
+key to be used
 </dd>
-<dt><i>size</i></dt>
+<dt><i>size</i> (int)</dt>
 <dd>
 key size (16, 24 or 32)
 </dd>
@@ -683,7 +797,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-encrypted data (bytes)
+encrypted data
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bytes
 </dd>
 </dl>
 <dl>
@@ -746,19 +866,19 @@
 </p>
 <dl>
 
-<dt><i>inputData</i></dt>
+<dt><i>inputData</i> (bytes)</dt>
 <dd>
-input data (bytes)
+input data
 </dd>
-<dt><i>start</i></dt>
+<dt><i>start</i> (int)</dt>
 <dd>
-start index (integer)
+start index
 </dd>
-<dt><i>end</i></dt>
+<dt><i>end</i> (int)</dt>
 <dd>
-end index (integer)
+end index
 </dd>
-<dt><i>mode</i></dt>
+<dt><i>mode</i> (int)</dt>
 <dd>
 mode of operation (0, 1, 2)
 </dd>
@@ -766,7 +886,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-extracted bytes (bytearray)
+extracted bytes
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bytearray
 </dd>
 </dl>
 <a NAME="AESModeOfOperation.decrypt" ID="AESModeOfOperation.decrypt"></a>
@@ -778,36 +904,41 @@
 </p>
 <dl>
 
-<dt><i>cipherIn</i></dt>
+<dt><i>cipherIn</i> (bytes)</dt>
 <dd>
-data to be decrypted (bytes)
+data to be decrypted
 </dd>
-<dt><i>originalsize</i></dt>
+<dt><i>originalsize</i> (int)</dt>
 <dd>
 unencrypted string length (required for CBC)
-            (integer)
 </dd>
-<dt><i>mode</i></dt>
+<dt><i>mode</i> (int)</dt>
 <dd>
 mode of operation (0, 1 or 2)
 </dd>
-<dt><i>key</i></dt>
+<dt><i>key</i> (bytes)</dt>
 <dd>
-key to be used (bytes)
+key to be used
 </dd>
-<dt><i>size</i></dt>
+<dt><i>size</i> (int)</dt>
 <dd>
 length of the key (16, 24 or 32)
 </dd>
-<dt><i>IV</i></dt>
+<dt><i>IV</i> (bytearray)</dt>
 <dd>
-initialisation vector (bytearray)
+initialisation vector
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-decrypted data (bytes)
+decrypted data
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bytes
 </dd>
 </dl>
 <dl>
@@ -826,32 +957,38 @@
 </p>
 <dl>
 
-<dt><i>inputData</i></dt>
+<dt><i>inputData</i> (bytes)</dt>
 <dd>
-data to be encrypted (bytes)
+data to be encrypted
 </dd>
-<dt><i>mode</i></dt>
+<dt><i>mode</i> (int)</dt>
 <dd>
 mode of operation (0, 1 or 2)
 </dd>
-<dt><i>key</i></dt>
+<dt><i>key</i> (bytes)</dt>
 <dd>
-key to be used (bytes)
+key to be used
 </dd>
-<dt><i>size</i></dt>
+<dt><i>size</i> (int)</dt>
 <dd>
 length of the key (16, 24 or 32)
 </dd>
-<dt><i>IV</i></dt>
+<dt><i>IV</i> (bytearray)</dt>
 <dd>
-initialisation vector (bytearray)
+initialisation vector
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
 tuple with mode of operation, length of the input data and
-            the encrypted data (integer, integer, bytes)
+            the encrypted data
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (int, int, bytes)
 </dd>
 </dl>
 <dl>
@@ -873,15 +1010,21 @@
 </p>
 <dl>
 
-<dt><i>b</i></dt>
+<dt><i>b</i> (bytes)</dt>
 <dd>
-data to be padded (bytes)
+data to be padded
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-padded data (bytes)
+padded data
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bytes
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -896,16 +1039,15 @@
 </p>
 <dl>
 
-<dt><i>key</i></dt>
+<dt><i>key</i> (bytes)</dt>
 <dd>
-key to be used for decryption (bytes)
+key to be used for decryption
 </dd>
-<dt><i>data</i></dt>
+<dt><i>data</i> (bytes)</dt>
 <dd>
 data to be decrypted (with initialization vector prepended)
-        (bytes)
 </dd>
-<dt><i>mode</i></dt>
+<dt><i>mode</i> (int)</dt>
 <dd>
 mode of operations (0, 1 or 2)
 </dd>
@@ -913,7 +1055,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-decrypted data (bytes)
+decrypted data
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bytes
 </dd>
 </dl>
 <dl>
@@ -935,15 +1083,15 @@
 </p>
 <dl>
 
-<dt><i>key</i></dt>
+<dt><i>key</i> (bytes)</dt>
 <dd>
-key to be used for encryption (bytes)
+key to be used for encryption
 </dd>
-<dt><i>data</i></dt>
+<dt><i>data</i> (bytes)</dt>
 <dd>
-data to be encrypted (bytes)
+data to be encrypted
 </dd>
-<dt><i>mode</i></dt>
+<dt><i>mode</i> (int)</dt>
 <dd>
 mode of operations (0, 1 or 2)
 </dd>
@@ -951,7 +1099,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-encrypted data prepended with the initialization vector (bytes)
+encrypted data prepended with the initialization vector
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bytes
 </dd>
 </dl>
 <dl>
@@ -973,15 +1127,21 @@
 </p>
 <dl>
 
-<dt><i>b</i></dt>
+<dt><i>b</i> (bytes)</dt>
 <dd>
-data to be stripped (bytes)
+data to be stripped
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-stripped data (bytes)
+stripped data
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bytes
 </dd>
 </dl>
 <dl>