Aead key templates for AES CTR HMAC AEAD.

PiperOrigin-RevId: 205383947

javascript/aead/aead_key_templates.js

+// 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.
+//
+////////////////////////////////////////////////////////////////////////////////
+
+goog.module('tink.aead.AeadKeyTemplates');
+
+const PbAesCtrHmacAeadKeyFormat = goog.require('proto.google.crypto.tink.AesCtrHmacAeadKeyFormat');
+const PbAesCtrKeyFormat = goog.require('proto.google.crypto.tink.AesCtrKeyFormat');
+const PbAesCtrParams = goog.require('proto.google.crypto.tink.AesCtrParams');
+const PbHashType = goog.require('proto.google.crypto.tink.HashType');
+const PbHmacKeyFormat = goog.require('proto.google.crypto.tink.HmacKeyFormat');
+const PbHmacParams = goog.require('proto.google.crypto.tink.HmacParams');
+const PbKeyTemplate = goog.require('proto.google.crypto.tink.KeyTemplate');
+const PbOutputPrefixType = goog.require('proto.google.crypto.tink.OutputPrefixType');
+
+/**
+ * Pre-generated KeyTemplates for Aead keys.
+ *
+ * One can use these templates to generate new Keyset with
+ * KeysetHandle.generateNew method. To generate a new keyset that contains a
+ * single AesCtrHmacAeadKey, one can do:
+ *
+ * AeadConfig.Register();
+ * KeysetHandle handle =
+ *     KeysetHandle.generateNew(AeadKeyTemplates.aes128CtrHmacSha256());
+ *
+ * @final
+ */
+class AeadKeyTemplates {
+  /**
+   * Returns a KeyTemplate that generates new instances of AesCtrHmacAeadKey
+   * with the following parameters:
+   *    AES key size: 16 bytes
+   *    AES IV size: 16 bytes
+   *    HMAC key size: 32 bytes
+   *    HMAC tag size: 16 bytes
+   *    HMAC hash function: SHA256
+   *    OutputPrefixType: TINK
+   *
+   * @return {!PbKeyTemplate}
+   */
+  static aes128CtrHmacSha256() {
+    return AeadKeyTemplates.newAesCtrHmacSha256KeyTemplate_(
+        /* aesKeySize = */ 16,
+        /* ivSize = */ 16,
+        /* hmacKeySize = */ 32,
+        /* tagSize = */ 16);
+  }
+
+  /**
+   * Returns a KeyTemplate that generates new instances of AesCtrHmacAeadKey
+   * with the following parameters:
+   *    AES key size: 32 bytes
+   *    AES IV size: 16 bytes
+   *    HMAC key size: 32 bytes
+   *    HMAC tag size: 32 bytes
+   *    HMAC hash function: SHA256
+   *    OutputPrefixType: TINK
+   *
+   * @return {!PbKeyTemplate}
+   */
+  static aes256CtrHmacSha256() {
+    return AeadKeyTemplates.newAesCtrHmacSha256KeyTemplate_(
+        /* aesKeySize = */ 32,
+        /* ivSize = */ 16,
+        /* hmacKeySize = */ 32,
+        /* tagSize = */ 32);
+  }
+
+  /**
+   * @private
+   *
+   * @param {number} aesKeySize
+   * @param {number} ivSize
+   * @param {number} hmacKeySize
+   * @param {number} tagSize
+   *
+   * @return {!PbKeyTemplate}
+   */
+  static newAesCtrHmacSha256KeyTemplate_(
+      aesKeySize, ivSize, hmacKeySize, tagSize) {
+    // Define AES CTR key format.
+    const aesCtrKeyFormat = new PbAesCtrKeyFormat();
+    aesCtrKeyFormat.setKeySize(aesKeySize);
+    aesCtrKeyFormat.setParams(new PbAesCtrParams());
+    aesCtrKeyFormat.getParams().setIvSize(ivSize);
+
+    // Define HMAC key format.
+    const hmacKeyFormat = new PbHmacKeyFormat();
+    hmacKeyFormat.setKeySize(hmacKeySize);
+    hmacKeyFormat.setParams(new PbHmacParams());
+    hmacKeyFormat.getParams().setTagSize(tagSize);
+    hmacKeyFormat.getParams().setHash(PbHashType.SHA256);
+
+    // Define AES CTR HMAC AEAD key format.
+    const keyFormat = new PbAesCtrHmacAeadKeyFormat();
+    keyFormat.setAesCtrKeyFormat(aesCtrKeyFormat);
+    keyFormat.setHmacKeyFormat(hmacKeyFormat);
+
+    // Define key template.
+    const keyTemplate = new PbKeyTemplate();
+    keyTemplate.setTypeUrl(AeadKeyTemplates.AES_CTR_HMAC_AEAD_KEY_TYPE_);
+    keyTemplate.setOutputPrefixType(PbOutputPrefixType.TINK);
+    keyTemplate.setValue(keyFormat.serializeBinary());
+
+    return keyTemplate;
+  }
+}
+
+/**
+ * @private @static @const {string}
+ */
+AeadKeyTemplates.AES_CTR_HMAC_AEAD_KEY_TYPE_ =
+    'type.googleapis.com/google.crypto.tink.AesCtrHmacAeadKey';
+
+exports = AeadKeyTemplates;

