claim

type Acr ¶

type Acr string

Acr is the authentication context class reference.

func NewAcr(s string) *Acr

func (c Acr) ClaimName() string

type Address ¶

type Address struct {
	// Formatted is full mailing address, formatted for display or use on a mailing label. This field MAY contain
	// multiple lines, separated by newlines. Newlines can be represented either as a carriage return/line feed pair
	// ("\r\n") or as a single line feed character ("\n").
	Formatted string `json:"formatted,omitempty"`

	// StreetAddress is full street address component, which MAY include house number, street name, Post Office Box, and
	// multi-line extended street address information. This field MAY contain multiple lines, separated by newlines.
	// Newlines can be represented either as a carriage return/line feed pair ("\r\n") or as a single line feed
	// character ("\n").
	StreetAddress string `json:"street_address,omitempty"`

	// Locality is city or locality component.
	Locality string `json:"locality,omitempty"`

	// Region is state, province, prefecture, or region component.
	Region string `json:"region,omitempty"`

	// PostalCode is zip code or postal code component.
	PostalCode string `json:"postal_code,omitempty"`

	// Country is country name component.
	Country string `json:"country,omitempty"`
}

func (c *Address) ClaimName() string

type Amr ¶

type Amr []string

Amr is the authentication methods references.

func NewAmr(s []string) *Amr

func (c Amr) ClaimName() string

type Aud ¶

type Aud = claim.Aud

type AuthTime ¶

type AuthTime time.Time

AuthTime is the time when the end-user authentication occurred.

func AuthTimeFromInt64(i int64) *AuthTime

func NewAuthTime(t time.Time) *AuthTime

func (c AuthTime) ClaimName() string

func (c AuthTime) Int64() int64

func (c AuthTime) MarshalJSON() ([]byte, error)

func (c *AuthTime) UnmarshalJSON(data []byte) error

type Azp ¶

type Azp string

Azp is the authorized party - the party to which the token was issued.

func NewAzp(s string) *Azp

func (c Azp) ClaimName() string

type Birthdate ¶

type Birthdate struct {
	Year       uint
	Month      uint
	DayOfMonth uint
}

Birthdate is End-User's birthday, represented as an ISO 8601:2004 YYYY-MM-DD format. The year MAY be 0000, indicating that it is omitted. To represent only the year, YYYY format is allowed. Note that depending on the underlying platform's date related function, providing just year can result in varying month and day, so the implementers need to take this factor into account to correctly process the dates.

func NewBirthdate(y, m, d uint) (*Birthdate, error)

func NewBirthdateFromStr(s string) (*Birthdate, error)

func NewBirthdateOnlyYear(y uint) (*Birthdate, error)

func (c Birthdate) ClaimName() string

func (c Birthdate) MarshalJSON() ([]byte, error)

func (c Birthdate) String() string

type Claim ¶

type Claim = claim.Claim

type Claims ¶

type Claims claim.Claims

func ClaimsFromEncryptedJWT(jwt string, keychain jwt.Keychain) (Claims, error)

func ClaimsFromEncryptedJWTWithRegistry(
	jwt string,
	keychain jwt.Keychain,
	registry Registrar,
) (Claims, error)

func ClaimsFromJWT(jwt string, keychain jwt.Keychain) (Claims, error)

func ClaimsFromJWTWithRegistry(
	jwt string,
	keychain jwt.Keychain,
	registry Registrar,
) (Claims, error)

func ClaimsFromSignedJWT(jwt string, keychain jwt.PublicKeychain) (Claims, error)

func ClaimsFromSignedJWTWithRegistry(
	jwt string,
	keychain jwt.PublicKeychain,
	registry Registrar,
) (Claims, error)

func NewClaims() Claims

func UnsafeDecodeClaimsFromJWT(jwt string) (Claims, error)

func UnsafeDecodeClaimsFromJWTWithRegistry(jwt string, registry Registrar) (Claims, error)

func (c Claims) Clone() Claims

func (c Claims) EncryptJWT(key jwt.PublicEncryptionKey, encryption jose.ContentEncryption) (string, error)

func (c Claims) MarshalJSON() ([]byte, error)

