dea8bc96ea
* oidc: add regression tests for token claim json this helps to verify that the same JSON is produced, after these types are refactored. * refactor: use struct types for claim related types BREAKING CHANGE: The following types are changed from interface to struct type: - AccessTokenClaims - IDTokenClaims - IntrospectionResponse - UserInfo and related types. The following methods of OPStorage now take a pointer to a struct type, instead of an interface: - SetUserinfoFromScopes - SetUserinfoFromToken - SetIntrospectionFromToken The following functions are now generic, so that type-safe extension of Claims is now possible: - op.VerifyIDTokenHint - op.VerifyAccessToken - rp.VerifyTokens - rp.VerifyIDToken - Changed UserInfoAddress to pointer in UserInfo and IntrospectionResponse. This was needed to make omitempty work correctly. - Copy or merge maps in IntrospectionResponse and SetUserInfo * op: add example for VerifyAccessToken * fix: rp: wrong assignment in WithIssuedAtMaxAge WithIssuedAtMaxAge assigned its value to v.maxAge, which was wrong. This change fixes that by assiging the duration to v.maxAgeIAT. * rp: add VerifyTokens example * oidc: add standard references to: - IDTokenClaims - IntrospectionResponse - UserInfo * only count coverage for `./pkg/...`
113 lines
2.6 KiB
Go
113 lines
2.6 KiB
Go
package op
|
|
|
|
import (
|
|
"context"
|
|
"time"
|
|
|
|
"github.com/zitadel/oidc/v2/pkg/oidc"
|
|
)
|
|
|
|
type IDTokenHintVerifier interface {
|
|
oidc.Verifier
|
|
SupportedSignAlgs() []string
|
|
KeySet() oidc.KeySet
|
|
ACR() oidc.ACRVerifier
|
|
MaxAge() time.Duration
|
|
}
|
|
|
|
type idTokenHintVerifier struct {
|
|
issuer string
|
|
maxAgeIAT time.Duration
|
|
offset time.Duration
|
|
supportedSignAlgs []string
|
|
maxAge time.Duration
|
|
acr oidc.ACRVerifier
|
|
keySet oidc.KeySet
|
|
}
|
|
|
|
func (i *idTokenHintVerifier) Issuer() string {
|
|
return i.issuer
|
|
}
|
|
|
|
func (i *idTokenHintVerifier) MaxAgeIAT() time.Duration {
|
|
return i.maxAgeIAT
|
|
}
|
|
|
|
func (i *idTokenHintVerifier) Offset() time.Duration {
|
|
return i.offset
|
|
}
|
|
|
|
func (i *idTokenHintVerifier) SupportedSignAlgs() []string {
|
|
return i.supportedSignAlgs
|
|
}
|
|
|
|
func (i *idTokenHintVerifier) KeySet() oidc.KeySet {
|
|
return i.keySet
|
|
}
|
|
|
|
func (i *idTokenHintVerifier) ACR() oidc.ACRVerifier {
|
|
return i.acr
|
|
}
|
|
|
|
func (i *idTokenHintVerifier) MaxAge() time.Duration {
|
|
return i.maxAge
|
|
}
|
|
|
|
type IDTokenHintVerifierOpt func(*idTokenHintVerifier)
|
|
|
|
func WithSupportedIDTokenHintSigningAlgorithms(algs ...string) IDTokenHintVerifierOpt {
|
|
return func(verifier *idTokenHintVerifier) {
|
|
verifier.supportedSignAlgs = algs
|
|
}
|
|
}
|
|
|
|
func NewIDTokenHintVerifier(issuer string, keySet oidc.KeySet, opts ...IDTokenHintVerifierOpt) IDTokenHintVerifier {
|
|
verifier := &idTokenHintVerifier{
|
|
issuer: issuer,
|
|
keySet: keySet,
|
|
}
|
|
for _, opt := range opts {
|
|
opt(verifier)
|
|
}
|
|
return verifier
|
|
}
|
|
|
|
// VerifyIDTokenHint validates the id token according to
|
|
// https://openid.net/specs/openid-connect-core-1_0.html#IDTokenValidation
|
|
func VerifyIDTokenHint[C oidc.Claims](ctx context.Context, token string, v IDTokenHintVerifier) (claims C, err error) {
|
|
var nilClaims C
|
|
|
|
decrypted, err := oidc.DecryptToken(token)
|
|
if err != nil {
|
|
return nilClaims, err
|
|
}
|
|
payload, err := oidc.ParseToken(decrypted, &claims)
|
|
if err != nil {
|
|
return nilClaims, err
|
|
}
|
|
|
|
if err := oidc.CheckIssuer(claims, v.Issuer()); err != nil {
|
|
return nilClaims, err
|
|
}
|
|
|
|
if err = oidc.CheckSignature(ctx, decrypted, payload, claims, v.SupportedSignAlgs(), v.KeySet()); err != nil {
|
|
return nilClaims, err
|
|
}
|
|
|
|
if err = oidc.CheckExpiration(claims, v.Offset()); err != nil {
|
|
return nilClaims, err
|
|
}
|
|
|
|
if err = oidc.CheckIssuedAt(claims, v.MaxAgeIAT(), v.Offset()); err != nil {
|
|
return nilClaims, err
|
|
}
|
|
|
|
if err = oidc.CheckAuthorizationContextClassReference(claims, v.ACR()); err != nil {
|
|
return nilClaims, err
|
|
}
|
|
|
|
if err = oidc.CheckAuthTime(claims, v.MaxAge()); err != nil {
|
|
return nilClaims, err
|
|
}
|
|
return claims, nil
|
|
}
|