diff options
author | Vivien Kraus <vivien@planete-kraus.eu> | 2021-10-13 17:08:30 +0200 |
---|---|---|
committer | Vivien Kraus <vivien@planete-kraus.eu> | 2021-10-19 11:33:00 +0200 |
commit | c2f4994c20072c11d407d506e7416e2c609d0ca3 (patch) | |
tree | 86d20c1f2cf608c60c23d808c0a22346a81a84a7 /doc/disfluid.texi | |
parent | a219bf64933d3313aebe0e5576b291e32e93d93f (diff) |
server: add a reverse proxy endpoint
Diffstat (limited to 'doc/disfluid.texi')
-rw-r--r-- | doc/disfluid.texi | 26 |
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 |