connection

type AuthenticationMode int

type ConnectFunc func(reconnect bool) (string, error)

type ConnectJWTSettings struct {
	ConnectJWTSettingsCore
	// contains filtered or unexported fields
}

type ConnectJWTSettingsCore struct {
	// KeyPath path to jwt signing key
	KeyPath string `json:"keypath,omitempty" doc-key:"config.connectionSettings.jwtsettings.keypath" displayname:"Key Path"`
	// JwtHeader JWT headers as escaped json string. Custom headers to be added to the JWT header.
	// The strings for JwtHeader and Claims will be processed as a GO template
	// where User struct can be used
	//  struct {
	//	UserName  string
	// 	Password  string
	// 	Directory string
	// }
	// as well as the function "now" which corresponds to time.Now
	// The entries for "alg" and "typ" are added automatically to the header.
	// E.g. to add a key id header, "kid" add the following string
	// "{\"kid\":\"myKeyId\"}"
	JwtHeader synced.Template `json:"jwtheader" doc-key:"config.connectionSettings.jwtsettings.jwtheader"  displayname:"JWT Header"`
	// Claims JWT claims as escaped json string. E.g. for an on prem JWT auth (with user and directory set as keys in QMC):
	// "{\"user\": \"{{.UserName}}\",\"directory\": \"{{.Directory}}\"}"
	// to add "iat":
	// "{\"iat\":{{now.Unix}}}"
	// or to add "exp" with 5 hours expiration
	// "{\"exp\":{{(now.Add 18000000000000).Unix}}}"
	Claims synced.Template `json:"claims" doc-key:"config.connectionSettings.jwtsettings.claims" displayname:"Claims"`

	// Alg is the signing method to be used for the JWT. Defaults to RS512 if omitted
	Alg string `json:"alg,omitempty" doc-key:"config.connectionSettings.jwtsettings.alg" displayname:"Algoritm"`
}

type ConnectWsSettings struct{}

type ConnectionSettings struct {
	// Mode authentication mode, either JWT or WS
	Mode AuthenticationMode `json:"mode" doc-key:"config.connectionSettings.mode"`
	// JwtSettings JWT mode specific settings
	JwtSettings *ConnectJWTSettings `json:"jwtsettings,omitempty" doc-key:"config.connectionSettings.jwtsettings"`
	// WsSettings WS mode specific settings
	WsSettings *ConnectWsSettings `json:"wssettings,omitempty" doc-key:"config.connectionSettings.wssettings"`
	// Server remote host
	Server string `json:"server" doc-key:"config.connectionSettings.server"`
	// VirtualProxy sense virtual proxy used (added to connect path)
	VirtualProxy string `json:"virtualproxy" doc-key:"config.connectionSettings.virtualproxy"`
	// RawURL used to specify custom path for connection to sense app
	RawURL string `json:"rawurl,omitempty" doc-key:"config.connectionSettings.rawurl"`
	// Port port to be used, defaults to 80 or 443 depending on Security flag
	Port int `json:"port,omitempty" doc-key:"config.connectionSettings.port"`
	// Security use TLS
	Security bool `json:"security" doc-key:"config.connectionSettings.security"`
	// Allowuntrusted certificates
	Allowuntrusted bool `json:"allowuntrusted" doc-key:"config.connectionSettings.allowuntrusted"`
	// AppExt : By making this a pointer, we can check whether it was initialized
	// so that if omitted, it defaults to "app", but can be explicitly set to an empty string as well
	AppExt *string `json:"appext,omitempty" doc-key:"config.connectionSettings.appext"`
	// Header headers to add on the websocket connection
	Headers map[string]string `json:"headers" doc-key:"config.connectionSettings.headers"`
	// MaxFrameSize (Default 0 - No limit). Max size in bytes to be read on sense websocket. Limit exceeded yields an error.
	MaxFrameSize int64 `json:"maxframesize" doc-key:"config.connectionSettings.maxframesize"`
	// contains filtered or unexported fields
}