go/prf/hmac_prf_key_manager_test.go - third_party/tink - Git at Google

 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
 // You may obtain a copy of the License at
 //
 //      http://www.apache.org/licenses/LICENSE-2.0
 //
 // Unless required by applicable law or agreed to in writing, software
 // distributed under the License is distributed on an "AS IS" BASIS,
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
 //
 ////////////////////////////////////////////////////////////////////////////////

 package prf_test

 import (
 	"encoding/hex"
 	"fmt"
 	"testing"

 	"github.com/golang/protobuf/proto"
 	"github.com/google/tink/go/core/registry"
 	"github.com/google/tink/go/prf"
 	"github.com/google/tink/go/prf/subtle"
 	"github.com/google/tink/go/subtle/random"
 	"github.com/google/tink/go/testutil"
 	commonpb "github.com/google/tink/go/proto/common_go_proto"
 	hmacpb "github.com/google/tink/go/proto/hmac_prf_go_proto"
 	tinkpb "github.com/google/tink/go/proto/tink_go_proto"
 )

 func TestGetPrimitiveHMACBasic(t *testing.T) {
 	km, err := registry.GetKeyManager(testutil.HMACPRFTypeURL)
 	if err != nil {
 		t.Errorf("HMAC PRF key manager not found: %s", err)
 	}
 	testKeys := genValidHMACPRFKeys()
 	for i := 0; i < len(testKeys); i++ {
 		serializedKey, _ := proto.Marshal(testKeys[i])
 		p, err := km.Primitive(serializedKey)
 		if err != nil {
 			t.Errorf("unexpected error in test case %d: %s", i, err)
 		}
 		if err := validateHMACPRFPrimitive(p, testKeys[i]); err != nil {
 			t.Errorf("%s", err)
 		}
 	}
 }

 func TestGetPrimitiveHMACWithInvalidInput(t *testing.T) {
 	km, err := registry.GetKeyManager(testutil.HMACPRFTypeURL)
 	if err != nil {
 		t.Errorf("cannot obtain HMAC PRFkey manager: %s", err)
 	}
 	// invalid key
 	testKeys := genInvalidHMACPRFKeys()
 	for i := 0; i < len(testKeys); i++ {
 		serializedKey, _ := proto.Marshal(testKeys[i])
 		if _, err := km.Primitive(serializedKey); err == nil {
 			t.Errorf("expect an error in test case %d", i)
 		}
 	}
 	if _, err := km.Primitive(nil); err == nil {
 		t.Errorf("expect an error when input is nil")
 	}
 	// empty input
 	if _, err := km.Primitive([]byte{}); err == nil {
 		t.Errorf("expect an error when input is empty")
 	}
 }

 func TestNewKeyHMACMultipleTimes(t *testing.T) {
 	km, err := registry.GetKeyManager(testutil.HMACPRFTypeURL)
 	if err != nil {
 		t.Errorf("cannot obtain HMAC PRF key manager: %s", err)
 	}
 	serializedFormat, _ := proto.Marshal(testutil.NewHMACPRFKeyFormat(commonpb.HashType_SHA256))
 	keys := make(map[string]bool)
 	nTest := 26
 	for i := 0; i < nTest; i++ {
 		key, _ := km.NewKey(serializedFormat)
 		serializedKey, _ := proto.Marshal(key)
 		keys[string(serializedKey)] = true

 		keyData, _ := km.NewKeyData(serializedFormat)
 		serializedKey = keyData.Value
 		keys[string(serializedKey)] = true
 	}
 	if len(keys) != nTest*2 {
 		t.Errorf("key is repeated")
 	}
 }

 func TestNewKeyHMACBasic(t *testing.T) {
 	km, err := registry.GetKeyManager(testutil.HMACPRFTypeURL)
 	if err != nil {
 		t.Errorf("cannot obtain HMAC PRF key manager: %s", err)
 	}
 	testFormats := genValidHMACPRFKeyFormats()
 	for i := 0; i < len(testFormats); i++ {
 		serializedFormat, _ := proto.Marshal(testFormats[i])
 		key, err := km.NewKey(serializedFormat)
 		if err != nil {
 			t.Errorf("unexpected error in test case %d: %s", i, err)
 		}
 		if err := validateHMACPRFKey(testFormats[i], key.(*hmacpb.HmacPrfKey)); err != nil {
 			t.Errorf("%s", err)
 		}
 	}
 }

 func TestNewKeyHMACWithInvalidInput(t *testing.T) {
 	km, err := registry.GetKeyManager(testutil.HMACPRFTypeURL)
 	if err != nil {
 		t.Errorf("cannot obtain HMAC PRF key manager: %s", err)
 	}
 	// invalid key formats
 	testFormats := genInvalidHMACPRFKeyFormats()
 	for i := 0; i < len(testFormats); i++ {
 		serializedFormat, err := proto.Marshal(testFormats[i])
 		if err != nil {
 			fmt.Println("Error!")
 		}
 		if _, err := km.NewKey(serializedFormat); err == nil {
 			t.Errorf("expect an error in test case %d: %s", i, err)
 		}
 	}
 	if _, err := km.NewKey(nil); err == nil {
 		t.Errorf("expect an error when input is nil")
 	}
 	// empty input
 	if _, err := km.NewKey([]byte{}); err == nil {
 		t.Errorf("expect an error when input is empty")
 	}
 }

 func TestNewKeyDataHMACBasic(t *testing.T) {
 	km, err := registry.GetKeyManager(testutil.HMACPRFTypeURL)
 	if err != nil {
 		t.Errorf("cannot obtain HMAC PRF key manager: %s", err)
 	}
 	testFormats := genValidHMACPRFKeyFormats()
 	for i := 0; i < len(testFormats); i++ {
 		serializedFormat, _ := proto.Marshal(testFormats[i])
 		keyData, err := km.NewKeyData(serializedFormat)
 		if err != nil {
 			t.Errorf("unexpected error in test case %d: %s", i, err)
 		}
 		if keyData.TypeUrl != testutil.HMACPRFTypeURL {
 			t.Errorf("incorrect type url in test case %d", i)
 		}
 		if keyData.KeyMaterialType != tinkpb.KeyData_SYMMETRIC {
 			t.Errorf("incorrect key material type in test case %d", i)
 		}
 		key := new(hmacpb.HmacPrfKey)
 		if err := proto.Unmarshal(keyData.Value, key); err != nil {
 			t.Errorf("invalid key value")
 		}
 		if err := validateHMACPRFKey(testFormats[i], key); err != nil {
 			t.Errorf("invalid key")
 		}
 	}
 }

 func TestNewKeyDataHMACWithInvalidInput(t *testing.T) {
 	km, err := registry.GetKeyManager(testutil.HMACPRFTypeURL)
 	if err != nil {
 		t.Errorf("HMAC PRF key manager not found: %s", err)
 	}
 	// invalid key formats
 	testFormats := genInvalidHMACPRFKeyFormats()
 	for i := 0; i < len(testFormats); i++ {
 		serializedFormat, _ := proto.Marshal(testFormats[i])
 		if _, err := km.NewKeyData(serializedFormat); err == nil {
 			t.Errorf("expect an error in test case %d", i)
 		}
 	}
 	// nil input
 	if _, err := km.NewKeyData(nil); err == nil {
 		t.Errorf("expect an error when input is nil")
 	}
 }

 func TestHMACDoesSupport(t *testing.T) {
 	km, err := registry.GetKeyManager(testutil.HMACPRFTypeURL)
 	if err != nil {
 		t.Errorf("HMAC PRF key manager not found: %s", err)
 	}
 	if !km.DoesSupport(testutil.HMACPRFTypeURL) {
 		t.Errorf("HMACPRFKeyManager must support %s", testutil.HMACPRFTypeURL)
 	}
 	if km.DoesSupport("some bad type") {
 		t.Errorf("HMACPRFKeyManager must support only %s", testutil.HMACPRFTypeURL)
 	}
 }

 func TestHMACTypeURL(t *testing.T) {
 	km, err := registry.GetKeyManager(testutil.HMACPRFTypeURL)
 	if err != nil {
 		t.Errorf("HMAC PRF key manager not found: %s", err)
 	}
 	if km.TypeURL() != testutil.HMACPRFTypeURL {
 		t.Errorf("incorrect GetKeyType()")
 	}
 }

 func genInvalidHMACPRFKeys() []proto.Message {
 	badVersionKey := testutil.NewHMACPRFKey(commonpb.HashType_SHA256)
 	badVersionKey.Version++
 	shortKey := testutil.NewHMACPRFKey(commonpb.HashType_SHA256)
 	shortKey.KeyValue = []byte{1, 1}
 	return []proto.Message{
 		// not a HMACPRFKey
 		testutil.NewHMACParams(commonpb.HashType_SHA256, 32),
 		// bad version
 		badVersionKey,
 		// key too short
 		shortKey,
 		// unknown hash type
 		testutil.NewHMACPRFKey(commonpb.HashType_UNKNOWN_HASH),
 	}
 }

 func genInvalidHMACPRFKeyFormats() []proto.Message {
 	shortKeyFormat := testutil.NewHMACPRFKeyFormat(commonpb.HashType_SHA256)
 	shortKeyFormat.KeySize = 1
 	return []proto.Message{
 		// not a HMACPRFKeyFormat
 		testutil.NewHMACParams(commonpb.HashType_SHA256, 32),
 		// key too short
 		shortKeyFormat,
 		// unknown hash type
 		testutil.NewHMACPRFKeyFormat(commonpb.HashType_UNKNOWN_HASH),
 	}
 }

 func genValidHMACPRFKeyFormats() []*hmacpb.HmacPrfKeyFormat {
 	return []*hmacpb.HmacPrfKeyFormat{
 		testutil.NewHMACPRFKeyFormat(commonpb.HashType_SHA1),
 		testutil.NewHMACPRFKeyFormat(commonpb.HashType_SHA256),
 		testutil.NewHMACPRFKeyFormat(commonpb.HashType_SHA512),
 	}
 }

 func genValidHMACPRFKeys() []*hmacpb.HmacPrfKey {
 	return []*hmacpb.HmacPrfKey{
 		testutil.NewHMACPRFKey(commonpb.HashType_SHA1),
 		testutil.NewHMACPRFKey(commonpb.HashType_SHA256),
 		testutil.NewHMACPRFKey(commonpb.HashType_SHA512),
 	}
 }

 // Checks whether the given HMACPRFKey matches the given key HMACPRFKeyFormat
 func validateHMACPRFKey(format *hmacpb.HmacPrfKeyFormat, key *hmacpb.HmacPrfKey) error {
 	if format.KeySize != uint32(len(key.KeyValue)) ||
 		key.Params.Hash != format.Params.Hash {
 		return fmt.Errorf("key format and generated key do not match")
 	}
 	p, err := subtle.NewHMACPRF(commonpb.HashType_name[int32(key.Params.Hash)], key.KeyValue)
 	if err != nil {
 		return fmt.Errorf("cannot create primitive from key: %s", err)
 	}
 	return validateHMACPRFPrimitive(p, key)
 }

 // validateHMACPRFPrimitive checks whether the given primitive can compute a PRF of length 16
 func validateHMACPRFPrimitive(p interface{}, key *hmacpb.HmacPrfKey) error {
 	hmac := p.(prf.PRF)
 	prfPrimitive, err := subtle.NewHMACPRF(commonpb.HashType_name[int32(key.Params.Hash)], key.KeyValue)
 	if err != nil {
 		return fmt.Errorf("Could not create HMAC PRF with key material %q: %s", hex.EncodeToString(key.KeyValue), err)
 	}
 	data := random.GetRandomBytes(20)
 	res, err := hmac.ComputePRF(data, 16)
 	if err != nil {
 		return fmt.Errorf("prf computation failed: %s", err)
 	}
 	if len(res) != 16 {
 		return fmt.Errorf("prf computation did not produce 16 byte output")
 	}
 	res2, err := prfPrimitive.ComputePRF(data, 16)
 	if err != nil {
 		return fmt.Errorf("prf computation failed: %s", err)
 	}
 	if len(res2) != 16 {
 		return fmt.Errorf("prf computation did not produce 16 byte output")
 	}
 	if hex.EncodeToString(res) != hex.EncodeToString(res2) {
 		return fmt.Errorf("prf computation did not produce the same output for the same key and input")
 	}
 	return nil
 }
	// Licensed under the Apache License, Version 2.0 (the "License");
	// you may not use this file except in compliance with the License.
	// You may obtain a copy of the License at
	//
	// http://www.apache.org/licenses/LICENSE-2.0
	//
	// Unless required by applicable law or agreed to in writing, software
	// distributed under the License is distributed on an "AS IS" BASIS,
	// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	// See the License for the specific language governing permissions and
	// limitations under the License.
	//
	////////////////////////////////////////////////////////////////////////////////

	package prf_test

	import (
	"encoding/hex"
	"fmt"
	"testing"

	"github.com/golang/protobuf/proto"
	"github.com/google/tink/go/core/registry"
	"github.com/google/tink/go/prf"
	"github.com/google/tink/go/prf/subtle"
	"github.com/google/tink/go/subtle/random"
	"github.com/google/tink/go/testutil"
	commonpb "github.com/google/tink/go/proto/common_go_proto"
	hmacpb "github.com/google/tink/go/proto/hmac_prf_go_proto"
	tinkpb "github.com/google/tink/go/proto/tink_go_proto"
	)

	func TestGetPrimitiveHMACBasic(t *testing.T) {
	km, err := registry.GetKeyManager(testutil.HMACPRFTypeURL)
	if err != nil {
	t.Errorf("HMAC PRF key manager not found: %s", err)
	}
	testKeys := genValidHMACPRFKeys()
	for i := 0; i < len(testKeys); i++ {
	serializedKey, _ := proto.Marshal(testKeys[i])
	p, err := km.Primitive(serializedKey)
	if err != nil {
	t.Errorf("unexpected error in test case %d: %s", i, err)
	}
	if err := validateHMACPRFPrimitive(p, testKeys[i]); err != nil {
	t.Errorf("%s", err)
	}
	}
	}

	func TestGetPrimitiveHMACWithInvalidInput(t *testing.T) {
	km, err := registry.GetKeyManager(testutil.HMACPRFTypeURL)
	if err != nil {
	t.Errorf("cannot obtain HMAC PRFkey manager: %s", err)
	}
	// invalid key
	testKeys := genInvalidHMACPRFKeys()
	for i := 0; i < len(testKeys); i++ {
	serializedKey, _ := proto.Marshal(testKeys[i])
	if _, err := km.Primitive(serializedKey); err == nil {
	t.Errorf("expect an error in test case %d", i)
	}
	}
	if _, err := km.Primitive(nil); err == nil {
	t.Errorf("expect an error when input is nil")
	}
	// empty input
	if _, err := km.Primitive([]byte{}); err == nil {
	t.Errorf("expect an error when input is empty")
	}
	}

	func TestNewKeyHMACMultipleTimes(t *testing.T) {
	km, err := registry.GetKeyManager(testutil.HMACPRFTypeURL)
	if err != nil {
	t.Errorf("cannot obtain HMAC PRF key manager: %s", err)
	}
	serializedFormat, _ := proto.Marshal(testutil.NewHMACPRFKeyFormat(commonpb.HashType_SHA256))
	keys := make(map[string]bool)
	nTest := 26
	for i := 0; i < nTest; i++ {
	key, _ := km.NewKey(serializedFormat)
	serializedKey, _ := proto.Marshal(key)
	keys[string(serializedKey)] = true

	keyData, _ := km.NewKeyData(serializedFormat)
	serializedKey = keyData.Value
	keys[string(serializedKey)] = true
	}
	if len(keys) != nTest*2 {
	t.Errorf("key is repeated")
	}
	}

	func TestNewKeyHMACBasic(t *testing.T) {
	km, err := registry.GetKeyManager(testutil.HMACPRFTypeURL)
	if err != nil {
	t.Errorf("cannot obtain HMAC PRF key manager: %s", err)
	}
	testFormats := genValidHMACPRFKeyFormats()
	for i := 0; i < len(testFormats); i++ {
	serializedFormat, _ := proto.Marshal(testFormats[i])
	key, err := km.NewKey(serializedFormat)
	if err != nil {
	t.Errorf("unexpected error in test case %d: %s", i, err)
	}
	if err := validateHMACPRFKey(testFormats[i], key.(*hmacpb.HmacPrfKey)); err != nil {
	t.Errorf("%s", err)
	}
	}
	}

	func TestNewKeyHMACWithInvalidInput(t *testing.T) {
	km, err := registry.GetKeyManager(testutil.HMACPRFTypeURL)
	if err != nil {
	t.Errorf("cannot obtain HMAC PRF key manager: %s", err)
	}
	// invalid key formats
	testFormats := genInvalidHMACPRFKeyFormats()
	for i := 0; i < len(testFormats); i++ {
	serializedFormat, err := proto.Marshal(testFormats[i])
	if err != nil {
	fmt.Println("Error!")
	}
	if _, err := km.NewKey(serializedFormat); err == nil {
	t.Errorf("expect an error in test case %d: %s", i, err)
	}
	}
	if _, err := km.NewKey(nil); err == nil {
	t.Errorf("expect an error when input is nil")
	}
	// empty input
	if _, err := km.NewKey([]byte{}); err == nil {
	t.Errorf("expect an error when input is empty")
	}
	}

	func TestNewKeyDataHMACBasic(t *testing.T) {
	km, err := registry.GetKeyManager(testutil.HMACPRFTypeURL)
	if err != nil {
	t.Errorf("cannot obtain HMAC PRF key manager: %s", err)
	}
	testFormats := genValidHMACPRFKeyFormats()
	for i := 0; i < len(testFormats); i++ {
	serializedFormat, _ := proto.Marshal(testFormats[i])
	keyData, err := km.NewKeyData(serializedFormat)
	if err != nil {
	t.Errorf("unexpected error in test case %d: %s", i, err)
	}
	if keyData.TypeUrl != testutil.HMACPRFTypeURL {
	t.Errorf("incorrect type url in test case %d", i)
	}
	if keyData.KeyMaterialType != tinkpb.KeyData_SYMMETRIC {
	t.Errorf("incorrect key material type in test case %d", i)
	}
	key := new(hmacpb.HmacPrfKey)
	if err := proto.Unmarshal(keyData.Value, key); err != nil {
	t.Errorf("invalid key value")
	}
	if err := validateHMACPRFKey(testFormats[i], key); err != nil {
	t.Errorf("invalid key")
	}
	}
	}

	func TestNewKeyDataHMACWithInvalidInput(t *testing.T) {
	km, err := registry.GetKeyManager(testutil.HMACPRFTypeURL)
	if err != nil {
	t.Errorf("HMAC PRF key manager not found: %s", err)
	}
	// invalid key formats
	testFormats := genInvalidHMACPRFKeyFormats()
	for i := 0; i < len(testFormats); i++ {
	serializedFormat, _ := proto.Marshal(testFormats[i])
	if _, err := km.NewKeyData(serializedFormat); err == nil {
	t.Errorf("expect an error in test case %d", i)
	}
	}
	// nil input
	if _, err := km.NewKeyData(nil); err == nil {
	t.Errorf("expect an error when input is nil")
	}
	}

	func TestHMACDoesSupport(t *testing.T) {
	km, err := registry.GetKeyManager(testutil.HMACPRFTypeURL)
	if err != nil {
	t.Errorf("HMAC PRF key manager not found: %s", err)
	}
	if !km.DoesSupport(testutil.HMACPRFTypeURL) {
	t.Errorf("HMACPRFKeyManager must support %s", testutil.HMACPRFTypeURL)
	}
	if km.DoesSupport("some bad type") {
	t.Errorf("HMACPRFKeyManager must support only %s", testutil.HMACPRFTypeURL)
	}
	}

	func TestHMACTypeURL(t *testing.T) {
	km, err := registry.GetKeyManager(testutil.HMACPRFTypeURL)
	if err != nil {
	t.Errorf("HMAC PRF key manager not found: %s", err)
	}
	if km.TypeURL() != testutil.HMACPRFTypeURL {
	t.Errorf("incorrect GetKeyType()")
	}
	}

	func genInvalidHMACPRFKeys() []proto.Message {
	badVersionKey := testutil.NewHMACPRFKey(commonpb.HashType_SHA256)
	badVersionKey.Version++
	shortKey := testutil.NewHMACPRFKey(commonpb.HashType_SHA256)
	shortKey.KeyValue = []byte{1, 1}
	return []proto.Message{
	// not a HMACPRFKey
	testutil.NewHMACParams(commonpb.HashType_SHA256, 32),
	// bad version
	badVersionKey,
	// key too short
	shortKey,
	// unknown hash type
	testutil.NewHMACPRFKey(commonpb.HashType_UNKNOWN_HASH),
	}
	}

	func genInvalidHMACPRFKeyFormats() []proto.Message {
	shortKeyFormat := testutil.NewHMACPRFKeyFormat(commonpb.HashType_SHA256)
	shortKeyFormat.KeySize = 1
	return []proto.Message{
	// not a HMACPRFKeyFormat
	testutil.NewHMACParams(commonpb.HashType_SHA256, 32),
	// key too short
	shortKeyFormat,
	// unknown hash type
	testutil.NewHMACPRFKeyFormat(commonpb.HashType_UNKNOWN_HASH),
	}
	}

	func genValidHMACPRFKeyFormats() []*hmacpb.HmacPrfKeyFormat {
	return []*hmacpb.HmacPrfKeyFormat{
	testutil.NewHMACPRFKeyFormat(commonpb.HashType_SHA1),
	testutil.NewHMACPRFKeyFormat(commonpb.HashType_SHA256),
	testutil.NewHMACPRFKeyFormat(commonpb.HashType_SHA512),
	}
	}

	func genValidHMACPRFKeys() []*hmacpb.HmacPrfKey {
	return []*hmacpb.HmacPrfKey{
	testutil.NewHMACPRFKey(commonpb.HashType_SHA1),
	testutil.NewHMACPRFKey(commonpb.HashType_SHA256),
	testutil.NewHMACPRFKey(commonpb.HashType_SHA512),
	}
	}

	// Checks whether the given HMACPRFKey matches the given key HMACPRFKeyFormat
	func validateHMACPRFKey(format hmacpb.HmacPrfKeyFormat, key hmacpb.HmacPrfKey) error {
	if format.KeySize != uint32(len(key.KeyValue)) \|\|
	key.Params.Hash != format.Params.Hash {
	return fmt.Errorf("key format and generated key do not match")
	}
	p, err := subtle.NewHMACPRF(commonpb.HashType_name[int32(key.Params.Hash)], key.KeyValue)
	if err != nil {
	return fmt.Errorf("cannot create primitive from key: %s", err)
	}
	return validateHMACPRFPrimitive(p, key)
	}

	// validateHMACPRFPrimitive checks whether the given primitive can compute a PRF of length 16
	func validateHMACPRFPrimitive(p interface{}, key *hmacpb.HmacPrfKey) error {
	hmac := p.(prf.PRF)
	prfPrimitive, err := subtle.NewHMACPRF(commonpb.HashType_name[int32(key.Params.Hash)], key.KeyValue)
	if err != nil {
	return fmt.Errorf("Could not create HMAC PRF with key material %q: %s", hex.EncodeToString(key.KeyValue), err)
	}
	data := random.GetRandomBytes(20)
	res, err := hmac.ComputePRF(data, 16)
	if err != nil {
	return fmt.Errorf("prf computation failed: %s", err)
	}
	if len(res) != 16 {
	return fmt.Errorf("prf computation did not produce 16 byte output")
	}
	res2, err := prfPrimitive.ComputePRF(data, 16)
	if err != nil {
	return fmt.Errorf("prf computation failed: %s", err)
	}
	if len(res2) != 16 {
	return fmt.Errorf("prf computation did not produce 16 byte output")
	}
	if hex.EncodeToString(res) != hex.EncodeToString(res2) {
	return fmt.Errorf("prf computation did not produce the same output for the same key and input")
	}
	return nil
	}