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
|
// Copyright 2024 OpenPubkey
//
// 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.
//
// SPDX-License-Identifier: Apache-2.0
package providers
import (
"context"
"crypto/ecdsa"
"crypto/rsa"
"encoding/json"
"fmt"
"strings"
"github.com/lestrrat-go/jwx/v2/jwa"
"github.com/lestrrat-go/jwx/v2/jws"
"github.com/openpubkey/openpubkey/discover"
"github.com/openpubkey/openpubkey/gq"
"github.com/openpubkey/openpubkey/oidc"
"github.com/openpubkey/openpubkey/pktoken/clientinstance"
"github.com/openpubkey/openpubkey/util"
)
const AudPrefixForGQCommitment = "OPENPUBKEY-PKTOKEN:"
type DefaultProviderVerifier struct {
issuer string
commitType CommitType
options ProviderVerifierOpts
}
type ProviderVerifierOpts struct {
// If ClientID is specified, then verification will require that the ClientID
// be present in the audience ("aud") claim of the PK token payload
ClientID string
// Describes the place where the cicHash is committed to in the the ID token.
// For instance the nonce payload claim name where the cicHash was stored during issuance
CommitType CommitType
// Specifies whether to skip the Client ID check, defaults to false
SkipClientIDCheck bool
// Custom function for discovering public key of Provider
DiscoverPublicKey *discover.PublicKeyFinder
// Only allows GQ signatures, a provider signature under any other algorithm
// is seen as an error
GQOnly bool
}
// Creates a new ProviderVerifier with required fields
//
// issuer: Is the OpenID provider issuer as seen in ID token e.g. "https://accounts.google.com"
// commitmentClaim: the ID token payload claim name where the cicHash was stored during issuance
func NewProviderVerifier(issuer string, options ProviderVerifierOpts) *DefaultProviderVerifier {
v := &DefaultProviderVerifier{
issuer: issuer,
commitType: options.CommitType,
options: options,
}
// If no custom DiscoverPublicKey function is set, set default
if v.options.DiscoverPublicKey == nil {
v.options.DiscoverPublicKey = discover.DefaultPubkeyFinder()
}
return v
}
func (v *DefaultProviderVerifier) Issuer() string {
return v.issuer
}
func (v *DefaultProviderVerifier) VerifyIDToken(ctx context.Context, idToken []byte, cic *clientinstance.Claims) error {
// Sanity check that if GQCommitment is enabled then the other options
// are set correctly for doing GQ commitment verification. The intention is
// to catch misconfigurations early and provide meaningful error messages.
if v.options.CommitType.GQCommitment {
if !v.options.GQOnly {
return fmt.Errorf("GQCommitment requires that GQOnly is true, but GQOnly is (%t)", v.options.GQOnly)
}
if v.commitType.Claim != "" {
return fmt.Errorf("GQCommitment requires that commitmentClaim is empty but commitmentClaim is (%s)", v.commitType.Claim)
}
if !v.options.SkipClientIDCheck {
// When we bind the commitment to the ID Token using GQ Signatures,
// We require that the audience is prefixed with
// "OPENPUBKEY-PKTOKEN:". Thus, the audience can't be the client-id
// If you are hitting this error of set SkipClientIDCheck to true
return fmt.Errorf("GQCommitment requires that audience (aud) is not set to client-id")
}
}
idt, err := oidc.NewJwt(idToken)
if err != nil {
return err
}
// Check whether Audience claim matches provided Client ID
// No error is thrown if option is set to skip client ID check
if err := verifyAudience(idt, v.options.ClientID); err != nil && !v.options.SkipClientIDCheck {
return err
}
algStr := idt.GetSignature().GetProtectedClaims().Alg
if algStr == "" {
return fmt.Errorf("provider algorithm type missing")
}
alg := jwa.SignatureAlgorithm(algStr)
if alg != gq.GQ256 && v.options.GQOnly {
return fmt.Errorf("non-GQ signatures are not supported")
}
switch alg {
case gq.GQ256:
if err := v.verifyGQSig(ctx, idt); err != nil {
return fmt.Errorf("error verifying OP GQ signature on PK Token: %w", err)
}
case jwa.RS256:
pubKeyRecord, err := v.providerPublicKey(ctx, idToken)
if err != nil {
return fmt.Errorf("failed to get OP public key: %w", err)
}
// Ensure that the algorithm of public key from OpenID Provider matches the algorithm specified in the ID Token
if _, ok := pubKeyRecord.PublicKey.(*rsa.PublicKey); !ok {
return fmt.Errorf("public key is not an RSA public key")
}
if _, err := jws.Verify(idToken, jws.WithKey(alg, pubKeyRecord.PublicKey)); err != nil {
return err
}
case jwa.ES256:
pubKeyRecord, err := v.providerPublicKey(ctx, idToken)
if err != nil {
return fmt.Errorf("failed to get OP public key: %w", err)
}
// Ensure that the algorithm of public key from OpenID Provider matches the algorithm specified in the ID Token
if _, ok := pubKeyRecord.PublicKey.(*ecdsa.PublicKey); !ok {
return fmt.Errorf("public key is not an ECDSA public key")
}
if _, err := jws.Verify(idToken, jws.WithKey(alg, pubKeyRecord.PublicKey)); err != nil {
return err
}
default:
return fmt.Errorf("unsupported signature algorithm %s", alg)
}
if err := v.verifyCommitment(idt, cic); err != nil {
return err
}
return nil
}
// This function takes in an OIDC Provider created ID token or GQ-signed modification of one and returns
// the associated public key
func (v *DefaultProviderVerifier) providerPublicKey(ctx context.Context, idToken []byte) (*discover.PublicKeyRecord, error) {
return v.options.DiscoverPublicKey.ByToken(ctx, v.Issuer(), idToken)
}
func (v *DefaultProviderVerifier) verifyCommitment(idt *oidc.Jwt, cic *clientinstance.Claims) error {
var claims map[string]any
payload, err := util.Base64DecodeForJWT([]byte(idt.GetPayload()))
if err != nil {
return err
}
if err := json.Unmarshal(payload, &claims); err != nil {
return err
}
expectedCommitment, err := cic.Hash()
if err != nil {
return err
}
var commitment any
var commitmentFound bool
if v.options.CommitType.GQCommitment {
aud, ok := claims["aud"]
if !ok {
return fmt.Errorf("require audience claim prefix missing in PK Token's GQCommitment")
}
// To prevent attacks where a attacker takes someone else's ID Token
// and turns it into a PK Token using a GQCommitment, we require that
// all GQ commitments explicitly signal they want to be used as
// PK Tokens. To signal this, they prefix the audience (aud)
// claim with the string "OPENPUBKEY-PKTOKEN:".
// We reject all GQ commitment PK Tokens that don't have this prefix
// in the aud claim.
if _, ok := strings.CutPrefix(aud.(string), AudPrefixForGQCommitment); !ok {
return fmt.Errorf("audience claim in PK Token's GQCommitment must be prefixed by (%s), got (%s) instead",
AudPrefixForGQCommitment, aud.(string))
}
// Get the commitment from the GQ signed protected header claim "cic" in the ID Token
commitment = idt.GetSignature().GetProtectedClaims().CIC
if commitment == "" {
return fmt.Errorf("missing GQ commitment")
}
} else {
if v.commitType.Claim == "" {
return fmt.Errorf("verifier configured with empty commitment claim")
}
commitment, commitmentFound = claims[v.commitType.Claim]
if !commitmentFound {
return fmt.Errorf("missing commitment claim %s", v.commitType.Claim)
}
}
if commitment != string(expectedCommitment) {
return fmt.Errorf("commitment claim doesn't match, got %q, expected %s", commitment, string(expectedCommitment))
}
return nil
}
// verifyGQSig verifies the signature of a PK token with a GQ signature. The
// parameter issuer should be the issuer of the ProviderVerifier not the
// issuer of the PK Token
func (v *DefaultProviderVerifier) verifyGQSig(ctx context.Context, idt *oidc.Jwt) error {
algStr := idt.GetSignature().GetProtectedClaims().Alg
if algStr == "" {
return fmt.Errorf("missing provider algorithm header")
}
if algStr != gq.GQ256.String() {
return fmt.Errorf("signature is not of type GQ")
}
origHeaders, err := originalTokenHeaders(idt.GetRaw())
if err != nil {
return fmt.Errorf("malformed ID Token headers: %w", err)
}
origAlg := origHeaders.Algorithm()
if origAlg != jwa.RS256 {
return fmt.Errorf("expected original headers to contain RS256 alg, got %s", origAlg)
}
if idt.GetClaims().Issuer == "" {
return fmt.Errorf("missing issuer in payload: %s", idt.GetPayload())
}
if idt.GetClaims().Issuer != v.issuer {
return fmt.Errorf("issuer of ID Token (%s) doesn't match expected issuer (%s)", idt.GetClaims().Issuer, v.issuer)
}
publicKeyRecord, err := v.options.DiscoverPublicKey.ByToken(ctx, v.Issuer(), idt.GetRaw())
if err != nil {
return fmt.Errorf("failed to get provider public key: %w", err)
}
rsaKey, ok := publicKeyRecord.PublicKey.(*rsa.PublicKey)
if !ok {
return fmt.Errorf("jwk is not an RSA key")
}
ok, err = gq.GQ256VerifyJWT(rsaKey, idt.GetRaw())
if err != nil {
return err
}
if !ok {
return fmt.Errorf("error verifying OP GQ signature on PK Token (ID Token invalid)")
}
return nil
}
func originalTokenHeaders(token []byte) (jws.Headers, error) {
origHeadersB64, err := gq.OriginalJWTHeaders(token)
if err != nil {
return nil, fmt.Errorf("malformatted PK token headers: %w", err)
}
origHeaders, err := util.Base64DecodeForJWT(origHeadersB64)
if err != nil {
return nil, fmt.Errorf("error decoding original token headers: %w", err)
}
headers := jws.NewHeaders()
err = json.Unmarshal(origHeaders, &headers)
if err != nil {
return nil, fmt.Errorf("error parsing segment: %w", err)
}
return headers, nil
}
func verifyAudience(idt *oidc.Jwt, clientID string) error {
if idt.GetClaims().Audience == "" {
return fmt.Errorf("missing audience claim")
}
for _, audience := range strings.Split(idt.GetClaims().Audience, ",") {
if audience == clientID {
return nil
}
}
return fmt.Errorf("audience does not contain clientID %s, aud = %v", clientID, idt.GetClaims().Audience)
}
|