v/vlib/crypto
stackotter 563469ed9f
vfmt: fix array_init line wrapping (#14154)
2022-04-25 08:11:44 +03:00
..
aes all: replace []byte with []u8 2022-04-15 15:35:35 +03:00
bcrypt all: replace []byte with []u8 2022-04-15 15:35:35 +03:00
blowfish all: replace []byte with []u8 2022-04-15 15:35:35 +03:00
cipher all: replace []byte with []u8 2022-04-15 15:35:35 +03:00
des ci: fix `./v -progress test-cleancode` 2022-04-15 21:04:10 +03:00
ed25519 ci: fix `./v -progress test-cleancode` 2022-04-15 21:04:10 +03:00
hmac vfmt: fix array_init line wrapping (#14154) 2022-04-25 08:11:44 +03:00
internal/subtle all: replace []byte with []u8 2022-04-15 15:35:35 +03:00
md5 all: handle fixed []u8 2022-04-15 18:35:56 +03:00
rand all: replace []byte with []u8 2022-04-15 15:35:35 +03:00
rc4 ci: fix failing tests for mysql, crypto.rc4, strings 2022-04-15 20:51:04 +03:00
sha1 all: replace []byte with []u8 2022-04-15 15:35:35 +03:00
sha256 all: replace []byte with []u8 2022-04-15 15:35:35 +03:00
sha512 all: replace []byte with []u8 2022-04-15 15:35:35 +03:00
README.md ci: fix `./v check-md -hide-warnings .` 2022-04-15 21:08:09 +03:00
crypto.v tools: make `v test-cleancode` test everything by default (#10050) 2021-05-08 13:32:29 +03:00

README.md

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:

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
}