Skip to main content

experimentation

Project description

xoryx

A simple XOR encryption/decryption CLI tool that encrypts files to ASCII hex format.

Installation

pip install xoryx

For development:

uv pip install -e .

Usage

Command Line Mode

Encrypt a file:

xoryx encrypt plaintext.txt encrypted.hex
# Or use short aliases:
xoryx enc plaintext.txt encrypted.hex
xoryx e plaintext.txt encrypted.hex

Decrypt a file:

xoryx decrypt encrypted.hex decrypted.txt
# Or use short aliases:
xoryx dec encrypted.hex decrypted.txt
xoryx d encrypted.hex decrypted.txt

Provide key on command line (not recommended for sensitive data):

xoryx encrypt plaintext.txt encrypted.hex --key "mysecretkey"
xoryx decrypt encrypted.hex decrypted.txt -k "mysecretkey"

If you don't provide a key with --key or -k, you'll be prompted to enter it securely (hidden input).

Interactive Mode

Launch the interactive menu by running xoryx without arguments:

xoryx
# Or explicitly:
xoryx interactive
xoryx i
xoryx menu

This will present a user-friendly menu where you can choose to encrypt or decrypt files interactively.

Options

  • -k, --key: Specify the encryption/decryption key (will prompt if not provided)
  • --encoding: Text encoding (default: utf-8)
  • -h, --help: Show help message

Examples

# Encrypt with prompted key
xoryx encrypt secrets.txt secrets.hex

# Decrypt with key on command line
xoryx decrypt secrets.hex restored.txt -k "mypassword"

# Use custom encoding
xoryx encrypt data.txt data.hex --encoding utf-16

# Interactive mode
xoryx

Features

  • 🔐 Simple XOR encryption/decryption
  • 📝 Outputs to ASCII hex format
  • 🎨 Colored terminal output
  • 🔒 Secure key input (hidden by default)
  • 🎯 Both CLI and interactive modes
  • ⚡ Fast and lightweight

How it works

xoryx uses XOR cipher to encrypt plaintext files. The encrypted output is stored as ASCII hex for easy storage and transmission. While XOR encryption is not suitable for highly sensitive data, it's perfect for quick obfuscation and educational purposes.

License

MIT

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

xoryx-0.0.1.tar.gz (45.8 kB view details)

Uploaded Source

Built Distribution

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

xoryx-0.0.1-py3-none-any.whl (4.9 kB view details)

Uploaded Python 3

File details

Details for the file xoryx-0.0.1.tar.gz.

File metadata

  • Download URL: xoryx-0.0.1.tar.gz
  • Upload date:
  • Size: 45.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.11

File hashes

Hashes for xoryx-0.0.1.tar.gz
Algorithm Hash digest
SHA256 c55e40115f435076bfb56945fee4ce9fd3fc8629a3464c233f1a04d6e2b48af8
MD5 5124e2633e612ed87905d55b247e81c6
BLAKE2b-256 5572757ba78edfabd2875dedc74395558fae0bda4c443c8df495ff414013f729

See more details on using hashes here.

File details

Details for the file xoryx-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: xoryx-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 4.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.11

File hashes

Hashes for xoryx-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 0ef3700a123424186f584532488aa9511e248c47d534a044e4f4ca037194e58b
MD5 599db458e904e7064e3d8754439fed67
BLAKE2b-256 660e325663f929b4440e44434f4f13eb63262272d8842ffa76ac3227644f4d2a

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