Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/bstnbuck/v-crypto

Current status of V's crypto library and implementation of additional algorithms
https://github.com/bstnbuck/v-crypto
crypto ecb-mode md4 ripemd160 salsa20 tea vlang xsalsa20 xtea
Last synced: about 1 month ago
JSON representation
Current status of V's crypto library and implementation of additional algorithms
Host: GitHub
URL: https://github.com/bstnbuck/v-crypto
Owner: bstnbuck
License: mit
Created: 2022-09-30T13:26:09.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2024-04-22T10:41:09.000Z (9 months ago)
Last Synced: 2024-04-22T11:48:30.908Z (9 months ago)
Topics: crypto, ecb-mode, md4, ripemd160, salsa20, tea, vlang, xsalsa20, xtea
Language: V
Homepage:
Size: 43 KB
Stars: 3
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project

README

        # V-crypto :key:

> **Attention!**


**V-crypto** has no connection to the official V community and is not maintained by it.
 

**→ It is not recommended to use the algorithms implemented here productively until the status is *implemented*.** As a non-cryptographer, I cannot fully validate the security.

>**Contributions welcome!**

---

#### V-crypto provides...

* a detailed **overview** of important cryptographic algorithms, protocols and formats,

* 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

| 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)]|

| **bcrypt** | hash-algorithm | high | implemented :heavy_check_mark: [[Git](https://github.com/vlang/v/tree/master/vlib/crypto/bcrypt)]|

| **blake2(b,s)** | hash-algorithm | moderate | implemented :heavy_check_mark: [[Git](https://github.com/vlang/v/tree/master/vlib/crypto/blake2b)] [[Git](https://github.com/vlang/v/tree/master/vlib/crypto/blake2s)]|

| **blake3** | hash-algorithm | moderate | implemented :heavy_check_mark: [[Git](https://github.com/vlang/v/tree/master/vlib/crypto/blake3)]|

| **blowfish** | legacy symmetric block cipher | moderate | implemented :heavy_check_mark: [[Git](https://github.com/vlang/v/tree/master/vlib/crypto/blowfish)]|

| *blockcipher modes* → **CBC, CFB, CTR, OFB** | Cipher-Block-Chaining, Cipher-Feedback, Counter, Output-Feedback | high | implemented :heavy_check_mark: [[Git](https://github.com/vlang/v/tree/master/vlib/crypto/cipher)]|

| **(3)DES** | legacy symmetric block cipher | low | implemented :heavy_check_mark: [[Git](https://github.com/vlang/v/tree/master/vlib/crypto/des)]|

| **ECDSA** | signature algorithm based on elliptic curves | high, daily use | OpenSSL C Wrapper :yellow_circle: [[Git](https://github.com/vlang/v/tree/master/vlib/crypto/ecdsa)] |

| **Ed25519** | signature algorithm based on elliptic curves | high | implemented :heavy_check_mark: [[Git](https://github.com/vlang/v/tree/master/vlib/crypto/ed25519)]|

| HMAC | hash-based message authentication code | high | implemented :heavy_check_mark: [[Git](https://github.com/vlang/v/tree/master/vlib/crypto/hmac)]|

| **MD5** | legacy hash-algorithm | high | implemented :heavy_check_mark: [[Git](https://github.com/vlang/v/tree/master/vlib/crypto/md5)]|

| **PBKDF2** | key derivation function | high | implemented :heavy_check_mark: [[Git](https://github.com/vlang/v/tree/master/vlib/crypto/pbkdf2)] |

| PEM | encoding format | high | implemented :heavy_check_mark: [[Git](https://github.com/vlang/v/tree/master/vlib/crypto/pem)]|

| **RAND** | random number generator | high, daily use | implemented :heavy_check_mark: [[Git](https://github.com/vlang/v/tree/master/vlib/crypto/rand)]|

| RC4 | legacy stream cipher | low | implemented :heavy_check_mark: [[Git](https://github.com/vlang/v/tree/master/vlib/crypto/rc4)]|

| **scrypt** | hash-algorithm / key derivation function | high | implemented :heavy_check_mark: [[Git](https://github.com/vlang/v/tree/master/vlib/crypto/scrypt)]|

| **SHA1** | legacy hash-algorithm | moderate | implemented :heavy_check_mark: [[Git](https://github.com/vlang/v/tree/master/vlib/crypto/sha1)]|

| **SHA256** | hash-algorithm | high, daily use | implemented :heavy_check_mark: [[Git](https://github.com/vlang/v/tree/master/vlib/crypto/sha256)]|

| **SHA512** | hash-algorithm | high, daily use | implemented :heavy_check_mark: [[Git](https://github.com/vlang/v/tree/master/vlib/crypto/sha512)]|

| **SHA3** | hash-algorithm | moderate | implemented :heavy_check_mark: [[Git](https://github.com/vlang/v/tree/master/vlib/crypto/sha3)]|

| **ChaCha20** | symmetric stream cipher | high, daily use | experimental :yellow_circle: [[Git](https://github.com/vlang/v/tree/master/vlib/x/crypto/chacha20)]|

| **ChaCha20-Poly1305** | Authenticated encryption with associated data (AEAD) | high, daily use | experimental :yellow_circle: [[Git](https://github.com/vlang/v/tree/master/vlib/x/crypto/chacha20poly1305)]|

| Poly1305 | message authentication code | moderate | experimental :yellow_circle: [[Git](https://github.com/vlang/v/tree/master/vlib/x/crypto/poly1305)]|

| SM4 | block cipher | moderate | experimental :yellow_circle: [[Git](https://github.com/vlang/v/tree/master/vlib/x/crypto/sm4)]|

> Last Update: 28-09-2024

## 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.

| algorithm | category, info | importance | status |

| --- | --- | --- | --- |

| *blockcipher modes* → **XTS, CCM, GCM** | XEX-based tweaked-codebook mode with ciphertext stealing, Counter with CBC-MAC (AEAD), Galois/Counter (AEAD) | high | :x: |

| **Curve25519** | elliptic curve | high, daily use | thirdparty, non standard :x: [[Git](https://github.com/blackshirt/curve25519)]|

| **DSA** | legacy signature algorithm | low | (see [[1](https://github.com/vlang/v/discussions/12679)]) :x: |

| **ECDH** | asymmetric crypto based on elliptic curves | high, daily use | (see [[1](https://github.com/vlang/v/discussions/12679)], [[2](https://github.com/vlang/v/issues/8547)]), thirdparty, non standard :x: [[Git](https://github.com/blackshirt/ecdhe)] |

| HKDF | key derivation function | moderate | thirdparty :x: [[Git](https://github.com/blackshirt/hkdf)]|

| **P-224/256/384**/(521) | elliptic curves (NIST) | high, daily use | :x: |

| secp256k1 | elliptic curve | moderate | thirdparty, non standard :x: [[Git](https://github.com/ismyhc/vsecp256k1)] |

| **RSA** | asymmetric crypto | high, daily use | (see [[1](https://github.com/vlang/v/discussions/12679)]), thirdparty, non standard :x: [[Git](https://github.com/LvMalware/vrsa-package)] |

| **SSH** | network protocol | high, daily use | (see [[2](https://github.com/vlang/v/issues/8547)]) :x: |

| **TLS** | protocol for secure network communication | high, daily use | (see [[2](https://github.com/vlang/v/issues/8547)]), wrapper, thirdparty :yellow_circle: [[Git](https://github.com/vlang/v/tree/master/thirdparty/mbedtls)] [[Git](https://github.com/blackshirt/tls13)]|

| x509 | encoding format | high | wrapper, thirdparty :yellow_circle: [[Git](https://github.com/vlang/v/tree/master/thirdparty/mbedtls)] |

> Last Update: 28-09-2024

## 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.

| algorithm | category, info | importance | status | 

| --- | --- | --- | --- |

| **argon2** | hash-algorithm / key derivation function | high | :x: |

| Ascon | lightweight AEAD | moderate | :x: |

| *blockcipher modes* → ECB, EAX, IGE, OCB | Electronic-Codebook, encrypt-then-authenticate-then-translate, Infinite Garble Extension, Offset codebook mode (AEAD) | moderate | experimental (only ECB, IGE) :yellow_circle: [[Git](https://github.com/bstnbuck/V-crypto/tree/main/_cipher)] |

| **brainpoolP(256,384,521)r1** | elliptic curve | high | :x: |

| Camellia | symmetric block cipher | low | :x: |

| CAST | symmetric block cipher | moderate | :x: |

| **Curve448** | elliptic curve | high | :x: |

| **Ed448** | signature algorithm based on elliptic curves | high | :x: |

| Grain v1 | symmetric stream cipher | moderate | :x: |

| HC-(128,256) | symmetric stream cipher | moderate | :x: |

| IDEA | symmetric block cipher | low | :x: |

| Kyber(512,1024) | key encapsulation mechanism, post-quanten crypto | low | :x: |

| MD4 | legacy hash-algorithm | low | experimental :yellow_circle: [[Git](https://github.com/bstnbuck/V-crypto/tree/main/md4)] |

| RC6 | symmetric block cipher | low | :x: |

| **RIPEMD160** | legacy hash-algorithm | moderate | experimental :yellow_circle: [[Git](https://github.com/bstnbuck/V-crypto/tree/main/ripemd160)] |

| **(X)Salsa20** | symmetric stream cipher | high | experimental :yellow_circle: [[Git](https://github.com/bstnbuck/V-crypto/tree/main/salsa20)] |

| **Serpent** | symmetric block cipher | moderate | :x: |

| TEA, XTEA | legacy block cipher | low | experimental :yellow_circle: [[Git](https://github.com/bstnbuck/V-crypto/tree/main/tea)] [[Git](https://github.com/bstnbuck/V-crypto/tree/main/xtea)]|

| **Twofisch** | symmetric block cipher | moderate | experimental :yellow_circle: [[Git](https://github.com/bstnbuck/V-crypto/tree/main/twofish)] |

| **yescrypt** | hash-algorithm / key derivation function | high | :x: |

> Last Update: 01-07-2024

---

## v_crypto

### Installation

```bash

v install https://github.com/bstnbuck/V-crypto

```

### Usage

In general, the functionality is easy to understand based on the tests of the respective algorithm. For larger algorithms, a README file with the most important functions follows.

```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())

}

```

> Please report security related issues to: bstnbuck (at) proton (dot) me