githubupstreamwatcher

Documentation

Overview

Package githubupstreamwatcher implements a controller which watches GitHubIdentityProviders.

Index

• Constants
• func New(namespace string, idpCache UpstreamGitHubIdentityProviderICache, ...) controllerlib.Controller
• func ProbeURL(ctx context.Context, client *http.Client, url string) error
• type GitHubValidatedAPICache
  • func (g *GitHubValidatedAPICache) IsValid(address string, caBundleHash tlsconfigutil.CABundleHash) bool
  • func (g *GitHubValidatedAPICache) MarkAsValidated(address string, caBundleHash tlsconfigutil.CABundleHash)
• type GitHubValidatedAPICacheI
  • func NewGitHubValidatedAPICache(cache *cache.Expiring) GitHubValidatedAPICacheI
• type GitHubValidatedAPICacheKey
• type ProbeURLFunc
• type UpstreamGitHubIdentityProviderICache

Constants

const (
	HostValid                    string = "HostValid"
	TLSConfigurationValid        string = "TLSConfigurationValid"
	OrganizationsPolicyValid     string = "OrganizationsPolicyValid"
	ClientCredentialsSecretValid string = "ClientCredentialsSecretValid" //nolint:gosec // this is not a credential
	GitHubConnectionValid        string = "GitHubConnectionValid"
	ClaimsValid                  string = "ClaimsValid"
)

Functions

func New

func New(
	namespace string,
	idpCache UpstreamGitHubIdentityProviderICache,
	client supervisorclientset.Interface,
	gitHubIdentityProviderInformer idpinformers.GitHubIdentityProviderInformer,
	secretInformer corev1informers.SecretInformer,
	configMapInformer corev1informers.ConfigMapInformer,
	log plog.Logger,
	withInformer pinnipedcontroller.WithInformerOptionFunc,
	clock clock.Clock,
	probeURLFunc ProbeURLFunc,
	validatedCache *cache.Expiring,
) controllerlib.Controller

New instantiates a new controllerlib.Controller which will populate the provided UpstreamGitHubIdentityProviderICache.

func ProbeURL

func ProbeURL(ctx context.Context, client *http.Client, url string) error

ProbeURL is the production code for how to probe a GitHub URL to test our connection to the GitHub API. It can be replaced via constructor injection for testing. Implements ProbeURLFunc.

Types

type GitHubValidatedAPICache

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

func (*GitHubValidatedAPICache) IsValid

func (g *GitHubValidatedAPICache) IsValid(address string, caBundleHash tlsconfigutil.CABundleHash) bool

func (*GitHubValidatedAPICache) MarkAsValidated

func (g *GitHubValidatedAPICache) MarkAsValidated(address string, caBundleHash tlsconfigutil.CABundleHash)

type GitHubValidatedAPICacheI

type GitHubValidatedAPICacheI interface {
	MarkAsValidated(address string, caBundleHash tlsconfigutil.CABundleHash)
	IsValid(address string, caBundleHash tlsconfigutil.CABundleHash) bool
}

func NewGitHubValidatedAPICache

func NewGitHubValidatedAPICache(cache *cache.Expiring) GitHubValidatedAPICacheI

type GitHubValidatedAPICacheKey

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

type ProbeURLFunc

type ProbeURLFunc func(ctx context.Context, client *http.Client, url string) error

type UpstreamGitHubIdentityProviderICache

type UpstreamGitHubIdentityProviderICache interface {
	SetGitHubIdentityProviders([]upstreamprovider.UpstreamGithubIdentityProviderI)
}

UpstreamGitHubIdentityProviderICache is a thread safe cache that holds a list of validated upstream GitHub IDP configurations.