server: add a reverse proxy endpoint

1 files changed, 26 insertions, 0 deletions

diff --git a/doc/disfluid.texi b/doc/disfluid.texi
index 6b9ad08..17a985c 100644
--- a/doc/disfluid.texi
+++ b/doc/disfluid.texi
@@ -1546,6 +1546,7 @@ the user.
 @menu
 * Error signalling::
 * Router endpoint::
+* Reverse proxy::
 @end menu
 
 @node Error signalling
@@ -1632,6 +1633,31 @@ turn, or return a 404 Not Found response if no endpoint is relevant.
 Return the list of endpoints for @var{router}.
 @end deffn
 
+@node Reverse proxy
+@section Reverse proxy
+The @emph{(webid-oidc server endpoint reverse-proxy)} module defines a
+@dfn{reverse proxy}, an endpoint that passes the incoming request to a
+backend server with added metadata.
+
+@deftp {Class} <reverse-proxy> (<endpoint>) @var{backend-uri} @var{authentication-header}
+This endpoint will handle the incoming requests by adding a header,
+named @var{authentication-header} (a symbol), to hold the webid of the
+authentified user, and passing it to the server listening at
+@var{backend-uri} (an URI).
+
+You can construct it with @code{#:@var{backend-uri}} and
+@code{#:@var{authentication-header}}.
+@end deftp
+
+@deffn {Generic} backend-uri @var{reverse-proxy}
+Return the URI where requests are passed.
+@end deffn
+
+@deffn {Generic} authentication-header @var{reverse-proxy}
+Return the header set by the reverse proxy to hold the authenticated
+webid.
+@end deffn
+
 @node Running an Identity Provider
 @chapter Running an Identity Provider