javascript/aead/aead_key_templates_test.js

+// 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.
+//
+////////////////////////////////////////////////////////////////////////////////
+
+goog.module('tink.aead.AeadKeyTemplatesTest');
+goog.setTestOnly('tink.aead.AeadKeyTemplatesTest');
+
+const AeadKeyTemplates = goog.require('tink.aead.AeadKeyTemplates');
+const AesCtrHmacAeadKeyManager = goog.require('tink.aead.AesCtrHmacAeadKeyManager');
+const PbAesCtrHmacAeadKeyFormat = goog.require('proto.google.crypto.tink.AesCtrHmacAeadKeyFormat');
+const PbHashType = goog.require('proto.google.crypto.tink.HashType');
+const PbOutputPrefixType = goog.require('proto.google.crypto.tink.OutputPrefixType');
+
+
+const testSuite = goog.require('goog.testing.testSuite');
+
+testSuite({
+
+  testAes128CtrHmacSha256() {
+    // Expects function to create key with following parameters.
+    const expectedAesKeySize = 16;
+    const expectedIvSize = 16;
+    const expectedHmacKeySize = 32;
+    const expectedTagSize = 16;
+    const expectedHashFunction = PbHashType.SHA256;
+    const expectedOutputPrefix = PbOutputPrefixType.TINK;
+
+    // Expected type URL is the one supported by AesCtrHmacAeadKeyManager.
+    const manager = new AesCtrHmacAeadKeyManager();
+    const expectedTypeUrl = manager.getKeyType();
+
+    const keyTemplate = AeadKeyTemplates.aes128CtrHmacSha256();
+
+    assertEquals(expectedTypeUrl, keyTemplate.getTypeUrl());
+    assertEquals(expectedOutputPrefix, keyTemplate.getOutputPrefixType());
+
+    //Test values in key format.
+    const keyFormat = PbAesCtrHmacAeadKeyFormat.deserializeBinary(
+        keyTemplate.getValue());
+
+    // Test AesCtrKeyFormat.
+    const aesCtrKeyFormat = keyFormat.getAesCtrKeyFormat();
+    assertEquals(expectedAesKeySize, aesCtrKeyFormat.getKeySize());
+    assertEquals(expectedIvSize, aesCtrKeyFormat.getParams().getIvSize());
+
+    // Test HmacKeyFormat.
+    const hmacKeyFormat = keyFormat.getHmacKeyFormat();
+    assertEquals(expectedHmacKeySize, hmacKeyFormat.getKeySize());
+    assertEquals(expectedTagSize, hmacKeyFormat.getParams().getTagSize());
+    assertEquals(expectedHashFunction, hmacKeyFormat.getParams().getHash());
+  },
+
+  testAes256CtrHmacSha256() {
+    // Expects function to create key with following parameters.
+    const expectedAesKeySize = 32;
+    const expectedIvSize = 16;
+    const expectedHmacKeySize = 32;
+    const expectedTagSize = 32;
+    const expectedHashFunction = PbHashType.SHA256;
+    const expectedOutputPrefix = PbOutputPrefixType.TINK;
+
+    // Expected type URL is the one supported by AesCtrHmacAeadKeyManager.
+    const manager = new AesCtrHmacAeadKeyManager();
+    const expectedTypeUrl = manager.getKeyType();
+
+    const keyTemplate = AeadKeyTemplates.aes256CtrHmacSha256();
+
+    assertEquals(expectedTypeUrl, keyTemplate.getTypeUrl());
+    assertEquals(expectedOutputPrefix, keyTemplate.getOutputPrefixType());
+
+    //Test values in key format.
+    const keyFormat = PbAesCtrHmacAeadKeyFormat.deserializeBinary(
+        keyTemplate.getValue());
+
+    // Test AesCtrKeyFormat.
+    const aesCtrKeyFormat = keyFormat.getAesCtrKeyFormat();
+    assertEquals(expectedAesKeySize, aesCtrKeyFormat.getKeySize());
+    assertEquals(expectedIvSize, aesCtrKeyFormat.getParams().getIvSize());
+
+    // Test HmacKeyFormat.
+    const hmacKeyFormat = keyFormat.getHmacKeyFormat();
+    assertEquals(expectedHmacKeySize, hmacKeyFormat.getKeySize());
+    assertEquals(expectedTagSize, hmacKeyFormat.getParams().getTagSize());
+    assertEquals(expectedHashFunction, hmacKeyFormat.getParams().getHash());
+  },
+});