docs/cryptanalysis.html

<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
<meta name="generator" content="pdoc 0.10.0" />
<title>cryptanalysis.cryptanalysis API documentation</title>
<meta name="description" content="Module for performing cryptanalysis on Substitution Permutation Network cipher …" />
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
<link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js" integrity="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8=" crossorigin></script>
<script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script>
</head>
<body>
<main>
<article id="content">
<header>
<h1 class="title">Module <code>cryptanalysis.cryptanalysis</code></h1>
</header>
<section id="section-intro">
<p>Module for performing cryptanalysis on Substitution Permutation Network cipher.</p>
<p>Classes:
- Cryptanalysis: Abstract base class for cryptanalysis algorithms.</p>
<p>Usage:
Import the <code><a title="cryptanalysis" href="index.html">cryptanalysis</a></code> module to access the <code><a title="cryptanalysis.cryptanalysis.Cryptanalysis" href="#cryptanalysis.cryptanalysis.Cryptanalysis">Cryptanalysis</a></code> class.</p>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">&#34;&#34;&#34;
Module for performing cryptanalysis on Substitution Permutation Network cipher.

Classes:
- Cryptanalysis: Abstract base class for cryptanalysis algorithms.

Usage:
Import the `cryptanalysis` module to access the `Cryptanalysis` class.
&#34;&#34;&#34;
from abc import ABC, abstractmethod
from .spn import SPN
from .characteristic_searcher import CharacteristicSearcher

