connector

Documentation

Overview

DO NOT EDIT: This file was auto-generated by "go generate" To regenerate run:

go install github.com/coreos/dex/cmd/genconfig
go generate <<fully qualified package name>>

Index

• Constants
• func RegisterConnectorConfigType(connectorType string, fn NewConnectorConfigFunc)
• type Connector
• type ConnectorConfig
  • func NewConnectorConfigFromType(connectorType string) (ConnectorConfig, error)
• type ConnectorConfigRepo
  • func NewConnectorConfigRepoFromFile(loc string) (ConnectorConfigRepo, error)
• type LocalConnector
  • func (c *LocalConnector) Healthy() error
  • func (c *LocalConnector) ID() string
  • func (c *LocalConnector) LoginURL(sessionKey, prompt string) (string, error)
  • func (c *LocalConnector) Register(mux *http.ServeMux, errorURL url.URL)
  • func (c *LocalConnector) SetLocalIdentityProvider(idp *LocalIdentityProvider)
  • func (c *LocalConnector) Sync() chan struct{}
  • func (c *LocalConnector) TrustedEmailProvider() bool
• type LocalConnectorConfig
  • func (cfg *LocalConnectorConfig) Connector(ns url.URL, lf oidc.LoginFunc, tpls *template.Template) (Connector, error)
  • func (cfg *LocalConnectorConfig) ConnectorID() string
  • func (cfg *LocalConnectorConfig) ConnectorType() string
• type LocalIdentityProvider
  • func (m *LocalIdentityProvider) Identity(email, password string) (*oidc.Identity, error)
• type NewConnectorConfigFunc
• type OIDCConnector
  • func (c *OIDCConnector) Healthy() error
  • func (c *OIDCConnector) ID() string
  • func (c *OIDCConnector) LoginURL(sessionKey, prompt string) (string, error)
  • func (c *OIDCConnector) Register(mux *http.ServeMux, errorURL url.URL)
  • func (c *OIDCConnector) Sync() chan struct{}
  • func (c *OIDCConnector) TrustedEmailProvider() bool
• type OIDCConnectorConfig
  • func (cfg *OIDCConnectorConfig) Connector(ns url.URL, lf oidc.LoginFunc, tpls *template.Template) (Connector, error)
  • func (cfg *OIDCConnectorConfig) ConnectorID() string
  • func (cfg *OIDCConnectorConfig) ConnectorType() string
• type Page

Constants

const (
	LocalConnectorType    = "local"
	LoginPageTemplateName = "local-login.html"
)

const (
	OIDCConnectorType = "oidc"
)

Functions

func RegisterConnectorConfigType

func RegisterConnectorConfigType(connectorType string, fn NewConnectorConfigFunc)

Types

type Connector

type Connector interface {
	ID() string
	LoginURL(sessionKey, prompt string) (string, error)
	Register(mux *http.ServeMux, errorURL url.URL)

	// Sync triggers any long-running tasks needed to maintain the
	// Connector's operation. For example, this would encompass
	// repeatedly caching any remote resources for local use.
	Sync() chan struct{}

	// TrustedEmailProvider indicates whether or not we can trust that email claims coming from this provider.
	TrustedEmailProvider() bool

	health.Checkable
}

type ConnectorConfig

type ConnectorConfig interface {
	ConnectorID() string
	ConnectorType() string
	Connector(ns url.URL, loginFunc oidc.LoginFunc, tpls *template.Template) (Connector, error)
}

func NewConnectorConfigFromType

func NewConnectorConfigFromType(connectorType string) (ConnectorConfig, error)

type ConnectorConfigRepo

type ConnectorConfigRepo interface {
	All() ([]ConnectorConfig, error)
}

func NewConnectorConfigRepoFromFile

func NewConnectorConfigRepoFromFile(loc string) (ConnectorConfigRepo, error)

type LocalConnector

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

func (*LocalConnector) Healthy

func (c *LocalConnector) Healthy() error

func (*LocalConnector) ID

func (c *LocalConnector) ID() string

func (*LocalConnector) LoginURL

func (c *LocalConnector) LoginURL(sessionKey, prompt string) (string, error)

func (*LocalConnector) Register

func (c *LocalConnector) Register(mux *http.ServeMux, errorURL url.URL)

func (*LocalConnector) SetLocalIdentityProvider

func (c *LocalConnector) SetLocalIdentityProvider(idp *LocalIdentityProvider)

func (*LocalConnector) Sync

func (c *LocalConnector) Sync() chan struct{}

func (*LocalConnector) TrustedEmailProvider

func (c *LocalConnector) TrustedEmailProvider() bool

type LocalConnectorConfig

type LocalConnectorConfig struct {
	ID            string              `json:"id"`
	PasswordInfos []user.PasswordInfo `json:"passwordInfos"`
}

func (*LocalConnectorConfig) Connector

func (cfg *LocalConnectorConfig) Connector(ns url.URL, lf oidc.LoginFunc, tpls *template.Template) (Connector, error)

func (*LocalConnectorConfig) ConnectorID

func (cfg *LocalConnectorConfig) ConnectorID() string

func (*LocalConnectorConfig) ConnectorType

func (cfg *LocalConnectorConfig) ConnectorType() string

type LocalIdentityProvider

type LocalIdentityProvider struct {
	PasswordInfoRepo user.PasswordInfoRepo
	UserRepo         user.UserRepo
}

func (*LocalIdentityProvider) Identity

func (m *LocalIdentityProvider) Identity(email, password string) (*oidc.Identity, error)

type NewConnectorConfigFunc

type NewConnectorConfigFunc func() ConnectorConfig

type OIDCConnector

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

func (*OIDCConnector) Healthy

func (c *OIDCConnector) Healthy() error

func (*OIDCConnector) ID

func (c *OIDCConnector) ID() string

func (*OIDCConnector) LoginURL

func (c *OIDCConnector) LoginURL(sessionKey, prompt string) (string, error)

func (*OIDCConnector) Register

func (c *OIDCConnector) Register(mux *http.ServeMux, errorURL url.URL)

func (*OIDCConnector) Sync

func (c *OIDCConnector) Sync() chan struct{}

func (*OIDCConnector) TrustedEmailProvider

func (c *OIDCConnector) TrustedEmailProvider() bool

type OIDCConnectorConfig

type OIDCConnectorConfig struct {
	ID                   string `json:"id"`
	IssuerURL            string `json:"issuerURL"`
	ClientID             string `json:"clientID"`
	ClientSecret         string `json:"clientSecret"`
	TrustedEmailProvider bool   `json:"trustedEmailProvider"`
}

func (*OIDCConnectorConfig) Connector

func (cfg *OIDCConnectorConfig) Connector(ns url.URL, lf oidc.LoginFunc, tpls *template.Template) (Connector, error)

func (*OIDCConnectorConfig) ConnectorID

func (cfg *OIDCConnectorConfig) ConnectorID() string

func (*OIDCConnectorConfig) ConnectorType

func (cfg *OIDCConnectorConfig) ConnectorType() string

type Page

type Page struct {
	PostURL    string
	Name       string
	Error      bool
	Message    string
	SessionKey string
}