Interface Authenticator

ecu/auth.go:32–45

Authenticator types provide functionality for authenticating users and adding the authenticated information to a context.

// Authenticator types provide functionality for authenticating users and adding
// the authenticated information to a context.
type Authenticator interface {
	// AuthInit will be called once when the ECU is run to set up required
	// resources for authentication. If nothing is needed, it should simply
	// return nil. If an error is returned, a warning will be
	// logged but the ECU will continue to run, so implementations should ensure
	// Authenticate does not crash if AuthInit fails.
	AuthInit() error

	// Authenticate inspects the provided context (particularly ctx.AuthToken)
	// and either returns an error or creates a child context treated as
	// authenticated (ctx.AuthType == ipc.ATSSO) and fields needed for
	// authorization checks (ctx.User).
	Authenticate(ctx *ipc.Context) (*ipc.Context, error)
}

// DefaultAuthenticator implements a "default-deny authenticator" that denies
// all authentications. Using this prevents remote connections to the ECU.