cmd

Documentation

Index

• Constants
• Variables
• func AuthenticateToProvider(provider OIDCProvider) error
• func AzureCommand(cmd *cobra.Command, args []string) error
• func DefaultCommand(cmd *cobra.Command, args []string) error
• func Execute() error
• func ExtractAuthInfo(kubeConfig string) (*clientCmdApi.AuthInfo, error)
• func GoogleCommand(cmd *cobra.Command, args []string) error
• type AzureOIDC
  • func (a *AzureOIDC) Autopilot() error
• type CustomClaim
• type DexterOIDC
  • func (d *DexterOIDC) AuthInfoToOauth2(authInfo *clientCmdApi.AuthInfo)
  • func (d *DexterOIDC) Autopilot() error
  • func (d *DexterOIDC) ConfigureOAuth2Manully() error
  • func (d DexterOIDC) GenerateAuthUrl() string
  • func (d DexterOIDC) PreflightCheck() error
  • func (d DexterOIDC) StartHTTPServer() error
• type GoogleOIDC
• type OIDCProvider

Constants

const (
	BANNER = `` /* 252-byte string literal not displayed */

)

Variables

var (

	// Cobra command
	AuthCmd = &cobra.Command{
		Use:   "auth",
		Short: "Authenticate with OIDC provider",
		Long: `Use a provider sub-command to authenticate against your identity provider of choice.
For details go to: https://blog.gini.net/
`,
		RunE: DefaultCommand,
	}
)

Functions

func AuthenticateToProvider

func AuthenticateToProvider(provider OIDCProvider) error

initiate the OIDC flow. This func should be called in each cobra command

func AzureCommand

func AzureCommand(cmd *cobra.Command, args []string) error

func DefaultCommand

func DefaultCommand(cmd *cobra.Command, args []string) error

support build time providers. If the variable buildTimeProvider is set run the provider. FR: https://github.com/gini/dexter/issues/29

func Execute

func Execute() error

Execute executes the root command.

func ExtractAuthInfo

func ExtractAuthInfo(kubeConfig string) (*clientCmdApi.AuthInfo, error)

extract relevant authentication data from the given kube config

func GoogleCommand

func GoogleCommand(cmd *cobra.Command, args []string) error

Types

type AzureOIDC

type AzureOIDC struct {
	DexterOIDC // embed the base provider
	// contains filtered or unexported fields
}

func (*AzureOIDC) Autopilot

func (a *AzureOIDC) Autopilot() error

type CustomClaim

type CustomClaim struct {
	Email string `json:"email"`
}

helper type to render the k8s config

type DexterOIDC

type DexterOIDC struct {
	Oauth2Config *oauth2.Config // oauth2 configuration
	// contains filtered or unexported fields
}

DexterOIDC: struct to store the required data and provide methods to authenticate with OpenID providers

func (*DexterOIDC) AuthInfoToOauth2

func (d *DexterOIDC) AuthInfoToOauth2(authInfo *clientCmdApi.AuthInfo)

create Oauth2 configuration

func (*DexterOIDC) Autopilot

func (d *DexterOIDC) Autopilot() error

func (*DexterOIDC) ConfigureOAuth2Manully

func (d *DexterOIDC) ConfigureOAuth2Manully() error

attempt to set client credentials

func (DexterOIDC) GenerateAuthUrl

func (d DexterOIDC) GenerateAuthUrl() string

func (DexterOIDC) PreflightCheck

func (d DexterOIDC) PreflightCheck() error

ensure that the required parameters are defined and that the values make sense

func (DexterOIDC) StartHTTPServer

func (d DexterOIDC) StartHTTPServer() error

start HTTP server to receive callbacks. This has to be run in a go routine

type GoogleOIDC

type GoogleOIDC struct {
	DexterOIDC
}

type OIDCProvider

type OIDCProvider interface {
	ConfigureOAuth2Manully() error
	Autopilot() error
	PreflightCheck() error
	GenerateAuthUrl() string
	StartHTTPServer() error
}

interface that all OIDC providers need to implement