The open alternative to Salesforce, designed for AI.
TypeScript crmcrm-systemcustomergood-first-issuegraphqlhacktoberfestjavascriptmarketingmonoreponestjsopen-sourcepostgresqlreactreactjssalestypescriptweb
Offer a DMARC record only when the sending domain has none (#25547)
neo77389d5fd101a31
diff --git a/packages/twenty-server/src/engine/core-modules/emailing-domain/constants/dmarc-monitoring-policy.constant.ts b/packages/twenty-server/src/engine/core-modules/emailing-domain/constants/dmarc-monitoring-policy.constant.tsnew file mode 100644index 00000000000..f220c46b918--- /dev/null+++ b/packages/twenty-server/src/engine/core-modules/emailing-domain/constants/dmarc-monitoring-policy.constant.ts@@ -0,0 +1 @@+export const DMARC_MONITORING_POLICY = 'p=none';diff --git a/packages/twenty-server/src/engine/core-modules/emailing-domain/constants/dmarc-record-prefix.constant.ts b/packages/twenty-server/src/engine/core-modules/emailing-domain/constants/dmarc-record-prefix.constant.tsnew file mode 100644index 00000000000..de722f4ff4e--- /dev/null+++ b/packages/twenty-server/src/engine/core-modules/emailing-domain/constants/dmarc-record-prefix.constant.ts@@ -0,0 +1 @@+export const DMARC_RECORD_PREFIX = '_dmarc';diff --git a/packages/twenty-server/src/engine/core-modules/emailing-domain/constants/dmarc-report-mailbox.constant.ts b/packages/twenty-server/src/engine/core-modules/emailing-domain/constants/dmarc-report-mailbox.constant.tsnew file mode 100644index 00000000000..23477b4355c--- /dev/null+++ b/packages/twenty-server/src/engine/core-modules/emailing-domain/constants/dmarc-report-mailbox.constant.ts@@ -0,0 +1 @@+export const DMARC_REPORT_MAILBOX = 'dmarc';diff --git a/packages/twenty-server/src/engine/core-modules/emailing-domain/constants/dmarc-version-tag.constant.ts b/packages/twenty-server/src/engine/core-modules/emailing-domain/constants/dmarc-version-tag.constant.tsnew file mode 100644index 00000000000..21d233fce55--- /dev/null+++ b/packages/twenty-server/src/engine/core-modules/emailing-domain/constants/dmarc-version-tag.constant.ts@@ -0,0 +1 @@+export const DMARC_VERSION_TAG = 'v=DMARC1';diff --git a/packages/twenty-server/src/engine/core-modules/emailing-domain/constants/missing-dns-record-error-codes.constant.ts b/packages/twenty-server/src/engine/core-modules/emailing-domain/constants/missing-dns-record-error-codes.constant.tsnew file mode 100644index 00000000000..02b17c15434--- /dev/null+++ b/packages/twenty-server/src/engine/core-modules/emailing-domain/constants/missing-dns-record-error-codes.constant.ts@@ -0,0 +1 @@+export const MISSING_DNS_RECORD_ERROR_CODES = ['ENOTFOUND', 'ENODATA'];diff --git a/packages/twenty-server/src/engine/core-modules/emailing-domain/emailing-domain.module.ts b/packages/twenty-server/src/engine/core-modules/emailing-domain/emailing-domain.module.tsindex f5c323988f0..807831fcc9d 100644--- a/packages/twenty-server/src/engine/core-modules/emailing-domain/emailing-domain.module.ts+++ b/packages/twenty-server/src/engine/core-modules/emailing-domain/emailing-domain.module.ts@@ -23,6 +23,7 @@ import { EmailingDomainWorkspaceCleanupJob } from 'src/engine/core-modules/emailimport { EmailingDomainTenantStatusService } from 'src/engine/core-modules/emailing-domain/services/emailing-domain-tenant-status.service';import { EmailingDomainService } from 'src/engine/core-modules/emailing-domain/services/emailing-domain.service';import { UnsubscribeContentService } from 'src/engine/core-modules/emailing-domain/services/unsubscribe-content.service';+import { DmarcRecordService } from 'src/engine/core-modules/emailing-domain/services/dmarc-record.service';import { UnsubscribeHostnameService } from 'src/engine/core-modules/emailing-domain/services/unsubscribe-hostname.service';import { UnsubscribeTokenService } from 'src/engine/core-modules/emailing-domain/services/unsubscribe-token.service';import { EnterpriseModule } from 'src/engine/core-modules/enterprise/enterprise.module';@@ -60,6 +61,7 @@ import { provideWorkspaceScopedRepository } from 'src/engine/twenty-orm/workspacUnsubscribeTokenService,UnsubscribeContentService,UnsubscribeHostnameService,+ DmarcRecordService,EmailingDomainResolver,EmailingDomainDriverFactory,EmailingDomainWorkspaceCleanupJob,diff --git a/packages/twenty-server/src/engine/core-modules/emailing-domain/services/dmarc-record.service.ts b/packages/twenty-server/src/engine/core-modules/emailing-domain/services/dmarc-record.service.tsnew file mode 100644index 00000000000..b3b96c71260--- /dev/null+++ b/packages/twenty-server/src/engine/core-modules/emailing-domain/services/dmarc-record.service.ts@@ -0,0 +1,73 @@+import { Injectable, Logger } from '@nestjs/common';++import { resolveTxt } from 'dns/promises';+import { isNonEmptyString } from '@sniptt/guards';++import { DMARC_RECORD_PREFIX } from 'src/engine/core-modules/emailing-domain/constants/dmarc-record-prefix.constant';+import { EmailingDomainEntity } from 'src/engine/core-modules/emailing-domain/emailing-domain.entity';+import { buildDmarcVerificationRecord } from 'src/engine/core-modules/emailing-domain/utils/build-dmarc-verification-record.util';+import { containsDmarcPolicy } from 'src/engine/core-modules/emailing-domain/utils/contains-dmarc-policy.util';+import { getDmarcLookupDomains } from 'src/engine/core-modules/emailing-domain/utils/get-dmarc-lookup-domains.util';+import { isMissingDnsRecordError } from 'src/engine/core-modules/emailing-domain/utils/is-missing-dns-record-error.util';++@Injectable()+export class DmarcRecordService {+ private readonly logger = new Logger(DmarcRecordService.name);++ async withDnsRecord(+ emailingDomain: EmailingDomainEntity,+ ): Promise<EmailingDomainEntity> {+ if (!isNonEmptyString(emailingDomain.domain)) {+ return emailingDomain;+ }++ const canOfferDmarcRecord = await this.canOfferDmarcRecord(+ emailingDomain.domain,+ );++ if (!canOfferDmarcRecord) {+ return emailingDomain;+ }++ return {+ ...emailingDomain,+ verificationRecords: [+ ...(emailingDomain.verificationRecords ?? []),+ buildDmarcVerificationRecord(emailingDomain.domain),+ ],+ };+ }++ private async canOfferDmarcRecord(domain: string): Promise<boolean> {+ for (const lookupDomain of getDmarcLookupDomains(domain)) {+ const hasResolvedWithoutPolicy =+ await this.hasResolvedWithoutPolicy(lookupDomain);++ if (!hasResolvedWithoutPolicy) {+ return false;+ }+ }++ return true;+ }++ private async hasResolvedWithoutPolicy(domain: string): Promise<boolean> {+ try {+ const txtRecords = await resolveTxt(`${DMARC_RECORD_PREFIX}.${domain}`);++ return !containsDmarcPolicy(txtRecords);+ } catch (error) {+ if (isMissingDnsRecordError(error)) {+ return true;+ }++ this.logger.warn(+ `Could not resolve the DMARC record of ${domain}, assuming a policy is already published: ${+ error instanceof Error ? error.message : String(error)+ }`,+ );++ return false;+ }+ }+}diff --git a/packages/twenty-server/src/engine/core-modules/emailing-domain/services/emailing-domain.service.ts b/packages/twenty-server/src/engine/core-modules/emailing-domain/services/emailing-domain.service.tsindex aa45063bad8..1f8e204c334 100644--- a/packages/twenty-server/src/engine/core-modules/emailing-domain/services/emailing-domain.service.ts+++ b/packages/twenty-server/src/engine/core-modules/emailing-domain/services/emailing-domain.service.ts@@ -16,6 +16,7 @@ import {EmailingDomainException,EmailingDomainExceptionCode,} from 'src/engine/core-modules/emailing-domain/exceptions/emailing-domain.exception';+import { DmarcRecordService } from 'src/engine/core-modules/emailing-domain/services/dmarc-record.service';import { UnsubscribeHostnameService } from 'src/engine/core-modules/emailing-domain/services/unsubscribe-hostname.service';import { WorkspaceEntity } from 'src/engine/core-modules/workspace/workspace.entity';import { InjectWorkspaceScopedRepository } from 'src/engine/twenty-orm/workspace-scoped-repository/inject-workspace-scoped-repository.decorator';@@ -34,8 +35,17 @@ export class EmailingDomainService {private readonly globalEmailingDomainRepository: Repository<EmailingDomainEntity>,private readonly emailingDomainDriverFactory: EmailingDomainDriverFactory,private readonly unsubscribeHostnameService: UnsubscribeHostnameService,+ private readonly dmarcRecordService: DmarcRecordService,) {}+ private async withDnsRecords(+ emailingDomain: EmailingDomainEntity,+ ): Promise<EmailingDomainEntity> {+ return this.dmarcRecordService.withDnsRecord(+ await this.unsubscribeHostnameService.withDnsRecords(emailingDomain),+ );+ }+async createEmailingDomain(domain: string,workspaceId: string,@@ -82,7 +92,7 @@ export class EmailingDomainService {provision: true,});- return this.unsubscribeHostnameService.withDnsRecords(+ return this.withDnsRecords(await this.emailingDomainRepository.findOneOrFail(workspaceId, {where: { id: emailingDomain.id },}),@@ -179,7 +189,7 @@ export class EmailingDomainService {return Promise.all(emailingDomains.map((emailingDomain) =>- this.unsubscribeHostnameService.withDnsRecords(emailingDomain),+ this.withDnsRecords(emailingDomain),),);}@@ -222,7 +232,7 @@ export class EmailingDomainService {provision: true,});- return this.unsubscribeHostnameService.withDnsRecords(+ return this.withDnsRecords(await this.emailingDomainRepository.findOneOrFail(workspaceId, {where: { id: emailingDomain.id },}),diff --git a/packages/twenty-server/src/engine/core-modules/emailing-domain/utils/__tests__/build-dmarc-verification-record.util.spec.ts b/packages/twenty-server/src/engine/core-modules/emailing-domain/utils/__tests__/build-dmarc-verification-record.util.spec.tsnew file mode 100644index 00000000000..0529b1b289c--- /dev/null+++ b/packages/twenty-server/src/engine/core-modules/emailing-domain/utils/__tests__/build-dmarc-verification-record.util.spec.ts@@ -0,0 +1,21 @@+import { buildDmarcVerificationRecord } from 'src/engine/core-modules/emailing-domain/utils/build-dmarc-verification-record.util';++describe('buildDmarcVerificationRecord', () => {+ it('should publish the policy at the _dmarc subdomain of the sending domain', () => {+ expect(buildDmarcVerificationRecord('acme.com')).toEqual({+ type: 'TXT',+ key: '_dmarc.acme.com',+ value: 'v=DMARC1; p=none; rua=mailto:[email protected]',+ });+ });++ it('should keep aggregate reports on the sending domain so no external destination authorization is needed', () => {+ const record = buildDmarcVerificationRecord('mail.acme.co.uk');++ expect(record.value).toContain('rua=mailto:[email protected]');+ });++ it('should start in monitoring mode so an unaligned sender is reported rather than rejected', () => {+ expect(buildDmarcVerificationRecord('acme.com').value).toContain('p=none');+ });+});diff --git a/packages/twenty-server/src/engine/core-modules/emailing-domain/utils/__tests__/contains-dmarc-policy.util.spec.ts b/packages/twenty-server/src/engine/core-modules/emailing-domain/utils/__tests__/contains-dmarc-policy.util.spec.tsnew file mode 100644index 00000000000..07ead193239--- /dev/null+++ b/packages/twenty-server/src/engine/core-modules/emailing-domain/utils/__tests__/contains-dmarc-policy.util.spec.ts@@ -0,0 +1,36 @@+import { containsDmarcPolicy } from 'src/engine/core-modules/emailing-domain/utils/contains-dmarc-policy.util';++describe('containsDmarcPolicy', () => {+ it('should find a policy among unrelated TXT records at the same name', () => {+ expect(+ containsDmarcPolicy([+ ['some-verification-token'],+ ['v=DMARC1; p=reject'],+ ]),+ ).toBe(true);+ });++ it('should join the chunks a long record is split into before matching', () => {+ expect(+ containsDmarcPolicy([['v=DMARC', '1; p=none; rua=mailto:[email protected]']]),+ ).toBe(true);+ });++ it('should match regardless of case and surrounding whitespace', () => {+ expect(containsDmarcPolicy([[' V=DmArC1; p=none']])).toBe(true);+ });++ it('should not treat an SPF record as a policy', () => {+ expect(containsDmarcPolicy([['v=spf1 include:amazonses.com ~all']])).toBe(+ false,+ );+ });++ it('should not match a record that only mentions the version tag later on', () => {+ expect(containsDmarcPolicy([['note: v=DMARC1 goes here']])).toBe(false);+ });++ it('should report no policy when the name resolves to nothing', () => {+ expect(containsDmarcPolicy([])).toBe(false);+ });+});diff --git a/packages/twenty-server/src/engine/core-modules/emailing-domain/utils/__tests__/get-dmarc-lookup-domains.util.spec.ts b/packages/twenty-server/src/engine/core-modules/emailing-domain/utils/__tests__/get-dmarc-lookup-domains.util.spec.tsnew file mode 100644index 00000000000..d5c5afc89dc--- /dev/null+++ b/packages/twenty-server/src/engine/core-modules/emailing-domain/utils/__tests__/get-dmarc-lookup-domains.util.spec.ts@@ -0,0 +1,25 @@+import { getDmarcLookupDomains } from 'src/engine/core-modules/emailing-domain/utils/get-dmarc-lookup-domains.util';++describe('getDmarcLookupDomains', () => {+ it('should look up the organizational domain only once for a domain that is already one', () => {+ expect(getDmarcLookupDomains('acme.com')).toEqual(['acme.com']);+ });++ it('should fall back to the organizational domain, whose policy a subdomain inherits', () => {+ expect(getDmarcLookupDomains('mail.acme.com')).toEqual([+ 'mail.acme.com',+ 'acme.com',+ ]);+ });++ it('should treat a multi-label public suffix as one organizational domain', () => {+ expect(getDmarcLookupDomains('send.acme.co.uk')).toEqual([+ 'send.acme.co.uk',+ 'acme.co.uk',+ ]);+ });++ it('should stay with the given name when it cannot be parsed as a public domain', () => {+ expect(getDmarcLookupDomains('localhost')).toEqual(['localhost']);+ });+});diff --git a/packages/twenty-server/src/engine/core-modules/emailing-domain/utils/__tests__/is-missing-dns-record-error.util.spec.ts b/packages/twenty-server/src/engine/core-modules/emailing-domain/utils/__tests__/is-missing-dns-record-error.util.spec.tsnew file mode 100644index 00000000000..00bd156d139--- /dev/null+++ b/packages/twenty-server/src/engine/core-modules/emailing-domain/utils/__tests__/is-missing-dns-record-error.util.spec.ts@@ -0,0 +1,30 @@+import { isMissingDnsRecordError } from 'src/engine/core-modules/emailing-domain/utils/is-missing-dns-record-error.util';++const buildDnsError = (code: string): Error =>+ Object.assign(new Error(`queryTxt ${code}`), { code });++describe('isMissingDnsRecordError', () => {+ it('should recognise a name that does not exist', () => {+ expect(isMissingDnsRecordError(buildDnsError('ENOTFOUND'))).toBe(true);+ });++ it('should recognise a name that exists without TXT records', () => {+ expect(isMissingDnsRecordError(buildDnsError('ENODATA'))).toBe(true);+ });++ it('should not treat a resolver failure as a missing record', () => {+ expect(isMissingDnsRecordError(buildDnsError('SERVFAIL'))).toBe(false);+ });++ it('should not treat a timeout as a missing record', () => {+ expect(isMissingDnsRecordError(buildDnsError('ETIMEOUT'))).toBe(false);+ });++ it('should reject an error carrying no code', () => {+ expect(isMissingDnsRecordError(new Error('boom'))).toBe(false);+ });++ it('should reject a thrown value that is not an error', () => {+ expect(isMissingDnsRecordError('ENOTFOUND')).toBe(false);+ });+});diff --git a/packages/twenty-server/src/engine/core-modules/emailing-domain/utils/build-dmarc-verification-record.util.ts b/packages/twenty-server/src/engine/core-modules/emailing-domain/utils/build-dmarc-verification-record.util.tsnew file mode 100644index 00000000000..87a4a1bb12e--- /dev/null+++ b/packages/twenty-server/src/engine/core-modules/emailing-domain/utils/build-dmarc-verification-record.util.ts@@ -0,0 +1,13 @@+import { DMARC_MONITORING_POLICY } from 'src/engine/core-modules/emailing-domain/constants/dmarc-monitoring-policy.constant';+import { DMARC_RECORD_PREFIX } from 'src/engine/core-modules/emailing-domain/constants/dmarc-record-prefix.constant';+import { DMARC_REPORT_MAILBOX } from 'src/engine/core-modules/emailing-domain/constants/dmarc-report-mailbox.constant';+import { DMARC_VERSION_TAG } from 'src/engine/core-modules/emailing-domain/constants/dmarc-version-tag.constant';+import { type VerificationRecord } from 'src/engine/core-modules/emailing-domain/drivers/types/verifications-record';++export const buildDmarcVerificationRecord = (+ domain: string,+): VerificationRecord => ({+ type: 'TXT',+ key: `${DMARC_RECORD_PREFIX}.${domain}`,+ value: `${DMARC_VERSION_TAG}; ${DMARC_MONITORING_POLICY}; rua=mailto:${DMARC_REPORT_MAILBOX}@${domain}`,+});diff --git a/packages/twenty-server/src/engine/core-modules/emailing-domain/utils/contains-dmarc-policy.util.ts b/packages/twenty-server/src/engine/core-modules/emailing-domain/utils/contains-dmarc-policy.util.tsnew file mode 100644index 00000000000..d4a1b6e4745--- /dev/null+++ b/packages/twenty-server/src/engine/core-modules/emailing-domain/utils/contains-dmarc-policy.util.ts@@ -0,0 +1,10 @@+import { DMARC_VERSION_TAG } from 'src/engine/core-modules/emailing-domain/constants/dmarc-version-tag.constant';++export const containsDmarcPolicy = (txtRecords: string[][]): boolean =>+ txtRecords.some((chunks) =>+ chunks+ .join('')+ .trim()+ .toLowerCase()+ .startsWith(DMARC_VERSION_TAG.toLowerCase()),+ );diff --git a/packages/twenty-server/src/engine/core-modules/emailing-domain/utils/get-dmarc-lookup-domains.util.ts b/packages/twenty-server/src/engine/core-modules/emailing-domain/utils/get-dmarc-lookup-domains.util.tsnew file mode 100644index 00000000000..623e4854e10--- /dev/null+++ b/packages/twenty-server/src/engine/core-modules/emailing-domain/utils/get-dmarc-lookup-domains.util.ts@@ -0,0 +1,12 @@+import psl from 'psl';+import { isDefined } from 'twenty-shared/utils';++export const getDmarcLookupDomains = (domain: string): string[] => {+ const organizationalDomain = psl.get(domain);++ if (!isDefined(organizationalDomain) || organizationalDomain === domain) {+ return [domain];+ }++ return [domain, organizationalDomain];+};diff --git a/packages/twenty-server/src/engine/core-modules/emailing-domain/utils/is-missing-dns-record-error.util.ts b/packages/twenty-server/src/engine/core-modules/emailing-domain/utils/is-missing-dns-record-error.util.tsnew file mode 100644index 00000000000..2d6e789c473--- /dev/null+++ b/packages/twenty-server/src/engine/core-modules/emailing-domain/utils/is-missing-dns-record-error.util.ts@@ -0,0 +1,15 @@+import { isDefined } from 'twenty-shared/utils';++import { MISSING_DNS_RECORD_ERROR_CODES } from 'src/engine/core-modules/emailing-domain/constants/missing-dns-record-error-codes.constant';++export const isMissingDnsRecordError = (error: unknown): boolean => {+ if (!(error instanceof Error) || !('code' in error)) {+ return false;+ }++ const { code } = error;++ return (+ isDefined(code) && MISSING_DNS_RECORD_ERROR_CODES.includes(String(code))+ );+};