# RC4Encryption
## Description
This package implements the RC4 encryption.
## Requirements
This package require:
- python3
- python3 Standard Library
## Installation
```bash
pip install RC4Encryption
```
## Usages
### Recommended options
```bash
rc4 [key] -6 -o [secrets.cipher] -i [secrets.file] # encryption
rc4 [key] -n base64 -i [secrets.cipher] -o [decipher.file] -d # decryption
```
### Command line
#### Module
```bash
python3 -m RC4Encryption rc4key -s secrets
```
#### Python executable
```bash
python3 RC4Encryption.pyz rc4key -s secrets
```
#### Command
##### Basic
```bash
rc4 rc4key -s secrets # encrypt "secrets" with rc4key sha256 as key
```
##### Advanced
```bash
rc4 rc4key -s secrets # encrypt "secrets" with rc4key as key
echo secrets| rc4 rc4key --no-sha256 -i # encrypt "secrets\n" with sha256 of rc4key as key
rc4 rc4key -i secrets.txt # encrypt secrets.txt file with rc4key as key
rc4 rc4key -o encrypt.rc4 -s secrets # encrypt "secrets" with rc4key as key and redirect the output to the encrypt.rc4 file
rc4 rc4key -i encrypt.rc4 -d # decrypt encrypt.rc4 with rc4key as key
## INPUT ENCODING
rc4 rc4key -n base64 -s c2VjcmV0cw== # encrypt "secrets" with rc4key sha256 as key ("c2VjcmV0cw==" = base64("secrets"))
## OUTPUT ENCODING
rc4 rc4key -s secrets -8 # encrypt "secrets" with rc4key sha256 as key, base85-encoded output
rc4 rc4key -s secrets -6 # encrypt "secrets" with rc4key sha256 as key, base64-encoded output
rc4 rc4key -s secrets -3 # encrypt "secrets" with rc4key sha256 as key, base30-encoded output
rc4 rc4key -s secrets -1 # encrypt "secrets" with rc4key sha256 as key, base16-encoded output
rc4 rc4key -s secrets -u # encrypt "secrets" with rc4key sha256 as key, uu-encoded output
```
### Python script
```python
from RC4Encryption import RC4Encryption
rc4 = RC4Encryption(b'key')
rc4.make_key()
cipher = rc4.crypt(b'secrets')
cipher_continuation = rc4.crypt(b'secrets')
rc4.reset(b'key')
rc4.make_key()
decipher = rc4.crypt(cipher)
decipher_continuation = rc4.crypt(cipher_continuation)
```
## Links
- [Github Page](https://github.com/mauricelambert/RC4Encryption/)
- [Documentation](https://mauricelambert.github.io/info/python/security/RC4Encryption.html)
- [Pypi package](https://pypi.org/project/RC4Encryption/)
- [Executable](https://mauricelambert.github.io/info/python/security/RC4Encryption.pyz)
## Help
```text
usage: RC4.py [-h] (--input-file [INPUT_FILE] | --input-string INPUT_STRING) [--output-file OUTPUT_FILE]
[--base85 | --base64 | --base32 | --base16 | --output-encoding {base64,base85,base16,base32}]
[--input-encoding {base64,base85,base16,base32}] [--sha256]
key
This file performs RC4 encryption.
positional arguments:
key Encryption key.
options:
-h, --help show this help message and exit
--input-file [INPUT_FILE], --i-file [INPUT_FILE], -i [INPUT_FILE]
The secrets file to be encrypted.
--input-string INPUT_STRING, --string INPUT_STRING, -s INPUT_STRING
The string to be encrypted.
--output-file OUTPUT_FILE, --o-file OUTPUT_FILE, -o OUTPUT_FILE
The output file.
--base85, --85, -8 Base85 encoding as output format
--base64, --64, -6 Base64 encoding as output format
--base32, --32, -3 Base32 encoding as output format
--base16, --16, -1 Base16 encoding as output format
--output-encoding {base64,base85,base16,base32}, --o-encoding {base64,base85,base16,base32}, -e {base64,base85,base16,base32}
Output encoding.
--input-encoding {base64,base85,base16,base32}, --i-encoding {base64,base85,base16,base32}, -n {base64,base85,base16,base32}
Input encoding.
--sha256 Use the sha256 of the key as the key.
```
## Licence
Licensed under the [GPL, version 3](https://www.gnu.org/licenses/).
Raw data
{
"_id": null,
"home_page": "https://github.com/mauricelambert/RC4Encryption",
"name": "RC4Encryption",
"maintainer": "Maurice Lambert",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "mauricelambert434@gmail.com",
"keywords": "RC4,Encryption,Cipher",
"author": "Maurice Lambert",
"author_email": "mauricelambert434@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/2c/9f/bfcc48d6b6261fff2f2a653bceab793eb3baa939adf0a6525ffdf444584b/RC4Encryption-0.0.2.tar.gz",
"platform": "Windows",
"description": "![RC4Encryption logo](https://mauricelambert.github.io/info/python/security/RC4Encryption_small.png \"RC4Encryption logo\")\n\n# RC4Encryption\n\n## Description\n\nThis package implements the RC4 encryption.\n\n## Requirements\n\nThis package require:\n\n - python3\n - python3 Standard Library\n\n## Installation\n\n```bash\npip install RC4Encryption\n```\n\n## Usages\n\n### Recommended options\n\n```bash\nrc4 [key] -6 -o [secrets.cipher] -i [secrets.file] # encryption\nrc4 [key] -n base64 -i [secrets.cipher] -o [decipher.file] -d # decryption\n```\n\n### Command line\n\n#### Module\n\n```bash\npython3 -m RC4Encryption rc4key -s secrets\n```\n\n#### Python executable\n\n```bash\npython3 RC4Encryption.pyz rc4key -s secrets\n```\n\n#### Command\n\n##### Basic\n\n```bash\nrc4 rc4key -s secrets # encrypt \"secrets\" with rc4key sha256 as key\n```\n\n##### Advanced\n\n```bash\nrc4 rc4key -s secrets # encrypt \"secrets\" with rc4key as key\necho secrets| rc4 rc4key --no-sha256 -i # encrypt \"secrets\\n\" with sha256 of rc4key as key\nrc4 rc4key -i secrets.txt # encrypt secrets.txt file with rc4key as key\nrc4 rc4key -o encrypt.rc4 -s secrets # encrypt \"secrets\" with rc4key as key and redirect the output to the encrypt.rc4 file\nrc4 rc4key -i encrypt.rc4 -d # decrypt encrypt.rc4 with rc4key as key\n\n## INPUT ENCODING\n\nrc4 rc4key -n base64 -s c2VjcmV0cw== # encrypt \"secrets\" with rc4key sha256 as key (\"c2VjcmV0cw==\" = base64(\"secrets\"))\n\n## OUTPUT ENCODING\n\nrc4 rc4key -s secrets -8 # encrypt \"secrets\" with rc4key sha256 as key, base85-encoded output\nrc4 rc4key -s secrets -6 # encrypt \"secrets\" with rc4key sha256 as key, base64-encoded output\nrc4 rc4key -s secrets -3 # encrypt \"secrets\" with rc4key sha256 as key, base30-encoded output\nrc4 rc4key -s secrets -1 # encrypt \"secrets\" with rc4key sha256 as key, base16-encoded output\nrc4 rc4key -s secrets -u # encrypt \"secrets\" with rc4key sha256 as key, uu-encoded output\n```\n\n### Python script\n\n```python\nfrom RC4Encryption import RC4Encryption\n\nrc4 = RC4Encryption(b'key')\nrc4.make_key()\ncipher = rc4.crypt(b'secrets')\ncipher_continuation = rc4.crypt(b'secrets')\n\n\nrc4.reset(b'key')\nrc4.make_key()\ndecipher = rc4.crypt(cipher)\ndecipher_continuation = rc4.crypt(cipher_continuation)\n```\n\n## Links\n\n - [Github Page](https://github.com/mauricelambert/RC4Encryption/)\n - [Documentation](https://mauricelambert.github.io/info/python/security/RC4Encryption.html)\n - [Pypi package](https://pypi.org/project/RC4Encryption/)\n - [Executable](https://mauricelambert.github.io/info/python/security/RC4Encryption.pyz)\n\n## Help\n\n```text\nusage: RC4.py [-h] (--input-file [INPUT_FILE] | --input-string INPUT_STRING) [--output-file OUTPUT_FILE]\n [--base85 | --base64 | --base32 | --base16 | --output-encoding {base64,base85,base16,base32}]\n [--input-encoding {base64,base85,base16,base32}] [--sha256]\n key\n\nThis file performs RC4 encryption.\n\npositional arguments:\n key Encryption key.\n\noptions:\n -h, --help show this help message and exit\n --input-file [INPUT_FILE], --i-file [INPUT_FILE], -i [INPUT_FILE]\n The secrets file to be encrypted.\n --input-string INPUT_STRING, --string INPUT_STRING, -s INPUT_STRING\n The string to be encrypted.\n --output-file OUTPUT_FILE, --o-file OUTPUT_FILE, -o OUTPUT_FILE\n The output file.\n --base85, --85, -8 Base85 encoding as output format\n --base64, --64, -6 Base64 encoding as output format\n --base32, --32, -3 Base32 encoding as output format\n --base16, --16, -1 Base16 encoding as output format\n --output-encoding {base64,base85,base16,base32}, --o-encoding {base64,base85,base16,base32}, -e {base64,base85,base16,base32}\n Output encoding.\n --input-encoding {base64,base85,base16,base32}, --i-encoding {base64,base85,base16,base32}, -n {base64,base85,base16,base32}\n Input encoding.\n --sha256 Use the sha256 of the key as the key.\n```\n\n## Licence\n\nLicensed under the [GPL, version 3](https://www.gnu.org/licenses/).\n",
"bugtrack_url": null,
"license": "GPL-3.0 License",
"summary": "This package implements RC4 encryption.",
"version": "0.0.2",
"project_urls": {
"Documentation": "https://mauricelambert.github.io/info/python/security/RC4Encryption.html",
"Executable": "https://mauricelambert.github.io/info/python/security/RC4Encryption.pyz",
"Homepage": "https://github.com/mauricelambert/RC4Encryption"
},
"split_keywords": [
"rc4",
"encryption",
"cipher"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2c9fbfcc48d6b6261fff2f2a653bceab793eb3baa939adf0a6525ffdf444584b",
"md5": "4d65fb2b589ff52d3164f7a5565732b6",
"sha256": "d07cfccc0fee756b1dd717c225aee46902f3bece9bf227a08f390191c4588642"
},
"downloads": -1,
"filename": "RC4Encryption-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "4d65fb2b589ff52d3164f7a5565732b6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 18300,
"upload_time": "2024-02-24T15:18:33",
"upload_time_iso_8601": "2024-02-24T15:18:33.351416Z",
"url": "https://files.pythonhosted.org/packages/2c/9f/bfcc48d6b6261fff2f2a653bceab793eb3baa939adf0a6525ffdf444584b/RC4Encryption-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-24 15:18:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mauricelambert",
"github_project": "RC4Encryption",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "rc4encryption"
}
JSON
