Files
cairnobs/deploy/operator
jcoffey-dev 4b5dae5879 Add local login, agent extra log paths, IPv4/IPv6 metrics; remediate security audit findings
This is a large squashed commit covering two batches of prior uncommitted
work plus a full security-audit remediation pass, kept together because
go.mod/go.sum and several shared files (main.go, handler.go) were touched
by both and splitting risked non-building intermediate commits.

Features (built earlier, previously uncommitted):
- Local username/password login for single-tenant deployments with no
  SSO configured (api/localauth, alerting/internal/sessioncheck,
  sentryctl users, web/src/routes/login, metadata migrations 0040/0041).
- Remotely-editable additional log file paths for agents, on top of
  their existing primary source (api/agents, agent/sentry-agent
  extra-file-path diffing, web agent config UI).
- IPv4/IPv6 addresses reported alongside other host system metrics.

Security audit remediation (this pass, all live-verified in production):
- Critical: block ClickHouse SSRF table functions (url/remote/file/s3/...)
  in the raw-SQL query escape hatch.
- High: deny sensitive paths and require Admin to add agent
  extra_file_paths (Editor could previously point an agent at /etc/shadow
  or an SSH key); alerting webhook targets now validate against
  internal/metadata/loopback addresses, both at creation and send time;
  alerting's session middleware now enforces an Editor+ floor on
  mutating requests instead of "any authenticated session"; bumped
  goxmldsig to close a SAML signature-verification bypass (GO-2026-4753).
- Medium: per-IP login rate limiting; security response headers
  (HSTS/CSP/nosniff/X-Frame-Options/Referrer-Policy/Permissions-Policy)
  on web/nginx.conf; a DevCredentialWarnings check in every Go service's
  config loader, logging loudly at startup if a deployment is still on
  docker-compose.yml's literal dev-only credentials; dependency bumps
  (golang.org/x/text, grpc, x/net, quick-xml, h2) across every affected
  Go module and both Rust crates, including a previously-uncovered x/net
  vulnerability in deploy/operator; a new security-scan.yml CI workflow
  running cargo-deny/govulncheck/npm-audit, mirroring the existing
  license-compliance.yml matrix shape.
- Low: removed sentryctl's plaintext --password flag (shell
  history/`ps` exposure) in favor of stdin and a --password-stdin flag
  for reset-password's optional specific-password path; a dummy bcrypt
  comparison closes a login response-time username-enumeration
  side-channel.
2026-08-18 23:53:20 -07:00
..

deploy/operator

A small controller-runtime Operator managing one CRD: Tenant (sentry.io/v1alpha1). See internal/controller/tenant_controller.go's doc comment for exactly what it reconciles and -- just as importantly -- what it deliberately doesn't (no ClickHouse calls, no Tantivy filesystem access, no enterprise/internal/rbacstore wiring; those are enterprise/internal/tenantprovision, still unbuilt).

Not kubebuilder-scaffolded

No kubebuilder/controller-gen binary was available in this environment, so this package is hand-written rather than generated:

  • api/v1alpha1/zz_generated.deepcopy.go -- normally controller-gen object output; hand-written here, covered by api/v1alpha1/api_test.go's round-trip tests (mutate a copy, assert the original is untouched -- exactly the class of bug a hand-written DeepCopy is prone to).
  • config/crd/sentry.io_tenants.yaml -- normally controller-gen crd output from the +kubebuilder:validation:* markers on api/v1alpha1/tenant_types.go; hand-written here and only as strong as keeping the two in sync by hand. Validated by strict-unmarshaling it into the real k8s.io/apiextensions-apiserver Go type (see /deploy/README.md's verification section) -- catches YAML/structural mistakes, not a drift between the CRD's field descriptions and the Go doc comments.
  • +kubebuilder:rbac markers on internal/controller/tenant_controller.go are present as documentation/intent (matching kubebuilder convention) but were never run through controller-gen rbac -- the actual ClusterRole is hand-written in /deploy/helm/sentry/templates/tenant-operator.yaml, kept in sync with those markers by hand, same caveat as the CRD above.

Layout

api/v1alpha1/          Tenant, TenantSpec, TenantStatus -- the CRD's Go types
internal/controller/    TenantReconciler -- see its doc comment
cmd/tenant-operator/     main.go -- manager setup, matches every other
                         service's cmd/<name>/main.go convention in this repo
config/crd/               hand-written CRD YAML (see above)

Building & testing

go build ./...
go vet ./...
go test ./...

Tests use sigs.k8s.io/controller-runtime/pkg/client/fake, not envtest -- envtest needs a real kube-apiserver/etcd binary pair (setup-envtest) not available in this environment. The fake client exercises real reconcile logic (object CRUD, owner references, status writes) but not anything a real apiserver does for you (admission, garbage collection, watch-triggered re-reconciliation) -- see internal/controller/tenant_controller_test.go's doc comment.

docker build -f Dockerfile -t sentry-tenant-operator .   # context is deploy/operator/, not the repo root

Not verified in this session -- see /deploy/README.md.

Trying it against a real cluster

kubectl apply -f config/crd/sentry.io_tenants.yaml
kubectl apply -f - <<'EOF'
apiVersion: sentry.io/v1alpha1
kind: Tenant
metadata:
  name: acme
spec:
  displayName: "Acme Corp"
EOF
kubectl get tenant acme -o yaml   # status.phase should reach Active
kubectl get secret sentry-tenant-acme-clickhouse -o yaml