com.google.crypto.tink.streamingaead.AesCtrHmacStreamingKeyManager Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of tink-android Show documentation
Show all versions of tink-android Show documentation
Tink is a small cryptographic library that provides a safe, simple, agile and fast way to accomplish some common cryptographic tasks.
// 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.streamingaead;
import static com.google.crypto.tink.internal.TinkBugException.exceptionIsBug;
import com.google.crypto.tink.AccessesPartialKey;
import com.google.crypto.tink.KeyManager;
import com.google.crypto.tink.KeyTemplate;
import com.google.crypto.tink.Parameters;
import com.google.crypto.tink.StreamingAead;
import com.google.crypto.tink.config.internal.TinkFipsUtil;
import com.google.crypto.tink.internal.KeyManagerRegistry;
import com.google.crypto.tink.internal.LegacyKeyManagerImpl;
import com.google.crypto.tink.internal.MutableKeyCreationRegistry;
import com.google.crypto.tink.internal.MutableParametersRegistry;
import com.google.crypto.tink.internal.MutablePrimitiveRegistry;
import com.google.crypto.tink.internal.PrimitiveConstructor;
import com.google.crypto.tink.proto.KeyData.KeyMaterialType;
import com.google.crypto.tink.streamingaead.internal.AesCtrHmacStreamingProtoSerialization;
import com.google.crypto.tink.subtle.AesCtrHmacStreaming;
import com.google.crypto.tink.util.SecretBytes;
import java.security.GeneralSecurityException;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
import javax.annotation.Nullable;
/**
* This key manager generates new {@code AesCtrHmacStreamingKey} keys and produces new instances of
* {@code AesCtrHmacStreaming}.
*/
public final class AesCtrHmacStreamingKeyManager {
private static final PrimitiveConstructor<
com.google.crypto.tink.streamingaead.AesCtrHmacStreamingKey, StreamingAead>
AES_CTR_HMAC_STREAMING_AEAD_PRIMITIVE_CONSTRUCTOR =
PrimitiveConstructor.create(
AesCtrHmacStreaming::create,
com.google.crypto.tink.streamingaead.AesCtrHmacStreamingKey.class,
StreamingAead.class);
@SuppressWarnings("InlineLambdaConstant") // We need a correct Object#equals in registration.
private static final MutableKeyCreationRegistry.KeyCreator
KEY_CREATOR = AesCtrHmacStreamingKeyManager::createAesCtrHmacStreamingKey;
@AccessesPartialKey
private static com.google.crypto.tink.streamingaead.AesCtrHmacStreamingKey
createAesCtrHmacStreamingKey(
AesCtrHmacStreamingParameters parameters, @Nullable Integer idRequirement)
throws GeneralSecurityException {
return com.google.crypto.tink.streamingaead.AesCtrHmacStreamingKey.create(
parameters, SecretBytes.randomBytes(parameters.getKeySizeBytes()));
}
private static final KeyManager legacyKeyManager =
LegacyKeyManagerImpl.create(
getKeyType(),
StreamingAead.class,
KeyMaterialType.SYMMETRIC,
com.google.crypto.tink.proto.AesCtrHmacStreamingKey.parser());
static String getKeyType() {
return "type.googleapis.com/google.crypto.tink.AesCtrHmacStreamingKey";
}
private static Map namedParameters() throws GeneralSecurityException {
Map result = new HashMap<>();
result.put(
"AES128_CTR_HMAC_SHA256_4KB",
PredefinedStreamingAeadParameters.AES128_CTR_HMAC_SHA256_4KB);
result.put(
"AES128_CTR_HMAC_SHA256_1MB",
PredefinedStreamingAeadParameters.AES128_CTR_HMAC_SHA256_1MB);
result.put(
"AES256_CTR_HMAC_SHA256_4KB",
PredefinedStreamingAeadParameters.AES256_CTR_HMAC_SHA256_4KB);
result.put(
"AES256_CTR_HMAC_SHA256_1MB",
PredefinedStreamingAeadParameters.AES256_CTR_HMAC_SHA256_1MB);
return Collections.unmodifiableMap(result);
}
public static void register(boolean newKeyAllowed) throws GeneralSecurityException {
if (!TinkFipsUtil.AlgorithmFipsCompatibility.ALGORITHM_NOT_FIPS.isCompatible()) {
throw new GeneralSecurityException(
"Registering AES CTR HMAC Streaming AEAD is not supported in FIPS mode");
}
AesCtrHmacStreamingProtoSerialization.register();
MutableParametersRegistry.globalInstance().putAll(namedParameters());
MutableKeyCreationRegistry.globalInstance()
.add(KEY_CREATOR, AesCtrHmacStreamingParameters.class);
MutablePrimitiveRegistry.globalInstance()
.registerPrimitiveConstructor(AES_CTR_HMAC_STREAMING_AEAD_PRIMITIVE_CONSTRUCTOR);
KeyManagerRegistry.globalInstance().registerKeyManager(legacyKeyManager, newKeyAllowed);
}
/**
* @return a {@link KeyTemplate} that generates new instances of AesCtrHmacStreaming keys with the
* following parameters:
*
* - Size of the main key: 16 bytes
*
- HKDF algo: HMAC-SHA256
*
- Size of AES-CTR derived keys: 16 bytes
*
- Tag algo: HMAC-SHA256
*
- Tag size: 32 bytes
*
- Ciphertext segment size: 4096
*
*/
public static final KeyTemplate aes128CtrHmacSha2564KBTemplate() {
return exceptionIsBug(
() ->
KeyTemplate.createFrom(
AesCtrHmacStreamingParameters.builder()
.setKeySizeBytes(16)
.setDerivedKeySizeBytes(16)
.setHkdfHashType(AesCtrHmacStreamingParameters.HashType.SHA256)
.setHmacHashType(AesCtrHmacStreamingParameters.HashType.SHA256)
.setHmacTagSizeBytes(32)
.setCiphertextSegmentSizeBytes(4 * 1024)
.build()));
}
/**
* @return a {@link KeyTemplate} that generates new instances of AesCtrHmacStreaming keys with the
* following parameters:
*
* - Size of the main key: 16 bytes
*
- HKDF algo: HMAC-SHA256
*
- Size of AES-CTR derived keys: 16 bytes
*
- Tag algo: HMAC-SHA256
*
- Tag size: 32 bytes
*
- Ciphertext segment size: 1MB
*
*/
public static final KeyTemplate aes128CtrHmacSha2561MBTemplate() {
return exceptionIsBug(
() ->
KeyTemplate.createFrom(
AesCtrHmacStreamingParameters.builder()
.setKeySizeBytes(16)
.setDerivedKeySizeBytes(16)
.setHkdfHashType(AesCtrHmacStreamingParameters.HashType.SHA256)
.setHmacHashType(AesCtrHmacStreamingParameters.HashType.SHA256)
.setHmacTagSizeBytes(32)
.setCiphertextSegmentSizeBytes(1024 * 1024)
.build()));
}
/**
* @return a {@link KeyTemplate} that generates new instances of AesCtrHmacStreaming keys with the
* following parameters:
*
* - Size of the main key: 32 bytes
*
- HKDF algo: HMAC-SHA256
*
- Size of AES-CTR derived keys: 32 bytes
*
- Tag algo: HMAC-SHA256
*
- Tag size: 32 bytes
*
- Ciphertext segment size: 4096
*
*/
public static final KeyTemplate aes256CtrHmacSha2564KBTemplate() {
return exceptionIsBug(
() ->
KeyTemplate.createFrom(
AesCtrHmacStreamingParameters.builder()
.setKeySizeBytes(32)
.setDerivedKeySizeBytes(32)
.setHkdfHashType(AesCtrHmacStreamingParameters.HashType.SHA256)
.setHmacHashType(AesCtrHmacStreamingParameters.HashType.SHA256)
.setHmacTagSizeBytes(32)
.setCiphertextSegmentSizeBytes(4 * 1024)
.build()));
}
/**
* @return a {@link KeyTemplate} that generates new instances of AesCtrHmacStreaming keys with the
* following parameters:
*
* - Size of the main key: 32 bytes
*
- HKDF algo: HMAC-SHA256
*
- Size of AES-CTR derived keys: 32 bytes
*
- Tag algo: HMAC-SHA256
*
- Tag size: 32 bytes
*
- Ciphertext segment size: 1MB
*
*/
public static final KeyTemplate aes256CtrHmacSha2561MBTemplate() {
return exceptionIsBug(
() ->
KeyTemplate.createFrom(
AesCtrHmacStreamingParameters.builder()
.setKeySizeBytes(32)
.setDerivedKeySizeBytes(32)
.setHkdfHashType(AesCtrHmacStreamingParameters.HashType.SHA256)
.setHmacHashType(AesCtrHmacStreamingParameters.HashType.SHA256)
.setHmacTagSizeBytes(32)
.setCiphertextSegmentSizeBytes(1024 * 1024)
.build()));
}
private AesCtrHmacStreamingKeyManager() {}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy