admin

type AgentChangeError struct {
	Saved bool
	Err   error
}

type AgentDisabledResponse struct {
	Name string `json:"name"`
	// Disabled は操作の後の状態。
	Disabled bool `json:"disabled"`
	// Changed は状態が変わったか。変わったときだけ世代が進む。
	Changed bool `json:"changed"`
	// Generation は操作の後の世代。
	Generation uint64 `json:"generation"`
}

type AgentInfo = adminapi.AgentInfo

type AgentRuleStatus = adminapi.AgentRuleStatus

type AgentRuleStatusBackend interface {
	// AgentRuleStatuses returns an entry for every one of rules, by rule ID - never fewer, since an
	// absent id would be indistinguishable from omitting the whole field (see AgentRuleStatus). rules
	// is the rule set already read for this response (getRules/postBatch pass resp.Rules), so this
	// needs no store read of its own.
	//
	// A rule's status comes only from its OWN agent (r.Agent), never from a different agent that
	// happens to also list the same rule ID in a stale cached heartbeat. This matters because a
	// disconnected agent keeps its last heartbeat's content (design.md 5.2 節): if a rule moves from
	// agent A to agent B while A is offline, or is deleted while its agent is offline, A's old
	// heartbeat can still list that rule ID. Looking it up by the rule's current agent, rather than
	// scanning every agent that ever mentioned the ID, is what keeps a moved rule showing B's live
	// status (not A's stale one) and keeps a deleted rule's ID from appearing at all (it is no longer
	// in rules, so it is never looked up).
	AgentRuleStatuses(rules []proto.Rule) map[string]AgentRuleStatus
}

type ApplyStatus struct {
	DesiredGeneration uint64
	ActiveGeneration  uint64
	Rules             map[string]RuleApply
	Drift             Drift
	// LastError is the failure of the last transaction that failed as a whole, or, when it
	// published but a repair after the publication failed, that failure (design.md 7a.3 節: 戻れない
	// 地点の後の修復). Empty once everything succeeded.
	LastError string
}

type ApplyStatusBackend interface {
	// ApplyStatus returns the report, and false until the first transaction was attempted.
	ApplyStatus() (ApplyStatus, bool)
}

type Backend interface {
	Rules() ([]proto.Rule, error)
	Generation() (uint64, error)
	// Batch は変更を 1 トランザクションで適用し、成功したら nftables などへ反映する。
	Batch(req BatchRequest) (*store.BatchResult, error)
	// AgentState はそのエージェントに配る全体状態(stream ができるまでの橋渡しにも使う)。
	AgentState(agent string) (*proto.State, error)
	// Agents は登録済みのエージェント。
	Agents() ([]AgentInfo, error)
	// RuleDrops は rule_id → 累積 drop パケット数。
	RuleDrops() (map[string]uint64, error)
	// JoinString は名前に紐付いた接続文字列を発行する(仕様 5.1 節)。
	JoinString(name string) (JoinStringResponse, error)
	// Revoke はエージェントを削除する。恒久トークンを使えなくし、ピアとアドレスを回収する(仕様 5.1、11 節)。
	Revoke(name string) error
	// DisableAgent はエージェントを無効にし、EnableAgent は有効に戻す(仕様 5.1 節)。不明な名前は
	// store.ErrAgentNotFound(404)、書き込みの時の検査の拒否と、保存は済んだが公開に失敗した場合は
	// *AgentChangeError(422)、それ以外の誤りは 500 になる。
	DisableAgent(name string) (AgentDisabledResponse, error)
	EnableAgent(name string) (AgentDisabledResponse, error)
	// Warnings は窃取検知の警告一覧。
	Warnings() ([]Warning, error)
	// DismissWarning は警告を消す(管理者が正当と確認したとき。仕様 5.2 節)。ip-mismatch では
	// 消した警告の 2 つの IP の組を確認済みとして記録する。
	DismissWarning(agent, kind, detail string) error
	// IPMismatchAcks は ip-mismatch の確認済みの組を全エージェント分返す(仕様 5.2 節)。ダッシュボードが
	// 1 回の読み取りで使う。管理用 API には出さない。
	IPMismatchAcks() ([]store.Ack, error)
	// CheckConnectivity は TCP ルールの疎通確認(仕様 10.1 節)。
	CheckConnectivity(ruleID string) (ConnCheck, error)
	// ServerInfo は vpsd/VPS の構成と環境(ダッシュボード上部に出す)。
	ServerInfo() (ServerInfo, error)
}

