sdk

package module

Go to main page

Versions in this module

v0

v0.5.4

Aug 9, 2026

Changes in this version

type Client

+ func (c *Client) SendDeliveryReceipt(ctx context.Context, deliveryID string) error

+ func (c *Client) SendManifestResult(ctx context.Context, result *pm.ManifestResult) error

+ func (c *Client) StoreLpsPasswords(ctx context.Context, actionID string, rotations []*pm.LpsPasswordRotation) error

+ func (c *Client) Sync(ctx context.Context) (*SyncStateResult, error)

type RegisterAgentResult

+ ControlSealingPublicKey []byte

+ ControlURL string

type StreamHandler

+ OnManifestDelivery func(ctx context.Context, delivery *pm.ManifestDelivery) error

type StreamingHandler

+ OnManifestDeliveryWithStreaming func(ctx context.Context, delivery *pm.ManifestDelivery, ...) error

+ type SyncStateResult struct

+ Deliveries []*pm.ManifestDelivery

+ MaintenanceWindow *pm.MaintenanceWindow

+ SyncIntervalMinutes int32

v0.5.3

Jul 2, 2026

Changes in this version

type SyncActionsResult

+ LpsPublicKey *pm.LpsPublicKey

v0.5.2

Jun 27, 2026

v0.5.1

Jun 23, 2026

v0.5.0

Jun 22, 2026

Changes in this version

+ const MaxHeartbeatInterval

+ const MinHeartbeatInterval

+ func NewULID() string

+ func ValidateHTTPSURL(raw string) error

+ type Client struct

+ func NewClient(serverURL string, opts ...ClientOption) *Client

+ func (c *Client) AuthToken() string

+ func (c *Client) Close() error

+ func (c *Client) CloseIdleConnections()

+ func (c *Client) Connect(ctx context.Context) error

+ func (c *Client) DeviceID() string

+ func (c *Client) GetLuksKey(ctx context.Context, actionID string) (string, error)

+ func (c *Client) Receive(ctx context.Context) (*pm.ServerMessage, error)

+ func (c *Client) Run(ctx context.Context, hostname, agentVersion string, ...) error

+ func (c *Client) SendActionResult(ctx context.Context, result *pm.ActionResult) error

+ func (c *Client) SendHeartbeat(ctx context.Context, hb *pm.Heartbeat) error

+ func (c *Client) SendHello(ctx context.Context, hostname, agentVersion string) error

+ func (c *Client) SendInventory(ctx context.Context, inventory *pm.DeviceInventory) error

+ func (c *Client) SendLogQueryResult(ctx context.Context, result *pm.LogQueryResult) error

+ func (c *Client) SendOutputChunk(ctx context.Context, chunk *pm.OutputChunk) error

+ func (c *Client) SendQueryResult(ctx context.Context, result *pm.OSQueryResult) error

+ func (c *Client) SendRevokeLuksDeviceKeyResult(ctx context.Context, actionID string, success bool, errMsg string) error

+ func (c *Client) SendSecurityAlert(ctx context.Context, alert *pm.SecurityAlert) error

+ func (c *Client) SendTerminalOutput(ctx context.Context, out *pm.TerminalOutput) error

+ func (c *Client) SendTerminalStateChange(ctx context.Context, change *pm.TerminalStateChange) error

+ func (c *Client) StartReceiver(ctx context.Context) context.CancelFunc

+ func (c *Client) StoreLuksKey(ctx context.Context, actionID, devicePath, passphrase string, ...) error

+ func (c *Client) SyncActions(ctx context.Context) (*SyncActionsResult, error)

+ func (c *Client) ValidateLuksToken(ctx context.Context, token string) (*ValidateLuksTokenResult, error)

+ type ClientOption interface

+ func WithAuth(deviceID, authToken string) ClientOption

+ func WithH2C() ClientOption

+ func WithHTTPClient(hc *http.Client) ClientOption

+ func WithLogger(l *slog.Logger) ClientOption

+ func WithMTLS(certFile, keyFile, caFile string) (ClientOption, error)

+ func WithMTLSFromPEM(certPEM, keyPEM, caPEM []byte) (ClientOption, error)

+ func WithMTLSFromPEMAndSystemRoots(certPEM, keyPEM, caPEM []byte) (ClientOption, error)

+ func WithTLSConfig(tlsConfig *tls.Config) ClientOption

+ type InventoryHandler interface

+ CollectInventory func(ctx context.Context) *pm.DeviceInventory

+ OnRequestInventory func(ctx context.Context, req *pm.RequestInventory) *pm.DeviceInventory

+ type LogQueryHandler interface

+ OnLogQuery func(ctx context.Context, query *pm.LogQuery) (*pm.LogQueryResult, error)

+ type LuksHandler interface

+ OnRevokeLuksDeviceKey func(ctx context.Context, req *pm.RevokeLuksDeviceKey) (bool, string)

+ type RegisterAgentResult struct

+ CACert []byte

+ Certificate []byte

+ DeviceID string

+ GatewayURL string

+ func RegisterAgent(ctx context.Context, controlURL string, token, hostname, agentVersion string, ...) (*RegisterAgentResult, error)

+ type RenewCertificateResult struct

+ CACert []byte

+ Certificate []byte

+ NotAfter time.Time

+ func RenewCertificate(ctx context.Context, controlURL string, csr, currentCert []byte, ...) (*RenewCertificateResult, error)

+ type StreamHandler interface

+ OnAction func(ctx context.Context, envelope []byte, signature []byte) (*pm.ActionResult, error)

+ OnError func(ctx context.Context, err *pm.Error) error

+ OnQuery func(ctx context.Context, query *pm.OSQuery) (*pm.OSQueryResult, error)

+ OnWelcome func(ctx context.Context, welcome *pm.Welcome) error

+ type StreamingHandler interface

+ OnActionWithStreaming func(ctx context.Context, envelope []byte, signature []byte, ...) (*pm.ActionResult, error)

+ type SyncActionsResult struct

+ GroupedActions []*pm.ActionGroup

+ MaintenanceWindow *pm.MaintenanceWindow

+ StandaloneActions []*pm.Action

+ SyncIntervalMinutes int32

+ type TerminalHandler interface

+ OnTerminalInput func(ctx context.Context, req *pm.TerminalInput) error

+ OnTerminalResize func(ctx context.Context, req *pm.TerminalResize) error

+ OnTerminalStart func(ctx context.Context, req *pm.TerminalStart) error

+ OnTerminalStop func(ctx context.Context, req *pm.TerminalStop) error

+ type ValidateLuksTokenResult struct

+ ActionID string

+ Complexity pm.LpsPasswordComplexity

+ DevicePath string

+ MinLength int32

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL