wilcocrypt 1.0.0 → 2.0.0

package/README.md

@@ -1,77 +1,111 @@
-# wilcocrypt
+# WilcoCrypt
 
-wilcocrypt is een prachtige tool voor het vergrendelen, oftewel encrypten, van JavaScript code.
+**WilcoCrypt** is a simple and secure file encryption tool for Node.js.  
+It offers both a clean programmatic API and a practical command-line interface (CLI) for everyday use.
 
-## Voorbeeld
+The library focuses on strong defaults, portability, and predictable behavior across environments
+(including low-end devices such as Raspberry Pi and Android/Termux).
 
-### config.json
-In config.json moet de even het begin van JSON code toevoegen, de rest word automatisch gedaan.
-```json
-{}
-```
+---
 
-### main.js
-Hierin moet de originele JavaScript code.
-```js
-console.log("Voorbeeld");
+## Features
+
+- AES-256-GCM authenticated encryption
+- Password-based key derivation using scrypt
+- MessagePack + gzip for compact encrypted files
+- Built-in versioning and compatibility checks
+- Clear and consistent error handling
+- Clean separation between public API and internal helpers
+- Command-line interface (CLI) for quick file encryption and decryption
+
+---
+
+## Installation
+
+```bash
+npm install wilcocrypt
 ```
 
-### encrypt.js
-Hierin staat de code voor het encrypten.
-```js
-const wilcocrypt = require("wilcocrypt");
-const path = require("path");
+### CLI Installation
 
-wilcocrypt.encryptFile(path.join(__dirname, "config.json"), path.join(__dirname, "main.js"), path.join(__dirname, "encrypted"));
+```bash
+npm install -g wilcocrypt
 ```
-Dit zorgt ervoor dat het bestand config.json word genomen als keyFile, main.js als JavaScript bestand, en encrypted als de map waar het bestand inkomt.
 
-### decrypt.js
-Hierin staat de code voor het decrypten.
+---
+
+## Usage (Node.js)
+
 ```js
-const wilcocrypt = require("wilcocrypt");
-const path = require("path");
+import wilcocrypt from 'wilcocrypt';
 
-const main = wilcocrypt.decryptFile(path.join(__dirname, "config.json"),  path.join(__dirname, "encrypted"));
+// Encrypt a file
+wilcocrypt.encryptFile('document.txt', 'myStrongPassword');
 
-main(require, __dirname);
+// Decrypt a file
+const content = wilcocrypt.decryptFile('document.txt.enc', 'myStrongPassword');
+console.log(content);
 ```
-Hierin staat weer dat config.json word genomen als keyFile en encrypted als de map waar het bestand instaat.
 
-Als je nu uitvoert:
-```shell
-node encrypt.js
-```
-Dan komt er een mapje encrypted met daarin iets zoals dit:
-```
-ec3d347f42dcb45872dbe11384511403442d24fe0c502e2070db8ca2fea0c3f9c2d1bb15c0f27a83ed128c545ee668f176d4c4c3ce78fe3c69f0979c80e9ee2e97533b2701b90cff18af9643441ccfde6b428c7746fd722ccf6b9290be12254b9a5d0bbbc121442d8a6077b8857c87788acfd00c0448e5e8edd28c093f1f24b016743aa13bbff1ecf0a6e7424307973d440f57cf3bc6b4770018c9e2effeaeb94b762975c526f44299d8734e1407ae994b27dabf6fed930ee0201e90812aa547b57cd75e718d96bb7915e2c1d37026b7bcec4c5c331a17b4f882f43f427ccf9b99a4ed51921bfdede2b40a493034e3016144bc1db0f93616e9bafcaf2e04623699d768ed6b099fc2a29820c39329de6e58e392c6ff43722b57f9bb3e006fbd0e4a5ba83ae7844b780dffd347115a070587def1a552ffbb3fa248a50d55a3e20b0632de552a83f995bf0697e963809d51d08c2cc3675d2d1e1427ac74279b40ebb5298576dec079b726e3ca1590c67119943ca3b265f3afe64df6acb1ddd5a285d8812bc1964c68a2c4fb69c9f0b4e4828ac7bd6778e5bac26da778aac5f5db727eb8da208cabad5f19f020125a71c6f1611f5e3e3add92e7b994c253eaf4becbb092309294952afae4e7bd2e16761b8d5f2ec1cafc5782ceaa0ee7cd1acd9cf7417a3a38f2ffc19f47c5c48dcecb240d83ad82fb16ea82633ac15a4c0af8aa614de5eaadbf550861c90aa2f1004957d96c3bf12c6ba3b766319a065bbf44b08e24576819249fa84b8583b4828d983338efa35f744fc75d9b3f96a23a552d655290cd0d3826cc24d883a39212c28addfcba95a0efcd5a8e14a56f08b17e5db749c063459a3e45d6c1ca89f86bc7d5fb5b6a0c745a27a918fc2169fdd9f6974d41f778a3078557d785d1b9bd0f40b890b1c21a7011f5ce8198b57603b219036400016c936a1b0e91a63037c7397d5d1a463a2ebf293c3217694c854a28d42cd3a08588470b2390a8df1d21f489cf68f279e8b45edf8f45d299ac6d50dc2f37139d17cba18ecb264783e1484b8e9bfa916820788371484f821a0a5464df34cbf95a6faab3bd4cfd128cc9acb57ef4f2893f96b324ee06968b199836797601d64c0670602cec99c561387399459114cf5c5a8556f7878538cbfddf95e2bfec6e3199120e8e8cde931a9816b86e3562185ab023e0fe2cd10f75685b03734f05380d9803c50bbe9bfc112ccfdb45e537e9b5e645536a0b6a5bf071722de3ef2522e0912b51c2cf5a1e268cd2207d242ce5797001d44482d0cc5931e84c7039674576f9d44b67739d1eaab7fd94e50cd191cc460f805cc27143834a37f76ccd65271ce2342f23c50806e509a2567982d008c5256bace9cb81b9f46e2b1c2d41bdb94b357227c3bc0e3f49eabd390d596cd1349a28d5a3c60e6e7ac65fdffabe797a6a4352f4ab67228f52c17dedd83a14f2faf2479757aac21818741c13323b27c12f18858ef2c3362ed730651ffdd64c166ffb53b8a2703d191b2160aaaf36aee571adc522cf148be4a7cb07eb58f3d702959c857e1b4fb9f80d8d616fbd98f1acb92a983bb480a43635b1ef6a47e471098974eb00babaee1127c0f3a4911b7d1f52d1
-```
-Als je uitvoert:
-```shell
-node decrypt.js
-```
-dan komt er:
-```
-Voorbeeld
-```
+---
+
+## Internal helpers (optional)
 
