Account management

Account management flows often need mailbox verification too. A common example is changing the email address on an existing account: create a challenge for the new mailbox, verify the code, then update the account.

Tip

Keep authenticated account-management challenges separate from unauthenticated signup/login challenges. That usually means a separate cookie key or server-side session record.

Start the email-change challenge

Default (safe)

import { Passlock, isChallengeRateLimitedError } from "@passlock/server";

// get these from your development tenancy settings
const tenancyId = "myTenancyId";
const apiKey = "myApiKey";
const passlock = new Passlock({ tenancyId, apiKey });

const user = await requireSignedInUser();
const newEmail = "new-address@example.com";

const result = await passlock.createMailboxChallenge({
  email: newEmail,
  purpose: "email-change",
  userId: String(user.id),
  invalidateOthers: true,
});

if (result.success) {
  // message contains rendered HTML and plain-text email content.
  // result.value.challenge.code is also available if you prefer to render your own email.
  const { challengeId, secret, message, email } = result.value.challenge;

  // save this in the user's session or a secure HTTP only cookie
  await savePendingEmailChange({
    challengeId,
    secret,
    userId: user.id,
    email,
  });

  await sendCodeEmail({ email, message });
} else if (isChallengeRateLimitedError(result.error)) {
  return showRateLimit(result.error.retryAfterSeconds);
} else {
  throw new Error(result.error.message);
}

Unsafe

import { Passlock } from "@passlock/server/unsafe";

// get these from your development tenancy settings
const tenancyId = "myTenancyId";
const apiKey = "myApiKey";
const passlock = new Passlock({ tenancyId, apiKey });

const user = await requireSignedInUser();
const newEmail = "new-address@example.com";

const result = await passlock.createMailboxChallenge({
  email: newEmail,
  purpose: "email-change",
  userId: String(user.id),
  invalidateOthers: true,
});

// message contains rendered HTML and plain-text email content.
// result.challenge.code is also available if you prefer to render your own email.
const { challengeId, secret, message, email } = result.challenge;

// save this in the user's session or a secure HTTP only cookie
await savePendingEmailChange({
  challengeId,
  secret,
  userId: user.id,
  email,
});

await sendCodeEmail({ email, message });

Functions (safe)

import {
  createMailboxChallenge,
  isChallengeRateLimitedError,
} from "@passlock/server";

const user = await requireSignedInUser();
const newEmail = "new-address@example.com";

const result = await createMailboxChallenge({
  email: newEmail,
  purpose: "email-change",
  userId: String(user.id),
  invalidateOthers: true,
}, { tenancyId: "myTenancyId", apiKey: "myApiKey" });

if (result.success) {
  // message contains rendered HTML and plain-text email content.
  // result.value.challenge.code is also available if you prefer to render your own email.
  const { challengeId, secret, message, email } = result.value.challenge;

  // save this in the user's session or a secure HTTP only cookie
  await savePendingEmailChange({
    challengeId,
    secret,
    userId: user.id,
    email,
  });

  await sendCodeEmail({ email, message });
} else if (isChallengeRateLimitedError(result.error)) {
  return showRateLimit(result.error.retryAfterSeconds);
} else {
  throw new Error(result.error.message);
}

Functions (unsafe)

import { createMailboxChallenge } from "@passlock/server/unsafe";

const user = await requireSignedInUser();
const newEmail = "new-address@example.com";

const result = await createMailboxChallenge({
  email: newEmail,
  purpose: "email-change",
  userId: String(user.id),
  invalidateOthers: true,
}, { tenancyId: "myTenancyId", apiKey: "myApiKey" });

// message contains rendered HTML and plain-text email content.
// result.challenge.code is also available if you prefer to render your own email.
const { challengeId, secret, message, email } = result.challenge;

// save this in the user's session or a secure HTTP only cookie
await savePendingEmailChange({
  challengeId,
  secret,
  userId: user.id,
  email,
});

await sendCodeEmail({ email, message });

Choose your code style

Verify the new mailbox and update the account

Default (safe)

import { Passlock } from "@passlock/server";

const passlock = new Passlock({ tenancyId: "myTenancyId", apiKey: "myApiKey" });

const user = await requireSignedInUser();

// fetch from the user's session or secure cookie
const pending = await loadPendingEmailChange(user.id);

const result = await passlock.verifyMailboxChallenge({
  challengeId: pending.challengeId,
  secret: pending.secret,
  code: form.code,
});

if (result.success) {
  const { challenge } = result.value;

  if (challenge.purpose !== "email-change") {
    throw new Error("Unexpected challenge purpose");
  }

  if (challenge.userId !== String(user.id)) {
    throw new Error("Unexpected user");
  }

  await updateUserEmail(user.id, challenge.email);
  await clearPendingEmailChange(user.id);
  await sendEmailChangeNotice(user.email);
} else {
  return showVerificationError(result.error);
}

Unsafe

import { Passlock } from "@passlock/server/unsafe";

const passlock = new Passlock({ tenancyId: "myTenancyId", apiKey: "myApiKey" });

const user = await requireSignedInUser();

// fetch from the user's session or secure cookie
const pending = await loadPendingEmailChange(user.id);

const verified = await passlock.verifyMailboxChallenge({
  challengeId: pending.challengeId,
  secret: pending.secret,
  code: form.code,
});

if (verified.challenge.purpose !== "email-change") {
  throw new Error("Unexpected challenge purpose");
}

if (verified.challenge.userId !== String(user.id)) {
  throw new Error("Unexpected user");
}

await updateUserEmail(user.id, verified.challenge.email);
await clearPendingEmailChange(user.id);
await sendEmailChangeNotice(user.email);

Functions (safe)

import { verifyMailboxChallenge } from "@passlock/server";

const user = await requireSignedInUser();

// fetch from the user's session or secure cookie
const pending = await loadPendingEmailChange(user.id);

const result = await verifyMailboxChallenge({
  challengeId: pending.challengeId,
  secret: pending.secret,
  code: form.code,
}, { tenancyId: "myTenancyId", apiKey: "myApiKey" });

if (result.success) {
  const { challenge } = result.value;

  if (challenge.purpose !== "email-change") {
    throw new Error("Unexpected challenge purpose");
  }

  if (challenge.userId !== String(user.id)) {
    throw new Error("Unexpected user");
  }

  await updateUserEmail(user.id, challenge.email);
  await clearPendingEmailChange(user.id);
  await sendEmailChangeNotice(user.email);
} else {
  return showVerificationError(result.error);
}

Functions (unsafe)

import { verifyMailboxChallenge } from "@passlock/server/unsafe";

const user = await requireSignedInUser();

// fetch from the user's session or secure cookie
const pending = await loadPendingEmailChange(user.id);

const verified = await verifyMailboxChallenge({
  challengeId: pending.challengeId,
  secret: pending.secret,
  code: form.code,
}, { tenancyId: "myTenancyId", apiKey: "myApiKey" });

if (verified.challenge.purpose !== "email-change") {
  throw new Error("Unexpected challenge purpose");
}

if (verified.challenge.userId !== String(user.id)) {
  throw new Error("Unexpected user");
}

await updateUserEmail(user.id, verified.challenge.email);
await clearPendingEmailChange(user.id);
await sendEmailChangeNotice(user.email);

Choose your code style

The same endpoints are available over raw HTTP if you are not using @passlock/server. See the REST API mailbox challenge reference.