1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284
|
// Copyright 2024 Google LLC
//
// 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 aesctrhmac
import (
"fmt"
"google.golang.org/protobuf/proto"
"github.com/tink-crypto/tink-go/v2/insecuresecretdataaccess"
"github.com/tink-crypto/tink-go/v2/internal/protoserialization"
"github.com/tink-crypto/tink-go/v2/key"
"github.com/tink-crypto/tink-go/v2/secretdata"
aesctrpb "github.com/tink-crypto/tink-go/v2/proto/aes_ctr_go_proto"
aesctrhmacpb "github.com/tink-crypto/tink-go/v2/proto/aes_ctr_hmac_aead_go_proto"
commonpb "github.com/tink-crypto/tink-go/v2/proto/common_go_proto"
hmacpb "github.com/tink-crypto/tink-go/v2/proto/hmac_go_proto"
tinkpb "github.com/tink-crypto/tink-go/v2/proto/tink_go_proto"
)
type keySerializer struct{}
var _ protoserialization.KeySerializer = (*keySerializer)(nil)
func protoOutputPrefixTypeFromVariant(variant Variant) (tinkpb.OutputPrefixType, error) {
switch variant {
case VariantTink:
return tinkpb.OutputPrefixType_TINK, nil
case VariantCrunchy:
return tinkpb.OutputPrefixType_CRUNCHY, nil
case VariantNoPrefix:
return tinkpb.OutputPrefixType_RAW, nil
default:
return tinkpb.OutputPrefixType_UNKNOWN_PREFIX, fmt.Errorf("unknown output prefix variant: %v", variant)
}
}
func hashTypeToProto(ht HashType) (commonpb.HashType, error) {
switch ht {
case SHA1:
return commonpb.HashType_SHA1, nil
case SHA224:
return commonpb.HashType_SHA224, nil
case SHA256:
return commonpb.HashType_SHA256, nil
case SHA384:
return commonpb.HashType_SHA384, nil
case SHA512:
return commonpb.HashType_SHA512, nil
default:
return commonpb.HashType_UNKNOWN_HASH, fmt.Errorf("unknown hash type: %v", ht)
}
}
func (s *keySerializer) SerializeKey(key key.Key) (*protoserialization.KeySerialization, error) {
actualKey, ok := key.(*Key)
if !ok {
return nil, fmt.Errorf("key is not a Key")
}
actualParameters, ok := actualKey.Parameters().(*Parameters)
if !ok {
return nil, fmt.Errorf("key parameters is not a Parameters")
}
outputPrefixType, err := protoOutputPrefixTypeFromVariant(actualParameters.Variant())
if err != nil {
return nil, err
}
hash, err := hashTypeToProto(actualParameters.HashType())
if err != nil {
return nil, err
}
protoKey := &aesctrhmacpb.AesCtrHmacAeadKey{
AesCtrKey: &aesctrpb.AesCtrKey{
Version: 0,
Params: &aesctrpb.AesCtrParams{
IvSize: uint32(actualParameters.IVSizeInBytes()),
},
KeyValue: actualKey.AESKeyBytes().Data(insecuresecretdataaccess.Token{}),
},
HmacKey: &hmacpb.HmacKey{
Version: 0,
Params: &hmacpb.HmacParams{
Hash: hash,
TagSize: uint32(actualParameters.TagSizeInBytes()),
},
KeyValue: actualKey.HMACKeyBytes().Data(insecuresecretdataaccess.Token{}),
},
Version: 0,
}
serializedKey, err := proto.Marshal(protoKey)
if err != nil {
return nil, err
}
// idRequirement is zero if the key doesn't have a key requirement.
idRequirement, _ := actualKey.IDRequirement()
keyData := &tinkpb.KeyData{
TypeUrl: typeURL,
Value: serializedKey,
KeyMaterialType: tinkpb.KeyData_SYMMETRIC,
}
return protoserialization.NewKeySerialization(keyData, outputPrefixType, idRequirement)
}
type keyParser struct{}
var _ protoserialization.KeyParser = (*keyParser)(nil)
func variantFromProto(prefixType tinkpb.OutputPrefixType) (Variant, error) {
switch prefixType {
case tinkpb.OutputPrefixType_TINK:
return VariantTink, nil
case tinkpb.OutputPrefixType_CRUNCHY, tinkpb.OutputPrefixType_LEGACY:
return VariantCrunchy, nil
case tinkpb.OutputPrefixType_RAW:
return VariantNoPrefix, nil
default:
return VariantUnknown, fmt.Errorf("unsupported output prefix type: %v", prefixType)
}
}
func hashTypeFromProto(ht commonpb.HashType) (HashType, error) {
switch ht {
case commonpb.HashType_SHA1:
return SHA1, nil
case commonpb.HashType_SHA224:
return SHA224, nil
case commonpb.HashType_SHA256:
return SHA256, nil
case commonpb.HashType_SHA384:
return SHA384, nil
case commonpb.HashType_SHA512:
return SHA512, nil
default:
return UnknownHashType, fmt.Errorf("unknown hash type: %v", ht)
}
}
func (s *keyParser) ParseKey(keySerialization *protoserialization.KeySerialization) (key.Key, error) {
if keySerialization == nil {
return nil, fmt.Errorf("key serialization is nil")
}
keyData := keySerialization.KeyData()
if keyData.GetTypeUrl() != typeURL {
return nil, fmt.Errorf("invalid type URL: got %q, want %q", keyData.GetTypeUrl(), typeURL)
}
if keyData.GetKeyMaterialType() != tinkpb.KeyData_SYMMETRIC {
return nil, fmt.Errorf("key is not a SYMMETRIC key")
}
protoKey := new(aesctrhmacpb.AesCtrHmacAeadKey)
if err := proto.Unmarshal(keyData.GetValue(), protoKey); err != nil {
return nil, err
}
if protoKey.GetVersion() != 0 {
return nil, fmt.Errorf("unsupported aesctrhmacpb.AesCtrHmacAeadKey version: got %q, want %q", protoKey.GetVersion(), 0)
}
if protoKey.GetAesCtrKey().GetVersion() != 0 {
return nil, fmt.Errorf("unsupported aesctrpb.AesCtrKey version: got %q, want %q", protoKey.GetAesCtrKey().GetVersion(), 0)
}
if protoKey.GetHmacKey().GetVersion() != 0 {
return nil, fmt.Errorf("unsupported hmacpb.HmacKey version: got %q, want %q", protoKey.GetHmacKey().GetVersion(), 0)
}
variant, err := variantFromProto(keySerialization.OutputPrefixType())
if err != nil {
return nil, err
}
aesKeySizeInBytes := len(protoKey.GetAesCtrKey().GetKeyValue())
hmacKeySizeInBytes := len(protoKey.GetHmacKey().GetKeyValue())
hashType, err := hashTypeFromProto(protoKey.GetHmacKey().GetParams().GetHash())
if err != nil {
return nil, err
}
params, err := NewParameters(ParametersOpts{
AESKeySizeInBytes: aesKeySizeInBytes,
HMACKeySizeInBytes: hmacKeySizeInBytes,
IVSizeInBytes: int(protoKey.GetAesCtrKey().GetParams().GetIvSize()),
TagSizeInBytes: int(protoKey.GetHmacKey().GetParams().GetTagSize()),
HashType: hashType,
Variant: variant,
})
if err != nil {
return nil, err
}
aesKeyMaterial := secretdata.NewBytesFromData(protoKey.GetAesCtrKey().GetKeyValue(), insecuresecretdataaccess.Token{})
hmacKeyMaterial := secretdata.NewBytesFromData(protoKey.GetHmacKey().GetKeyValue(), insecuresecretdataaccess.Token{})
// keySerialization.IDRequirement() returns zero if the key doesn't have a
// key requirement.
keyID, _ := keySerialization.IDRequirement()
return NewKey(KeyOpts{
AESKeyBytes: aesKeyMaterial,
HMACKeyBytes: hmacKeyMaterial,
IDRequirement: keyID,
Parameters: params})
}
type parametersSerializer struct{}
var _ protoserialization.ParametersSerializer = (*parametersSerializer)(nil)
func (s *parametersSerializer) Serialize(parameters key.Parameters) (*tinkpb.KeyTemplate, error) {
actualParameters, ok := parameters.(*Parameters)
if !ok {
return nil, fmt.Errorf("invalid parameters type: got %T, want *aesctrhmac.Parameters", parameters)
}
outputPrefixType, err := protoOutputPrefixTypeFromVariant(actualParameters.Variant())
if err != nil {
return nil, err
}
hashType, err := hashTypeToProto(actualParameters.HashType())
if err != nil {
return nil, err
}
format := &aesctrhmacpb.AesCtrHmacAeadKeyFormat{
AesCtrKeyFormat: &aesctrpb.AesCtrKeyFormat{
KeySize: uint32(actualParameters.AESKeySizeInBytes()),
Params: &aesctrpb.AesCtrParams{
IvSize: uint32(actualParameters.IVSizeInBytes()),
},
},
HmacKeyFormat: &hmacpb.HmacKeyFormat{
KeySize: uint32(actualParameters.HMACKeySizeInBytes()),
Params: &hmacpb.HmacParams{
Hash: hashType,
TagSize: uint32(actualParameters.TagSizeInBytes()),
},
Version: 0,
},
}
serializedFormat, err := proto.Marshal(format)
if err != nil {
return nil, err
}
return &tinkpb.KeyTemplate{
TypeUrl: typeURL,
OutputPrefixType: outputPrefixType,
Value: serializedFormat,
}, nil
}
type parametersParser struct{}
var _ protoserialization.ParametersParser = (*parametersParser)(nil)
func (s *parametersParser) Parse(keyTemplate *tinkpb.KeyTemplate) (key.Parameters, error) {
if keyTemplate.GetTypeUrl() != typeURL {
return nil, fmt.Errorf("invalid type URL: got %q, want %q", keyTemplate.GetTypeUrl(), typeURL)
}
format := new(aesctrhmacpb.AesCtrHmacAeadKeyFormat)
if err := proto.Unmarshal(keyTemplate.GetValue(), format); err != nil {
return nil, err
}
if format.GetHmacKeyFormat().GetVersion() != 0 {
return nil, fmt.Errorf("unsupported hmacpb.HmacKeyFormat version: got %q, want %q", format.GetHmacKeyFormat().GetVersion(), 0)
}
variant, err := variantFromProto(keyTemplate.GetOutputPrefixType())
if err != nil {
return nil, err
}
hashType, err := hashTypeFromProto(format.GetHmacKeyFormat().GetParams().GetHash())
if err != nil {
return nil, err
}
return NewParameters(ParametersOpts{
AESKeySizeInBytes: int(format.GetAesCtrKeyFormat().GetKeySize()),
HMACKeySizeInBytes: int(format.GetHmacKeyFormat().GetKeySize()),
IVSizeInBytes: int(format.GetAesCtrKeyFormat().GetParams().GetIvSize()),
TagSizeInBytes: int(format.GetHmacKeyFormat().GetParams().GetTagSize()),
HashType: hashType,
Variant: variant,
})
}
|