claim

Documentation

Overview

Package claim wraps the JWT claims with util functions

Index

• Constants
• func ToContext(ctx context.Context, claims Claims) context.Context
• func UserNameFromContext(ctx context.Context) string
• type Claims
  • func FromContext(ctx context.Context) (Claims, bool)
  • func (c *Claims) AttachSecretPair(sp string)
  • func (c *Claims) GetClientApp() string
  • func (c *Claims) GetSecretPair() string
  • func (c *Claims) GetUniqueKey() string

Constants

const (
	ContextKey contextKey = "pydio-claims"
)

Functions

func ToContext

func ToContext(ctx context.Context, claims Claims) context.Context

ToContext feeds context with correct Keys and Metadata for a given Claims

func UserNameFromContext

func UserNameFromContext(ctx context.Context) string

UserNameFromContext looks up for various keys to find username and **optionally** claims

Types

type Claims

type Claims struct {
	ClientApp      interface{} `json:"aud" mapstructure:"aud"`
	Issuer         string      `json:"iss" mapstructure:"iss"`
	SessionID      string      `json:"sid" mapstructure:"sid"`
	Subject        string      `json:"sub" mapstructure:"sub"`
	Nonce          string      `json:"nonce" mapstructure:"nonce"`
	Name           string      `json:"name" mapstructure:"name"`
	Email          string      `json:"email" mapstructure:"email"`
	Profile        string      `json:"profile" mapstructure:"profile"`
	Verified       bool        `json:"email_verified" mapstructure:"email_verified"`
	Public         bool        `json:"public" mapstructure:"public"`
	Roles          string      `json:"roles" mapstructure:"roles"`
	Expiry         time.Time   `json:"expiry" mapstructure:"expiry"`
	AuthSource     string      `json:"authSource" mapstructure:"authSource"`
	DisplayName    string      `json:"displayName" mapstructure:"displayName"`
	GroupPath      string      `json:"groupPath" mapstructure:"groupPath"`
	ProvidesScopes bool        `json:"providesScopes" mapstructure:"providesScopes"`
	Scopes         []string    `json:"scopes" mapstructure:"scopes"`
	// contains filtered or unexported fields
}

func FromContext

func FromContext(ctx context.Context) (Claims, bool)

FromContext retrieves claims from context

func (*Claims) AttachSecretPair

func (c *Claims) AttachSecretPair(sp string)

func (*Claims) GetClientApp

func (c *Claims) GetClientApp() string

func (*Claims) GetSecretPair

func (c *Claims) GetSecretPair() string

func (*Claims) GetUniqueKey

func (c *Claims) GetUniqueKey() string

GetUniqueKey returns a key that is unique to a given claim value