A Python library for for plaintext encryption using homophonic substitution and historical character frequencies.
Project description
ChronoFidelius
ChronoFidelius is a Python library for plaintext encryption using homophonic substitution and historical character frequencies. It provides configurable error injection, frequency-based key generation, and advanced encryption techniques inspired by historical cryptography.
Features
- Homophonic Substitution Cipher: Encrypts plaintext with multiple cipher options for each character
- Frequency-Based Key Generation: Supports even and uneven key generation using historical unigram frequencies
- Error Injection: Introduces errors (additions, deletions, or doubles) into plaintext for obfuscation
- Custom Configurations: Control error frequency, character spacing, and more
Installation
Install ChronoFidelius using pip:
pip install ChronoFidelius
Or, install directly from the source:
git clone https://github.com/mbruton0426/ChronoFidelius.git
cd ChronoFidelius
pip install .
Usage
When initializing ChronoFidelius, the only required variable is some text to encrypt, either as a str or list of str.
Initalization:
from chronofidelius import ChronoFidelius
# Initialize the ChronoFidelius object
cf = ChronoFidelius("Hello, World!")
Optional Parameters: initialization
- set_seed (int, optional): A seed value for reproducibility of random operations. Default is None
- include_errors (bool, optional): If True, introduces errors (e.g., additions, deletions, doubles) into the plaintext. Default is False
- error_type (str, optional): Specifies the type of error to introduce. Must be set if
include_errorsis True. Default is None. Valid options are: - "additions": Adds random characters - "deletions": Removes characters - "doubles": Doubles characters - "all": Randomly selects between "additions", "deletions", or "doubles" - error_frequency (float, optional): Frequency of errors in the plaintext (0–1). For example, 0.05 introduces errors to 5% of the text. Default is 0.05
- include_spacing (bool, optional): If True, retains spaces and line breaks during formatting. Default is False
- max_length (int, optional): Maximum length of the formatted plaintext or chunks. Default is 200
- set_punctuation (str, optional): Specifies the set of punctuation characters to remove. Default is string.punctuation
- set_case (str, optional): Specifies case for plaintext strings. Default is upper. Valid options are: - "upper": Uppercase all characters - "lower": Lowercase all characters - "no_change": Make no changes to case
Encrypting Plaintexts
Plaintexts can be encrypted with:
cf.encrypt_homophonic()
This automatically encrypts plaintext(s) according to every possible option based on the default values. Plaintext(s), ciphertexts, and keys are then all available as a dictionary in:
cf.pt_ct_dict
Optional Parameters: encrypt_homophonic()
- key_type (str): The type of encryption key ("even", "uneven", or "both"). Default is "even"
- encryption_dict (dict): Optional pre-defined encryption dictionary.
- lang_code (str): Language code for character frequencies and automatic alphabet retrieval. Valid options: "Czech (cz)", "Dutch (nl)", "English (en)", "French (fr)", "German (de)", "Greek (el)", "Hungarian (hu)", "Icelandic (is)", "Italian (it)", "Latin (la)", "Polish (pl)", "Russian (ru)", "Slovene (sl)", "Spanish (es)", "Swedish (sv)"
- freq_year (str): Time period for character frequencies. Varies by language. Set to "a" for a print out of available year ranges.
- set_frequencies (dict): Custom frequency mappings for uneven key generation
- set_alphabet (str): Manually set alphabet to use for key generation
- ct_as_int (bool): Whether to represent ciphertext characters as a single string connected by "_" (False), or as a list of string type integers (True). Default is True
- mix_code (tuple, optional): Defines whether to mix different digit-length integer codes in the encryption. Pass a tuple of at least two distinct digit lengths from {1, 2, 3, 4}.
Utilizing Custom Character Frequencies
All uneven-type encryptions require character frequencies. If frequencies are not available for the language you're working with, or you would otherwise like to set your own, you may do so.
# Custom frequency dictionary
custom_frequencies = {"A": 0.1, "B": 0.2, "C": 0.3, "D": 0.4}
cf.encrypt_homophonic(set_frequencies=custom_frequencies)
Using a Predefined Encryption Dictionary
If you have an existing key you would like to use, you can pass it directly
via encryption_dict instead of using automatic key generation.
Note: Providing
encryption_dictbypasses all automatic key generation. Parameterskey_type,lang_code,set_frequencies,set_alphabet,freq_year, andmix_codewill be ignored.
The dictionary should map plaintext characters (or multi-character sequences) to a list of possible ciphertext codes:
encryption_dict = {
"A": ["01", "14", "37"],
"B": ["02"],
"C": ["03", "21"],
# ... one entry per character (or sequence) you want to encrypt
}
cf.encrypt_homophonic(encryption_dict=encryption_dict)
Multi-character keys (nomenclature) are supported and take priority over single-character keys
via longest-match scanning. For example, if both "HE" and "H" are in your
dictionary, the sequence "HE" in the plaintext will always match "HE" first.
Characters not present in encryption_dict are passed through to the
ciphertext unchanged.
Output structure
When using encryption_dict, results are stored under fixed keys rather than
the auto-generated names used by automatic key generation:
cf.pt_ct_dict["0"]["ciphertext"] # the encrypted output
cf.pt_ct_dict["0"]["key"] # the document-specific key dictionary showing which codes were actually used
License
This project is licensed under the MIT License. See the LICENSE file for details.
Citation
If you use this tool in your research, please cite:
@inproceedings{bruton2025statistics,
title = {From Statistics to Neural Networks: Enhancing Ciphertext-Plaintext Alignment in Historical Substitution Ciphers For Automatic Key Extraction},
author = {Bruton, Micaella and Megyesi, Be{\'a}ta},
booktitle = {Proceedings of the International Conference on Historical Cryptology (HistoCrypt)},
year = {2025},
}
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file chronofidelius-1.2.0.tar.gz.
File metadata
- Download URL: chronofidelius-1.2.0.tar.gz
- Upload date:
- Size: 89.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e62d643d60f5f0311a5fa3f45f9fa719bda5ac20dbe75529d147320e36499538
|
|
| MD5 |
4b3fe31b7b4d2468b64d95bd9775fc76
|
|
| BLAKE2b-256 |
0c309429ebecd2cbd4e7b9204e3140f6af9d608d2b75ef02d8b8d895a05b186a
|
File details
Details for the file chronofidelius-1.2.0-py3-none-any.whl.
File metadata
- Download URL: chronofidelius-1.2.0-py3-none-any.whl
- Upload date:
- Size: 91.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f3e227bef7fa33ae9b3e2fbf4eefba45b75cacef02864a0a3a70b3b33ccd66a4
|
|
| MD5 |
7bb467600d310fa359f93698eab0fe25
|
|
| BLAKE2b-256 |
7d42c0912a701a137af66cdd0ae5aa2f545126dabb6badfc0b7a08d4495f7f92
|