@fonderie/courier 5.2.2 → 7.0.0

package/brain/signatures.md

@@ -16,7 +16,7 @@ new CourierModule(config: ICourierConfig, store?: IStoreAdapter | undefined, bus
 
 function validateCourierConfig(config: ICourierConfig, registeredChannels: Iterable<string>): void
 
-function handleSendGridDelivery(req: Request, store: IStoreAdapter, webhookSecret?: string | undefined): Promise<Response>
+function handleSendGridDelivery(req: Request, store: IStoreAdapter, publicKey?: string | undefined): Promise<Response>
 
 function handleMailgunDelivery(req: Request, store: IStoreAdapter, signingKey?: string | undefined): Promise<Response>
 
@@ -37,7 +37,7 @@ new PushChannel(config: IPushChannelConfig): PushChannel
 
 new EmailChannel(config: IEmailChannelConfig): EmailChannel
   .name: "email"
-  .send(message: ICourierMessage, template: IRenderedTemplate): Promise<void>
+  .send(message: ICourierMessage, template: IRenderedTemplate): Promise<void | ISendResult>
 
 new DBTemplateResolver(store: IStoreAdapter, defaults?: DefaultTemplates | undefined): DBTemplateResolver
   .resolve(type: string, data: Record<string, unknown>, locale?: string | undefined): Promise<IRenderedTemplate>
@@ -122,7 +122,7 @@ interface ICourierMessage {
 
 interface ICourierChannel {
     name: string;
-    send(message: ICourierMessage, template: IRenderedTemplate): Promise<void>;
+    send(message: ICourierMessage, template: IRenderedTemplate): Promise<ISendResult | void>;
 }
 
 interface IRenderedTemplate {
@@ -161,6 +161,7 @@ interface ICourierConfig {
             sendgrid?: string;
             mailgun?: string;
         };
+        allowUnverifiedMailtrap?: boolean;
     };
 }
 

package/dist/index.cjs

@@ -75,6 +75,14 @@ async function insertMessageLog(entry, store) {
   );
   return row?.id ?? "";
 }
