Update documentation

Crypto-TII · Nov 27, 2023 · 7d0ce68 · 7d0ce68
1 parent d3fad15
commit 7d0ce68
Show file tree

Hide file tree

Showing 265 changed files with 75,834 additions and 16,735 deletions.
diff --git a/docs/build/html/.buildinfo b/docs/build/html/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 6d848c87a72724c8c4808ff7e1d931a1
+config: 08a53bd5d60dd2e28390fe56d9e51a12
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/build/html/_sources/cipher_modules/graph_generator.rst.txt b/docs/build/html/_sources/cipher_modules/graph_generator.rst.txt
@@ -0,0 +1,10 @@
+---------------
+Graph generator
+---------------
+
+.. automodule:: cipher_modules.graph_generator
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
diff --git a/docs/build/html/_sources/cipher_modules/inverse_cipher.rst.txt b/docs/build/html/_sources/cipher_modules/inverse_cipher.rst.txt
@@ -0,0 +1,10 @@
+--------------
+Inverse cipher
+--------------
+
+.. automodule:: cipher_modules.inverse_cipher
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
diff --git a/...l/_sources/cipher_modules/models/cp/cp_models/cp_xor_differential_model.rst.txt b/...l/_sources/cipher_modules/models/cp/cp_models/cp_xor_differential_model.rst.txt
@@ -0,0 +1,10 @@
+-------------------------
+Cp xor differential model
+-------------------------
+
+.. automodule:: cipher_modules.models.cp.cp_models.cp_xor_differential_model
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
diff --git a/...milp_models/milp_bitwise_deterministic_truncated_xor_differential_model.rst.txt b/...milp_models/milp_bitwise_deterministic_truncated_xor_differential_model.rst.txt
@@ -0,0 +1,10 @@
+-----------------------------------------------------------
+Milp bitwise deterministic truncated xor differential model
+-----------------------------------------------------------
+
+.. automodule:: cipher_modules.models.milp.milp_models.milp_bitwise_deterministic_truncated_xor_differential_model
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
diff --git a/.../models/milp/milp_models/milp_bitwise_impossible_xor_differential_model.rst.txt b/.../models/milp/milp_models/milp_bitwise_impossible_xor_differential_model.rst.txt
@@ -0,0 +1,10 @@
+----------------------------------------------
+Milp bitwise impossible xor differential model
+----------------------------------------------
+
+.. automodule:: cipher_modules.models.milp.milp_models.milp_bitwise_impossible_xor_differential_model
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
diff --git a/...ilp_models/milp_wordwise_deterministic_truncated_xor_differential_model.rst.txt b/...ilp_models/milp_wordwise_deterministic_truncated_xor_differential_model.rst.txt
@@ -0,0 +1,10 @@
+------------------------------------------------------------
+Milp wordwise deterministic truncated xor differential model
+------------------------------------------------------------
+
+.. automodule:: cipher_modules.models.milp.milp_models.milp_wordwise_deterministic_truncated_xor_differential_model
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
diff --git a/...models/milp/milp_models/milp_wordwise_impossible_xor_differential_model.rst.txt b/...models/milp/milp_models/milp_wordwise_impossible_xor_differential_model.rst.txt
@@ -0,0 +1,10 @@
+-----------------------------------------------
+Milp wordwise impossible xor differential model
+-----------------------------------------------
+
+.. automodule:: cipher_modules.models.milp.milp_models.milp_wordwise_impossible_xor_differential_model
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
diff --git a/...s/milp/utils/dictionary_containing_truncated_input_pattern_inequalities.rst.txt b/...s/milp/utils/dictionary_containing_truncated_input_pattern_inequalities.rst.txt
@@ -0,0 +1,10 @@
+----------------------------------------------------------
+Dictionary containing truncated input pattern inequalities
+----------------------------------------------------------
+
+.. automodule:: cipher_modules.models.milp.utils.dictionary_containing_truncated_input_pattern_inequalities
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
diff --git a/...ules/models/milp/utils/dictionary_containing_truncated_mds_inequalities.rst.txt b/...ules/models/milp/utils/dictionary_containing_truncated_mds_inequalities.rst.txt
@@ -0,0 +1,10 @@
+------------------------------------------------
+Dictionary containing truncated mds inequalities
+------------------------------------------------
+
+.. automodule:: cipher_modules.models.milp.utils.dictionary_containing_truncated_mds_inequalities
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
diff --git a/...s/dictionary_containing_truncated_xor_inequalities_between_n_input_bits.rst.txt b/...s/dictionary_containing_truncated_xor_inequalities_between_n_input_bits.rst.txt
@@ -0,0 +1,10 @@
+---------------------------------------------------------------------
+Dictionary containing truncated xor inequalities between n input bits
+---------------------------------------------------------------------
+
+.. automodule:: cipher_modules.models.milp.utils.dictionary_containing_truncated_xor_inequalities_between_n_input_bits
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
diff --git a/.../milp/utils/dictionary_containing_xor_inequalities_between_n_input_bits.rst.txt b/.../milp/utils/dictionary_containing_xor_inequalities_between_n_input_bits.rst.txt
@@ -0,0 +1,10 @@
+-----------------------------------------------------------
+Dictionary containing xor inequalities between n input bits
+-----------------------------------------------------------
+
+.. automodule:: cipher_modules.models.milp.utils.dictionary_containing_xor_inequalities_between_n_input_bits
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
diff --git a/...odels/milp/utils/dictionary_that_contains_inequalities_for_large_sboxes.rst.txt b/...odels/milp/utils/dictionary_that_contains_inequalities_for_large_sboxes.rst.txt
@@ -0,0 +1,10 @@
+------------------------------------------------------
+Dictionary that contains inequalities for large sboxes
+------------------------------------------------------
+
+.. automodule:: cipher_modules.models.milp.utils.dictionary_that_contains_inequalities_for_large_sboxes
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
diff --git a/...utils/dictionary_that_contains_inequalities_for_large_sboxes_xor_linear.rst.txt b/...utils/dictionary_that_contains_inequalities_for_large_sboxes_xor_linear.rst.txt
@@ -0,0 +1,10 @@
+-----------------------------------------------------------------
+Dictionary that contains inequalities for large sboxes xor linear
+-----------------------------------------------------------------
+
+.. automodule:: cipher_modules.models.milp.utils.dictionary_that_contains_inequalities_for_large_sboxes_xor_linear
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
diff --git a/.../dictionary_that_contains_inequalities_for_sboxes_with_undisturbed_bits.rst.txt b/.../dictionary_that_contains_inequalities_for_sboxes_with_undisturbed_bits.rst.txt
@@ -0,0 +1,10 @@
+----------------------------------------------------------------------
+Dictionary that contains inequalities for sboxes with undisturbed bits
+----------------------------------------------------------------------
+
+.. automodule:: cipher_modules.models.milp.utils.dictionary_that_contains_inequalities_for_sboxes_with_undisturbed_bits
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
diff --git a/...odels/milp/utils/dictionary_that_contains_inequalities_for_small_sboxes.rst.txt b/...odels/milp/utils/dictionary_that_contains_inequalities_for_small_sboxes.rst.txt
@@ -0,0 +1,10 @@
+------------------------------------------------------
+Dictionary that contains inequalities for small sboxes
+------------------------------------------------------
+
+.. automodule:: cipher_modules.models.milp.utils.dictionary_that_contains_inequalities_for_small_sboxes
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
diff --git a/...utils/dictionary_that_contains_inequalities_for_small_sboxes_xor_linear.rst.txt b/...utils/dictionary_that_contains_inequalities_for_small_sboxes_xor_linear.rst.txt
@@ -0,0 +1,10 @@
+-----------------------------------------------------------------
+Dictionary that contains inequalities for small sboxes xor linear
+-----------------------------------------------------------------
+
+.. automodule:: cipher_modules.models.milp.utils.dictionary_that_contains_inequalities_for_small_sboxes_xor_linear
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
diff --git a/...ls/milp/utils/generate_inequalities_for_wordwise_truncated_mds_matrices.rst.txt b/...ls/milp/utils/generate_inequalities_for_wordwise_truncated_mds_matrices.rst.txt
@@ -0,0 +1,10 @@
+---------------------------------------------------------
+Generate inequalities for wordwise truncated mds matrices
+---------------------------------------------------------
+
+.. automodule:: cipher_modules.models.milp.utils.generate_inequalities_for_wordwise_truncated_mds_matrices
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
diff --git a/...tils/generate_inequalities_for_wordwise_truncated_xor_with_n_input_bits.rst.txt b/...tils/generate_inequalities_for_wordwise_truncated_xor_with_n_input_bits.rst.txt
@@ -0,0 +1,10 @@
+------------------------------------------------------------------
+Generate inequalities for wordwise truncated xor with n input bits
+------------------------------------------------------------------
+
+.. automodule:: cipher_modules.models.milp.utils.generate_inequalities_for_wordwise_truncated_xor_with_n_input_bits
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
diff --git a/...les/models/milp/utils/generate_undisturbed_bits_inequalities_for_sboxes.rst.txt b/...les/models/milp/utils/generate_undisturbed_bits_inequalities_for_sboxes.rst.txt
@@ -0,0 +1,10 @@
+-------------------------------------------------
+Generate undisturbed bits inequalities for sboxes
+-------------------------------------------------
+
+.. automodule:: cipher_modules.models.milp.utils.generate_undisturbed_bits_inequalities_for_sboxes
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
diff --git a/...build/html/_sources/cipher_modules/models/milp/utils/milp_name_mappings.rst.txt b/...build/html/_sources/cipher_modules/models/milp/utils/milp_name_mappings.rst.txt
@@ -0,0 +1,10 @@
+------------------
+Milp name mappings
+------------------
+
+.. automodule:: cipher_modules.models.milp.utils.milp_name_mappings
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
diff --git a/docs/build/html/_sources/cipher_modules/models/milp/utils/utils.rst.txt b/docs/build/html/_sources/cipher_modules/models/milp/utils/utils.rst.txt
@@ -0,0 +1,10 @@
+-----
+Utils
+-----
+
+.. automodule:: cipher_modules.models.milp.utils.utils
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
diff --git a/docs/build/html/_sources/ciphers/block_ciphers/bea1_block_cipher.rst.txt b/docs/build/html/_sources/ciphers/block_ciphers/bea1_block_cipher.rst.txt
@@ -0,0 +1,10 @@
+-----------------
+Bea1 block cipher
+-----------------
+
+.. automodule:: ciphers.block_ciphers.bea1_block_cipher
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
diff --git a/docs/build/html/_sources/ciphers/block_ciphers/lblock_block_cipher.rst.txt b/docs/build/html/_sources/ciphers/block_ciphers/lblock_block_cipher.rst.txt
@@ -0,0 +1,10 @@
+-------------------
+Lblock block cipher
+-------------------
+
+.. automodule:: ciphers.block_ciphers.lblock_block_cipher
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
diff --git a/docs/build/html/_sources/ciphers/block_ciphers/qarmav2_block_cipher.rst.txt b/docs/build/html/_sources/ciphers/block_ciphers/qarmav2_block_cipher.rst.txt
@@ -0,0 +1,10 @@
+--------------------
+Qarmav2 block cipher
+--------------------
+
+.. automodule:: ciphers.block_ciphers.qarmav2_block_cipher
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
diff --git a/docs/build/html/_sources/ciphers/block_ciphers/rc5_block_cipher.rst.txt b/docs/build/html/_sources/ciphers/block_ciphers/rc5_block_cipher.rst.txt
@@ -0,0 +1,10 @@
+----------------
+Rc5 block cipher
+----------------
+
+.. automodule:: ciphers.block_ciphers.rc5_block_cipher
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
diff --git a/docs/build/html/_sources/ciphers/hash_functions/whirlpool_hash_function.rst.txt b/docs/build/html/_sources/ciphers/hash_functions/whirlpool_hash_function.rst.txt
@@ -0,0 +1,10 @@
+-----------------------
+Whirlpool hash function
+-----------------------
+
+.. automodule:: ciphers.hash_functions.whirlpool_hash_function
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
diff --git a/docs/build/html/_sources/ciphers/permutations/salsa_permutation.rst.txt b/docs/build/html/_sources/ciphers/permutations/salsa_permutation.rst.txt
@@ -0,0 +1,10 @@
+-----------------
+Salsa permutation
+-----------------
+
+.. automodule:: ciphers.permutations.salsa_permutation
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
diff --git a/docs/build/html/_sources/ciphers/permutations/spongent_pi_fsr_permutation.rst.txt b/docs/build/html/_sources/ciphers/permutations/spongent_pi_fsr_permutation.rst.txt
@@ -0,0 +1,10 @@
+---------------------------
+Spongent pi fsr permutation
+---------------------------
+
+.. automodule:: ciphers.permutations.spongent_pi_fsr_permutation
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
diff --git a/...tml/_sources/ciphers/permutations/tinyjambu_fsr_32bits_word_permutation.rst.txt b/...tml/_sources/ciphers/permutations/tinyjambu_fsr_32bits_word_permutation.rst.txt
@@ -0,0 +1,10 @@
+-------------------------------------
+Tinyjambu fsr 32bits word permutation
+-------------------------------------
+
+.. automodule:: ciphers.permutations.tinyjambu_fsr_32bits_word_permutation
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
diff --git a/docs/build/html/_sources/ciphers/permutations/util.rst.txt b/docs/build/html/_sources/ciphers/permutations/util.rst.txt
@@ -0,0 +1,10 @@
+----
+Util
+----
+
+.. automodule:: ciphers.permutations.util
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
diff --git a/docs/build/html/_sources/ciphers/stream_ciphers/a5_1_stream_cipher.rst.txt b/docs/build/html/_sources/ciphers/stream_ciphers/a5_1_stream_cipher.rst.txt
@@ -0,0 +1,10 @@
+------------------
+A5 1 stream cipher
+------------------
+
+.. automodule:: ciphers.stream_ciphers.a5_1_stream_cipher
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
diff --git a/docs/build/html/_sources/ciphers/stream_ciphers/bivium_stream_cipher.rst.txt b/docs/build/html/_sources/ciphers/stream_ciphers/bivium_stream_cipher.rst.txt
@@ -0,0 +1,10 @@
+--------------------
+Bivium stream cipher
+--------------------
+
+.. automodule:: ciphers.stream_ciphers.bivium_stream_cipher
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
diff --git a/docs/build/html/_sources/ciphers/stream_ciphers/bluetooth_stream_cipher_e0.rst.txt b/docs/build/html/_sources/ciphers/stream_ciphers/bluetooth_stream_cipher_e0.rst.txt
@@ -0,0 +1,10 @@
+--------------------------
+Bluetooth stream cipher e0
+--------------------------
+
+.. automodule:: ciphers.stream_ciphers.bluetooth_stream_cipher_e0
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
diff --git a/docs/build/html/_sources/ciphers/stream_ciphers/snow3g_stream_cipher.rst.txt b/docs/build/html/_sources/ciphers/stream_ciphers/snow3g_stream_cipher.rst.txt
@@ -0,0 +1,10 @@
+--------------------
+Snow3g stream cipher
+--------------------
+
+.. automodule:: ciphers.stream_ciphers.snow3g_stream_cipher
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
diff --git a/docs/build/html/_sources/ciphers/stream_ciphers/trivium_stream_cipher.rst.txt b/docs/build/html/_sources/ciphers/stream_ciphers/trivium_stream_cipher.rst.txt
@@ -0,0 +1,10 @@
+---------------------
+Trivium stream cipher
+---------------------
+
+.. automodule:: ciphers.stream_ciphers.trivium_stream_cipher
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+