blob: f97b64fdec005327b1eb9f2a3c7b58917ebdd9d4 [file] [log] [blame]
// Copyright 2017 Google Inc.
//
// 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 com.google.crypto.tink.mac;
import com.google.crypto.tink.KeyTemplate;
import com.google.crypto.tink.KeyTypeManager;
import com.google.crypto.tink.Mac;
import com.google.crypto.tink.Registry;
import com.google.crypto.tink.proto.HashType;
import com.google.crypto.tink.proto.HmacKey;
import com.google.crypto.tink.proto.HmacKeyFormat;
import com.google.crypto.tink.proto.HmacParams;
import com.google.crypto.tink.proto.KeyData.KeyMaterialType;
import com.google.crypto.tink.subtle.PrfHmacJce;
import com.google.crypto.tink.subtle.PrfMac;
import com.google.crypto.tink.subtle.Random;
import com.google.crypto.tink.subtle.Validators;
import com.google.protobuf.ByteString;
import com.google.protobuf.ExtensionRegistryLite;
import com.google.protobuf.InvalidProtocolBufferException;
import java.io.IOException;
import java.io.InputStream;
import java.security.GeneralSecurityException;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
import javax.crypto.spec.SecretKeySpec;
/**
* This key manager generates new {@code HmacKey} keys and produces new instances of {@code
* PrfHmacJce}.
*/
public final class HmacKeyManager extends KeyTypeManager<HmacKey> {
public HmacKeyManager() {
super(
HmacKey.class,
new PrimitiveFactory<Mac, HmacKey>(Mac.class) {
@Override
public Mac getPrimitive(HmacKey key) throws GeneralSecurityException {
HashType hash = key.getParams().getHash();
byte[] keyValue = key.getKeyValue().toByteArray();
SecretKeySpec keySpec = new SecretKeySpec(keyValue, "HMAC");
int tagSize = key.getParams().getTagSize();
switch (hash) {
case SHA1:
return new PrfMac(new PrfHmacJce("HMACSHA1", keySpec), tagSize);
case SHA224:
return new PrfMac(new PrfHmacJce("HMACSHA224", keySpec), tagSize);
case SHA256:
return new PrfMac(new PrfHmacJce("HMACSHA256", keySpec), tagSize);
case SHA384:
return new PrfMac(new PrfHmacJce("HMACSHA384", keySpec), tagSize);
case SHA512:
return new PrfMac(new PrfHmacJce("HMACSHA512", keySpec), tagSize);
default:
throw new GeneralSecurityException("unknown hash");
}
}
});
}
/** Minimum key size in bytes. */
private static final int MIN_KEY_SIZE_IN_BYTES = 16;
/** Minimum tag size in bytes. This provides minimum 80-bit security strength. */
private static final int MIN_TAG_SIZE_IN_BYTES = 10;
@Override
public String getKeyType() {
return "type.googleapis.com/google.crypto.tink.HmacKey";
}
@Override
public int getVersion() {
return 0;
}
@Override
public KeyMaterialType keyMaterialType() {
return KeyMaterialType.SYMMETRIC;
}
@Override
public void validateKey(HmacKey key) throws GeneralSecurityException {
Validators.validateVersion(key.getVersion(), getVersion());
if (key.getKeyValue().size() < MIN_KEY_SIZE_IN_BYTES) {
throw new GeneralSecurityException("key too short");
}
validateParams(key.getParams());
}
@Override
public HmacKey parseKey(ByteString byteString) throws InvalidProtocolBufferException {
return HmacKey.parseFrom(byteString, ExtensionRegistryLite.getEmptyRegistry());
}
private static void validateParams(HmacParams params) throws GeneralSecurityException {
if (params.getTagSize() < MIN_TAG_SIZE_IN_BYTES) {
throw new GeneralSecurityException("tag size too small");
}
switch (params.getHash()) {
case SHA1:
if (params.getTagSize() > 20) {
throw new GeneralSecurityException("tag size too big");
}
break;
case SHA224:
if (params.getTagSize() > 28) {
throw new GeneralSecurityException("tag size too big");
}
break;
case SHA256:
if (params.getTagSize() > 32) {
throw new GeneralSecurityException("tag size too big");
}
break;
case SHA384:
if (params.getTagSize() > 48) {
throw new GeneralSecurityException("tag size too big");
}
break;
case SHA512:
if (params.getTagSize() > 64) {
throw new GeneralSecurityException("tag size too big");
}
break;
default:
throw new GeneralSecurityException("unknown hash type");
}
}
@Override
public KeyFactory<HmacKeyFormat, HmacKey> keyFactory() {
return new KeyFactory<HmacKeyFormat, HmacKey>(HmacKeyFormat.class) {
@Override
public void validateKeyFormat(HmacKeyFormat format) throws GeneralSecurityException {
if (format.getKeySize() < MIN_KEY_SIZE_IN_BYTES) {
throw new GeneralSecurityException("key too short");
}
validateParams(format.getParams());
}
@Override
public HmacKeyFormat parseKeyFormat(ByteString byteString)
throws InvalidProtocolBufferException {
return HmacKeyFormat.parseFrom(byteString, ExtensionRegistryLite.getEmptyRegistry());
}
@Override
public HmacKey createKey(HmacKeyFormat format) throws GeneralSecurityException {
return HmacKey.newBuilder()
.setVersion(getVersion())
.setParams(format.getParams())
.setKeyValue(ByteString.copyFrom(Random.randBytes(format.getKeySize())))
.build();
}
@Override
public HmacKey deriveKey(HmacKeyFormat format, InputStream inputStream)
throws GeneralSecurityException {
Validators.validateVersion(format.getVersion(), getVersion());
byte[] pseudorandomness = new byte[format.getKeySize()];
try {
int read = inputStream.read(pseudorandomness);
if (read != format.getKeySize()) {
throw new GeneralSecurityException("Not enough pseudorandomness given");
}
return HmacKey.newBuilder()
.setVersion(getVersion())
.setParams(format.getParams())
.setKeyValue(ByteString.copyFrom(pseudorandomness))
.build();
} catch (IOException e) {
throw new GeneralSecurityException("Reading pseudorandomness failed", e);
}
}
@Override
public Map<String, KeyFactory.KeyFormat<HmacKeyFormat>> keyFormats()
throws GeneralSecurityException {
Map<String, KeyFactory.KeyFormat<HmacKeyFormat>> result = new HashMap<>();
result.put(
"HMAC_SHA256_128BITTAG",
createKeyFormat(32, 16, HashType.SHA256, KeyTemplate.OutputPrefixType.TINK));
result.put(
"HMAC_SHA256_128BITTAG_RAW",
createKeyFormat(32, 16, HashType.SHA256, KeyTemplate.OutputPrefixType.RAW));
result.put(
"HMAC_SHA256_256BITTAG",
createKeyFormat(32, 32, HashType.SHA256, KeyTemplate.OutputPrefixType.TINK));
result.put(
"HMAC_SHA256_256BITTAG_RAW",
createKeyFormat(32, 32, HashType.SHA256, KeyTemplate.OutputPrefixType.RAW));
result.put(
"HMAC_SHA512_128BITTAG",
createKeyFormat(64, 16, HashType.SHA512, KeyTemplate.OutputPrefixType.TINK));
result.put(
"HMAC_SHA512_128BITTAG_RAW",
createKeyFormat(64, 16, HashType.SHA512, KeyTemplate.OutputPrefixType.RAW));
result.put(
"HMAC_SHA512_256BITTAG",
createKeyFormat(64, 32, HashType.SHA512, KeyTemplate.OutputPrefixType.TINK));
result.put(
"HMAC_SHA512_256BITTAG_RAW",
createKeyFormat(64, 32, HashType.SHA512, KeyTemplate.OutputPrefixType.RAW));
result.put(
"HMAC_SHA512_512BITTAG",
createKeyFormat(64, 64, HashType.SHA512, KeyTemplate.OutputPrefixType.TINK));
result.put(
"HMAC_SHA512_512BITTAG_RAW",
createKeyFormat(64, 64, HashType.SHA512, KeyTemplate.OutputPrefixType.RAW));
return Collections.unmodifiableMap(result);
}
};
}
public static void register(boolean newKeyAllowed) throws GeneralSecurityException {
Registry.registerKeyManager(new HmacKeyManager(), newKeyAllowed);
}
/**
* @return A {@link KeyTemplate} that generates new instances of HMAC keys with the following
* parameters:
* <ul>
* <li>Key size: 32 bytes
* <li>Tag size: 16 bytes
* <li>Hash function: SHA256
* <li>Prefix type: {@link KeyTemplate.OutputPrefixType#TINK}
* </ul>
*
* @deprecated use {@code KeyTemplates.get("HMAC_SHA256_128BITTAG")}
*/
@Deprecated
public static final KeyTemplate hmacSha256HalfDigestTemplate() {
return createTemplate(32, 16, HashType.SHA256);
}
/**
* @return A {@link KeyTemplate} that generates new instances of HMAC keys with the following
* parameters:
* <ul>
* <li>Key size: 32 bytes
* <li>Tag size: 32 bytes
* <li>Hash function: SHA256
* <li>Prefix type: {@link KeyTemplate.OutputPrefixType#TINK}
* </ul>
*
* @deprecated use {@code KeyTemplates.get("HMAC_SHA256_256BITTAG")}
*/
@Deprecated
public static final KeyTemplate hmacSha256Template() {
return createTemplate(32, 32, HashType.SHA256);
}
/**
* @return A {@link KeyTemplate} that generates new instances of HMAC keys with the following
* parameters:
* <ul>
* <li>Key size: 64 bytes
* <li>Tag size: 32 bytes
* <li>Hash function: SHA512
* <li>Prefix type: {@link KeyTemplate.OutputPrefixType#TINK}
* </ul>
*
* @deprecated use {@code KeyTemplates.get("HMAC_SHA512_256BITTAG")}
*/
@Deprecated
public static final KeyTemplate hmacSha512HalfDigestTemplate() {
return createTemplate(64, 32, HashType.SHA512);
}
/**
* @return A {@link KeyTemplate} that generates new instances of HMAC keys with the following
* parameters:
* <ul>
* <li>Key size: 64 bytes
* <li>Tag size: 64 bytes
* <li>Hash function: SHA512
* <li>Prefix type: {@link KeyTemplate.OutputPrefixType#TINK}
* </ul>
*
* @deprecated use {@code KeyTemplates.get("HMAC_SHA512_512BITTAG")}
*/
@Deprecated
public static final KeyTemplate hmacSha512Template() {
return createTemplate(64, 64, HashType.SHA512);
}
/**
* @return a {@link KeyTemplate} containing a {@link HmacKeyFormat} with some specified
* parameters.
*/
private static KeyTemplate createTemplate(int keySize, int tagSize, HashType hashType) {
HmacParams params = HmacParams.newBuilder().setHash(hashType).setTagSize(tagSize).build();
HmacKeyFormat format = HmacKeyFormat.newBuilder().setParams(params).setKeySize(keySize).build();
return KeyTemplate.create(
new HmacKeyManager().getKeyType(), format.toByteArray(), KeyTemplate.OutputPrefixType.TINK);
}
private static KeyFactory.KeyFormat<HmacKeyFormat> createKeyFormat(
int keySize, int tagSize, HashType hashType, KeyTemplate.OutputPrefixType prefixType) {
return new KeyFactory.KeyFormat<>(
HmacKeyFormat.newBuilder()
.setParams(HmacParams.newBuilder().setHash(hashType).setTagSize(tagSize).build())
.setKeySize(keySize)
.build(),
prefixType);
}
}