api

package
v3.6.0-1+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 22, 2017 License: Apache-2.0 Imports: 17 Imported by: 0

Documentation

Overview

Package api is the internal version of the API.

Index

Constants

View Source 
const (
	LegacyGroupName = ""
	GroupName       = "authorization.openshift.io"
)
View Source 
const (
	DockerBuildResource          = "builds/docker"
	SourceBuildResource          = "builds/source"
	CustomBuildResource          = "builds/custom"
	JenkinsPipelineBuildResource = "builds/jenkinspipeline"

	// these are valid under the "nodes" resource
	NodeMetricsSubresource = "metrics"
	NodeStatsSubresource   = "stats"
	NodeSpecSubresource    = "spec"
	NodeLogSubresource     = "log"

	RestrictedEndpointsResource = "endpoints/restricted"
)

Synthetic authorization endpoints

View Source 
const (
	// PolicyName is the name of Policy
	PolicyName     = "default"
	APIGroupAll    = "*"
	ResourceAll    = "*"
	VerbAll        = "*"
	NonResourceAll = "*"

	ScopesKey           = "authorization.openshift.io/scopes"
	ScopesAllNamespaces = "*"

	UserKind           = "User"
	GroupKind          = "Group"
	ServiceAccountKind = "ServiceAccount"
	SystemUserKind     = "SystemUser"
	SystemGroupKind    = "SystemGroup"

	UserResource           = "users"
	GroupResource          = "groups"
	ServiceAccountResource = "serviceaccounts"
	SystemUserResource     = "systemusers"
	SystemGroupResource    = "systemgroups"
)

Variables

View Source 
var (
	SchemeGroupVersion       = unversioned.GroupVersion{Group: GroupName, Version: runtime.APIVersionInternal}
	LegacySchemeGroupVersion = unversioned.GroupVersion{Group: LegacyGroupName, Version: runtime.APIVersionInternal}

	LegacySchemeBuilder    = runtime.NewSchemeBuilder(addLegacyKnownTypes)
	AddToSchemeInCoreGroup = LegacySchemeBuilder.AddToScheme

	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes, addConversionFuncs)
	AddToScheme   = SchemeBuilder.AddToScheme
)
View Source 
var ClusterPolicyBindingName = GetPolicyBindingName("")
View Source 
var DiscoveryRule = PolicyRule{
	Verbs: sets.NewString("get"),
	NonResourceURLs: sets.NewString(

		"/version", "/version/*",

		"/api", "/api/*",
		"/apis", "/apis/*",
		"/oapi", "/oapi/*",
		"/swaggerapi", "/swaggerapi/*",
		"/osapi", "/osapi/",
		"/.well-known", "/.well-known/*",
	),
}

DiscoveryRule is a rule that allows a client to discover the API resources available on this server

Functions

func BuildSubjects added in v1.0.5 

func BuildSubjects(users, groups []string, userNameValidator, groupNameValidator validation.ValidateNameFunc) []kapi.ObjectReference

func ClusterPolicyBindingToSelectableFields added in v1.0.8 

func ClusterPolicyBindingToSelectableFields(policyBinding *ClusterPolicyBinding) fields.Set

ClusterPolicyBindingToSelectableFields returns a label set that represents the object changes to the returned keys require registering conversions for existing versions using Scheme.AddFieldLabelConversionFunc

func ClusterPolicyToSelectableFields added in v1.0.8 

func ClusterPolicyToSelectableFields(policy *ClusterPolicy) fields.Set

ClusterPolicyToSelectableFields returns a label set that represents the object changes to the returned keys require registering conversions for existing versions using Scheme.AddFieldLabelConversionFunc

func Convert_api_ClusterRoleBinding_To_rbac_ClusterRoleBinding 

func Convert_api_ClusterRoleBinding_To_rbac_ClusterRoleBinding(in *ClusterRoleBinding, out *rbac.ClusterRoleBinding, _ conversion.Scope) error

func Convert_api_ClusterRole_To_rbac_ClusterRole 

func Convert_api_ClusterRole_To_rbac_ClusterRole(in *ClusterRole, out *rbac.ClusterRole, _ conversion.Scope) error

func Convert_api_RoleBinding_To_rbac_RoleBinding 

func Convert_api_RoleBinding_To_rbac_RoleBinding(in *RoleBinding, out *rbac.RoleBinding, _ conversion.Scope) error

func Convert_api_Role_To_rbac_Role 

func Convert_api_Role_To_rbac_Role(in *Role, out *rbac.Role, _ conversion.Scope) error

func Convert_rbac_ClusterRoleBinding_To_api_ClusterRoleBinding 

func Convert_rbac_ClusterRoleBinding_To_api_ClusterRoleBinding(in *rbac.ClusterRoleBinding, out *ClusterRoleBinding, _ conversion.Scope) error

func Convert_rbac_ClusterRole_To_api_ClusterRole 

