From 866ce05cc75e05eac210117215ee6a9bfc067115 Mon Sep 17 00:00:00 2001
From: Johan Haals <johan.haals@gmail.com>
Date: Fri, 22 Nov 2024 11:09:16 +0100
Subject: [PATCH] add docs

Signed-off-by: Johan Haals <johan.haals@gmail.com>
---
 .../backend-system/core-services/http-auth.md | 39 +++++++++++++++++++
 1 file changed, 39 insertions(+)

diff --git a/docs/backend-system/core-services/http-auth.md b/docs/backend-system/core-services/http-auth.md
index 13938c921d..3936670b77 100644
--- a/docs/backend-system/core-services/http-auth.md
+++ b/docs/backend-system/core-services/http-auth.md
@@ -102,6 +102,45 @@ or [contribute](https://github.com/backstage/backstage/blob/master/CONTRIBUTING.
 
 :::
 
+### Custom token extraction logic
+
+In some cases, you might want to customize how tokens are extracted from incoming requests. It might be that you want to extract tokens from a different location in the request. To support this you supply your own slightly modified httpAuth service. The `DefaultHttpAuthService` class is exported from the `@backstage/backend-defaults` package and it's `create` method can be used to pass in a custom `getTokenFromRequest` extraction function.
+
+```ts
+import { DefaultHttpAuthService } from '@backstage/backend-defaults/httpAuth';
+import {
+  coreServices,
+  createServiceFactory,
+} from '@backstage/backend-plugin-api';
+
+export const customizedAuthServiceFactory = createServiceFactory({
+  service: coreServices.httpAuth,
+  deps: {
+    auth: coreServices.auth,
+    discovery: coreServices.discovery,
+    plugin: coreServices.pluginMetadata,
+  },
+  async factory({ auth, discovery, plugin }) {
+    return DefaultHttpAuthService.create({
+      auth,
+      discovery,
+      pluginId: plugin.getId(),
+      getTokenFromRequest: req => {
+        let token: string | undefined;
+        const header = req.headers.some_random_header;
+        if (typeof header === 'string') {
+          const parts = header.split(' ');
+          if (parts.length === 2 && parts[0] === 'Bearer') {
+            token = parts[1];
+          }
+        }
+        return { token };
+      },
+    });
+  },
+});
+```
+
 This service has no configuration options, but it abides by the policies you
 have set up using [the `httpRouter` service](./http-router.md) for your routes,
 if any.