Struct AuthConfig

config/auth.go:13–51

AuthConfig is the configuration of the authentication client.

// AuthConfig is the configuration of the authentication client.
type AuthConfig struct {
	// PasswordAuth configures how users are authenticated with passwords. If not set, password authentication is
	// disabled.
	PasswordAuth PasswordAuthConfig `json:"password" yaml:"password"`

	// PublicKeyAuth configures how users are authenticated with their public keys. If not set, public key
	// authentication is disabled.
	PublicKeyAuth PublicKeyAuthConfig `json:"publicKey" yaml:"publicKey"`

	// KeyboardInteractiveAuth configures how users are authenticated using the keyboard-interactive (question-answer)
	// method. If this is empty, keyboard-interactive is disabled.
	KeyboardInteractiveAuth KeyboardInteractiveAuthConfig `json:"keyboardInteractive" yaml:"keyboardInteractive"`

	// GSSAPIAuth configures how users are authenticated using the GSSAPI (typically Kerberos) method. If this is empty,
	// GSSAPI authentication is disabled.
	GSSAPIAuth GSSAPIAuthConfig `json:"gssapi" yaml:"gssapi"`

	// Authz is the authorization configuration. The authorization server will receive a webhook after successful user
	// authentication to determine whether the specified user has access to the service. If not set authorization is
	// disabled. It is strongly recommended you configure AuthZ in case of oAuth2 and GSSAPI methods as these methods
	// do not verify the provided SSH username.
	Authz AuthzConfig `json:"authz" yaml:"authz"`

	// AuthTimeout is the timeout for the overall authentication call (e.g. verifying a password). If the server
	// responds with a non-200 response the call will be retried until this timeout is reached. This timeout
	// should be increased to ~180s for OAuth2 login.
	// Deprecated: please use the individual authentication methods instead.
	AuthTimeout time.Duration `json:"authTimeout" yaml:"authTimeout" default:"60s"`

	// Deprecated: please use the individual authentication configurations instead.
	HTTPClientConfiguration `json:",inline" yaml:",inline"`

	// Password is a flag to enable password authentication.
	// Deprecated: use PasswordAuth instead.
	Password *bool `json:"-" yaml:"-" comment:"Perform password authentication" default:"true"`
	// PubKey is a flag to enable public key authentication.
	// Deprecated: use PublicKeyAuth instead.
	PubKey *bool `json:"pubkey" yaml:"pubkey" comment:"Perform public key authentication" default:"true"`
}

type legacyAuthConfig struct {
	PasswordAuth            PasswordAuthConfig            `json:"-" yaml:"-"`