Sync-in · Sovereign platform for file storage, sharing, synchronization, and collaboration.
TypeScript cloud-alternativecollaborationcollaborative-editingdropboxfile-serverfile-sharingfile-storagefile-syncfull-text-searchhomelabnextcloudon-premiseopen-sourceprivacy-firstprivate-cloudrealtimesecureself-hostedstorage-serverwebdav
feat(backend:auth): Allow the LDAP `mail` attribute to be used as the login attribute, and allow users to authenticate using either the login attribute or their email address
Johan Legranda683b5760ce9
diff --git a/backend/src/applications/users/constants/user.ts b/backend/src/applications/users/constants/user.tsindex c12bb5e0..7d200c06 100644--- a/backend/src/applications/users/constants/user.ts+++ b/backend/src/applications/users/constants/user.ts@@ -6,7 +6,7 @@export const USER_PASSWORD_MIN_LENGTH = 8export const USER_MAX_PASSWORD_ATTEMPTS = 10-export const USER_LOGIN_VALIDATION = /^(?! )(?!.* $)[a-zA-Z0-9\-\\._ ]{2,255}$/+export const USER_LOGIN_VALIDATION = /^(?! )(?!.* $)[a-zA-Z0-9@\-\\._ ]{2,255}$/export const USER_PATH = {TMP: 'tmp',diff --git a/backend/src/authentication/constants/auth-ldap.ts b/backend/src/authentication/constants/auth-ldap.tsindex 25e6b1fe..aab414cd 100644--- a/backend/src/authentication/constants/auth-ldap.ts+++ b/backend/src/authentication/constants/auth-ldap.ts@@ -7,6 +7,7 @@export enum LDAP_LOGIN_ATTR {UID = 'uid',CN = 'cn',+ MAIL = 'mail',SAM = 'sAMAccountName',UPN = 'userPrincipalName'}diff --git a/backend/src/authentication/services/auth-methods/auth-method-ldap.service.ts b/backend/src/authentication/services/auth-methods/auth-method-ldap.service.tsindex 436675d5..2dc85bb9 100644--- a/backend/src/authentication/services/auth-methods/auth-method-ldap.service.ts+++ b/backend/src/authentication/services/auth-methods/auth-method-ldap.service.ts@@ -33,6 +33,7 @@ export class AuthMethodLdapService implements AuthMethod {) {}async validateUser(login: string, password: string, ip?: string, scope?: AUTH_SCOPE): Promise<UserModel> {+ // Find user from his login or emaillet user: UserModel = await this.usersManager.findUser(this.dbLogin(login), false)if (user) {if (user.isGuest) {@@ -44,7 +45,8 @@ export class AuthMethodLdapService implements AuthMethod {throw new HttpException('Account locked', HttpStatus.FORBIDDEN)}}- const entry: false | LdapUserEntry = await this.checkAuth(login, password)+ // If a user was found, use the stored login. This allows logging in with an email.+ const entry: false | LdapUserEntry = await this.checkAuth(user?.login || login, password)if (entry === false) {// LDAP auth failedif (user) {@@ -239,9 +241,7 @@ export class AuthMethodLdapService implements AuthMethod {}private dbLogin(login: string): string {- if (login.includes('@')) {- return login.split('@')[0]- } else if (login.includes('\\')) {+ if (login.includes('\\')) {return login.split('\\').slice(-1)[0]}return login@@ -264,7 +264,7 @@ export class AuthMethodLdapService implements AuthMethod {// Build a safe LDAP filter to search for a user.// Important: - Values passed to EqualityFilter are auto-escaped by ldapts// - extraFilter is appended as-is (assumed trusted configuration)- // Output: (&(|([email protected])(sAMAccountName=john.doe)(cn=john.doe))(*extraFilter*))+ // Output: (&(|([email protected])(sAMAccountName=john.doe)(cn=john.doe)(uid=john.doe)([email protected]))(*extraFilter*))// Handle the case where the sAMAccountName is provided in domain-qualified format (e.g., SYNC_IN\\user)// Note: sAMAccountName is always stored without the domain in Active Directory.@@ -273,12 +273,14 @@ export class AuthMethodLdapService implements AuthMethod {const or = new OrFilter({filters: this.isAD? [- new EqualityFilter({ attribute: LDAP_LOGIN_ATTR.UPN, value: login }),- new EqualityFilter({ attribute: LDAP_LOGIN_ATTR.SAM, value: dbLogin })+ new EqualityFilter({ attribute: LDAP_LOGIN_ATTR.SAM, value: dbLogin }),+ new EqualityFilter({ attribute: LDAP_LOGIN_ATTR.UPN, value: dbLogin }),+ new EqualityFilter({ attribute: LDAP_LOGIN_ATTR.MAIL, value: dbLogin })]: [new EqualityFilter({ attribute: LDAP_LOGIN_ATTR.UID, value: dbLogin }),- new EqualityFilter({ attribute: LDAP_LOGIN_ATTR.CN, value: dbLogin })+ new EqualityFilter({ attribute: LDAP_LOGIN_ATTR.CN, value: dbLogin }),+ new EqualityFilter({ attribute: LDAP_LOGIN_ATTR.MAIL, value: dbLogin })]})diff --git a/environment/environment.dist.yaml b/environment/environment.dist.yamlindex 42ad0a78..7695f931 100755--- a/environment/environment.dist.yaml+++ b/environment/environment.dist.yaml@@ -19,10 +19,10 @@ logger:# stdout: if false logs are written to the run directory# default: `true`stdout: true- # colorize output+ # Colorize output.# default: `true`colorize: true- # path to the log file used when stdout is set to false+ # Path to the log file used when stdout is set to falsefilePath:mysql:# required@@ -33,20 +33,20 @@ cache:# adapter: `mysql` | `redis`# default: `mysql`adapter: mysql- # ttl in seconds+ # TTL in seconds# default: `60`ttl: 60- # redis adapter url+ # Redis adapter url# default: `redis://127.0.0.1:6379`redis: redis://127.0.0.1:6379websocket:# adapter: `cluster` (Node.js Workers: default) | `redis`# default: `cluster`adapter: cluster- # cors origin allowed+ # Cors origin allowed# default: `*`corsOrigin: '*'- # redis adapter url+ # Redis adapter url# default: `redis://127.0.0.1:6379`redis: redis://127.0.0.1:6379mail:@@ -59,9 +59,9 @@ mail:auth:user: userpass: password- # secure: defines if the connection should use SSL (if true) or not (if false)- # note: setting `secure: false` does not necessarily mean messages are sent in plaintext- # if the server supports STARTTLS, the connection is usually upgraded to TLS automatically+ # Defines if the connection should use SSL (if true) or not (if false)+ # Note: setting `secure: false` does not necessarily mean messages are sent in plaintext+ # If the server supports STARTTLS, the connection is usually upgraded to TLS automatically# default: `false`secure: false# ignoreTLS: if true, disables the use of STARTTLS even if the server advertises it@@ -70,28 +70,28 @@ mail:# rejectUnauthorized: reject the connection if the server's TLS certificate is invalid# default: falserejectUnauthorized: false- # enable logger+ # Enable logger# default: `false`logger: false- # set log level to debug+ # Set log level to debug# default: `false`debug: falseauth:# adapter : `mysql` | `ldap`# default: `mysql`method: mysql- # key used to encrypt user secret keys in the database- # optional, but strongly recommended- # warning: do not change or remove the encryption key after MFA activation, or the codes will become invalid+ # Key used to encrypt user secret keys in the database+ # Optional but strongly recommended+ # Warning: do not change or remove the encryption key after MFA activation, or the codes will become invalidencryptionKey: changeEncryptionKeyWithStrongKey- # multifactor authentication+ # Multifactor authenticationmfa:- # totp configuration+ # TOTP configurationtotp:- # enable TOTP authentication+ # Enable TOTP authentication# default: trueenabled: true- # name displayed in the authentication app (FreeOTP, Proton Authenticator, Aegis Authenticator etc.)+ # Name displayed in the authentication app (FreeOTP, Proton Authenticator, Aegis Authenticator etc.)# default: Sync-inissuer: Sync-in# cookie sameSite setting: `lax` | `strict`@@ -99,14 +99,14 @@ auth:cookieSameSite: stricttoken:access:- # used for token and cookie signatures+ # Used for token and cookie signatures# requiredsecret: changeAccessWithStrongSecret# token expiration = cookie maxAge# default: `30m`expiration: 30mrefresh:- # used for token and cookie signatures+ # Used for token and cookie signatures# requiredsecret: changeRefreshWithStrongSecret# token expiration = cookie maxAge@@ -120,10 +120,13 @@ auth:# filter, e.g: (acl=admin)filter:attributes:- # login attribute: `uid` | `cn` | `sAMAccountName` | `userPrincipalName`, used to authenticate the user+ # Login attribute used to construct the user's DN for binding.+ # The value of this attribute is used as the naming attribute (first RDN) when forming the Distinguished Name (DN) during authentication+ # login: `uid` | `cn` | `mail` | `sAMAccountName` | `userPrincipalName`, used to authenticate the user# default: `uid`login: uid- # email attribute: `mail` or `email`+ # Attribute used to retrieve the user's email address+ # email: `mail` or `email`# default: `mail`email: mail# adminGroup: The CN of a group containing Sync-in administrators (e.g., administrators)@@ -148,14 +151,14 @@ applications:# enable onlyoffice integration# default: falseenabled: false- # for an external server (e.g., https://onlyoffice.domain.com), remember the url must be accessible from browser !- # if externalServer is empty (case of official docker compose), we use the local instance+ # For an external server (e.g., https://onlyoffice.domain.com), remember the url must be accessible from browser!+ # If externalServer is empty (case of official docker compose), we use the local instance# default: nullexternalServer:- # secret used for jwt tokens, it must be the same on the onlyoffice server+ # Secret used for jwt tokens, it must be the same on the onlyoffice server# requiredsecret: onlyOfficeSecret- # if you use https, set to `true`+ # If you use https, set to `true`.# default: `false`verifySSL: falseappStore: