1 // Copyright 2023 Google LLC 2 // 3 // Licensed under the Apache License, Version 2.0 (the "License"); 4 // you may not use this file except in compliance with the License. 5 // You may obtain a copy of the License at 6 // 7 // http://www.apache.org/licenses/LICENSE-2.0 8 // 9 // Unless required by applicable law or agreed to in writing, software 10 // distributed under the License is distributed on an "AS IS" BASIS, 11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 // See the License for the specific language governing permissions and 13 // limitations under the License. 14 // 15 //////////////////////////////////////////////////////////////////////////////// 16 17 package com.google.crypto.tink.prf; 18 19 import static com.google.common.truth.Truth.assertThat; 20 import static org.junit.Assert.assertThrows; 21 22 import com.google.crypto.tink.InsecureSecretKeyAccess; 23 import com.google.crypto.tink.internal.KeyTester; 24 import com.google.crypto.tink.util.SecretBytes; 25 import java.security.GeneralSecurityException; 26 import org.junit.Test; 27 import org.junit.experimental.theories.DataPoints; 28 import org.junit.experimental.theories.FromDataPoints; 29 import org.junit.experimental.theories.Theories; 30 import org.junit.experimental.theories.Theory; 31 import org.junit.runner.RunWith; 32 33 @RunWith(Theories.class) 34 public final class HmacPrfKeyTest { 35 @DataPoints("keySizes") 36 public static final int[] KEY_SIZES = new int[] {16, 32}; 37 38 @DataPoints("hashTypes") 39 public static final HmacPrfParameters.HashType[] HASH_TYPES = 40 new HmacPrfParameters.HashType[] { 41 HmacPrfParameters.HashType.SHA1, 42 HmacPrfParameters.HashType.SHA224, 43 HmacPrfParameters.HashType.SHA256, 44 HmacPrfParameters.HashType.SHA384, 45 HmacPrfParameters.HashType.SHA512 46 }; 47 48 @Theory buildAndGetPropertiesVariedValues_succeeds( @romDataPoints"keySizes") int keySize, @FromDataPoints("hashTypes") HmacPrfParameters.HashType hashType)49 public void buildAndGetPropertiesVariedValues_succeeds( 50 @FromDataPoints("keySizes") int keySize, 51 @FromDataPoints("hashTypes") HmacPrfParameters.HashType hashType) 52 throws Exception { 53 HmacPrfParameters parameters = 54 HmacPrfParameters.builder().setKeySizeBytes(keySize).setHashType(hashType).build(); 55 assertThat(parameters.hasIdRequirement()).isFalse(); 56 SecretBytes keyBytes = SecretBytes.randomBytes(keySize); 57 HmacPrfKey key = HmacPrfKey.builder().setParameters(parameters).setKeyBytes(keyBytes).build(); 58 59 assertThat(key.getParameters()).isEqualTo(parameters); 60 assertThat(key.getKeyBytes()).isEqualTo(keyBytes); 61 assertThat(key.getIdRequirementOrNull()).isNull(); 62 } 63 64 @Test buildWithoutSettingParameters_fails()65 public void buildWithoutSettingParameters_fails() throws Exception { 66 assertThrows( 67 GeneralSecurityException.class, 68 () -> HmacPrfKey.builder().setKeyBytes(SecretBytes.randomBytes(16)).build()); 69 } 70 71 @Test buildWithoutSettingKeyBytes_fails()72 public void buildWithoutSettingKeyBytes_fails() throws Exception { 73 assertThrows( 74 GeneralSecurityException.class, 75 () -> 76 HmacPrfKey.builder() 77 .setParameters( 78 HmacPrfParameters.builder() 79 .setKeySizeBytes(16) 80 .setHashType(HmacPrfParameters.HashType.SHA256) 81 .build()) 82 .build()); 83 } 84 85 @Test buildWithKeySizeMismatch_fails()86 public void buildWithKeySizeMismatch_fails() throws Exception { 87 assertThrows( 88 GeneralSecurityException.class, 89 () -> 90 HmacPrfKey.builder() 91 .setParameters( 92 HmacPrfParameters.builder() 93 .setKeySizeBytes(16) 94 .setHashType(HmacPrfParameters.HashType.SHA256) 95 .build()) 96 .setKeyBytes(SecretBytes.randomBytes(32)) 97 .build()); 98 } 99 100 @Test equals()101 public void equals() throws Exception { 102 SecretBytes keyBytes = SecretBytes.randomBytes(16); 103 SecretBytes keyBytesCopy = 104 SecretBytes.copyFrom( 105 keyBytes.toByteArray(InsecureSecretKeyAccess.get()), InsecureSecretKeyAccess.get()); 106 HmacPrfParameters parameters16 = 107 HmacPrfParameters.builder() 108 .setKeySizeBytes(16) 109 .setHashType(HmacPrfParameters.HashType.SHA256) 110 .build(); 111 HmacPrfParameters parameters32 = 112 HmacPrfParameters.builder() 113 .setKeySizeBytes(32) 114 .setHashType(HmacPrfParameters.HashType.SHA256) 115 .build(); 116 117 new KeyTester() 118 .addEqualityGroup( 119 "16-byte key", 120 HmacPrfKey.builder().setParameters(parameters16).setKeyBytes(keyBytes).build(), 121 // Same key built twice. 122 HmacPrfKey.builder().setParameters(parameters16).setKeyBytes(keyBytes).build(), 123 // Same key built with a copy of the key bytes. 124 HmacPrfKey.builder().setParameters(parameters16).setKeyBytes(keyBytesCopy).build()) 125 .addEqualityGroup( 126 "16-byte random key bytes", 127 HmacPrfKey.builder() 128 .setParameters(parameters16) 129 .setKeyBytes(SecretBytes.randomBytes(16)) 130 .build()) 131 .addEqualityGroup( 132 "32-byte random key bytes", 133 HmacPrfKey.builder() 134 .setParameters(parameters32) 135 .setKeyBytes(SecretBytes.randomBytes(32)) 136 .build()) 137 .addEqualityGroup( 138 "different key class", 139 HkdfPrfKey.builder() 140 .setParameters( 141 HkdfPrfParameters.builder() 142 .setKeySizeBytes(16) 143 .setHashType(HkdfPrfParameters.HashType.SHA256) 144 .build()) 145 .setKeyBytes(keyBytes) 146 .build()) 147 .doTests(); 148 } 149 } 150