Skip to main content

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_errors is 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

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"
  • lang_code (str): Language code for character frequencies. Options: {'en', 'es', 'sv', 'de', 'fr', 'it'}
  • freq_year (str): Year range for character frequencies. Varies by language, available in chronofidelius/unigram_frequencies.py
  • set_frequencies (dict): Custom frequency mappings for uneven key generation
  • set_alphabet (str): Alphabet to use for key generation

Utilizing Custom Character Frequencies

All uneven-type encryptions require character frequencies. If the frequencies you would like to use are not available in chronofidelius/unigram_frequencies.py, you may input your own.

# Custom frequency dictionary
custom_frequencies = {"A": 0.1, "B": 0.2, "C": 0.3, "D": 0.4}

cf.encrypt_homophonic(set_frequencies=custom_frequencies)

License

This project is licensed under the Apache License 2.0. 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

chronofidelius-1.0.3.tar.gz (47.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

chronofidelius-1.0.3-py3-none-any.whl (47.6 kB view details)

Uploaded Python 3

File details

Details for the file chronofidelius-1.0.3.tar.gz.

File metadata

  • Download URL: chronofidelius-1.0.3.tar.gz
  • Upload date:
  • Size: 47.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for chronofidelius-1.0.3.tar.gz
Algorithm Hash digest
SHA256 0ec293691325c0b19d7aac58ad0487a3ebb3a8bd6321afb0f767d16853007a92
MD5 b933069f3aa2279e762b695d3c7f3b8d
BLAKE2b-256 4dfd81057a92fc9a38d8920b91b95491d4f7781348580f535564b9ac82ff2391

See more details on using hashes here.

File details

Details for the file chronofidelius-1.0.3-py3-none-any.whl.

File metadata

  • Download URL: chronofidelius-1.0.3-py3-none-any.whl
  • Upload date:
  • Size: 47.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for chronofidelius-1.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 c36bf740f3e30e0607125969758b35d1e0ff1a1a6f3b4658dac52c1c3634e453
MD5 3501200e1bb23b8231f035d615b54895
BLAKE2b-256 7ba856cf55d231a751371890664447b645ff921b6f9d3d98b412564a7ebe3118

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page