v1alpha1

package
v0.11.2 Latest Latest
Warning

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

 Go to latest Published: Nov 8, 2024 License: Apache-2.0 Imports: 5 Imported by: 6

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the authentication v1alpha1 API group +kubebuilder:object:generate=true +groupName=authentication.zncdata.dev

Index

Constants

This section is empty.

Variables

View Source 
var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "authentication.zncdata.dev", Version: "v1alpha1"}

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
	SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion}

	// AddToScheme adds the types in this group-version to the given scheme.
	AddToScheme = SchemeBuilder.AddToScheme
)

Functions

This section is empty.

Types

type AuthenticationClass 

type AuthenticationClass struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   AuthenticationClassSpec   `json:"spec,omitempty"`
	Status AuthenticationClassStatus `json:"status,omitempty"`
}

AuthenticationClass is the Schema for the authenticationclasses API

func (*AuthenticationClass) DeepCopy 

func (in *AuthenticationClass) DeepCopy() *AuthenticationClass

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AuthenticationClass.

func (*AuthenticationClass) DeepCopyInto 

func (in *AuthenticationClass) DeepCopyInto(out *AuthenticationClass)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*AuthenticationClass) DeepCopyObject 

func (in *AuthenticationClass) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type AuthenticationClassList 

type AuthenticationClassList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []AuthenticationClass `json:"items"`
}

AuthenticationClassList contains a list of AuthenticationClass

func (*AuthenticationClassList) DeepCopy 

func (in *AuthenticationClassList) DeepCopy() *AuthenticationClassList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AuthenticationClassList.

func (*AuthenticationClassList) DeepCopyInto 

func (in *AuthenticationClassList) DeepCopyInto(out *AuthenticationClassList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*AuthenticationClassList) DeepCopyObject 

