joelsleeba/xor-encryptor

Created this when I was quarentined with Covid-19 and wanted to be little creative in exchanging letters

% xor-encryptor(7) 0.5
% Joel Sleeba
% Jan 2022

# NAME
**xor-encryptor** - encrypt text keyphrase

# SYNOPSIS
python xor-encryptor.py {-b} -{e,d} -k {key_file} -i {input_file} -o {output_file}


# DESCRIPTION
**xor-encryptor** encrypt/decrypt texts with the logical xor. It takes input from the _input_file_ and output to _output_file_


# OPTIONS
-----------------------------
-b
    : toggle binary file operations mode. off by default.

-e
    : to encrypt

-d
    : to decrypt

-k
    : specify the keyfile

-i *input_file*
    : specify the input file

-o *output_file*
    : specify the output file
    : '-o -' will output to STDOUT in -b mode, allowing to pipe streams.
    : try python xor-encryptor -b -d -k keys/samplekey -i output/image.png -o - |chafa
    : you can use chafa or img2sixel, given that your terminal supports sixel output.


# EXAMPLES
-----------------------------
- python xor-encryptor.py
    : Will ask if to encrypt/decrypt, keyphrase, input text and output all from/to the STDIN

- python xor-encryptor.py -e
    : same as *python xor-encryptor.py* but knows it is to encrypt

- python xor-encryptor.py -d -i inputfile
    : will ask for key and will output in STDIN

- python xor-encryptor.py -e -i plaintext.txt -o cipher.txt
    : Encrypts the content in *plaintext.txt* and saves it in *cipher.txt*

- python xor-encryptor.py -d -k keyfile -i ciphertext.txt -o plaintext.txt
    : Decrypts the content in *ciphertext.txt* and saves it in *plaintext.txt*

- python xor-encryptor.py -b -k keyfile -i img.png -o enc_img.png
    : Encrypts/Decrypts a binary file. if -k is not specified, it'll ask to input keyphrase from command prompt