Files
cloudpods/pkg/keystone/models/users.go
T

659 lines
20 KiB
Go

// Copyright 2019 Yunion
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package models
import (
"context"
"database/sql"
"fmt"
"time"
"yunion.io/x/pkg/errors"
"yunion.io/x/jsonutils"
"yunion.io/x/log"
"yunion.io/x/pkg/tristate"
"yunion.io/x/sqlchemy"
api "yunion.io/x/onecloud/pkg/apis/identity"
"yunion.io/x/onecloud/pkg/cloudcommon/consts"
"yunion.io/x/onecloud/pkg/cloudcommon/db"
"yunion.io/x/onecloud/pkg/cloudcommon/policy"
"yunion.io/x/onecloud/pkg/httperrors"
"yunion.io/x/onecloud/pkg/keystone/options"
"yunion.io/x/onecloud/pkg/mcclient"
"yunion.io/x/onecloud/pkg/util/logclient"
"yunion.io/x/onecloud/pkg/util/rbacutils"
"yunion.io/x/onecloud/pkg/util/seclib2"
"yunion.io/x/onecloud/pkg/util/stringutils2"
)
type SUserManager struct {
SEnabledIdentityBaseResourceManager
}
var UserManager *SUserManager
func init() {
UserManager = &SUserManager{
SEnabledIdentityBaseResourceManager: NewEnabledIdentityBaseResourceManager(
SUser{},
"user",
"user",
"users",
),
}
UserManager.SetVirtualObject(UserManager)
}
/*
+--------------------+-------------+------+-----+---------+-------+
| Field | Type | Null | Key | Default | Extra |
+--------------------+-------------+------+-----+---------+-------+
| id | varchar(64) | NO | PRI | NULL | |
| extra | text | YES | | NULL | |
| enabled | tinyint(1) | YES | | NULL | |
| default_project_id | varchar(64) | YES | MUL | NULL | |
| created_at | datetime | YES | | NULL | |
| last_active_at | date | YES | | NULL | |
| domain_id | varchar(64) | NO | MUL | NULL | |
+--------------------+-------------+------+-----+---------+-------+
*/
type SUser struct {
SEnabledIdentityBaseResource
Email string `width:"64" charset:"ascii" nullable:"true" index:"true" list:"domain" update:"domain" create:"domain_optional"`
Mobile string `width:"20" charset:"ascii" nullable:"true" index:"true" list:"domain" update:"domain" create:"domain_optional"`
Displayname string `with:"128" charset:"utf8" nullable:"true" list:"domain" update:"domain" create:"domain_optional"`
LastActiveAt time.Time `nullable:"true" list:"domain"`
LastLoginIp string `nullable:"true" list:"domain"`
LastLoginSource string `nullable:"true" list:"domain"`
IsSystemAccount tristate.TriState `nullable:"false" default:"false" list:"domain" update:"domain" create:"domain_optional"`
DefaultProjectId string `width:"64" charset:"ascii" nullable:"true"`
AllowWebConsole tristate.TriState `nullable:"false" default:"true" list:"domain" update:"domain" create:"domain_optional"`
EnableMfa tristate.TriState `nullable:"false" default:"true" list:"domain" update:"domain" create:"domain_optional"`
}
func (manager *SUserManager) GetContextManagers() [][]db.IModelManager {
return [][]db.IModelManager{
{GroupManager},
{ProjectManager},
}
}
func (manager *SUserManager) InitializeData() error {
q := manager.Query().IsNullOrEmpty("name")
users := make([]SUser, 0)
err := db.FetchModelObjects(manager, q, &users)
if err != nil {
return errors.Wrap(err, "FetchModelObjects")
}
for i := range users {
extUser, err := manager.FetchUserExtended(users[i].Id, "", "", "")
if err != nil {
return errors.Wrap(err, "FetchUserExtended")
}
name := extUser.LocalName
if len(name) == 0 {
name = extUser.IdpName
}
desc, _ := users[i].Extra.GetString("description")
email, _ := users[i].Extra.GetString("email")
mobile, _ := users[i].Extra.GetString("mobile")
dispName, _ := users[i].Extra.GetString("displayname")
_, err = db.Update(&users[i], func() error {
users[i].Name = name
if len(email) > 0 {
users[i].Email = email
}
if len(mobile) > 0 {
users[i].Mobile = mobile
}
if len(dispName) > 0 {
users[i].Displayname = dispName
}
if len(desc) > 0 {
users[i].Description = desc
}
return nil
})
if err != nil {
return errors.Wrap(err, "update")
}
}
err = manager.initSystemAccount()
if err != nil {
return errors.Wrap(err, "initSystemAccount")
}
return manager.initSysUser()
}
func (manager *SUserManager) initSystemAccount() error {
q := manager.Query().IsNotEmpty("default_project_id")
users := make([]SUser, 0)
err := db.FetchModelObjects(manager, q, &users)
if err != nil {
return errors.Wrap(err, "FetchModelObjects")
}
for i := range users {
_, err = db.Update(&users[i], func() error {
users[i].IsSystemAccount = tristate.True
users[i].DefaultProjectId = ""
return nil
})
if err != nil {
return errors.Wrap(err, "update")
}
}
return nil
}
func (manager *SUserManager) initSysUser() error {
q := manager.Query().Equals("name", api.SystemAdminUser)
q = q.Equals("domain_id", api.DEFAULT_DOMAIN_ID)
cnt, err := q.CountWithError()
if err != nil {
return errors.Wrap(err, "query")
}
if cnt == 1 {
return nil
}
if cnt > 2 {
// ???
log.Fatalf("duplicate sysadmin account???")
}
// insert
usr := SUser{}
usr.Name = api.SystemAdminUser
usr.DomainId = api.DEFAULT_DOMAIN_ID
usr.Enabled = tristate.True
usr.Description = "Boostrap system default admin user"
usr.SetModelManager(manager, &usr)
err = manager.TableSpec().Insert(&usr)
if err != nil {
return errors.Wrap(err, "insert")
}
err = usr.initLocalData(options.Options.BootstrapAdminUserPassword)
if err != nil {
return errors.Wrap(err, "initLocalData")
}
return nil
}
/*
Fetch extended userinfo by Id or name + domainId or name + domainName
*/
func (manager *SUserManager) FetchUserExtended(userId, userName, domainId, domainName string) (*api.SUserExtended, error) {
if len(userId) == 0 && len(userName) == 0 {
return nil, sqlchemy.ErrEmptyQuery
}
localUsers := LocalUserManager.Query().SubQuery()
// nonlocalUsers := NonlocalUserManager.Query().SubQuery()
users := UserManager.Query().SubQuery()
domains := DomainManager.Query().SubQuery()
idmappings := IdmappingManager.Query().SubQuery()
q := users.Query(
users.Field("id"),
users.Field("name"),
users.Field("enabled"),
users.Field("default_project_id"),
users.Field("created_at"),
users.Field("last_active_at"),
users.Field("domain_id"),
localUsers.Field("id", "local_id"),
localUsers.Field("name", "local_name"),
domains.Field("name", "domain_name"),
domains.Field("enabled", "domain_enabled"),
idmappings.Field("domain_id", "idp_id"),
idmappings.Field("local_id", "idp_name"),
)
q = q.Join(domains, sqlchemy.Equals(users.Field("domain_id"), domains.Field("id")))
q = q.LeftJoin(localUsers, sqlchemy.Equals(localUsers.Field("user_id"), users.Field("id")))
q = q.LeftJoin(idmappings, sqlchemy.Equals(users.Field("id"), idmappings.Field("public_id")))
if len(userId) > 0 {
q = q.Filter(sqlchemy.Equals(users.Field("id"), userId))
} else if len(userName) > 0 {
q = q.Filter(sqlchemy.Equals(users.Field("name"), userName))
if len(domainId) == 0 && len(domainName) == 0 {
domainId = api.DEFAULT_DOMAIN_ID
}
if len(domainId) > 0 {
q = q.Filter(sqlchemy.Equals(domains.Field("id"), domainId))
} else if len(domainName) > 0 {
q = q.Filter(sqlchemy.Equals(domains.Field("name"), domainName))
}
}
extUser := api.SUserExtended{}
err := q.First(&extUser)
if err != nil {
return nil, err
}
if len(extUser.IdpName) > 0 {
extUser.IsLocal = false
} else {
extUser.IsLocal = true
}
return &extUser, nil
}
func VerifyPassword(user *api.SUserExtended, passwd string) error {
if user.IsLocal {
return localUserVerifyPassword(user, passwd)
} else {
return fmt.Errorf("not implemented")
}
}
func localUserVerifyPassword(user *api.SUserExtended, passwd string) error {
passes, err := PasswordManager.fetchByLocaluserId(user.LocalId)
if err != nil {
return err
}
if len(passes) == 0 {
return nil
}
for i := range passes {
err = seclib2.BcryptVerifyPassword(passwd, passes[i].PasswordHash)
if err == nil {
return nil
}
}
return fmt.Errorf("invalid password")
}
func (manager *SUserManager) ListItemFilter(ctx context.Context, q *sqlchemy.SQuery, userCred mcclient.TokenCredential, query jsonutils.JSONObject) (*sqlchemy.SQuery, error) {
q, err := manager.SEnabledIdentityBaseResourceManager.ListItemFilter(ctx, q, userCred, query)
if err != nil {
return nil, err
}
groupStr := jsonutils.GetAnyString(query, []string{"group_id"})
if len(groupStr) > 0 {
groupObj, err := GroupManager.FetchById(groupStr)
if err != nil {
if err == sql.ErrNoRows {
return nil, httperrors.NewResourceNotFoundError2(GroupManager.Keyword(), groupStr)
} else {
return nil, httperrors.NewGeneralError(err)
}
}
subq := UsergroupManager.Query("user_id").Equals("group_id", groupObj.GetId())
q = q.In("id", subq.SubQuery())
}
projectStr := jsonutils.GetAnyString(query, []string{"project_id"})
if len(projectStr) > 0 {
project, err := ProjectManager.FetchProjectById(projectStr)
if err != nil {
if err == sql.ErrNoRows {
return nil, httperrors.NewResourceNotFoundError2(ProjectManager.Keyword(), projectStr)
} else {
return nil, httperrors.NewGeneralError(err)
}
}
subq := AssignmentManager.fetchProjectUserIdsQuery(project.Id)
q = q.In("id", subq.SubQuery())
}
return q, nil
}
func (manager *SUserManager) FilterByHiddenSystemAttributes(q *sqlchemy.SQuery, userCred mcclient.TokenCredential, query jsonutils.JSONObject, scope rbacutils.TRbacScope) *sqlchemy.SQuery {
q = manager.SEnabledIdentityBaseResourceManager.FilterByHiddenSystemAttributes(q, userCred, query, scope)
isSystem := jsonutils.QueryBoolean(query, "system", false)
if isSystem {
var isAllow bool
if consts.IsRbacEnabled() {
allowScope := policy.PolicyManager.AllowScope(userCred, consts.GetServiceType(), manager.KeywordPlural(), policy.PolicyActionList, "system")
if !scope.HigherThan(allowScope) {
isAllow = true
}
} else {
if userCred.HasSystemAdminPrivilege() {
isAllow = true
}
}
if !isAllow {
isSystem = false
}
}
if !isSystem {
q = q.Filter(sqlchemy.OR(sqlchemy.IsNull(q.Field("is_system_account")), sqlchemy.IsFalse(q.Field("is_system_account"))))
}
return q
}
func (user *SUser) ValidateUpdateData(ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject, data *jsonutils.JSONDict) (*jsonutils.JSONDict, error) {
if data.Contains("name") {
if user.IsAdminUser() {
return nil, httperrors.NewForbiddenError("cannot alter sysadmin user name")
}
}
if user.IsReadOnly() {
for _, k := range []string{
"name",
"enabled",
"displayname",
"email",
"mobile",
"password",
} {
if data.Contains(k) {
return nil, httperrors.NewForbiddenError("field %s is readonly", k)
}
}
}
return user.SEnabledIdentityBaseResource.ValidateUpdateData(ctx, userCred, query, data)
}
func (user *SUser) ValidateUpdateCondition(ctx context.Context) error {
// if user.IsReadOnly() {
// return httperrors.NewForbiddenError("readonly")
// }
return user.SEnabledIdentityBaseResource.ValidateUpdateCondition(ctx)
}
func (manager *SUserManager) fetchUserById(uid string) (*SUser, error) {
obj, err := manager.FetchById(uid)
if err != nil {
return nil, errors.Wrap(err, "manager.FetchById")
}
return obj.(*SUser), nil
}
func (user *SUser) IsAdminUser() bool {
return user.Name == api.SystemAdminUser && user.DomainId == api.DEFAULT_DOMAIN_ID
}
func (user *SUser) GetGroupCount() (int, error) {
q := UsergroupManager.Query().Equals("user_id", user.Id)
return q.CountWithError()
}
func (user *SUser) GetProjectCount() (int, error) {
q := AssignmentManager.fetchUserProjectIdsQuery(user.Id)
return q.CountWithError()
}
func (user *SUser) GetCredentialCount() (int, error) {
q := CredentialManager.Query().Equals("user_id", user.Id)
return q.CountWithError()
}
func (user *SUser) GetCustomizeColumns(ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject) *jsonutils.JSONDict {
extra := user.SEnabledIdentityBaseResource.GetCustomizeColumns(ctx, userCred, query)
return userExtra(user, extra)
}
func (user *SUser) GetExtraDetails(ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject) (*jsonutils.JSONDict, error) {
extra, err := user.SEnabledIdentityBaseResource.GetExtraDetails(ctx, userCred, query)
if err != nil {
return nil, err
}
return userExtra(user, extra), nil
}
func userExtra(user *SUser, extra *jsonutils.JSONDict) *jsonutils.JSONDict {
grpCnt, _ := user.GetGroupCount()
extra.Add(jsonutils.NewInt(int64(grpCnt)), "group_count")
prjCnt, _ := user.GetProjectCount()
extra.Add(jsonutils.NewInt(int64(prjCnt)), "project_count")
credCnt, _ := user.GetCredentialCount()
extra.Add(jsonutils.NewInt(int64(credCnt)), "credential_count")
return extra
}
func (user *SUser) initLocalData(passwd string) error {
localUsr, err := LocalUserManager.register(user.Id, user.DomainId, user.Name)
if err != nil {
return errors.Wrap(err, "register localuser")
}
if len(passwd) > 0 {
err = PasswordManager.savePassword(localUsr.Id, passwd)
if err != nil {
return errors.Wrap(err, "save password")
}
}
return nil
}
func (user *SUser) PostCreate(ctx context.Context, userCred mcclient.TokenCredential, ownerId mcclient.IIdentityProvider, query jsonutils.JSONObject, data jsonutils.JSONObject) {
user.SEnabledIdentityBaseResource.PostCreate(ctx, userCred, ownerId, query, data)
passwd, _ := data.GetString("password")
err := user.initLocalData(passwd)
if err != nil {
log.Errorf("fail to register localUser %s", err)
return
}
}
func (user *SUser) PostUpdate(ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject, data jsonutils.JSONObject) {
user.SEnabledIdentityBaseResource.PostUpdate(ctx, userCred, query, data)
passwd, _ := data.GetString("password")
if len(passwd) > 0 {
usrExt, err := UserManager.FetchUserExtended(user.Id, "", "", "")
if err != nil {
log.Errorf("UserManager.FetchUserExtended fail %s", err)
return
}
err = PasswordManager.savePassword(usrExt.LocalId, passwd)
if err != nil {
log.Errorf("fail to set password %s", err)
return
}
}
}
func (user *SUser) ValidatePurgeCondition(ctx context.Context) error {
prjCnt, _ := user.GetProjectCount()
if prjCnt > 0 {
return httperrors.NewNotEmptyError("user joins project")
}
if user.IsAdminUser() {
return httperrors.NewForbiddenError("cannot delete system user")
}
return nil
}
func (user *SUser) ValidateDeleteCondition(ctx context.Context) error {
// grpCnt, _ := user.GetGroupCount()
// if grpCnt > 0 {
// return httperrors.NewNotEmptyError("group contains user")
// }
err := user.ValidatePurgeCondition(ctx)
if err != nil {
return err
}
if user.IsReadOnly() {
return httperrors.NewForbiddenError("readonly")
}
return user.SIdentityBaseResource.ValidateDeleteCondition(ctx)
}
func (user *SUser) PostDelete(ctx context.Context, userCred mcclient.TokenCredential) {
user.SEnabledIdentityBaseResource.PostDelete(ctx, userCred)
localUser, err := LocalUserManager.delete(user.Id, user.DomainId)
if err != nil {
log.Errorf("LocalUserManager.delete fail %s", err)
return
}
err = PasswordManager.delete(localUser.Id)
if err != nil {
log.Errorf("PasswordManager.delete fail %s", err)
return
}
err = UsergroupManager.delete(user.Id, "")
if err != nil {
log.Errorf("UsergroupManager.delete fail %s", err)
return
}
}
func (user *SUser) UpdateInContext(ctx context.Context, userCred mcclient.TokenCredential, ctxObjs []db.IModel, query jsonutils.JSONObject, data jsonutils.JSONObject) (jsonutils.JSONObject, error) {
if len(ctxObjs) != 1 {
return nil, httperrors.NewInputParameterError("not supported update context")
}
group, ok := ctxObjs[0].(*SGroup)
if !ok {
return nil, httperrors.NewInputParameterError("not supported update context %s", ctxObjs[0].Keyword())
}
if user.DomainId != group.DomainId {
return nil, httperrors.NewInputParameterError("cannot join user and group in differnt domain")
}
if group.IsReadOnly() {
return nil, httperrors.NewForbiddenError("cannot join read-only group")
}
return nil, UsergroupManager.add(ctx, userCred, user, group)
}
func (user *SUser) DeleteInContext(ctx context.Context, userCred mcclient.TokenCredential, ctxObjs []db.IModel, query jsonutils.JSONObject, data jsonutils.JSONObject) (jsonutils.JSONObject, error) {
if len(ctxObjs) != 1 {
return nil, httperrors.NewInputParameterError("not supported update context")
}
group, ok := ctxObjs[0].(*SGroup)
if !ok {
return nil, httperrors.NewInputParameterError("not supported update context %s", ctxObjs[0].Keyword())
}
if group.IsReadOnly() {
return nil, httperrors.NewForbiddenError("cannot leave read-only group")
}
return nil, UsergroupManager.remove(ctx, userCred, user, group)
}
func (manager *SUserManager) TraceLoginV2(ctx context.Context, token *mcclient.TokenCredentialV2) {
s := tokenV2LoginSession(token)
manager.traceLoginEvent(ctx, token, s, token.Context)
}
func (manager *SUserManager) TraceLoginV3(ctx context.Context, token *mcclient.TokenCredentialV3) {
s := tokenV3LoginSession(token)
manager.traceLoginEvent(ctx, token, s, token.Token.Context)
}
func (manager *SUserManager) traceLoginEvent(ctx context.Context, token mcclient.TokenCredential, s sLoginSession, authCtx mcclient.SAuthContext) {
usr, err := manager.fetchUserById(token.GetUserId())
if err != nil {
// very unlikely
log.Errorf("fetchUserById fail %s", err)
return
}
db.Update(usr, func() error {
usr.LastActiveAt = time.Now().UTC()
usr.LastLoginIp = authCtx.Ip
usr.LastLoginSource = authCtx.Source
return nil
})
db.OpsLog.LogEvent(usr, "auth", &s, token)
logclient.AddActionLogWithContext(ctx, usr, logclient.ACT_AUTHENTICATE, &s, token, true)
}
type sLoginSession struct {
Version string
Source string
Ip string
Project string
ProjectId string
ProjectDomain string
ProjectDomainId string
Token string
}
func tokenV2LoginSession(token *mcclient.TokenCredentialV2) sLoginSession {
s := sLoginSession{}
s.Version = "v2"
s.Source = token.Context.Source
s.Ip = token.Context.Ip
s.Project = token.Token.Tenant.Name
s.ProjectId = token.Token.Tenant.Id
s.ProjectDomain = token.Token.Tenant.Domain.Name
s.ProjectDomainId = token.Token.Tenant.Domain.Id
s.Token = token.Token.Id
return s
}
func tokenV3LoginSession(token *mcclient.TokenCredentialV3) sLoginSession {
s := sLoginSession{}
s.Version = "v3"
s.Source = token.Token.Context.Source
s.Ip = token.Token.Context.Ip
s.Project = token.Token.Project.Name
s.ProjectId = token.Token.Project.Id
s.ProjectDomain = token.Token.Project.Domain.Name
s.ProjectDomainId = token.Token.Project.Domain.Id
s.Token = token.Id
return s
}
func (manager *SUserManager) NamespaceScope() rbacutils.TRbacScope {
return rbacutils.ScopeDomain
}
func (user *SUser) purge(ctx context.Context, userCred mcclient.TokenCredential) error {
localUser, err := LocalUserManager.delete(user.Id, user.DomainId)
if err != nil {
return errors.Wrap(err, "LocalUserManager.delete")
}
if localUser != nil {
err = PasswordManager.delete(localUser.Id)
if err != nil {
return errors.Wrap(err, "PasswordManager.delete")
}
}
err = UsergroupManager.delete(user.Id, "")
if err != nil {
return errors.Wrap(err, "UsergroupManager.delete")
}
return user.Delete(ctx, userCred)
}
func (user *SUser) getIdmapping() (*SIdmapping, error) {
return IdmappingManager.FetchEntity(user.Id, api.IdMappingEntityUser)
}
func (user *SUser) IsReadOnly() bool {
idmap, _ := user.getIdmapping()
if idmap != nil {
return true
}
return false
}
func (manager *SUserManager) FetchCustomizeColumns(ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject, objs []db.IModel, fields stringutils2.SSortedStrings) []*jsonutils.JSONDict {
rows := manager.SEnabledIdentityBaseResourceManager.FetchCustomizeColumns(ctx, userCred, query, objs, fields)
return expandIdpAttributes(rows, objs, fields, api.IdMappingEntityUser)
}