xref: /aosp_15_r20/external/tink/go/aead/subtle/aes_gcm.go (revision e7b1675dde1b92d52ec075b0a92829627f2c52a5)
1*e7b1675dSTing-Kang Chang// Copyright 2020 Google LLC
2*e7b1675dSTing-Kang Chang//
3*e7b1675dSTing-Kang Chang// Licensed under the Apache License, Version 2.0 (the "License");
4*e7b1675dSTing-Kang Chang// you may not use this file except in compliance with the License.
5*e7b1675dSTing-Kang Chang// You may obtain a copy of the License at
6*e7b1675dSTing-Kang Chang//
7*e7b1675dSTing-Kang Chang//      http://www.apache.org/licenses/LICENSE-2.0
8*e7b1675dSTing-Kang Chang//
9*e7b1675dSTing-Kang Chang// Unless required by applicable law or agreed to in writing, software
10*e7b1675dSTing-Kang Chang// distributed under the License is distributed on an "AS IS" BASIS,
11*e7b1675dSTing-Kang Chang// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12*e7b1675dSTing-Kang Chang// See the License for the specific language governing permissions and
13*e7b1675dSTing-Kang Chang// limitations under the License.
14*e7b1675dSTing-Kang Chang//
15*e7b1675dSTing-Kang Chang////////////////////////////////////////////////////////////////////////////////
16*e7b1675dSTing-Kang Chang
17*e7b1675dSTing-Kang Changpackage subtle
18*e7b1675dSTing-Kang Chang
19*e7b1675dSTing-Kang Changimport (
20*e7b1675dSTing-Kang Chang	"fmt"
21*e7b1675dSTing-Kang Chang
22*e7b1675dSTing-Kang Chang	internalaead "github.com/google/tink/go/internal/aead"
23*e7b1675dSTing-Kang Chang	"github.com/google/tink/go/subtle/random"
24*e7b1675dSTing-Kang Chang	"github.com/google/tink/go/tink"
25*e7b1675dSTing-Kang Chang)
26*e7b1675dSTing-Kang Chang
27*e7b1675dSTing-Kang Changconst (
28*e7b1675dSTing-Kang Chang	// AESGCMIVSize is the acceptable IV size defined by RFC 5116.
29*e7b1675dSTing-Kang Chang	AESGCMIVSize = 12
30*e7b1675dSTing-Kang Chang	// AESGCMTagSize is the acceptable tag size defined by RFC 5116.
31*e7b1675dSTing-Kang Chang	AESGCMTagSize = 16
32*e7b1675dSTing-Kang Chang)
33*e7b1675dSTing-Kang Chang
34*e7b1675dSTing-Kang Chang// AESGCM is an implementation of AEAD interface.
35*e7b1675dSTing-Kang Changtype AESGCM struct {
36*e7b1675dSTing-Kang Chang	aesGCMInsecureIV *internalaead.AESGCMInsecureIV
37*e7b1675dSTing-Kang Chang}
38*e7b1675dSTing-Kang Chang
39*e7b1675dSTing-Kang Chang// Assert that AESGCM implements the AEAD interface.
40*e7b1675dSTing-Kang Changvar _ tink.AEAD = (*AESGCM)(nil)
41*e7b1675dSTing-Kang Chang
42*e7b1675dSTing-Kang Chang// NewAESGCM returns an AESGCM instance, where key is the AES key with length
43*e7b1675dSTing-Kang Chang// 16 bytes (AES-128) or 32 bytes (AES-256).
44*e7b1675dSTing-Kang Changfunc NewAESGCM(key []byte) (*AESGCM, error) {
45*e7b1675dSTing-Kang Chang	aesGCMInsecureIV, err := internalaead.NewAESGCMInsecureIV(key, true /*=prependIV*/)
46*e7b1675dSTing-Kang Chang	return &AESGCM{aesGCMInsecureIV}, err
47*e7b1675dSTing-Kang Chang}
48*e7b1675dSTing-Kang Chang
49*e7b1675dSTing-Kang Chang// Encrypt encrypts plaintext with associatedData. The returned ciphertext
50*e7b1675dSTing-Kang Chang// contains both the IV used for encryption and the actual ciphertext.
51*e7b1675dSTing-Kang Chang//
52*e7b1675dSTing-Kang Chang// Note: The crypto library's AES-GCM implementation always returns the
53*e7b1675dSTing-Kang Chang// ciphertext with an AESGCMTagSize (16-byte) tag.
54*e7b1675dSTing-Kang Changfunc (a *AESGCM) Encrypt(plaintext, associatedData []byte) ([]byte, error) {
55*e7b1675dSTing-Kang Chang	iv := random.GetRandomBytes(AESGCMIVSize)
56*e7b1675dSTing-Kang Chang	return a.aesGCMInsecureIV.Encrypt(iv, plaintext, associatedData)
57*e7b1675dSTing-Kang Chang}
58*e7b1675dSTing-Kang Chang
59*e7b1675dSTing-Kang Chang// Decrypt decrypts ciphertext with associatedData.
60*e7b1675dSTing-Kang Changfunc (a *AESGCM) Decrypt(ciphertext, associatedData []byte) ([]byte, error) {
61*e7b1675dSTing-Kang Chang	if len(ciphertext) < AESGCMIVSize {
62*e7b1675dSTing-Kang Chang		return nil, fmt.Errorf("ciphertext with size %d is too short", len(ciphertext))
63*e7b1675dSTing-Kang Chang	}
64*e7b1675dSTing-Kang Chang	iv := ciphertext[:AESGCMIVSize]
65*e7b1675dSTing-Kang Chang	return a.aesGCMInsecureIV.Decrypt(iv, ciphertext, associatedData)
66*e7b1675dSTing-Kang Chang}
67*e7b1675dSTing-Kang Chang
68*e7b1675dSTing-Kang Chang// Key returns the AES key.
69*e7b1675dSTing-Kang Changfunc (a *AESGCM) Key() []byte {
70*e7b1675dSTing-Kang Chang	return a.aesGCMInsecureIV.Key
71*e7b1675dSTing-Kang Chang}
72