~jan0sch/smederee

Showing details for patch d6bc5c36b2e0db0aae9753d4ab807297a3b66797.
2023-05-25 (Thu), 6:34 PM - Jens Grassel - d6bc5c36b2e0db0aae9753d4ab807297a3b66797

Cleanup: Adjust documentation for changed CSRF origin check

Summary of changes
1 files modified with 5 lines added and 4 lines removed
  • modules/hub/src/main/scala/de/smederee/hub/HubServer.scala with 5 added and 4 removed lines
diff -rN -u old-smederee/modules/hub/src/main/scala/de/smederee/hub/HubServer.scala new-smederee/modules/hub/src/main/scala/de/smederee/hub/HubServer.scala
--- old-smederee/modules/hub/src/main/scala/de/smederee/hub/HubServer.scala	2025-01-16 07:40:26.836053193 +0000
+++ new-smederee/modules/hub/src/main/scala/de/smederee/hub/HubServer.scala	2025-01-16 07:40:26.836053193 +0000
@@ -56,10 +56,11 @@
 
   /** Create a function to perform the origin checks for the CSRF protection middleware using the configuration.
     *
-    * @param linkConfig
-    *   Settings affecting how the service will communicate several information to the "outside world" e.g. if it runs
-    *   behind a reverse proxy. These settings are needed to set the correct values for expected hostname, port and
-    *   transport scheme of the cookies.
+    * @param allowedOrigins
+    *   A list of configuration settings describing the external url configuration for a service. These settings are
+    *   affecting how a service will communicate several information to the "outside world" e.g. if it runs behind a
+    *   reverse proxy. These settings are needed to validate the correct values for expected hostname, port and
+    *   transport scheme of the checked requests.
     * @return
     *   A function which will check the correct origin of requests / cookies inside the CSRF middleware.
     */