]> Cypherpunks repositories - gostls13.git/commitdiff
crypto/internal/fips/aes/gcm: add CounterKDF
authorFilippo Valsorda <filippo@golang.org>
Thu, 7 Nov 2024 12:32:13 +0000 (13:32 +0100)
committerGopher Robot <gobot@golang.org>
Tue, 19 Nov 2024 00:31:19 +0000 (00:31 +0000)
Change-Id: I236f9d8c4637793c1bda39f69573481356f8e362
Reviewed-on: https://go-review.googlesource.com/c/go/+/626436
Reviewed-by: Roland Shoemaker <roland@golang.org>
Auto-Submit: Filippo Valsorda <filippo@golang.org>
LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
Reviewed-by: Daniel McCarney <daniel@binaryparadox.net>
Reviewed-by: Dmitri Shuralyov <dmitshur@google.com>
src/crypto/internal/fips/aes/gcm/cmac_test.go
src/crypto/internal/fips/aes/gcm/ctrkdf.go [new file with mode: 0644]
src/crypto/internal/fips/aes/gcm/ctrkdf_test.go [new file with mode: 0644]

index 52b7a42c763f0948fb5a1690f4a7c3560c1f8cd4..d2418fd8d37736f372e061979178beca7cf34d62 100644 (file)
@@ -6,7 +6,6 @@ package gcm_test
 
 import (
        "bytes"
-       "crypto/internal/cryptotest"
        "crypto/internal/fips/aes"
        "crypto/internal/fips/aes/gcm"
        "encoding/hex"
@@ -14,22 +13,6 @@ import (
        "testing"
 )
 
-var sink byte
-
-func TestAllocations(t *testing.T) {
-       cryptotest.SkipTestAllocations(t)
-       if allocs := testing.AllocsPerRun(10, func() {
-               b, err := aes.New(make([]byte, 16))
-               if err != nil {
-                       t.Fatal(err)
-               }
-               c := gcm.NewCMAC(b)
-               sink ^= c.MAC(make([]byte, 16))[0]
-       }); allocs > 0 {
-               t.Errorf("expected zero allocations, got %0.1f", allocs)
-       }
-}
-
 func TestCMAC(t *testing.T) {
        // https://csrc.nist.gov/CSRC/media/Projects/Cryptographic-Standards-and-Guidelines/documents/examples/AES_CMAC.pdf
        key := "2B7E1516 28AED2A6 ABF71588 09CF4F3C"
diff --git a/src/crypto/internal/fips/aes/gcm/ctrkdf.go b/src/crypto/internal/fips/aes/gcm/ctrkdf.go
new file mode 100644 (file)
index 0000000..9285633
--- /dev/null
@@ -0,0 +1,49 @@
+// Copyright 2024 The Go Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+package gcm
+
+import (
+       "crypto/internal/fips"
+       "crypto/internal/fips/aes"
+)
+
+// CounterKDF implements a KDF in Counter Mode instantiated with CMAC-AES,
+// according to NIST SP 800-108 Revision 1 Update 1, Section 4.1.
+//
+// It produces a 256-bit output, and accepts a 8-bit Label and a 96-bit Context.
+// It uses a counter of 16 bits placed before the fixed data. The fixed data is
+// the sequence Label || 0x00 || Context. The L field is omitted, since the
+// output key length is fixed.
+//
+// It's optimized for use in XAES-256-GCM (https://c2sp.org/XAES-256-GCM),
+// rather than for exposing it to applications as a stand-alone KDF.
+type CounterKDF struct {
+       mac CMAC
+}
+
+// NewCounterKDF creates a new CounterKDF with the given key.
+func NewCounterKDF(b *aes.Block) *CounterKDF {
+       return &CounterKDF{mac: *NewCMAC(b)}
+}
+
+// DeriveKey derives a key from the given label and context.
+func (kdf *CounterKDF) DeriveKey(label byte, context [12]byte) [32]byte {
+       fips.RecordApproved()
+       var output [32]byte
+
+       var input [aes.BlockSize]byte
+       input[2] = label
+       copy(input[4:], context[:])
+
+       input[1] = 0x01 // i = 1
+       K1 := kdf.mac.MAC(input[:])
+
+       input[1] = 0x02 // i = 2
+       K2 := kdf.mac.MAC(input[:])
+
+       copy(output[:], K1[:])
+       copy(output[aes.BlockSize:], K2[:])
+       return output
+}
diff --git a/src/crypto/internal/fips/aes/gcm/ctrkdf_test.go b/src/crypto/internal/fips/aes/gcm/ctrkdf_test.go
new file mode 100644 (file)
index 0000000..2dcd9c7
--- /dev/null
@@ -0,0 +1,120 @@
+// Copyright 2024 The Go Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+package gcm_test
+
+import (
+       "bytes"
+       "crypto/internal/cryptotest"
+       "crypto/internal/fips/aes"
+       "crypto/internal/fips/aes/gcm"
+       "crypto/internal/fips/sha3"
+       "encoding/hex"
+       "testing"
+)
+
+func TestAllocations(t *testing.T) {
+       cryptotest.SkipTestAllocations(t)
+       if allocs := testing.AllocsPerRun(10, func() {
+               key := make([]byte, 32)
+               nonce := make([]byte, 24)
+               plaintext := make([]byte, 16)
+               aad := make([]byte, 16)
+               ciphertext := make([]byte, 0, 16+16)
+               ciphertext = xaesSeal(ciphertext, key, nonce, plaintext, aad)
+               if _, err := xaesOpen(plaintext[:0], key, nonce, ciphertext, aad); err != nil {
+                       t.Fatal(err)
+               }
+       }); allocs > 0 {
+               t.Errorf("expected zero allocations, got %0.1f", allocs)
+       }
+}
+
+// ACVP tests consider fixed data part of the output, not part of the input, and
+// all the pre-generated vectors at
+// https://github.com/usnistgov/ACVP-Server/blob/3a7333f6/gen-val/json-files/KDF-1.0/expectedResults.json
+// have a 32-byte fixed data, while ours is always 14 bytes. Instead, test
+// against the XAES-256-GCM vectors, which were tested against OpenSSL's Counter
+// KDF. This also ensures the KDF will work for XAES-256-GCM.
+
+func xaesSeal(dst, key, nonce, plaintext, additionalData []byte) []byte {
+       c, _ := aes.New(key)
+       k := gcm.NewCounterKDF(c).DeriveKey(0x58, [12]byte(nonce))
+       n := nonce[12:]
+       a, _ := aes.New(k[:])
+       g, _ := gcm.New(a, 12, 16)
+       return g.Seal(dst, n, plaintext, additionalData)
+}
+
+func xaesOpen(dst, key, nonce, ciphertext, additionalData []byte) ([]byte, error) {
+       c, _ := aes.New(key)
+       k := gcm.NewCounterKDF(c).DeriveKey(0x58, [12]byte(nonce))
+       n := nonce[12:]
+       a, _ := aes.New(k[:])
+       g, _ := gcm.New(a, 12, 16)
+       return g.Open(dst, n, ciphertext, additionalData)
+}
+
+func TestVectors(t *testing.T) {
+       key := bytes.Repeat([]byte{0x01}, 32)
+       nonce := []byte("ABCDEFGHIJKLMNOPQRSTUVWX")
+       plaintext := []byte("XAES-256-GCM")
+       ciphertext := xaesSeal(nil, key, nonce, plaintext, nil)
+       expected := "ce546ef63c9cc60765923609b33a9a1974e96e52daf2fcf7075e2271"
+       if got := hex.EncodeToString(ciphertext); got != expected {
+               t.Errorf("got: %s", got)
+       }
+       if decrypted, err := xaesOpen(nil, key, nonce, ciphertext, nil); err != nil {
+               t.Fatal(err)
+       } else if !bytes.Equal(plaintext, decrypted) {
+               t.Errorf("plaintext and decrypted are not equal")
+       }
+
+       key = bytes.Repeat([]byte{0x03}, 32)
+       aad := []byte("c2sp.org/XAES-256-GCM")
+       ciphertext = xaesSeal(nil, key, nonce, plaintext, aad)
+       expected = "986ec1832593df5443a179437fd083bf3fdb41abd740a21f71eb769d"
+       if got := hex.EncodeToString(ciphertext); got != expected {
+               t.Errorf("got: %s", got)
+       }
+       if decrypted, err := xaesOpen(nil, key, nonce, ciphertext, aad); err != nil {
+               t.Fatal(err)
+       } else if !bytes.Equal(plaintext, decrypted) {
+               t.Errorf("plaintext and decrypted are not equal")
+       }
+}
+
+func TestAccumulated(t *testing.T) {
+       iterations := 10_000
+       expected := "e6b9edf2df6cec60c8cbd864e2211b597fb69a529160cd040d56c0c210081939"
+
+       s, d := sha3.NewShake128(), sha3.NewShake128()
+       for i := 0; i < iterations; i++ {
+               key := make([]byte, 32)
+               s.Read(key)
+               nonce := make([]byte, 24)
+               s.Read(nonce)
+               lenByte := make([]byte, 1)
+               s.Read(lenByte)
+               plaintext := make([]byte, int(lenByte[0]))
+               s.Read(plaintext)
+               s.Read(lenByte)
+               aad := make([]byte, int(lenByte[0]))
+               s.Read(aad)
+
+               ciphertext := xaesSeal(nil, key, nonce, plaintext, aad)
+               decrypted, err := xaesOpen(nil, key, nonce, ciphertext, aad)
+               if err != nil {
+                       t.Fatal(err)
+               }
+               if !bytes.Equal(plaintext, decrypted) {
+                       t.Errorf("plaintext and decrypted are not equal")
+               }
+
+               d.Write(ciphertext)
+       }
+       if got := hex.EncodeToString(d.Sum(nil)); got != expected {
+               t.Errorf("got: %s", got)
+       }
+}