2021-07-24 10:16:34 +00:00
|
|
|
// Copyright 2021 The Gitea Authors. All rights reserved.
|
|
|
|
// Use of this source code is governed by a MIT-style
|
|
|
|
// license that can be found in the LICENSE file.
|
|
|
|
|
|
|
|
package ldap
|
|
|
|
|
|
|
|
import (
|
|
|
|
"context"
|
|
|
|
"fmt"
|
2021-09-15 09:28:37 +00:00
|
|
|
"sort"
|
2021-07-24 10:16:34 +00:00
|
|
|
"strings"
|
|
|
|
|
2021-12-10 08:14:24 +00:00
|
|
|
asymkey_model "code.gitea.io/gitea/models/asymkey"
|
2021-11-10 05:13:16 +00:00
|
|
|
"code.gitea.io/gitea/models/db"
|
2021-11-24 09:49:20 +00:00
|
|
|
user_model "code.gitea.io/gitea/models/user"
|
2021-07-24 10:16:34 +00:00
|
|
|
"code.gitea.io/gitea/modules/log"
|
2021-11-22 15:21:55 +00:00
|
|
|
user_service "code.gitea.io/gitea/services/user"
|
2021-07-24 10:16:34 +00:00
|
|
|
)
|
|
|
|
|
|
|
|
// Sync causes this ldap source to synchronize its users with the db
|
|
|
|
func (source *Source) Sync(ctx context.Context, updateExisting bool) error {
|
2022-01-02 13:12:35 +00:00
|
|
|
log.Trace("Doing: SyncExternalUsers[%s]", source.authSource.Name)
|
2021-07-24 10:16:34 +00:00
|
|
|
|
2021-09-15 09:28:37 +00:00
|
|
|
var existingUsers []int
|
2021-07-24 10:16:34 +00:00
|
|
|
isAttributeSSHPublicKeySet := len(strings.TrimSpace(source.AttributeSSHPublicKey)) > 0
|
|
|
|
var sshKeysNeedUpdate bool
|
|
|
|
|
|
|
|
// Find all users with this login type - FIXME: Should this be an iterator?
|
2022-01-02 13:12:35 +00:00
|
|
|
users, err := user_model.GetUsersBySource(source.authSource)
|
2021-07-24 10:16:34 +00:00
|
|
|
if err != nil {
|
|
|
|
log.Error("SyncExternalUsers: %v", err)
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
select {
|
|
|
|
case <-ctx.Done():
|
2022-01-02 13:12:35 +00:00
|
|
|
log.Warn("SyncExternalUsers: Cancelled before update of %s", source.authSource.Name)
|
|
|
|
return db.ErrCancelledf("Before update of %s", source.authSource.Name)
|
2021-07-24 10:16:34 +00:00
|
|
|
default:
|
|
|
|
}
|
|
|
|
|
2021-09-15 09:28:37 +00:00
|
|
|
sort.Slice(users, func(i, j int) bool {
|
|
|
|
return users[i].LowerName < users[j].LowerName
|
|
|
|
})
|
|
|
|
|
2021-07-24 10:16:34 +00:00
|
|
|
sr, err := source.SearchEntries()
|
|
|
|
if err != nil {
|
2022-01-02 13:12:35 +00:00
|
|
|
log.Error("SyncExternalUsers LDAP source failure [%s], skipped", source.authSource.Name)
|
2021-07-24 10:16:34 +00:00
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
if len(sr) == 0 {
|
|
|
|
if !source.AllowDeactivateAll {
|
|
|
|
log.Error("LDAP search found no entries but did not report an error. Refusing to deactivate all users")
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
log.Warn("LDAP search found no entries but did not report an error. All users will be deactivated as per settings")
|
|
|
|
}
|
|
|
|
|
2021-09-15 09:28:37 +00:00
|
|
|
sort.Slice(sr, func(i, j int) bool {
|
|
|
|
return sr[i].LowerName < sr[j].LowerName
|
|
|
|
})
|
|
|
|
|
|
|
|
userPos := 0
|
|
|
|
|
2021-07-24 10:16:34 +00:00
|
|
|
for _, su := range sr {
|
|
|
|
select {
|
|
|
|
case <-ctx.Done():
|
2022-01-02 13:12:35 +00:00
|
|
|
log.Warn("SyncExternalUsers: Cancelled at update of %s before completed update of users", source.authSource.Name)
|
2021-07-24 10:16:34 +00:00
|
|
|
// Rewrite authorized_keys file if LDAP Public SSH Key attribute is set and any key was added or removed
|
|
|
|
if sshKeysNeedUpdate {
|
2021-12-10 08:14:24 +00:00
|
|
|
err = asymkey_model.RewriteAllPublicKeys()
|
2021-07-24 10:16:34 +00:00
|
|
|
if err != nil {
|
|
|
|
log.Error("RewriteAllPublicKeys: %v", err)
|
|
|
|
}
|
|
|
|
}
|
2022-01-02 13:12:35 +00:00
|
|
|
return db.ErrCancelledf("During update of %s before completed update of users", source.authSource.Name)
|
2021-07-24 10:16:34 +00:00
|
|
|
default:
|
|
|
|
}
|
|
|
|
if len(su.Username) == 0 {
|
|
|
|
continue
|
|
|
|
}
|
|
|
|
|
|
|
|
if len(su.Mail) == 0 {
|
|
|
|
su.Mail = fmt.Sprintf("%s@localhost", su.Username)
|
|
|
|
}
|
|
|
|
|
2021-11-24 09:49:20 +00:00
|
|
|
var usr *user_model.User
|
2021-09-15 09:28:37 +00:00
|
|
|
for userPos < len(users) && users[userPos].LowerName < su.LowerName {
|
|
|
|
userPos++
|
|
|
|
}
|
|
|
|
if userPos < len(users) && users[userPos].LowerName == su.LowerName {
|
|
|
|
usr = users[userPos]
|
|
|
|
existingUsers = append(existingUsers, userPos)
|
2021-07-24 10:16:34 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
fullName := composeFullName(su.Name, su.Surname, su.Username)
|
|
|
|
// If no existing user found, create one
|
|
|
|
if usr == nil {
|
2022-01-02 13:12:35 +00:00
|
|
|
log.Trace("SyncExternalUsers[%s]: Creating user %s", source.authSource.Name, su.Username)
|
2021-07-24 10:16:34 +00:00
|
|
|
|
2021-11-24 09:49:20 +00:00
|
|
|
usr = &user_model.User{
|
2021-09-15 09:28:37 +00:00
|
|
|
LowerName: su.LowerName,
|
2021-07-24 10:16:34 +00:00
|
|
|
Name: su.Username,
|
|
|
|
FullName: fullName,
|
2022-01-02 13:12:35 +00:00
|
|
|
LoginType: source.authSource.Type,
|
|
|
|
LoginSource: source.authSource.ID,
|
2021-07-24 10:16:34 +00:00
|
|
|
LoginName: su.Username,
|
|
|
|
Email: su.Mail,
|
|
|
|
IsAdmin: su.IsAdmin,
|
|
|
|
IsRestricted: su.IsRestricted,
|
|
|
|
IsActive: true,
|
|
|
|
}
|
|
|
|
|
2021-11-24 09:49:20 +00:00
|
|
|
err = user_model.CreateUser(usr)
|
2021-07-24 10:16:34 +00:00
|
|
|
|
|
|
|
if err != nil {
|
2022-01-02 13:12:35 +00:00
|
|
|
log.Error("SyncExternalUsers[%s]: Error creating user %s: %v", source.authSource.Name, su.Username, err)
|
2021-09-27 02:39:36 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
if err == nil && isAttributeSSHPublicKeySet {
|
2022-01-02 13:12:35 +00:00
|
|
|
log.Trace("SyncExternalUsers[%s]: Adding LDAP Public SSH Keys for user %s", source.authSource.Name, usr.Name)
|
|
|
|
if asymkey_model.AddPublicKeysBySource(usr, source.authSource, su.SSHPublicKey) {
|
2021-07-24 10:16:34 +00:00
|
|
|
sshKeysNeedUpdate = true
|
|
|
|
}
|
|
|
|
}
|
2021-09-27 02:39:36 +00:00
|
|
|
|
|
|
|
if err == nil && len(source.AttributeAvatar) > 0 {
|
2021-11-22 15:21:55 +00:00
|
|
|
_ = user_service.UploadAvatar(usr, su.Avatar)
|
2021-09-27 02:39:36 +00:00
|
|
|
}
|
2021-07-24 10:16:34 +00:00
|
|
|
} else if updateExisting {
|
|
|
|
// Synchronize SSH Public Key if that attribute is set
|
2022-01-02 13:12:35 +00:00
|
|
|
if isAttributeSSHPublicKeySet && asymkey_model.SynchronizePublicKeys(usr, source.authSource, su.SSHPublicKey) {
|
2021-07-24 10:16:34 +00:00
|
|
|
sshKeysNeedUpdate = true
|
|
|
|
}
|
|
|
|
|
|
|
|
// Check if user data has changed
|
|
|
|
if (len(source.AdminFilter) > 0 && usr.IsAdmin != su.IsAdmin) ||
|
|
|
|
(len(source.RestrictedFilter) > 0 && usr.IsRestricted != su.IsRestricted) ||
|
|
|
|
!strings.EqualFold(usr.Email, su.Mail) ||
|
|
|
|
usr.FullName != fullName ||
|
|
|
|
!usr.IsActive {
|
|
|
|
|
2022-01-02 13:12:35 +00:00
|
|
|
log.Trace("SyncExternalUsers[%s]: Updating user %s", source.authSource.Name, usr.Name)
|
2021-07-24 10:16:34 +00:00
|
|
|
|
|
|
|
usr.FullName = fullName
|
|
|
|
usr.Email = su.Mail
|
|
|
|
// Change existing admin flag only if AdminFilter option is set
|
|
|
|
if len(source.AdminFilter) > 0 {
|
|
|
|
usr.IsAdmin = su.IsAdmin
|
|
|
|
}
|
|
|
|
// Change existing restricted flag only if RestrictedFilter option is set
|
|
|
|
if !usr.IsAdmin && len(source.RestrictedFilter) > 0 {
|
|
|
|
usr.IsRestricted = su.IsRestricted
|
|
|
|
}
|
|
|
|
usr.IsActive = true
|
|
|
|
|
2021-11-24 09:49:20 +00:00
|
|
|
err = user_model.UpdateUserCols(db.DefaultContext, usr, "full_name", "email", "is_admin", "is_restricted", "is_active")
|
2021-07-24 10:16:34 +00:00
|
|
|
if err != nil {
|
2022-01-02 13:12:35 +00:00
|
|
|
log.Error("SyncExternalUsers[%s]: Error updating user %s: %v", source.authSource.Name, usr.Name, err)
|
2021-07-24 10:16:34 +00:00
|
|
|
}
|
|
|
|
}
|
2021-09-27 02:39:36 +00:00
|
|
|
|
|
|
|
if usr.IsUploadAvatarChanged(su.Avatar) {
|
|
|
|
if err == nil && len(source.AttributeAvatar) > 0 {
|
2021-11-22 15:21:55 +00:00
|
|
|
_ = user_service.UploadAvatar(usr, su.Avatar)
|
2021-09-27 02:39:36 +00:00
|
|
|
}
|
|
|
|
}
|
2021-07-24 10:16:34 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// Rewrite authorized_keys file if LDAP Public SSH Key attribute is set and any key was added or removed
|
|
|
|
if sshKeysNeedUpdate {
|
2021-12-10 08:14:24 +00:00
|
|
|
err = asymkey_model.RewriteAllPublicKeys()
|
2021-07-24 10:16:34 +00:00
|
|
|
if err != nil {
|
|
|
|
log.Error("RewriteAllPublicKeys: %v", err)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
select {
|
|
|
|
case <-ctx.Done():
|
2022-01-02 13:12:35 +00:00
|
|
|
log.Warn("SyncExternalUsers: Cancelled during update of %s before delete users", source.authSource.Name)
|
|
|
|
return db.ErrCancelledf("During update of %s before delete users", source.authSource.Name)
|
2021-07-24 10:16:34 +00:00
|
|
|
default:
|
|
|
|
}
|
|
|
|
|
|
|
|
// Deactivate users not present in LDAP
|
|
|
|
if updateExisting {
|
2021-09-15 09:28:37 +00:00
|
|
|
existPos := 0
|
|
|
|
for i, usr := range users {
|
|
|
|
for existPos < len(existingUsers) && i > existingUsers[existPos] {
|
|
|
|
existPos++
|
2021-07-24 10:16:34 +00:00
|
|
|
}
|
2021-09-15 09:28:37 +00:00
|
|
|
if usr.IsActive && (existPos >= len(existingUsers) || i < existingUsers[existPos]) {
|
2022-01-02 13:12:35 +00:00
|
|
|
log.Trace("SyncExternalUsers[%s]: Deactivating user %s", source.authSource.Name, usr.Name)
|
2021-07-24 10:16:34 +00:00
|
|
|
|
|
|
|
usr.IsActive = false
|
2021-11-24 09:49:20 +00:00
|
|
|
err = user_model.UpdateUserCols(db.DefaultContext, usr, "is_active")
|
2021-07-24 10:16:34 +00:00
|
|
|
if err != nil {
|
2022-01-02 13:12:35 +00:00
|
|
|
log.Error("SyncExternalUsers[%s]: Error deactivating user %s: %v", source.authSource.Name, usr.Name, err)
|
2021-07-24 10:16:34 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return nil
|
|
|
|
}
|