Skip to content

Latest commit

 

History

History
163 lines (102 loc) · 5.12 KB

README.md

File metadata and controls

163 lines (102 loc) · 5.12 KB
Raw

SSO for Maggot

Purpose

  • Implement Single Sign-On (SSO) authentication for the Maggot application.

  • For management within a collective that goes beyond a simple intranet, it may be necessary to set up an authentication layer. Setting up such a layer can be done independently of the Maggot tool, i.e. without modifying its code or configuration. The proposed implementation can serve as a basis for a larger configuration.

  • See the Wiki page for more details


Installation

Requirements:

  • a recent Linux OS that support Docker (see https://www.docker.com/)

  • You have to create the docker images:

      Step 1: Clone this repository, then `cd` to your clone path.

      $ git clone https://github.com/djacob65/maggot-sso.git
      $ cd sso

  Step 2: Create the docker image:

      $ sh ./run build

Then, you should have something like below:

$ docker images

REPOSITORY        TAG           IMAGE ID         CREATED          SIZE
nginx-image       latest        77b4d4887fa7     44 hours ago     398MB
keycloak-image    latest        8cfd3af34d85     5 days ago       459MB
postgres-image    latest        5f01f1db17f8     11 days ago      431MB

configuration

  • You need to edit the local.conf file, then adapt parameters, especially the following ones
# Host
HOST_NAME=10.0.0.106 # Host Name or IP

# Network
MYNET=my-net

# Application
APP_NAME=mmdt-web    # container name of Maggot web application
APP_PORT=80          # http port inside the Maggot web application container
APP_BASE_URL=/maggot # Base URL of Maggot web application

# Keycloak - Client
KC_REALM=Maggot
KC_CLIENT=maggot
KC_SECRET=GUWHrrBXnJp3dtT3Nl15olqDgyxaGGx2

# Keycloak - API Client
API_CLIENT=api-Maggot
API_SECRET=FYFBOxpWl6spQ9of62ljGhR7v6NcnBS7

# Use template
USETMPL=1

# Wait message
WAITMSG=1
  • You need to also edit the keycloak.env file, then change passwords :
KC_DB_USERNAME=keycloak
KC_DB_PASSWORD=kcpass01
KEYCLOAK_ADMIN=admin
KEYCLOAK_ADMIN_PASSWORD=adminpass

Notes

  • You must be careful that the network name ('my-net') is the same as the one defined in Maggot's run and/or local.conf files..

  • The APP_NAME parameter must be equal to the WEB_CONTAINER parameter defined in Maggot's run and/or local.conf files..

  • For Keycloak parameters, see the Wiki page

  • In case Maggot must be accessible from outside of your network (internet), you must ensure that the application web port (80) as well as the keycloak web port (8080) are open and accessible beyond the various firewalls, starting with the one that is possibly installed on the host machine.

  • If USETMPL is equal to 1 then the nginx.conf file will be automatically generated based on the corresponding template nginx-conf.template file. Otherwise it will be used as it is.

  • if WAITMSG is equal to 1 then a waiting message will be appear after starting, indicating when the keycloak will have finished its configuration (~ 15 sec)

  • You must first start the SSO layer (see below) to access the keycloak interface (here http://10.0.0.106:8080). Once the different elements are configured, the settings in the local.conf file must be modified to match those entered in Keycloak. A restart of the SSO layer will therefore be necessary to take the new settings into account.


Usage

  • Note: The Maggot application must be started first. Otherwise, an error occurs when starting the nginx container because the server "APP_NAME" (the APP_NAME must be the name of the maggot web application container) is not recognized as available.

  • To start the SSO layer

sh ./run start
  • To stop the SSO layer
sh ./run stop
  • To restart the SSO layer
sh ./run restart
  • To view the container list
sh ./run ps
  • To authorize HTTP protocol in case you've got the message :"HTTPS required" in the keycloak admin interface
sh ./run http

  • Based on the default configuration provided (see above):

    * The Maggot URL is http://10.0.0.106/maggot/

* The Keycloak interface URL is http://10.0.0.106:8080

License

Copyright (C) 2024 Daniel Jacob - INRAE

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.