type BatchRequest struct {
	Upsert []proto.Rule `json:"upsert"` // ID があれば置き換え、なければ追加
	Delete []string     `json:"delete"` // ID
	Force  bool         `json:"force"`  // bind 中のポートとの衝突を無視する
	// ExpectedDigest は任意(空なら検査しない、既存の呼び出し元と互換)。指定すると、
	// Batch はこのバッチが変更しようとしている今のルール集合の proto.RulesDigest と
	// 一致するかを、読み取りと変更を 1 トランザクション/1 ロックの内側で照合する。
	// 一致しなければ何も変えず ErrBatchConflict を返す。読み取ってから Batch を呼ぶまでの
	// 間に他経路(別の CLI 呼び出しや別タブの Web UI)が割り込む競合を塞ぐためのもの
	// (仕様 5.4、10.1 節)。Web UI の読み込み確認・適用はこれを使う(webui_import.go)。
	ExpectedDigest string `json:"expected_digest,omitempty"`
	// Op はこの変更の出どころ(ログの識別用。例 "ui import"、"cli rule add")。
	// 空なら Batch の実装が既定("api")を補う。
	Op string `json:"op,omitempty"`
}

type BatchResponse = adminapi.BatchResponse

type Client struct {
	Base string
	HTTP *http.Client
}

type ConnCheck = adminapi.ConnCheck

type Drift = adminapi.Drift

type DriftResource = adminapi.DriftResource

type ErrorBody struct {
	Error string `json:"error"`
	// Saved は、エージェントの無効化と有効化(POST /api/v1/agents/{name}/disable と /enable)の
	// 失敗の応答(404、422、500)だけが持つ(設計文書 7a.11 節)。true は、変更をサーバのデータベースに
	// 保存したが、まだ公開していないことを表す(422)。false は何も保存していないことを表す。
	// 他のルートの失敗では省く。
	Saved *bool `json:"saved,omitempty"`
}

type FlowBudget = adminapi.FlowBudget

type IPForwardBackend interface {
	// IPForward reads the sysctl now. ok is false when this server does not forward through the
	// kernel, so the value would say nothing about its rules.
	IPForward() (status IPForwardStatus, ok bool)
}

type IPForwardStatus = adminapi.IPForwardStatus

type JoinStringRequest struct {
	Name string `json:"name"`
}

type JoinStringResponse struct {
	JoinString string `json:"join_string"`
	ExpiresAt  string `json:"expires_at"`
}

type ResourceStatus struct {
	// FlowBudget is keyed by protocol ("udp", "tcp"). Kernel mode server has no entry for "udp":
	// kernel mode counts UDP through nftables/conntrack, not through a resource.Pool.
	FlowBudget map[proto.Proto]FlowBudget
	// Refusals is keyed by rule ID, then by reason. A rule of a protocol/forwarding combination that
	// Go never judges (a Transparent rule in kernel mode) never appears here, since no resource.Pool
	// ever sees it (design.md 7a.10 節「kernel 側の保護」).
	Refusals map[string]map[string]uint64
}

type ResourceStatusBackend interface {
	ResourceStatus() ResourceStatus
}

type RuleApply = adminapi.RuleApply

type Server struct {

	// AllowedHosts は localhost / 127.0.0.1 / [::1] に加えて許可する Host(--admin-host)。
	// 応答を始める前に決め、以後は変えない。
	AllowedHosts []string
	// contains filtered or unexported fields
}

type ServerInfo struct {
	Version          string `json:"version"`
	Mode             string `json:"mode"` // 転送方式 kernel / userspace(仕様 9・11a 節)
	StartedAt        string `json:"started_at"`
	WGInterface      string `json:"wg_interface"`
	WGAddress        string `json:"wg_address"`
	WGPort           int    `json:"wg_port"`
	WGEndpoint       string `json:"wg_endpoint"`
	AgentAPIPort     string `json:"agent_api_port"`
	AdminAddr        string `json:"admin_addr"`
	MTU              int    `json:"mtu"`
	ServerPubKey     string `json:"server_public_key"`
	Kernel           string `json:"kernel"`
	NFT              string `json:"nft"`
	IPForwardSetAt   string `json:"ip_forward_set_at"`
	UDPTimeout       int    `json:"udp_timeout"`
	UDPTimeoutStream int    `json:"udp_timeout_stream"`
	// IPForward は net.ipv4.ip_forward の今の値("1" か "0")で、読めなければ省く(仕様 6.1、10.1 節)。
	// v1 への加算である。IPForwardSetAt は wgft が起動時に 0 から 1 にした記録であり、今の値ではない。
	IPForward string `json:"ip_forward,omitempty"`
}

type TunnelStatus = adminapi.TunnelStatus

type UDPReply = adminapi.UDPReply

type UDPReplyBackend interface {
	// UDPReplies returns an entry for each of rules that is an enabled UDP rule the server
	// publishes now, by rule ID. ok is false when the server does not observe replies at all.
	UDPReplies(rules []proto.Rule) (replies map[string]UDPReply, ok bool)
}

type Warning = adminapi.Warning