https://github.com/tchapgouv/tchap-identite

Service d'Authentication pour les produits BetaGouv
https://github.com/tchapgouv/tchap-identite

Last synced: 4 months ago
JSON representation

Service d'Authentication pour les produits BetaGouv

• Host: GitHub
• URL: https://github.com/tchapgouv/tchap-identite
• Owner: tchapgouv
• License: mit
• Created: 2022-05-11T08:37:59.000Z (over 2 years ago)
• Default Branch: develop
• Last Pushed: 2023-03-02T23:27:33.000Z (almost 2 years ago)
• Last Synced: 2024-06-04T22:59:32.224Z (6 months ago)
• Language: Java
• Homepage: https://beta.gouv.fr/startups/authentification.html
• Size: 2.86 MB
• Stars: 4
• Watchers: 9
• Forks: 1
• Open Issues: 36
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Authentification

Le projet Authentification otp publie un service d'authentification qui se base sur un envoi d'otp par email et par [Tchap](https://tchap.beta.gouv.fr/), la messagerie de l'Etat

## Monitoring

Realm uptime can be found here : https://updown.io/fta9

## Stack Technology

- maven : 3.8.2

- keycloak : 18.0

- quarkus : 2.7.5

- java : 11

## Run the local environment with docker containers

1. copy env.sample -> env, fill in passwords with (any value you want..)

- POSTGRES_PASSWORD=password

- KEYCLOAK_ADMIN_PASSWORD=password

- KC_DB_PASSWORD=password

- TCHAP_BOT_ACCOUNT_EMAIL=service account for Tchap Identity created on Tchap Server side

- TCHAP_BOT_PASSWORD=password for the service account

- TCHAP_HOME_SERVER_LIST=list of home servers that tchap-identity can connect to

- TCHAP_SKIP_CERTIFICATE_VALIDATION=false

- TCHAP_UNAUTHORIZED_HOME_SERVER_LIST=list of unauthorized home servers -- use to check if a user is valid

- TCHAP_OTP_MAIL_DELAY_IN_MINUTES= (optionnal) delay to wait to send another otp to users. default 0

- TCHAP_CODE_TIMEOUT_IN_MINUTES= (optionnal) validity of a otp code. default 60

- TCHAP_LOG_SENSITIVE_DATA = (optionnal) log sensitive data like username. default false

- TCHAP_HOME_REDIRECT_URL=url to redirect the user when it hits the welcome page (/admin by default)

1. build extension with maven goal. A jar is produced with the custom providers and the custom view.

`mvn clean package`

to specify a version run :

`mvn clean install -Drevision=X.Y.Z`

For local development, the jar is copied to /dev/providers

3. launch containers

`docker compose up`

4. Connect to

- keycloak admin http://localhost:8080 with admin/password

- in realm Tchap-identite, go to Clients>tchap-identite-client-sample>credentials> "Regenerate Secret"

- copy this secret in your open id client (see -4-)

- email client : http://localhost:1080

5. install a openId client sample

https://github.com/tchapgouv/oidc-client-example

6. After a modification in the java adapters, you need to compile the jar and restart keycloak. Indeed quarkus docker image does not support hot reload as of Keycloak 18 

```mvn clean package && docker compose restart keycloak```

## Code formatting

1. To format the code, execute the following command : `mvn spotless:apply`

2. You can view the diff with : `git diff `