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
|
// 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/Lycense-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
package jwtecdsa
import (
"bytes"
"crypto/ecdh"
"crypto/rand"
"encoding/base64"
"encoding/binary"
"fmt"
"github.com/tink-crypto/tink-go/v2/insecuresecretdataaccess"
"github.com/tink-crypto/tink-go/v2/key"
"github.com/tink-crypto/tink-go/v2/secretdata"
)
// PublicKey represents a public key for JWT ECDSA signing.
type PublicKey struct {
parameters *Parameters
publicPoint []byte
idRequirement uint32
kid string
hasKID bool
}
var _ key.Key = (*PublicKey)(nil)
// ecdhCurveFromAlgorithm returns the corresponding ecdh.Curve value from ct.
func ecdhCurveFromAlgorithm(ct Algorithm) (ecdh.Curve, error) {
switch ct {
case ES256:
return ecdh.P256(), nil
case ES384:
return ecdh.P384(), nil
case ES512:
return ecdh.P521(), nil
default:
return nil, fmt.Errorf("invalid curve type: %v", ct)
}
}
func computeKID(customKID string, hasCustomKID bool, idRequirement uint32, parameters *Parameters) (string, bool, error) {
if !hasCustomKID && len(customKID) != 0 {
return "", false, fmt.Errorf("hasCustomKID is false but customKID is not empty")
}
switch parameters.KIDStrategy() {
case Base64EncodedKeyIDAsKID:
if hasCustomKID {
return "", false, fmt.Errorf("custom KID is not supported for KID strategy: %v", parameters.KIDStrategy())
}
// Serialize the ID requirement.
idRequirementBytes := make([]byte, 4)
binary.BigEndian.PutUint32(idRequirementBytes, idRequirement)
return base64.URLEncoding.WithPadding(base64.NoPadding).EncodeToString(idRequirementBytes), true, nil
case IgnoredKID:
if hasCustomKID {
return "", false, fmt.Errorf("custom KID is not supported for KID strategy: %v", parameters.KIDStrategy())
}
return "", false, nil
case CustomKID:
if !hasCustomKID {
return "", false, fmt.Errorf("custom KID is required for KID strategy: %v", parameters.KIDStrategy())
}
return customKID, hasCustomKID, nil
default:
return "", false, fmt.Errorf("invalid KID strategy: %v", parameters.KIDStrategy())
}
}
// PublicKeyOpts are [PublicKey] options.
type PublicKeyOpts struct {
PublicPoint []byte
IDRequirement uint32
CustomKID string
HasCustomKID bool
Parameters *Parameters
}
// NewPublicKey creates a new JWT ECDSA public key.
//
// The point is expected to be encoded uncompressed as per [SEC 1 v2.0, Section
// 2.3.3].
//
// [SEC 1 v2.0, Section 2.3.3]: https://www.secg.org/sec1-v2.pdf#page=17.08
func NewPublicKey(opts PublicKeyOpts) (*PublicKey, error) {
if opts.Parameters == nil {
return nil, fmt.Errorf("jwtecdsa.NewPublicKey: parameters can't be nil")
}
if !opts.Parameters.HasIDRequirement() && opts.IDRequirement != 0 {
return nil, fmt.Errorf("jwtecdsa.NewPublicKey: ID requirement must be 0 if ID is not required")
}
curve, err := ecdhCurveFromAlgorithm(opts.Parameters.Algorithm())
if err != nil {
return nil, fmt.Errorf("jwtecdsa.NewPublicKey: %v", err)
}
// Validate the point.
if _, err := curve.NewPublicKey(opts.PublicPoint); err != nil {
return nil, fmt.Errorf("jwtecdsa.NewPublicKey: point validation failed: %v", err)
}
kid, hasKID, err := computeKID(opts.CustomKID, opts.HasCustomKID, opts.IDRequirement, opts.Parameters)
if err != nil {
return nil, fmt.Errorf("jwtecdsa.NewPublicKey: %v", err)
}
return &PublicKey{
parameters: opts.Parameters,
publicPoint: opts.PublicPoint,
idRequirement: opts.IDRequirement,
kid: kid,
hasKID: hasKID,
}, nil
}
// Parameters returns the parameters of the key.
func (k *PublicKey) Parameters() key.Parameters { return k.parameters }
// PublicPoint returns the public key uncompressed point.
//
// Point format as per [SEC 1 v2.0, Section 2.3.3].
//
// [SEC 1 v2.0, Section 2.3.3]: https://www.secg.org/sec1-v2.pdf#page=17.08
func (k *PublicKey) PublicPoint() []byte { return k.publicPoint }
// KID returns the KID for this key.
//
// If no kid is set, it returns ("", false).
func (k *PublicKey) KID() (string, bool) { return k.kid, k.hasKID }
// IDRequirement returns the ID requirement for this key.
func (k *PublicKey) IDRequirement() (uint32, bool) {
return k.idRequirement, k.parameters.HasIDRequirement()
}
// Equal returns true if k and other are equal.
func (k *PublicKey) Equal(other key.Key) bool {
that, ok := other.(*PublicKey)
return ok && k.parameters.Equal(that.parameters) &&
bytes.Equal(k.publicPoint, that.publicPoint) &&
k.idRequirement == that.idRequirement &&
k.kid == that.kid && k.hasKID == that.hasKID
}
// PrivateKey represents a JWT ECDSA key.
type PrivateKey struct {
publicKey *PublicKey
privateKeyBytes secretdata.Bytes
}
// NewPrivateKeyFromPublicKey creates a new JWT ECDSA private key.
//
// 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(keyBytes secretdata.Bytes, publicKey *PublicKey) (*PrivateKey, error) {
if publicKey == nil {
return nil, fmt.Errorf("jwtecdsa.NewPrivateKeyFromPublicKey: public key can't be nil")
}
curve, err := ecdhCurveFromAlgorithm(publicKey.parameters.Algorithm())
if err != nil {
return nil, fmt.Errorf("jwtecdsa.NewPrivateKeyFromPublicKey: %v", err)
}
ecdhPrivateKey, err := curve.NewPrivateKey(keyBytes.Data(insecuresecretdataaccess.Token{}))
if err != nil {
return nil, fmt.Errorf("jwtecdsa.NewPrivateKeyFromPublicKey: %v", err)
}
if !bytes.Equal(publicKey.PublicPoint(), ecdhPrivateKey.PublicKey().Bytes()) {
return nil, fmt.Errorf("jwtecdsa.NewPrivateKeyFromPublicKey: public key mismatch")
}
return &PrivateKey{
publicKey: publicKey,
privateKeyBytes: keyBytes,
}, nil
}
// Parameters returns the parameters of the key.
func (k *PrivateKey) Parameters() key.Parameters { return k.publicKey.Parameters() }
// PrivateKeyValue returns the private key material.
func (k *PrivateKey) PrivateKeyValue() secretdata.Bytes { return k.privateKeyBytes }
// PublicKey returns the public key.
func (k *PrivateKey) PublicKey() (key.Key, error) { return k.publicKey, nil }
// IDRequirement returns the ID requirement for this key.
func (k *PrivateKey) IDRequirement() (uint32, bool) { return k.publicKey.IDRequirement() }
// Equal returns true if k and other are equal.
func (k *PrivateKey) Equal(other key.Key) bool {
that, ok := other.(*PrivateKey)
return ok && k.publicKey.Equal(that.publicKey) &&
k.privateKeyBytes.Equal(that.privateKeyBytes)
}
func createPrivateKey(p key.Parameters, idRequirement uint32) (key.Key, error) {
jwtECDSAParams, ok := p.(*Parameters)
if !ok {
return nil, fmt.Errorf("jwtecdsa.createPrivateKey: invalid parameters type: want %T, got %T", (*Parameters)(nil), p)
}
if jwtECDSAParams.KIDStrategy() == CustomKID {
return nil, fmt.Errorf("jwtecdsa.createPrivateKey: key generation is not supported for strategy %v", jwtECDSAParams.KIDStrategy())
}
curve, err := ecdhCurveFromAlgorithm(jwtECDSAParams.Algorithm())
if err != nil {
return nil, fmt.Errorf("jwtecdsa.createPrivateKey: %v", err)
}
privateKey, err := curve.GenerateKey(rand.Reader)
if err != nil {
return nil, fmt.Errorf("jwtecdsa.createPrivateKey: %v", err)
}
privateKeyValue := secretdata.NewBytesFromData(privateKey.Bytes(), insecuresecretdataaccess.Token{})
publicKey, err := NewPublicKey(PublicKeyOpts{
PublicPoint: privateKey.PublicKey().Bytes(),
IDRequirement: idRequirement,
HasCustomKID: false,
Parameters: jwtECDSAParams,
})
if err != nil {
return nil, fmt.Errorf("jwtecdsa.createPrivateKey: %v", err)
}
return NewPrivateKeyFromPublicKey(privateKeyValue, publicKey)
}
|