uma

package module

Go to main page

Versions in this module

v0

v0.4.3

Dec 16, 2022

v0.4.2

Dec 10, 2022

v0.4.1

Dec 3, 2022

v0.4.0

Nov 27, 2022

v0.3.2

Oct 30, 2022

Changes in this version

type KeycloakProvider

+ ClientID string

type ManagerOptions

+ CustomEnforce func(r *http.Request, resource Resource, scopes []string) bool

+ Logger *logr.Logger

v0.3.1

Sep 14, 2022

v0.3.0

Sep 13, 2022

Changes in this version

+ func GetClaimsScopes(r *http.Request) (scopes map[string]struct{})

type KeycloakProvider

+ func (p *KeycloakProvider) Credentials() (issuer, clientID, clientSecret string)

type Manager

+ func (m *Manager) AskForTicket(w http.ResponseWriter, r *http.Request)

v0.2.2

Sep 1, 2022

Changes in this version

type ManagerOptions

+ AnonymousScopes func(resource Resource) (scopes []string)

+ EditUnauthorizedResponse func(rw http.ResponseWriter)

+ GetResourceStore func(r *http.Request) ResourceStore

+ LocalEnforce func(r *http.Request, resource Resource, scopes []string) bool

v0.2.1

Aug 27, 2022

v0.2.0

Aug 27, 2022

Changes in this version

+ type KeycloakOption func(kp *KeycloakProvider)

+ func WithKeycloakClient(client *http.Client) KeycloakOption

+ func WithKeycloakOwnerManagedAccess() KeycloakOption

+ type Manager struct

+ func New(opts ManagerOptions, types map[string]ResourceType, securitySchemes []string, ...) *Manager

+ func (m *Manager) Middleware(next http.Handler) http.Handler

+ func (m *Manager) RegisterResourceAt(p Provider, baseURL url.URL, path string) (rsc *Resource, err error)

+ type ManagerOptions struct

+ DisableTokenExpirationCheck bool

+ GetBaseURL func(r *http.Request) url.URL

+ GetProvider func(r *http.Request) Provider

+ GetResourceName func(rsc Resource) string

+ IncludeScopesInPermissionTicket bool

+ ResourceStore ResourceStore

type Path

+ func (p *Path) FindScopes(securitySchemes map[string]struct{}, method string) (scopes []string)

v0.1.0

Aug 27, 2022

Changes in this version

+ func GetScopes(r *http.Request) []string

+ func Middleware(opts MiddlewareOptions, types map[string]ResourceType, ...) func(next http.Handler) http.Handler

+ type Authorization struct

+ Permissions []Permission

+ type Claims struct

+ Aud string

+ Authorization *Authorization

+ Azp string

+ Email string

+ EmailVerified bool

+ Exp int

+ FamilyName string

+ GivenName string

+ Iat int

+ Jti string

+ Name string

+ Nbf int

+ PreferredUsername string

+ Sid string

+ Sub string

+ Typ string

+ func GetClaims(r *http.Request) *Claims

+ func (tok *Claims) IsValid(resourceID string, disableTokenExpirationCheck bool, scopes ...string) bool

+ type DiscoveryDoc struct

+ PermissionEndpoint string

+ PolicyEndpoint string

+ ResourceRegistrationEndpoint string

+ TokenEndpoint string

+ TokenIntrospectionEndpoint string

+ type ExpandedResource struct

+ Description string

+ ID string

+ IconUri string

+ Name string

+ Owner *ResourceOwner

+ OwnerManagedAccess bool

+ ResourceScopes []Scope

+ Scopes []Scope

+ Type string

+ URIs []string

+ type KcPermission struct

+ Clients []string

+ DecisionStrategy KcPolicyDecisionStrategy

+ Description string

+ Groups []string

+ ID string

+ Logic KcPermissionLogic

+ Name string

+ Owner string

+ Roles []string

+ Scopes []string

+ Type string

+ type KcPermissionLogic string

+ const KcNegative

+ const KcPositive

+ type KcPolicyDecisionStrategy string

+ const KcUnanimous