func Convert_rbac_ClusterRole_To_api_ClusterRole(in *rbac.ClusterRole, out *ClusterRole, _ conversion.Scope) error

func Convert_rbac_RoleBinding_To_api_RoleBinding 

func Convert_rbac_RoleBinding_To_api_RoleBinding(in *rbac.RoleBinding, out *RoleBinding, _ conversion.Scope) error

func Convert_rbac_Role_To_api_Role 

func Convert_rbac_Role_To_api_Role(in *rbac.Role, out *Role, _ conversion.Scope) error

func DeepCopy_api_Action added in v1.3.0 

func DeepCopy_api_Action(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_api_ClusterPolicy added in v1.3.0 

func DeepCopy_api_ClusterPolicy(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_api_ClusterPolicyBinding added in v1.3.0 

func DeepCopy_api_ClusterPolicyBinding(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_api_ClusterPolicyBindingList added in v1.3.0 

func DeepCopy_api_ClusterPolicyBindingList(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_api_ClusterPolicyList added in v1.3.0 

func DeepCopy_api_ClusterPolicyList(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_api_ClusterRole added in v1.3.0 

func DeepCopy_api_ClusterRole(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_api_ClusterRoleBinding added in v1.3.0 

func DeepCopy_api_ClusterRoleBinding(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_api_ClusterRoleBindingList added in v1.3.0 

func DeepCopy_api_ClusterRoleBindingList(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_api_ClusterRoleList added in v1.3.0 

func DeepCopy_api_ClusterRoleList(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_api_GroupRestriction added in v1.4.0 

func DeepCopy_api_GroupRestriction(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_api_IsPersonalSubjectAccessReview added in v1.3.0 

func DeepCopy_api_IsPersonalSubjectAccessReview(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_api_LocalResourceAccessReview added in v1.3.0 

func DeepCopy_api_LocalResourceAccessReview(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_api_LocalSubjectAccessReview added in v1.3.0 

func DeepCopy_api_LocalSubjectAccessReview(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_api_Policy added in v1.3.0 

func DeepCopy_api_Policy(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_api_PolicyBinding added in v1.3.0 

func DeepCopy_api_PolicyBinding(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_api_PolicyBindingList added in v1.3.0 

func DeepCopy_api_PolicyBindingList(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_api_PolicyList added in v1.3.0 

func DeepCopy_api_PolicyList(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_api_PolicyRule added in v1.3.0 

func DeepCopy_api_PolicyRule(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_api_PolicyRuleBuilder added in v1.4.0 

func DeepCopy_api_PolicyRuleBuilder(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_api_ResourceAccessReview added in v1.3.0 

func DeepCopy_api_ResourceAccessReview(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_api_ResourceAccessReviewResponse added in v1.3.0 

func DeepCopy_api_ResourceAccessReviewResponse(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_api_Role added in v1.3.0 

func DeepCopy_api_Role(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_api_RoleBinding added in v1.3.0 

func DeepCopy_api_RoleBinding(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_api_RoleBindingList added in v1.3.0 

func DeepCopy_api_RoleBindingList(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_api_RoleBindingRestriction added in v1.4.0 

func DeepCopy_api_RoleBindingRestriction(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_api_RoleBindingRestrictionList added in v1.4.0 

func DeepCopy_api_RoleBindingRestrictionList(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_api_RoleBindingRestrictionSpec added in v1.4.0 

func DeepCopy_api_RoleBindingRestrictionSpec(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_api_RoleList added in v1.3.0 

func DeepCopy_api_RoleList(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_api_SelfSubjectRulesReview added in v1.3.0 

func DeepCopy_api_SelfSubjectRulesReview(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_api_SelfSubjectRulesReviewSpec added in v1.3.0 

func DeepCopy_api_SelfSubjectRulesReviewSpec(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_api_ServiceAccountReference added in v1.4.0 

func DeepCopy_api_ServiceAccountReference(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_api_ServiceAccountRestriction added in v1.4.0 

func DeepCopy_api_ServiceAccountRestriction(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_api_SubjectAccessReview added in v1.3.0 

func DeepCopy_api_SubjectAccessReview(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_api_SubjectAccessReviewResponse added in v1.3.0 

func DeepCopy_api_SubjectAccessReviewResponse(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_api_SubjectRulesReview added in v1.4.0 

func DeepCopy_api_SubjectRulesReview(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_api_SubjectRulesReviewSpec added in v1.4.0 

func DeepCopy_api_SubjectRulesReviewSpec(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_api_SubjectRulesReviewStatus added in v1.3.0 

func DeepCopy_api_SubjectRulesReviewStatus(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_api_UserRestriction added in v1.4.0 

func DeepCopy_api_UserRestriction(in interface{}, out interface{}, c *conversion.Cloner) error

func GetPolicyBindingName added in v0.5.1 

func GetPolicyBindingName(policyRefNamespace string) string

func IsKindOrLegacy 

func IsKindOrLegacy(kind string, gk unversioned.GroupKind) bool

IsKindOrLegacy checks if the provided GroupKind matches with the given kind by looking up the API group and also the legacy API.

func IsResourceOrLegacy 

func IsResourceOrLegacy(resource string, gr unversioned.GroupResource) bool

IsResourceOrLegacy checks if the provided GroupResources matches with the given resource by looking up the API group and also the legacy API.

func Kind added in v1.1.2 

func Kind(kind string) unversioned.GroupKind

Kind takes an unqualified kind and returns back a Group qualified GroupKind

func LegacyKind 

func LegacyKind(kind string) unversioned.GroupKind

LegacyKind takes an unqualified kind and returns back a Group qualified GroupKind

func LegacyResource 

func LegacyResource(resource string) unversioned.GroupResource

LegacyResource takes an unqualified resource and returns back a Group qualified GroupResource using legacy API

func NormalizeResources added in v1.1.1 

func NormalizeResources(rawResources sets.String) sets.String

NormalizeResources expands all resource groups and forces all resources to lower case. If the rawResources are already normalized, it returns the original set to avoid the allocation and GC cost, since this is hit multiple times for every REST call. That means you should NEVER MODIFY THE RESULT of this call.

func PolicyBindingToSelectableFields added in v1.0.8 

func PolicyBindingToSelectableFields(policyBinding *PolicyBinding) fields.Set

PolicyBindingToSelectableFields returns a label set that represents the object changes to the returned keys require registering conversions for existing versions using Scheme.AddFieldLabelConversionFunc

func PolicyToSelectableFields added in v1.0.8 

func PolicyToSelectableFields(policy *Policy) fields.Set

PolicyToSelectableFields returns a label set that represents the object changes to the returned keys require registering conversions for existing versions using Scheme.AddFieldLabelConversionFunc

func RegisterDeepCopies added in v1.4.0 

func RegisterDeepCopies(scheme *runtime.Scheme) error

RegisterDeepCopies adds deep-copy functions to the given scheme. Public to allow building arbitrary schemes.

func Resource added in v1.1.2 

func Resource(resource string) unversioned.GroupResource

Resource takes an unqualified resource and returns back a Group qualified GroupResource

func RoleBindingRestrictionToSelectableFields added in v1.4.0 

func RoleBindingRestrictionToSelectableFields(rbr *RoleBindingRestriction) fields.Set

RoleBindingRestrictionToSelectableFields returns a label set that be used to identify a RoleBindingRestriction object.

func RoleBindingToSelectableFields added in v1.0.8 

func RoleBindingToSelectableFields(roleBinding *RoleBinding) fields.Set

RoleBindingToSelectableFields returns a label set that represents the object changes to the returned keys require registering conversions for existing versions using Scheme.AddFieldLabelConversionFunc

func RoleToSelectableFields added in v1.0.8 

func RoleToSelectableFields(role *Role) fields.Set

RoleToSelectableFields returns a label set that represents the object changes to the returned keys require registering conversions for existing versions using Scheme.AddFieldLabelConversionFunc

func StringSubjectsFor added in v1.0.5 

func StringSubjectsFor(currentNamespace string, subjects []kapi.ObjectReference) ([]string, []string)

StringSubjectsFor returns users and groups for comparison against user.Info. currentNamespace is used to to create usernames for service accounts where namespace=="".

func SubjectsContainAnyGroup added in v1.3.0 

func SubjectsContainAnyGroup(subjects []kapi.ObjectReference, groups []string) bool

SubjectsContainAnyGroup returns true if the provided subjects any of the named groups.

func SubjectsContainUser added in v1.3.0 

func SubjectsContainUser(subjects []kapi.ObjectReference, currentNamespace string, user string) bool

SubjectsContainUser returns true if the provided subjects contain the named user. currentNamespace is used to identify service accounts that are defined in a relative fashion.

func SubjectsStrings added in v1.0.5 

func SubjectsStrings(currentNamespace string, subjects []kapi.ObjectReference) ([]string, []string, []string, []string)

SubjectsStrings returns users, groups, serviceaccounts, unknown for display purposes. currentNamespace is used to hide the subject.Namespace for ServiceAccounts in the currentNamespace

func ToClusterPolicyRef added in v0.5.1 

func ToClusterPolicyRef(in kapi.ObjectReference) kapi.ObjectReference

func ToClusterRoleBindingMap added in v0.5.1 

func ToClusterRoleBindingMap(in map[string]*RoleBinding) map[string]*ClusterRoleBinding

func ToClusterRoleMap added in v0.5.1 

func ToClusterRoleMap(in map[string]*Role) map[string]*ClusterRole

func ToClusterRoleRef added in v0.5.1 

func ToClusterRoleRef(in kapi.ObjectReference) kapi.ObjectReference

func ToPolicyRef added in v0.5.1 

func ToPolicyRef(in kapi.ObjectReference) kapi.ObjectReference

func ToRoleBindingMap added in v0.5.1 

func ToRoleBindingMap(in map[string]*ClusterRoleBinding) map[string]*RoleBinding

func ToRoleMap added in v0.5.1 

func ToRoleMap(in map[string]*ClusterRole) map[string]*Role

func ToRoleRef added in v0.5.1 

func ToRoleRef(in kapi.ObjectReference) kapi.ObjectReference

Types

type Action added in v1.3.0 

type Action struct {
	// Namespace is the namespace of the action being requested.  Currently, there is no distinction between no namespace and all namespaces
	Namespace string
	// Verb is one of: get, list, watch, create, update, delete
	Verb string
	// Group is the API group of the resource
	Group string
	// Version is the API version of the resource
	Version string
	// Resource is one of the existing resource types
	Resource string
	// ResourceName is the name of the resource being requested for a "get" or deleted for a "delete"
	ResourceName string
	// Path is the path of a non resource URL
	Path string
	// IsNonResourceURL is true if this is a request for a non-resource URL (outside of the resource hieraarchy)
	IsNonResourceURL bool
	// Content is the actual content of the request for create and update
	Content kruntime.Object
}

Action describes a request to be authorized

type ClusterPolicy added in v0.5.1 

type ClusterPolicy struct {
	unversioned.TypeMeta
	// Standard object's metadata.
	kapi.ObjectMeta

	// LastModified is the last time that any part of the ClusterPolicy was created, updated, or deleted
	LastModified unversioned.Time

	// Roles holds all the ClusterRoles held by this ClusterPolicy, mapped by Role.Name
	Roles ClusterRolesByName
}

ClusterPolicy is a object that holds all the ClusterRoles for a particular namespace. There is at most one ClusterPolicy document per namespace.

func ToClusterPolicy added in v0.5.1 

func ToClusterPolicy(in *Policy) *ClusterPolicy

type ClusterPolicyBinding added in v0.5.1 

type ClusterPolicyBinding struct {
	unversioned.TypeMeta
	// Standard object's metadata.
	kapi.ObjectMeta

	// LastModified is the last time that any part of the ClusterPolicyBinding was created, updated, or deleted
	LastModified unversioned.Time

	// ClusterPolicyRef is a reference to the ClusterPolicy that contains all the ClusterRoles that this ClusterPolicyBinding's RoleBindings may reference
	PolicyRef kapi.ObjectReference
	// RoleBindings holds all the RoleBindings held by this ClusterPolicyBinding, mapped by RoleBinding.Name
	RoleBindings ClusterRoleBindingsByName
}

ClusterPolicyBinding is a object that holds all the ClusterRoleBindings for a particular namespace. There is one ClusterPolicyBinding document per referenced ClusterPolicy namespace

func ToClusterPolicyBinding added in v0.5.1 

func ToClusterPolicyBinding(in *PolicyBinding) *ClusterPolicyBinding

type ClusterPolicyBindingList added in v0.5.1 

type ClusterPolicyBindingList struct {
	unversioned.TypeMeta
	// Standard object's metadata.
	unversioned.ListMeta

	// Items is a list of ClusterPolicyBindings
	Items []ClusterPolicyBinding
}

ClusterPolicyBindingList is a collection of ClusterPolicyBindings

func ToClusterPolicyBindingList added in v0.5.1 

func ToClusterPolicyBindingList(in *PolicyBindingList) *ClusterPolicyBindingList

type ClusterPolicyList added in v0.5.1 

type ClusterPolicyList struct {
	unversioned.TypeMeta
	// Standard object's metadata.
	unversioned.ListMeta

	// Items is a list of ClusterPolicies
	Items []ClusterPolicy
}

ClusterPolicyList is a collection of ClusterPolicies

func ToClusterPolicyList added in v0.5.1 

func ToClusterPolicyList(in *PolicyList) *ClusterPolicyList

type ClusterRole added in v0.5.1 

type ClusterRole struct {
	unversioned.TypeMeta
	// Standard object's metadata.
	kapi.ObjectMeta

	// Rules holds all the PolicyRules for this ClusterRole
	Rules []PolicyRule
}

ClusterRole is a logical grouping of PolicyRules that can be referenced as a unit by ClusterRoleBindings.

func ToClusterRole added in v0.5.1 

func ToClusterRole(in *Role) *ClusterRole

type ClusterRoleBinding added in v0.5.1 

type ClusterRoleBinding struct {
	unversioned.TypeMeta
	// Standard object's metadata.
	kapi.ObjectMeta

	// Subjects hold object references of to authorize with this rule
	Subjects []kapi.ObjectReference

	// RoleRef can only reference the current namespace and the global namespace
	// If the ClusterRoleRef cannot be resolved, the Authorizer must return an error.
	// Since Policy is a singleton, this is sufficient knowledge to locate a role
	RoleRef kapi.ObjectReference
}

ClusterRoleBinding references a ClusterRole, but not contain it. It can reference any ClusterRole in the same namespace or in the global namespace. It adds who information via Users and Groups and namespace information by which namespace it exists in. ClusterRoleBindings in a given namespace only have effect in that namespace (excepting the master namespace which has power in all namespaces).

func ToClusterRoleBinding added in v0.5.1 

func ToClusterRoleBinding(in *RoleBinding) *ClusterRoleBinding

type ClusterRoleBindingList added in v0.5.1 

type ClusterRoleBindingList struct {
	unversioned.TypeMeta
	// Standard object's metadata.
	unversioned.ListMeta

	// Items is a list of ClusterRoleBindings
	Items []ClusterRoleBinding
}

ClusterRoleBindingList is a collection of ClusterRoleBindings

func ToClusterRoleBindingList added in v0.5.1 

func ToClusterRoleBindingList(in *RoleBindingList) *ClusterRoleBindingList

type ClusterRoleBindingsByName added in v1.3.0 

type ClusterRoleBindingsByName map[string]*ClusterRoleBinding

type ClusterRoleList added in v0.5.1 

type ClusterRoleList struct {
	unversioned.TypeMeta
	// Standard object's metadata.
	unversioned.ListMeta

	// Items is a list of ClusterRoles
	Items []ClusterRole
}

ClusterRoleList is a collection of ClusterRoles

func ToClusterRoleList added in v0.5.1 

func ToClusterRoleList(in *RoleList) *ClusterRoleList

type ClusterRolesByName added in v1.3.0 

type ClusterRolesByName map[string]*ClusterRole

type GroupRestriction added in v1.4.0 

type GroupRestriction struct {
	// Groups specifies a list of literal group names.
	Groups []string

	// Selectors specifies a list of label selectors over group labels.
	Selectors []unversioned.LabelSelector
}

GroupRestriction matches a group either by a string match on the group name or a label selector applied to group labels.

type IsPersonalSubjectAccessReview added in v0.4.2 

type IsPersonalSubjectAccessReview struct {
	unversioned.TypeMeta
}

IsPersonalSubjectAccessReview is a marker for PolicyRule.AttributeRestrictions that denotes that subjectaccessreviews on self should be allowed

type LocalResourceAccessReview added in v1.0.5 

type LocalResourceAccessReview struct {
	unversioned.TypeMeta

	// Action describes the action being tested
	Action
}

LocalResourceAccessReview is a means to request a list of which users and groups are authorized to perform the action specified by spec in a particular namespace

type LocalSubjectAccessReview added in v1.0.5 

type LocalSubjectAccessReview struct {
	unversioned.TypeMeta

	// Action describes the action being tested.  The Namespace element is FORCED to the current namespace.
	Action
	// User is optional.  If both User and Groups are empty, the current authenticated user is used.
	User string
	// Groups is optional.  Groups is the list of groups to which the User belongs.
	// +k8s:conversion-gen=false
	Groups sets.String
	// Scopes to use for the evaluation.  Empty means "use the unscoped (full) permissions of the user/groups".
	// Nil for a self-SAR, means "use the scopes on this request".
	// Nil for a regular SAR, means the same as empty.
	Scopes []string
}

LocalSubjectAccessReview is an object for requesting information about whether a user or group can perform an action in a particular namespace

func AddUserToLSAR added in v1.3.0 

func AddUserToLSAR(user user.Info, lsar *LocalSubjectAccessReview) *LocalSubjectAccessReview

type Policy 

type Policy struct {
	unversioned.TypeMeta
	kapi.ObjectMeta

	// LastModified is the last time that any part of the Policy was created, updated, or deleted
	LastModified unversioned.Time

	// Roles holds all the Roles held by this Policy, mapped by Role.Name
	Roles RolesByName
}

Policy is a object that holds all the Roles for a particular namespace. There is at most one Policy document per namespace.

func ToPolicy added in v0.5.1 

func ToPolicy(in *ClusterPolicy) *Policy

type PolicyBinding 

type PolicyBinding struct {
	unversioned.TypeMeta
	// Standard object's metadata.
	kapi.ObjectMeta

	// LastModified is the last time that any part of the PolicyBinding was created, updated, or deleted
	LastModified unversioned.Time

	// PolicyRef is a reference to the Policy that contains all the Roles that this PolicyBinding's RoleBindings may reference
	PolicyRef kapi.ObjectReference
	// RoleBindings holds all the RoleBindings held by this PolicyBinding, mapped by RoleBinding.Name
	RoleBindings RoleBindingsByName
}

PolicyBinding is a object that holds all the RoleBindings for a particular namespace. There is one PolicyBinding document per referenced Policy namespace

func ToPolicyBinding added in v0.5.1 

func ToPolicyBinding(in *ClusterPolicyBinding) *PolicyBinding

type PolicyBindingList 

type PolicyBindingList struct {
	unversioned.TypeMeta
	// Standard object's metadata.
	unversioned.ListMeta

	// Items is a list of policyBindings
	Items []PolicyBinding
}

PolicyBindingList is a collection of PolicyBindings

func ToPolicyBindingList added in v0.5.1 

func ToPolicyBindingList(in *ClusterPolicyBindingList) *PolicyBindingList

type PolicyBindingSorter added in v0.5.1 

type PolicyBindingSorter []PolicyBinding

func (PolicyBindingSorter) Len added in v0.5.1 

func (s PolicyBindingSorter) Len() int

func (PolicyBindingSorter) Less added in v0.5.1 

func (s PolicyBindingSorter) Less(i, j int) bool

func (PolicyBindingSorter) Swap added in v0.5.1 

func (s PolicyBindingSorter) Swap(i, j int)

type PolicyList 

type PolicyList struct {
	unversioned.TypeMeta
	// Standard object's metadata.
	unversioned.ListMeta

	// Items is a list of policies
	Items []Policy
}

PolicyList is a collection of Policies

func ToPolicyList added in v0.5.1 

func ToPolicyList(in *ClusterPolicyList) *PolicyList

type PolicyRule 

type PolicyRule struct {
	// Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule.  VerbAll represents all kinds.
	Verbs sets.String
	// AttributeRestrictions will vary depending on what the Authorizer/AuthorizationAttributeBuilder pair supports.
	// If the Authorizer does not recognize how to handle the AttributeRestrictions, the Authorizer should report an error.
	AttributeRestrictions kruntime.Object
	// APIGroups is the name of the APIGroup that contains the resources.  If this field is empty, then both kubernetes and origin API groups are assumed.
	// That means that if an action is requested against one of the enumerated resources in either the kubernetes or the origin API group, the request
	// will be allowed
	APIGroups []string
	// Resources is a list of resources this rule applies to.  ResourceAll represents all resources.
	Resources sets.String
	// ResourceNames is an optional white list of names that the rule applies to.  An empty set means that everything is allowed.
	ResourceNames sets.String
	// NonResourceURLs is a set of partial urls that a user should have access to.  *s are allowed, but only as the full, final step in the path
	// If an action is not a resource API request, then the URL is split on '/' and is checked against the NonResourceURLs to look for a match.
	NonResourceURLs sets.String
}

PolicyRule holds information that describes a policy rule, but does not contain information about who the rule applies to or which namespace the rule applies to.

func (PolicyRule) CompactString added in v1.3.0 

func (r PolicyRule) CompactString() string

CompactString exposes a compact string representation for use in escalation error messages

func (PolicyRule) String added in v0.3.2 

func (r PolicyRule) String() string

type PolicyRuleBuilder added in v1.3.0 

type PolicyRuleBuilder struct {
	PolicyRule PolicyRule
}

+gencopy=false PolicyRuleBuilder let's us attach methods. A no-no for API types

func NewRule added in v1.3.0 

func NewRule(verbs ...string) *PolicyRuleBuilder

func (*PolicyRuleBuilder) Groups added in v1.3.0 

func (r *PolicyRuleBuilder) Groups(groups ...string) *PolicyRuleBuilder

func (*PolicyRuleBuilder) Names added in v1.3.0 

func (r *PolicyRuleBuilder) Names(names ...string) *PolicyRuleBuilder

func (*PolicyRuleBuilder) Resources added in v1.3.0 

func (r *PolicyRuleBuilder) Resources(resources ...string) *PolicyRuleBuilder

func (*PolicyRuleBuilder) Rule added in v1.3.0 

func (r *PolicyRuleBuilder) Rule() (PolicyRule, error)

func (*PolicyRuleBuilder) RuleOrDie added in v1.3.0 

func (r *PolicyRuleBuilder) RuleOrDie() PolicyRule

type ResourceAccessReview added in v0.3.1 

type ResourceAccessReview struct {
	unversioned.TypeMeta

	// Action describes the action being tested
	Action
}

ResourceAccessReview is a means to request a list of which users and groups are authorized to perform the action specified by spec

type ResourceAccessReviewResponse added in v0.3.1 

type ResourceAccessReviewResponse struct {
	unversioned.TypeMeta

	// Namespace is the namespace used for the access review
	Namespace string
	// Users is the list of users who can perform the action
	// +k8s:conversion-gen=false
	Users sets.String
	// Groups is the list of groups who can perform the action
	// +k8s:conversion-gen=false
	Groups sets.String

	// EvaluationError is an indication that some error occurred during resolution, but partial results can still be returned.
	// It is entirely possible to get an error and be able to continue determine authorization status in spite of it.  This is
	// most common when a bound role is missing, but enough roles are still present and bound to reason about the request.
	EvaluationError string
}

ResourceAccessReviewResponse describes who can perform the action

type Role 

type Role struct {
	unversioned.TypeMeta
	// Standard object's metadata.
	kapi.ObjectMeta

	// Rules holds all the PolicyRules for this Role
	Rules []PolicyRule
}

Role is a logical grouping of PolicyRules that can be referenced as a unit by RoleBindings.

func ToRole added in v0.5.1 

func ToRole(in *ClusterRole) *Role

type RoleBinding 

type RoleBinding struct {
	unversioned.TypeMeta
	kapi.ObjectMeta

	// Subjects hold object references of to authorize with this rule
	Subjects []kapi.ObjectReference

	// RoleRef can only reference the current namespace and the global namespace
	// If the RoleRef cannot be resolved, the Authorizer must return an error.
	// Since Policy is a singleton, this is sufficient knowledge to locate a role
	RoleRef kapi.ObjectReference
}

RoleBinding references a Role, but not contain it. It can reference any Role in the same namespace or in the global namespace. It adds who information via Users and Groups and namespace information by which namespace it exists in. RoleBindings in a given namespace only have effect in that namespace (excepting the master namespace which has power in all namespaces).

func SortRoleBindings added in v0.5.1 

func SortRoleBindings(roleBindingMap map[string]*RoleBinding, reverse bool) []*RoleBinding

func ToRoleBinding added in v0.5.1 

func ToRoleBinding(in *ClusterRoleBinding) *RoleBinding

type RoleBindingList added in v0.3.2 

type RoleBindingList struct {
	unversioned.TypeMeta
	// Standard object's metadata.
	unversioned.ListMeta

	// Items is a list of roleBindings
	Items []RoleBinding
}

RoleBindingList is a collection of RoleBindings

func ToRoleBindingList added in v0.5.1 

func ToRoleBindingList(in *ClusterRoleBindingList) *RoleBindingList

type RoleBindingRestriction added in v1.4.0 

type RoleBindingRestriction struct {
	unversioned.TypeMeta

	// Standard object's metadata.
	kapi.ObjectMeta

	// Spec defines the matcher.
	Spec RoleBindingRestrictionSpec
}

RoleBindingRestriction is an object that can be matched against a subject (user, group, or service account) to determine whether rolebindings on that subject are allowed in the namespace to which the RoleBindingRestriction belongs. If any one of those RoleBindingRestriction objects matches a subject, rolebindings on that subject in the namespace are allowed.

type RoleBindingRestrictionList added in v1.4.0 

type RoleBindingRestrictionList struct {
	unversioned.TypeMeta

	// Standard object's metadata.
	unversioned.ListMeta

	// Items is a list of RoleBindingRestriction objects.
	Items []RoleBindingRestriction
}

RoleBindingRestrictionList is a collection of RoleBindingRestriction objects.

type RoleBindingRestrictionSpec added in v1.4.0 

type RoleBindingRestrictionSpec struct {
	// UserRestriction matches against user subjects.
	UserRestriction *UserRestriction

	// GroupRestriction matches against group subjects.
	GroupRestriction *GroupRestriction

	// ServiceAccountRestriction matches against service-account subjects.
	ServiceAccountRestriction *ServiceAccountRestriction
}

RoleBindingRestrictionSpec defines a rolebinding restriction. Exactly one field must be non-nil.

type RoleBindingSorter added in v0.5.1 

type RoleBindingSorter []*RoleBinding

func (RoleBindingSorter) Len added in v0.5.1 

func (s RoleBindingSorter) Len() int

func (RoleBindingSorter) Less added in v0.5.1 

func (s RoleBindingSorter) Less(i, j int) bool

func (RoleBindingSorter) Swap added in v0.5.1 

func (s RoleBindingSorter) Swap(i, j int)

type RoleBindingsByName added in v1.3.0 

type RoleBindingsByName map[string]*RoleBinding

type RoleList added in v0.4.2 

type RoleList struct {
	unversioned.TypeMeta
	// Standard object's metadata.
	unversioned.ListMeta

	// Items is a list of roles
	Items []Role
}

RoleList is a collection of Roles

func ToRoleList added in v0.5.1 

func ToRoleList(in *ClusterRoleList) *RoleList

type RolesByName added in v1.3.0 

type RolesByName map[string]*Role

type SelfSubjectRulesReview added in v1.3.0 

type SelfSubjectRulesReview struct {
	unversioned.TypeMeta

	// Spec adds information about how to conduct the check
	Spec SelfSubjectRulesReviewSpec

	// Status is completed by the server to tell which permissions you have
	Status SubjectRulesReviewStatus
}

SelfSubjectRulesReview is a resource you can create to determine which actions you can perform in a namespace

type SelfSubjectRulesReviewSpec added in v1.3.0 

type SelfSubjectRulesReviewSpec struct {
	// Scopes to use for the evaluation.  Empty means "use the unscoped (full) permissions of the user/groups".
	// Nil for a self-SubjectRulesReview, means "use the scopes on this request".
	// Nil for a regular SubjectRulesReview, means the same as empty.
	Scopes []string
}

SelfSubjectRulesReviewSpec adds information about how to conduct the check

type ServiceAccountReference added in v1.4.0 

type ServiceAccountReference struct {
	// Name is the name of the service account.
	Name string

	// Namespace is the namespace of the service account.  Service accounts from
	// inside the whitelisted namespaces are allowed to be bound to roles.  If
	// Namespace is empty, then the namespace of the RoleBindingRestriction in
	// which the ServiceAccountReference is embedded is used.
	Namespace string
}

ServiceAccountReference specifies a service account and namespace by their names.

type ServiceAccountRestriction added in v1.4.0 

type ServiceAccountRestriction struct {
	// ServiceAccounts specifies a list of literal service-account names.
	ServiceAccounts []ServiceAccountReference

	// Namespaces specifies a list of literal namespace names.  ServiceAccounts
	// from inside the whitelisted namespaces are allowed to be bound to roles.
	Namespaces []string
}

ServiceAccountRestriction matches a service account by a string match on either the service-account name or the name of the service account's namespace.

type SortableRuleSlice added in v1.3.0 

type SortableRuleSlice []PolicyRule

func (SortableRuleSlice) Len added in v1.3.0 

func (s SortableRuleSlice) Len() int

func (SortableRuleSlice) Less added in v1.3.0 

func (s SortableRuleSlice) Less(i, j int) bool

func (SortableRuleSlice) Swap added in v1.3.0 

func (s SortableRuleSlice) Swap(i, j int)

type SubjectAccessReview added in v0.3.1 

type SubjectAccessReview struct {
	unversioned.TypeMeta

	// Action describes the action being tested
	Action
	// User is optional.  If both User and Groups are empty, the current authenticated user is used.
	User string
	// Groups is optional.  Groups is the list of groups to which the User belongs.
	// +k8s:conversion-gen=false
	Groups sets.String
	// Scopes to use for the evaluation.  Empty means "use the unscoped (full) permissions of the user/groups".
	// Nil for a self-SAR, means "use the scopes on this request".
	// Nil for a regular SAR, means the same as empty.
	Scopes []string
}

SubjectAccessReview is an object for requesting information about whether a user or group can perform an action

func AddUserToSAR added in v1.3.0 

func AddUserToSAR(user user.Info, sar *SubjectAccessReview) *SubjectAccessReview

type SubjectAccessReviewResponse added in v0.3.1 

type SubjectAccessReviewResponse struct {
	unversioned.TypeMeta

	// Namespace is the namespace used for the access review
	Namespace string
	// Allowed is required.  True if the action would be allowed, false otherwise.
	Allowed bool
	// Reason is optional.  It indicates why a request was allowed or denied.
	Reason string
	// EvaluationError is an indication that some error occurred during the authorization check.
	// It is entirely possible to get an error and be able to continue determine authorization status in spite of it.  This is
	// most common when a bound role is missing, but enough roles are still present and bound to reason about the request.
	EvaluationError string
}

SubjectAccessReviewResponse describes whether or not a user or group can perform an action

type SubjectRulesReview added in v1.4.0 

type SubjectRulesReview struct {
	unversioned.TypeMeta

	// Spec adds information about how to conduct the check
	Spec SubjectRulesReviewSpec

	// Status is completed by the server to tell which permissions you have
	Status SubjectRulesReviewStatus
}

SubjectRulesReview is a resource you can create to determine which actions another user can perform in a namespace

type SubjectRulesReviewSpec added in v1.4.0 

type SubjectRulesReviewSpec struct {
	// User is optional.  At least one of User and Groups must be specified.
	User string
	// Groups is optional.  Groups is the list of groups to which the User belongs.  At least one of User and Groups must be specified.
	Groups []string
	// Scopes to use for the evaluation.  Empty means "use the unscoped (full) permissions of the user/groups".
	Scopes []string
}

SubjectRulesReviewSpec adds information about how to conduct the check

type SubjectRulesReviewStatus added in v1.3.0 

type SubjectRulesReviewStatus struct {
	// Rules is the list of rules (no particular sort) that are allowed for the subject
	Rules []PolicyRule
	// EvaluationError can appear in combination with Rules.  It means some error happened during evaluation
	// that may have prevented additional rules from being populated.
	EvaluationError string
}

SubjectRulesReviewStatus is contains the result of a rules check

type UserRestriction added in v1.4.0 

type UserRestriction struct {
	// Users specifies a list of literal user names.
	Users []string

	// Groups is a list of groups used to match against an individual user's
	// groups. If the user is a member of one of the whitelisted groups, the user
	// is allowed to be bound to a role.
	Groups []string

	// Selectors specifies a list of label selectors over user labels.
	Selectors []unversioned.LabelSelector
}

UserRestriction matches a user either by a string match on the user name, a string match on the name of a group to which the user belongs, or a label selector applied to the user labels.

Source Files

View all Source files

Directories

Path Synopsis
Package v1 is the v1 version of the API.
 Package v1 is the v1 version of the API.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.