scope

Documentation

Index

• Constants
• Variables
• func DefaultSupportedScopes() []string
• func DefaultSupportedScopesMap() map[string]string
• func DescribeScopes(scopes []string) map[string]string
• func NewAuthorizer(clusterRoleGetter rbaclisters.ClusterRoleLister) authorizer.Authorizer
• func ParseClusterRoleScope(scope string) (string, string, bool, error)
• func ScopesToRules(scopes []string, namespace string, ...) ([]rbacv1.PolicyRule, error)
• func ScopesToVisibleNamespaces(scopes []string, clusterRoleGetter rbaclisters.ClusterRoleLister, ...) (sets.String, error)
• func ValidateScopeRestrictions(client *oauthapi.OAuthClient, scopes ...string) error
• type ScopeEvaluator

Constants

const (
	UserIndicator        = "user:"
	ClusterRoleIndicator = "role:"
)

const (
	UserInfo        = UserIndicator + "info"
	UserAccessCheck = UserIndicator + "check-access"

	// UserListScopedProjects gives explicit permission to see the projects that this token can see.
	UserListScopedProjects = UserIndicator + "list-scoped-projects"

	// UserListAllProjects gives explicit permission to see the projects a user can see.  This is often used to prime secondary ACL systems
	// unrelated to openshift and to display projects for selection in a secondary UI.
	UserListAllProjects = UserIndicator + "list-projects"

	// UserFull includes all permissions of the user
	UserFull = UserIndicator + "full"
)

Variables

var ScopeEvaluators = []ScopeEvaluator{
	userEvaluator{},
	clusterRoleEvaluator{},
}

ScopeEvaluators map prefixes to a function that handles that prefix

Functions

func DefaultSupportedScopes

func DefaultSupportedScopes() []string

func DefaultSupportedScopesMap

func DefaultSupportedScopesMap() map[string]string

func DescribeScopes

func DescribeScopes(scopes []string) map[string]string

func NewAuthorizer

func NewAuthorizer(clusterRoleGetter rbaclisters.ClusterRoleLister) authorizer.Authorizer

func ParseClusterRoleScope

func ParseClusterRoleScope(scope string) (string, string, bool, error)

func ScopesToRules

func ScopesToRules(scopes []string, namespace string, clusterRoleGetter rbaclisters.ClusterRoleLister) ([]rbacv1.PolicyRule, error)

ScopesToRules takes the scopes and return the rules back. We ALWAYS add the discovery rules and it is possible to get some rules and and an error since errors aren't fatal to evaluation

func ScopesToVisibleNamespaces

func ScopesToVisibleNamespaces(scopes []string, clusterRoleGetter rbaclisters.ClusterRoleLister, ignoreUnhandledScopes bool) (sets.String, error)

ScopesToVisibleNamespaces returns a list of namespaces that the provided scopes have "get" access to. This exists only to support efficiently list/watch of projects (ACLed namespaces)

func ValidateScopeRestrictions

func ValidateScopeRestrictions(client *oauthapi.OAuthClient, scopes ...string) error

Types

type ScopeEvaluator

type ScopeEvaluator interface {
	// Handles returns true if this evaluator can evaluate this scope
	Handles(scope string) bool
	// Validate returns an error if the scope is malformed
	Validate(scope string) error
	// Describe returns a description, warning (typically used to warn about escalation dangers), or an error if the scope is malformed
	Describe(scope string) (description string, warning string, err error)
	// ResolveRules returns the policy rules that this scope allows
	ResolveRules(scope, namespace string, clusterRoleGetter rbaclisters.ClusterRoleLister) ([]rbacv1.PolicyRule, error)
	ResolveGettableNamespaces(scope string, clusterRoleGetter rbaclisters.ClusterRoleLister) ([]string, error)
}

ScopeEvaluator takes a scope and returns the rules that express it