Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

feat(enterprise): add auditing to SCIM#13614

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.

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

Already on GitHub?Sign in to your account

Merged
coadler merged 1 commit intomainfromcolin/feat_enterprise_add_auditing_to_scim
Jun 20, 2024
Merged
Show file tree
Hide file tree
Changes fromall commits
Commits
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
15 changes: 11 additions & 4 deletionscoderd/audit/request.go
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -31,7 +31,7 @@ type RequestParams struct {
OrganizationID uuid.UUID
Request*http.Request
Action database.AuditAction
AdditionalFieldsjson.RawMessage
AdditionalFieldsinterface{}
}

typeRequest[TAuditable]struct {
Expand DownExpand Up@@ -283,8 +283,15 @@ func InitRequest[T Auditable](w http.ResponseWriter, p *RequestParams) (*Request
}
}

ifp.AdditionalFields==nil {
p.AdditionalFields=json.RawMessage("{}")
additionalFieldsRaw:=json.RawMessage("{}")

ifp.AdditionalFields!=nil {
data,err:=json.Marshal(p.AdditionalFields)
iferr!=nil {
p.Log.Warn(logCtx,"marshal additional fields",slog.Error(err))
}else {
additionalFieldsRaw=json.RawMessage(data)
}
}

varuserID uuid.UUID
Expand DownExpand Up@@ -319,7 +326,7 @@ func InitRequest[T Auditable](w http.ResponseWriter, p *RequestParams) (*Request
Diff:diffRaw,
StatusCode:int32(sw.Status),
RequestID:httpmw.RequestID(p.Request),
AdditionalFields:p.AdditionalFields,
AdditionalFields:additionalFieldsRaw,
OrganizationID:requireOrgID[T](logCtx,p.OrganizationID,p.Log),
}
err:=p.Audit.Export(ctx,auditLog)
Expand Down
7 changes: 1 addition & 6 deletionscoderd/workspaces.go
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -361,17 +361,12 @@ func (api *API) postWorkspacesByOrganization(rw http.ResponseWriter, r *http.Req
}
)

wriBytes, err := json.Marshal(workspaceResourceInfo)
if err != nil {
api.Logger.Warn(ctx, "marshal workspace owner name")
}

aReq, commitAudit := audit.InitRequest[database.Workspace](rw, &audit.RequestParams{
Audit: *auditor,
Log: api.Logger,
Request: r,
Action: database.AuditActionCreate,
AdditionalFields:wriBytes,
AdditionalFields:workspaceResourceInfo,
OrganizationID: organization.ID,
})

Expand Down
39 changes: 37 additions & 2 deletionsenterprise/coderd/scim.go
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,7 @@ import (
"golang.org/x/xerrors"

agpl"github.com/coder/coder/v2/coderd"
"github.com/coder/coder/v2/coderd/audit"
"github.com/coder/coder/v2/coderd/database"
"github.com/coder/coder/v2/coderd/database/dbauthz"
"github.com/coder/coder/v2/coderd/database/dbtime"
Expand DownExpand Up@@ -118,6 +119,11 @@ type SCIMUser struct {
}`json:"meta"`
}

varSCIMAuditAdditionalFields=map[string]string{
"automatic_actor":"coder",
"automatic_subsystem":"scim",
}

// scimPostUser creates a new user, or returns the existing user if it exists.
//
// @Summary SCIM 2.0: Create new user
Expand All@@ -135,6 +141,16 @@ func (api *API) scimPostUser(rw http.ResponseWriter, r *http.Request) {
return
}

auditor:=*api.AGPL.Auditor.Load()
aReq,commitAudit:=audit.InitRequest[database.User](rw,&audit.RequestParams{
Audit:auditor,
Log:api.Logger,
Request:r,
Action:database.AuditActionCreate,
AdditionalFields:SCIMAuditAdditionalFields,
})
defercommitAudit()