func (c Claims) Merge(claims Claims) Claims

func (c Claims) SignJWT(key jwt.PrivateSigningKey) (string, error)

func (c *Claims) UnmarshalJSON(data []byte) error

func (c Claims) With(claim Claim) Claims

type Email ¶

type Email string

Email is URL of the End-User's email page. The contents of this Web page SHOULD be about the End-User.

func NewEmail(s string) (*Email, error)

func (c Email) ClaimName() string

type EmailVerified ¶

type EmailVerified bool

EmailVerified represents End-User at the time the verification was performed. The means by which an e-mail address is verified is context-specific, and dependent upon the trust framework or contractual agreements within which the parties are operating.

func NewEmailVerified(b bool) (*EmailVerified, error)

func (c EmailVerified) ClaimName() string

type Exp ¶

type Exp = claim.Exp

type FamilyName ¶

type FamilyName string

FamilyName is surname(s) or last name(s) of the End-User. Note that in some cultures, people can have multiple family names or no family name; all can be present, with the names being separated by space characters.

func NewFamilyName(s string) (*FamilyName, error)

func (c FamilyName) ClaimName() string

type Gender ¶

type Gender string

Gender is End-User's gender. Values defined by this specification are female and male. Other values MAY be used when neither of the defined values are applicable.

const (
	GenderMale   Gender = "male"
	GenderFemale Gender = "female"
)

func NewGender(s string) (*Gender, error)

func (c Gender) ClaimName() string

type GivenName ¶

type GivenName string

GivenName is given name(s) or first name(s) of the End-User. Note that in some cultures, people can have multiple given names; all can be present, with the names being separated by space characters.

func NewGivenName(s string) (*GivenName, error)

func (c GivenName) ClaimName() string

type Iat ¶

type Iat = claim.Iat

type Iss ¶

type Iss url.URL

Iss is the identifier for the issuer.

func IssFromStr(s string) (*Iss, error)

func NewIss(u url.URL) (*Iss, error)

func (c Iss) ClaimName() string

func (c Iss) MarshalJSON() ([]byte, error)

func (c Iss) String() string

func (c *Iss) UnmarshalJSON(data []byte) error

type Locale ¶

type Locale string

Locale is End-User's locale, represented as a BCP47 language tag. This is typically an ISO 639-1 Alpha-2 language code in lowercase and an ISO 3166-1 Alpha-2 country code in uppercase, separated by a dash. For example, en-US or fr-CA. As a compatibility note, some implementations have used an underscore as the separator rather than a dash, for example, en_US; Relying Parties MAY choose to accept this locale syntax as well.

func NewLocale(s string) (*Locale, error)

func (c Locale) ClaimName() string

type LocalizedClaim ¶

type LocalizedClaim[T claim.Claim] struct {
	Claim  T
	Locale string
}

func (c LocalizedClaim[T]) ClaimName() string

func (c LocalizedClaim[T]) MarshalJSON() ([]byte, error)

func (c *LocalizedClaim[T]) UnmarshalJSON(data []byte) error

type MiddleName ¶

type MiddleName string

MiddleName is middle name(s) of the End-User. Note that in some cultures, people can have multiple middle names; all can be present, with the names being separated by space characters. Also note that in some cultures, middle names are not used.

func NewMiddleName(s string) (*MiddleName, error)

func (c MiddleName) ClaimName() string

type Name ¶

type Name string

Name is End-User's full name in displayable form including all name parts, possibly including titles and suffixes, ordered according to the End-User's locale and preferences.

func NewName(s string) (*Name, error)

func (c Name) ClaimName() string

type Nickname ¶

type Nickname string

Nickname is casual name of the End-User that may or may not be the same as the given_name. For instance, a nickname value of Mike might be returned alongside a given_name value of Michael.

func NewNickname(s string) (*Nickname, error)

func (c Nickname) ClaimName() string

type Nonce ¶

type Nonce string

Nonce is a string value used to associate a client session with the token, and to mitigate replay attacks.

func NewNonce(s string) *Nonce

func (c Nonce) ClaimName() string

type PhoneNumber ¶

type PhoneNumber string

