control

type Actor struct {
	UserID *int64 `json:"user_id,omitempty"`
	Name   string `json:"name"`
	IP     string `json:"ip,omitempty"`
}

type AuditSink interface {
	RecordCommand(ctx context.Context, rec CommandRecord)
}

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

type CommandRecord struct {
	Time    time.Time `json:"time"`
	Target  Target    `json:"target"`
	Command string    `json:"command"` // canonical full name
	Args    []string  `json:"args,omitempty"`
	// Mutating is true for calls that change hbbs/hbbr state.
	Mutating bool `json:"mutating"`
	// Raw is true for calls made through the admin console (ExecLine).
	Raw           bool          `json:"raw"`
	Actor         Actor         `json:"actor"`
	Duration      time.Duration `json:"duration_ns"`
	ResponseBytes int           `json:"response_bytes"`
	// ResponseSHA256 is the hex digest of the reply (the reply itself may be large).
	ResponseSHA256 string `json:"response_sha256,omitempty"`
	Err            string `json:"error,omitempty"`
}

type CommandSpec struct {
	Target Target `json:"target"`
	Name   string `json:"name"`
	Alias  string `json:"alias"`
	// Usage is a human hint for the console ("[Y|N]").
	Usage string `json:"usage"`
	// contains filtered or unexported fields
}

type Config struct {
	// HBBSAddr is the hbbs admin address (default 127.0.0.1:21115).
	// "unix:/path" dials a unix socket forwarder instead.
	HBBSAddr string
	// HBBRAddr is the hbbr admin address (default 127.0.0.1:21117).
	HBBRAddr    string
	Timeout     time.Duration
	MaxResponse int
	Audit       AuditSink
	Log         *slog.Logger
	// Dial is injectable for tests.
	Dial func(ctx context.Context, network, addr string) (net.Conn, error)
}

type IPBlockerEntry struct {
	IP string `json:"ip"`
	// Attempts is the number of RegisterPk calls in the current window and
	// AttemptsAge the age of that window.
	Attempts    int           `json:"attempts"`
	AttemptsAge time.Duration `json:"attempts_age_ns"`
	// DistinctIDs is the number of ids registered from this IP in the daily
	// window, IDsAge the age of that window.
	DistinctIDs int           `json:"distinct_ids"`
	IDsAge      time.Duration `json:"ids_age_ns"`
}

type IPBlockerPage struct {
	Total   int              `json:"total"`
	Entries []IPBlockerEntry `json:"entries"`
}

type IPChange struct {
	ID string `json:"id"`
	// Age is the age of the observation window.
	Age time.Duration `json:"age_ns"`
	// IPs maps each source IP to its registration count.
	IPs map[string]int `json:"ips"`
}

type IPChangesPage struct {
	Total   int        `json:"total"`
	Entries []IPChange `json:"entries"`
}

type List string

type NopAudit struct{}

type PunchRequest struct {
	Time   time.Time `json:"time"`
	FromIP string    `json:"from_ip"`
	ToID   string    `json:"to_id"`
	ToIP   string    `json:"to_ip"`
}

type Rate string

type RelayUsage struct {
	Addr    string        `json:"addr"`
	Elapsed time.Duration `json:"elapsed_ns"`
	TotalMB float64       `json:"total_mb"`
	// Rates in kb/s as printed by hbbr.
	HighestKbps int64 `json:"highest_kbps"`
	AvgKbps     int64 `json:"avg_kbps"`
	CurrentKbps int64 `json:"current_kbps"`
}

type Target string