X-Git-Url: https://git.njae.me.uk/?a=blobdiff_plain;f=docs%2Fszyfrow%2Findex.html;fp=docs%2Fszyfrow%2Findex.html;h=e27a80f029216165a9c52fa103c28baa628c3545;hb=b535d9d75e69cc395e8de28c99e38564655e5ac9;hp=0000000000000000000000000000000000000000;hpb=f19a021eabb3222709b9d513839a14c01cfdfd38;p=szyfrow.git diff --git a/docs/szyfrow/index.html b/docs/szyfrow/index.html new file mode 100644 index 0000000..e27a80f --- /dev/null +++ b/docs/szyfrow/index.html @@ -0,0 +1,202 @@ +<!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.9.2" /> +<title>szyfrow API documentation</title> +<meta name="description" content="Simple ciphers, enciphering, deciphering, and breaking â¦" /> +<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">Package <code>szyfrow</code></h1> +</header> +<section id="section-intro"> +<p>Simple ciphers, enciphering, deciphering, and breaking.</p> +<p>The ciphers implemented here are mostly ones that predate mechanical cipher +systems. The most complex cipher is the Enigma of World War II.</p> +<p>Each cipher is presented with functions to encipher, decipher, and +automatically break messages with that cipher.</p> +<p>Most of the time, messages are broken by brute-force trying each possible key +and scoring the resulting deciphered message using a bag-of-words probability +measure (or a bag-of-bigrams, or a bag-of-trigrams).</p> +<p>You can find more information on the ciphers and how they are implemented in +the <a href="https://work.njae.me.uk/tag/codes-and-ciphers/">codes and ciphers area of my blog</a>.</p> +<p>Ciphers work on messages encoded with the 26 letters of the Latin alphabet, +without accents (the letters contained in the <code>string.ascii_letters</code> constant). +Most of the ciphers convert letters to lowercase, strip accents from letters, +and drop all other characters (such as spaces and punctuation).</p> +<p><code><a title="szyfrow.support.text_prettify" href="support/text_prettify.html">szyfrow.support.text_prettify</a></code> contains functions to make the output easier +to read, such as automatically recovering word boundaries.</p> +<p>The name comes from the Polish cipher bureau, the Biuro Szyfrów, who were +breaking Enigma ciphers by hand before World War II.</p> +<details class="source"> +<summary> +<span>Expand source code</span> +</summary> +<pre><code class="python">"""Simple ciphers, enciphering, deciphering, and breaking. + +The ciphers implemented here are mostly ones that predate mechanical cipher +systems. The most complex cipher is the Enigma of World War II. + +Each cipher is presented with functions to encipher, decipher, and +automatically break messages with that cipher. + +Most of the time, messages are broken by brute-force trying each possible key +and scoring the resulting deciphered message using a bag-of-words probability +measure (or a bag-of-bigrams, or a bag-of-trigrams). + +You can find more information on the ciphers and how they are implemented in +the [codes and ciphers area of my blog](https://work.njae.me.uk/tag/codes-and-ciphers/). + +Ciphers work on messages encoded with the 26 letters of the Latin alphabet, +without accents (the letters contained in the `string.ascii_letters` constant). +Most of the ciphers convert letters to lowercase, strip accents from letters, +and drop all other characters (such as spaces and punctuation). + +`szyfrow.support.text_prettify` contains functions to make the output easier +to read, such as automatically recovering word boundaries. + +The name comes from the Polish cipher bureau, the Biuro Szyfrów, who were +breaking Enigma ciphers by hand before World War II. +"""</code></pre> +</details> +</section> +<section> +<h2 class="section-title" id="header-submodules">Sub-modules</h2> +<dl> +<dt><code class="name"><a title="szyfrow.affine" href="affine.html">szyfrow.affine</a></code></dt> +<dd> +<div class="desc"><p>Enciphering and deciphering using the <a href="https://en.wikipedia.org/wiki/Affine_cipher">affine cipher</a>. +Also attempts to break messages that use an â¦</p></div> +</dd> +<dt><code class="name"><a title="szyfrow.amsco" href="amsco.html">szyfrow.amsco</a></code></dt> +<dd> +<div class="desc"><p>Enciphering and deciphering using the <a href="http://ericbrandel.com/2016/10/09/the-amsco-cipher/">Amsco cipher</a>. +Also attempts to break messages that use â¦</p></div> +</dd> +<dt><code class="name"><a title="szyfrow.autokey" href="autokey.html">szyfrow.autokey</a></code></dt> +<dd> +<div class="desc"><p>Enciphering and deciphering using the <a href="https://en.wikipedia.org/wiki/Autokey_cipher">Autokey cipher</a>. +Also attempts to break messages that use a â¦</p></div> +</dd> +<dt><code class="name"><a title="szyfrow.bifid" href="bifid.html">szyfrow.bifid</a></code></dt> +<dd> +<div class="desc"><p>Enciphering and deciphering using the <a href="https://en.wikipedia.org/wiki/Bifid_cipher">Bifid cipher</a>. +Also attempts to break messages that use a Bifid â¦</p></div> +</dd> +<dt><code class="name"><a title="szyfrow.bombe" href="bombe.html">szyfrow.bombe</a></code></dt> +<dd> +<div class="desc"><p>A simulator for Bombe machines â¦</p></div> +</dd> +<dt><code class="name"><a title="szyfrow.cadenus" href="cadenus.html">szyfrow.cadenus</a></code></dt> +<dd> +<div class="desc"><p>Enciphering and deciphering using the <a href="https://www.thonky.com/kryptos/cadenus-cipher">Cadenus cipher</a>. +Also attempts to break messages that use a â¦</p></div> +</dd> +<dt><code class="name"><a title="szyfrow.caesar" href="caesar.html">szyfrow.caesar</a></code></dt> +<dd> +<div class="desc"><p>Enciphering and deciphering using the <a href="https://en.wikipedia.org/wiki/Caesar_cipher">Caesar cipher</a>. +Also attempts to break messages that use a Caesar â¦</p></div> +</dd> +<dt><code class="name"><a title="szyfrow.column_transposition" href="column_transposition.html">szyfrow.column_transposition</a></code></dt> +<dd> +<div class="desc"><p>Enciphering and deciphering using the <a href="https://en.wikipedia.org/wiki/Bifid_cipher">Column transposition cipher</a>. +Also attempts to break messages that â¦</p></div> +</dd> +<dt><code class="name"><a title="szyfrow.enigma" href="enigma.html">szyfrow.enigma</a></code></dt> +<dd> +<div class="desc"><p>A simulator for Enigma machines â¦</p></div> +</dd> +<dt><code class="name"><a title="szyfrow.keyword_cipher" href="keyword_cipher.html">szyfrow.keyword_cipher</a></code></dt> +<dd> +<div class="desc"><p>Monoalphabetic substitution ciphers, mainly done by keyword. Enciphering +and deciphering, and a couple of ways to break these ciphers.</p></div> +</dd> +<dt><code class="name"><a title="szyfrow.language_model_files" href="language_model_files/index.html">szyfrow.language_model_files</a></code></dt> +<dd> +<div class="desc"><p>Descriptions of English, used for building language models â¦</p></div> +</dd> +<dt><code class="name"><a title="szyfrow.playfair" href="playfair.html">szyfrow.playfair</a></code></dt> +<dd> +<div class="desc"><p>Enciphering and deciphering using the <a href="https://en.wikipedia.org/wiki/Playfair_cipher">Playfair cipher</a>. +Also attempts to break messages that use a â¦</p></div> +</dd> +<dt><code class="name"><a title="szyfrow.pocket_enigma" href="pocket_enigma.html">szyfrow.pocket_enigma</a></code></dt> +<dd> +<div class="desc"><p>The Pocket Enigma machine, a simple example that illustrates the mechanisms +of the Enigma machine. See [a â¦</p></div> +</dd> +<dt><code class="name"><a title="szyfrow.polybius" href="polybius.html">szyfrow.polybius</a></code></dt> +<dd> +<div class="desc"><p>Simple digraph substitution cipher, using the +<a href="https://en.wikipedia.org/wiki/Polybius_square">Polybius square</a>. Enciphering +and deciphering, and a â¦</p></div> +</dd> +<dt><code class="name"><a title="szyfrow.railfence" href="railfence.html">szyfrow.railfence</a></code></dt> +<dd> +<div class="desc"><p><a href="https://en.wikipedia.org/wiki/Rail_fence_cipher">Railfence transposition cipher</a> â¦</p></div> +</dd> +<dt><code class="name"><a title="szyfrow.support" href="support/index.html">szyfrow.support</a></code></dt> +<dd> +<div class="desc"><p>Support utilities for ciphers â¦</p></div> +</dd> +<dt><code class="name"><a title="szyfrow.vigenere" href="vigenere.html">szyfrow.vigenere</a></code></dt> +<dd> +<div class="desc"><p><a href="https://en.wikipedia.org/wiki/Vigen%C3%A8re_cipher">Vigenère polyalphabetic substitution ciphers</a>, +mainly done by keyword. Also does Beaufort â¦</p></div> +</dd> +</dl> +</section> +<section> +</section> +<section> +</section> +<section> +</section> +</article> +<nav id="sidebar"> +<h1>Index</h1> +<div class="toc"> +<ul></ul> +</div> +<ul id="index"> +<li><h3><a href="#header-submodules">Sub-modules</a></h3> +<ul> +<li><code><a title="szyfrow.affine" href="affine.html">szyfrow.affine</a></code></li> +<li><code><a title="szyfrow.amsco" href="amsco.html">szyfrow.amsco</a></code></li> +<li><code><a title="szyfrow.autokey" href="autokey.html">szyfrow.autokey</a></code></li> +<li><code><a title="szyfrow.bifid" href="bifid.html">szyfrow.bifid</a></code></li> +<li><code><a title="szyfrow.bombe" href="bombe.html">szyfrow.bombe</a></code></li> +<li><code><a title="szyfrow.cadenus" href="cadenus.html">szyfrow.cadenus</a></code></li> +<li><code><a title="szyfrow.caesar" href="caesar.html">szyfrow.caesar</a></code></li> +<li><code><a title="szyfrow.column_transposition" href="column_transposition.html">szyfrow.column_transposition</a></code></li> +<li><code><a title="szyfrow.enigma" href="enigma.html">szyfrow.enigma</a></code></li> +<li><code><a title="szyfrow.keyword_cipher" href="keyword_cipher.html">szyfrow.keyword_cipher</a></code></li> +<li><code><a title="szyfrow.language_model_files" href="language_model_files/index.html">szyfrow.language_model_files</a></code></li> +<li><code><a title="szyfrow.playfair" href="playfair.html">szyfrow.playfair</a></code></li> +<li><code><a title="szyfrow.pocket_enigma" href="pocket_enigma.html">szyfrow.pocket_enigma</a></code></li> +<li><code><a title="szyfrow.polybius" href="polybius.html">szyfrow.polybius</a></code></li> +<li><code><a title="szyfrow.railfence" href="railfence.html">szyfrow.railfence</a></code></li> +<li><code><a title="szyfrow.support" href="support/index.html">szyfrow.support</a></code></li> +<li><code><a title="szyfrow.vigenere" href="vigenere.html">szyfrow.vigenere</a></code></li> +</ul> +</li> +</ul> +</nav> +</main> +<footer id="footer"> +<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.9.2</a>.</p> +</footer> +</body> +</html> \ No newline at end of file