The minimalistic document archiving platform.
feat(auth): add IP address header configuration and logging support (#530)
Corentin Thomassetd09b9ed70d1c
diff --git a/apps/papra-server/src/modules/app/auth/auth.config.ts b/apps/papra-server/src/modules/app/auth/auth.config.tsindex a07e079f..f3b87074 100644--- a/apps/papra-server/src/modules/app/auth/auth.config.ts+++ b/apps/papra-server/src/modules/app/auth/auth.config.ts@@ -55,6 +55,17 @@ export const authConfig = {default: false,env: 'AUTH_SHOW_LEGAL_LINKS',},+ ipAddressHeaders: {+ doc: `The header, or comma separated list of headers, to use to get the real IP address of the user, use for rate limiting. Make sur to use a non-spoofable header, one set by your proxy.+- If behind a standard proxy, you might want to set this to "x-forwarded-for".+- If behind Cloudflare, you might want to set this to "cf-connecting-ip".`,+ schema: z.union([+ z.string(),+ z.array(z.string()),+ ]).transform(value => (typeof value === 'string' ? value.split(',').map(v => v.trim()) : value)),+ default: ['x-forwarded-for'],+ env: 'AUTH_IP_ADDRESS_HEADERS',+ },providers: {email: {isEnabled: {diff --git a/apps/papra-server/src/modules/app/auth/auth.services.ts b/apps/papra-server/src/modules/app/auth/auth.services.tsindex 1d12a90c..f944cf74 100644--- a/apps/papra-server/src/modules/app/auth/auth.services.ts+++ b/apps/papra-server/src/modules/app/auth/auth.services.ts@@ -85,6 +85,9 @@ export function getAuth({advanced: {// Drizzle tables handle the id generationdatabase: { generateId: false },+ ipAddress: {+ ipAddressHeaders: config.auth.ipAddressHeaders,+ },},socialProviders: {github: {diff --git a/apps/papra-server/src/modules/app/server.ts b/apps/papra-server/src/modules/app/server.tsindex 31048f31..edb3cfdc 100644--- a/apps/papra-server/src/modules/app/server.ts+++ b/apps/papra-server/src/modules/app/server.ts@@ -46,7 +46,7 @@ export async function createServer(initialDeps: Partial<GlobalDependencies> = {}const app = new Hono<ServerInstanceGenerics>({ strict: true });- app.use(createLoggerMiddleware());+ app.use(createLoggerMiddleware({ config }));app.use(createCorsMiddleware({ config }));app.use(createTimeoutMiddleware({ config }));app.use(secureHeaders());diff --git a/apps/papra-server/src/modules/shared/headers/headers.models.ts b/apps/papra-server/src/modules/shared/headers/headers.models.tsindex a819357f..9dfe592f 100644--- a/apps/papra-server/src/modules/shared/headers/headers.models.ts+++ b/apps/papra-server/src/modules/shared/headers/headers.models.ts@@ -26,3 +26,15 @@ export function getContentLengthHeader({ headers }: { headers: Record<string, streturn Number(contentLengthHeaderValue);}++export function getIpFromHeaders({ context, headerNames }: { context: Context; headerNames: string[] }): string | undefined {+ for (const headerName of headerNames) {+ const headerValue = getHeader({ context, name: headerName });++ if (!isNil(headerValue)) {+ return headerValue;+ }+ }++ return undefined;+}diff --git a/apps/papra-server/src/modules/shared/logger/logger.middleware.ts b/apps/papra-server/src/modules/shared/logger/logger.middleware.tsindex f9a0e09f..1e59f4ab 100644--- a/apps/papra-server/src/modules/shared/logger/logger.middleware.ts+++ b/apps/papra-server/src/modules/shared/logger/logger.middleware.ts@@ -1,18 +1,21 @@import type { Context } from '../../app/server.types';+import type { Config } from '../../config/config.types';import { createMiddleware } from 'hono/factory';-import { getHeader } from '../headers/headers.models';+import { routePath } from 'hono/route';+import { getHeader, getIpFromHeaders } from '../headers/headers.models';import { generateId } from '../random/ids';import { createLogger, wrapWithLoggerContext } from './logger';const logger = createLogger({ namespace: 'app' });-export function createLoggerMiddleware() {+export function createLoggerMiddleware({ config }: { config: Config }) {return createMiddleware(async (context: Context, next) => {- const requestId = getHeader({ context, name: 'x-request-id' });+ const requestId = getHeader({ context, name: 'x-request-id' }) ?? generateId({ prefix: 'req' });+ const ip = getIpFromHeaders({ context, headerNames: config.auth.ipAddressHeaders });await wrapWithLoggerContext({- requestId: requestId ?? generateId({ prefix: 'req' }),+ requestId,},async () => {const requestedAt = new Date();@@ -26,9 +29,10 @@ export function createLoggerMiddleware() {status: context.res.status,method: context.req.method,path: context.req.path,- routePath: context.req.routePath,+ routePath: routePath(context),userAgent: getHeader({ context, name: 'User-Agent' }),durationMs,+ ip,},'Request completed',);