Skip to content

Evenfire is an intelligence layer platform for running LLM agents that take real actions, on your infrastructure

TypeScript

feat: add dedicated password recovery endpoint

Josuébfef0dd2ce09
diff --git a/control-api/package-lock.json b/control-api/package-lock.json
index 16bef5e03..7d9c7b26a 100644
--- a/control-api/package-lock.json
+++ b/control-api/package-lock.json
@@ -1,12 +1,12 @@
{
"name": "clerum-control-api",
- "version": "0.1.775",
+ "version": "0.1.776",
"lockfileVersion": 3,
"requires": true,
"packages": {
"": {
"name": "clerum-control-api",
- "version": "0.1.775",
+ "version": "0.1.776",
"dependencies": {
"@clerum/display-field": "file:../packages/display-field",
"@clerum/grok-provider-attempt-contract": "file:../packages/grok-provider-attempt-contract",
diff --git a/control-api/package.json b/control-api/package.json
index da5ab2454..321c9798b 100644
--- a/control-api/package.json
+++ b/control-api/package.json
@@ -1,6 +1,6 @@
{
"name": "clerum-control-api",
- "version": "0.1.775",
+ "version": "0.1.776",
"description": "Internal Clerum control plane REST API + UI for managing CRDs and secrets",
"main": "dist/main.js",
"engines": {
diff --git a/control-api/test/passwordRecovery.http.contract.test.ts b/control-api/test/passwordRecovery.http.contract.test.ts
index b7e5de22c..b6368eaf9 100644
--- a/control-api/test/passwordRecovery.http.contract.test.ts
+++ b/control-api/test/passwordRecovery.http.contract.test.ts
@@ -781,7 +781,7 @@ describe('invitation/password producer response mappings', () => {
})
const response = await request(await publicApp())
- .post('/api/v1/invitations/password')
+ .post('/api/v1/invitations/password-reset')
.set('x-forwarded-for', '198.51.100.42')
.send({
token: 'r6-synthetic-reset-proof',
@@ -820,6 +820,9 @@ describe('invitation/password producer response mappings', () => {
'R6-synthetic-valid-password'
)
expect(directory.setInvitationPasswordForEmail).toHaveBeenCalledOnce()
+ expect(directory.getInvitationByToken).toHaveBeenCalledWith('r6-producer-invitation-token')
+ expect(directory.getInvitationByToken).toHaveBeenCalledOnce()
+ expect(directory.acceptInvitationForEmail).not.toHaveBeenCalled()
})
it('keeps a dropped post-dispatch reset acknowledgement unknown and never retries it', async () => {
@@ -850,7 +853,7 @@ describe('invitation/password producer response mappings', () => {
const response = await (async () => {
try {
return await request(await publicApp())
- .post('/api/v1/invitations/password')
+ .post('/api/v1/invitations/password-reset')
.set('x-forwarded-for', '198.51.100.43')
.send({
token: 'r6-synthetic-reset-proof',
@@ -869,6 +872,8 @@ describe('invitation/password producer response mappings', () => {
expect(response.headers['set-cookie']).toBeUndefined()
expect(JSON.stringify(response.body)).not.toMatch(/r6-|sql|stack|invalid_password/i)
expect(directory.setInvitationPasswordForEmail).toHaveBeenCalledOnce()
+ expect(directory.getInvitationByToken).toHaveBeenCalledWith('r6-producer-invitation-token')
+ expect(directory.getInvitationByToken).toHaveBeenCalledOnce()
expect(droppedResetResponsesForTest()).toBe(1)
})
diff --git a/external-rest-api/package-lock.json b/external-rest-api/package-lock.json
index 480bf4a3e..478d2b001 100644
--- a/external-rest-api/package-lock.json
+++ b/external-rest-api/package-lock.json
@@ -1,12 +1,12 @@
{
"name": "clerum-external-rest-api",
- "version": "0.1.123",
+ "version": "0.1.124",
"lockfileVersion": 3,
"requires": true,
"packages": {
"": {
"name": "clerum-external-rest-api",
- "version": "0.1.123",
+ "version": "0.1.124",
"dependencies": {
"@clerum/jwt-key-policy": "file:../packages/jwt-key-policy",
"cors": "^2.8.5",
diff --git a/external-rest-api/package.json b/external-rest-api/package.json
index 33efd8774..ff10368e3 100644
--- a/external-rest-api/package.json
+++ b/external-rest-api/package.json
@@ -1,6 +1,6 @@
{
"name": "clerum-external-rest-api",
- "version": "0.1.123",
+ "version": "0.1.124",
"description": "External REST API for profile, team management, and RPC token brokerage",
"main": "dist/main.js",
"engines": {
diff --git a/external-rest-api/src/releaseManifest.ts b/external-rest-api/src/releaseManifest.ts
index 41bede684..a04a1e5de 100644
--- a/external-rest-api/src/releaseManifest.ts
+++ b/external-rest-api/src/releaseManifest.ts
@@ -8,7 +8,7 @@ export type ReleaseManifest = {
export const releaseManifest: ReleaseManifest = {
releaseId: 'v0.11.0',
- externalRestApiVersion: '0.1.123',
+ externalRestApiVersion: '0.1.124',
rpcProxyVersion: '0.1.126',
desktopVersion: '0.11.0',
minimumDesktopVersion: '0.1.252',
diff --git a/external-rest-api/src/routes/invitations.ts b/external-rest-api/src/routes/invitations.ts
index f150ed80e..c9531fa88 100644
--- a/external-rest-api/src/routes/invitations.ts
+++ b/external-rest-api/src/routes/invitations.ts
@@ -4,13 +4,15 @@ import { ControlApiError } from '../controlApiClient.js'
import { sendPasswordAuthorityError } from '../http/passwordAdmissionError.js'
import { type AuthedRequest, extractAuthToken, requireAuth } from '../middleware/auth.js'
import { createRateLimiter } from '../middleware/rateLimit.js'
+import {
+ setupInvitationPassword,
+ setupInvitationPasswordWithToken,
+} from '../services/invitationPasswordService.js'
import {
acceptInvitation,
createDesktopAuthorization,
getInvitationByToken,
listPendingInvitations,
- setupInvitationPassword,
- setupInvitationPasswordWithToken,
} from '../services/invitationsService.js'
import { setProfileSessionCookie } from '../sessionCookie.js'
@@ -145,6 +147,29 @@ function isInvalidInvitationProof(error: unknown): boolean {
)
}
+async function completePasswordReset(
+ req: Request,
+ res: Response,
+ token: string,
+ email: string,
+ invitationId: string,
+ password: string
+): Promise<void> {
+ const result = await setupInvitationPasswordWithToken(token, email, invitationId, password)
+ if (result.error) {
+ sendInvitationPasswordError(res, result.error)
+ return
+ }
+ const sessionToken = result.data?.token
+ if (!result.data || !sessionToken) {
+ res.status(502).json({ error: 'Failed to restore account session' })
+ return
+ }
+ const { token: _sessionToken, ...body } = result.data
+ setProfileSessionCookie(req, res, sessionToken)
+ res.status(200).json(body)
+}
+
export function createInvitationsRouter(): Router {
const router = Router()
@@ -201,24 +226,7 @@ export function createInvitationsRouter(): Router {
throw error
}
if (preview?.purpose === 'password_reset') {
- const result = await setupInvitationPasswordWithToken(
- token,
- email,
- invitationId,
- password
- )
- if (result.error) {
- sendInvitationPasswordError(res, result.error)
- return
- }
- const sessionToken = result.data?.token
- if (!result.data || !sessionToken) {
- res.status(502).json({ error: 'Failed to restore account session' })
- return
- }
- const { token: _sessionToken, ...body } = result.data
- setProfileSessionCookie(req, res, sessionToken)
- res.status(200).json(body)
+ await completePasswordReset(req, res, token, email, invitationId, password)
return
}
}
@@ -242,6 +250,29 @@ export function createInvitationsRouter(): Router {
}
})
+ router.post('/invitations/password-reset', acceptRateLimit, async (req: Request, res, next) => {
+ try {
+ const invitationId = String(req.body?.invitationId || '').trim()
+ if (!invitationId) {
+ res.status(400).json({ error: 'invitationId is required' })
+ return
+ }
+ const token = String(req.body?.token || '').trim()
+ const email = String(req.body?.email || '')
+ .trim()
+ .toLowerCase()
+ if (!token || !email) {
+ res.status(401).json({ error: 'Unauthorized' })
+ return
+ }
+ const password = String(req.body?.password || '')
+ await completePasswordReset(req, res, token, email, invitationId, password)
+ } catch (error) {
+ if (sendPasswordAuthorityError(error, res)) return
+ next(error)
+ }
+ })
+
router.post(
'/invitations/desktop-authorization',
requireAuth,
diff --git a/external-rest-api/src/services/invitationPasswordService.ts b/external-rest-api/src/services/invitationPasswordService.ts
new file mode 100644
index 000000000..7cd017aa3
--- /dev/null
+++ b/external-rest-api/src/services/invitationPasswordService.ts
@@ -0,0 +1,164 @@
+import { ControlApiError, controlApiRequest } from '../controlApiClient.js'
+import type { InvitationPreview } from './invitationsService.js'
+
+type AuthContext = {
+ userId: string
+ email: string
+ sessionToken: string
+}
+
+type ResetPasswordDomainError =
+ | 'not_found'
+ | 'forbidden'
+ | 'not_pending'
+ | 'expired'
+ | 'invalid_invitation'
+ | 'invalid_password'
+
+function invitationPasswordDomainError(
+ error: ControlApiError
+):
+ | 'not_found'
+ | 'forbidden'
+ | 'not_accepted'
+ | 'not_pending'
+ | 'expired'
+ | 'invalid_password'
+ | null {
+ const code = controlApiErrorCode(error)
+ if (error.status === 400 && code === 'invalid_password') return 'invalid_password'
+ if (error.status === 401 && code === 'user_retired') return 'not_found'
+ if (error.status === 403 && code === 'forbidden') return 'forbidden'
+ if (error.status === 404 && code === 'not_found') return 'not_found'
+ if (error.status === 409 && code === 'invitation_not_accepted') return 'not_accepted'
+ if (error.status === 409 && code === 'invitation_not_pending') return 'not_pending'
+ if (error.status === 410 && code === 'expired') return 'expired'
+ return null
+}
+
+function controlApiErrorCode(error: ControlApiError): string | null {
+ if (
+ error.body !== null &&
+ typeof error.body === 'object' &&
+ 'error' in error.body &&
+ typeof error.body.error === 'string'
+ ) {
+ return error.body.error
+ }
+ return null
+}
+
+function resetPasswordDomainError(
+ error: ControlApiError,
+ password: string
+): ResetPasswordDomainError | null {
+ const code = controlApiErrorCode(error)
+ if (error.status === 400 && code === 'invalid_password') return 'invalid_password'
+ // Keep compatibility with the current producer until its stable code is published.
+ if (error.status === 400 && code === 'invalid payload' && password.length === 0) {
+ return 'invalid_password'
+ }
+ if (error.status === 400 && code === 'invalid_invitation') return 'invalid_invitation'
+ if (error.status === 401 && code === 'user_retired') return 'invalid_invitation'
+ if (error.status === 403 && code === 'forbidden') return 'forbidden'
+ if (error.status === 404 && code === 'not_found') return 'not_found'
+ if (
+ error.status === 409 &&
+ (code === 'invitation_not_pending' || code === 'invitation_not_ready')
+ ) {
+ return 'not_pending'
+ }
+ if (error.status === 410 && code === 'expired') return 'expired'
+ return null
+}
+
+function unknownRecoveryOutcome(): ControlApiError {
+ return new ControlApiError(
+ 'Password recovery outcome is unknown',
+ 503,
+ { error: 'recovery_outcome_unknown' },
+ { 'retry-after': '2' }
+ )
+}
+
+function passwordAuthorityUnavailable(): ControlApiError {
+ return new ControlApiError(
+ 'Password recovery authority unavailable',
+ 503,
+ { error: 'authority_unavailable' },
+ { 'retry-after': '2' }
+ )
+}
+
+export async function setupInvitationPassword(
+ auth: AuthContext,
+ invitationId: string,
+ password: string
+): Promise<{
+ error?:
+ | 'not_found'
+ | 'forbidden'
+ | 'not_accepted'
+ | 'not_pending'
+ | 'expired'
+ | 'invalid_password'
+ data?: InvitationPreview & { passwordUpdated: boolean }
+}> {
+ try {
+ const data = await controlApiRequest<InvitationPreview & { passwordUpdated: boolean }>(
+ 'POST',
+ '/external/invitations/password',
+ {
+ body: {
+ userId: auth.userId,
+ email: auth.email,
+ invitationId,
+ password,
+ },
+ userSessionToken: auth.sessionToken,
+ }
+ )
+ return { data }
+ } catch (error) {
+ if (error instanceof ControlApiError && [429, 503].includes(error.status)) throw error
+ if (error instanceof ControlApiError) {
+ const domainError = invitationPasswordDomainError(error)
+ if (domainError) return { error: domainError }
+ }
+ throw passwordAuthorityUnavailable()
+ }
+}
+
+export async function setupInvitationPasswordWithToken(
+ token: string,
+ email: string,
+ invitationId: string,
+ password: string
+): Promise<{
+ error?:
+ | 'not_found'
+ | 'forbidden'
+ | 'not_accepted'
+ | 'not_pending'
+ | 'expired'
+ | 'invalid_invitation'
+ | 'invalid_password'
+ data?: InvitationPreview & { passwordUpdated: boolean; token: string }
+}> {
+ try {
+ const data = await controlApiRequest<
+ InvitationPreview & { passwordUpdated: boolean; token: string }
+ >('POST', '/external/invitations/password-token', {
+ body: { email, token, invitationId, password },
+ })
+ return { data }
+ } catch (error) {
+ if (error instanceof ControlApiError && [429, 503].includes(error.status)) throw error
+ if (error instanceof ControlApiError) {
+ const domainError = resetPasswordDomainError(error, password)
+ if (domainError) return { error: domainError }
+ if (error.status < 500) throw passwordAuthorityUnavailable()
+ }
+ throw unknownRecoveryOutcome()
+ }
+}
diff --git a/external-rest-api/src/services/invitationsService.ts b/external-rest-api/src/services/invitationsService.ts
index 4dcbf09b4..287542832 100644
--- a/external-rest-api/src/services/invitationsService.ts
+++ b/external-rest-api/src/services/invitationsService.ts
@@ -6,35 +6,6 @@ type AuthContext = {
sessionToken: string
}
-type ResetPasswordDomainError =
- | 'not_found'
- | 'forbidden'
- | 'not_pending'
- | 'expired'
- | 'invalid_invitation'
- | 'invalid_password'
-
-function invitationPasswordDomainError(
- error: ControlApiError
-):
- | 'not_found'
- | 'forbidden'
- | 'not_accepted'
- | 'not_pending'
- | 'expired'
- | 'invalid_password'
- | null {
- const code = controlApiErrorCode(error)
- if (error.status === 400 && code === 'invalid_password') return 'invalid_password'
- if (error.status === 401 && code === 'user_retired') return 'not_found'
- if (error.status === 403 && code === 'forbidden') return 'forbidden'
- if (error.status === 404 && code === 'not_found') return 'not_found'
- if (error.status === 409 && code === 'invitation_not_accepted') return 'not_accepted'
- if (error.status === 409 && code === 'invitation_not_pending') return 'not_pending'
- if (error.status === 410 && code === 'expired') return 'expired'
- return null
-}
-
function controlApiErrorCode(error: ControlApiError): string | null {
if (
error.body !== null &&
@@ -47,40 +18,6 @@ function controlApiErrorCode(error: ControlApiError): string | null {
return null
}
-function resetPasswordDomainError(
- error: ControlApiError,
- password: string
-): ResetPasswordDomainError | null {
- const code = controlApiErrorCode(error)
- if (error.status === 400 && code === 'invalid_password') return 'invalid_password'
- // The public reset route has already required token, email, and invitation ID.
- // The producer's exact payload error therefore identifies an empty password.
- if (error.status === 400 && code === 'invalid payload' && password.length === 0) {
- return 'invalid_password'
- }
- if (error.status === 400 && code === 'invalid_invitation') return 'invalid_invitation'
- if (error.status === 401 && code === 'user_retired') return 'invalid_invitation'
- if (error.status === 403 && code === 'forbidden') return 'forbidden'
- if (error.status === 404 && code === 'not_found') return 'not_found'
- if (
- error.status === 409 &&
- (code === 'invitation_not_pending' || code === 'invitation_not_ready')
- ) {
- return 'not_pending'
- }
- if (error.status === 410 && code === 'expired') return 'expired'
- return null
-}
-
-function unknownRecoveryOutcome(): ControlApiError {
- return new ControlApiError(
- 'Password recovery outcome is unknown',
- 503,
- { error: 'recovery_outcome_unknown' },
- { 'retry-after': '2' }
- )
-}
-
function passwordAuthorityUnavailable(): ControlApiError {
return new ControlApiError(
'Password recovery authority unavailable',
@@ -209,76 +146,3 @@ export async function getInvitationByToken(token: string): Promise<InvitationPre
throw error
}
}
-
-export async function setupInvitationPassword(
- auth: AuthContext,
- invitationId: string,
- password: string
-): Promise<{
- error?:
- | 'not_found'
- | 'forbidden'
- | 'not_accepted'
- | 'not_pending'
- | 'expired'
- | 'invalid_password'
- data?: InvitationPreview & { passwordUpdated: boolean }
-}> {
- try {
- const data = await controlApiRequest<InvitationPreview & { passwordUpdated: boolean }>(
- 'POST',
- '/external/invitations/password',
- {
- body: {
- userId: auth.userId,
- email: auth.email,
- invitationId,
- password,
- },
- userSessionToken: auth.sessionToken,
- }
- )
- return { data }
- } catch (error) {
- if (error instanceof ControlApiError && [429, 503].includes(error.status)) throw error
- if (error instanceof ControlApiError) {
- const domainError = invitationPasswordDomainError(error)
- if (domainError) return { error: domainError }
- }
- throw passwordAuthorityUnavailable()
- }
-}
-
-export async function setupInvitationPasswordWithToken(
- token: string,
- email: string,
- invitationId: string,
- password: string
-): Promise<{
- error?:
- | 'not_found'
- | 'forbidden'
- | 'not_accepted'
- | 'not_pending'
- | 'expired'
- | 'invalid_invitation'
- | 'invalid_password'
- data?: InvitationPreview & { passwordUpdated: boolean; token: string }
-}> {
- try {
- const data = await controlApiRequest<
- InvitationPreview & { passwordUpdated: boolean; token: string }
- >('POST', '/external/invitations/password-token', {
- body: { email, token, invitationId, password },
- })
- return { data }
- } catch (error) {
- if (error instanceof ControlApiError && [429, 503].includes(error.status)) throw error
- if (error instanceof ControlApiError) {
- const domainError = resetPasswordDomainError(error, password)
- if (domainError) return { error: domainError }
- if (error.status < 500) throw passwordAuthorityUnavailable()
- }
- throw unknownRecoveryOutcome()
- }
-}
diff --git a/external-rest-api/test/invitations.passwordRecovery.public.test.ts b/external-rest-api/test/invitations.passwordRecovery.public.test.ts
index 5024db735..61c7ad4da 100644
--- a/external-rest-api/test/invitations.passwordRecovery.public.test.ts
+++ b/external-rest-api/test/invitations.passwordRecovery.public.test.ts
@@ -4,7 +4,7 @@ import { type AddressInfo } from 'node:net'
import request from 'supertest'
import { createApp } from '../src/app.js'
import { config } from '../src/config.js'
-import { setupInvitationPasswordWithToken } from '../src/services/invitationsService.js'
+import { setupInvitationPasswordWithToken } from '../src/services/invitationPasswordService.js'
const recoveryProof = 'synthetic-one-use-recovery-proof'
diff --git a/external-rest-api/test/routes.invitations.test.ts b/external-rest-api/test/routes.invitations.test.ts
index ecfdb7468..e24017da4 100644
--- a/external-rest-api/test/routes.invitations.test.ts
+++ b/external-rest-api/test/routes.invitations.test.ts
@@ -19,6 +19,10 @@ const invitationsServiceMock = vi.hoisted(() => ({
vi.mock('../src/authToken.js', () => authTokenMock)
vi.mock('../src/services/invitationsService.js', () => invitationsServiceMock)
+vi.mock('../src/services/invitationPasswordService.js', () => ({
+ setupInvitationPassword: invitationsServiceMock.setupInvitationPassword,
+ setupInvitationPasswordWithToken: invitationsServiceMock.setupInvitationPasswordWithToken,
+}))
describe('routes/invitations', () => {
beforeEach(() => {
@@ -143,6 +147,45 @@ describe('routes/invitations', () => {
)
})
+ it('uses the additive reset route without preview or invitation acceptance', async () => {
+ invitationsServiceMock.setupInvitationPasswordWithToken.mockResolvedValue({
+ data: {
+ id: 'reset-1',
+ email: '[email protected]',
+ purpose: 'password_reset',
+ status: 'accepted',
+ passwordUpdated: true,
+ token: 'Synthetic-reset-session-token',
+ },
+ })
+
+ const res = await request(makeApp())
+ .post('/invitations/password-reset')
+ .set('x-forwarded-for', '198.51.100.12')
+ .send({
+ token: 'Synthetic-reset-proof',
+ email: '[email protected]',
+ invitationId: 'reset-1',
+ password: 'Synthetic-new-password-123',
+ })
+ .expect(200)
+
+ expect(res.body).toMatchObject({ id: 'reset-1', passwordUpdated: true })
+ expect(JSON.stringify(res.body)).not.toContain('Synthetic-reset-session-token')
+ expect(String(res.headers['set-cookie'])).toContain(
+ 'profile_session=Synthetic-reset-session-token'
+ )
+ expect(invitationsServiceMock.getInvitationByToken).not.toHaveBeenCalled()
+ expect(invitationsServiceMock.acceptInvitation).not.toHaveBeenCalled()
+ expect(invitationsServiceMock.setupInvitationPassword).not.toHaveBeenCalled()
+ expect(invitationsServiceMock.setupInvitationPasswordWithToken).toHaveBeenCalledWith(
+ 'Synthetic-reset-proof',
+ 'reset-1',
+ 'Synthetic-new-password-123'
+ )
+ })
+
it('uses non-enumerating wording when a reset row does not match the verified link', async () => {
invitationsServiceMock.getInvitationByToken.mockResolvedValue({
id: 'current-reset-row',
@@ -398,7 +441,7 @@ describe('routes/invitations', () => {
}
const limited = await request(app)
- .post('/invitations/password')
+ .post('/invitations/password-reset')
.set('x-forwarded-for', '198.51.100.10')
.send({})
.expect(429)
diff --git a/profile-ui/lib/api.ts b/profile-ui/lib/api.ts
index 25a1d65d5..e47e60fe7 100644
--- a/profile-ui/lib/api.ts
+++ b/profile-ui/lib/api.ts
@@ -235,7 +235,7 @@ export async function setupInvitationPasswordWithToken(
invitationId: string,
password: string
): Promise<InvitationPreview & { passwordUpdated: boolean }> {
- const response = (await apiSend('POST', '/api/v1/invitations/password', {
+ const response = (await apiSend('POST', '/api/v1/invitations/password-reset', {
token: invitationUrlId,
email,
invitationId,
diff --git a/profile-ui/package-lock.json b/profile-ui/package-lock.json
index ce28bf04b..aa37c6a22 100644
--- a/profile-ui/package-lock.json
+++ b/profile-ui/package-lock.json
@@ -1,12 +1,12 @@
{
"name": "clerum-profile-ui",
- "version": "0.1.175",
+ "version": "0.1.176",
"lockfileVersion": 3,
"requires": true,
"packages": {
"": {
"name": "clerum-profile-ui",
- "version": "0.1.175",
+ "version": "0.1.176",
"dependencies": {
"@clerum/desktop-app-links": "file:../packages/desktop-app-links",
"@clerum/frontend-components": "file:../packages/frontend-components",
diff --git a/profile-ui/package.json b/profile-ui/package.json
index 3f3a4836a..a9b6aa8ac 100644
--- a/profile-ui/package.json
+++ b/profile-ui/package.json
@@ -1,6 +1,6 @@
{
"name": "clerum-profile-ui",
- "version": "0.1.175",
+ "version": "0.1.176",
"private": true,
"scripts": {
"dev": "next dev",