__all__ = [&#34;Cryptanalysis&#34;]


class Cryptanalysis(SPN, ABC):
    &#34;&#34;&#34;
    Abstract base class for cryptanalysis algorithms.

    Methods:
    - __init__: Initialize the cryptanalysis class.
    - dec_partial_last_noperm: Partially decrypt the ciphertext using last round without permutation.
    - dec_partial_last_withperm: Partially decrypt the ciphertext using last round with permutation.
    - update_encryptions: Update the encryption pairs used for analysis.
    - batch_encrypt: Encrypt multiple plaintexts in batch mode.
    - find_keybits: Find the key bits of the encryption algorithm.
    - generate_encryption_pairs: Generate encryption pairs for cryptanalysis.
    - find_last_roundkey: Find the last round key of the encryption algorithm.
    &#34;&#34;&#34;
    def __init__(self, sbox, pbox, num_rounds, mode=&#39;differential&#39;):
        &#34;&#34;&#34;
        This method initializes the Cryptanalysis class by calling the __init__ method of the SPN class
        (the parent class) and setting the mode and characteristic_searcher attributes. It also initializes
        the encryptions dictionary.

        Args:
            sbox (list): A list of integers representing the S-box.
            pbox (list): A list of integers representing the P-box.
            num_rounds (int): The number of rounds in the block cipher.
            mode (str, optional): The mode of the cryptanalysis. Defaults to &#39;differential&#39;.
        &#34;&#34;&#34;
        super().__init__(sbox, pbox, 0, num_rounds)
        self.mode = mode
        self.characteristic_searcher = CharacteristicSearcher(
            self.sbox, self.pbox, num_rounds - 1, mode)
        self.encryptions = {}  # store of the encryptions utilized by the cryptanalysis

    def dec_partial_last_noperm(self, ciphertext, round_keys):
        &#34;&#34;&#34;Performs partial decryption without permutation on the last round.
        Args:
            ciphertext (int): The ciphertext to decrypt.
            round_keys (list): A list of round keys in reverse order.

        Returns:
            int: The partially decrypted ciphertext.
        &#34;&#34;&#34;
        # partial decryption
        # round keys in reverse order
        ciphertext = ciphertext ^ round_keys[0]
        ciphertext = self.inv_sub(ciphertext)
        for round_key in round_keys[1:self.rounds]:
            ciphertext ^= round_key
            ciphertext = self.inv_perm(ciphertext)
            ciphertext = self.inv_sub(ciphertext)
        if len(round_keys) == self.rounds + 1:
            ciphertext ^= round_keys[-1]
        return ciphertext

    def dec_partial_last_withperm(self, ciphertext, round_keys):
        &#34;&#34;&#34;Performs partial decryption with permutation on last round
        Args:
            ciphertext (int): The ciphertext to decrypt.
            round_keys (list): A list of round keys.

        Returns:
            int: The partially decrypted ciphertext.
        &#34;&#34;&#34;
        for round_key in round_keys[:self.rounds]:
            ciphertext ^= round_key
            ciphertext = self.inv_perm(ciphertext)
            ciphertext = self.inv_sub(ciphertext)
        if len(round_keys) == self.rounds + 1:
            ciphertext ^= round_keys[-1]
        return ciphertext


    def update_encryptions(self, multiple=10000):
        &#34;&#34;&#34;Updates the encryptions dictionary.

        This method updates the encryptions dictionary by encrypting the ciphertexts
        that have not been encrypted yet. It encrypts the ciphertexts in batches to
        improve performance.

        Args:
            multiple (int, optional): The number of ciphertexts to encrypt in each batch. Defaults to 10000.
        &#34;&#34;&#34;
        to_encrypt = [i for i, v in self.encryptions.items() if v is None]
        for i in range(0, len(to_encrypt) + multiple, multiple):
            current_batch = to_encrypt[i:i + multiple]
            if current_batch == []:
                break
            for j, enc in zip(current_batch, self.batch_encrypt(current_batch)):
                self.encryptions[j] = enc

    def batch_encrypt(self, pt_list):
        &#34;&#34;&#34;Encrypts a list of plaintexts.

        This method takes a list of integers representing plaintexts and returns a
        list of integers representing the corresponding ciphertexts.
        Override this function in case oracle is remote and to get encryptions from it.

        Args:
            pt_list (list): A list of integers representing the plaintexts.

        Returns:
            list: A list of integers representing the ciphertexts.
        &#34;&#34;&#34;
        return [self.encrypt(i) for i in pt_list]

    @abstractmethod
    def find_keybits(self, in_mask, out_mask, encryption_pairs, known_keyblocks=()):
        &#34;&#34;&#34;Finds the key bits based on input and output masks.

        This abstract method is meant to be overridden by subclasses. It takes an input mask,
        an output mask, a list of encryption pairs, and an optional list of known key blocks
        as input. It should implement the logic to find the key bits based on the provided parameters.

        Args:
            in_mask (int): The input mask for the key search.
            out_mask (int): The output mask for the key search.
            encryption_pairs (list): A list of tuples of encryption pairs used for analysis.
            known_keyblocks (list, optional): A list of known key blocks. Defaults to an empty list.

        Returns:
            list: A list of key bits that are determined based on the provided parameters.
        &#34;&#34;&#34;

    @abstractmethod
    def generate_encryption_pairs(self, outmasks, cutoff, multiple):
        &#34;&#34;&#34;Generates encryption pairs for analysis.

        This abstract method is meant to be overridden by subclasses. It takes a list of output masks
        and generates encryption pairs for analysis. The encryption pairs should be suitable for
        cryptanalysis purposes.

        Args:
            outmasks (list): A list of tuples of (input, output masks, bias) for which
                                the last round key needs to be found.
            cutoff (int, optional): The cutoff value used for the maximum number of encryptions
                                    called from oracle in determining the last round key. Defaults to 10000.
            multiple (int, optional): The multiple indicating the size of the batch of values to be
                                encrypted at once used for generating encryption pairs. Defaults to 1000.

        Returns:
            list: A list of encryption pairs suitable for cryptanalysis.
        &#34;&#34;&#34;

    @abstractmethod
    def find_last_roundkey(self, outmasks, cutoff, multiple):
        &#34;&#34;&#34;Finds the last round key based on output masks.

        This abstract method is meant to be overridden by subclasses. It takes a list of output masks
        and a cutoff value. It should implement the logic to find the last round key based on the output
        masks and the specified cutoff value.

        Args:
            outmasks (list): A list of tuples of (input, output masks, bias) for which
                                the last round key needs to be found.
            cutoff (int): The cutoff value used for determining the number of encryptions used to
                            determine the last round key
            multiple (int): The multiple indicating the size of the batch of values to be
                                encrypted at once used for generating encryption pairs.


        Returns:
            int: The last round key determined based on the output masks and the cutoff value.
        &#34;&#34;&#34;</code></pre>
</details>
</section>
<section>
</section>
<section>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-classes">Classes</h2>
<dl>
<dt id="cryptanalysis.cryptanalysis.Cryptanalysis"><code class="flex name class">
<span>class <span class="ident">Cryptanalysis</span></span>
<span>(</span><span>sbox, pbox, num_rounds, mode='differential')</span>
</code></dt>
<dd>
<div class="desc"><p>Abstract base class for cryptanalysis algorithms.</p>
<p>Methods:
- <strong>init</strong>: Initialize the cryptanalysis class.
- dec_partial_last_noperm: Partially decrypt the ciphertext using last round without permutation.
- dec_partial_last_withperm: Partially decrypt the ciphertext using last round with permutation.
- update_encryptions: Update the encryption pairs used for analysis.
- batch_encrypt: Encrypt multiple plaintexts in batch mode.
- find_keybits: Find the key bits of the encryption algorithm.
- generate_encryption_pairs: Generate encryption pairs for cryptanalysis.
- find_last_roundkey: Find the last round key of the encryption algorithm.</p>
<p>This method initializes the Cryptanalysis class by calling the <strong>init</strong> method of the SPN class
(the parent class) and setting the mode and characteristic_searcher attributes. It also initializes
the encryptions dictionary.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>sbox</code></strong> :&ensp;<code>list</code></dt>
<dd>A list of integers representing the S-box.</dd>
<dt><strong><code>pbox</code></strong> :&ensp;<code>list</code></dt>
<dd>A list of integers representing the P-box.</dd>
<dt><strong><code>num_rounds</code></strong> :&ensp;<code>int</code></dt>
<dd>The number of rounds in the block cipher.</dd>
<dt><strong><code>mode</code></strong> :&ensp;<code>str</code>, optional</dt>
<dd>The mode of the cryptanalysis. Defaults to 'differential'.</dd>
</dl></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class Cryptanalysis(SPN, ABC):
    &#34;&#34;&#34;
    Abstract base class for cryptanalysis algorithms.

    Methods:
    - __init__: Initialize the cryptanalysis class.
    - dec_partial_last_noperm: Partially decrypt the ciphertext using last round without permutation.
    - dec_partial_last_withperm: Partially decrypt the ciphertext using last round with permutation.
    - update_encryptions: Update the encryption pairs used for analysis.
    - batch_encrypt: Encrypt multiple plaintexts in batch mode.
    - find_keybits: Find the key bits of the encryption algorithm.
    - generate_encryption_pairs: Generate encryption pairs for cryptanalysis.
    - find_last_roundkey: Find the last round key of the encryption algorithm.
    &#34;&#34;&#34;
    def __init__(self, sbox, pbox, num_rounds, mode=&#39;differential&#39;):
        &#34;&#34;&#34;
        This method initializes the Cryptanalysis class by calling the __init__ method of the SPN class
        (the parent class) and setting the mode and characteristic_searcher attributes. It also initializes
        the encryptions dictionary.

        Args:
            sbox (list): A list of integers representing the S-box.
            pbox (list): A list of integers representing the P-box.
            num_rounds (int): The number of rounds in the block cipher.
            mode (str, optional): The mode of the cryptanalysis. Defaults to &#39;differential&#39;.
        &#34;&#34;&#34;
        super().__init__(sbox, pbox, 0, num_rounds)
        self.mode = mode
        self.characteristic_searcher = CharacteristicSearcher(
            self.sbox, self.pbox, num_rounds - 1, mode)
        self.encryptions = {}  # store of the encryptions utilized by the cryptanalysis

    def dec_partial_last_noperm(self, ciphertext, round_keys):
        &#34;&#34;&#34;Performs partial decryption without permutation on the last round.
        Args:
            ciphertext (int): The ciphertext to decrypt.
            round_keys (list): A list of round keys in reverse order.

        Returns:
            int: The partially decrypted ciphertext.
        &#34;&#34;&#34;
        # partial decryption
        # round keys in reverse order
        ciphertext = ciphertext ^ round_keys[0]
        ciphertext = self.inv_sub(ciphertext)
        for round_key in round_keys[1:self.rounds]:
            ciphertext ^= round_key
            ciphertext = self.inv_perm(ciphertext)
            ciphertext = self.inv_sub(ciphertext)
        if len(round_keys) == self.rounds + 1:
            ciphertext ^= round_keys[-1]
        return ciphertext

    def dec_partial_last_withperm(self, ciphertext, round_keys):
        &#34;&#34;&#34;Performs partial decryption with permutation on last round
        Args:
            ciphertext (int): The ciphertext to decrypt.
            round_keys (list): A list of round keys.

        Returns:
            int: The partially decrypted ciphertext.
        &#34;&#34;&#34;
        for round_key in round_keys[:self.rounds]:
            ciphertext ^= round_key
            ciphertext = self.inv_perm(ciphertext)
            ciphertext = self.inv_sub(ciphertext)
        if len(round_keys) == self.rounds + 1:
            ciphertext ^= round_keys[-1]
        return ciphertext


    def update_encryptions(self, multiple=10000):
        &#34;&#34;&#34;Updates the encryptions dictionary.

        This method updates the encryptions dictionary by encrypting the ciphertexts
        that have not been encrypted yet. It encrypts the ciphertexts in batches to
        improve performance.

        Args:
            multiple (int, optional): The number of ciphertexts to encrypt in each batch. Defaults to 10000.
        &#34;&#34;&#34;
        to_encrypt = [i for i, v in self.encryptions.items() if v is None]
        for i in range(0, len(to_encrypt) + multiple, multiple):
            current_batch = to_encrypt[i:i + multiple]
            if current_batch == []:
                break
            for j, enc in zip(current_batch, self.batch_encrypt(current_batch)):
                self.encryptions[j] = enc

    def batch_encrypt(self, pt_list):
        &#34;&#34;&#34;Encrypts a list of plaintexts.

        This method takes a list of integers representing plaintexts and returns a
        list of integers representing the corresponding ciphertexts.
        Override this function in case oracle is remote and to get encryptions from it.

        Args:
            pt_list (list): A list of integers representing the plaintexts.

        Returns:
            list: A list of integers representing the ciphertexts.
        &#34;&#34;&#34;
        return [self.encrypt(i) for i in pt_list]

    @abstractmethod
    def find_keybits(self, in_mask, out_mask, encryption_pairs, known_keyblocks=()):
        &#34;&#34;&#34;Finds the key bits based on input and output masks.

        This abstract method is meant to be overridden by subclasses. It takes an input mask,
        an output mask, a list of encryption pairs, and an optional list of known key blocks
        as input. It should implement the logic to find the key bits based on the provided parameters.

        Args:
            in_mask (int): The input mask for the key search.
            out_mask (int): The output mask for the key search.
            encryption_pairs (list): A list of tuples of encryption pairs used for analysis.
            known_keyblocks (list, optional): A list of known key blocks. Defaults to an empty list.

        Returns:
            list: A list of key bits that are determined based on the provided parameters.
        &#34;&#34;&#34;

    @abstractmethod
    def generate_encryption_pairs(self, outmasks, cutoff, multiple):
        &#34;&#34;&#34;Generates encryption pairs for analysis.

        This abstract method is meant to be overridden by subclasses. It takes a list of output masks
        and generates encryption pairs for analysis. The encryption pairs should be suitable for
        cryptanalysis purposes.

        Args:
            outmasks (list): A list of tuples of (input, output masks, bias) for which
                                the last round key needs to be found.
            cutoff (int, optional): The cutoff value used for the maximum number of encryptions
                                    called from oracle in determining the last round key. Defaults to 10000.
            multiple (int, optional): The multiple indicating the size of the batch of values to be
                                encrypted at once used for generating encryption pairs. Defaults to 1000.

        Returns:
            list: A list of encryption pairs suitable for cryptanalysis.
        &#34;&#34;&#34;

    @abstractmethod
    def find_last_roundkey(self, outmasks, cutoff, multiple):
        &#34;&#34;&#34;Finds the last round key based on output masks.

        This abstract method is meant to be overridden by subclasses. It takes a list of output masks
        and a cutoff value. It should implement the logic to find the last round key based on the output
        masks and the specified cutoff value.

        Args:
            outmasks (list): A list of tuples of (input, output masks, bias) for which
                                the last round key needs to be found.
            cutoff (int): The cutoff value used for determining the number of encryptions used to
                            determine the last round key
            multiple (int): The multiple indicating the size of the batch of values to be
                                encrypted at once used for generating encryption pairs.


        Returns:
            int: The last round key determined based on the output masks and the cutoff value.
        &#34;&#34;&#34;</code></pre>
</details>
<h3>Ancestors</h3>
<ul class="hlist">
<li><a title="cryptanalysis.spn.SPN" href="spn.html#cryptanalysis.spn.SPN">SPN</a></li>
<li>abc.ABC</li>
</ul>
<h3>Subclasses</h3>
<ul class="hlist">
<li><a title="cryptanalysis.differential_cryptanalysis.DifferentialCryptanalysis" href="differential_cryptanalysis.html#cryptanalysis.differential_cryptanalysis.DifferentialCryptanalysis">DifferentialCryptanalysis</a></li>
<li><a title="cryptanalysis.linear_cryptanalysis.LinearCryptanalysis" href="linear_cryptanalysis.html#cryptanalysis.linear_cryptanalysis.LinearCryptanalysis">LinearCryptanalysis</a></li>
</ul>
<h3>Methods</h3>
<dl>
<dt id="cryptanalysis.cryptanalysis.Cryptanalysis.batch_encrypt"><code class="name flex">
<span>def <span class="ident">batch_encrypt</span></span>(<span>self, pt_list)</span>
</code></dt>
<dd>
<div class="desc"><p>Encrypts a list of plaintexts.</p>
<p>This method takes a list of integers representing plaintexts and returns a
list of integers representing the corresponding ciphertexts.
Override this function in case oracle is remote and to get encryptions from it.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>pt_list</code></strong> :&ensp;<code>list</code></dt>
<dd>A list of integers representing the plaintexts.</dd>
</dl>
<h2 id="returns">Returns</h2>
<dl>
<dt><code>list</code></dt>
<dd>A list of integers representing the ciphertexts.</dd>
</dl></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def batch_encrypt(self, pt_list):
    &#34;&#34;&#34;Encrypts a list of plaintexts.

    This method takes a list of integers representing plaintexts and returns a
    list of integers representing the corresponding ciphertexts.
    Override this function in case oracle is remote and to get encryptions from it.

    Args:
        pt_list (list): A list of integers representing the plaintexts.

    Returns:
        list: A list of integers representing the ciphertexts.
    &#34;&#34;&#34;
    return [self.encrypt(i) for i in pt_list]</code></pre>
</details>
</dd>
<dt id="cryptanalysis.cryptanalysis.Cryptanalysis.dec_partial_last_noperm"><code class="name flex">
<span>def <span class="ident">dec_partial_last_noperm</span></span>(<span>self, ciphertext, round_keys)</span>
</code></dt>
<dd>
<div class="desc"><p>Performs partial decryption without permutation on the last round.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>ciphertext</code></strong> :&ensp;<code>int</code></dt>
<dd>The ciphertext to decrypt.</dd>
<dt><strong><code>round_keys</code></strong> :&ensp;<code>list</code></dt>
<dd>A list of round keys in reverse order.</dd>
</dl>
<h2 id="returns">Returns</h2>
<dl>
<dt><code>int</code></dt>
<dd>The partially decrypted ciphertext.</dd>
</dl></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def dec_partial_last_noperm(self, ciphertext, round_keys):
    &#34;&#34;&#34;Performs partial decryption without permutation on the last round.
    Args:
        ciphertext (int): The ciphertext to decrypt.
        round_keys (list): A list of round keys in reverse order.

    Returns:
        int: The partially decrypted ciphertext.
    &#34;&#34;&#34;
    # partial decryption
    # round keys in reverse order
    ciphertext = ciphertext ^ round_keys[0]
    ciphertext = self.inv_sub(ciphertext)
    for round_key in round_keys[1:self.rounds]:
        ciphertext ^= round_key
        ciphertext = self.inv_perm(ciphertext)
        ciphertext = self.inv_sub(ciphertext)
    if len(round_keys) == self.rounds + 1:
        ciphertext ^= round_keys[-1]
    return ciphertext</code></pre>
</details>
</dd>
<dt id="cryptanalysis.cryptanalysis.Cryptanalysis.dec_partial_last_withperm"><code class="name flex">
<span>def <span class="ident">dec_partial_last_withperm</span></span>(<span>self, ciphertext, round_keys)</span>
</code></dt>
<dd>
<div class="desc"><p>Performs partial decryption with permutation on last round</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>ciphertext</code></strong> :&ensp;<code>int</code></dt>
<dd>The ciphertext to decrypt.</dd>
<dt><strong><code>round_keys</code></strong> :&ensp;<code>list</code></dt>
<dd>A list of round keys.</dd>
</dl>
<h2 id="returns">Returns</h2>
<dl>
<dt><code>int</code></dt>
<dd>The partially decrypted ciphertext.</dd>
</dl></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def dec_partial_last_withperm(self, ciphertext, round_keys):
    &#34;&#34;&#34;Performs partial decryption with permutation on last round
    Args:
        ciphertext (int): The ciphertext to decrypt.
        round_keys (list): A list of round keys.

    Returns:
        int: The partially decrypted ciphertext.
    &#34;&#34;&#34;
    for round_key in round_keys[:self.rounds]:
        ciphertext ^= round_key
        ciphertext = self.inv_perm(ciphertext)
        ciphertext = self.inv_sub(ciphertext)
    if len(round_keys) == self.rounds + 1:
        ciphertext ^= round_keys[-1]
    return ciphertext</code></pre>
</details>
</dd>
<dt id="cryptanalysis.cryptanalysis.Cryptanalysis.find_keybits"><code class="name flex">
<span>def <span class="ident">find_keybits</span></span>(<span>self, in_mask, out_mask, encryption_pairs, known_keyblocks=())</span>
</code></dt>
<dd>
<div class="desc"><p>Finds the key bits based on input and output masks.</p>
<p>This abstract method is meant to be overridden by subclasses. It takes an input mask,
an output mask, a list of encryption pairs, and an optional list of known key blocks
as input. It should implement the logic to find the key bits based on the provided parameters.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>in_mask</code></strong> :&ensp;<code>int</code></dt>
<dd>The input mask for the key search.</dd>
<dt><strong><code>out_mask</code></strong> :&ensp;<code>int</code></dt>
<dd>The output mask for the key search.</dd>
<dt><strong><code>encryption_pairs</code></strong> :&ensp;<code>list</code></dt>
<dd>A list of tuples of encryption pairs used for analysis.</dd>
<dt><strong><code>known_keyblocks</code></strong> :&ensp;<code>list</code>, optional</dt>
<dd>A list of known key blocks. Defaults to an empty list.</dd>
</dl>
<h2 id="returns">Returns</h2>
<dl>
<dt><code>list</code></dt>
<dd>A list of key bits that are determined based on the provided parameters.</dd>
</dl></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">@abstractmethod
def find_keybits(self, in_mask, out_mask, encryption_pairs, known_keyblocks=()):
    &#34;&#34;&#34;Finds the key bits based on input and output masks.

    This abstract method is meant to be overridden by subclasses. It takes an input mask,
    an output mask, a list of encryption pairs, and an optional list of known key blocks
    as input. It should implement the logic to find the key bits based on the provided parameters.

    Args:
        in_mask (int): The input mask for the key search.
        out_mask (int): The output mask for the key search.
        encryption_pairs (list): A list of tuples of encryption pairs used for analysis.
        known_keyblocks (list, optional): A list of known key blocks. Defaults to an empty list.

    Returns:
        list: A list of key bits that are determined based on the provided parameters.
    &#34;&#34;&#34;</code></pre>
</details>
</dd>
<dt id="cryptanalysis.cryptanalysis.Cryptanalysis.find_last_roundkey"><code class="name flex">
<span>def <span class="ident">find_last_roundkey</span></span>(<span>self, outmasks, cutoff, multiple)</span>
</code></dt>
<dd>
<div class="desc"><p>Finds the last round key based on output masks.</p>
<p>This abstract method is meant to be overridden by subclasses. It takes a list of output masks
and a cutoff value. It should implement the logic to find the last round key based on the output
masks and the specified cutoff value.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>outmasks</code></strong> :&ensp;<code>list</code></dt>
<dd>A list of tuples of (input, output masks, bias) for which
the last round key needs to be found.</dd>
<dt><strong><code>cutoff</code></strong> :&ensp;<code>int</code></dt>
<dd>The cutoff value used for determining the number of encryptions used to
determine the last round key</dd>
<dt><strong><code>multiple</code></strong> :&ensp;<code>int</code></dt>
<dd>The multiple indicating the size of the batch of values to be
encrypted at once used for generating encryption pairs.</dd>
</dl>
<h2 id="returns">Returns</h2>
<dl>
<dt><code>int</code></dt>
<dd>The last round key determined based on the output masks and the cutoff value.</dd>
</dl></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">@abstractmethod
def find_last_roundkey(self, outmasks, cutoff, multiple):
    &#34;&#34;&#34;Finds the last round key based on output masks.

    This abstract method is meant to be overridden by subclasses. It takes a list of output masks
    and a cutoff value. It should implement the logic to find the last round key based on the output
    masks and the specified cutoff value.

    Args:
        outmasks (list): A list of tuples of (input, output masks, bias) for which
                            the last round key needs to be found.
        cutoff (int): The cutoff value used for determining the number of encryptions used to
                        determine the last round key
        multiple (int): The multiple indicating the size of the batch of values to be
                            encrypted at once used for generating encryption pairs.


    Returns:
        int: The last round key determined based on the output masks and the cutoff value.
    &#34;&#34;&#34;</code></pre>
</details>
</dd>
<dt id="cryptanalysis.cryptanalysis.Cryptanalysis.generate_encryption_pairs"><code class="name flex">
<span>def <span class="ident">generate_encryption_pairs</span></span>(<span>self, outmasks, cutoff, multiple)</span>
</code></dt>
<dd>
<div class="desc"><p>Generates encryption pairs for analysis.</p>
<p>This abstract method is meant to be overridden by subclasses. It takes a list of output masks
and generates encryption pairs for analysis. The encryption pairs should be suitable for
cryptanalysis purposes.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>outmasks</code></strong> :&ensp;<code>list</code></dt>
<dd>A list of tuples of (input, output masks, bias) for which
the last round key needs to be found.</dd>
<dt><strong><code>cutoff</code></strong> :&ensp;<code>int</code>, optional</dt>
<dd>The cutoff value used for the maximum number of encryptions
called from oracle in determining the last round key. Defaults to 10000.</dd>
<dt><strong><code>multiple</code></strong> :&ensp;<code>int</code>, optional</dt>
<dd>The multiple indicating the size of the batch of values to be
encrypted at once used for generating encryption pairs. Defaults to 1000.</dd>
</dl>
<h2 id="returns">Returns</h2>
<dl>
<dt><code>list</code></dt>
<dd>A list of encryption pairs suitable for cryptanalysis.</dd>
</dl></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">@abstractmethod
def generate_encryption_pairs(self, outmasks, cutoff, multiple):
    &#34;&#34;&#34;Generates encryption pairs for analysis.

    This abstract method is meant to be overridden by subclasses. It takes a list of output masks
    and generates encryption pairs for analysis. The encryption pairs should be suitable for
    cryptanalysis purposes.

    Args:
        outmasks (list): A list of tuples of (input, output masks, bias) for which
                            the last round key needs to be found.
        cutoff (int, optional): The cutoff value used for the maximum number of encryptions
                                called from oracle in determining the last round key. Defaults to 10000.
        multiple (int, optional): The multiple indicating the size of the batch of values to be
                            encrypted at once used for generating encryption pairs. Defaults to 1000.

    Returns:
        list: A list of encryption pairs suitable for cryptanalysis.
    &#34;&#34;&#34;</code></pre>
</details>
</dd>
<dt id="cryptanalysis.cryptanalysis.Cryptanalysis.update_encryptions"><code class="name flex">
<span>def <span class="ident">update_encryptions</span></span>(<span>self, multiple=10000)</span>
</code></dt>
<dd>
<div class="desc"><p>Updates the encryptions dictionary.</p>
<p>This method updates the encryptions dictionary by encrypting the ciphertexts
that have not been encrypted yet. It encrypts the ciphertexts in batches to
improve performance.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>multiple</code></strong> :&ensp;<code>int</code>, optional</dt>
<dd>The number of ciphertexts to encrypt in each batch. Defaults to 10000.</dd>
</dl></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def update_encryptions(self, multiple=10000):
    &#34;&#34;&#34;Updates the encryptions dictionary.

    This method updates the encryptions dictionary by encrypting the ciphertexts
    that have not been encrypted yet. It encrypts the ciphertexts in batches to
    improve performance.

    Args:
        multiple (int, optional): The number of ciphertexts to encrypt in each batch. Defaults to 10000.
    &#34;&#34;&#34;
    to_encrypt = [i for i, v in self.encryptions.items() if v is None]
    for i in range(0, len(to_encrypt) + multiple, multiple):
        current_batch = to_encrypt[i:i + multiple]
        if current_batch == []:
            break
        for j, enc in zip(current_batch, self.batch_encrypt(current_batch)):
            self.encryptions[j] = enc</code></pre>
</details>
</dd>
</dl>
<h3>Inherited members</h3>
<ul class="hlist">
<li><code><b><a title="cryptanalysis.spn.SPN" href="spn.html#cryptanalysis.spn.SPN">SPN</a></b></code>:
<ul class="hlist">
<li><code><a title="cryptanalysis.spn.SPN.expand_key" href="spn.html#cryptanalysis.spn.SPN.expand_key">expand_key</a></code></li>
<li><code><a title="cryptanalysis.spn.SPN.int_to_list" href="spn.html#cryptanalysis.spn.SPN.int_to_list">int_to_list</a></code></li>
<li><code><a title="cryptanalysis.spn.SPN.inv_perm" href="spn.html#cryptanalysis.spn.SPN.inv_perm">inv_perm</a></code></li>
<li><code><a title="cryptanalysis.spn.SPN.inv_sub" href="spn.html#cryptanalysis.spn.SPN.inv_sub">inv_sub</a></code></li>
<li><code><a title="cryptanalysis.spn.SPN.list_to_int" href="spn.html#cryptanalysis.spn.SPN.list_to_int">list_to_int</a></code></li>
<li><code><a title="cryptanalysis.spn.SPN.perm" href="spn.html#cryptanalysis.spn.SPN.perm">perm</a></code></li>
<li><code><a title="cryptanalysis.spn.SPN.sub" href="spn.html#cryptanalysis.spn.SPN.sub">sub</a></code></li>
</ul>
</li>
</ul>
</dd>
</dl>
</section>
</article>
<nav id="sidebar">
<h1>Index</h1>
<div class="toc">
<ul></ul>
</div>
<ul id="index">
<li><h3>Super-module</h3>
<ul>
<li><code><a title="cryptanalysis" href="index.html">cryptanalysis</a></code></li>
</ul>
</li>
<li><h3><a href="#header-classes">Classes</a></h3>
<ul>
<li>
<h4><code><a title="cryptanalysis.cryptanalysis.Cryptanalysis" href="#cryptanalysis.cryptanalysis.Cryptanalysis">Cryptanalysis</a></code></h4>
<ul class="">
<li><code><a title="cryptanalysis.cryptanalysis.Cryptanalysis.batch_encrypt" href="#cryptanalysis.cryptanalysis.Cryptanalysis.batch_encrypt">batch_encrypt</a></code></li>
<li><code><a title="cryptanalysis.cryptanalysis.Cryptanalysis.dec_partial_last_noperm" href="#cryptanalysis.cryptanalysis.Cryptanalysis.dec_partial_last_noperm">dec_partial_last_noperm</a></code></li>
<li><code><a title="cryptanalysis.cryptanalysis.Cryptanalysis.dec_partial_last_withperm" href="#cryptanalysis.cryptanalysis.Cryptanalysis.dec_partial_last_withperm">dec_partial_last_withperm</a></code></li>
<li><code><a title="cryptanalysis.cryptanalysis.Cryptanalysis.find_keybits" href="#cryptanalysis.cryptanalysis.Cryptanalysis.find_keybits">find_keybits</a></code></li>
<li><code><a title="cryptanalysis.cryptanalysis.Cryptanalysis.find_last_roundkey" href="#cryptanalysis.cryptanalysis.Cryptanalysis.find_last_roundkey">find_last_roundkey</a></code></li>
<li><code><a title="cryptanalysis.cryptanalysis.Cryptanalysis.generate_encryption_pairs" href="#cryptanalysis.cryptanalysis.Cryptanalysis.generate_encryption_pairs">generate_encryption_pairs</a></code></li>
<li><code><a title="cryptanalysis.cryptanalysis.Cryptanalysis.update_encryptions" href="#cryptanalysis.cryptanalysis.Cryptanalysis.update_encryptions">update_encryptions</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</nav>
</main>
<footer id="footer">
<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
</footer>
</body>
</html>