-## Extra functie
+Advanced users can access internal helpers via `wilcocrypt._`.
+These APIs are considered internal and may change between versions.
 
-Voor de mensen die het leuk vinden is er ook nog de `decryptLog` functie. Die is als volgt te gebruiken:
 ```js
-const wilcocrypt = require("wilcocrypt");
-const path = require("path");
+const iv = Buffer.from('...');
+const key = Buffer.from('...');
+const encrypted = wilcocrypt._.encryptData(Buffer.from('Hello'), key, iv);
+```
 
-const decrypted = wilcocrypt.decryptLog(path.join(__dirname, "config.json"),  path.join(__dirname, "encrypted"));
+---
 
-console.log(decrypted);
-```
-Dan komt de letterlijke decrypte code eruit:
-```js
-(function(_0xbf65d7,_0x15daa7){var _0x3afcd9=_0x1c81,_0x162bea=_0xbf65d7();while(!![]){try{var _0x72f333=-parseInt(_0x3afcd9(0x1cd))/0x1*(parseInt(_0x3afcd9(0x1c5))/0x2)+-parseInt(_0x3afcd9(0x1c7))/0x3*(-parseInt(_0x3afcd9(0x1cf))/0x4)+parseInt(_0x3afcd9(0x1c6))/0x5*(-parseInt(_0x3afcd9(0x1c8))/0x6)+-parseInt(_0x3afcd9(0x1cc))/0x7*(parseInt(_0x3afcd9(0x1c9))/0x8)+parseInt(_0x3afcd9(0x1cb))/0x9+parseInt(_0x3afcd9(0x1ce))/0xa+parseInt(_0x3afcd9(0x1ca))/0xb;if(_0x72f333===_0x15daa7)break;else _0x162bea['push'](_0x162bea['shift']());}catch(_0x40b1fe){_0x162bea['push'](_0x162bea['shift']());}}}(_0x28c4,0x64e14),console['log']('Test'));function _0x1c81(_0x3d5a59,_0x380b95){var _0x28c429=_0x28c4();return _0x1c81=function(_0x1c8195,_0x52ce1d){_0x1c8195=_0x1c8195-0x1c5;var _0x1c95c4=_0x28c429[_0x1c8195];return _0x1c95c4;},_0x1c81(_0x3d5a59,_0x380b95);}function _0x28c4(){var _0x1e89dd=['1008jGxdEe','7819449tGJxNe','1651914cFJLIy','4907qNvfVo','125821GAjXcS','2295720dsiUxg','989348uvKaZU','2oNaZQT','79145gxkvGD','3anJDXL','282HSwsBf'];_0x28c4=function(){return _0x1e89dd;};return _0x28c4();}
+## CLI Usage
+
+Once installed globally:
+
+```bash
+# Encrypt a file
+wilcocrypt -e document.txt
+wilcocrypt --encrypt document.txt
+
+# Decrypt a file
+wilcocrypt -d document.txt.enc
+wilcocrypt --decrypt document.txt.enc
+
+# Internal: unpack raw encrypted envelope
+wilcocrypt --unpack document.txt.enc
 ```
-Dit is in princiepe zelfs in de webbrowser uit te voeren, dan krijg je in de console: `Voorbeeld`
 
-#### Credits
+The CLI will securely prompt for a password (input is masked).
+
+---
+
+## Version
+
+- Current version: **2.0.0**
+- Version 1.x is deprecated and should not be used
+
+---
+
+## License
+
+WilcoCrypt is released under the **GPL-3.0-only** license.
+
+You are free to:
+- Use the software for any purpose
+- Study how it works and modify it
+- Redistribute the software
+- Distribute modified versions
+
+Under the condition that:
+- Any distributed derivative work is also licensed under GPL-3.0-only
+- The source code remains available to users
+
+This software is provided **without any warranty**.
+Use it at your own risk.
 
-Dit project is gebaseerd op het github repository [SweatyCircle439/439cription](https://github.com/sweatycircle439/439cription) wat is gelicenseerd onder appache 2.0
+For full license text, see:
+https://www.gnu.org/licenses/gpl-3.0.html