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

professionalize wording

Browse Source
This commit is contained in:
Leon Etienne
2026-08-08 17:02:53 +02:00
parent 77fca14226
commit 6842db6434
2 changed files with 9 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files
GCryptLib/doxygen/doxyfig
+1 -1
View File
@@ -44,7 +44,7 @@ PROJECT_NUMBER =
# for a project that appears at the top of each page and should give viewer a # for a project that appears at the top of each page and should give viewer a
# quick idea about the purpose of the project. Keep the description short. # quick idea about the purpose of the project. Keep the description short.
PROJECT_BRIEF = "Ghetto (but also super easy) cryptography!" PROJECT_BRIEF = "An educational cryptography library (GCrypt / GNU Crypt)"
# With the PROJECT_LOGO tag one can specify a logo or an icon that is included # With the PROJECT_LOGO tag one can specify a logo or an icon that is included
# in the documentation. The maximum height of the logo should not exceed 55 # in the documentation. The maximum height of the logo should not exceed 55
readme.md
+8 -11
View File
@@ -1,24 +1,22 @@
[![Build Status](https://drone.leonetienne.de/api/badges/leonetienne/GCrypt/status.svg)](https://drone.leonetienne.de/leonetienne/GCrypt) [![Build Status](https://drone.leonetienne.de/api/badges/leonetienne/GCrypt/status.svg)](https://drone.leonetienne.de/leonetienne/GCrypt)
# GCrypt # GCrypt
*(GhettoCrypt), because frankly I have no idea what the fuck I'm doing* *GCrypt (GNU Crypt) — an educational project for learning how block ciphers work*
<sub>*Please don't use this for anything critical*</sub> <sub>*Please don't use this for anything critical*</sub>
> **Note:** This project is unrelated to [libgcrypt](https://www.gnupg.org/software/libgcrypt/index.html), the cryptographic library used by GnuPG. Any naming similarity is coincidental — "GCrypt" here just stands for "GNU Crypt".
## [Documentation](https://gcrypt.rtfm.leonetienne.de/) ## [Documentation](https://gcrypt.rtfm.leonetienne.de/)
## What the hell is this? ## What is this?
An educational project on implementing a block cipher using a feistel network. An educational project on implementing a block cipher using a feistel network.
This block cipher employs a few modes of operation. Read more about them [here](#modes-of-operation). This block cipher employs a few modes of operation. Read more about them [here](#modes-of-operation).
## Features ## Features
* It has very easy syntax * Very easy to use
* It's slow
* It's probably super insecure
* But the syntax is pythonlike easy🙇
* 512-bit keys * 512-bit keys
* Not performance-optimized, and not audited for security
It's pretty ghetto, you know?
## What are the actual advantages? ## What are the actual advantages?
* It's two files to import into your project * It's two files to import into your project
@@ -30,9 +28,8 @@ It's pretty ghetto, you know?
* 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 tend to be shit! ### Seriously, don't use this for anything critical. Homebrew ciphers are rarely secure — this one included.
Especially mine!🗡️ Even assuming it's a good cipher, its implementation leaves a lot to be desired in terms of being cryptographically secure.
Even assumed it's a good cipher, it's implementation leaves a lot to be desired in terms of being cryptographically secure.
## How do I use this? ## How do I use this?
### *"I don't care about the library. Just let me use it from the command line!"* ### *"I don't care about the library. Just let me use it from the command line!"*