+ type KeySet interface

+ VerifySignature func(ctx context.Context, jwt string) (payload []byte, err error)

+ type KeycloakProvider struct

+ func NewKeycloakProvider(issuer, clientID, clientSecret string, keySet KeySet, client *http.Client, ...) (p *KeycloakProvider, err error)

+ func (p *KeycloakProvider) CreatePermissionForResource(resourceID string, perm *KcPermission) (permissionID string, err error)

+ func (p *KeycloakProvider) CreateResource(request *Resource) (response *ExpandedResource, err error)

+ func (p *KeycloakProvider) DeletePermission(id string) (err error)

+ func (p *KeycloakProvider) ListPermissions(urlQuery url.Values) (perms []KcPermission, err error)

+ func (p *KeycloakProvider) UpdatePermission(id string, perm *KcPermission) (err error)

+ func (p *KeycloakProvider) WWWAuthenticateDirectives() WWWAuthenticateDirectives

+ func (p KeycloakProvider) Authenticate(client *http.Client) (*httputil.ClientCreds, error)

+ func (p KeycloakProvider) CreatePermissionTicket(resourceID string, scopes ...string) (string, error)

+ func (p KeycloakProvider) DeleteResource(id string) (err error)

+ func (p KeycloakProvider) GetResource(id string) (resource *ExpandedResource, err error)

+ func (p KeycloakProvider) ListResources(urlQuery url.Values) (ids []string, err error)

+ func (p KeycloakProvider) UpdateResource(id string, resource *Resource) (err error)

+ func (p KeycloakProvider) VerifySignature(ctx context.Context, jwt string) (payload []byte, err error)

+ type MiddlewareOptions struct

+ DisableTokenExpirationCheck bool

+ GetBaseURL func(r *http.Request) url.URL

+ GetProvider func(r *http.Request) Provider

+ IncludeScopeInPermissionTicket bool

+ ResourceStore ResourceStore

+ type Operation struct

+ Security Security

+ type Path struct

+ func NewPath(pathTmpl string, rscTmpl *ResourceTemplate, operations map[string]Operation) Path

+ func (p *Path) Match(types map[string]ResourceType, securitySchemes map[string]struct{}, ...) (rsc *Resource, scopes []string, match bool)

+ func (p *Path) MatchPath(types map[string]ResourceType, baseURL, path string) (rsc *Resource, match bool)

+ type Paths []Path

+ func (t Paths) Len() int

+ func (t Paths) Less(i, j int) bool

+ func (t Paths) Swap(i, j int)

+ type Permission struct

+ Rsid string

+ Rsname string

+ Scopes []string

+ type Provider interface

+ Authenticate func(client *http.Client) (*httputil.ClientCreds, error)

+ CreatePermissionTicket func(resourceID string, scopes ...string) (string, error)

+ CreateResource func(request *Resource) (response *ExpandedResource, err error)

+ DeleteResource func(id string) (err error)

+ GetResource func(id string) (resource *ExpandedResource, err error)

+ ListResources func(urlQuery url.Values) (ids []string, err error)

+ UpdateResource func(id string, resource *Resource) (err error)

+ WWWAuthenticateDirectives func() WWWAuthenticateDirectives

+ type Resource struct

+ ID string

+ Name string

+ Owner string

+ OwnerManagedAccess bool

+ URI string

+ func GetResource(r *http.Request) *Resource

+ type ResourceOwner struct

+ ID string

+ Name string

+ type ResourceStore interface

+ Get func(name string) (id string)

+ Set func(name, id string)

+ type ResourceTemplate struct

+ func NewResourceTemplate(rscType, rscNameTmpl string) *ResourceTemplate

+ func (t *ResourceTemplate) CreateResource(types map[string]ResourceType, uri string, params map[string]string) (rsc *Resource)

+ type ResourceType struct

+ Description string

+ IconUri string

+ ResourceScopes []string

+ Type string

+ type Scope struct

+ ID string

+ Name string

+ type Security []map[string][]string

+ type WWWAuthenticateDirectives struct

+ AsUri string

+ Realm string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL