state

type ClientIdentifier ¶ added in v1.8.0

type ClientIdentifier struct {
	SessionID            string // OpenVPN session identifier
	CommonName           string // OpenVPN common name (user)
	AuthFailedReasonFile string // File for failed authentication reasons
	AuthControlFile      string // Control file for authentication
	CID                  uint64 // OpenVPN connection ID
	KID                  uint64 // OpenVPN key ID
	UsernameIsDefined    int    // 1 if username is defined, 0 otherwise
}

ClientIdentifier holds detailed information about the client initiating an OAuth2 login flow.

This struct provides more context for the client and can be passed to github.com/jkroepke/openvpn-auth-oauth2/internal/openvpn.Client.AcceptClient.

type State ¶

type State struct {
	IPAddr       string           // Client's IP address
	IPPort       string           // Client's port
	SessionState string           // Compact session state representation
	Client       ClientIdentifier // Information about the client
	Issued       int64            // Timestamp (seconds since Unix epoch)
}

State represents the context and security information associated with an OAuth2 login flow.

The `State` value is passed to the `state` GET parameter during the OAuth2 login flow. It ensures that the client initiating the login flow is the same client completing it, thus preventing CSRF (Cross-Site Request Forgery) attacks. The `State` value is returned by the OAuth2 Identity Provider (IDP) in the redirect URL.

To prevent tampering, the `State` is protected using AES encryption.

func New(client ClientIdentifier, ipAddr, ipPort, sessionState string) State

func NewWithEncodedToken(encodedState, secretKey string) (State, error)

func (state *State) Encode(secretKey string) (string, error)

CID KID AuthFailedReasonFile AuthControlFile SessionID UsernameIsDefined CommonName IPAddr IPPort SessionState Issued