cleanup + how to install

bstnbuck · Mar 3, 2024 · 44407d0 · 44407d0
1 parent b74d510
commit 44407d0
Show file tree

Hide file tree

Showing 20 changed files with 28 additions and 63 deletions.
diff --git a/README.md b/README.md
@@ -13,7 +13,7 @@
 * the **current implementation status** of the official V community. 
 * less known but relevant as well as self-developed official algorithms that might be published here. 
 
-### Cryptographic algorithms and protocols available in V standard library
+## Cryptographic algorithms and protocols available in V standard library
 | algorithm | category, info | importance | status | 
 | --- | --- | --- | --- |
 | **AES** | symmetric block cipher | high, daily use | implemented :heavy_check_mark: [[Git](https://github.com/vlang/v/tree/master/vlib/crypto/aes)]|
@@ -39,7 +39,7 @@
 
 > Last Update: 18-02-2024
 
-### Cryptographic algorithms and protocols (not officially) planned for V standard library
+## Cryptographic algorithms and protocols (not officially) planned for V standard library
 
 The V wrapper libsodium [[Git](https://github.com/vlang/libsodium)] has some of these algorithms.
 
@@ -61,7 +61,7 @@ The V wrapper libsodium [[Git](https://github.com/vlang/libsodium)] has some of
 
 > Last Update: 18-02-2024
 
-### Additional cryptographic algorithms implemented/planned in V-crypto (this Repo)
+## Additional cryptographic algorithms implemented/planned in V-crypto (this Repo)
 
 The V wrapper libsodium [[Git](https://github.com/vlang/libsodium)] has some of these algorithms.
 
@@ -86,4 +86,28 @@ The V wrapper libsodium [[Git](https://github.com/vlang/libsodium)] has some of
 | **Twofisch** | symmetric block cipher | moderate | :x: |
 | **yescrypt** | hash-algorithm / key derivation function | high | :x: |
 
-> Last Update: 21-02-2024
+> Last Update: 21-02-2024
+---
+## v_crypto
+### Installation
+```bash
+v install https://github.com/bstnbuck/V-crypto
+```
+
+### Usage
+```v
+import v_crypto.md4
+
+fn main(){
+    // short way to get MD4 hex hash
+    println("`test` hashed with MD4 is: "+md4.hexhash("test"))
+
+    // long way to get bytes array
+    mut d := md4.new()
+    blocksize, bytes_hash := d.checksum('test'.bytes())
+    println("input produces a bytes checksum $bytes_hash.hex() with block size: $blocksize")
+
+    d.reset() // with reset, a new empty checksum can be produced
+    _, _ := d.checksum('Hi from V_crypto. This is an example of a long long line.'.bytes())
+}
+```
diff --git a/argon2/nothing b/argon2/nothing
diff --git a/bp256r1/nothing b/bp256r1/nothing
diff --git a/bp384r1/nothing b/bp384r1/nothing
diff --git a/bp521r1/nothing b/bp521r1/nothing
diff --git a/cipher/cfb/cfb.v → cipher/cfb.v b/cipher/cfb/cfb.v → cipher/cfb.v
diff --git a/cipher/cipher.v b/cipher/cipher.v
diff --git a/cipher/ctr/ctr.v → cipher/ctr.v b/cipher/ctr/ctr.v → cipher/ctr.v
diff --git a/cipher/eax/nothing b/cipher/eax/nothing
diff --git a/cipher/ecb/nothing b/cipher/ecb/nothing
diff --git a/cipher/ige/nothing b/cipher/ige/nothing
diff --git a/cipher/ofb/ofb.v → cipher/ofb.v b/cipher/ofb/ofb.v → cipher/ofb.v
diff --git a/curve448/nothing b/curve448/nothing
diff --git a/ed448/nothing b/ed448/nothing
diff --git a/kyber512/nothing b/kyber512/nothing
diff --git a/ripemd160/nothing b/ripemd160/nothing
diff --git a/salsa20/nothing b/salsa20/nothing
diff --git a/scrypt/nothing b/scrypt/nothing
diff --git a/twofish/nothing b/twofish/nothing
diff --git a/yescrypt/nothing b/yescrypt/nothing