fix(enterprise): ensure creating a SCIM user is idempotent (#8730)

This commit is contained in:
Colin Adler
2023-07-25 17:49:52 -05:00
committed by GitHub
parent 0feb855b8f
commit f07d2ff68d
2 changed files with 53 additions and 1 deletions

View File

@ -2,6 +2,7 @@ package coderd
import (
"crypto/subtle"
"database/sql"
"encoding/json"
"net/http"
@ -11,6 +12,7 @@ import (
scimjson "github.com/imulab/go-scim/pkg/v2/json"
"github.com/imulab/go-scim/pkg/v2/service"
"github.com/imulab/go-scim/pkg/v2/spec"
"golang.org/x/xerrors"
agpl "github.com/coder/coder/coderd"
"github.com/coder/coder/coderd/database"
@ -152,6 +154,23 @@ func (api *API) scimPostUser(rw http.ResponseWriter, r *http.Request) {
return
}
//nolint:gocritic
user, err := api.Database.GetUserByEmailOrUsername(dbauthz.AsSystemRestricted(ctx), database.GetUserByEmailOrUsernameParams{
Email: email,
Username: sUser.UserName,
})
if err != nil && !xerrors.Is(err, sql.ErrNoRows) {
_ = handlerutil.WriteError(rw, err)
return
}
if err == nil {
sUser.ID = user.ID.String()
sUser.UserName = user.Username
httpapi.Write(ctx, rw, http.StatusOK, sUser)
return
}
// The username is a required property in Coder. We make a best-effort
// attempt at using what the claims provide, but if that fails we will
// generate a random username.
@ -182,7 +201,7 @@ func (api *API) scimPostUser(rw http.ResponseWriter, r *http.Request) {
}
//nolint:gocritic // needed for SCIM
user, _, err := api.AGPL.CreateUser(dbauthz.AsSystemRestricted(ctx), api.Database, agpl.CreateUserRequest{
user, _, err = api.AGPL.CreateUser(dbauthz.AsSystemRestricted(ctx), api.Database, agpl.CreateUserRequest{
CreateUserRequest: codersdk.CreateUserRequest{
Username: sUser.UserName,
Email: email,

View File

@ -131,6 +131,39 @@ func TestScim(t *testing.T) {
assert.Equal(t, sUser.UserName, userRes.Users[0].Username)
})
t.Run("Duplicate", func(t *testing.T) {
t.Parallel()
ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
defer cancel()
scimAPIKey := []byte("hi")
client, _ := coderdenttest.New(t, &coderdenttest.Options{
SCIMAPIKey: scimAPIKey,
LicenseOptions: &coderdenttest.LicenseOptions{
AccountID: "coolin",
Features: license.Features{
codersdk.FeatureSCIM: 1,
},
},
})
sUser := makeScimUser(t)
for i := 0; i < 3; i++ {
res, err := client.Request(ctx, "POST", "/scim/v2/Users", sUser, setScimAuth(scimAPIKey))
require.NoError(t, err)
_ = res.Body.Close()
assert.Equal(t, http.StatusOK, res.StatusCode)
}
userRes, err := client.Users(ctx, codersdk.UsersRequest{Search: sUser.Emails[0].Value})
require.NoError(t, err)
require.Len(t, userRes.Users, 1)
assert.Equal(t, sUser.Emails[0].Value, userRes.Users[0].Email)
assert.Equal(t, sUser.UserName, userRes.Users[0].Username)
})
t.Run("DomainStrips", func(t *testing.T) {
t.Parallel()