Skip to content

Rallly is an open-source scheduling and collaboration tool designed to make organizing events and meetings easier.

🐛 Require both SMTP_USER and SMTP_PWD for authenticated SMTP (#3064)

Pruthvi Kotharkar640959522977
diff --git a/apps/web/src/env.ts b/apps/web/src/env.ts
index a37f5c1c4..7e1149b0d 100644
--- a/apps/web/src/env.ts
+++ b/apps/web/src/env.ts
@@ -294,4 +294,17 @@ export const env = createEnv({
process.env.NEXT_PUBLIC_COOKIE_DOMAIN || undefined,
},
skipValidation: !!process.env.SKIP_ENV_VALIDATION,
+ createFinalSchema: (shape) =>
+ z.object(shape).superRefine((env, ctx) => {
+ // Authenticated SMTP needs both credentials; nodemailer fails at send
+ // time with a cryptic "Missing credentials" error if one is missing.
+ if (Boolean(env.SMTP_USER) !== Boolean(env.SMTP_PWD)) {
+ ctx.addIssue({
+ code: "custom",
+ path: [env.SMTP_USER ? "SMTP_PWD" : "SMTP_USER"],
+ message:
+ "SMTP_USER and SMTP_PWD must be set together. Set both to use authenticated SMTP, or neither to connect without authentication.",
+ });
+ }
+ }),
});
diff --git a/packages/emails/src/transport.test.ts b/packages/emails/src/transport.test.ts
new file mode 100644
index 000000000..39694edc2
--- /dev/null
+++ b/packages/emails/src/transport.test.ts
@@ -0,0 +1,83 @@
+import { afterEach, beforeEach, expect, test, vi } from "vitest";
+
+const createTransport = vi.fn((_options: unknown) => ({}));
+
+vi.mock("nodemailer", () => ({
+ createTransport: (options: unknown) => createTransport(options),
+}));
+
+vi.mock("@rallly/logger", () => ({
+ logger: { child: () => ({}) },
+}));
+
+const { createTransportForProvider } = await import("./transport");
+
+const SMTP_ENV_VARS = [
+ "SMTP_USER",
+ "SMTP_PWD",
+ "SMTP_HOST",
+ "SMTP_PORT",
+ "SMTP_SECURE",
+ "SMTP_DEBUG",
+];
+
+const savedEnv: Record<string, string | undefined> = {};
+
+beforeEach(() => {
+ createTransport.mockClear();
+ for (const name of SMTP_ENV_VARS) {
+ savedEnv[name] = process.env[name];
+ delete process.env[name];
+ }
+});
+
+afterEach(() => {
+ for (const name of SMTP_ENV_VARS) {
+ if (savedEnv[name] === undefined) {
+ delete process.env[name];
+ } else {
+ process.env[name] = savedEnv[name];
+ }
+ }
+});
+
+test("enables auth when both SMTP_USER and SMTP_PWD are set", () => {
+ process.env.SMTP_USER = "[email protected]";
+ process.env.SMTP_PWD = "password";
+
+ createTransportForProvider("smtp");
+
+ expect(createTransport).toHaveBeenCalledWith(
+ expect.objectContaining({
+ auth: { user: "[email protected]", pass: "password" },
+ }),
+ );
+});
+
+test("does not send partial auth when only SMTP_USER is set", () => {
+ process.env.SMTP_USER = "[email protected]";
+
+ createTransportForProvider("smtp");
+
+ expect(createTransport).toHaveBeenCalledWith(
+ expect.objectContaining({ auth: undefined }),
+ );
+});
+
+test("does not send partial auth when only SMTP_PWD is set", () => {
+ process.env.SMTP_PWD = "password";
+
+ createTransportForProvider("smtp");
+
+ expect(createTransport).toHaveBeenCalledWith(
+ expect.objectContaining({ auth: undefined }),
+ );
+});
+
+test("leaves auth undefined when neither is set", () => {
+ createTransportForProvider("smtp");
+
+ expect(createTransport).toHaveBeenCalledWith(
+ expect.objectContaining({ auth: undefined }),
+ );
+});
diff --git a/packages/emails/src/transport.ts b/packages/emails/src/transport.ts
index 5b7afe0f9..a34df23bf 100644
--- a/packages/emails/src/transport.ts
+++ b/packages/emails/src/transport.ts
@@ -27,7 +27,7 @@ export type SupportedEmailProviders = EmailProvider;
let cachedTransport: Transporter | undefined;
-function createTransportForProvider(provider: EmailProvider): Transporter {
+export function createTransportForProvider(provider: EmailProvider) {
switch (provider) {
case "ses": {
const ses = new aws.SES({
@@ -41,7 +41,12 @@ function createTransportForProvider(provider: EmailProvider): Transporter {
});
}
case "smtp": {
- const hasAuth = process.env.SMTP_USER || process.env.SMTP_PWD;
+ // Nodemailer refuses partial credentials at send time ("Missing
+ // credentials for PLAIN"), so a half-built auth object must never be
+ // passed. Env validation in apps/web rejects the one-without-the-other
+ // state at startup.
+ const hasAuth = Boolean(process.env.SMTP_USER && process.env.SMTP_PWD);
+
const port = process.env.SMTP_PORT
? Number.parseInt(process.env.SMTP_PORT, 10)
: undefined;