Skip to content

chore: include organization id in workspace build audit log #9905

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 28, 2023
Merged

chore: include organization id in workspace build audit log #9905

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9e8f100
chore: include organization id in workspace build audit log
Emyrk Sep 28, 2023
ff73bab
rename 'BuildAudit' to 'WorkspaceBuildAudit'
Emyrk Sep 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions coderd/audit/request.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ type BuildAuditParams[T Auditable] struct {
JobID uuid.UUID
Status int
Action database.AuditAction
OrganizationID uuid.UUID
AdditionalFields json.RawMessage

New T
Expand Down Expand Up @@ -244,9 +245,9 @@ func InitRequest[T Auditable](w http.ResponseWriter, p *RequestParams) (*Request
}
}

// BuildAudit creates an audit log for a workspace build.
// WorkspaceBuildAudit creates an audit log for a workspace build.
// The audit log is committed upon invocation.
func BuildAudit[T Auditable](ctx context.Context, p *BuildAuditParams[T]) {
func WorkspaceBuildAudit[T Auditable](ctx context.Context, p *BuildAuditParams[T]) {
// As the audit request has not been initiated directly by a user, we omit
// certain user details.
ip := parseIP("")
Expand All @@ -267,6 +268,7 @@ func BuildAudit[T Auditable](ctx context.Context, p *BuildAuditParams[T]) {
ID: uuid.New(),
Time: dbtime.Now(),
UserID: p.UserID,
OrganizationID: p.OrganizationID,
Ip: ip,
UserAgent: sql.NullString{},
ResourceType: either(p.Old, p.New, ResourceType[T], p.Action),
Expand Down
6 changes: 4 additions & 2 deletions coderd/provisionerdserver/provisionerdserver.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -898,10 +898,11 @@ func (s *server) FailJob(ctx context.Context, failJob *proto.FailedJob) (*proto.
s.Logger.Error(ctx, "marshal workspace resource info for failed job", slog.Error(err))
}

audit.BuildAudit(ctx, &audit.BuildAuditParams[database.WorkspaceBuild]{
audit.WorkspaceBuildAudit(ctx, &audit.BuildAuditParams[database.WorkspaceBuild]{
Audit: *auditor,
Log: s.Logger,
UserID: job.InitiatorID,
OrganizationID: workspace.OrganizationID,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, that's the trick 👍 I assumed that OrganizationID should be passed together with UserID, but didn't think about pulling it out from workspace.

JobID: job.ID,
Action: auditAction,
Old: previousBuild,
Expand Down Expand Up @@ -1236,10 +1237,11 @@ func (s *server) CompleteJob(ctx context.Context, completed *proto.CompletedJob)
s.Logger.Error(ctx, "marshal resource info for successful job", slog.Error(err))
}

audit.BuildAudit(ctx, &audit.BuildAuditParams[database.WorkspaceBuild]{
audit.WorkspaceBuildAudit(ctx, &audit.BuildAuditParams[database.WorkspaceBuild]{
Audit: *auditor,
Log: s.Logger,
UserID: job.InitiatorID,
OrganizationID: workspace.OrganizationID,
JobID: job.ID,
Action: auditAction,
Old: previousBuild,
Expand Down