leonetienne/GCrypt
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

readme

Browse Source
This commit is contained in:
Leonetienne 2021-12-06 10:06:14 +01:00
parent c7ea6618f7
commit 4dc402e2e6
1 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
readme.md
View File

@ -11,27 +11,27 @@ This way this provides relatively good diffusion.
* It has a very easy syntax * It has a very easy syntax
* It's slow * It's slow
* It's probably super insecure * It's probably super insecure
* It leaves your keys sprinkled in ram * It leaves your keys sprinkled in ram✨
* Short 128-bit keys🤦‍♂️ * Short 128-bit keys<sup>\*</sup>🤦‍♂️
* But the syntax is pythonlike easy🙇 * But the syntax is pythonlike easy🙇
It's pretty ghetto, you know? It's pretty ghetto, you know?
## What are the actual advantages? ## What are the actual advantages?
* It's two files to import into the project * It's two files to import into your project
* 1 Line to use * 1 Line to use
* 100% cross plattform * 100% cross plattform
## What could i use it for? ## What could I use it for?
* For data obfuscation * For data obfuscation
* If your only other option would be no encryption at all * If your only other option would be no encryption at all
### I am not kidding, don't use this for critical stuff! Homebrew ciphers are most often shit! ### I am not kidding, don't use this for critical stuff! Homebrew ciphers are most often shit!
Especially mine!🦯 Especially mine!🦯
## How do i use this? ## How do I use this?
##### Installation ##### Installation
Download the `.h` and `.cpp` files in [INCLUDE/](https://github.com/Leonetienne/GhettoCrypt/tree/master/INCLUDE) and add them to your projects files. *Single-header-magic*. Download the `.h` and `.cpp` file in [INCLUDE/](https://github.com/Leonetienne/GhettoCrypt/tree/master/INCLUDE) and add them to your projects files. *Single-header-magic*.
##### Working with strings ##### Working with strings
```c++ ```c++
@ -65,6 +65,8 @@ If you want to do more complex stuff, use the cipher-class [`GhettoCipher::Ciphe
This way you could, for example, decrypt an ecrypted file directly into memory. Or use a full-length key instead of a password. This way you could, for example, decrypt an ecrypted file directly into memory. Or use a full-length key instead of a password.
Without saying, this is more advanced and not as-easy as the methods supplied in the wrapper. Without saying, this is more advanced and not as-easy as the methods supplied in the wrapper.
---
* <sup>\*</sup> A key is always of size BLOCK_SIZE. The default block size is 128 (bit), but you can easily change it in [Config.h](https://github.com/Leonetienne/GhettoCrypt/blob/master/GhettoCrypt/Config.h) or wherever it'll be put in the INCLUDE/*.cpp. `BLOCK_SIZE` is also the minimal output length!
## LICENSE ## LICENSE
``` ```