validator

Documentation

Index

• type OktaApiAuth
• type OktaOpenVPNValidator
  • func New(args ...string) *OktaOpenVPNValidator
  • func (validator *OktaOpenVPNValidator) Authenticate() error
  • func (validator *OktaOpenVPNValidator) Setup(deferred bool, args []string, pluginEnv *PluginEnv) bool
  • func (validator *OktaOpenVPNValidator) WriteControlFile()
• type PluginEnv

Types

type OktaApiAuth

type OktaApiAuth = oktaApiAuth.OktaApiAuth

type OktaOpenVPNValidator

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

func New

func New(args ...string) *OktaOpenVPNValidator

Returns a validator: if no args is provided LogLevel will be INFO if a arg is provided and in ["TRACE","DEBUG","INFO","WARN","WARNING","ERROR"] use it as LogLevel

func (*OktaOpenVPNValidator) Authenticate

func (validator *OktaOpenVPNValidator) Authenticate() error

Authenticate the user against Okta API

func (*OktaOpenVPNValidator) Setup

func (validator *OktaOpenVPNValidator) Setup(deferred bool, args []string, pluginEnv *PluginEnv) bool

Setup the validator depending on the way it's invoked

func (*OktaOpenVPNValidator) WriteControlFile

func (validator *OktaOpenVPNValidator) WriteControlFile()

Write the authentication result in the OpenVPN control file (only used in deferred mode)

type PluginEnv

type PluginEnv struct {
	// ControlFile is the path to the OpenVPN auth control file
	// where the authentication result is written
	ControlFile string

	// The OpenVPN client ip address, used as `X-Forwarded-For` payload attribute
	// to the Okta API
	ClientIp string

	// The CN of the SSL certificate presented by the OpenVPN client
	CommonName string

	// The client username submitted during OpenVPN authentication
	Username string

	// The client password submitted during OpenVPN authentication
	Password string
}

PluginEnv represents the information passed to the validator when it's running as `Shared Object Plugin`