agentcontrol

const (
	// ReportErrorCodeBatchIDInvalid: no batch_id, or one over 128 bytes.
	ReportErrorCodeBatchIDInvalid = "report_batch_id_invalid"
	// ReportErrorCodeInvalid: an entry is malformed (an empty entry, a
	// user_id of 0, fields_json that is not JSON).
	ReportErrorCodeInvalid = "report_invalid"
	// ReportErrorCodeCounterOverflow: bytes beyond the 64-bit counter range.
	ReportErrorCodeCounterOverflow = "report_counter_overflow"
	// ReportErrorCodeNodeGone: the stream's node no longer exists.
	ReportErrorCodeNodeGone = "report_node_gone"
	// ReportErrorCodeUnavailable: Control could not record the batch now
	// (its database failed). applied is false and error empty; the Agent
	// keeps the batch and resends it after ReportAck.retry_after_ms. Sent
	// only to an Agent that negotiated ReportsAttributeTransientAck.
	ReportErrorCodeUnavailable = "report_unavailable"
)

const (
	ReportsAttributeTransientAck = "transient_ack"
	ReportsTransientAckV1        = "v1"
)

const (
	// MaintenanceErrorCodeSchemaUnsupported: the batch's version is not
	// MaintenanceSchemaV1.
	MaintenanceErrorCodeSchemaUnsupported = "maintenance_schema_unsupported"
	// MaintenanceErrorCodeBatchTooLarge: more than MaxMaintenanceBatchEvents
	// events, or more than MaxMaintenanceBatchBytes.
	MaintenanceErrorCodeBatchTooLarge = "maintenance_batch_too_large"
	// MaintenanceErrorCodeEventInvalid: the event is not a valid
	// anixops.maintenance/v1 event (ParseMaintenanceEvent).
	MaintenanceErrorCodeEventInvalid = "maintenance_event_invalid"
	// MaintenanceErrorCodeWrongNode: the event's node_id is not the
	// stream's node.
	MaintenanceErrorCodeWrongNode = "maintenance_event_wrong_node"
	// MaintenanceErrorCodeNodeGone: the stream's node no longer exists.
	MaintenanceErrorCodeNodeGone = "maintenance_node_gone"
	// MaintenanceErrorCodeUnavailable: Control could not store the event
	// now; persisted is false and error empty, and the Agent sends it again
	// after MaintenanceEventResult.retry_after_ms.
	MaintenanceErrorCodeUnavailable = "maintenance_unavailable"
)

const (
	// ConfigErrorCodeFormatUnsupported: the snapshot's format is one the
	// Agent does not know.
	ConfigErrorCodeFormatUnsupported = "config_format_unsupported"
	// ConfigErrorCodeHashMismatch: config_hash is not the SHA-256 of
	// config_json.
	ConfigErrorCodeHashMismatch = "config_hash_mismatch"
	// ConfigErrorCodeInvalid: the document does not parse or fails the
	// Agent's checks.
	ConfigErrorCodeInvalid = "config_invalid"
	// ConfigErrorCodeApplyFailed: the Agent could not run the configuration
	// (a core or driver refused it).
	ConfigErrorCodeApplyFailed = "config_apply_failed"
)

const (
	// ErrorCodePluginReleaseAddressInvalid (InvalidArgument): the request
	// lacks a plugin_id, version, 64-hex sha256 or positive size.
	ErrorCodePluginReleaseAddressInvalid = "invalid_plugin_release_address"
	// ErrorCodePluginReleaseAddressMismatch (InvalidArgument): the address
	// is not the release's verified content.
	ErrorCodePluginReleaseAddressMismatch = "plugin_release_address_mismatch"
	// ErrorCodePluginReleaseNotAssigned (PermissionDenied): the
	// certificate's node has no enabled assignment of the release, or the
	// release is not an official enabled Agent release.
	ErrorCodePluginReleaseNotAssigned = "plugin_release_not_assigned"
	// ErrorCodePluginReleaseNotFound (NotFound): the assigned release or its
	// artifact is gone.
	ErrorCodePluginReleaseNotFound = "plugin_release_not_found"
	// ErrorCodePluginReleaseIntegrityFailed (FailedPrecondition): the
	// stored release no longer verifies.
	ErrorCodePluginReleaseIntegrityFailed = "plugin_release_integrity_failed"
	// ErrorCodePluginReleaseBusy (ResourceExhausted): the node has as many
	// downloads running as Control allows; retry later.
	ErrorCodePluginReleaseBusy = "plugin_release_download_busy"
)

