Files
coder/coderd/audit/workspacebuild.go
T
Steven Masley 357e81b470 feat(coderd): list workspace secrets on workspace build audit entries (#30459)
Workspace build audit entries now list the build's secrets: name, env var, file path, and whether the request set the secret or it was carried forward from the previous build. Values are never included. Follows up on [this review thread](https://github.com/coder/coder/pull/30250#discussion_r4199276004).

**Stack** (design decisions in #30248)
1. #30248 Database schema, queries, and RBAC
2. #30249 Encryption at rest
3. #30250 Set secrets on workspace builds
4. #30251 Deliver secrets to the agent
5. #30252 Docs
6. #30388 List a build's secrets
7. **#30459 Audit a build's secrets (this PR)**

- Every workspace build audit entry includes its secrets, including builds that fail and orphaned deletes.
- The entry lists the build's full set of secrets. Removed secrets show up only by being absent.
- The three places that write build audit entries now share one helper instead of building the fields by hand.

<details>
<summary>Implementation details</summary>

- `audit.AdditionalFields` gains `workspace_secrets`: `name`, `env_name`, `file_path`, and `source` (`request` or `carry_forward`) for each secret.
- New `audit.WorkspaceBuildFields` is used for job success and failure in `provisionerdserver`, and for the orphan delete completed in `workspacebuilds.go`.
- `source` comes from the `workspace_secrets.source` column (#30248), set by `persistSecrets` (#30250).

</details>

<details>
<summary>Decision log</summary>

(existing decision log, unchanged)

</details>

---

*Created by Coder Agents on behalf of @Emyrk.*
2026-10-15 18:03:15 -05:00

63 lines
2.4 KiB
Go

package audit
import (
"context"
"strconv"
"golang.org/x/xerrors"
"github.com/coder/coder/v2/coderd/database"
"github.com/coder/coder/v2/coderd/database/dbauthz"
)
// WorkspaceBuildSecret is the metadata of a secret linked to a workspace
// build. Secret values are never audited. Ephemeral is recorded so an
// ephemeral secret missing from the next build's entry can be told apart
// from one the request removed.
type WorkspaceBuildSecret struct {
Name string `json:"name"`
EnvName string `json:"env_name"`
FilePath string `json:"file_path"`
Ephemeral bool `json:"ephemeral"`
Source database.WorkspaceSecretSource `json:"source"`
}
// WorkspaceSecretsUnavailable is the AdditionalFields.WorkspaceSecretsError
// value for an entry whose secrets could not be listed. It is a fixed marker
// so database error text never lands in the audit log.
const WorkspaceSecretsUnavailable = "unavailable"
// WorkspaceBuildFields returns the additional fields for a workspace build
// audit entry, including the full set of secrets linked to the build.
// Removed secrets have no row, so they are absent from the set. If the
// secrets cannot be listed, the other fields are still returned with the
// error and WorkspaceSecretsError is set.
func WorkspaceBuildFields(ctx context.Context, db database.Store, workspace database.Workspace, build database.WorkspaceBuild) (AdditionalFields, error) {
fields := AdditionalFields{
WorkspaceName: workspace.Name,
BuildNumber: strconv.FormatInt(int64(build.BuildNumber), 10),
BuildReason: build.Reason,
WorkspaceID: workspace.ID,
}
//nolint:gocritic // Audit entries list secret metadata for every build initiator; values are never read.
rows, err := db.GetWorkspaceSecretsHistory(dbauthz.AsWorkspaceSecretManager(ctx), database.GetWorkspaceSecretsHistoryParams{
WorkspaceID: workspace.ID,
WorkspaceBuildID: build.ID,
})
if err != nil {
fields.WorkspaceSecretsError = WorkspaceSecretsUnavailable
return fields, xerrors.Errorf("list workspace build secrets: %w", err)
}
for _, row := range rows {
fields.WorkspaceSecrets = append(fields.WorkspaceSecrets, WorkspaceBuildSecret{
Name: row.Name,
EnvName: row.EnvName,
FilePath: row.FilePath,
Ephemeral: row.Ephemeral,
Source: row.Source,
})
}
return fields, nil
}