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
|
// Copyright 2025 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 ecies
import (
"bytes"
"crypto/ecdh"
"fmt"
"github.com/tink-crypto/tink-go/v2/insecuresecretdataaccess"
"github.com/tink-crypto/tink-go/v2/internal/outputprefix"
"github.com/tink-crypto/tink-go/v2/key"
"github.com/tink-crypto/tink-go/v2/secretdata"
)
// PublicKey represents an ECIES public key.
type PublicKey struct {
// A public point representing the public key. This can be either:
// - Uncompressed encoded EC point as per [SEC 1 v2.0, Section 2.3.3] if Nist*.
// - An X25519 public key bytes.
publicKeyBytes []byte
idRequirement uint32
outputPrefix []byte
parameters *Parameters
}
var _ key.Key = (*PublicKey)(nil)
func calculateOutputPrefix(variant Variant, idRequirement uint32) ([]byte, error) {
switch variant {
case VariantTink:
return outputprefix.Tink(idRequirement), nil
case VariantCrunchy:
return outputprefix.Legacy(idRequirement), nil
case VariantNoPrefix:
return nil, nil
default:
return nil, fmt.Errorf("invalid output prefix variant: %v", variant)
}
}
// ecdhCurveFromCurveType returns the corresponding ecdh.Curve value from ct.
func ecdhCurveFromCurveType(ct CurveType) (ecdh.Curve, error) {
switch ct {
case NISTP256:
return ecdh.P256(), nil
case NISTP384:
return ecdh.P384(), nil
case NISTP521:
return ecdh.P521(), nil
case X25519:
return ecdh.X25519(), nil
default:
return nil, fmt.Errorf("invalid curve type: %v", ct)
}
}
// NewPublicKey creates a new ECIES PublicKey.
//
// publicKeyBytes belongs to either a NIST Curve or Curve25519.
func NewPublicKey(publicKeyBytes []byte, idRequirement uint32, parameters *Parameters) (*PublicKey, error) {
if parameters.Variant() == VariantNoPrefix && idRequirement != 0 {
return nil, fmt.Errorf("ecies.NewPublicKey: key ID must be zero for VariantNoPrefix")
}
outputPrefix, err := calculateOutputPrefix(parameters.Variant(), idRequirement)
if err != nil {
return nil, fmt.Errorf("ecies.NewPublicKey: %v", err)
}
curve, err := ecdhCurveFromCurveType(parameters.CurveType())
if err != nil {
return nil, fmt.Errorf("ecies.NewPublicKey: %v", err)
}
// Validate the point.
if _, err := curve.NewPublicKey(publicKeyBytes); err != nil {
return nil, fmt.Errorf("ecies.NewPublicKey: point validation failed: %v", err)
}
return &PublicKey{
publicKeyBytes: bytes.Clone(publicKeyBytes),
idRequirement: idRequirement,
outputPrefix: outputPrefix,
parameters: parameters,
}, nil
}
// PublicKeyBytes returns the public key bytes.
func (k *PublicKey) PublicKeyBytes() []byte { return k.publicKeyBytes }
// Parameters returns the parameters of this key.
func (k *PublicKey) Parameters() key.Parameters { return k.parameters }
// IDRequirement returns the key ID and whether it is required.
func (k *PublicKey) IDRequirement() (uint32, bool) {
return k.idRequirement, k.Parameters().HasIDRequirement()
}
// OutputPrefix returns the output prefix of this key.
func (k *PublicKey) OutputPrefix() []byte { return bytes.Clone(k.outputPrefix) }
// Equal tells whether this key value is equal to other.
func (k *PublicKey) Equal(other key.Key) bool {
otherKey, ok := other.(*PublicKey)
return ok && k.Parameters().Equal(otherKey.Parameters()) &&
k.idRequirement == otherKey.idRequirement &&
bytes.Equal(k.publicKeyBytes, otherKey.publicKeyBytes)
}
// PrivateKey represents an ECIES private key.
type PrivateKey struct {
publicKey *PublicKey
privateKeyBytes secretdata.Bytes
}
var _ key.Key = (*PrivateKey)(nil)
// NewPrivateKey creates a new ECIES private key from privateKeyBytes,
// idRequirement and a [Parameters].
//
// If X25519 curve is used, the private key value must be 32 bytes.
// If NIST curve is used, the private key value must be octet encoded as per
// [SEC 1 v2.0, Section 2.3.5].
//
// [SEC 1 v2.0, Section 2.3.5]: https://www.secg.org/sec1-v2.pdf#page=17.08
func NewPrivateKey(privateKeyBytes secretdata.Bytes, idRequirement uint32, params *Parameters) (*PrivateKey, error) {
curveType := params.CurveType()
curve, err := ecdhCurveFromCurveType(curveType)
if err != nil {
return nil, err
}
ecdhPrivateKey, err := curve.NewPrivateKey(privateKeyBytes.Data(insecuresecretdataaccess.Token{}))
if err != nil {
return nil, fmt.Errorf("ecies.NewPrivateKey: private key validation failed: %v", err)
}
publicKey, err := NewPublicKey(ecdhPrivateKey.PublicKey().Bytes(), idRequirement, params)
if err != nil {
return nil, fmt.Errorf("ecies.NewPrivateKey: %v", err)
}
return &PrivateKey{
publicKey: publicKey,
privateKeyBytes: privateKeyBytes,
}, nil
}
// NewPrivateKeyFromPublicKey creates a new ECIES private key from
// privateKeyBytes and a [PublicKey].
//
// If X25519 curve is used, the private key value must be 32 bytes.
// If NIST curve is used, the private key value must be octet encoded as per
// [SEC 1 v2.0, Section 2.3.5].
//
// [SEC 1 v2.0, Section 2.3.5]: https://www.secg.org/sec1-v2.pdf#page=17.08
func NewPrivateKeyFromPublicKey(privateKeyBytes secretdata.Bytes, pubKey *PublicKey) (*PrivateKey, error) {
curveType := pubKey.Parameters().(*Parameters).CurveType()
curve, err := ecdhCurveFromCurveType(curveType)
if err != nil {
return nil, fmt.Errorf("ecies.NewPrivateKey: %v", err)
}
ecdhPrivateKey, err := curve.NewPrivateKey(privateKeyBytes.Data(insecuresecretdataaccess.Token{}))
if err != nil {
return nil, fmt.Errorf("ecies.NewPrivateKey: private key validation failed: %v", err)
}
ecdhPublicKeyFromPublicKey, err := curve.NewPublicKey(pubKey.publicKeyBytes)
if err != nil {
// Should never happen.
return nil, fmt.Errorf("ecies.NewPrivateKey: invalid public key point: %v", err)
}
if !ecdhPrivateKey.PublicKey().Equal(ecdhPublicKeyFromPublicKey) {
return nil, fmt.Errorf("ecies.NewPrivateKey: invalid private key value")
}
return &PrivateKey{
publicKey: pubKey,
privateKeyBytes: privateKeyBytes,
}, nil
}
// PrivateKeyBytes returns the private key bytes.
func (k *PrivateKey) PrivateKeyBytes() secretdata.Bytes { return k.privateKeyBytes }
// PublicKey returns the public key of the key.
//
// This implements the privateKey interface defined in handle.go.
func (k *PrivateKey) PublicKey() (key.Key, error) { return k.publicKey, nil }
// Parameters returns the parameters of the key.
func (k *PrivateKey) Parameters() key.Parameters { return k.publicKey.Parameters() }
// IDRequirement returns the ID requirement of the key, and whether it is
// required.
func (k *PrivateKey) IDRequirement() (uint32, bool) { return k.publicKey.IDRequirement() }
// OutputPrefix returns the output prefix of this key.
func (k *PrivateKey) OutputPrefix() []byte { return bytes.Clone(k.publicKey.outputPrefix) }
// Equal returns true if this key is equal to other.
func (k *PrivateKey) Equal(other key.Key) bool {
otherKey, ok := other.(*PrivateKey)
return ok && k.publicKey.Equal(otherKey.publicKey) &&
k.privateKeyBytes.Equal(otherKey.privateKeyBytes)
}
|