PhoneNumber is End-User's preferred telephone number. E.164 is RECOMMENDED as the format of this Claim, for example, +1 (425) 555-1212 or +56 (2) 687 2400. If the phone number contains an extension, it is RECOMMENDED that the extension be represented using the RFC 3966 [RFC3966] extension syntax, for example, +1 (604) 555-1234;ext=5678.

func NewPhoneNumber(s string) (*PhoneNumber, error)

func (c PhoneNumber) ClaimName() string

type PhoneNumberVerified ¶

type PhoneNumberVerified bool

PhoneNumberVerified is true if the End-User's phone number has been verified; otherwise false. When this Claim Value is true, this means that the OP took affirmative steps to ensure that this phone number was controlled by the End-User at the time the verification was performed. The means by which a phone number is verified is context-specific, and dependent upon the trust framework or contractual agreements within which the parties are operating. When true, the phone_number Claim MUST be in E.164 format and any extensions MUST be represented in RFC 3966 format.

func NewPhoneNumberVerified(b bool) (*PhoneNumberVerified, error)

func (c PhoneNumberVerified) ClaimName() string

type Picture ¶

type Picture url.URL

Picture is URL of the End-User's profile picture. This URL MUST refer to an image file (for example, a PNG, JPEG, or GIF image file), rather than to a Web page containing an image. Note that this URL SHOULD specifically reference a profile photo of the End-User suitable for displaying when describing the End-User, rather than an arbitrary photo taken by the End-User.

func NewPicture(u url.URL) (*Picture, error)

func PictureFromStr(s string) (*Picture, error)

func (c Picture) ClaimName() string

func (c Picture) MarshalJSON() ([]byte, error)

func (c Picture) String() string

func (c *Picture) UnmarshalJSON(data []byte) error

type PreferredUsername ¶

type PreferredUsername string

PreferredUsername is shorthand name by which the End-User wishes to be referred to at the RP, such as janedoe or j.doe. This value MAY be any valid JSON string including special characters such as @, /, or whitespace. The RP MUST NOT rely upon this value being unique, as discussed in Section 5.7.

func NewPreferredUsername(s string) (*PreferredUsername, error)

func (c PreferredUsername) ClaimName() string

type Profile ¶

type Profile url.URL

Profile is URL of the End-User's profile page. The contents of this Web page SHOULD be about the End-User.

func NewProfile(u url.URL) (*Profile, error)

func ProfileFromStr(s string) (*Profile, error)

func (c Profile) ClaimName() string

func (c Profile) MarshalJSON() ([]byte, error)

func (c Profile) String() string

func (c *Profile) UnmarshalJSON(data []byte) error

type Registrar ¶

type Registrar = claim.Registrar

type Sub ¶

type Sub string

Sub is the subject identifier.

func NewSub(s string) (*Sub, error)

func (c Sub) ClaimName() string

type UpdatedAt ¶

type UpdatedAt time.Time

UpdatedAt is time the End-User's information was last updated. Its value is a JSON number representing the number of seconds from 1970-01-01T0:0:0Z as measured in UTC until the date/time.

func NewUpdatedAt(t time.Time) (*UpdatedAt, error)

func UpdatedAtFromInt64(i int64) (*UpdatedAt, error)

func (c UpdatedAt) ClaimName() string

func (c UpdatedAt) Int64() int64

func (c UpdatedAt) MarshalJSON() ([]byte, error)

func (c *UpdatedAt) UnmarshalJSON(data []byte) error

type Website ¶

type Website url.URL

Website is URL of the End-User's Web page or blog. This Web page SHOULD contain information published by the End-User or an organization that the End-User is affiliated with.

func NewWebsite(u url.URL) (*Website, error)

func WebsiteFromStr(s string) (*Website, error)

func (c Website) ClaimName() string

func (c Website) MarshalJSON() ([]byte, error)

func (c Website) String() string

func (c *Website) UnmarshalJSON(data []byte) error

type Zoneinfo ¶

type Zoneinfo string

Zoneinfo is string from zoneinfo time zone database representing the End-User's time zone. For example, Europe/Paris or America/Los_Angeles.

func NewZoneinfo(s string) (*Zoneinfo, error)

func (c Zoneinfo) ClaimName() string