varsUserSCIMUser
err:=json.NewDecoder(r.Body).Decode(&sUser)
iferr!=nil {
Expand DownExpand Up@@ -170,7 +186,7 @@ func (api *API) scimPostUser(rw http.ResponseWriter, r *http.Request) {

ifsUser.Active&&dbUser.Status==database.UserStatusSuspended {
//nolint:gocritic
_,err=api.Database.UpdateUserStatus(dbauthz.AsSystemRestricted(r.Context()), database.UpdateUserStatusParams{
newUser,err:=api.Database.UpdateUserStatus(dbauthz.AsSystemRestricted(r.Context()), database.UpdateUserStatusParams{
ID:dbUser.ID,
// The user will get transitioned to Active after logging in.
Status:database.UserStatusDormant,
Expand All@@ -180,8 +196,13 @@ func (api *API) scimPostUser(rw http.ResponseWriter, r *http.Request) {
_=handlerutil.WriteError(rw,err)
return
}
aReq.New=newUser
}else {
aReq.New=dbUser
}

aReq.Old=dbUser

httpapi.Write(ctx,rw,http.StatusOK,sUser)
return
}
Expand DownExpand Up@@ -223,6 +244,8 @@ func (api *API) scimPostUser(rw http.ResponseWriter, r *http.Request) {
_=handlerutil.WriteError(rw,err)
return
}
aReq.New=dbUser
aReq.UserID=dbUser.ID

sUser.ID=dbUser.ID.String()
sUser.UserName=dbUser.Username
Expand All@@ -248,6 +271,15 @@ func (api *API) scimPatchUser(rw http.ResponseWriter, r *http.Request) {
return
}

auditor:=*api.AGPL.Auditor.Load()
aReq,commitAudit:=audit.InitRequest[database.User](rw,&audit.RequestParams{
Audit:auditor,
Log:api.Logger,
Request:r,
Action:database.AuditActionWrite,
})
defercommitAudit()

id:=chi.URLParam(r,"id")

varsUserSCIMUser
Expand All@@ -270,6 +302,8 @@ func (api *API) scimPatchUser(rw http.ResponseWriter, r *http.Request) {
_=handlerutil.WriteError(rw,err)
return
}
aReq.Old=dbUser
aReq.UserID=dbUser.ID

varstatus database.UserStatus
ifsUser.Active {
Expand All@@ -280,7 +314,7 @@ func (api *API) scimPatchUser(rw http.ResponseWriter, r *http.Request) {
}

//nolint:gocritic // needed for SCIM
_,err=api.Database.UpdateUserStatus(dbauthz.AsSystemRestricted(r.Context()), database.UpdateUserStatusParams{
userNew,err:=api.Database.UpdateUserStatus(dbauthz.AsSystemRestricted(r.Context()), database.UpdateUserStatusParams{
ID:dbUser.ID,
Status:status,
UpdatedAt:dbtime.Now(),
Expand All@@ -289,6 +323,7 @@ func (api *API) scimPatchUser(rw http.ResponseWriter, r *http.Request) {
_=handlerutil.WriteError(rw,err)
return
}
aReq.New=userNew

httpapi.Write(ctx,rw,http.StatusOK,sUser)
}
36 changes: 31 additions & 5 deletionsenterprise/coderd/scim_test.go
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,9 @@ import (
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"

"github.com/coder/coder/v2/coderd/audit"
"github.com/coder/coder/v2/coderd/coderdtest"
"github.com/coder/coder/v2/coderd/database"
"github.com/coder/coder/v2/codersdk"
"github.com/coder/coder/v2/cryptorand"
"github.com/coder/coder/v2/enterprise/coderd"
Expand DownExpand Up@@ -109,21 +112,34 @@ func TestScim(t *testing.T) {
defercancel()

scimAPIKey:= []byte("hi")
mockAudit:=audit.NewMock()
client,_:=coderdenttest.New(t,&coderdenttest.Options{
SCIMAPIKey:scimAPIKey,
Options:&coderdtest.Options{Auditor:mockAudit},
SCIMAPIKey:scimAPIKey,
AuditLogging:true,
LicenseOptions:&coderdenttest.LicenseOptions{
AccountID:"coolin",
Features: license.Features{
codersdk.FeatureSCIM:1,
codersdk.FeatureSCIM:1,
codersdk.FeatureAuditLog:1,
},
},
})
mockAudit.ResetLogs()

sUser:=makeScimUser(t)
res,err:=client.Request(ctx,"POST","/scim/v2/Users",sUser,setScimAuth(scimAPIKey))
require.NoError(t,err)
deferres.Body.Close()
assert.Equal(t,http.StatusOK,res.StatusCode)
require.Equal(t,http.StatusOK,res.StatusCode)

aLogs:=mockAudit.AuditLogs()
require.Len(t,aLogs,1)
af:=map[string]string{}
err=json.Unmarshal([]byte(aLogs[0].AdditionalFields),&af)
require.NoError(t,err)
assert.Equal(t,coderd.SCIMAuditAdditionalFields,af)
assert.Equal(t,database.AuditActionCreate,aLogs[0].Action)

userRes,err:=client.Users(ctx, codersdk.UsersRequest{Search:sUser.Emails[0].Value})
require.NoError(t,err)
Expand DownExpand Up@@ -306,21 +322,27 @@ func TestScim(t *testing.T) {
defercancel()

scimAPIKey:= []byte("hi")
mockAudit:=audit.NewMock()
client,_:=coderdenttest.New(t,&coderdenttest.Options{
SCIMAPIKey:scimAPIKey,
Options:&coderdtest.Options{Auditor:mockAudit},
SCIMAPIKey:scimAPIKey,
AuditLogging:true,
LicenseOptions:&coderdenttest.LicenseOptions{
AccountID:"coolin",
Features: license.Features{
codersdk.FeatureSCIM:1,
codersdk.FeatureSCIM:1,
codersdk.FeatureAuditLog:1,
},
},
})
mockAudit.ResetLogs()

sUser:=makeScimUser(t)
res,err:=client.Request(ctx,"POST","/scim/v2/Users",sUser,setScimAuth(scimAPIKey))
require.NoError(t,err)
deferres.Body.Close()
assert.Equal(t,http.StatusOK,res.StatusCode)
mockAudit.ResetLogs()

err=json.NewDecoder(res.Body).Decode(&sUser)
require.NoError(t,err)
Expand All@@ -333,6 +355,10 @@ func TestScim(t *testing.T) {
_=res.Body.Close()
assert.Equal(t,http.StatusOK,res.StatusCode)

aLogs:=mockAudit.AuditLogs()
require.Len(t,aLogs,1)
assert.Equal(t,database.AuditActionWrite,aLogs[0].Action)

userRes,err:=client.Users(ctx, codersdk.UsersRequest{Search:sUser.Emails[0].Value})
require.NoError(t,err)
require.Len(t,userRes.Users,1)
Expand Down
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -56,3 +56,45 @@ export const UnsuccessfulLoginForUnknownUser: Story = {
auditLog: MockAuditLogUnsuccessfulLoginKnownUser,
},
};

export const CreateUser: Story = {
args: {
auditLog: {
...MockAuditLog,
resource_type: "user",
resource_target: "colin",
description: "{user} created user {target}",
},
},
};

export const SCIMCreateUser: Story = {
args: {
auditLog: {
...MockAuditLog,
resource_type: "user",
resource_target: "colin",
description: "{user} created user {target}",
additional_fields: {
automatic_actor: "coder",
automatic_subsystem: "scim",
},
},
},
};

export const SCIMUpdateUser: Story = {
args: {
auditLog: {
...MockAuditLog,
action: "write",
resource_type: "user",
resource_target: "colin",
description: "{user} updated user {target}",
additional_fields: {
automatic_actor: "coder",
automatic_subsystem: "scim",
},
},
},
};
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,7 @@ export const AuditLogDescription: FC<AuditLogDescriptionProps> = ({
auditLog,
})=>{
lettarget=auditLog.resource_target.trim();
constuser=auditLog.user?.username.trim();
letuser=auditLog.user?.username.trim();

if(auditLog.resource_type==="workspace_build"){
return<BuildAuditDescriptionauditLog={auditLog}/>;
Expand All@@ -23,6 +23,14 @@ export const AuditLogDescription: FC<AuditLogDescriptionProps> = ({
target="";
}

// This occurs when SCIM creates a user.
if(
auditLog.resource_type==="user"&&
auditLog.additional_fields?.automatic_actor==="coder"
){
user="Coder automatically";
}

consttruncatedDescription=auditLog.description
.replace("{user}",`${user}`)
.replace("{target}","");
Expand Down
Loading
[8]ページ先頭
©2009-2025 Movatter.jp