feat: Add webhook API definitions

Author: franky47

packages/api/src/index.ts

@@ -6,6 +6,7 @@ export * from './participants'
 export * from './permissions'
 export * from './schemas/encodings'
 export * from './schemas/identity'
+export * from './server/webhook'
 export * from './sharedKey'
 export * from './signup'
 export * from './utils/time'

packages/api/src/server/webhook.ts

@@ -0,0 +1,43 @@
+import { z } from 'zod'
+import { publicKeyAuthHeaders } from '../headers'
+import { postKeychainItemRequestBody } from '../keychain'
+import { identitySchema } from '../schemas/identity'
+import { postSharedKeyBody } from '../sharedKey'
+
+export const webhookHeaders = publicKeyAuthHeaders.extend({
+  'x-e2esdk-server-pubkey': identitySchema.shape.signaturePublicKey,
+  'x-e2esdk-request-id': z.string(),
+  origin: z.string().url(),
+})
+
+export type WebhookHeaders = z.infer<typeof webhookHeaders>
+
+// --
+
+export const webhookRoutes = {
+  // Authorizations
+  '/authorize/signup': {
+    body: identitySchema.pick({ userId: true }),
+  },
+  '/authorize/key-share': {
+    body: postSharedKeyBody,
+  },
+  // Notifications
+  '/notify/signup': {
+    body: identitySchema,
+  },
+  '/notify/key-added': {
+    body: postKeychainItemRequestBody.omit({
+      name: true,
+      payload: true,
+      subkeyIndex: true,
+      signature: true,
+    }),
+  },
+} as const
+
+export type WebhookRoutes = {
+  [Path in keyof typeof webhookRoutes]: {
+    body: z.infer<typeof webhookRoutes[Path]['body']>
+  }
+}

packages/server/src/plugins/webhook.ts

@@ -2,6 +2,7 @@ import {
   Identity,
   PostKeychainItemRequestBody,
   PostSharedKeyBody,
+  WebhookRoutes,
 } from '@socialgouv/e2esdk-api'
 import { signAuth } from '@socialgouv/e2esdk-crypto'
 import type { FastifyPluginAsync, FastifyRequest } from 'fastify'
@@ -36,11 +37,13 @@ declare module 'fastify' {
 
 // --
 
-type WebhookAPICallArgs = {
+type WebhookPaths = keyof WebhookRoutes
+
+type WebhookAPICallArgs<Path extends WebhookPaths> = {
   name: keyof Decoration
   req: FastifyRequest
-  path: string
-  body?: any
+  path: Path
+  body: WebhookRoutes[Path]['body']
 }
 
 // --
@@ -63,12 +66,12 @@ const webhookPlugin: FastifyPluginAsync = async (app: App) => {
   }
   app.log.info({ msg: 'Setting up webhook', url: baseURL })
 
-  async function webhookApiCall({
+  async function webhookApiCall<Path extends WebhookPaths>({
     req,
     path,
     name,
     body: payload,
-  }: WebhookAPICallArgs) {
+  }: WebhookAPICallArgs<Path>) {
     try {
       const method = 'POST'
       const url = baseURL + path
@@ -110,7 +113,7 @@ const webhookPlugin: FastifyPluginAsync = async (app: App) => {
         referrer,
         body,
         headers: {
-          ...(body ? { 'content-type': 'application/json' } : {}),
+          'content-type': 'application/json',
           origin: env.DEPLOYMENT_URL,
           'user-agent': `${app.pkg.name}@${app.pkg.version} Webhook`,
           'x-e2esdk-user-id': userId,