Skip to content

The open alternative to Salesforce, designed for AI.

Verify IMAP and SMTP server certificates by default (#28115)

Charles Bochet243cb8c3322c
diff --git a/packages/twenty-server/src/engine/core-modules/imap-smtp-caldav-connection/services/imap-smtp-caldav-connection.service.ts b/packages/twenty-server/src/engine/core-modules/imap-smtp-caldav-connection/services/imap-smtp-caldav-connection.service.ts
index fb57e492f83..2250ce4c2ac 100644
--- a/packages/twenty-server/src/engine/core-modules/imap-smtp-caldav-connection/services/imap-smtp-caldav-connection.service.ts
+++ b/packages/twenty-server/src/engine/core-modules/imap-smtp-caldav-connection/services/imap-smtp-caldav-connection.service.ts
@@ -16,6 +16,7 @@ import {
type PlaintextImapSmtpCaldavParams,
} from 'src/engine/core-modules/imap-smtp-caldav-connection/types/imap-smtp-caldav-connection.type';
import { buildImapTlsOptions } from 'src/engine/core-modules/imap-smtp-caldav-connection/utils/build-imap-tls-options.util';
+import { buildMailServerCertificateOptions } from 'src/engine/core-modules/imap-smtp-caldav-connection/utils/build-mail-server-certificate-options.util';
import { buildSmtpTlsOptions } from 'src/engine/core-modules/imap-smtp-caldav-connection/utils/build-smtp-tls-options.util';
import { SecureHttpClientService } from 'src/engine/core-modules/secure-http-client/secure-http-client.service';
import { TwentyConfigService } from 'src/engine/core-modules/twenty-config/twenty-config.service';
@@ -51,9 +52,12 @@ export class ImapSmtpCaldavService {
},
logger: false,
disableIMAP4rev2: true,
- tls: {
- rejectUnauthorized: false,
- },
+ tls: buildMailServerCertificateOptions({
+ host: params.host,
+ isSelfSignedCertificateAllowed: this.twentyConfigService.get(
+ 'IMAP_SMTP_ALLOW_SELF_SIGNED',
+ ),
+ }),
});
// ImapFlow is EventEmitter — missing 'error' listener crashes process on socket timeout.
@@ -123,9 +127,12 @@ export class ImapSmtpCaldavService {
user: params.username ?? handle,
pass: params.password,
},
- tls: {
- rejectUnauthorized: false,
- },
+ tls: buildMailServerCertificateOptions({
+ host: params.host,
+ isSelfSignedCertificateAllowed: this.twentyConfigService.get(
+ 'IMAP_SMTP_ALLOW_SELF_SIGNED',
+ ),
+ }),
});
try {
diff --git a/packages/twenty-server/src/engine/core-modules/imap-smtp-caldav-connection/utils/__tests__/build-mail-server-certificate-options.util.spec.ts b/packages/twenty-server/src/engine/core-modules/imap-smtp-caldav-connection/utils/__tests__/build-mail-server-certificate-options.util.spec.ts
new file mode 100644
index 00000000000..2f59a1b5461
--- /dev/null
+++ b/packages/twenty-server/src/engine/core-modules/imap-smtp-caldav-connection/utils/__tests__/build-mail-server-certificate-options.util.spec.ts
@@ -0,0 +1,48 @@
+import { buildMailServerCertificateOptions } from 'src/engine/core-modules/imap-smtp-caldav-connection/utils/build-mail-server-certificate-options.util';
+
+describe('buildMailServerCertificateOptions', () => {
+ it('verifies the certificate against the configured hostname by default', () => {
+ expect(
+ buildMailServerCertificateOptions({
+ host: 'imap.example.com',
+ isSelfSignedCertificateAllowed: false,
+ }),
+ ).toEqual({
+ rejectUnauthorized: true,
+ servername: 'imap.example.com',
+ });
+ });
+
+ it('accepts unverifiable certificates only when self-signed servers are allowed', () => {
+ expect(
+ buildMailServerCertificateOptions({
+ host: 'mail.internal',
+ isSelfSignedCertificateAllowed: true,
+ }),
+ ).toEqual({
+ rejectUnauthorized: false,
+ servername: 'mail.internal',
+ });
+ });
+
+ it('verifies against the hostname when the host was saved as a URL', () => {
+ expect(
+ buildMailServerCertificateOptions({
+ host: 'imaps://mail.example.com:993',
+ isSelfSignedCertificateAllowed: false,
+ }),
+ ).toEqual({
+ rejectUnauthorized: true,
+ servername: 'mail.example.com',
+ });
+ });
+
+ it('omits the servername for IP literals, which are not valid SNI values', () => {
+ expect(
+ buildMailServerCertificateOptions({
+ host: '192.168.1.10',
+ isSelfSignedCertificateAllowed: false,
+ }),
+ ).toEqual({ rejectUnauthorized: true });
+ });
+});
diff --git a/packages/twenty-server/src/engine/core-modules/imap-smtp-caldav-connection/utils/build-mail-server-certificate-options.util.ts b/packages/twenty-server/src/engine/core-modules/imap-smtp-caldav-connection/utils/build-mail-server-certificate-options.util.ts
new file mode 100644
index 00000000000..191e3ec52d4
--- /dev/null
+++ b/packages/twenty-server/src/engine/core-modules/imap-smtp-caldav-connection/utils/build-mail-server-certificate-options.util.ts
@@ -0,0 +1,24 @@
+import { isIP } from 'net';
+
+import { normalizeAllowedInternalHost } from 'src/engine/core-modules/secure-http-client/utils/normalize-allowed-internal-host.util';
+
+type MailServerCertificateOptions = {
+ rejectUnauthorized: boolean;
+ servername?: string;
+};
+
+export const buildMailServerCertificateOptions = ({
+ host,
+ isSelfSignedCertificateAllowed,
+}: {
+ host: string;
+ isSelfSignedCertificateAllowed: boolean;
+}): MailServerCertificateOptions => {
+ const hostname = normalizeAllowedInternalHost(host);
+
+ return {
+ rejectUnauthorized: !isSelfSignedCertificateAllowed,
+ // Socket connects to the SSRF-pinned IP, so verify the cert against the configured hostname
+ ...(isIP(hostname) === 0 ? { servername: hostname } : {}),
+ };
+};
diff --git a/packages/twenty-server/src/engine/core-modules/twenty-config/config-variables.ts b/packages/twenty-server/src/engine/core-modules/twenty-config/config-variables.ts
index 785d32adbaf..e972064350e 100644
--- a/packages/twenty-server/src/engine/core-modules/twenty-config/config-variables.ts
+++ b/packages/twenty-server/src/engine/core-modules/twenty-config/config-variables.ts
@@ -106,6 +106,15 @@ export class ConfigVariables {
@IsOptional()
OUTBOUND_HTTP_ALLOWED_INTERNAL_HOSTS: string[] = [];
+ @ConfigVariablesMetadata({
+ group: ConfigVariablesGroup.ADVANCED_SETTINGS,
+ description:
+ 'Accept IMAP and SMTP servers whose TLS certificate cannot be verified, e.g. self-signed. Prefer adding your CA with NODE_EXTRA_CA_CERTS, which keeps verification on.',
+ type: ConfigVariableType.BOOLEAN,
+ })
+ @IsOptional()
+ IMAP_SMTP_ALLOW_SELF_SIGNED = false;
+
@ConfigVariablesMetadata({
group: ConfigVariablesGroup.ADVANCED_SETTINGS,
description:
diff --git a/packages/twenty-server/src/modules/messaging/message-import-manager/drivers/imap/providers/imap-client.provider.ts b/packages/twenty-server/src/modules/messaging/message-import-manager/drivers/imap/providers/imap-client.provider.ts
index 5d74490c5b5..ca6c838e510 100644
--- a/packages/twenty-server/src/modules/messaging/message-import-manager/drivers/imap/providers/imap-client.provider.ts
+++ b/packages/twenty-server/src/modules/messaging/message-import-manager/drivers/imap/providers/imap-client.provider.ts
@@ -7,7 +7,9 @@ import { isDefined } from 'twenty-shared/utils';
import { Repository } from 'typeorm';
import { buildImapTlsOptions } from 'src/engine/core-modules/imap-smtp-caldav-connection/utils/build-imap-tls-options.util';
+import { buildMailServerCertificateOptions } from 'src/engine/core-modules/imap-smtp-caldav-connection/utils/build-mail-server-certificate-options.util';
import { SecureHttpClientService } from 'src/engine/core-modules/secure-http-client/secure-http-client.service';
+import { TwentyConfigService } from 'src/engine/core-modules/twenty-config/twenty-config.service';
import { ConnectedAccountEntity } from 'src/engine/metadata-modules/connected-account/entities/connected-account.entity';
import { ConnectedAccountTokenEncryptionService } from 'src/engine/metadata-modules/connected-account/services/connected-account-token-encryption.service';
import {
@@ -25,6 +27,7 @@ export class ImapClientProvider {
constructor(
private readonly secureHttpClientService: SecureHttpClientService,
+ private readonly twentyConfigService: TwentyConfigService,
private readonly connectedAccountTokenEncryptionService: ConnectedAccountTokenEncryptionService,
@InjectRepository(ConnectedAccountEntity)
private readonly connectedAccountRepository: Repository<ConnectedAccountEntity>,
@@ -104,9 +107,12 @@ export class ImapClientProvider {
},
logger: false,
disableIMAP4rev2: true,
- tls: {
- rejectUnauthorized: false,
- },
+ tls: buildMailServerCertificateOptions({
+ host: imapParams.host,
+ isSelfSignedCertificateAllowed: this.twentyConfigService.get(
+ 'IMAP_SMTP_ALLOW_SELF_SIGNED',
+ ),
+ }),
connectionTimeout: ImapClientProvider.CONNECTION_TIMEOUT_MS,
greetingTimeout: ImapClientProvider.GREETING_TIMEOUT_MS,
});
diff --git a/packages/twenty-server/src/modules/messaging/message-import-manager/drivers/smtp/providers/smtp-client.provider.ts b/packages/twenty-server/src/modules/messaging/message-import-manager/drivers/smtp/providers/smtp-client.provider.ts
index 77aa4c341eb..e583822321b 100644
--- a/packages/twenty-server/src/modules/messaging/message-import-manager/drivers/smtp/providers/smtp-client.provider.ts
+++ b/packages/twenty-server/src/modules/messaging/message-import-manager/drivers/smtp/providers/smtp-client.provider.ts
@@ -9,8 +9,10 @@ import { ConnectedAccountProvider } from 'twenty-shared/types';
import { isDefined } from 'twenty-shared/utils';
import { Repository } from 'typeorm';
+import { buildMailServerCertificateOptions } from 'src/engine/core-modules/imap-smtp-caldav-connection/utils/build-mail-server-certificate-options.util';
import { buildSmtpTlsOptions } from 'src/engine/core-modules/imap-smtp-caldav-connection/utils/build-smtp-tls-options.util';
import { SecureHttpClientService } from 'src/engine/core-modules/secure-http-client/secure-http-client.service';
+import { TwentyConfigService } from 'src/engine/core-modules/twenty-config/twenty-config.service';
import { ConnectedAccountEntity } from 'src/engine/metadata-modules/connected-account/entities/connected-account.entity';
import { ConnectedAccountTokenEncryptionService } from 'src/engine/metadata-modules/connected-account/services/connected-account-token-encryption.service';
@@ -18,6 +20,7 @@ import { ConnectedAccountTokenEncryptionService } from 'src/engine/metadata-modu
export class SmtpClientProvider {
constructor(
private readonly secureHttpClientService: SecureHttpClientService,
+ private readonly twentyConfigService: TwentyConfigService,
private readonly connectedAccountTokenEncryptionService: ConnectedAccountTokenEncryptionService,
@InjectRepository(ConnectedAccountEntity)
private readonly connectedAccountRepository: Repository<ConnectedAccountEntity>,
@@ -58,9 +61,12 @@ export class SmtpClientProvider {
user: smtpParams.username ?? connectedAccount.handle ?? '',
pass: smtpParams.password,
},
- tls: {
- rejectUnauthorized: false,
- },
+ tls: buildMailServerCertificateOptions({
+ host: smtpParams.host,
+ isSelfSignedCertificateAllowed: this.twentyConfigService.get(
+ 'IMAP_SMTP_ALLOW_SELF_SIGNED',
+ ),
+ }),
};
const transporter = createTransport(options);