p7mj/PCS
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 2 Wiki Activity

Update README.md

Browse Source
This commit is contained in:
P7MJ
2026-06-27 16:11:17 -04:00
parent 7d0bebd51a
commit 0cc425865c
1 changed files with 11 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@@ -4,7 +4,7 @@
PCS is a secure and lightweight Python utility designed to encrypt and decrypt any type of file that can be read in binary. Virtually every file can be encrypted and decrypted, including archives, pictures, movies, code, and programs.
It is the standard encryption program for [BUGPy-mOS](https://git.wholeworldcoding.com/wholeworldcoding/BUGPy-mOS) (implemented as the FDEA launcher and encryption "ant"). An implementation derived from the older A-2-i is included in BUGPy as an utility.
It is the standard encryption program for [BUGPy-mOS](https://git.wholeworldcoding.com/wholeworldcoding/BUGPy-mOS) (implemented as the FDEA launcher and encryption "ant"). An implementation derived from the older A-2-i is included in BUGPy as a utility.
This version features total extension freedom. You can now not only encrypt `.zip` files, but any type of file readable in binary. Additionally, there are no longer any limits regarding the names and extensions of the archives and the keyfiles generated.
@@ -25,7 +25,7 @@ PCS is tested on **Debian Trixie** only. It should work on other Linux distribut
- Removal of original files, including keyfiles, is supported after encryption or decryption.
> [!TIP]
> The security of the archive depends on your password! Since there is no limit to your password length, or complexity, ensure your password has >9 chars and includes symbols and numbers. This makes it impractical for attackers to brute-force your password in time.
> The security of the archive depends on your password! Since there is no limit to your password length, or complexity, it is strongly recommended that your password has at least 12 chars and includes symbols and numbers. This makes it impractical for attackers to brute-force your password in time.
## 🛠️ Installation and Dependencies
@@ -39,19 +39,19 @@ PCS requires Python 3.x and the `cryptography` library.
## 🧑‍💻 Usage
### Launching the tool
Navigate to the folder and run:
```
python3 pcs-a-3-ii-terminal.py
```
You will be greeted by a prompt:
You will be greeted by a prompt (`PCS`), which you can then run the commands in.
```
[PCS]
```
### Command Usage
Command Usage:
Syntax:
`encrypt unencrypted_name [encrypted_name] password [use_key] [keyfile_name] [delete_original]`
@@ -75,16 +75,13 @@ Examples:
- Decrypts `archive.zip.p7c_enc` into `archive.zip` with password `hello!na` and using `archive_key.p7c_key` as the keyfile. Deletes `archive_zip.p7c_enc` and `archive_key.p7c_key` after decryption.
All parameters in square brackets (`[]`) are required. If you wish to leave them as blank/false, put one of the negative keywords in their position. If you wish to leave them as true, put one of the positive keywords in their position.
Negative keywords: `None`, `0`, `no`, `No`, or `False`
All parameters in square brackets (`[]`) are optional, but you must put something in there.
Positive keywords:
If you wish to leave them blank, please type one of `None`, `0`, `no`, `No`, `False` in their place. If you wish to set use_key or delete_original to True, please type one of `True`, `1`
- `yes`
- `Yes`
- `exists`
- `Exists`
in their place.
If you wish to leave one of them blank, please type one of `None`, `0`, `no`, `No`, or `False` in its place. If you wish to set use_key or delete_original to True, please type one of `True`, `1`, `yes`, `Yes`, `exists`, or `Exists` in its place.
> [!TIP]
> Typing `help` lists all commands and their usage!