Skip to content

Sync-in · Sovereign platform for file storage, sharing, synchronization, and collaboration.

feat(backend:notifications): add email notifications for two-factor authentication security events

johavenb207f336c2dc
diff --git a/backend/src/applications/files/services/files-only-office-manager.service.ts b/backend/src/applications/files/services/files-only-office-manager.service.ts
index ca9d7069..e4fe320a 100644
--- a/backend/src/applications/files/services/files-only-office-manager.service.ts
+++ b/backend/src/applications/files/services/files-only-office-manager.service.ts
@@ -228,6 +228,7 @@ export class FilesOnlyOfficeManager {
login: user.login,
email: user.email,
fullName: user.fullName,
+ language: user.language,
role: user.role,
applications: user.applications
} satisfies JwtIdentityPayload
diff --git a/backend/src/applications/notifications/constants/notifications.ts b/backend/src/applications/notifications/constants/notifications.ts
index 903712e8..0f61379d 100644
--- a/backend/src/applications/notifications/constants/notifications.ts
+++ b/backend/src/applications/notifications/constants/notifications.ts
@@ -12,7 +12,8 @@ export enum NOTIFICATION_APP {
SPACE_ROOTS = 'spaces_roots',
SHARES = 'shares',
LINKS = 'links',
- SYNC = 'sync'
+ SYNC = 'sync',
+ AUTH_2FA = 'auth_2fa'
}
export const NOTIFICATION_APP_EVENT = {
@@ -41,5 +42,9 @@ export const NOTIFICATION_APP_EVENT = {
},
SYNC: {
[ACTION.DELETE]: 'You are no longer synchronizing'
+ },
+ AUTH_2FA: {
+ [ACTION.ADD]: 'Two-factor authentication (2FA) on your account has been enabled',
+ [ACTION.DELETE]: 'Two-factor authentication (2FA) on your account has been disabled'
}
}
diff --git a/backend/src/applications/notifications/i18n/fr.ts b/backend/src/applications/notifications/i18n/fr.ts
index 74b4278e..19de5767 100644
--- a/backend/src/applications/notifications/i18n/fr.ts
+++ b/backend/src/applications/notifications/i18n/fr.ts
@@ -32,5 +32,11 @@ export const fr = {
'Access password': `Mot de passe d'accès`,
Sync: 'Synchronisation',
'Access your syncs from': 'Accédez à vos synchronisations depuis',
- 'You are no longer synchronizing': 'Vous ne synchronisez plus'
+ 'You are no longer synchronizing': 'Vous ne synchronisez plus',
+ 'Security notification': 'Notification de sécurité',
+ 'Two-factor authentication (2FA) on your account has been disabled': `L’authentification à deux facteurs (2FA) sur votre compte a été désactivée`,
+ 'Two-factor authentication (2FA) on your account has been enabled': `L’authentification à deux facteurs (2FA) sur votre compte a été activée`,
+ 'You received this notification because the security of your Sync-in account has changed. If you think this was a mistake, please review your security settings or contact your administrator.': `Vous recevez cette notification car la sécurité de votre compte Sync-in a été modifiée. Si vous pensez qu’il s’agit d’une erreur, vérifiez vos paramètres de sécurité ou contactez votre administrateur.`,
+ 'Address IP': 'Adresse IP',
+ Browser: 'Navigateur'
} as const
diff --git a/backend/src/applications/notifications/mails/models.ts b/backend/src/applications/notifications/mails/models.ts
index aaa4d2fd..70c46c3f 100644
--- a/backend/src/applications/notifications/mails/models.ts
+++ b/backend/src/applications/notifications/mails/models.ts
@@ -126,7 +126,6 @@ export function linkMail(
): [string, string] {
const tr = translateObject(language, {
title: options.action === ACTION.ADD ? 'Share' : 'Space',
- defaultFooter: defaultFooter,
passwordText: 'Access password',
urlText: 'Access it from',
event: notification.event
@@ -138,7 +137,7 @@ export function linkMail(
content += `<br><br>${tr.passwordText}:&nbsp;<div style="border:1px solid #000; padding:8px; display:inline-block;">${options.linkPassword}</div>`
}
- const footer = `<br>${tr.urlText}&nbsp;<a href="${urlFromLink(options.currentUrl, options.linkUUID)}">${SERVER_NAME}</a><br>${tr.defaultFooter}`
+ const footer = `<br>${tr.urlText}&nbsp;<a href="${urlFromLink(options.currentUrl, options.linkUUID)}">${SERVER_NAME}</a>`
return [`${tr.title}: ${capitalizeString(notification.element)}`, mailTemplate(content, footer)]
}
@@ -166,3 +165,20 @@ export function syncMail(
return [`${tr.title}: ${capitalizeString(notification.element)}`, mailTemplate(content, footer)]
}
+
+export function auth2FaMail(language: string, notification: NotificationContent): [string, string] {
+ const tr = translateObject(language, {
+ title: 'Security notification',
+ footer:
+ 'You received this notification because the security of your Sync-in account has changed. If you think this was a mistake, please review your security settings or contact your administrator.',
+ event: notification.event,
+ addressIp: 'Address IP',
+ browser: 'Browser'
+ })
+
+ const content = `${tr.event}<br><br>${tr.addressIp}:&nbsp;${notification.url}<br>${tr.browser}:&nbsp;${notification.element}`
+
+ const footer = `<br>${tr.footer}<br>`
+
+ return [tr.title, mailTemplate(content, footer)]
+}
diff --git a/backend/src/applications/notifications/services/notifications-manager.service.ts b/backend/src/applications/notifications/services/notifications-manager.service.ts
index bccf04fc..fb36dc30 100644
--- a/backend/src/applications/notifications/services/notifications-manager.service.ts
+++ b/backend/src/applications/notifications/services/notifications-manager.service.ts
@@ -14,7 +14,7 @@ import { NOTIFICATION_APP } from '../constants/notifications'
import { NOTIFICATIONS_WS } from '../constants/websocket'
import type { NotificationContent, NotificationFromUser, NotificationOptions } from '../interfaces/notification-properties.interface'
import type { UserMailNotification } from '../interfaces/user-mail-notification'
-import { commentMail, linkMail, shareMail, spaceMail, spaceRootMail, syncMail } from '../mails/models'
+import { auth2FaMail, commentMail, linkMail, shareMail, spaceMail, spaceRootMail, syncMail } from '../mails/models'
import { WebSocketNotifications } from '../notifications.gateway'
import { NotificationsQueries } from './notifications-queries.service'
@@ -114,6 +114,8 @@ export class NotificationsManager {
})
case NOTIFICATION_APP.SYNC:
return syncMail(language, content, { currentUrl: options.currentUrl, action: options.action })
+ case NOTIFICATION_APP.AUTH_2FA:
+ return auth2FaMail(language, content)
default:
this.logger.error(`${this.genMail.name} - case not handled : ${content.app}`)
}
diff --git a/backend/src/authentication/interfaces/jwt-payload.interface.ts b/backend/src/authentication/interfaces/jwt-payload.interface.ts
index 81bf8bb7..8e2b856a 100644
--- a/backend/src/authentication/interfaces/jwt-payload.interface.ts
+++ b/backend/src/authentication/interfaces/jwt-payload.interface.ts
@@ -9,6 +9,7 @@ export class JwtIdentityPayload {
login: string
email: string
fullName: string
+ language: string
role: number
applications: string[]
impersonatedFromId?: number
@@ -20,6 +21,7 @@ export class JwtIdentityPayload {
export class JwtIdentity2FaPayload {
id: number
login: string
+ language: string
role: number
twoFaEnabled: true
}
diff --git a/backend/src/authentication/services/auth-manager.service.ts b/backend/src/authentication/services/auth-manager.service.ts
index d7e4b834..17a6a99a 100755
--- a/backend/src/authentication/services/auth-manager.service.ts
+++ b/backend/src/authentication/services/auth-manager.service.ts
@@ -146,6 +146,7 @@ export class AuthManager {
login: user.login,
email: user.email,
fullName: user.fullName,
+ language: user.language,
role: user.role,
applications: user.applications,
impersonatedFromId: user.impersonatedFromId || undefined,
@@ -169,6 +170,7 @@ export class AuthManager {
identity: {
id: user.id,
login: user.login,
+ language: user.language,
role: user.role,
twoFaEnabled: true
} satisfies JwtIdentity2FaPayload,
diff --git a/backend/src/authentication/services/auth-methods/auth-method-two-fa.service.ts b/backend/src/authentication/services/auth-methods/auth-method-two-fa.service.ts
index 4a6eeb36..504331e7 100644
--- a/backend/src/authentication/services/auth-methods/auth-method-two-fa.service.ts
+++ b/backend/src/authentication/services/auth-methods/auth-method-two-fa.service.ts
@@ -7,9 +7,13 @@
import { HttpException, HttpStatus, Injectable, Logger } from '@nestjs/common'
import { configuration } from 'src/configuration/config.environment'
import { Totp } from 'time2fa'
+import { NOTIFICATION_APP, NOTIFICATION_APP_EVENT } from '../../../applications/notifications/constants/notifications'
+import { NotificationContent } from '../../../applications/notifications/interfaces/notification-properties.interface'
+import { NotificationsManager } from '../../../applications/notifications/services/notifications-manager.service'
import { UserPasswordDto } from '../../../applications/users/dto/user-properties.dto'
import { UserModel } from '../../../applications/users/models/user.model'
import { UsersManager } from '../../../applications/users/services/users-manager.service'
+import { ACTION } from '../../../common/constants'
import { generateShortUUID } from '../../../common/functions'
import { qrcodeToDataURL } from '../../../common/qrcode'
import { Cache } from '../../../infrastructure/cache/services/cache.service'
@@ -26,7 +30,8 @@ export class AuthMethod2FA {
constructor(
private readonly cache: Cache,
- private readonly usersManager: UsersManager
+ private readonly usersManager: UsersManager,
+ private readonly notificationsManager: NotificationsManager
) {}
async initTwoFactor(user: UserModel): Promise<TwoFaSetup> {
@@ -54,6 +59,7 @@ export class AuthMethod2FA {
twoFaSecret: secret,
recoveryCodes: recoveryCodes.map((code) => this.encryptSecret(code))
})
+ this.sendEmailNotification(req, ACTION.ADD)
return { ...auth, recoveryCodes: recoveryCodes }
}
@@ -64,6 +70,7 @@ export class AuthMethod2FA {
}
// store and disable TwoFA & recovery codes
await this.usersManager.updateSecrets(req.user.id, { twoFaSecret: undefined, recoveryCodes: undefined })
+ this.sendEmailNotification(req, ACTION.DELETE)
return auth
}
@@ -169,4 +176,16 @@ export class AuthMethod2FA {
private generateRecoveryCodes(count = 5): string[] {
return Array.from({ length: count }, () => generateShortUUID())
}
+
+ private sendEmailNotification(req: FastifyAuthenticatedRequest, action: ACTION) {
+ const notification: NotificationContent = {
+ app: NOTIFICATION_APP.AUTH_2FA,
+ event: NOTIFICATION_APP_EVENT.AUTH_2FA[action],
+ element: req.headers['user-agent'],
+ url: req.ip
+ }
+ this.notificationsManager
+ .sendEmailNotification([req.user], notification)
+ .catch((e: Error) => this.logger.error(`${this.sendEmailNotification.name} - ${e}`))
+ }
}
diff --git a/frontend/src/app/applications/notifications/notifications.constants.ts b/frontend/src/app/applications/notifications/notifications.constants.ts
index b67273dc..8864aea7 100644
--- a/frontend/src/app/applications/notifications/notifications.constants.ts
+++ b/frontend/src/app/applications/notifications/notifications.constants.ts
@@ -10,7 +10,7 @@ import { COMMENTS_ICON } from '../comments/comments.constants'
import { SPACES_ICON } from '../spaces/spaces.constants'
import { SYNC_ICON } from '../sync/sync.constants'
-export const NOTIFICATION_ICON: Record<NOTIFICATION_APP, IconDefinition> = {
+export const NOTIFICATION_ICON: Partial<Record<NOTIFICATION_APP, IconDefinition>> = {
[NOTIFICATION_APP.COMMENTS]: COMMENTS_ICON,
[NOTIFICATION_APP.SPACES]: SPACES_ICON.SPACES,
[NOTIFICATION_APP.SPACE_ROOTS]: SPACES_ICON.SPACES,