Skip to content

Authentication documentation #373

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

Open
joelgaspard wants to merge 1 commit into
base: main
Choose a base branch
from
+16 −3
Open

Authentication documentation #373

Show file tree
Hide file tree
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
1 change: 1 addition & 0 deletions chutney/server/src/test/resources/local-dev/additional-config/application-sso-auth.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ spring:

chutney:
auth:
enable-sso: true
sso:
issuer: "http://localhost:3000"
clientId: 'my-client'
Expand Down
18 changes: 15 additions & 3 deletions docs/docs/installation/advanced_topics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,12 +33,24 @@ Moreover, Chutney provides following metrics and corresponding Micrometer tags :

# Authentication

Authentication can be performed in three ways :

* In-memory authentication
* LDAP authentication
* OIDC provider authentication

When using in-memory authentication or LDAP authentication, Chutney displays a form where users can enter their username and password.
When using SSO, a button is displayed to redirect users to the OIDC provider. The image displayed on the button can be configured.

The username/password form is displayed by default and can be enabled or disabled using the `chutney.auth.enable-user-password` property
The SSO link is not displayed by default and can be enabled or disabled using the `chutney.auth.enable-sso` property

!!! important
Maven module [server](https://github.com/Enedis-OSS/chutney/tree/main/chutney/server/test/resources/blackbox){:target="_blank"} shows :

* How to use in memory authentication and roles, see the `mem-auth` profile
* How to use a custom LDAP authentication (see the `ldap-auth` profile. For example purpose, it uses an embedded LDAP server)
* How to use a OIDC provider authentication (see the `sso-auth` profile. For example purpose, it uses a [local](https://github.com/Enedis-OSS/chutney/tree/main/chutney/server/test/resources/blackbox/sso){:target="_blank"} server)
* How to use a custom LDAP authentication (see the `ldap-auth` profile. For example purpose, it uses an embedded [LDAP](https://github.com/Enedis-OSS/chutney/tree/main/chutney/server/test/resources/local-dev/additional-config/application-ldap-auth.yml){:target="_blank"} server)
* How to use a OIDC provider authentication (see the `sso-auth` profile. For example purpose, it uses a [local](https://github.com/Enedis-OSS/chutney/tree/main/chutney/server/test/resources/local-dev/additional-config/application-sso-auth.yml){:target="_blank"} server)

Chutney uses Spring Security for :

Expand Down Expand Up @@ -141,7 +153,7 @@ Since Chutney includes this module, you can also configure it.
Chutney enforces `ADMIN_ACCESS` permissions on all default Actuator endpoints.


# Specifics values
# Specific values

In addition of spring application [properties](https://docs.spring.io/spring-boot/appendix/application-properties/index.html#appendix.application-properties.server){:target="_blank"}, following table shows all properties you can set to configure Chutney.

Expand Down
Loading