From 937237ea1d5819d8762368895b8fb8eeb4f138b7 Mon Sep 17 00:00:00 2001 From: James Elliott Date: Sun, 31 Jul 2022 13:09:05 +1000 Subject: [PATCH] docs: add oidc guacamole integration (#3772) --- .../openid-connect/apache-guacamole/index.md | 88 +++++++++++++++++++ 1 file changed, 88 insertions(+) create mode 100644 docs/content/en/integration/openid-connect/apache-guacamole/index.md diff --git a/docs/content/en/integration/openid-connect/apache-guacamole/index.md b/docs/content/en/integration/openid-connect/apache-guacamole/index.md new file mode 100644 index 000000000..e4419d52e --- /dev/null +++ b/docs/content/en/integration/openid-connect/apache-guacamole/index.md @@ -0,0 +1,88 @@ +--- +title: "Apache Guacamole" +description: "Integrating Apache Guacamole with the Authelia OpenID Connect Provider." +lead: "" +date: 2022-07-13T03:42:47+10:00 +draft: false +images: [] +menu: +integration: +parent: "openid-connect" +weight: 620 +toc: true +community: true +--- + +## Tested Versions + +* [Authelia] + * [v4.36.3](https://github.com/authelia/authelia/releases/tag/v4.36.2) +* [Apache Guacamole] + * __UNKNOWN__ + +## Before You Begin + +You are required to utilize a unique client id and a unique and random client secret for all [OpenID Connect] relying +parties. You should not use the client secret in this example, you should randomly generate one yourself. You may also +choose to utilize a different client id, it's completely up to you. + +This example makes the following assumptions: + +* __Application Root URL:__ `https://guacamole.example.com` +* __Authelia Root URL:__ `https://auth.example.com` +* __Client ID:__ `guacamole` +* __Client Secret:__ `guacamole_client_secret` + +## Configuration + +### Application + +To configure [Apache Guacamole] to utilize Authelia as an [OpenID Connect] Provider use the following configuration: + +```yaml +openid-client-id: guacamole +openid-scope: openid profile groups email +openid-issuer: https://auth.example.com +openid-jwks-endpoint: https://auth.example.com/jwks.json +openid-authorization-endpoint: https://auth.example.com/api/oidc/authorization?state=1234abcedfdhf +openid-redirect-uri: https://guacamole.example.com +openid-username-claim-type: preferred_username +openid-groups-claim-type: groups +``` + +### Authelia + +The following YAML configuration is an example __Authelia__ +[client configuration](../../../configuration/identity-providers/open-id-connect.md#clients) for use with +[Apache Guacamole] which will operate with the above example: + +```yaml +- id: guacamole + secret: guacamole_client_secret + public: false + authorization_policy: two_factor + scopes: + - openid + - profile + - groups + - email + redirect_uris: + - https://guacamole.example.com + response_types: + - id_token + grant_types: + - implicit + userinfo_signing_algorithm: none +``` + +## See Also + +* [Apache Guacamole OpenID Connect Authentication Documentation](https://guacamole.apache.org/doc/gug/openid-auth.html) + +[Authelia]: https://www.authelia.com +[Apache Guacamole]: https://guacamole.apache.org/ +[OpenID Connect]: ../../openid-connect/introduction.md + + + +