README.md

Overview

The Forest Operations Map application supports the ability for licensees to authenticate / login to the application. Authentication is handled using OIDC. The application in its current site requires that someone in government be able to manage access.

Adding new users / roles to the application through the keycloak UI would be inefficient as it would require looking up:

• forest client number
• determining if it exists as a role in keycloak
• create if roles does not exist
• add user to the role

This repository contains the code for a simple command line based tool. That will make it easy to add new users to the FOM application.

Setup

Run setup script

Download the install script from here

# download the file:
curl https://raw.githubusercontent.com/bcgov/nr-fom-usermanager/main/util/mgr_shell.sh -o mgr_shell.sh

# edit line 5 adding the keycloak secret

# make the file executable
chmod +x mgr_shell.sh

# install deps
util/mgr_shell.sh

# run fomuser
fomuser

Return and re-run

# set up the virtualenv
util/mgr_shell.sh

# run fomuser
fomuser

Older Instructions - hopefully replaced by above

define the following env vars

Either copy this file as .env: [https://raw.githubusercontent.com/bcgov/nr-fom-usermanager/main/env-sample]

or populate these env vars

KC_HOST=https://<host>
KC_CLIENTID=<The kc client set up to administer fom users>
KC_SECRET=<client secret>
KC_REALM=<realm>
KC_FOM_CLIENTID=<the kc client that fom app uses to authenticate against>

Install

python3 -m venv venvfom
source ./venvfom/bin/activate
pip install FOMUserUtil

Re-use Venv after install

source ./venvfom/bin/activate
fomuser

Using the CLI tool

Search forest clients

Before a new user can be added we need to know what forest client id to attach them to. This is accomplished with a forest client search.

fomuser -qfc <search string>

Example:

kirk@NCC1701:$ fomuser -qfc kli
forest clients matching: kli
--------------------------------------------------------------------------------
KLINGON CONTRACTING LTD.                           -    18514
KLINGON SAND & GRAVEL LTD.                         -    31775
KLINGON & BORG CONSULTING                          -    53996
KLI FOREST PRODUCTS INC.                           -    68697
KLI ENG. & LAND SURVEYING INC                      -    97448
KLI INVESTMENTS LTD.                               -   103766
KLIMA RESOURCES LTD.                               -   110974
KLISTERS PELLET INC                                -   126239
KLIK & CLOCK CONSULTING LTD.                       -   126967

Search Keycloak users

Having determined what the forest client id is, use the following command to search for the users in keycloak:

fomuser -qu <search string>

Example:

kirk@NCC1701:$ fomuser -qu sp
matching users for search: kj
--------------------------------------------------------------------------------
spock@enterprisedir                    - spock.mock@gov.bc.ca
speed.warp@Prometheusdir               - speedwarp@gmail.com
sp.warf@bce-klingon-id                 - warf@birdofprey.ca

Adding the user -

Having determined the user id, and the forest client the new user can now be added:

fomuser --add <userid> <forest client id>

Projected syntax:

fom-user <forest client id> <user email>

Building the package manually

pip install -r requirements-build.txt
python -m build --sdist

Related links / Information

bcgov/ocp-sso#118

Keycloak Config

Assuming a fom client config already exists, the following instructions outline what needs to be done to add fom admin service account / client to keycloak. At the moment this is accomplished using the GUI.

• Create client

  • protocol = openid-connect
  • root url = blank

• Configure Client - (screen that comes up after client is created)

  • fill in and
  • Access Type: confidential
  • Service Accounts Enabled: On
  • valid redirect uris: localhost

• Configure roles:

  • type 'realm-management' in Client Roles and select
  • Assign the following roles:
    • manage-clients
    • manage-users
    • query-clients
    • view-clients
    • view-users