model

Documentation

Index

• Constants
• Variables
• type Response
  • func ErrorToBadRequestErrorResponse(err error) *Response
  • func ErrorToInternalServerErrorResponse(err error) *Response
  • func (r Response) Send(ctx *fiber.Ctx) error
• type RestrictionClaim
  • func NewRestrictionClaim(s string) RestrictionClaim
  • func (rc RestrictionClaim) MarshalJSON() ([]byte, error)
  • func (rc *RestrictionClaim) String() string
  • func (rc *RestrictionClaim) UnmarshalJSON(data []byte) error
  • func (rc *RestrictionClaim) UnmarshalText(data []byte) error
  • func (rc *RestrictionClaim) UnmarshalYAML(value *yaml.Node) error
  • func (rc *RestrictionClaim) Valid() bool
• type RestrictionClaims
  • func (rks RestrictionClaims) Disable(disable RestrictionClaims) (left RestrictionClaims)
  • func (rks RestrictionClaims) Has(rk RestrictionClaim) bool

Constants

const (
	AttrScope      = "scope"
	AttrAud        = "audience"
	AttrCapability = "capability"
)

Defined attributes

Variables

var AllRestrictionClaimStrings = api.AllRestrictionClaims

AllRestrictionClaimStrings holds all defined RestrictionClaim strings

var Attributes = []string{
	AttrScope,
	AttrAud,
	AttrCapability,
}

Attributes holds all defined attributes

var ResponseNYI = Response{
	Status:   fiber.StatusNotImplemented,
	Response: api.ErrorNYI,
}

ResponseNYI is the server response when something is not yet implemented

Types

type Response

type Response struct {
	// The Http Status code of the response
	Status int
	// The response body, will be marshalled as json
	Response interface{}
	// Cookies that should be set
	Cookies []*fiber.Cookie
}

Response models a http server response

func ErrorToBadRequestErrorResponse

func ErrorToBadRequestErrorResponse(err error) *Response

ErrorToBadRequestErrorResponse creates a bad request error response from a golang error

func ErrorToInternalServerErrorResponse

func ErrorToInternalServerErrorResponse(err error) *Response

ErrorToInternalServerErrorResponse creates an internal server error response from a golang error

func (Response) Send

func (r Response) Send(ctx *fiber.Ctx) error

Send sends this response using the passed fiber.Ctx

type RestrictionClaim

type RestrictionClaim int

RestrictionClaim is an enum like type for restriction keys

const (
	RestrictionClaimNotBefore RestrictionClaim = iota
	RestrictionClaimExpiresAt
	RestrictionClaimScope
	RestrictionClaimAudiences
	RestrictionClaimHosts
	RestrictionClaimGeoIPAllow
	RestrictionClaimGeoIPDisallow
	RestrictionClaimUsagesAT
	RestrictionClaimUsagesOther
)

RestrictionClaims

func NewRestrictionClaim

func NewRestrictionClaim(s string) RestrictionClaim

NewRestrictionClaim creates a new RestrictionClaim from the grant type string

func (RestrictionClaim) MarshalJSON

func (rc RestrictionClaim) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface

func (*RestrictionClaim) String

func (rc *RestrictionClaim) String() string

func (*RestrictionClaim) UnmarshalJSON

func (rc *RestrictionClaim) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface

func (*RestrictionClaim) UnmarshalText

func (rc *RestrictionClaim) UnmarshalText(data []byte) error

UnmarshalText implements the encoding.TextUnmarshaler interface

func (*RestrictionClaim) UnmarshalYAML

func (rc *RestrictionClaim) UnmarshalYAML(value *yaml.Node) error

UnmarshalYAML implements the yaml.Unmarshaler interface

func (*RestrictionClaim) Valid

func (rc *RestrictionClaim) Valid() bool

Valid checks that RestrictionClaim is a defined grant type

type RestrictionClaims

type RestrictionClaims []RestrictionClaim

RestrictionClaims is a slice of RestrictionClaim

var AllRestrictionClaims RestrictionClaims

AllRestrictionClaims holds all defined RestrictionClaims

func (RestrictionClaims) Disable

func (rks RestrictionClaims) Disable(disable RestrictionClaims) (left RestrictionClaims)

Disable subtracts the passed RestrictionClaims from this RestrictionClaims and returns the left RestrictionClaims

func (RestrictionClaims) Has

func (rks RestrictionClaims) Has(rk RestrictionClaim) bool

Has checks if a RestrictionClaim is in a RestrictionClaims