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/...`
76 lines
2.5 KiB
Go
76 lines
2.5 KiB
Go
package oidc
|
|
|
|
import "github.com/muhlemmer/gu"
|
|
|
|
type IntrospectionRequest struct {
|
|
Token string `schema:"token"`
|
|
}
|
|
|
|
type ClientAssertionParams struct {
|
|
ClientAssertion string `schema:"client_assertion"`
|
|
ClientAssertionType string `schema:"client_assertion_type"`
|
|
}
|
|
|
|
// IntrospectionResponse implements RFC 7662, section 2.2 and
|
|
// OpenID Connect Core 1.0, section 5.1 (UserInfo).
|
|
// https://www.rfc-editor.org/rfc/rfc7662.html#section-2.2.
|
|
// https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims.
|
|
type IntrospectionResponse struct {
|
|
Active bool `json:"active"`
|
|
Scope SpaceDelimitedArray `json:"scope,omitempty"`
|
|
ClientID string `json:"client_id,omitempty"`
|
|
TokenType string `json:"token_type,omitempty"`
|
|
Expiration Time `json:"exp,omitempty"`
|
|
IssuedAt Time `json:"iat,omitempty"`
|
|
NotBefore Time `json:"nbf,omitempty"`
|
|
Subject string `json:"sub,omitempty"`
|
|
Audience Audience `json:"aud,omitempty"`
|
|
Issuer string `json:"iss,omitempty"`
|
|
JWTID string `json:"jti,omitempty"`
|
|
Username string `json:"username,omitempty"`
|
|
UserInfoProfile
|
|
UserInfoEmail
|
|
UserInfoPhone
|
|
|
|
Address *UserInfoAddress `json:"address,omitempty"`
|
|
Claims map[string]any `json:"-"`
|
|
}
|
|
|
|
// SetUserInfo copies all relevant fields from UserInfo
|
|
// into the IntroSpectionResponse.
|
|
func (i *IntrospectionResponse) SetUserInfo(u *UserInfo) {
|
|
i.Subject = u.Subject
|
|
i.Username = u.PreferredUsername
|
|
i.Address = gu.PtrCopy(u.Address)
|
|
i.UserInfoProfile = u.UserInfoProfile
|
|
i.UserInfoEmail = u.UserInfoEmail
|
|
i.UserInfoPhone = u.UserInfoPhone
|
|
if i.Claims == nil {
|
|
i.Claims = gu.MapCopy(u.Claims)
|
|
} else {
|
|
gu.MapMerge(u.Claims, i.Claims)
|
|
}
|
|
}
|
|
|
|
// GetAddress is a safe getter that takes
|
|
// care of a possible nil value.
|
|
func (i *IntrospectionResponse) GetAddress() *UserInfoAddress {
|
|
if i.Address == nil {
|
|
return new(UserInfoAddress)
|
|
}
|
|
return i.Address
|
|
}
|
|
|
|
// introspectionResponseAlias prevents loops on the JSON methods
|
|
type introspectionResponseAlias IntrospectionResponse
|
|
|
|
func (i *IntrospectionResponse) MarshalJSON() ([]byte, error) {
|
|
if i.Username == "" {
|
|
i.Username = i.PreferredUsername
|
|
}
|
|
return mergeAndMarshalClaims((*introspectionResponseAlias)(i), i.Claims)
|
|
}
|
|
|
|
func (i *IntrospectionResponse) UnmarshalJSON(data []byte) error {
|
|
return unmarshalJSONMulti(data, (*introspectionResponseAlias)(i), &i.Claims)
|
|
}
|