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 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551
|
// 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 ecdsa
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"
commonpb "github.com/tink-crypto/tink-go/v2/proto/common_go_proto"
ecdsapb "github.com/tink-crypto/tink-go/v2/proto/ecdsa_go_proto"
tinkpb "github.com/tink-crypto/tink-go/v2/proto/tink_go_proto"
)
// padBigIntBytesToFixedSizeBuffer pads the given big integer bytes to the given size.
func padBigIntBytesToFixedSizeBuffer(bigIntBytes []byte, size int) ([]byte, error) {
if len(bigIntBytes) > size {
return nil, fmt.Errorf("big int has invali size: %d, want at most %d", len(bigIntBytes), size)
}
if len(bigIntBytes) == size {
return bigIntBytes, nil
}
buf := make([]byte, size-len(bigIntBytes), size)
return append(buf, bigIntBytes...), nil
}
type publicKeySerializer struct{}
func protoOutputPrefixTypeFromVariant(variant Variant) (tinkpb.OutputPrefixType, error) {
switch variant {
case VariantTink:
return tinkpb.OutputPrefixType_TINK, nil
case VariantLegacy:
return tinkpb.OutputPrefixType_LEGACY, 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 protoCurveFromCurveType(curveType CurveType) (commonpb.EllipticCurveType, error) {
switch curveType {
case NistP256:
return commonpb.EllipticCurveType_NIST_P256, nil
case NistP384:
return commonpb.EllipticCurveType_NIST_P384, nil
case NistP521:
return commonpb.EllipticCurveType_NIST_P521, nil
default:
return commonpb.EllipticCurveType_UNKNOWN_CURVE, fmt.Errorf("unknown curve type: %v", curveType)
}
}
func protoHashTypeFromHashType(hashType HashType) (commonpb.HashType, error) {
switch hashType {
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", hashType)
}
}
func protoEcdsaSignatureEncodingFromSignatureEncoding(encoding SignatureEncoding) (ecdsapb.EcdsaSignatureEncoding, error) {
switch encoding {
case DER:
return ecdsapb.EcdsaSignatureEncoding_DER, nil
case IEEEP1363:
return ecdsapb.EcdsaSignatureEncoding_IEEE_P1363, nil
default:
return ecdsapb.EcdsaSignatureEncoding_UNKNOWN_ENCODING, fmt.Errorf("unknown hash type: %v", encoding)
}
}
func createProtoECDSAParams(p *Parameters) (*ecdsapb.EcdsaParams, error) {
curve, err := protoCurveFromCurveType(p.CurveType())
if err != nil {
return nil, err
}
hash, err := protoHashTypeFromHashType(p.HashType())
if err != nil {
return nil, err
}
encoding, err := protoEcdsaSignatureEncodingFromSignatureEncoding(p.SignatureEncoding())
if err != nil {
return nil, err
}
return &ecdsapb.EcdsaParams{
Curve: curve,
HashType: hash,
Encoding: encoding,
}, nil
}
// validateEncodingAndGetCoordinates validates the encoding of a public point
// and returns the x and y coordinates. Encoding must be as per [SEC 1 v2.0,
// Section 2.3.3]. This function adds an extra leading 0x00 byte to the
// coordinates for compatibility with other Tink implementations (see
// b/264525021).
//
// [SEC 1 v2.0, Section 2.3.3]: https://www.secg.org/sec1-v2.pdf#page=17.08
func validateEncodingAndGetCoordinates(publicPoint []byte, curveType CurveType) ([]byte, []byte, error) {
coordinateSize, err := coordinateSizeForCurve(curveType)
if err != nil {
return nil, nil, err
}
if len(publicPoint) != 2*coordinateSize+1 {
return nil, nil, fmt.Errorf("public key point has invalid coordinate size: got %v, want %v", len(publicPoint), 2*coordinateSize+1)
}
if publicPoint[0] != 0x04 {
return nil, nil, fmt.Errorf("public key has invalid 1st byte: got %x, want %x", publicPoint[0], 0x04)
}
xy := publicPoint[1:]
x, err := padBigIntBytesToFixedSizeBuffer(xy[:coordinateSize], coordinateSize+1)
if err != nil {
return nil, nil, err
}
y, err := padBigIntBytesToFixedSizeBuffer(xy[coordinateSize:], coordinateSize+1)
if err != nil {
return nil, nil, err
}
return x, y, nil
}
func createProtoECDSAPublicKey(k *PublicKey, p *Parameters) (*ecdsapb.EcdsaPublicKey, error) {
protoECDSAParams, err := createProtoECDSAParams(p)
if err != nil {
return nil, err
}
x, y, err := validateEncodingAndGetCoordinates(k.PublicPoint(), p.CurveType())
if err != nil {
return nil, err
}
return &ecdsapb.EcdsaPublicKey{
Version: verifierKeyVersion,
Params: protoECDSAParams,
X: x,
Y: y,
}, nil
}
func (s *publicKeySerializer) SerializeKey(key key.Key) (*protoserialization.KeySerialization, error) {
ecdsaPublicKey, ok := key.(*PublicKey)
if !ok {
return nil, fmt.Errorf("key is not an ecdsa.PublicKey object")
}
ecdsaParameters, ok := ecdsaPublicKey.Parameters().(*Parameters)
if !ok {
return nil, fmt.Errorf("ecdsaPublicKey.Parameters() is not *ecdsa.Parameters")
}
// This is nil if PublicKey was created as a struct literal.
if ecdsaParameters == nil {
return nil, fmt.Errorf("ecdsaParameters is nil")
}
outputPrefixType, err := protoOutputPrefixTypeFromVariant(ecdsaParameters.Variant())
if err != nil {
return nil, err
}
protoECDSAKey, err := createProtoECDSAPublicKey(ecdsaPublicKey, ecdsaParameters)
if err != nil {
return nil, err
}
protoECDSAKeyBytes, err := proto.Marshal(protoECDSAKey)
if err != nil {
return nil, err
}
// idRequirement is zero if the key doesn't have a key requirement.
idRequirement, _ := ecdsaPublicKey.IDRequirement()
keyData := &tinkpb.KeyData{
TypeUrl: verifierTypeURL,
Value: protoECDSAKeyBytes,
KeyMaterialType: tinkpb.KeyData_ASYMMETRIC_PUBLIC,
}
return protoserialization.NewKeySerialization(keyData, outputPrefixType, idRequirement)
}
type publicKeyParser struct{}
func variantFromProto(outputPrefixType tinkpb.OutputPrefixType) (Variant, error) {
switch outputPrefixType {
case tinkpb.OutputPrefixType_TINK:
return VariantTink, nil
case tinkpb.OutputPrefixType_LEGACY:
return VariantLegacy, nil
case tinkpb.OutputPrefixType_CRUNCHY:
return VariantCrunchy, nil
case tinkpb.OutputPrefixType_RAW:
return VariantNoPrefix, nil
default:
return VariantUnknown, fmt.Errorf("unknown output prefix: %v", outputPrefixType)
}
}
func curveTypeFromProto(curveType commonpb.EllipticCurveType) (CurveType, error) {
switch curveType {
case commonpb.EllipticCurveType_NIST_P256:
return NistP256, nil
case commonpb.EllipticCurveType_NIST_P384:
return NistP384, nil
case commonpb.EllipticCurveType_NIST_P521:
return NistP521, nil
default:
return UnknownCurveType, fmt.Errorf("unknown curve type: %v", curveType)
}
}
func hashTypeFromProto(hashType commonpb.HashType) (HashType, error) {
switch hashType {
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", hashType)
}
}
func signatureEncodingFromProto(encoding ecdsapb.EcdsaSignatureEncoding) (SignatureEncoding, error) {
switch encoding {
case ecdsapb.EcdsaSignatureEncoding_DER:
return DER, nil
case ecdsapb.EcdsaSignatureEncoding_IEEE_P1363:
return IEEEP1363, nil
default:
return UnknownSignatureEncoding, fmt.Errorf("unknown signature encoding: %v", encoding)
}
}
func coordinateSizeForCurve(curveType CurveType) (int, error) {
switch curveType {
case NistP256:
return 32, nil
case NistP384:
return 48, nil
case NistP521:
return 66, nil
default:
return 0, fmt.Errorf("unsupported curve: %v", curveType)
}
}
// encodePoint encodes a public point in uncompressed format as per [SEC 1
// v2.0, Section 2.3.3].
//
// The encoding is of the form "0x04 || x || y", where x and y are the byte
// representations of the coordinates of the public point.
// The byte representation of the public point coordinates may be smaller
// than the curve size, in which case we have to pad them with a prefix of
// zeros.
//
// [SEC 1 v2.0, Section 2.3.3]: https://www.secg.org/sec1-v2.pdf#page=17.08
func encodePoint(x, y []byte, coordinateSize int) []byte {
encodedPoint := make([]byte, 1+2*coordinateSize)
encodedPoint[0] = 0x04
xStartPos := 1 + coordinateSize - len(x)
copy(encodedPoint[xStartPos:], x)
yStartPos := 1 + coordinateSize + coordinateSize - len(y)
copy(encodedPoint[yStartPos:], y)
return encodedPoint
}
// removeLeftPaddingFromBigInt removes the leading zeros from the
// given big integer representation.
//
// If bigIntValue is smaller than the given size, it is returned as is.
// If the bytes representation of the big integer is longer than size, an error
// is returned.
func removeLeftPaddingFromBigInt(bigIntValue []byte, size int) ([]byte, error) {
if len(bigIntValue) <= size {
return bigIntValue, nil
}
// Remove the leading len(bigIntValue)-size bytes. Fail if any is not zero.
for i := 0; i < len(bigIntValue)-size; i++ {
if bigIntValue[i] != 0 {
return nil, fmt.Errorf("big int has invalid size: %v, want %v", len(bigIntValue)-i, size)
}
}
return bigIntValue[len(bigIntValue)-size:], nil
}
func parseParameters(protoParameters *ecdsapb.EcdsaParams, outputPrefixType tinkpb.OutputPrefixType) (*Parameters, error) {
curveType, err := curveTypeFromProto(protoParameters.GetCurve())
if err != nil {
return nil, err
}
hashType, err := hashTypeFromProto(protoParameters.GetHashType())
if err != nil {
return nil, err
}
signatureEncoding, err := signatureEncodingFromProto(protoParameters.GetEncoding())
if err != nil {
return nil, err
}
variant, err := variantFromProto(outputPrefixType)
if err != nil {
return nil, err
}
return NewParameters(curveType, hashType, signatureEncoding, variant)
}
func newPublicKeyFromProto(protoECDSAKey *ecdsapb.EcdsaPublicKey, outputPrefixType tinkpb.OutputPrefixType, keyID uint32) (*PublicKey, error) {
if protoECDSAKey.GetVersion() > verifierKeyVersion {
return nil, fmt.Errorf("public key has unsupported version: %v", protoECDSAKey.GetVersion())
}
params, err := parseParameters(protoECDSAKey.GetParams(), outputPrefixType)
if err != nil {
return nil, err
}
curveType, err := curveTypeFromProto(protoECDSAKey.GetParams().GetCurve())
if err != nil {
return nil, err
}
coordinateSize, err := coordinateSizeForCurve(curveType)
if err != nil {
return nil, err
}
// Tolerate arbitrary leading zeros in the coordinates.
// This is to support the case where the curve size in bytes + 1 is the
// length of the coordinate. This happens when Tink adds an extra leading
// 0x00 byte (see b/264525021).
x, err := removeLeftPaddingFromBigInt(protoECDSAKey.GetX(), coordinateSize)
if err != nil {
return nil, err
}
y, err := removeLeftPaddingFromBigInt(protoECDSAKey.GetY(), coordinateSize)
if err != nil {
return nil, err
}
publicPoint := encodePoint(x, y, coordinateSize)
return NewPublicKey(publicPoint, keyID, params)
}
func (s *publicKeyParser) ParseKey(keySerialization *protoserialization.KeySerialization) (key.Key, error) {
if keySerialization == nil {
return nil, fmt.Errorf("key serialization is nil")
}
keyData := keySerialization.KeyData()
if keyData.GetTypeUrl() != verifierTypeURL {
return nil, fmt.Errorf("invalid key type URL: %v", keyData.GetTypeUrl())
}
if keyData.GetKeyMaterialType() != tinkpb.KeyData_ASYMMETRIC_PUBLIC {
return nil, fmt.Errorf("invalid key material type: %v", keyData.GetKeyMaterialType())
}
protoECDSAKey := new(ecdsapb.EcdsaPublicKey)
if err := proto.Unmarshal(keyData.GetValue(), protoECDSAKey); err != nil {
return nil, err
}
// keySerialization.IDRequirement() returns zero if the key doesn't have a key requirement.
keyID, _ := keySerialization.IDRequirement()
return newPublicKeyFromProto(protoECDSAKey, keySerialization.OutputPrefixType(), keyID)
}
type privateKeySerializer struct{}
var _ protoserialization.KeySerializer = (*privateKeySerializer)(nil)
func (s *privateKeySerializer) SerializeKey(key key.Key) (*protoserialization.KeySerialization, error) {
ecdsaPrivKey, ok := key.(*PrivateKey)
if !ok {
return nil, fmt.Errorf("invalid key type: %T, want *ecdsa.PrivateKey", key)
}
// This is nil if PrivateKey was created as a struct literal.
if ecdsaPrivKey.publicKey == nil {
return nil, fmt.Errorf("invalid key: public key is nil")
}
params := ecdsaPrivKey.publicKey.parameters
outputPrefixType, err := protoOutputPrefixTypeFromVariant(params.Variant())
if err != nil {
return nil, err
}
protoPublicKey, err := createProtoECDSAPublicKey(ecdsaPrivKey.publicKey, params)
if err != nil {
return nil, err
}
coordinateSize, err := coordinateSizeForCurve(params.CurveType())
if err != nil {
return nil, err
}
// Key value must be fixed size: 1 + coordinateSize (see b/264525021).
privateKeyValue := ecdsaPrivKey.PrivateKeyValue().Data(insecuresecretdataaccess.Token{})
privateKeyValue, err = padBigIntBytesToFixedSizeBuffer(privateKeyValue, coordinateSize+1)
if err != nil {
return nil, err
}
protoKey := &ecdsapb.EcdsaPrivateKey{
KeyValue: privateKeyValue,
PublicKey: protoPublicKey,
Version: signerKeyVersion,
}
serializedKey, err := proto.Marshal(protoKey)
if err != nil {
return nil, err
}
// idRequirement is zero if the key doesn't have a key requirement.
idRequirement, _ := ecdsaPrivKey.IDRequirement()
keyData := &tinkpb.KeyData{
TypeUrl: signerTypeURL,
Value: serializedKey,
KeyMaterialType: tinkpb.KeyData_ASYMMETRIC_PRIVATE,
}
return protoserialization.NewKeySerialization(keyData, outputPrefixType, idRequirement)
}
type privateKeyParser struct{}
var _ protoserialization.KeyParser = (*privateKeyParser)(nil)
func privateKeyValue(curveType CurveType, keyBytes []byte) (secretdata.Bytes, error) {
// The private key value may be padded with leading zeros (see b/264525021).
// We simply make sure the private key value is of the correct size.
coordinateSize, err := coordinateSizeForCurve(curveType)
if err != nil {
return secretdata.Bytes{}, err
}
var privateKeyBytes []byte
if coordinateSize > len(keyBytes) {
// Pad with zeros until coordinateSize.
privateKeyBytes, err = padBigIntBytesToFixedSizeBuffer(keyBytes, coordinateSize)
if err != nil {
return secretdata.Bytes{}, err
}
} else {
// Remove leading zeros, if any. Fail if the value is larger than
// coordinateSize.
privateKeyBytes, err = removeLeftPaddingFromBigInt(keyBytes, coordinateSize)
if err != nil {
return secretdata.Bytes{}, err
}
}
return secretdata.NewBytesFromData(privateKeyBytes, insecuresecretdataaccess.Token{}), nil
}
func (s *privateKeyParser) ParseKey(keySerialization *protoserialization.KeySerialization) (key.Key, error) {
if keySerialization == nil {
return nil, fmt.Errorf("key serialization is nil")
}
keyData := keySerialization.KeyData()
if keyData.GetTypeUrl() != signerTypeURL {
return nil, fmt.Errorf("invalid key type URL: %v", keyData.GetTypeUrl())
}
if keyData.GetKeyMaterialType() != tinkpb.KeyData_ASYMMETRIC_PRIVATE {
return nil, fmt.Errorf("invalid key material type: %v", keyData.GetKeyMaterialType())
}
protoKey := new(ecdsapb.EcdsaPrivateKey)
if err := proto.Unmarshal(keyData.GetValue(), protoKey); err != nil {
return nil, err
}
if protoKey.GetVersion() != signerKeyVersion {
return nil, fmt.Errorf("private key has unsupported version: %v", protoKey.GetVersion())
}
// keySerialization.IDRequirement() returns zero if the key doesn't have a key requirement.
keyID, _ := keySerialization.IDRequirement()
// Get the inner public key.
publicKey, err := newPublicKeyFromProto(protoKey.GetPublicKey(), keySerialization.OutputPrefixType(), keyID)
if err != nil {
return nil, err
}
privateKeyValue, err := privateKeyValue(publicKey.parameters.CurveType(), protoKey.GetKeyValue())
if err != nil {
return nil, err
}
return NewPrivateKeyFromPublicKey(publicKey, privateKeyValue)
}
type parametersSerializer struct{}
var _ protoserialization.ParametersSerializer = (*parametersSerializer)(nil)
func (s *parametersSerializer) Serialize(parameters key.Parameters) (*tinkpb.KeyTemplate, error) {
ecdsaParameters, ok := parameters.(*Parameters)
if !ok {
return nil, fmt.Errorf("invalid parameters type: got %T, want *ecdsa.Parameters", parameters)
}
outputPrefixType, err := protoOutputPrefixTypeFromVariant(ecdsaParameters.Variant())
if err != nil {
return nil, err
}
protoECDSAParams, err := createProtoECDSAParams(ecdsaParameters)
if err != nil {
return nil, err
}
format := &ecdsapb.EcdsaKeyFormat{
Params: protoECDSAParams,
}
serializedFormat, err := proto.Marshal(format)
if err != nil {
return nil, err
}
return &tinkpb.KeyTemplate{
TypeUrl: signerTypeURL,
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() != signerTypeURL {
return nil, fmt.Errorf("invalid type URL: got %q, want %q", keyTemplate.GetTypeUrl(), signerTypeURL)
}
format := new(ecdsapb.EcdsaKeyFormat)
if err := proto.Unmarshal(keyTemplate.GetValue(), format); err != nil {
return nil, err
}
return parseParameters(format.GetParams(), keyTemplate.GetOutputPrefixType())
}
|