mirror of
https://github.com/0rangebananaspy/authelia.git
synced 2024-09-14 22:47:21 +07:00
499 lines
14 KiB
Go
499 lines
14 KiB
Go
package authentication
|
|
|
|
import (
|
|
"crypto/tls"
|
|
"crypto/x509"
|
|
"fmt"
|
|
"net"
|
|
"strings"
|
|
|
|
"github.com/go-ldap/ldap/v3"
|
|
"github.com/sirupsen/logrus"
|
|
|
|
"github.com/authelia/authelia/v4/internal/configuration/schema"
|
|
"github.com/authelia/authelia/v4/internal/logging"
|
|
"github.com/authelia/authelia/v4/internal/utils"
|
|
)
|
|
|
|
// LDAPUserProvider is a UserProvider that connects to LDAP servers like ActiveDirectory, OpenLDAP, OpenDJ, FreeIPA, etc.
|
|
type LDAPUserProvider struct {
|
|
config schema.LDAPAuthenticationBackendConfiguration
|
|
tlsConfig *tls.Config
|
|
dialOpts []ldap.DialOpt
|
|
log *logrus.Logger
|
|
factory LDAPClientFactory
|
|
|
|
disableResetPassword bool
|
|
|
|
// Automatically detected LDAP features.
|
|
features LDAPSupportedFeatures
|
|
|
|
// Dynamically generated users values.
|
|
usersBaseDN string
|
|
usersAttributes []string
|
|
usersFilterReplacementInput bool
|
|
|
|
// Dynamically generated groups values.
|
|
groupsBaseDN string
|
|
groupsAttributes []string
|
|
groupsFilterReplacementInput bool
|
|
groupsFilterReplacementUsername bool
|
|
groupsFilterReplacementDN bool
|
|
}
|
|
|
|
// NewLDAPUserProvider creates a new instance of LDAPUserProvider.
|
|
func NewLDAPUserProvider(config schema.AuthenticationBackendConfiguration, certPool *x509.CertPool) (provider *LDAPUserProvider) {
|
|
provider = newLDAPUserProvider(*config.LDAP, config.PasswordReset.Disable, certPool, nil)
|
|
|
|
return provider
|
|
}
|
|
|
|
func newLDAPUserProvider(config schema.LDAPAuthenticationBackendConfiguration, disableResetPassword bool, certPool *x509.CertPool, factory LDAPClientFactory) (provider *LDAPUserProvider) {
|
|
if config.TLS == nil {
|
|
config.TLS = schema.DefaultLDAPAuthenticationBackendConfiguration.TLS
|
|
}
|
|
|
|
tlsConfig := utils.NewTLSConfig(config.TLS, tls.VersionTLS12, certPool)
|
|
|
|
var dialOpts = []ldap.DialOpt{
|
|
ldap.DialWithDialer(&net.Dialer{Timeout: config.Timeout}),
|
|
}
|
|
|
|
if tlsConfig != nil {
|
|
dialOpts = append(dialOpts, ldap.DialWithTLSConfig(tlsConfig))
|
|
}
|
|
|
|
if factory == nil {
|
|
factory = NewProductionLDAPClientFactory()
|
|
}
|
|
|
|
provider = &LDAPUserProvider{
|
|
config: config,
|
|
tlsConfig: tlsConfig,
|
|
dialOpts: dialOpts,
|
|
log: logging.Logger(),
|
|
factory: factory,
|
|
disableResetPassword: disableResetPassword,
|
|
}
|
|
|
|
provider.parseDynamicUsersConfiguration()
|
|
provider.parseDynamicGroupsConfiguration()
|
|
|
|
return provider
|
|
}
|
|
|
|
// CheckUserPassword checks if provided password matches for the given user.
|
|
func (p *LDAPUserProvider) CheckUserPassword(username string, password string) (valid bool, err error) {
|
|
var (
|
|
client, clientUser LDAPClient
|
|
profile *ldapUserProfile
|
|
)
|
|
|
|
if client, err = p.connect(); err != nil {
|
|
return false, err
|
|
}
|
|
|
|
defer client.Close()
|
|
|
|
if profile, err = p.getUserProfile(client, username); err != nil {
|
|
return false, err
|
|
}
|
|
|
|
if clientUser, err = p.connectCustom(p.config.URL, profile.DN, password, p.config.StartTLS, p.dialOpts...); err != nil {
|
|
return false, fmt.Errorf("authentication failed. Cause: %w", err)
|
|
}
|
|
|
|
defer clientUser.Close()
|
|
|
|
return true, nil
|
|
}
|
|
|
|
// GetDetails retrieve the groups a user belongs to.
|
|
func (p *LDAPUserProvider) GetDetails(username string) (details *UserDetails, err error) {
|
|
var (
|
|
client LDAPClient
|
|
profile *ldapUserProfile
|
|
)
|
|
|
|
if client, err = p.connect(); err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
defer client.Close()
|
|
|
|
if profile, err = p.getUserProfile(client, username); err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
var (
|
|
filter string
|
|
searchRequest *ldap.SearchRequest
|
|
searchResult *ldap.SearchResult
|
|
)
|
|
|
|
if filter, err = p.resolveGroupsFilter(username, profile); err != nil {
|
|
return nil, fmt.Errorf("unable to create group filter for user '%s'. Cause: %w", username, err)
|
|
}
|
|
|
|
// Search for the users groups.
|
|
searchRequest = ldap.NewSearchRequest(
|
|
p.groupsBaseDN, ldap.ScopeWholeSubtree, ldap.NeverDerefAliases,
|
|
0, 0, false, filter, p.groupsAttributes, nil,
|
|
)
|
|
|
|
if searchResult, err = p.search(client, searchRequest); err != nil {
|
|
return nil, fmt.Errorf("unable to retrieve groups of user '%s'. Cause: %w", username, err)
|
|
}
|
|
|
|
groups := make([]string, 0)
|
|
|
|
for _, res := range searchResult.Entries {
|
|
if len(res.Attributes) == 0 {
|
|
p.log.Warningf("No groups retrieved from LDAP for user %s", username)
|
|
break
|
|
}
|
|
|
|
// Append all values of the document. Normally there should be only one per document.
|
|
groups = append(groups, res.Attributes[0].Values...)
|
|
}
|
|
|
|
return &UserDetails{
|
|
Username: profile.Username,
|
|
DisplayName: profile.DisplayName,
|
|
Emails: profile.Emails,
|
|
Groups: groups,
|
|
}, nil
|
|
}
|
|
|
|
// UpdatePassword update the password of the given user.
|
|
func (p *LDAPUserProvider) UpdatePassword(username, password string) (err error) {
|
|
var (
|
|
client LDAPClient
|
|
profile *ldapUserProfile
|
|
)
|
|
|
|
if client, err = p.connect(); err != nil {
|
|
return fmt.Errorf("unable to update password. Cause: %w", err)
|
|
}
|
|
|
|
defer client.Close()
|
|
|
|
if profile, err = p.getUserProfile(client, username); err != nil {
|
|
return fmt.Errorf("unable to update password. Cause: %w", err)
|
|
}
|
|
|
|
var controls []ldap.Control
|
|
|
|
switch {
|
|
case p.features.ControlTypes.MsftPwdPolHints:
|
|
controls = append(controls, &controlMsftServerPolicyHints{ldapOIDControlMsftServerPolicyHints})
|
|
case p.features.ControlTypes.MsftPwdPolHintsDeprecated:
|
|
controls = append(controls, &controlMsftServerPolicyHints{ldapOIDControlMsftServerPolicyHintsDeprecated})
|
|
}
|
|
|
|
switch {
|
|
case p.features.Extensions.PwdModifyExOp:
|
|
pwdModifyRequest := ldap.NewPasswordModifyRequest(
|
|
profile.DN,
|
|
"",
|
|
password,
|
|
)
|
|
|
|
err = p.pwdModify(client, pwdModifyRequest)
|
|
case p.config.Implementation == schema.LDAPImplementationActiveDirectory:
|
|
modifyRequest := ldap.NewModifyRequest(profile.DN, controls)
|
|
// The password needs to be enclosed in quotes
|
|
// https://docs.microsoft.com/en-us/openspecs/windows_protocols/ms-adts/6e803168-f140-4d23-b2d3-c3a8ab5917d2
|
|
pwdEncoded, _ := utf16LittleEndian.NewEncoder().String(fmt.Sprintf("\"%s\"", password))
|
|
modifyRequest.Replace(ldapAttributeUnicodePwd, []string{pwdEncoded})
|
|
|
|
err = p.modify(client, modifyRequest)
|
|
default:
|
|
modifyRequest := ldap.NewModifyRequest(profile.DN, controls)
|
|
modifyRequest.Replace(ldapAttributeUserPassword, []string{password})
|
|
|
|
err = p.modify(client, modifyRequest)
|
|
}
|
|
|
|
if err != nil {
|
|
return fmt.Errorf("unable to update password. Cause: %w", err)
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
func (p *LDAPUserProvider) connect() (client LDAPClient, err error) {
|
|
return p.connectCustom(p.config.URL, p.config.User, p.config.Password, p.config.StartTLS, p.dialOpts...)
|
|
}
|
|
|
|
func (p *LDAPUserProvider) connectCustom(url, username, password string, startTLS bool, opts ...ldap.DialOpt) (client LDAPClient, err error) {
|
|
if client, err = p.factory.DialURL(url, opts...); err != nil {
|
|
return nil, fmt.Errorf("dial failed with error: %w", err)
|
|
}
|
|
|
|
if startTLS {
|
|
if err = client.StartTLS(p.tlsConfig); err != nil {
|
|
client.Close()
|
|
|
|
return nil, fmt.Errorf("starttls failed with error: %w", err)
|
|
}
|
|
}
|
|
|
|
if password == "" {
|
|
err = client.UnauthenticatedBind(username)
|
|
} else {
|
|
err = client.Bind(username, password)
|
|
}
|
|
|
|
if err != nil {
|
|
client.Close()
|
|
|
|
return nil, fmt.Errorf("bind failed with error: %w", err)
|
|
}
|
|
|
|
return client, nil
|
|
}
|
|
|
|
func (p *LDAPUserProvider) search(client LDAPClient, searchRequest *ldap.SearchRequest) (searchResult *ldap.SearchResult, err error) {
|
|
if searchResult, err = client.Search(searchRequest); err != nil {
|
|
if referral, ok := p.getReferral(err); ok {
|
|
if searchResult == nil {
|
|
searchResult = &ldap.SearchResult{
|
|
Referrals: []string{referral},
|
|
}
|
|
} else {
|
|
searchResult.Referrals = append(searchResult.Referrals, referral)
|
|
}
|
|
}
|
|
}
|
|
|
|
if !p.config.PermitReferrals || len(searchResult.Referrals) == 0 {
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
return searchResult, nil
|
|
}
|
|
|
|
if err = p.searchReferrals(searchRequest, searchResult); err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
return searchResult, nil
|
|
}
|
|
|
|
func (p *LDAPUserProvider) searchReferral(referral string, searchRequest *ldap.SearchRequest, searchResult *ldap.SearchResult) (err error) {
|
|
var (
|
|
client LDAPClient
|
|
result *ldap.SearchResult
|
|
)
|
|
|
|
if client, err = p.connectCustom(referral, p.config.User, p.config.Password, p.config.StartTLS, p.dialOpts...); err != nil {
|
|
return fmt.Errorf("error occurred connecting to referred LDAP server '%s': %w", referral, err)
|
|
}
|
|
|
|
defer client.Close()
|
|
|
|
if result, err = client.Search(searchRequest); err != nil {
|
|
return fmt.Errorf("error occurred performing search on referred LDAP server '%s': %w", referral, err)
|
|
}
|
|
|
|
for i := 0; i < len(result.Entries); i++ {
|
|
if !ldapEntriesContainsEntry(result.Entries[i], searchResult.Entries) {
|
|
searchResult.Entries = append(searchResult.Entries, result.Entries[i])
|
|
}
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
func (p *LDAPUserProvider) searchReferrals(searchRequest *ldap.SearchRequest, searchResult *ldap.SearchResult) (err error) {
|
|
for i := 0; i < len(searchResult.Referrals); i++ {
|
|
if err = p.searchReferral(searchResult.Referrals[i], searchRequest, searchResult); err != nil {
|
|
return err
|
|
}
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
func (p *LDAPUserProvider) getUserProfile(client LDAPClient, username string) (profile *ldapUserProfile, err error) {
|
|
userFilter := p.resolveUsersFilter(username)
|
|
|
|
// Search for the given username.
|
|
searchRequest := ldap.NewSearchRequest(
|
|
p.usersBaseDN, ldap.ScopeWholeSubtree, ldap.NeverDerefAliases,
|
|
1, 0, false, userFilter, p.usersAttributes, nil,
|
|
)
|
|
|
|
var searchResult *ldap.SearchResult
|
|
|
|
if searchResult, err = p.search(client, searchRequest); err != nil {
|
|
return nil, fmt.Errorf("cannot find user DN of user '%s'. Cause: %w", username, err)
|
|
}
|
|
|
|
if len(searchResult.Entries) == 0 {
|
|
return nil, ErrUserNotFound
|
|
}
|
|
|
|
if len(searchResult.Entries) > 1 {
|
|
return nil, fmt.Errorf("there were %d users found when searching for '%s' but there should only be 1", len(searchResult.Entries), username)
|
|
}
|
|
|
|
userProfile := ldapUserProfile{
|
|
DN: searchResult.Entries[0].DN,
|
|
}
|
|
|
|
for _, attr := range searchResult.Entries[0].Attributes {
|
|
attrs := len(attr.Values)
|
|
|
|
if attr.Name == p.config.UsernameAttribute {
|
|
switch attrs {
|
|
case 1:
|
|
userProfile.Username = attr.Values[0]
|
|
case 0:
|
|
return nil, fmt.Errorf("user '%s' must have value for attribute '%s'",
|
|
username, p.config.UsernameAttribute)
|
|
default:
|
|
return nil, fmt.Errorf("user '%s' has %d values for for attribute '%s' but the attribute must be a single value attribute",
|
|
username, attrs, p.config.UsernameAttribute)
|
|
}
|
|
}
|
|
|
|
if attrs == 0 {
|
|
continue
|
|
}
|
|
|
|
if attr.Name == p.config.MailAttribute {
|
|
userProfile.Emails = attr.Values
|
|
}
|
|
|
|
if attr.Name == p.config.DisplayNameAttribute {
|
|
userProfile.DisplayName = attr.Values[0]
|
|
}
|
|
}
|
|
|
|
if userProfile.Username == "" {
|
|
return nil, fmt.Errorf("user '%s' must have value for attribute '%s'",
|
|
username, p.config.UsernameAttribute)
|
|
}
|
|
|
|
if userProfile.DN == "" {
|
|
return nil, fmt.Errorf("user '%s' must have a distinguished name but the result returned an empty distinguished name", username)
|
|
}
|
|
|
|
return &userProfile, nil
|
|
}
|
|
|
|
func (p *LDAPUserProvider) resolveUsersFilter(username string) (filter string) {
|
|
filter = p.config.UsersFilter
|
|
|
|
if p.usersFilterReplacementInput {
|
|
// The {input} placeholder is replaced by the username input.
|
|
filter = strings.ReplaceAll(filter, ldapPlaceholderInput, ldapEscape(username))
|
|
}
|
|
|
|
p.log.Tracef("Detected user filter is %s", filter)
|
|
|
|
return filter
|
|
}
|
|
|
|
func (p *LDAPUserProvider) resolveGroupsFilter(username string, profile *ldapUserProfile) (filter string, err error) { //nolint:unparam
|
|
filter = p.config.GroupsFilter
|
|
|
|
if p.groupsFilterReplacementInput {
|
|
// The {input} placeholder is replaced by the users username input.
|
|
filter = strings.ReplaceAll(p.config.GroupsFilter, ldapPlaceholderInput, ldapEscape(username))
|
|
}
|
|
|
|
if profile != nil {
|
|
if p.groupsFilterReplacementUsername {
|
|
filter = strings.ReplaceAll(filter, ldapPlaceholderUsername, ldap.EscapeFilter(profile.Username))
|
|
}
|
|
|
|
if p.groupsFilterReplacementDN {
|
|
filter = strings.ReplaceAll(filter, ldapPlaceholderDistinguishedName, ldap.EscapeFilter(profile.DN))
|
|
}
|
|
}
|
|
|
|
p.log.Tracef("Computed groups filter is %s", filter)
|
|
|
|
return filter, nil
|
|
}
|
|
|
|
func (p *LDAPUserProvider) modify(client LDAPClient, modifyRequest *ldap.ModifyRequest) (err error) {
|
|
if err = client.Modify(modifyRequest); err != nil {
|
|
var (
|
|
referral string
|
|
ok bool
|
|
)
|
|
|
|
if referral, ok = p.getReferral(err); !ok {
|
|
return err
|
|
}
|
|
|
|
p.log.Debugf("Attempting Modify on referred URL %s", referral)
|
|
|
|
var (
|
|
clientRef LDAPClient
|
|
errRef error
|
|
)
|
|
|
|
if clientRef, errRef = p.connectCustom(referral, p.config.User, p.config.Password, p.config.StartTLS, p.dialOpts...); errRef != nil {
|
|
return fmt.Errorf("error occurred connecting to referred LDAP server '%s': %+v. Original Error: %w", referral, errRef, err)
|
|
}
|
|
|
|
defer clientRef.Close()
|
|
|
|
if errRef = clientRef.Modify(modifyRequest); errRef != nil {
|
|
return fmt.Errorf("error occurred performing modify on referred LDAP server '%s': %+v. Original Error: %w", referral, errRef, err)
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
func (p *LDAPUserProvider) pwdModify(client LDAPClient, pwdModifyRequest *ldap.PasswordModifyRequest) (err error) {
|
|
if _, err = client.PasswordModify(pwdModifyRequest); err != nil {
|
|
var (
|
|
referral string
|
|
ok bool
|
|
)
|
|
|
|
if referral, ok = p.getReferral(err); !ok {
|
|
return err
|
|
}
|
|
|
|
p.log.Debugf("Attempting PwdModify ExOp (1.3.6.1.4.1.4203.1.11.1) on referred URL %s", referral)
|
|
|
|
var (
|
|
clientRef LDAPClient
|
|
errRef error
|
|
)
|
|
|
|
if clientRef, errRef = p.connectCustom(referral, p.config.User, p.config.Password, p.config.StartTLS, p.dialOpts...); errRef != nil {
|
|
return fmt.Errorf("error occurred connecting to referred LDAP server '%s': %+v. Original Error: %w", referral, errRef, err)
|
|
}
|
|
|
|
defer clientRef.Close()
|
|
|
|
if _, errRef = clientRef.PasswordModify(pwdModifyRequest); errRef != nil {
|
|
return fmt.Errorf("error occurred performing password modify on referred LDAP server '%s': %+v. Original Error: %w", referral, errRef, err)
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
func (p *LDAPUserProvider) getReferral(err error) (referral string, ok bool) {
|
|
if !p.config.PermitReferrals {
|
|
return "", false
|
|
}
|
|
|
|
return ldapGetReferral(err)
|
|
}
|