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
|
// 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 chacha20poly1305
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"
cppb "github.com/tink-crypto/tink-go/v2/proto/chacha20_poly1305_go_proto"
tinkpb "github.com/tink-crypto/tink-go/v2/proto/tink_go_proto"
)
const (
// protoVersion is the accepted [gcmpb.AesGcmKey] proto version.
//
// Currently, only version 0 is supported; other versions are rejected.
protoVersion = 0
)
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 (s *keySerializer) SerializeKey(key key.Key) (*protoserialization.KeySerialization, error) {
that, ok := key.(*Key)
if !ok {
return nil, fmt.Errorf("key is not a Key")
}
actualParameters, ok := that.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
}
keyBytes := that.KeyBytes()
protoKey := &cppb.ChaCha20Poly1305Key{
KeyValue: keyBytes.Data(insecuresecretdataaccess.Token{}),
Version: protoVersion,
}
serializedKey, err := proto.Marshal(protoKey)
if err != nil {
return nil, err
}
// idRequirement is zero if the key doesn't have a key requirement.
idRequirement, _ := that.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 (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("key is not a ChaCha20Poly1305 key")
}
if keyData.GetKeyMaterialType() != tinkpb.KeyData_SYMMETRIC {
return nil, fmt.Errorf("key is not a SYMMETRIC key")
}
protoKey := new(cppb.ChaCha20Poly1305Key)
if err := proto.Unmarshal(keyData.GetValue(), protoKey); err != nil {
return nil, err
}
if protoKey.GetVersion() != protoVersion {
return nil, fmt.Errorf("key has unsupported version: %v", protoKey.GetVersion())
}
variant, err := variantFromProto(keySerialization.OutputPrefixType())
if err != nil {
return nil, err
}
params, err := NewParameters(variant)
if err != nil {
return nil, err
}
keyMaterial := secretdata.NewBytesFromData(protoKey.GetKeyValue(), insecuresecretdataaccess.Token{})
// keySerialization.IDRequirement() returns zero if the key doesn't have a
// key requirement.
keyID, _ := keySerialization.IDRequirement()
return NewKey(keyMaterial, keyID, 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 *chacha20poly1305.Parameters", parameters)
}
outputPrefixType, err := protoOutputPrefixTypeFromVariant(actualParameters.Variant())
if err != nil {
return nil, err
}
format := &cppb.ChaCha20Poly1305KeyFormat{}
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(cppb.ChaCha20Poly1305KeyFormat)
if err := proto.Unmarshal(keyTemplate.GetValue(), format); err != nil {
return nil, err
}
variant, err := variantFromProto(keyTemplate.GetOutputPrefixType())
if err != nil {
return nil, err
}
return NewParameters(variant)
}
|