const (
	// ErrorCodeReleaseRequestInvalid (InvalidArgument): the kind, version,
	// asset or offset names no release file.
	ErrorCodeReleaseRequestInvalid = "invalid_release_request"
	// ErrorCodeReleaseNotFound (NotFound): Control holds no such file.
	ErrorCodeReleaseNotFound = "release_not_found"
)

const (
	// ReleaseKindAgent names an Agent release asset (UpgradeArtifact).
	ReleaseKindAgent = "agent"
	// ReleaseKindKernel names a kernel package (UpgradeKernel); its value
	// is the kernel's name.
	ReleaseKindKernel = KernelAnxNode
)

const (
	// ErrorCodeLinkNotNegotiated (FailedPrecondition): the node's Agent did
	// not negotiate forward.v1 in its last Hello. Ask again after a HelloAck
	// that lists forward.v1.
	ErrorCodeLinkNotNegotiated = "link_cert_not_negotiated"
	// ErrorCodeLinkRequestInvalid (InvalidArgument): the CSR is malformed,
	// uses an unsupported key or the agent certificate's own key, or names
	// anything but the node's DNS name and SPIFFE ID. An Agent bug: fix the
	// request, with a fresh key.
	ErrorCodeLinkRequestInvalid = "link_cert_request_invalid"
	// ErrorCodeLinkUnavailable (FailedPrecondition): this Control issues no
	// link certificates (no built-in CA, or an external PKI) or has no link
	// CA yet. Keep the current link certificate and retry later.
	ErrorCodeLinkUnavailable = "link_cert_unavailable"
)

const (
	// LabelProtocolRevision is the Hello label in which an Agent names the
	// protocol revision it speaks (a decimal number). An Agent that
	// predates the label speaks ProtocolRevisionBaseline.
	LabelProtocolRevision = "protocol.revision"
	// LabelKernelMinVersion is the Hello label in which an Agent names the
	// oldest anx-node release it works with (KernelVersionPattern); an
	// Agent that predates the label names none.
	LabelKernelMinVersion = "kernel.anx-node.min"

	// ProtocolRevisionBaseline is the revision of the v5.0.0 contract:
	// every Agent released before LabelProtocolRevision speaks it.
	ProtocolRevisionBaseline uint32 = 1
	// ProtocolRevisionCurrent is the newest revision this SDK defines.
	// Raise it, and add a line to the revision table of
	// docs/reference/agent-versioning.md, with the contract change that
	// introduces it.
	ProtocolRevisionCurrent uint32 = 3
	// ProtocolRevisionUserKeys is the revision from which an Agent serves a
	// user's stored Shadowsocks 2022 key (users.v1 extra
	// UserExtraSS2022Key) next to the legacy one.
	ProtocolRevisionUserKeys uint32 = 2
	// ProtocolRevisionSnell is the revision from which an Agent runs a
	// configuration answer of node type snell.
	ProtocolRevisionSnell uint32 = 3
)

const (
	// CompatibilityOK: the Agent and Control work together.
	CompatibilityOK = "compatible"
	// CompatibilityWarning: they work together, but something should be
	// upgraded (Control is older than the Agent, or the version lines
	// differ).
	CompatibilityWarning = "warning"
	// CompatibilityIncompatible: the Agent, or its kernel, is older than
	// Control or the Agent supports; features fail until it is upgraded.
	CompatibilityIncompatible = "incompatible"
)

