api

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

type ClientOptions struct {
	// BaseURL of the relay.
	BaseURL string
	// Agent is the agent name that will be sent in requests.
	Agent string
	// TunnelName is the name of the tunnel.
	TunnelName string
	// Token is the bearer token for authenticating to the relay.
	Token string
	// TLS config for HTTP/3. Provide RootCAs or InsecureSkipVerify if you're
	// talking to a dev relay with a self-signed cert (only for development).
	TLSConfig *tls.Config
	// Timeout for each request. Defaults to 10s if not set.
	Timeout time.Duration
	// PacketConn is an optional UDP PacketConn to use for QUIC connections.
	// If nil, a new UDP socket will be created for each connection.
	PacketConn net.PacketConn
	// MetricsPort is the port the agent's Prometheus metrics server listens on.
	// Advertised to the relay so it can scrape metrics through the overlay.
	MetricsPort int
	// Labels are agent-declared labels used for service selection.
	Labels map[string]string
	// AdvertisedRoutes are CIDRs reachable behind this agent.
	AdvertisedRoutes []string
	// AgentInstance is a stable per-process UUID identifying the agent instance.
	AgentInstance string
}

type ConnectRequest struct {
	// Agent is the name of the agent.
	Agent string `json:"agent"`
	// MetricsPort is the port the agent's Prometheus metrics server listens on.
	// 0 means the agent does not expose metrics.
	MetricsPort int `json:"metricsPort,omitempty"`
	// Labels are agent-declared labels used for service selection. The relay
	// rejects labels outside the credential's allowed label sets.
	Labels map[string]string `json:"labels,omitempty"`
	// AdvertisedRoutes are CIDRs reachable behind this connection. The relay
	// rejects routes outside the credential's allowed CIDRs.
	AdvertisedRoutes []string `json:"advertisedRoutes,omitempty"`
	// AgentInstance is a stable per-process UUID identifying the agent instance.
	AgentInstance string `json:"agentInstance,omitempty"`
}

type ConnectResponse struct {
	// ID is the unique ID of the connection.
	ID string `json:"id"`
	// VNI is the virtual network identifier assigned to the connection.
	VNI uint `json:"vni"`
	// MTU is the maximum transmission unit for the connection.
	MTU int `json:"mtu"`
	// Keys contains the symmetric keys for sending and receiving packets.
	Keys Keys `json:"keys"`
	// Addresses is a list of overlay addresses assigned to the connection.
	Addresses []string `json:"addresses"`
	// Routes is a list of routes to configure for the connection.
	Routes []Route `json:"routes,omitempty"`
	// DNS contains DNS configuration for the connection.
	DNS *DNS `json:"dns,omitempty"`
}

type DNS struct {
	// Servers is a list of nameservers to use.
	Servers []string `json:"servers,omitempty"`
	// SearchDomains is a list of search domains to use.
	SearchDomains []string `json:"searchDomains,omitempty"`
	// NDots is the number of dots in name to trigger absolute lookup.
	NDots *int `json:"ndots,omitempty"`
}

type Keys struct {
	// Epoch is the key generation for this connection; it starts at 1 and
	// strictly increases on every rotation. Each side maps it onto mirrored
	// per-direction SPIs (psp.EpochSPIs: relay = Responder, agent = Initiator)
	// and the handler derives that epoch's keys from the master secret.
	Epoch uint32 `json:"epoch"`
	// MasterSecret is the connection's PSP master secret (base64-encoded). It is
	// minted once per connection; rotations advance Epoch under the same master.
	MasterSecret MasterSecret `json:"masterSecret"`
	// ExpiresAt is the expiration time for the keys, when this is exceeded, the agent
	// should issue an update keys request.
	ExpiresAt time.Time `json:"expiresAt"`
}

type MasterSecret [32]byte

type Request struct {
	// Agent is the name of the agent.
	Agent string `json:"agent"`
	// ID is the unique ID of the connection.
	ID string `json:"id"`
}

type Route struct {
	// Destination is the destination CIDR for the route.
	Destination string `json:"destination"`
}

type RoutesResponse struct {
	// Routes is the full route set the agent should have installed.
	Routes []Route `json:"routes,omitempty"`
}

type StatusError struct {
	Method string
	URL    string
	Code   int
	Status string
	Body   string
}

type UpdateKeysResponse struct {
	// Keys contains the symmetric keys for sending and receiving packets.
	Keys Keys `json:"keys"`
}