func (in *AuthenticationClassList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type AuthenticationClassSpec 

type AuthenticationClassSpec struct {
	// +kubebuilder:validation:Required
	AuthenticationProvider *AuthenticationProvider `json:"provider,omitempty"`
}

AuthenticationClassSpec defines the desired state of AuthenticationClass

func (*AuthenticationClassSpec) DeepCopy 

func (in *AuthenticationClassSpec) DeepCopy() *AuthenticationClassSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AuthenticationClassSpec.

func (*AuthenticationClassSpec) DeepCopyInto 

func (in *AuthenticationClassSpec) DeepCopyInto(out *AuthenticationClassSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type AuthenticationClassStatus 

type AuthenticationClassStatus struct {
}

AuthenticationClassStatus defines the observed state of AuthenticationClass

func (*AuthenticationClassStatus) DeepCopy 

func (in *AuthenticationClassStatus) DeepCopy() *AuthenticationClassStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AuthenticationClassStatus.

func (*AuthenticationClassStatus) DeepCopyInto 

func (in *AuthenticationClassStatus) DeepCopyInto(out *AuthenticationClassStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type AuthenticationProvider 

type AuthenticationProvider struct {
	// +kubebuilder:validation:Optional
	OIDC *OIDCProvider `json:"oidc,omitempty"`

	// +kubebuilder:validation:Optional
	TLS *TLSProvider `json:"tls,omitempty"`

	// +kubebuilder:validation:Optional
	Static *StaticProvider `json:"static,omitempty"`

	// +kubebuilder:validation:Optional
	LDAP *LDAPProvider `json:"ldap,omitempty"`
}

func (*AuthenticationProvider) DeepCopy 

func (in *AuthenticationProvider) DeepCopy() *AuthenticationProvider

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AuthenticationProvider.

func (*AuthenticationProvider) DeepCopyInto 

func (in *AuthenticationProvider) DeepCopyInto(out *AuthenticationProvider)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type AuthenticationSpec added in v0.11.0 

type AuthenticationSpec struct {
	// +kubebuilder:validation:Required
	AuthenticationClass string `json:"authenticationClass"`

	// +kubebuilder:validation:Optional
	Oidc *OidcSpec `json:"oidc,omitempty"`
}

func (*AuthenticationSpec) DeepCopy added in v0.11.0 

func (in *AuthenticationSpec) DeepCopy() *AuthenticationSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AuthenticationSpec.

func (*AuthenticationSpec) DeepCopyInto added in v0.11.0 

func (in *AuthenticationSpec) DeepCopyInto(out *AuthenticationSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type LDAPFieldNames 

type LDAPFieldNames struct {
	// +kubebuilder:validation:Optional
	Email string `json:"email,omitempty"`

	// +kubebuilder:validation:Optional
	GivenName string `json:"givenName,omitempty"`

	// +kubebuilder:validation:Optional
	Group string `json:"group,omitempty"`

	// +kubebuilder:validation:Optional
	Surname string `json:"surname,omitempty"`

	// +kubebuilder:validation:Optional
	Uid string `json:"uid,omitempty"`
}

func (*LDAPFieldNames) DeepCopy 

func (in *LDAPFieldNames) DeepCopy() *LDAPFieldNames

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new LDAPFieldNames.

func (*LDAPFieldNames) DeepCopyInto 

func (in *LDAPFieldNames) DeepCopyInto(out *LDAPFieldNames)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type LDAPProvider 

type LDAPProvider struct {
	// Provide ldap credentials mounts for Pods via k8s-search secret-class.
	// The secret searched by k8s-search must contain the following data:
	//  - user: bind user, e.g. cn=admin,dc=example,dc=com
	//  - password: bind password
	// +kubebuilder:validation:Required
	BindCredentials *commonsv1alpha1.Credentials `json:"bindCredentials"`

	// +kubebuilder:validation:Required
	Hostname string `json:"hostname"`

	// +kubebuilder:validation:Optional
	Port int `json:"port,omitempty"`

	// +kubebuilder:validation:Optional
	LDAPFieldNames *LDAPFieldNames `json:"ldapFieldNames,omitempty"`

	// LDAP search base, for example: ou=users,dc=example,dc=com.
	// +kubebuilder:validation:Optional
	SearchBase string `json:"searchBase,omitempty"`

	// LDAP search filter, for example: (ou=teams,dc=example,dc=com).
	// +kubebuilder:validation:Optional
	SearchFilter string `json:"searchFilter,omitempty"`

	// +kubebuilder:validation:Optional
	TLS *LDAPTLS `json:"tls,omitempty"`
}

func (*LDAPProvider) DeepCopy 

func (in *LDAPProvider) DeepCopy() *LDAPProvider

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new LDAPProvider.

func (*LDAPProvider) DeepCopyInto 

func (in *LDAPProvider) DeepCopyInto(out *LDAPProvider)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type LDAPTLS added in v0.9.1 

type LDAPTLS struct {
	// +kubebuilder:validation:Required
	Verification *commonsv1alpha1.TLSVerificationSpec `json:"verification"`
}

func (*LDAPTLS) DeepCopy added in v0.9.1 

func (in *LDAPTLS) DeepCopy() *LDAPTLS

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new LDAPTLS.

func (*LDAPTLS) DeepCopyInto added in v0.9.1 

func (in *LDAPTLS) DeepCopyInto(out *LDAPTLS)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type OIDCProvider 

type OIDCProvider struct {

	// +kubebuilder:validation:Required
	Hostname string `json:"hostname"`

	// +kubebuilder:validation:Optional
	Port int `json:"port,omitempty"`

	// +kubebuilder:validation:Required
	PrincipalClaim string `json:"principalClaim"`

	// +kubebuilder:validation:Required
	// +kubebuilder:validation:Enum=keycloak
	ProviderHint string `json:"providerHint"`

	// +kubebuilder:validation:Optional
	RootPath string `json:"rootPath,omitempty"`

	// +kubebuilder:validation:Optional
	Scopes []string `json:"scopes,omitempty"`

	// +kubebuilder:validation:Optional
	TLS *OIDCTls `json:"tls,omitempty"`
}

func (*OIDCProvider) DeepCopy 

func (in *OIDCProvider) DeepCopy() *OIDCProvider

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OIDCProvider.

func (*OIDCProvider) DeepCopyInto 

func (in *OIDCProvider) DeepCopyInto(out *OIDCProvider)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type OIDCTls added in v0.9.1 

type OIDCTls struct {
	// +kubebuilder:validation
	Verification *commonsv1alpha1.TLSVerificationSpec `json:"verification"`
}

func (*OIDCTls) DeepCopy added in v0.9.1 

func (in *OIDCTls) DeepCopy() *OIDCTls

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OIDCTls.

func (*OIDCTls) DeepCopyInto added in v0.9.1 

func (in *OIDCTls) DeepCopyInto(out *OIDCTls)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type OidcSpec added in v0.11.0 

type OidcSpec struct {
	// OIDC client credentials secret. It must contain the following keys:
	//   - `CLIENT_ID`: The client ID of the OIDC client.
	//   - `CLIENT_SECRET`: The client secret of the OIDC client.
	// credentials will omit to pod environment variables.
	// +kubebuilder:validation:Required
	ClientCredentialsSecret string `json:"clientCredentialsSecret"`

	// Extra scopes to request during the OIDC flow. e.g. `["email", "profile"]`
	// +kubebuilder:validation:Optional
	ExtraScopes []string `json:"extraScopes,omitempty"`
}

OidcSpec defines the OIDC spec.

func (*OidcSpec) DeepCopy added in v0.11.0 

func (in *OidcSpec) DeepCopy() *OidcSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OidcSpec.

func (*OidcSpec) DeepCopyInto added in v0.11.0 

func (in *OidcSpec) DeepCopyInto(out *OidcSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ResponseType 

type ResponseType string
const (
	ResponseTypeCode  ResponseType = "code"
	ResponseTypeToken ResponseType = "id_token"
)

type StaticCredentialsSecret added in v0.9.1 

type StaticCredentialsSecret struct {
	// The secret name that contains the user credentials.
	// The data contained in secret is related to the data required for the specific product certification function.
	// +kubebuilder:validation:Required
	Name string `json:"name"`
}

func (*StaticCredentialsSecret) DeepCopy added in v0.9.1 

func (in *StaticCredentialsSecret) DeepCopy() *StaticCredentialsSecret

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StaticCredentialsSecret.

func (*StaticCredentialsSecret) DeepCopyInto added in v0.9.1 

func (in *StaticCredentialsSecret) DeepCopyInto(out *StaticCredentialsSecret)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type StaticProvider 

type StaticProvider struct {
	// +kubebuilder:validation:Required
	UserCredentialsSecret *StaticCredentialsSecret `json:"userCredentialsSecret"`
}

func (*StaticProvider) DeepCopy 

func (in *StaticProvider) DeepCopy() *StaticProvider

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StaticProvider.

func (*StaticProvider) DeepCopyInto 

func (in *StaticProvider) DeepCopyInto(out *StaticProvider)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type TLSProvider added in v0.9.1 

type TLSProvider struct {
	// +kubebuilder:validation:Required
	ClientCertSecretClass string `json:"clientCertSecretClass"`
}

func (*TLSProvider) DeepCopy added in v0.9.1 

func (in *TLSProvider) DeepCopy() *TLSProvider

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TLSProvider.

func (*TLSProvider) DeepCopyInto added in v0.9.1 

func (in *TLSProvider) DeepCopyInto(out *TLSProvider)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

Source Files

View all Source files

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.