const (
	// ProblemAgentProtocolTooOld: the Agent speaks a revision below the
	// oldest Control serves. Upgrade the Agent.
	ProblemAgentProtocolTooOld = "agent_protocol_too_old"
	// ProblemAgentProtocolTooNew: the Agent speaks a revision above the
	// newest Control serves; the newer features stay off. Upgrade Control.
	ProblemAgentProtocolTooNew = "agent_protocol_too_new"
	// ProblemVersionLineMismatch: the Agent's major.minor is not Control's.
	ProblemVersionLineMismatch = "version_line_mismatch"
	// ProblemKernelTooOld: the anx-node release is older than the Agent
	// needs. Upgrade the kernel.
	ProblemKernelTooOld = "kernel_too_old"
)

const (
	// CapabilityConfig: Control sends ConfigSnapshot and the Agent answers
	// ConfigStatus; Hello.config_revision is read.
	CapabilityConfig = "config"
	// CapabilityUsers: Control sends UserDelta; Hello.users_cursor is read.
	CapabilityUsers = "users"
	// CapabilityReports: the Agent sends TrafficReport, LogBatch and
	// NodeStatus, and Control answers reports with ReportAck.
	CapabilityReports = "reports"
	// CapabilityDiag: the Agent runs node-side diagnostics, the forward
	// checks of the agent.diagnostic operation (PROTOCOL.md, "Diagnostic
	// operation"), so Control may choose the node as a vantage. It adds no
	// payload; Control records it on the session and sends the checks only
	// with agent.diagnostic listed too.
	CapabilityDiag = "diag"
	// CapabilityPackageReports: the Agent sends PackageReport, the latest
	// observation of a plugin package; Control does not acknowledge it.
	CapabilityPackageReports = "package-reports"
	// CapabilityForward: the node forwards (forward-sdk.md section 8).
	// Control carries the node's NodeForwardState in an
	// anixops.nodeconfig/v2 ConfigSnapshot (so it needs config.v1 too) and
	// accepts the node's NodeForwardReport as a PackageReport (with
	// package-reports.v1). The Agent's Hello lists it with the node's
	// NodeCapabilities in an attribute (sdk/forward/wire).
	CapabilityForward = "forward"
	// CapabilityMaintenance: the Agent sends its maintenance outbox as
	// MaintenanceEvents, and Control answers each batch with
	// MaintenanceAck (maintenance.go; PROTOCOL.md, "Maintenance events").
	CapabilityMaintenance = "maintenance"
	// CapabilityAlive: Control sends AliveList, every user's online device
	// count across all nodes, so the Agent enforces
	// device limits against every node's connections.
	CapabilityAlive = "alive"
	// CapabilityArtifacts: Control serves the AgentArtifacts service
	// (artifacts.proto) to the session's client certificate, so the Agent
	// downloads its node's plugin releases without the node API key. It
	// adds no stream payload.
	CapabilityArtifacts = "artifacts"
	// CapabilityReleases: Control serves AgentArtifacts.DownloadRelease
	// (artifacts.proto) to the session's client certificate, so the Agent
	// downloads the Agent and kernel files of an agent.upgrade operation
	// over the mTLS connection instead of their https URL, which stays the
	// fallback. It adds no stream payload.
	CapabilityReleases = "releases"
	// CapabilityDestinations: the Agent sends DestinationReport, each
	// user's traffic by destination domain, and Control answers it with
	// ReportAck as it answers reports.v1 batches.
	CapabilityDestinations = "destinations"
	// CapabilityNetwork: the device runs the network model
	// (docs/design/network-model, sdk/network). Control carries the
	// device's NetworkPlan as the member "network" of the nodeconfig
	// document (so it needs config.v1 too) and accepts the device's
	// NetworkStatus as a PackageReport (with package-reports.v1). The
	// Agent's Hello lists it with the device's DeviceCapabilities in an
	// attribute.
	CapabilityNetwork = "network"
)