+async function setMessageProviderId(id, providerMessageId, store) {
+  await store.query(
+    `UPDATE fonderie_message_log
+		 SET provider_message_id = $2
+		 WHERE id = $1`,
+    [id, providerMessageId]
+  );
+}
 async function markMessageSent(id, store) {
   await store.query(
     `UPDATE fonderie_message_log
@@ -172,8 +180,13 @@ var Dispatcher = class {
         if (message.locale) logEntry.locale = message.locale;
         const logId = this.store ? await insertMessageLog(logEntry, this.store).catch(() => "") : "";
         try {
-          await channel.send(message, template);
+          const result = await channel.send(message, template);
           if (this.store && logId) {
+            if (result?.providerMessageId) {
+              await setMessageProviderId(logId, result.providerMessageId, this.store).catch(
+                () => void 0
+              );
+            }
             markMessageSent(logId, this.store).catch(() => void 0);
           }
         } catch (err) {
@@ -320,12 +333,12 @@ var EmailChannel = class {
       return;
     }
     if (this.config.provider === "resend") {
-      await this.sendViaResend(to, template);
-    } else if (this.config.provider === "smtp") {
-      await this.sendViaSMTP(to, template);
-    } else {
-      console.warn(`[courier:email] provider ${this.config.provider} not implemented`);
+      return this.sendViaResend(to, template);
+    }
+    if (this.config.provider === "smtp") {
+      return this.sendViaSMTP(to, template);
     }
+    console.warn(`[courier:email] provider ${this.config.provider} not implemented`);
   }
   async sendViaResend(to, template) {
     if (!this.config.apiKey) {
@@ -349,18 +362,23 @@ var EmailChannel = class {
       const body2 = await res.text();
       throw new Error(`[courier:email] Resend error ${res.status}: ${body2}`);
     }
+    const data = await res.json().catch(() => null);
+    return typeof data?.id === "string" ? { providerMessageId: data.id } : {};
   }
   async sendViaSMTP(to, template) {
     if (!this.transport) {
       throw new Error("SMTP transport not initialised \u2014 check smtp config");
     }
-    await this.transport.sendMail({
+    const info = await this.transport.sendMail({
       from: this.config.from,
       to,
       subject: template.subject ?? "(no subject)",
       text: template.text,
       ...template.html !== void 0 ? { html: template.html } : {}
     });
+    const raw = typeof info?.messageId === "string" ? info.messageId : "";
+    const providerMessageId = raw.replace(/^<|>$/g, "");
+    return providerMessageId ? { providerMessageId } : {};
   }
 };
 
@@ -495,15 +513,20 @@ function wrapLayout(bodyHtml, layoutHtml = DEFAULT_EMAIL_LAYOUT) {
 
 // src/templates/resolver.ts
 var LAYOUT_TYPE = "_layout";
-function render(template, data) {
+function escapeHtml(value) {
+  return value.replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;").replace(/"/g, "&quot;").replace(/'/g, "&#39;");
+}
+function render(template, data, opts = {}) {
   return template.replace(/\{\{(\w+)\}\}/g, (_, key) => {
     const value = data[key];
-    return value !== void 0 && value !== null ? String(value) : "";
+    if (value === void 0 || value === null) return "";
+    const s = String(value);
+    return opts.escapeHtml ? escapeHtml(s) : s;
   });
 }
 function composeHtml(bodyHtml, layoutHtml, subject, data) {
   const wrapped = wrapLayout(bodyHtml, layoutHtml);
-  return render(wrapped, { subject: subject ?? "", preheader: "", ...data });
+  return render(wrapped, { subject: subject ?? "", preheader: "", ...data }, { escapeHtml: true });
 }
 function renderFragment(frag, layoutHtml, data) {
   const subject = frag.subject ? render(frag.subject, data) : void 0;
@@ -647,29 +670,43 @@ function validateCourierConfig(config, registeredChannels) {
 // src/delivery.ts
 var import_node_crypto = require("crypto");
 var import_core = require("@fonderie/core");
-async function handleSendGridDelivery(req, store, webhookSecret) {
-  if (webhookSecret) {
-    const sig = req.headers.get("x-twilio-email-event-webhook-signature") ?? "";
-    const ts = req.headers.get("x-twilio-email-event-webhook-timestamp") ?? "";
-    const body2 = await req.text();
-    if (!verifySendGridSignature(webhookSecret, ts, body2, sig)) {
-      return Response.json({ error: "INVALID_SIGNATURE" }, { status: 401 });
-    }
-    const events2 = parseJson(body2);
-    if (!Array.isArray(events2)) return Response.json({ ok: true });
-    await processSendGridEvents(events2, store);
-    return Response.json({ ok: true });
+var TIMESTAMP_TOLERANCE_S = 5 * 60;
+function isFreshTimestamp(unixSeconds) {
+  const ts = Number(unixSeconds);
+  if (!Number.isFinite(ts)) return false;
+  return Math.abs(Date.now() / 1e3 - ts) <= TIMESTAMP_TOLERANCE_S;
+}
+async function handleSendGridDelivery(req, store, publicKey) {
+  if (!publicKey) {
+    return Response.json({ error: "VERIFICATION_NOT_CONFIGURED" }, { status: 401 });
   }
-  const events = await req.json();
+  const sig = req.headers.get("x-twilio-email-event-webhook-signature") ?? "";
+  const ts = req.headers.get("x-twilio-email-event-webhook-timestamp") ?? "";
+  const body2 = await req.text();
+  if (!isFreshTimestamp(ts)) {
+    return Response.json({ error: "STALE_TIMESTAMP" }, { status: 401 });
+  }
+  if (!verifySendGridSignature(publicKey, ts, body2, sig)) {
+    return Response.json({ error: "INVALID_SIGNATURE" }, { status: 401 });
+  }
+  const events = parseJson(body2);
   if (!Array.isArray(events)) return Response.json({ ok: true });
   await processSendGridEvents(events, store);
   return Response.json({ ok: true });
 }
-function verifySendGridSignature(secret, timestamp, body2, signature) {
+function verifySendGridSignature(publicKeyB64, timestamp, body2, signature) {
   try {
-    const payload = timestamp + body2;
-    const expected = (0, import_node_crypto.createHmac)("sha256", secret).update(payload).digest("base64");
-    return (0, import_core.constantTimeEqual)(Buffer.from(signature, "base64"), Buffer.from(expected, "base64"));
+    const key = (0, import_node_crypto.createPublicKey)({
+      key: Buffer.from(publicKeyB64, "base64"),
+      format: "der",
+      type: "spki"
+    });
+    return (0, import_node_crypto.verify)(
+      "sha256",
+      Buffer.from(timestamp + body2),
+      key,
+      Buffer.from(signature, "base64")
+    );
   } catch {
     return false;
   }
@@ -698,12 +735,16 @@ async function processSendGridEvents(events, store) {
   }
 }
 async function handleMailgunDelivery(req, store, signingKey) {
+  if (!signingKey) {
+    return Response.json({ error: "VERIFICATION_NOT_CONFIGURED" }, { status: 401 });
+  }
   const body2 = await req.json();
-  if (signingKey) {
-    const { signature } = body2;
-    if (!signature || !verifyMailgunSignature(signingKey, signature.timestamp, signature.token, signature.signature)) {
-      return Response.json({ error: "INVALID_SIGNATURE" }, { status: 401 });
-    }
+  const { signature } = body2;
+  if (!signature || !isFreshTimestamp(signature.timestamp)) {
+    return Response.json({ error: "STALE_TIMESTAMP" }, { status: 401 });
+  }
+  if (!verifyMailgunSignature(signingKey, signature.timestamp, signature.token, signature.signature)) {
+    return Response.json({ error: "INVALID_SIGNATURE" }, { status: 401 });
   }
   const event = body2["event-data"];
   if (event) {
@@ -948,22 +989,29 @@ var CourierModule = class {
   install(app) {
     validateCourierConfig(this.config, this.dispatcher.channelNames());
     const store = this.store;
-    const signingKeys = this.config.delivery?.signingKeys;
-    app.addRoute(
-      "POST",
-      "/courier/delivery/sendgrid",
-      (ctx) => handleSendGridDelivery(ctx.request, store, signingKeys?.sendgrid)
-    );
-    app.addRoute(
-      "POST",
-      "/courier/delivery/mailgun",
-      (ctx) => handleMailgunDelivery(ctx.request, store, signingKeys?.mailgun)
-    );
-    app.addRoute(
-      "POST",
-      "/courier/delivery/mailtrap",
-      (ctx) => handleMailtrapDelivery(ctx.request, store)
-    );
+    const delivery = this.config.delivery;
+    const signingKeys = delivery?.signingKeys;
+    if (signingKeys?.sendgrid) {
+      app.addRoute(
+        "POST",
+        "/courier/delivery/sendgrid",
+        (ctx) => handleSendGridDelivery(ctx.request, store, signingKeys.sendgrid)
+      );
+    }
+    if (signingKeys?.mailgun) {
+      app.addRoute(
+        "POST",
+        "/courier/delivery/mailgun",
+        (ctx) => handleMailgunDelivery(ctx.request, store, signingKeys.mailgun)
+      );
+    }
+    if (delivery?.allowUnverifiedMailtrap) {
+      app.addRoute(
+        "POST",
+        "/courier/delivery/mailtrap",
+        (ctx) => handleMailtrapDelivery(ctx.request, store)
+      );
+    }
     if (this.config.adminToken) {
       if (!store) {
         throw new Error("[courier] adminToken requires @fonderie/store (db templates)");