feat(auth): support tenantless provisioning and gated self-service workspace creation

Allow deployments to register users without auto-creating a personal tenant, expose creation policy via /auth/me, and guide tenantless accounts through a workspace onboarding flow.
This commit is contained in:
wizardchen
2026-07-13 18:04:14 +08:00
committed by lyingbug
parent 50b8c0a72e
commit ecf2c1fb9b
36 changed files with 1543 additions and 89 deletions
+21
View File
@@ -31,6 +31,14 @@ func NewUserRepository(db *gorm.DB) interfaces.UserRepository {
// CreateUser creates a user
func (r *userRepository) CreateUser(ctx context.Context, user *types.User) error {
// users.tenant_id is nullable in both PostgreSQL and SQLite. GORM would
// otherwise serialise the uint64 zero value as 0, which violates the
// PostgreSQL FK and loses the distinction between "not provisioned yet"
// and a real tenant. Omitting the column stores SQL NULL; reads hydrate it
// back as zero, the domain sentinel used by tenantless auth flows.
if user != nil && user.TenantID == 0 {
return r.db.WithContext(ctx).Omit("tenant_id").Create(user).Error
}
return r.db.WithContext(ctx).Create(user).Error
}
@@ -104,6 +112,19 @@ func (r *userRepository) GetUserByTenantID(ctx context.Context, tenantID uint64)
// UpdateUser updates a user
func (r *userRepository) UpdateUser(ctx context.Context, user *types.User) error {
if user != nil && user.TenantID == 0 {
return r.db.WithContext(ctx).Transaction(func(tx *gorm.DB) error {
// Preserve Save's all-fields behaviour while keeping the nullable
// tenant column out of the struct write, then explicitly store NULL.
// Writing uint64(0) would violate the PostgreSQL tenant FK.
if err := tx.Omit("tenant_id").Save(user).Error; err != nil {
return err
}
return tx.Model(&types.User{}).
Where("id = ?", user.ID).
UpdateColumn("tenant_id", nil).Error
})
}
return r.db.WithContext(ctx).Save(user).Error
}
@@ -0,0 +1,59 @@
package repository
import (
"context"
"testing"
"github.com/Tencent/WeKnora/internal/types"
"gorm.io/driver/sqlite"
"gorm.io/gorm"
)
func TestUserRepositoryTenantlessCreateAndUpdateKeepNullTenantID(t *testing.T) {
db, err := gorm.Open(sqlite.Open("file:user_tenantless?mode=memory&cache=shared"), &gorm.Config{})
if err != nil {
t.Fatalf("open sqlite: %v", err)
}
if err := db.AutoMigrate(&types.Tenant{}, &types.User{}); err != nil {
t.Fatalf("migrate: %v", err)
}
repo := NewUserRepository(db)
user := &types.User{
ID: "tenantless-user",
Username: "before-update",
Email: "tenantless@example.com",
PasswordHash: "hashed",
TenantID: 0,
IsActive: true,
}
if err := repo.CreateUser(context.Background(), user); err != nil {
t.Fatalf("CreateUser: %v", err)
}
assertNullTenantID(t, db, user.ID)
user.Username = "after-update"
if err := repo.UpdateUser(context.Background(), user); err != nil {
t.Fatalf("UpdateUser: %v", err)
}
assertNullTenantID(t, db, user.ID)
var stored types.User
if err := db.First(&stored, "id = ?", user.ID).Error; err != nil {
t.Fatalf("reload user: %v", err)
}
if stored.Username != "after-update" || stored.TenantID != 0 {
t.Fatalf("stored user = %#v", stored)
}
}
func assertNullTenantID(t *testing.T, db *gorm.DB, userID string) {
t.Helper()
var count int64
if err := db.Table("users").Where("id = ? AND tenant_id IS NULL", userID).Count(&count).Error; err != nil {
t.Fatalf("check tenant_id: %v", err)
}
if count != 1 {
t.Fatalf("tenant_id for user %s is not NULL", userID)
}
}
@@ -135,6 +135,15 @@ var registry = map[string]settingSpec{
Description: "自助注册模式。self_serve = 任何人可注册账号;invite_only = 关闭公网注册," +
"仅 Owner/Admin 可邀请。修改后立即生效,但谨慎对待 self_serve(公网会接受 spam)。",
},
"auth.default_tenant_mode": {
Type: "string",
EnvName: "WEKNORA_AUTH_DEFAULT_TENANT_MODE",
Default: "create_personal",
Enum: []string{"create_personal", "tenantless"},
Category: "auth",
Description: "公开注册成功后的默认租户策略。create_personal = 自动创建个人租户并设为 Owner;" +
"tenantless = 仅创建用户,等待接受邀请或主动创建租户。修改后只影响新注册用户。",
},
// tenant.max_owned_per_user caps how many tenants a single non-superuser
// can create (and Own) via self-service POST /tenants. Read on every
// request — UI edits take effect immediately, no restart required. The
@@ -150,6 +159,14 @@ var registry = map[string]settingSpec{
Description: "每个非超管用户通过自助创建可拥有的最大租户数。每次创建租户时实时读取," +
"修改后立即生效。0 表示使用内置默认值 10;负数表示完全关闭限制(不建议在公开部署使用)。",
},
"tenant.self_service_creation_enabled": {
Type: "bool",
EnvName: "WEKNORA_TENANT_SELF_SERVICE_CREATION_ENABLED",
Default: true,
Category: "tenant",
Description: "是否允许非超管用户主动创建租户。关闭后,普通用户只能通过邀请加入已有租户;" +
"跨租户超管仍可创建。修改后立即生效。",
},
// tenant.default_storage_quota_gb is the default storage quota (in GB)
// applied to a newly-created tenant when the caller doesn't specify
// one explicitly. Read at create time only — changing the value does
+100 -22
View File
@@ -103,18 +103,29 @@ func (s *userService) Register(ctx context.Context, req *types.RegisterRequest)
return nil, errors.New("failed to process password")
}
// Create default tenant for the user
// Note: RetrieverEngines is left empty - system will use defaults from RETRIEVE_DRIVER env
tenant := &types.Tenant{
Name: fmt.Sprintf("%s's Workspace", secutils.SanitizeForLog(req.Username)),
Description: "Default workspace",
Status: "active",
provisioning := req.TenantProvisioning
if provisioning == "" {
provisioning = types.TenantProvisioningCreatePersonal
}
if !provisioning.IsValid() {
return nil, fmt.Errorf("invalid tenant provisioning mode %q", provisioning)
}
createdTenant, err := s.tenantService.CreateTenant(ctx, tenant)
if err != nil {
logger.Errorf(ctx, "Failed to create tenant")
return nil, errors.New("failed to create workspace")
var createdTenant *types.Tenant
if provisioning == types.TenantProvisioningCreatePersonal {
// Note: RetrieverEngines is left empty - system will use defaults
// from RETRIEVE_DRIVER env.
tenant := &types.Tenant{
Name: fmt.Sprintf("%s's Workspace", secutils.SanitizeForLog(req.Username)),
Description: "Default workspace",
Status: "active",
}
createdTenant, err = s.tenantService.CreateTenant(ctx, tenant)
if err != nil {
logger.Errorf(ctx, "Failed to create tenant")
return nil, errors.New("failed to create workspace")
}
}
// Create user
@@ -123,15 +134,23 @@ func (s *userService) Register(ctx context.Context, req *types.RegisterRequest)
Username: req.Username,
Email: req.Email,
PasswordHash: string(hashedPassword),
TenantID: createdTenant.ID,
TenantID: 0,
IsActive: true,
CreatedAt: time.Now(),
UpdatedAt: time.Now(),
}
if createdTenant != nil {
user.TenantID = createdTenant.ID
}
err = s.userRepo.CreateUser(ctx, user)
if err != nil {
logger.Errorf(ctx, "Failed to create user: %v", err)
if createdTenant != nil {
if rollbackErr := s.tenantService.DeleteTenant(ctx, createdTenant.ID); rollbackErr != nil {
logger.Errorf(ctx, "Failed to roll back tenant %d after user creation failure: %v", createdTenant.ID, rollbackErr)
}
}
return nil, errors.New("failed to create user")
}
@@ -139,10 +158,13 @@ func (s *userService) Register(ctx context.Context, req *types.RegisterRequest)
// the tenant their account just created. Failure here only logs — the
// user record exists and the auth middleware's orphan-tenant recovery
// path will recreate the membership on next login.
if s.memberService != nil {
if createdTenant != nil && s.memberService != nil {
if _, err := s.memberService.EnsureOwner(ctx, user.ID, createdTenant.ID); err != nil {
logger.Errorf(ctx, "Failed to create owner membership for user %s tenant %d: %v",
user.ID, createdTenant.ID, err)
_ = s.userRepo.DeleteUser(ctx, user.ID)
_ = s.tenantService.DeleteTenant(ctx, createdTenant.ID)
return nil, errors.New("failed to finalise workspace ownership")
}
}
@@ -206,12 +228,16 @@ func (s *userService) Login(ctx context.Context, req *types.LoginRequest) (*type
}
logger.Info(ctx, "Tokens generated successfully")
// Get tenant information
tenant, err := s.tenantService.GetTenantByID(ctx, resolvedTenantID)
if err != nil {
logger.Warn(ctx, "Failed to get tenant info")
} else {
logger.Info(ctx, "Tenant information retrieved successfully")
// Get tenant information. A zero resolved ID is a valid tenantless
// identity, not a failed tenant lookup.
var tenant *types.Tenant
if resolvedTenantID > 0 {
tenant, err = s.tenantService.GetTenantByID(ctx, resolvedTenantID)
if err != nil {
logger.Warn(ctx, "Failed to get tenant info")
} else {
logger.Info(ctx, "Tenant information retrieved successfully")
}
}
memberships := s.buildMembershipsForUser(ctx, user, tenant)
@@ -625,7 +651,9 @@ func (s *userService) GenerateTokens(
// freshly minted access token. The contract:
//
// 1. If the user has no LastActiveTenantID preference set (or it points
// at home), return home — the historical behaviour.
// at home), return home — the historical behaviour. A tenantless user
// with an active membership adopts their earliest membership instead;
// this repairs partial invitation/admin-assignment flows.
// 2. Otherwise validate the preference: the tenant must still exist and
// the user must still have an active membership (or be a cross-tenant
// superuser). Validation failure logs a warning, best-effort clears
@@ -641,6 +669,9 @@ func (s *userService) resolveLoginTenantID(ctx context.Context, user *types.User
}
pref := user.Preferences.LastActiveTenantID
if pref == nil || *pref == 0 || *pref == user.TenantID {
if user.TenantID == 0 {
return s.resolveFirstMembershipTenant(ctx, user)
}
return user.TenantID
}
preferred := *pref
@@ -680,6 +711,46 @@ func (s *userService) resolveLoginTenantID(ctx context.Context, user *types.User
return preferred
}
// resolveFirstMembershipTenant makes a tenantless identity usable when an
// active membership already exists (for example, an invitation was accepted
// but persisting the default tenant failed). ListByUser is stably ordered by
// join time, so the earliest valid membership is deterministic. Persisting it
// as home is best-effort: even if the repair write fails, the freshly issued
// token can still be scoped to the membership and the next login retries.
func (s *userService) resolveFirstMembershipTenant(ctx context.Context, user *types.User) uint64 {
if user == nil || s.memberService == nil {
return 0
}
members, err := s.memberService.ListByUser(ctx, user.ID)
if err != nil {
logger.Warnf(ctx, "resolveLoginTenantID: failed to list memberships for tenantless user %s: %v", user.ID, err)
return 0
}
for _, member := range members {
if member == nil || member.TenantID == 0 || member.Status != types.TenantMemberStatusActive {
continue
}
if s.tenantService != nil {
if _, err := s.tenantService.GetTenantByID(ctx, member.TenantID); err != nil {
logger.Warnf(ctx, "resolveLoginTenantID: tenant %d for tenantless user %s is unavailable: %v",
member.TenantID, user.ID, err)
continue
}
}
user.TenantID = member.TenantID
if s.userRepo != nil {
if err := s.userRepo.UpdateUser(ctx, user); err != nil {
logger.Warnf(ctx, "resolveLoginTenantID: failed to persist tenant %d for tenantless user %s: %v",
member.TenantID, user.ID, err)
user.TenantID = 0
}
}
return member.TenantID
}
return 0
}
// clearLastActiveTenantPreference is the best-effort cleanup half of
// resolveLoginTenantID. Failures here are logged but never propagated:
// the in-memory user already has the preference cleared for this login,
@@ -1261,10 +1332,17 @@ func (s *userService) provisionOIDCUser(ctx context.Context, info *types.OIDCUse
return nil, fmt.Errorf("failed to generate password for OIDC user: %w", err)
}
provisioning := types.TenantProvisioningCreatePersonal
if s.config != nil && s.config.OIDCAuth != nil &&
strings.TrimSpace(s.config.OIDCAuth.DefaultTenantMode) == config.AuthDefaultTenantModeTenantless {
provisioning = types.TenantProvisioningTenantless
}
user, err := s.Register(ctx, &types.RegisterRequest{
Username: username,
Email: info.Email,
Password: randomPassword,
Username: username,
Email: info.Email,
Password: randomPassword,
TenantProvisioning: provisioning,
})
if err != nil {
return nil, fmt.Errorf("failed to auto-provision OIDC user: %w", err)
@@ -0,0 +1,96 @@
package service
import (
"context"
"testing"
"github.com/Tencent/WeKnora/internal/types"
"github.com/Tencent/WeKnora/internal/types/interfaces"
)
type provisioningUserRepo struct {
interfaces.UserRepository
created *types.User
updatedTenant uint64
}
func (r *provisioningUserRepo) GetUserByEmail(context.Context, string) (*types.User, error) {
return nil, nil
}
func (r *provisioningUserRepo) GetUserByUsername(context.Context, string) (*types.User, error) {
return nil, nil
}
func (r *provisioningUserRepo) CreateUser(_ context.Context, user *types.User) error {
copy := *user
r.created = &copy
return nil
}
func (r *provisioningUserRepo) UpdateUser(_ context.Context, user *types.User) error {
r.updatedTenant = user.TenantID
return nil
}
type provisioningTenantService struct {
interfaces.TenantService
createCalls int
}
func (s *provisioningTenantService) CreateTenant(context.Context, *types.Tenant) (*types.Tenant, error) {
s.createCalls++
return &types.Tenant{ID: 99}, nil
}
func (s *provisioningTenantService) GetTenantByID(_ context.Context, id uint64) (*types.Tenant, error) {
return &types.Tenant{ID: id}, nil
}
type provisioningMemberService struct {
interfaces.TenantMemberService
members []*types.TenantMember
}
func (s *provisioningMemberService) ListByUser(context.Context, string) ([]*types.TenantMember, error) {
return s.members, nil
}
func TestUserServiceRegisterTenantlessSkipsTenantCreation(t *testing.T) {
repo := &provisioningUserRepo{}
tenantSvc := &provisioningTenantService{}
svc := &userService{userRepo: repo, tenantService: tenantSvc}
user, err := svc.Register(context.Background(), &types.RegisterRequest{
Username: "alice",
Email: "alice@example.com",
Password: "supersecret",
TenantProvisioning: types.TenantProvisioningTenantless,
})
if err != nil {
t.Fatalf("Register: %v", err)
}
if tenantSvc.createCalls != 0 {
t.Fatalf("tenant create calls = %d, want 0", tenantSvc.createCalls)
}
if user.TenantID != 0 || repo.created == nil || repo.created.TenantID != 0 {
t.Fatalf("tenantless user persisted with tenant: user=%d created=%v", user.TenantID, repo.created)
}
}
func TestResolveLoginTenantIDRepairsTenantlessUserWithMembership(t *testing.T) {
repo := &provisioningUserRepo{}
tenantSvc := &provisioningTenantService{}
memberSvc := &provisioningMemberService{members: []*types.TenantMember{
{TenantID: 42, Status: types.TenantMemberStatusActive},
}}
svc := &userService{userRepo: repo, tenantService: tenantSvc, memberService: memberSvc}
user := &types.User{ID: "alice", TenantID: 0}
if got := svc.resolveLoginTenantID(context.Background(), user); got != 42 {
t.Fatalf("resolved tenant = %d, want 42", got)
}
if repo.updatedTenant != 42 || user.TenantID != 42 {
t.Fatalf("repair was not persisted: repo=%d user=%d", repo.updatedTenant, user.TenantID)
}
}