Skip to main content

The Hexafid Cipher reference implementation

Project description

Hexafid

Hexafid is a post-apocalyptic field cipher.

The project goals are to produce a cipher that:

  • works easily with pen and paper
  • secures confidentiality of information
  • offers plausible deniability if discovered
  • exhibits greater strength in software

The project includes a:

  • cipher reference implementation in Python
  • cross platform application with Command Line Interface (CLI)
  • iOS Today View widget usable within Pythonista
  • website hosting a cryptographic oracle (TBD)

all of which implement the Hexafid Cipher.

Caveat Emptor

  • Hexafid began as a hobby project during the COVID-19 pandemic
  • The work has NOT been peer reviewed by the academic community
  • The algorithms have NOT been proven to have strong security
  • The software is released under an open source licence (MIT) that:
    • Limits ANY liability, and
    • Provides NO warranty

Installation

Use the package manager pip to install hexafid.

$ pip install hexafid

Usage

As an end user:

$ hexafid --version
$ hexafid --help
$ hexafid

As a developer:

from hexafid import hexafid_core as hexafid
hexafid.encrypt(message, key, mode, iv, period, rounds)  # returns ciphertext string
hexafid.decrypt(message ,key, mode, period, rounds)  # returns plaintext string

NOTE: developer use of these libraries assumes that you understand the cryptographic implications of changing the parameters in the function calls.

Documentation Home

https://hexafid.gitlab.io/hexafid

Contributing

Merge Requests are welcome. For all changes, please:

  1. open an Issue first to document the activity;
  2. label the Issue (e.g. Bug, Feature, Refactor, Suggestion, Test);
  3. update or add any related tests to support your work;
  4. create an associated Merge Request to discuss changes with a maintainer.

We expect team members to have minimum knowledge as found in https://www.coursera.org/learn/crypto.

License

MIT License

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

hexafid-0.7.3.2.tar.gz (143.0 kB view details)

Uploaded Source

Built Distribution

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

hexafid-0.7.3.2-py3-none-any.whl (37.4 kB view details)

Uploaded Python 3

File details

Details for the file hexafid-0.7.3.2.tar.gz.

File metadata

  • Download URL: hexafid-0.7.3.2.tar.gz
  • Upload date:
  • Size: 143.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.6.0 requests-toolbelt/0.9.1 tqdm/4.50.0 CPython/3.8.6

File hashes

Hashes for hexafid-0.7.3.2.tar.gz
Algorithm Hash digest
SHA256 f44b804b6d5c3aa49a5ad24882bfc76c4b4c12fdc1e7b87822cb68d87ca68d3f
MD5 5e62502b34c302600f3b5982046dd984
BLAKE2b-256 42f6a42df183e99ada5dfba39a1d0ccc5a21baf400fcd68cbefab4a42669a32a

See more details on using hashes here.

File details

Details for the file hexafid-0.7.3.2-py3-none-any.whl.

File metadata

  • Download URL: hexafid-0.7.3.2-py3-none-any.whl
  • Upload date:
  • Size: 37.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.6.0 requests-toolbelt/0.9.1 tqdm/4.50.0 CPython/3.8.6

File hashes

Hashes for hexafid-0.7.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 7e387bf3e1f41bc68d03539874ac7c58f53d5c650fcef24c6003f7ceb277968a
MD5 835544f540f1bb3451b66fe162cd134c
BLAKE2b-256 29bc0f83406e863a14d80b68010a8f30844daf5ee0fd48d14ba05aa18ea5adf3

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