const (
	// MetadataNodeID carries the node id with a node credential.
	MetadataNodeID = "x-node-id"
	// MetadataAPIKey carries a proxy node's API key, or a forward node's
	// token when MetadataNodeKind is NodeKindForward.
	MetadataAPIKey = "x-api-key"
	// MetadataNodeKind names the table of MetadataNodeID: NodeKindProxy (the
	// default) or NodeKindForward. Only AgentEnrollment.Enroll reads it.
	MetadataNodeKind = "x-node-kind"
	// MetadataAuthDeprecated is the response header Control sends when an
	// Agent authenticated with its legacy node credential although client
	// certificates are preferred (agent_control.mtls: preferred).
	MetadataAuthDeprecated = "x-anix-auth-deprecated"
	// MetadataAuthSunset accompanies MetadataAuthDeprecated when Control
	// announces a date (agent_control.legacy_sunset) after which legacy
	// credentials may be refused, as an HTTP-date (RFC 9110).
	MetadataAuthSunset = "x-anix-auth-sunset"
	// MetadataAuthDeprecationLink accompanies MetadataAuthDeprecated: where
	// the operator reads how to move the node to client certificates.
	MetadataAuthDeprecationLink = "x-anix-auth-deprecation-link"
	// MetadataErrorCode is the trailer of a call Control refused for a
	// machine-readable reason, such as ErrorCodeMTLSRequired.
	MetadataErrorCode = "x-anix-error-code"
	// ErrorCodeMTLSRequired refuses legacy credentials on an AnixOps Agent
	// channel under agent_control.mtls: required. HTTP answers carry it as
	// the "code" of their JSON body.
	ErrorCodeMTLSRequired = "agent_mtls_required"
)

const (
	// ErrorCodeCertRevoked: the certificate, its enrollment or its node's
	// credentials were revoked, or the node was disabled or deleted (which
	// revokes them).
	ErrorCodeCertRevoked = "agent_cert_revoked"
	// ErrorCodeCertExpired: the certificate's not_after has passed, at
	// connection or, on an open stream, at a heartbeat.
	ErrorCodeCertExpired = "agent_cert_expired"
	// ErrorCodeCertInvalid: the certificate does not authenticate an agent
	// of this Control: unparsable, not chaining to the agent trust bundle,
	// not yet valid, without client-auth usage, without exactly one agent
	// SPIFFE ID, or presented while Control runs no agent PKI.
	ErrorCodeCertInvalid = "agent_cert_invalid"
	// ErrorCodeCertWrongNode: the certificate names another node than the
	// call: x-node-id or x-node-kind, an envelope's node_id, or a forward
	// node's certificate on the proxy-only v2board services.
	ErrorCodeCertWrongNode = "agent_cert_wrong_node"
	// ErrorCodeCertWrongCluster: the certificate is an agent certificate of
	// another cluster.
	ErrorCodeCertWrongCluster = "agent_cert_wrong_cluster"
	// ErrorCodeEnrollmentRejected answers AgentEnrollment.Enroll for any
	// unusable bootstrap credential (unknown, used, expired or revoked
	// enrollment credential, wrong node key or token, disabled node): one
	// answer, so credentials cannot be probed.
	ErrorCodeEnrollmentRejected = "agent_enrollment_rejected"
	// ErrorCodeJoinRejected answers AgentEnrollment.Join (PermissionDenied)
	// for any unusable join token: unknown, of a deleted group, expired, or
	// of a group at its node cap. One answer, without detail, so tokens
	// cannot be probed; Control audits the reason.
	ErrorCodeJoinRejected = "join_rejected"
)

const (
	// NodeKindProxy is a proxy node, a v2_node row.
	NodeKindProxy = "proxy"
	// NodeKindForward is a forward node, a v2_forward_node row.
	NodeKindForward = "forward"
)

const (
	// MaintenanceSchemaV1 is MaintenanceEvents.version.
	MaintenanceSchemaV1 = "anixops.maintenance/v1"
	// MaxMaintenanceBatchEvents caps the events of one MaintenanceEvents.
	MaxMaintenanceBatchEvents = 50
	// MaxMaintenanceEventBytes caps one event's JSON.
	MaxMaintenanceEventBytes = 16 << 10
	// MaxMaintenanceBatchBytes caps the events of one batch together.
	MaxMaintenanceBatchBytes = 256 << 10
	// MaxMaintenanceEventIDLength caps an event_id.
	MaxMaintenanceEventIDLength = 128
)

