v/vlib/crypto
2024-09-17 09:47:38 +03:00
..
aes fmt: remove the prefixed module name of const names, that are in the same module (related #22183) (#22185) 2024-09-10 11:25:56 +03:00
bcrypt crypto.bcrypt: reduce runtime cost for running bcrypt_test.v, by reducing the iteration count 2024-09-13 09:45:21 +03:00
blake2b fmt: remove the prefixed module name of const names, that are in the same module (related #22183) (#22185) 2024-09-10 11:25:56 +03:00
blake2s fmt: remove the prefixed module name of const names, that are in the same module (related #22183) (#22185) 2024-09-10 11:25:56 +03:00
blake3 fmt: fix formating a file in an oscillating manner (fix #22223, fix #22026) (#22232) 2024-09-17 09:47:38 +03:00
blowfish fmt: fix alignment of struct init fields (#22025) 2024-08-11 09:11:24 +03:00
cipher fmt: fix alignment of struct init fields (#22025) 2024-08-11 09:11:24 +03:00
des fmt: remove the prefixed module name of const names, that are in the same module (related #22183) (#22185) 2024-09-10 11:25:56 +03:00
ed25519 checker: add missing check for ref passing to non-ref (#22194) 2024-09-14 23:13:25 +03:00
hmac fmt: remove the prefixed module name of const names, that are in the same module (related #22183) (#22185) 2024-09-10 11:25:56 +03:00
internal/subtle all: change single blank comment to blank line (#22016) 2024-08-09 14:55:58 +03:00
md5 fmt: remove the prefixed module name of const names, that are in the same module (related #22183) (#22185) 2024-09-10 11:25:56 +03:00
pbkdf2 crypto.pbkdf2: move extensive test cases to https://github.com/vlang/slower_tests, but keep test case 7, where the key_size is > block_size for sha224 and sha256 2024-09-13 10:50:55 +03:00
pem fmt: remove the prefixed module name of const names, that are in the same module (related #22183) (#22185) 2024-09-10 11:25:56 +03:00
rand crypto.rand: fix compilation on macos with -cc tcc -no-retry-compilation -gc none 2024-09-15 14:53:52 +03:00
rc4 crypto.cipher: make Stream.xor_key_stream implementers require a mutable receiver (#21974) 2024-08-01 16:04:09 +03:00
scrypt crypto.scrypt: add missing comment of source for test vector (#22222) 2024-09-15 15:20:30 +03:00
sha1 crypto, x.crypto: trim long inputs, move more extensive cases to https://github.com/vlang/slower_tests 2024-09-13 10:28:11 +03:00
sha3 fmt: fix formating a file in an oscillating manner (fix #22223, fix #22026) (#22232) 2024-09-17 09:47:38 +03:00
sha256 crypto, x.crypto: trim long inputs, move more extensive cases to https://github.com/vlang/slower_tests 2024-09-13 10:28:11 +03:00
sha512 crypto.sha512: move sha512 long message tests to separate repo (#22208) 2024-09-13 07:19:55 +03:00
crypto.v tools: make v test-cleancode test everything by default (#10050) 2021-05-08 13:32:29 +03:00
README.md doc: update trim_doc_node_description, make module readmes more uniform (#20792) 2024-02-12 12:38:47 +02:00

Description

crypto is a module that exposes cryptographic algorithms to V programs.

Each submodule implements things differently, so be sure to consider the documentation of the specific algorithm you need, but in general, the method is to create a cipher struct using one of the module functions, and then to call the encrypt or decrypt method on that struct to actually encrypt or decrypt your data.

This module is a work-in-progress. For example, the AES implementation currently requires you to create a destination buffer of the correct size to receive the decrypted data, and the AesCipher encrypt and decrypt functions only operate on the first block of the src.

The implementations here are loosely based on Go's crypto package.

Examples

AES

import crypto.aes
import crypto.rand

fn main() {
	// remember to save this key somewhere if you ever want to decrypt your data
	key := rand.bytes(32)!
	println('KEY: ${key}')

	// this data is one block (16 bytes) big
	mut data := 'THIS IS THE DATA'.bytes()

	println('generating cipher')
	cipher := aes.new_cipher(key)

	println('performing encryption')
	mut encrypted := []u8{len: aes.block_size}
	cipher.encrypt(mut encrypted, data)
	println(encrypted)

	println('performing decryption')
	mut decrypted := []u8{len: aes.block_size}
	cipher.decrypt(mut decrypted, encrypted)
	println(decrypted)

	assert decrypted == data
}

JWT

import crypto.hmac
import crypto.sha256
import encoding.base64
import json
import time

struct JwtHeader {
	alg string
	typ string
}

struct JwtPayload {
	sub  string
	name string
	iat  int
}

fn main() {
	sw := time.new_stopwatch()
	secret := 'your-256-bit-secret'
	token := make_token(secret)
	ok := auth_verify(secret, token)
	dt := sw.elapsed().microseconds()
	println('token: ${token}')
	println('auth_verify(secret, token): ${ok}')
	println('Elapsed time: ${dt} uS')
}

fn make_token(secret string) string {
	header := base64.url_encode(json.encode(JwtHeader{'HS256', 'JWT'}).bytes())
	payload := base64.url_encode(json.encode(JwtPayload{'1234567890', 'John Doe', 1516239022}).bytes())
	signature := base64.url_encode(hmac.new(secret.bytes(), '${header}.${payload}'.bytes(),
		sha256.sum, sha256.block_size))
	jwt := '${header}.${payload}.${signature}'
	return jwt
}

fn auth_verify(secret string, token string) bool {
	token_split := token.split('.')
	signature_mirror := hmac.new(secret.bytes(), '${token_split[0]}.${token_split[1]}'.bytes(),
		sha256.sum, sha256.block_size)
	signature_from_token := base64.url_decode(token_split[2])
	return hmac.equal(signature_from_token, signature_mirror)
}