upstreamwatchers

Documentation

Index

• Constants
• func EvaluateConditions(conditions GradatedConditions, config *upstreamldap.ProviderConfig) (provider.UpstreamLDAPIdentityProviderI, bool)
• func TestConnection(ctx context.Context, bindSecretName string, ...) *v1alpha1.Condition
• func ValidateSecret(secretInformer corev1informers.SecretInformer, secretName string, ...) (*v1alpha1.Condition, string)
• func ValidateTLSConfig(tlsSpec *v1alpha1.TLSSpec, config *upstreamldap.ProviderConfig) *v1alpha1.Condition
• type GradatedConditions
  • func ValidateGenericLDAP(ctx context.Context, upstream UpstreamGenericLDAPIDP, ...) GradatedConditions
  • func (g *GradatedConditions) Append(condition *v1alpha1.Condition, isFatal bool)
  • func (g *GradatedConditions) Conditions() []*v1alpha1.Condition
• type UpstreamGenericLDAPGroupSearch
• type UpstreamGenericLDAPIDP
• type UpstreamGenericLDAPSpec
• type UpstreamGenericLDAPStatus
• type UpstreamGenericLDAPUserSearch
• type ValidatedSettings
• type ValidatedSettingsCache
  • func (s *ValidatedSettingsCache) Get(upstreamName, resourceVersion string, idpSpecGeneration int64) (ValidatedSettings, bool)
  • func (s *ValidatedSettingsCache) Set(upstreamName string, settings ValidatedSettings)
• type ValidatedSettingsCacheI
  • func NewValidatedSettingsCache() ValidatedSettingsCacheI

Constants

const (
	ReasonNotFound         = "SecretNotFound"
	ReasonWrongType        = "SecretWrongType"
	ReasonMissingKeys      = "SecretMissingKeys"
	ReasonSuccess          = "Success"
	ReasonInvalidTLSConfig = "InvalidTLSConfig"

	ErrNoCertificates = constable.Error("no certificates found")

	LDAPBindAccountSecretType = corev1.SecretTypeBasicAuth

	TypeSearchBaseFound = "SearchBaseFound"

	ReasonUsingConfigurationFromSpec = "UsingConfigurationFromSpec"
	ReasonErrorFetchingSearchBase    = "ErrorFetchingSearchBase"
)

Functions

func EvaluateConditions

func EvaluateConditions(conditions GradatedConditions, config *upstreamldap.ProviderConfig) (provider.UpstreamLDAPIdentityProviderI, bool)

func TestConnection

func TestConnection(
	ctx context.Context,
	bindSecretName string,
	config *upstreamldap.ProviderConfig,
	currentSecretVersion string,
) *v1alpha1.Condition

func ValidateSecret

func ValidateSecret(secretInformer corev1informers.SecretInformer, secretName string, secretNamespace string, config *upstreamldap.ProviderConfig) (*v1alpha1.Condition, string)

func ValidateTLSConfig

func ValidateTLSConfig(tlsSpec *v1alpha1.TLSSpec, config *upstreamldap.ProviderConfig) *v1alpha1.Condition

Types

type GradatedConditions

type GradatedConditions struct {
	// contains filtered or unexported fields
}

GradatedConditions is a list of conditions, where each condition can additionally be considered fatal or non-fatal.

func ValidateGenericLDAP

func ValidateGenericLDAP(
	ctx context.Context,
	upstream UpstreamGenericLDAPIDP,
	secretInformer corev1informers.SecretInformer,
	validatedSettingsCache ValidatedSettingsCacheI,
	config *upstreamldap.ProviderConfig,
) GradatedConditions

func (*GradatedConditions) Append

func (g *GradatedConditions) Append(condition *v1alpha1.Condition, isFatal bool)

func (*GradatedConditions) Conditions

func (g *GradatedConditions) Conditions() []*v1alpha1.Condition

type UpstreamGenericLDAPGroupSearch

type UpstreamGenericLDAPGroupSearch interface {
	Base() string
	Filter() string
	GroupNameAttribute() string
}

type UpstreamGenericLDAPIDP

type UpstreamGenericLDAPIDP interface {
	Spec() UpstreamGenericLDAPSpec
	Name() string
	Namespace() string
	Generation() int64
	Status() UpstreamGenericLDAPStatus
}

UpstreamGenericLDAPIDP is a read-only interface for abstracting the differences between LDAP and Active Directory IDP types.

type UpstreamGenericLDAPSpec

type UpstreamGenericLDAPSpec interface {
	Host() string
	TLSSpec() *v1alpha1.TLSSpec
	BindSecretName() string
	UserSearch() UpstreamGenericLDAPUserSearch
	GroupSearch() UpstreamGenericLDAPGroupSearch
	DetectAndSetSearchBase(ctx context.Context, config *upstreamldap.ProviderConfig) *v1alpha1.Condition
}

type UpstreamGenericLDAPStatus

type UpstreamGenericLDAPStatus interface {
	Conditions() []v1alpha1.Condition
}

type UpstreamGenericLDAPUserSearch

type UpstreamGenericLDAPUserSearch interface {
	Base() string
	Filter() string
	UsernameAttribute() string
	UIDAttribute() string
}

type ValidatedSettings

type ValidatedSettings struct {
	IDPSpecGeneration         int64  // which IDP spec was used during the validation
	BindSecretResourceVersion string // which bind secret was used during the validation

	// Cache the setting for TLS vs StartTLS. This is always auto-discovered by probing the server.
	LDAPConnectionProtocol upstreamldap.LDAPConnectionProtocol

	// Cache the settings for search bases. These could be configured by the IDP spec, or in the
	// case of AD they can also be auto-discovered by probing the server.
	UserSearchBase, GroupSearchBase string

	// Cache copies of the conditions that were computed when the above settings were cached, so we
	// can keep writing them to the status in the future. This matters most when the first attempt
	// to write them to the IDP's status fails. In this case, future Syncs calls will be able to
	// use these cached values to try writing them again.
	ConnectionValidCondition, SearchBaseFoundCondition *v1alpha1.Condition
}

ValidatedSettings is the struct which is cached by the ValidatedSettingsCacheI interface.

type ValidatedSettingsCache

type ValidatedSettingsCache struct {
	ValidatedSettingsByName map[string]ValidatedSettings
}

func (*ValidatedSettingsCache) Get

func (s *ValidatedSettingsCache) Get(upstreamName, resourceVersion string, idpSpecGeneration int64) (ValidatedSettings, bool)

func (*ValidatedSettingsCache) Set

func (s *ValidatedSettingsCache) Set(upstreamName string, settings ValidatedSettings)

type ValidatedSettingsCacheI

type ValidatedSettingsCacheI interface {
	// Get the cached settings for a given upstream at a given generation which was previously
	// validated using a given bind secret version. If no settings have been cached for the
	// upstream, or if the settings were cached at a different generation of the upstream or
	// using a different version of the bind secret, then return false to indicate that the
	// desired settings were not cached yet for that combination of spec generation and secret version.
	Get(upstreamName, resourceVersion string, idpSpecGeneration int64) (ValidatedSettings, bool)

	// Set some settings into the cache for a given upstream.
	Set(upstreamName string, settings ValidatedSettings)
}

ValidatedSettingsCacheI is an interface for an in-memory cache with an entry for each upstream provider. It keeps track of settings that were already validated for a given IDP spec and bind secret for that upstream.

func NewValidatedSettingsCache

func NewValidatedSettingsCache() ValidatedSettingsCacheI