Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

DM-42384: Minor improvements to OpenID Connect documentation #969

Merged
merged 1 commit into from
Feb 22, 2024
Merged

DM-42384: Minor improvements to OpenID Connect documentation #969

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 1 addition & 12 deletions docs/user-guide/openid-connect.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,18 +86,7 @@ Assuming that Gafaelfawr and Chronograf are deployed on the host ``example.com``
* ``TOKEN_SECRET``: ``pCY29u3qMTdWCNetOUD3OShsqwPm+pYKDNt6dqy01qw=``

``GENERIC_CLIENT_ID`` and ``GENERIC_CLIENT_SECRET`` should match a client ID and secret configured in the ``oidc-server-secrets`` Vault key.
The ``return_uri`` value for this entry in the ``oidc-server-secrets`` Vault key should be set to the ``PUBLIC_URL`` value above with ``/oauth/OIDC?callback`` appended.

Be aware that this uses the ``sub`` token claim, which corresponds to the user's username, for authentication, rather than the default of the user's email address.
Gafaelfawr does not always have an email address for a user.

Open Distro for Elasticsearch
-----------------------------

Assuming that Gafaelfawr and Open Distro for Elasticsearch are deployed on the host ``example.com``, here are the settings required to configure `Open Distro for Elasticsearch <https://opendistro.github.io/for-elasticsearch-docs/docs/security/configuration/openid-connect/>`__:

* ``opendistro_security.auth.type``: ``openid``
* ``opendistro_security.openid.connect_url``: ``https://example.com/.well-known/openid-configuration``
* ``opendistro_security.openid.client_id``: ``kibana-client-id``
* ``opendistro_security.openid.client_secret``: ``fb7518beb61d27aaf20675d62778dea9``
* ``opendistro_security.openid.scope``: ``openid``
* ``opendistro_security.openid.logout_url``: ``https://example.com/logout``