build
Directory actions
More options
Directory actions
More options
build
Folders and files
| Name | Name | Last commit date | ||
|---|---|---|---|---|
parent directory.. | ||||
<!DOCTYPE html>
<html lang="en" data-content_root="./" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Overview — cryptosystems 1.0.0 documentation</title>
<script data-cfasync="false">
document.documentElement.dataset.mode = localStorage.getItem("mode") || "";
document.documentElement.dataset.theme = localStorage.getItem("theme") || "";
</script>
<!-- Loaded before other Sphinx assets -->
<link href="proxy.php?url=https%3A%2F%2Fgithub.com%2F_static%2Fstyles%2Ftheme.css%3Fdigest%3Ddfe6caa3a7d634c4db9b" rel="stylesheet" />
<link href="proxy.php?url=https%3A%2F%2Fgithub.com%2F_static%2Fstyles%2Fbootstrap.css%3Fdigest%3Ddfe6caa3a7d634c4db9b" rel="stylesheet" />
<link href="proxy.php?url=https%3A%2F%2Fgithub.com%2F_static%2Fstyles%2Fpydata-sphinx-theme.css%3Fdigest%3Ddfe6caa3a7d634c4db9b" rel="stylesheet" />
<link href="proxy.php?url=https%3A%2F%2Fgithub.com%2F_static%2Fvendor%2Ffontawesome%2F6.5.2%2Fcss%2Fall.min.css%3Fdigest%3Ddfe6caa3a7d634c4db9b" rel="stylesheet" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="proxy.php?url=https%3A%2F%2Fgithub.com%2F_static%2Fvendor%2Ffontawesome%2F6.5.2%2Fwebfonts%2Ffa-solid-900.woff2" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="proxy.php?url=https%3A%2F%2Fgithub.com%2F_static%2Fvendor%2Ffontawesome%2F6.5.2%2Fwebfonts%2Ffa-brands-400.woff2" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="proxy.php?url=https%3A%2F%2Fgithub.com%2F_static%2Fvendor%2Ffontawesome%2F6.5.2%2Fwebfonts%2Ffa-regular-400.woff2" />
<link rel="stylesheet" type="text/css" href="proxy.php?url=https%3A%2F%2Fgithub.com%2F_static%2Fpygments.css%3Fv%3Da746c00c" />
<link rel="stylesheet" type="text/css" href="proxy.php?url=https%3A%2F%2Fgithub.com%2F_static%2Fstyles%2Fsphinx-book-theme.css%3Fv%3Da3416100" />
<link rel="stylesheet" type="text/css" href="proxy.php?url=https%3A%2F%2Fgithub.com%2F_static%2Fcopybutton.css%3Fv%3D76b2166b" />
<link rel="stylesheet" type="text/css" href="proxy.php?url=https%3A%2F%2Fgithub.com%2F_static%2Fsphinx-design.min.css%3Fv%3D95c83b7e" />
<!-- Pre-loaded scripts that we'll load fully later -->
<link rel="preload" as="script" href="proxy.php?url=https%3A%2F%2Fgithub.com%2F_static%2Fscripts%2Fbootstrap.js%3Fdigest%3Ddfe6caa3a7d634c4db9b" />
<link rel="preload" as="script" href="proxy.php?url=https%3A%2F%2Fgithub.com%2F_static%2Fscripts%2Fpydata-sphinx-theme.js%3Fdigest%3Ddfe6caa3a7d634c4db9b" />
<script src="proxy.php?url=https%3A%2F%2Fgithub.com%2F_static%2Fvendor%2Ffontawesome%2F6.5.2%2Fjs%2Fall.min.js%3Fdigest%3Ddfe6caa3a7d634c4db9b"></script>
<script src="proxy.php?url=https%3A%2F%2Fgithub.com%2F_static%2Fdocumentation_options.js%3Fv%3Df9c1cefe"></script>
<script src="proxy.php?url=https%3A%2F%2Fgithub.com%2F_static%2Fdoctools.js%3Fv%3D9bcbadda"></script>
<script src="proxy.php?url=https%3A%2F%2Fgithub.com%2F_static%2Fsphinx_highlight.js%3Fv%3Ddc90522c"></script>
<script src="proxy.php?url=https%3A%2F%2Fgithub.com%2F_static%2Fclipboard.min.js%3Fv%3Da7894cd8"></script>
<script src="proxy.php?url=https%3A%2F%2Fgithub.com%2F_static%2Fcopybutton.js%3Fv%3Df281be69"></script>
<script src="proxy.php?url=https%3A%2F%2Fgithub.com%2F_static%2Fscripts%2Fsphinx-book-theme.js%3Fv%3D887ef09a"></script>
<script src="proxy.php?url=https%3A%2F%2Fgithub.com%2F_static%2Fdesign-tabs.js%3Fv%3Df930bc37"></script>
<script>DOCUMENTATION_OPTIONS.pagename = 'readme';</script>
<link rel="index" title="Index" href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fgenindex.html" />
<link rel="search" title="Search" href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fsearch.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
</head>
<body data-bs-spy="scroll" data-bs-target=".bd-toc-nav" data-offset="180" data-bs-root-margin="0px 0px -60%" data-default-mode="">
<div id="pst-skip-link" class="skip-link d-print-none"><a href="proxy.php?url=https%3A%2F%2Fgithub.com%2F%23main-content">Skip to main content</a></div>
<div id="pst-scroll-pixel-helper"></div>
<button type="button" class="btn rounded-pill" id="pst-back-to-top">
<i class="fa-solid fa-arrow-up"></i>Back to top</button>
<input type="checkbox"
class="sidebar-toggle"
id="pst-primary-sidebar-checkbox"/>
<label class="overlay overlay-primary" for="pst-primary-sidebar-checkbox"></label>
<input type="checkbox"
class="sidebar-toggle"
id="pst-secondary-sidebar-checkbox"/>
<label class="overlay overlay-secondary" for="pst-secondary-sidebar-checkbox"></label>
<div class="search-button__wrapper">
<div class="search-button__overlay"></div>
<div class="search-button__search-container">
<form class="bd-search d-flex align-items-center"
action="proxy.php?url=https%3A%2F%2Fgithub.com%2Fsearch.html"
method="get">
<i class="fa-solid fa-magnifying-glass"></i>
<input type="search"
class="form-control"
name="q"
id="search-input"
placeholder="Search..."
aria-label="Search..."
autocomplete="off"
autocorrect="off"
autocapitalize="off"
spellcheck="false"/>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span>
</form></div>
</div>
<div class="pst-async-banner-revealer d-none">
<aside id="bd-header-version-warning" class="d-none d-print-none" aria-label="Version warning"></aside>
</div>
<header class="bd-header navbar navbar-expand-lg bd-navbar d-print-none">
</header>
<div class="bd-container">
<div class="bd-container__inner bd-page-width">
<div class="bd-sidebar-primary bd-sidebar">
<div class="sidebar-header-items sidebar-primary__section">
</div>
<div class="sidebar-primary-items__start sidebar-primary__section">
<div class="sidebar-primary-item">
<a class="navbar-brand logo" href="proxy.php?url=https%3A%2F%2Fgithub.com%2Findex.html">
<img src="proxy.php?url=https%3A%2F%2Fgithub.com%2F%3Ca+href%3D"https://ishan-surana.github.io/images/cryptosystems.png" rel="nofollow">https://ishan-surana.github.io/images/cryptosystems.png" class="logo__image only-light" alt="cryptosystems 1.0.0 documentation - Home"/>
<script>document.write(`<img src="proxy.php?url=https%3A%2F%2Fgithub.com%2F%3Ca+href%3D"https://ishan-surana.github.io/images/cryptosystems.png" rel="nofollow">https://ishan-surana.github.io/images/cryptosystems.png" class="logo__image only-dark" alt="cryptosystems 1.0.0 documentation - Home"/>`);</script>
</a></div>
<div class="sidebar-primary-item"><ul class="navbar-icon-links"
aria-label="Icon Links">
<li class="nav-item">
<a href="proxy.php?url=https%3A%2F%2Fgithub.com%2F%3Ca+href%3D"https://github.com/ishan-surana/cryptosystems">https://github.com/ishan-surana/cryptosystems" title="GitHub" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-github fa-lg" aria-hidden="true"></i>
<span class="sr-only">GitHub</span></a>
</li>
<li class="nav-item">
<a href="proxy.php?url=https%3A%2F%2Fgithub.com%2F%3Ca+href%3D"https://pypi.org/project/cryptosystems/" rel="nofollow">https://pypi.org/project/cryptosystems/" title="PyPI" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><img src="proxy.php?url=https%3A%2F%2Fgithub.com%2F%3Ca+href%3D"https://img.shields.io/pypi/v/cryptosystems?label=latest+release&color=blue" rel="nofollow">https://img.shields.io/pypi/v/cryptosystems?label=latest+release&color=blue" class="icon-link-image" alt="PyPI"/></a>
</li>
</ul></div>
<div class="sidebar-primary-item">
<script>
document.write(`
<button class="btn search-button-field search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass"></i>
<span class="search-button__default-text">Search</span>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
</button>
`);
</script></div>
<div class="sidebar-primary-item"><nav class="bd-links bd-docs-nav" aria-label="Main">
<div class="bd-toc-item navbar-nav active">
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fintroduction.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fstandards.html">Standards</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fclassical_symmetric%2Findex.html">Classical Symmetric Cryptosystems</a><ul>
<li class="toctree-l2"><a class="reference internal" href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fclassical_symmetric%2FAdditiveCipher.html">AdditiveCipher</a></li>
<li class="toctree-l2"><a class="reference internal" href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fclassical_symmetric%2FMultiplicativeCipher.html">MultiplicativeCipher</a></li>
<li class="toctree-l2"><a class="reference internal" href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fclassical_symmetric%2FAffineCipher.html">AffineCipher</a></li>
<li class="toctree-l2"><a class="reference internal" href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fclassical_symmetric%2FHillCipher.html">HillCipher</a></li>
<li class="toctree-l2"><a class="reference internal" href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fclassical_symmetric%2FPlayfairCipher.html">PlayfairCipher</a></li>
<li class="toctree-l2"><a class="reference internal" href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fclassical_symmetric%2FVigenereCipher.html">VigenèreCipher</a></li>
<li class="toctree-l2"><a class="reference internal" href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fclassical_symmetric%2FAutokeyCipher.html">AutokeyCipher</a></li>
</ul><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary>
</details></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fmodern_symmetric%2Findex.html">Modern Symmetric Cryptosystems</a><ul>
<li class="toctree-l2"><a class="reference internal" href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fmodern_symmetric%2FDES.html">DES</a></li>
<li class="toctree-l2"><a class="reference internal" href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fmodern_symmetric%2FAES.html">AES</a></li>
</ul><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary>
</details></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fasymmetric%2Findex.html">Asymmetric Cryptosystems</a><ul>
<li class="toctree-l2"><a class="reference internal" href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fasymmetric%2FRSA.html">RSA</a></li>
<li class="toctree-l2"><a class="reference internal" href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fasymmetric%2FElGamal.html">ElGamal</a></li>
<li class="toctree-l2"><a class="reference internal" href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fasymmetric%2FRabin.html">Rabin</a></li>
<li class="toctree-l2"><a class="reference internal" href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fasymmetric%2FPaillier.html">Paillier</a></li>
<li class="toctree-l2"><a class="reference internal" href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fasymmetric%2FECC.html">ECC</a></li>
</ul><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary>
</details></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fkey_exchange%2Findex.html">Key Exchange</a><ul>
<li class="toctree-l2"><a class="reference internal" href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fkey_exchange%2FDiffieHellman.html">DiffieHellman</a></li>
<li class="toctree-l2"><a class="reference internal" href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fkey_exchange%2FECDH.html">ECDH</a></li>
</ul><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary>
</details></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fhash_functions%2Findex.html">Hash Functions</a><ul>
<li class="toctree-l2"><a class="reference internal" href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fhash_functions%2FMD5.html">MD5</a></li>
<li class="toctree-l2"><a class="reference internal" href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fhash_functions%2FSHA256.html">SHA256</a></li>
<li class="toctree-l2"><a class="reference internal" href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fhash_functions%2FSHA512.html">SHA512</a></li>
</ul><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary>
</details></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="proxy.php?url=https%3A%2F%2Fgithub.com%2Ffunctions%2Findex.html">Utility Functions</a><ul>
<li class="toctree-l2"><a class="reference internal" href="proxy.php?url=https%3A%2F%2Fgithub.com%2Ffunctions%2FisPrime.html">isPrime</a></li>
<li class="toctree-l2"><a class="reference internal" href="proxy.php?url=https%3A%2F%2Fgithub.com%2Ffunctions%2FgetPrime.html">getPrime</a></li>
<li class="toctree-l2"><a class="reference internal" href="proxy.php?url=https%3A%2F%2Fgithub.com%2Ffunctions%2FgetRandomInteger.html">getRandomInteger</a></li>
<li class="toctree-l2"><a class="reference internal" href="proxy.php?url=https%3A%2F%2Fgithub.com%2Ffunctions%2FgetRandomRange.html">getRandomRange</a></li>
</ul><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary>
</details></li>
</ul>
</div>
</nav></div>
</div>
<div class="sidebar-primary-items__end sidebar-primary__section">
</div>
<div id="rtd-footer-container"></div>
</div>
<main id="main-content" class="bd-main" role="main">
<div class="sbt-scroll-pixel-helper"></div>
<div class="bd-content">
<div class="bd-article-container">
<div class="bd-header-article d-print-none">
<div class="header-article-items header-article__inner">
<div class="header-article-items__start">
<div class="header-article-item"><button class="sidebar-toggle primary-toggle btn btn-sm" title="Toggle primary sidebar" data-bs-placement="bottom" data-bs-toggle="tooltip">
<span class="fa-solid fa-bars"></span>
</button></div>
</div>
<div class="header-article-items__end">
<div class="header-article-item">
<div class="article-header-buttons">
<div class="dropdown dropdown-source-buttons">
<button class="btn dropdown-toggle" type="button" data-bs-toggle="dropdown" aria-expanded="false" aria-label="Source repositories">
<i class="fab fa-github"></i>
</button>
<ul class="dropdown-menu">
<li><a href="proxy.php?url=https%3A%2F%2Fgithub.com%2F%3Ca+href%3D"https://github.com/ishan-surana/cryptosystems">https://github.com/ishan-surana/cryptosystems" target="_blank"
class="btn btn-sm btn-source-repository-button dropdown-item"
title="Source repository"
data-bs-placement="left" data-bs-toggle="tooltip"
>
<span class="btn__icon-container">
<i class="fab fa-github"></i>
</span>
<span class="btn__text-container">Repository</span>
</a>
</li>
<li><a href="proxy.php?url=https%3A%2F%2Fgithub.com%2F%3Ca+href%3D"https://github.com/ishan-surana/cryptosystems/blob/main/docs/readme.md?plain=1">https://github.com/ishan-surana/cryptosystems/blob/main/docs/readme.md?plain=1" target="_blank"
class="btn btn-sm btn-source-file-button dropdown-item"
title="Show source"
data-bs-placement="left" data-bs-toggle="tooltip"
>
<span class="btn__icon-container">
<i class="fas fa-code"></i>
</span>
<span class="btn__text-container">Show source</span>
</a>
</li>
</ul>
</div>
<div class="dropdown dropdown-download-buttons">
<button class="btn dropdown-toggle" type="button" data-bs-toggle="dropdown" aria-expanded="false" aria-label="Download this page">
<i class="fas fa-download"></i>
</button>
<ul class="dropdown-menu">
<li><a href="proxy.php?url=https%3A%2F%2Fgithub.com%2F_sources%2Freadme.md" target="_blank"
class="btn btn-sm btn-download-source-button dropdown-item"
title="Download source file"
data-bs-placement="left" data-bs-toggle="tooltip"
>
<span class="btn__icon-container">
<i class="fas fa-file"></i>
</span>
<span class="btn__text-container">.md</span>
</a>
</li>
<li>
<button onclick="window.print()"
class="btn btn-sm btn-download-pdf-button dropdown-item"
title="Print to PDF"
data-bs-placement="left" data-bs-toggle="tooltip"
>
<span class="btn__icon-container">
<i class="fas fa-file-pdf"></i>
</span>
<span class="btn__text-container">.pdf</span>
</button>
</li>
</ul>
</div>
<button onclick="toggleFullScreen()"
class="btn btn-sm btn-fullscreen-button"
title="Fullscreen mode"
data-bs-placement="bottom" data-bs-toggle="tooltip"
>
<span class="btn__icon-container">
<i class="fas fa-expand"></i>
</span>
</button>
<script>
document.write(`
<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button" title="light/dark" aria-label="light/dark" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light"></i>
<i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark"></i>
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto"></i>
</button>
`);
</script>
<script>
document.write(`
<button class="btn btn-sm pst-navbar-icon search-button search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass fa-lg"></i>
</button>
`);
</script>
<button class="sidebar-toggle secondary-toggle btn btn-sm" title="Toggle secondary sidebar" data-bs-placement="bottom" data-bs-toggle="tooltip">
<span class="fa-solid fa-list"></span>
</button>
</div></div>
</div>
</div>
</div>
<div id="jb-print-docs-body" class="onlyprint">
<h1>Overview</h1>
<!-- Table of contents -->
<div id="print-main-content">
<div id="jb-print-toc">
<div>
<h2> Contents </h2>
</div>
<nav aria-label="Page">
<ul class="visible nav section-nav flex-column">
<li class="toc-h1 nav-item toc-entry"><a class="reference internal nav-link" href="proxy.php?url=https%3A%2F%2Fgithub.com%2F%23">Overview</a></li>
<li class="toc-h1 nav-item toc-entry"><a class="reference internal nav-link" href="proxy.php?url=https%3A%2F%2Fgithub.com%2F%23key-advantages">Key Advantages</a></li>
<li class="toc-h1 nav-item toc-entry"><a class="reference internal nav-link" href="proxy.php?url=https%3A%2F%2Fgithub.com%2F%23installation">Installation</a></li>
<li class="toc-h1 nav-item toc-entry"><a class="reference internal nav-link" href="proxy.php?url=https%3A%2F%2Fgithub.com%2F%23usage">Usage</a></li>
<li class="toc-h1 nav-item toc-entry"><a class="reference internal nav-link" href="proxy.php?url=https%3A%2F%2Fgithub.com%2F%23license">License</a></li>
<li class="toc-h1 nav-item toc-entry"><a class="reference internal nav-link" href="proxy.php?url=https%3A%2F%2Fgithub.com%2F%23authors">Authors</a></li>
<li class="toc-h1 nav-item toc-entry"><a class="reference internal nav-link" href="proxy.php?url=https%3A%2F%2Fgithub.com%2F%23acknowledgments">Acknowledgments</a></li>
</ul>
</nav>
</div>
</div>
</div>
<div id="searchbox"></div>
<article class="bd-article">
<section id="overview">
<h1>Overview<a class="headerlink" href="proxy.php?url=https%3A%2F%2Fgithub.com%2F%23overview" title="Link to this heading">#</a></h1>
<p>The <code class="docutils literal notranslate"><span class="pre">cryptosystems</span></code> package offers a suite of classes and functions for both symmetric and asymmetric encryption, as well as hashing functionalities. Designed for seamless encryption, decryption, and cryptographic operations, this package is lightweight and efficient, relying solely on Python’s built-in libraries: <code class="docutils literal notranslate"><span class="pre">ctypes</span></code>, <code class="docutils literal notranslate"><span class="pre">warnings</span></code> and <code class="docutils literal notranslate"><span class="pre">hashlib</span></code>. With all cryptographic logic implemented from scratch, cryptosystems provides a streamlined, dependency-free solution, ensuring consistency and reliability across different environments as well as Python versions.</p>
</section>
<section id="key-advantages">
<h1>Key Advantages<a class="headerlink" href="proxy.php?url=https%3A%2F%2Fgithub.com%2F%23key-advantages" title="Link to this heading">#</a></h1>
<ul class="simple">
<li><p><strong>Dependency-Free</strong> 🚫📦: Operates solely on Python’s built-in modules, eliminating the need for external libraries.</p></li>
<li><p><strong>Version Stability</strong> 🔒📅: Crafted to maintain consistent functionality across Python versions.</p></li>
<li><p><strong>Optimized for Performance</strong> ⚡⚙️: Built from scratch for efficient and consistant cryptographic operations.</p></li>
<li><p><strong>Lightweight Codebase</strong> 🪶💻: Minimalistic design ensures a low overhead and straightforward integration.</p></li>
<li><p><strong>Reliability and Security</strong> 🔐🛡️: Ensures robust encryption/decryption and hashing without reliance on third-party modules.</p></li>
<li><p><strong>Comprehensive Cryptosystem Support</strong> 🔄🔑: Offers a full suite of symmetric, asymmetric, and hashing methods.</p></li>
</ul>
</section>
<section id="installation">
<h1>Installation<a class="headerlink" href="proxy.php?url=https%3A%2F%2Fgithub.com%2F%23installation" title="Link to this heading">#</a></h1>
<p>To install the package, simply clone the repository and install the dependencies:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>cryptosystems
</pre></div>
</div>
</section>
<section id="usage">
<h1>Usage<a class="headerlink" href="proxy.php?url=https%3A%2F%2Fgithub.com%2F%23usage" title="Link to this heading">#</a></h1>
<p>The general structure for usage is to create an object of the respective cryptosystem, with the key as argument if required. Similar usage for the utility functions as well. See <a class="reference external" href="proxy.php?url=https%3A%2F%2Fgithub.com%2F%3Ca+href%3D"https://cryptosystems.readthedocs.io/en/latest/">docs</a" rel="nofollow">https://cryptosystems.readthedocs.io/en/latest/">docs</a> for the exact reference example of a specific cryptosystem if required.</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">cryptosystems</span> <span class="kn">import</span> <span class="n">SomeCryptosystem</span>
<span class="n">cipher</span> <span class="o">=</span> <span class="n">SomeCryptosystem</span><span class="p">()</span>
<span class="n">ciphertext</span> <span class="o">=</span> <span class="n">cipher</span><span class="o">.</span><span class="n">encrypt</span><span class="p">(</span><span class="s2">"Hello World"</span><span class="p">)</span>
<span class="nb">print</span><span class="p">(</span><span class="n">ciphertext</span><span class="p">)</span> <span class="c1"># Output: 'ciphertext string'</span>
<span class="n">plaintext</span> <span class="o">=</span> <span class="n">cipher</span><span class="o">.</span><span class="n">decrypt</span><span class="p">(</span><span class="n">ciphertext</span><span class="p">)</span>
<span class="nb">print</span><span class="p">(</span><span class="n">plaintext</span><span class="p">)</span> <span class="c1"># Output: 'Hello World'</span>
</pre></div>
</div>
</section>
<section id="license">
<h1>License<a class="headerlink" href="proxy.php?url=https%3A%2F%2Fgithub.com%2F%23license" title="Link to this heading">#</a></h1>
<p>This project is licensed under the Apache License - see the <a class="reference external" href="proxy.php?url=https%3A%2F%2Fgithub.com%2F%3Ca+href%3D"https://github.com/ishan-surana/cryptosystems/blob/main/LICENCE">LICENSE</a">https://github.com/ishan-surana/cryptosystems/blob/main/LICENCE">LICENSE</a> file for details.</p>
</section>
<section id="authors">
<h1>Authors<a class="headerlink" href="proxy.php?url=https%3A%2F%2Fgithub.com%2F%23authors" title="Link to this heading">#</a></h1>
<ul class="simple">
<li><p><strong>Ishan Surana</strong> - <em>Inception, implementation and testing</em> - <a class="reference external" href="proxy.php?url=https%3A%2F%2Fgithub.com%2F%3Ca+href%3D"https://github.com/ishan-surana">GitHub</a></p></li">https://github.com/ishan-surana">GitHub</a></p></li>
</ul>
</section>
<section id="acknowledgments">
<h1>Acknowledgments<a class="headerlink" href="proxy.php?url=https%3A%2F%2Fgithub.com%2F%23acknowledgments" title="Link to this heading">#</a></h1>
<ul class="simple">
<li><p><span class="raw-html-m2r"><del>PyCryptodome, for the logic of functions in the [functions submodule](https://github.com/ishan-surana/cryptosystems/blob/main/cryptosystems/functions.py)</del></span> (Python-based implementation, discontinued from version v1.x onward)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">bcrypt.h</span></code> and <code class="docutils literal notranslate"><span class="pre">gmp.h</span></code>, for functions in the <a class="reference external" href="proxy.php?url=https%3A%2F%2Fgithub.com%2F%3Ca+href%3D"https://github.com/ishan-surana/cryptosystems/tree/main/cryptosystems/functions.py">functions">https://github.com/ishan-surana/cryptosystems/tree/main/cryptosystems/functions.py">functions submodule</a></p></li>
</ul>
</section>
</article>
<footer class="prev-next-footer d-print-none">
<div class="prev-next-area">
</div>
</footer>
</div>
<div class="bd-sidebar-secondary bd-toc"><div class="sidebar-secondary-items sidebar-secondary__inner">
<div class="sidebar-secondary-item">
<div class="page-toc tocsection onthispage">
<i class="fa-solid fa-list"></i> Contents
</div>
<nav class="bd-toc-nav page-toc">
<ul class="visible nav section-nav flex-column">
<li class="toc-h1 nav-item toc-entry"><a class="reference internal nav-link" href="proxy.php?url=https%3A%2F%2Fgithub.com%2F%23">Overview</a></li>
<li class="toc-h1 nav-item toc-entry"><a class="reference internal nav-link" href="proxy.php?url=https%3A%2F%2Fgithub.com%2F%23key-advantages">Key Advantages</a></li>
<li class="toc-h1 nav-item toc-entry"><a class="reference internal nav-link" href="proxy.php?url=https%3A%2F%2Fgithub.com%2F%23installation">Installation</a></li>
<li class="toc-h1 nav-item toc-entry"><a class="reference internal nav-link" href="proxy.php?url=https%3A%2F%2Fgithub.com%2F%23usage">Usage</a></li>
<li class="toc-h1 nav-item toc-entry"><a class="reference internal nav-link" href="proxy.php?url=https%3A%2F%2Fgithub.com%2F%23license">License</a></li>
<li class="toc-h1 nav-item toc-entry"><a class="reference internal nav-link" href="proxy.php?url=https%3A%2F%2Fgithub.com%2F%23authors">Authors</a></li>
<li class="toc-h1 nav-item toc-entry"><a class="reference internal nav-link" href="proxy.php?url=https%3A%2F%2Fgithub.com%2F%23acknowledgments">Acknowledgments</a></li>
</ul>
</nav></div>
</div></div>
</div>
<footer class="bd-footer-content">
<div class="bd-footer-content__inner container">
<div class="footer-item">
<p class="component-author">
By Ishan Surana
</p>
</div>
<div class="footer-item">
<p class="copyright">
© Copyright 2024, Ishan Surana.
<br/>
</p>
</div>
<div class="footer-item">
</div>
<div class="footer-item">
</div>
</div>
</footer>
</main>
</div>
</div>
<!-- Scripts loaded after <body> so the DOM is not blocked -->
<script src="proxy.php?url=https%3A%2F%2Fgithub.com%2F_static%2Fscripts%2Fbootstrap.js%3Fdigest%3Ddfe6caa3a7d634c4db9b"></script>
<script src="proxy.php?url=https%3A%2F%2Fgithub.com%2F_static%2Fscripts%2Fpydata-sphinx-theme.js%3Fdigest%3Ddfe6caa3a7d634c4db9b"></script>
<footer class="bd-footer">
</footer>
</body>
</html>