const (
	// MaxPackageReportPayloadBytes caps PackageReport.payload_json.
	MaxPackageReportPayloadBytes = 256 << 10
	// MaxPackageReportKindLength caps PackageReport.kind.
	MaxPackageReportKindLength = 64
)

const (
	ProtocolV1          = "anix.agent.v1"
	CapabilityVersionV1 = "v1"
)

const (
	// CapabilityUpgrade: the Agent applies agent.upgrade operations through
	// its privileged updater (anixops-agent-updater.path). It adds no
	// stream payload.
	CapabilityUpgrade = "upgrade"
	// OperationKindAgentUpgrade is the DesiredOperation kind of an upgrade
	// or a rollback. It is not a capability name: the session must
	// negotiate upgrade.v1.
	OperationKindAgentUpgrade = "agent.upgrade"
	// UpgradeSchemaV1 is UpgradeRequest.Schema.
	UpgradeSchemaV1 = "anixops.agent-upgrade/v1"
	// UpgradeActionUpgrade installs TargetVersion from Artifacts.
	UpgradeActionUpgrade = "upgrade"
	// UpgradeActionRollback reinstates the binary the Agent kept from its
	// last upgrade, which must be TargetVersion; it carries no artifacts.
	UpgradeActionRollback = "rollback"
	// MaxUpgradeRequestBytes bounds payload_json.
	MaxUpgradeRequestBytes = 16 << 10
	// MaxUpgradeArtifactBytes bounds an artifact's size (the release zip).
	MaxUpgradeArtifactBytes = 256 << 20
	// KernelAnxNode is UpgradeKernel.Name of anx-node, AnixOps' own node
	// kernel with ANX (the private anx release), which the Agent runs as
	// its anixcore core.
	KernelAnxNode = "anx-node"
	// LabelKernelVersion is the Hello label in which an Agent names the
	// anx-node release it has installed (KernelVersionPattern); an Agent
	// without a kernel, or one that predates the label, leaves it out.
	LabelKernelVersion = "kernel.anx-node"
	// MaxUpgradeKernelBytes bounds a kernel package's size.
	MaxUpgradeKernelBytes = 64 << 20
)

const (
	// UpgradePhaseDownloading: APPLYING, fetching the artifact.
	UpgradePhaseDownloading = "downloading"
	// UpgradePhaseVerifying: APPLYING, checking size, SHA-256 and the
	// Ed25519 signature.
	UpgradePhaseVerifying = "verifying"
	// UpgradePhaseHandedOff: SUCCEEDED, the staged release and the request
	// are with the updater, which restarts the Agent. Control closes the
	// loop on the next Hello's agent_version.
	UpgradePhaseHandedOff = "handed_off"
	// UpgradePhaseCurrent: SUCCEEDED, the Agent already runs TargetVersion
	// (a replay after the restart, or a host that was upgraded through
	// another node identity).
	UpgradePhaseCurrent = "current"
)

const (
	UpgradeErrorInvalidRequest = "upgrade_invalid_request"
	UpgradeErrorNoArtifact     = "upgrade_no_artifact"
	UpgradeErrorDownload       = "upgrade_download_failed"
	UpgradeErrorDigest         = "upgrade_digest_mismatch"
	UpgradeErrorSignature      = "upgrade_signature_invalid"
	UpgradeErrorUpdater        = "upgrade_updater_unavailable"
	UpgradeErrorNoPrevious     = "upgrade_no_previous_release"
	UpgradeErrorBusy           = "upgrade_in_progress"
	UpgradeErrorDowngrade      = "upgrade_downgrade_refused"
)

const EnrollmentCredentialPrefix = "anixagt_"

const ErrorCodeCapabilityNotNegotiated = "agent_capability_not_negotiated"

const JoinTokenPrefix = "anixjoin_"

const UserExtraSS2022Key = "ss2022_key"