You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@james.apache.org by bt...@apache.org on 2022/01/17 04:34:56 UTC

[james-project] 01/03: JAMES-3680 Document OIDC setup from JMAP configuration pages

This is an automated email from the ASF dual-hosted git repository.

btellier pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/james-project.git

commit 9ddcdc1eaa2e4f1ebd434b1930639e710fc6e6af
Author: Benoit Tellier <bt...@linagora.com>
AuthorDate: Thu Jan 13 11:16:39 2022 +0700

    JAMES-3680 Document OIDC setup from JMAP configuration pages
---
 .../docs/modules/ROOT/pages/configure/jmap.adoc             | 13 +++++++++++++
 src/site/xdoc/server/config-jmap.xml                        |  8 ++++++++
 2 files changed, 21 insertions(+)

diff --git a/server/apps/distributed-app/docs/modules/ROOT/pages/configure/jmap.adoc b/server/apps/distributed-app/docs/modules/ROOT/pages/configure/jmap.adoc
index bbfc9d4..c324cfd 100644
--- a/server/apps/distributed-app/docs/modules/ROOT/pages/configure/jmap.adoc
+++ b/server/apps/distributed-app/docs/modules/ROOT/pages/configure/jmap.adoc
@@ -88,8 +88,21 @@ Enabling *TRACE* on `org.apache.james.jmap.wire` enables reactor-netty wiretap,
 all incoming and outgoing requests, outgoing requests. This will log also potentially sensible information
 like authentication credentials.
 
+== OIDC set up
+
+The use of `XUserAuthenticationStrategy` allow delegating the authentication responsibility to a third party system,
+which could be used to set up authentication against an OIDC provider.
+
+We do supply an link:https://github.com[example] of such a setup. It combines the link:https://www.keycloak.org/[Keycloack]
+OIDC provider with the link:https://www.krakend.io/[Krackend] API gateway, but usage of similar technologies is definitely doable.
+
 == Generating a JWT key pair
 
+Apache James can alternatively be configured to check the validity of JWT tokens itself. No revocation mechanism is
+supported in such a setup, and the `sub` claim is used to identify the user. The key configuration is static.
+
+This requires the `JWTAuthenticationStrategy` authentication strategy to be used.
+
 The Distributed server enforces the use of RSA-SHA-256.
 
 One can use OpenSSL to generate a JWT key pair :
diff --git a/src/site/xdoc/server/config-jmap.xml b/src/site/xdoc/server/config-jmap.xml
index b43c144..03e8834 100644
--- a/src/site/xdoc/server/config-jmap.xml
+++ b/src/site/xdoc/server/config-jmap.xml
@@ -127,6 +127,14 @@
                 like authentication credentials.</p>
             </subsection>
 
+            <subsection name="OIDC set up">
+                <p>The use of <code>XUserAuthenticationStrategy</code> allow delegating the authentication responsibility to a third party system,
+                    which could be used to set up authentication against an OIDC provider.</p>
+                <p>We do supply an <a href="https://github.com">example</a> of such a setup. It combines the
+                    <a href="https://www.keycloak.org/">Keycloack</a> OIDC provider with the
+                    <a href="https://www.krakend.io/">Krackend</a> API gateway, but usage of similar technologies is definitely doable.</p>
+            </subsection>
+
             <subsection name="JMAP-draft vs JMAP-RFC-8621">
                 <p>James had been supporting an implementation based on an early specification of JMAP, what we call here
                 <em>JMAP-draft</em> version. But the protocol went under a lot of changes until its finalization as an

---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@james.apache.org
For additional commands, e-mail: notifications-help@james.apache.org