hare

[hare] The Hare programming language
git clone https://git.torresjrjr.com/hare.git
Log | Files | Refs | README | LICENSE

commit bd1c1c4aa0dbcb7a01e9689b52c1761d80dcf60f
parent 1db5f9b50db3f74d677224592d9718c1cc6e119b
Author: Armin Preiml <apreiml@strohwolke.at>
Date:   Thu,  7 Jul 2022 15:17:40 +0200

add crypto::hkdf

Signed-off-by: Armin Preiml <apreiml@strohwolke.at>

Diffstat:
Acrypto/hkdf/+test.ha | 218+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Acrypto/hkdf/README | 1+
Acrypto/hkdf/hkdf.ha | 85+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Mscripts/gen-stdlib | 13+++++++++++++
Mstdlib.mk | 33+++++++++++++++++++++++++++++++++
5 files changed, 350 insertions(+), 0 deletions(-)

diff --git a/crypto/hkdf/+test.ha b/crypto/hkdf/+test.ha @@ -0,0 +1,218 @@ +// License: MPL-2.0 +// (c) 2022 Armin Preiml <apreiml@strohwolke.at> +use bytes; +use crypto::sha1; +use crypto::sha256; + +// test taken from RFC 5869 +@test fn rfc1() void = { + let h = sha256::sha256(); + let dest: [42]u8 = [0...]; + + const key: [22]u8 = [0x0b...]; + const salt: [13]u8 = [ + 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, + 0x0a, 0x0b, 0x0c, + ]; + const info: [10]u8 = [ + 0xf0, 0xf1, 0xf2, 0xf3, 0xf4, 0xf5, 0xf6, 0xf7, 0xf8, 0xf9, + ]; + + const expected: [42]u8 = [ + 0x3c, 0xb2, 0x5f, 0x25, 0xfa, 0xac, 0xd5, 0x7a, 0x90, 0x43, + 0x4f, 0x64, 0xd0, 0x36, 0x2f, 0x2a, 0x2d, 0x2d, 0x0a, 0x90, + 0xcf, 0x1a, 0x5a, 0x4c, 0x5d, 0xb0, 0x2d, 0x56, 0xec, 0xc4, + 0xc5, 0xbf, 0x34, 0x00, 0x72, 0x08, 0xd5, 0xb8, 0x87, 0x18, + 0x58, 0x65, + ]; + + let buf: [sha256::SIZE + sha256::BLOCKSIZE]u8 = [0...]; + + hkdf(&h, dest[..], key, info, salt, buf); + + assert(bytes::equal(expected, dest)); +}; + +// test taken from RFC 5869 +@test fn rfc2() void = { + let h = sha256::sha256(); + let dest: [82]u8 = [0...]; + + const key: [80]u8 = [ + 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, + 0x0a, 0x0b, 0x0c, 0x0d, 0x0e, 0x0f, 0x10, 0x11, 0x12, 0x13, + 0x14, 0x15, 0x16, 0x17, 0x18, 0x19, 0x1a, 0x1b, 0x1c, 0x1d, + 0x1e, 0x1f, 0x20, 0x21, 0x22, 0x23, 0x24, 0x25, 0x26, 0x27, + 0x28, 0x29, 0x2a, 0x2b, 0x2c, 0x2d, 0x2e, 0x2f, 0x30, 0x31, + 0x32, 0x33, 0x34, 0x35, 0x36, 0x37, 0x38, 0x39, 0x3a, 0x3b, + 0x3c, 0x3d, 0x3e, 0x3f, 0x40, 0x41, 0x42, 0x43, 0x44, 0x45, + 0x46, 0x47, 0x48, 0x49, 0x4a, 0x4b, 0x4c, 0x4d, 0x4e, 0x4f, + ]; + const salt: [80]u8 = [ + 0x60, 0x61, 0x62, 0x63, 0x64, 0x65, 0x66, 0x67, 0x68, 0x69, + 0x6a, 0x6b, 0x6c, 0x6d, 0x6e, 0x6f, 0x70, 0x71, 0x72, 0x73, + 0x74, 0x75, 0x76, 0x77, 0x78, 0x79, 0x7a, 0x7b, 0x7c, 0x7d, + 0x7e, 0x7f, 0x80, 0x81, 0x82, 0x83, 0x84, 0x85, 0x86, 0x87, + 0x88, 0x89, 0x8a, 0x8b, 0x8c, 0x8d, 0x8e, 0x8f, 0x90, 0x91, + 0x92, 0x93, 0x94, 0x95, 0x96, 0x97, 0x98, 0x99, 0x9a, 0x9b, + 0x9c, 0x9d, 0x9e, 0x9f, 0xa0, 0xa1, 0xa2, 0xa3, 0xa4, 0xa5, + 0xa6, 0xa7, 0xa8, 0xa9, 0xaa, 0xab, 0xac, 0xad, 0xae, 0xaf, + ]; + const info: [80]u8 = [ + 0xb0, 0xb1, 0xb2, 0xb3, 0xb4, 0xb5, 0xb6, 0xb7, 0xb8, 0xb9, + 0xba, 0xbb, 0xbc, 0xbd, 0xbe, 0xbf, 0xc0, 0xc1, 0xc2, 0xc3, + 0xc4, 0xc5, 0xc6, 0xc7, 0xc8, 0xc9, 0xca, 0xcb, 0xcc, 0xcd, + 0xce, 0xcf, 0xd0, 0xd1, 0xd2, 0xd3, 0xd4, 0xd5, 0xd6, 0xd7, + 0xd8, 0xd9, 0xda, 0xdb, 0xdc, 0xdd, 0xde, 0xdf, 0xe0, 0xe1, + 0xe2, 0xe3, 0xe4, 0xe5, 0xe6, 0xe7, 0xe8, 0xe9, 0xea, 0xeb, + 0xec, 0xed, 0xee, 0xef, 0xf0, 0xf1, 0xf2, 0xf3, 0xf4, 0xf5, + 0xf6, 0xf7, 0xf8, 0xf9, 0xfa, 0xfb, 0xfc, 0xfd, 0xfe, 0xff, + ]; + + const expected: [82]u8 = [ + 0xb1, 0x1e, 0x39, 0x8d, 0xc8, 0x03, 0x27, 0xa1, 0xc8, 0xe7, + 0xf7, 0x8c, 0x59, 0x6a, 0x49, 0x34, 0x4f, 0x01, 0x2e, 0xda, + 0x2d, 0x4e, 0xfa, 0xd8, 0xa0, 0x50, 0xcc, 0x4c, 0x19, 0xaf, + 0xa9, 0x7c, 0x59, 0x04, 0x5a, 0x99, 0xca, 0xc7, 0x82, 0x72, + 0x71, 0xcb, 0x41, 0xc6, 0x5e, 0x59, 0x0e, 0x09, 0xda, 0x32, + 0x75, 0x60, 0x0c, 0x2f, 0x09, 0xb8, 0x36, 0x77, 0x93, 0xa9, + 0xac, 0xa3, 0xdb, 0x71, 0xcc, 0x30, 0xc5, 0x81, 0x79, 0xec, + 0x3e, 0x87, 0xc1, 0x4c, 0x01, 0xd5, 0xc1, 0xf3, 0x43, 0x4f, + 0x1d, 0x87, + ]; + + let buf: [sha256::SIZE + sha256::BLOCKSIZE]u8 = [0...]; + + hkdf(&h, dest[..], key, info, salt, buf); + + assert(bytes::equal(expected, dest)); +}; + +// test taken from RFC 5869 +@test fn rfc3() void = { + let h = sha256::sha256(); + let dest: [42]u8 = [0...]; + + const key: [22]u8 = [0x0b...]; + + const expected: [42]u8 = [ + 0x8d, 0xa4, 0xe7, 0x75, 0xa5, 0x63, 0xc1, 0x8f, 0x71, 0x5f, + 0x80, 0x2a, 0x06, 0x3c, 0x5a, 0x31, 0xb8, 0xa1, 0x1f, 0x5c, + 0x5e, 0xe1, 0x87, 0x9e, 0xc3, 0x45, 0x4e, 0x5f, 0x3c, 0x73, + 0x8d, 0x2d, 0x9d, 0x20, 0x13, 0x95, 0xfa, 0xa4, 0xb6, 0x1a, + 0x96, 0xc8, + ]; + + let buf: [sha256::SIZE + sha256::BLOCKSIZE]u8 = [0...]; + + hkdf(&h, dest[..], key, [], [], buf); + + assert(bytes::equal(expected, dest)); +}; + + +// test taken from RFC 5869 +@test fn rfc4() void = { + let h = sha1::sha1(); + let dest: [42]u8 = [0...]; + + const key: [11]u8 = [0x0b...]; + const salt: [13]u8 = [ + 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, + 0x0a, 0x0b, 0x0c, + ]; + const info: [10]u8 = [ + 0xf0, 0xf1, 0xf2, 0xf3, 0xf4, 0xf5, 0xf6, 0xf7, 0xf8, 0xf9, + ]; + + const expected: [42]u8 = [ + 0x08, 0x5a, 0x01, 0xea, 0x1b, 0x10, 0xf3, 0x69, 0x33, 0x06, + 0x8b, 0x56, 0xef, 0xa5, 0xad, 0x81, 0xa4, 0xf1, 0x4b, 0x82, + 0x2f, 0x5b, 0x09, 0x15, 0x68, 0xa9, 0xcd, 0xd4, 0xf1, 0x55, + 0xfd, 0xa2, 0xc2, 0x2e, 0x42, 0x24, 0x78, 0xd3, 0x05, 0xf3, + 0xf8, 0x96, + ]; + + let buf: [sha1::SIZE + sha1::BLOCKSIZE]u8 = [0...]; + + hkdf(&h, dest[..], key, info, salt, buf); + + assert(bytes::equal(expected, dest)); +}; + +// test taken from RFC 5869 +@test fn rfc5() void = { + let h = sha1::sha1(); + let dest: [82]u8 = [0...]; + + const key: [80]u8 = [ + 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, + 0x0a, 0x0b, 0x0c, 0x0d, 0x0e, 0x0f, 0x10, 0x11, 0x12, 0x13, + 0x14, 0x15, 0x16, 0x17, 0x18, 0x19, 0x1a, 0x1b, 0x1c, 0x1d, + 0x1e, 0x1f, 0x20, 0x21, 0x22, 0x23, 0x24, 0x25, 0x26, 0x27, + 0x28, 0x29, 0x2a, 0x2b, 0x2c, 0x2d, 0x2e, 0x2f, 0x30, 0x31, + 0x32, 0x33, 0x34, 0x35, 0x36, 0x37, 0x38, 0x39, 0x3a, 0x3b, + 0x3c, 0x3d, 0x3e, 0x3f, 0x40, 0x41, 0x42, 0x43, 0x44, 0x45, + 0x46, 0x47, 0x48, 0x49, 0x4a, 0x4b, 0x4c, 0x4d, 0x4e, 0x4f, + ]; + const salt: [80]u8 = [ + 0x60, 0x61, 0x62, 0x63, 0x64, 0x65, 0x66, 0x67, 0x68, 0x69, + 0x6a, 0x6b, 0x6c, 0x6d, 0x6e, 0x6f, 0x70, 0x71, 0x72, 0x73, + 0x74, 0x75, 0x76, 0x77, 0x78, 0x79, 0x7a, 0x7b, 0x7c, 0x7d, + 0x7e, 0x7f, 0x80, 0x81, 0x82, 0x83, 0x84, 0x85, 0x86, 0x87, + 0x88, 0x89, 0x8a, 0x8b, 0x8c, 0x8d, 0x8e, 0x8f, 0x90, 0x91, + 0x92, 0x93, 0x94, 0x95, 0x96, 0x97, 0x98, 0x99, 0x9a, 0x9b, + 0x9c, 0x9d, 0x9e, 0x9f, 0xa0, 0xa1, 0xa2, 0xa3, 0xa4, 0xa5, + 0xa6, 0xa7, 0xa8, 0xa9, 0xaa, 0xab, 0xac, 0xad, 0xae, 0xaf, + ]; + const info: [80]u8 = [ + 0xb0, 0xb1, 0xb2, 0xb3, 0xb4, 0xb5, 0xb6, 0xb7, 0xb8, 0xb9, + 0xba, 0xbb, 0xbc, 0xbd, 0xbe, 0xbf, 0xc0, 0xc1, 0xc2, 0xc3, + 0xc4, 0xc5, 0xc6, 0xc7, 0xc8, 0xc9, 0xca, 0xcb, 0xcc, 0xcd, + 0xce, 0xcf, 0xd0, 0xd1, 0xd2, 0xd3, 0xd4, 0xd5, 0xd6, 0xd7, + 0xd8, 0xd9, 0xda, 0xdb, 0xdc, 0xdd, 0xde, 0xdf, 0xe0, 0xe1, + 0xe2, 0xe3, 0xe4, 0xe5, 0xe6, 0xe7, 0xe8, 0xe9, 0xea, 0xeb, + 0xec, 0xed, 0xee, 0xef, 0xf0, 0xf1, 0xf2, 0xf3, 0xf4, 0xf5, + 0xf6, 0xf7, 0xf8, 0xf9, 0xfa, 0xfb, 0xfc, 0xfd, 0xfe, 0xff, + ]; + + const expected: [82]u8 = [ + 0x0b, 0xd7, 0x70, 0xa7, 0x4d, 0x11, 0x60, 0xf7, 0xc9, 0xf1, + 0x2c, 0xd5, 0x91, 0x2a, 0x06, 0xeb, 0xff, 0x6a, 0xdc, 0xae, + 0x89, 0x9d, 0x92, 0x19, 0x1f, 0xe4, 0x30, 0x56, 0x73, 0xba, + 0x2f, 0xfe, 0x8f, 0xa3, 0xf1, 0xa4, 0xe5, 0xad, 0x79, 0xf3, + 0xf3, 0x34, 0xb3, 0xb2, 0x02, 0xb2, 0x17, 0x3c, 0x48, 0x6e, + 0xa3, 0x7c, 0xe3, 0xd3, 0x97, 0xed, 0x03, 0x4c, 0x7f, 0x9d, + 0xfe, 0xb1, 0x5c, 0x5e, 0x92, 0x73, 0x36, 0xd0, 0x44, 0x1f, + 0x4c, 0x43, 0x00, 0xe2, 0xcf, 0xf0, 0xd0, 0x90, 0x0b, 0x52, + 0xd3, 0xb4, + ]; + + let buf: [sha1::SIZE + sha1::BLOCKSIZE]u8 = [0...]; + + hkdf(&h, dest[..], key, info, salt, buf); + + assert(bytes::equal(expected, dest)); +}; + +// test taken from RFC 5869 +@test fn rfc6() void = { + let h = sha1::sha1(); + let dest: [42]u8 = [0...]; + + const key: [22]u8 = [0x0c...]; + + const expected: [42]u8 = [ + 0x2c, 0x91, 0x11, 0x72, 0x04, 0xd7, 0x45, 0xf3, 0x50, 0x0d, + 0x63, 0x6a, 0x62, 0xf6, 0x4f, 0x0a, 0xb3, 0xba, 0xe5, 0x48, + 0xaa, 0x53, 0xd4, 0x23, 0xb0, 0xd1, 0xf2, 0x7e, 0xbb, 0xa6, + 0xf5, 0xe5, 0x67, 0x3a, 0x08, 0x1d, 0x70, 0xcc, 0xe7, 0xac, + 0xfc, 0x48, + ]; + + let buf: [sha1::SIZE + sha1::BLOCKSIZE]u8 = [0...]; + + hkdf(&h, dest[..], key, [], void, buf); + + assert(bytes::equal(expected, dest)); +}; diff --git a/crypto/hkdf/README b/crypto/hkdf/README @@ -0,0 +1 @@ +This module provides a HKDF implementation according to RFC 5869. diff --git a/crypto/hkdf/hkdf.ha b/crypto/hkdf/hkdf.ha @@ -0,0 +1,85 @@ +// License: MPL-2.0 +// (c) 2022 Armin Preiml <apreiml@strohwolke.at> +use bytes; +use crypto::hmac; +use crypto::mac; +use hash; + +// Derives a new key from specified 'key' material using HMAC with 'h' as +// underlying hash function and writes it to 'dest'. The resulting key size is +// of the size of 'dest'. +// +// 'info' binds the resulting key to the context in where it is being used and +// therefore prevents the derivation of the same key for different contexts. It +// should be independent of the input key. 'salt' does not need to be secret and +// it's recommended to use a random or pseudo random value, ideally of the hash +// size of the given hash function. The 'salt' must be a fixed value or void +// between many different contexts. +// +// 'buf' must be of the size [[hash::bsz]] + [[hash::sz]] of given hash 'h'. +// +// See the RFC 5869 for detailed usage guidance. +export fn hkdf( + h: *hash::hash, + dest: []u8, + key: []u8, + info: []u8, + salt: ([]u8 | void), + buf: []u8, +) void = { + const hashsz = hash::sz(h); + assert(len(buf) >= (hash::sz(h) + hash::bsz(h)), + "len(buf) must be at least `hash::sz(h) + hash::bsz(h)`"); + + let prk = buf[..hashsz]; + let buf = buf[hashsz..]; + + let prkkey = match(salt) { + case let s: []u8 => + yield s; + case void => + // use prk for an hashsz full of zeros + bytes::zero(prk); + yield prk; + }; + + let hm = hmac::hmac(h, prkkey, buf); + + mac::write(&hm, key); + mac::sum(&hm, prk); + mac::finish(&hm); + + let ctr: [1]u8 = [0]; + let preblock: []u8 = []; + + for (let i = 0u8; len(dest) > 0; i += 1) { + hash::reset(h); + hm = hmac::hmac(h, prk, buf); + defer mac::finish(&hm); + + if (i > 0) { + mac::write(&hm, preblock); + }; + mac::write(&hm, info); + + ctr[0] = i + 1; + mac::write(&hm, ctr); + + const n = if (len(dest) >= hashsz) { + mac::sum(&hm, dest[..hashsz]); + preblock = dest[..hashsz]; + yield hashsz; + } else { + // use the prk as buffer for the last block as it's + // not needed anymore afterwards. + mac::sum(&hm, prk); + dest[..] = prk[..len(dest)]; + yield len(dest); + }; + + dest = dest[n..]; + }; + + bytes::zero(prk); + bytes::zero(buf); +}; diff --git a/scripts/gen-stdlib b/scripts/gen-stdlib @@ -344,6 +344,18 @@ crypto_cipher() { gen_ssa crypto::cipher crypto::math bytes endian errors io types } +crypto_hkdf() { + if [ $testing -eq 0 ] + then + gen_srcs crypto::hkdf hkdf.ha + gen_ssa crypto::hkdf bytes crypto::hmac crypto::mac hash + else + gen_srcs crypto::hkdf hkdf.ha +test.ha + gen_ssa crypto::hkdf bytes crypto::hmac crypto::mac hash \ + crypto::sha1 crypto::sha256 + fi +} + crypto_hmac() { if [ $testing -eq 0 ] then @@ -1415,6 +1427,7 @@ crypto::blake2b crypto::blowfish crypto::chacha crypto::cipher +crypto::hkdf crypto::hmac crypto::mac crypto::math diff --git a/stdlib.mk b/stdlib.mk @@ -202,6 +202,12 @@ stdlib_deps_any += $(stdlib_crypto_cipher_any) stdlib_crypto_cipher_linux = $(stdlib_crypto_cipher_any) stdlib_crypto_cipher_freebsd = $(stdlib_crypto_cipher_any) +# gen_lib crypto::hkdf (any) +stdlib_crypto_hkdf_any = $(HARECACHE)/crypto/hkdf/crypto_hkdf-any.o +stdlib_deps_any += $(stdlib_crypto_hkdf_any) +stdlib_crypto_hkdf_linux = $(stdlib_crypto_hkdf_any) +stdlib_crypto_hkdf_freebsd = $(stdlib_crypto_hkdf_any) + # gen_lib crypto::hmac (any) stdlib_crypto_hmac_any = $(HARECACHE)/crypto/hmac/crypto_hmac-any.o stdlib_deps_any += $(stdlib_crypto_hmac_any) @@ -868,6 +874,16 @@ $(HARECACHE)/crypto/cipher/crypto_cipher-any.ssa: $(stdlib_crypto_cipher_any_src @HARECACHE=$(HARECACHE) $(HAREC) $(HAREFLAGS) -o $@ -Ncrypto::cipher \ -t$(HARECACHE)/crypto/cipher/crypto_cipher.td $(stdlib_crypto_cipher_any_srcs) +# crypto::hkdf (+any) +stdlib_crypto_hkdf_any_srcs = \ + $(STDLIB)/crypto/hkdf/hkdf.ha + +$(HARECACHE)/crypto/hkdf/crypto_hkdf-any.ssa: $(stdlib_crypto_hkdf_any_srcs) $(stdlib_rt) $(stdlib_bytes_$(PLATFORM)) $(stdlib_crypto_hmac_$(PLATFORM)) $(stdlib_crypto_mac_$(PLATFORM)) $(stdlib_hash_$(PLATFORM)) + @printf 'HAREC \t$@\n' + @mkdir -p $(HARECACHE)/crypto/hkdf + @HARECACHE=$(HARECACHE) $(HAREC) $(HAREFLAGS) -o $@ -Ncrypto::hkdf \ + -t$(HARECACHE)/crypto/hkdf/crypto_hkdf.td $(stdlib_crypto_hkdf_any_srcs) + # crypto::hmac (+any) stdlib_crypto_hmac_any_srcs = \ $(STDLIB)/crypto/hmac/hmac.ha \ @@ -2338,6 +2354,12 @@ testlib_deps_any += $(testlib_crypto_cipher_any) testlib_crypto_cipher_linux = $(testlib_crypto_cipher_any) testlib_crypto_cipher_freebsd = $(testlib_crypto_cipher_any) +# gen_lib crypto::hkdf (any) +testlib_crypto_hkdf_any = $(TESTCACHE)/crypto/hkdf/crypto_hkdf-any.o +testlib_deps_any += $(testlib_crypto_hkdf_any) +testlib_crypto_hkdf_linux = $(testlib_crypto_hkdf_any) +testlib_crypto_hkdf_freebsd = $(testlib_crypto_hkdf_any) + # gen_lib crypto::hmac (any) testlib_crypto_hmac_any = $(TESTCACHE)/crypto/hmac/crypto_hmac-any.o testlib_deps_any += $(testlib_crypto_hmac_any) @@ -3016,6 +3038,17 @@ $(TESTCACHE)/crypto/cipher/crypto_cipher-any.ssa: $(testlib_crypto_cipher_any_sr @HARECACHE=$(TESTCACHE) $(HAREC) $(TESTHAREFLAGS) -o $@ -Ncrypto::cipher \ -t$(TESTCACHE)/crypto/cipher/crypto_cipher.td $(testlib_crypto_cipher_any_srcs) +# crypto::hkdf (+any) +testlib_crypto_hkdf_any_srcs = \ + $(STDLIB)/crypto/hkdf/hkdf.ha \ + $(STDLIB)/crypto/hkdf/+test.ha + +$(TESTCACHE)/crypto/hkdf/crypto_hkdf-any.ssa: $(testlib_crypto_hkdf_any_srcs) $(testlib_rt) $(testlib_bytes_$(PLATFORM)) $(testlib_crypto_hmac_$(PLATFORM)) $(testlib_crypto_mac_$(PLATFORM)) $(testlib_hash_$(PLATFORM)) $(testlib_crypto_sha1_$(PLATFORM)) $(testlib_crypto_sha256_$(PLATFORM)) + @printf 'HAREC \t$@\n' + @mkdir -p $(TESTCACHE)/crypto/hkdf + @HARECACHE=$(TESTCACHE) $(HAREC) $(TESTHAREFLAGS) -o $@ -Ncrypto::hkdf \ + -t$(TESTCACHE)/crypto/hkdf/crypto_hkdf.td $(testlib_crypto_hkdf_any_srcs) + # crypto::hmac (+any) testlib_crypto_hmac_any_srcs = \ $(STDLIB)/crypto/hmac/hmac.ha \