RADIUS Module Development

Setting up a dev environment has some extra complexity due to the mono-repo design.

  1. Install poetry: python -m pip install poetry. This is what we use to manage the packages, and allows you to set up virtual python environments easier.
  2. Build the base environment. From within the kanidm_rlm_python directory, run: poetry install
  3. Install the kanidm python library: poetry run python -m pip install ../pykanidm
  4. Start editing!

Most IDEs will be happier if you open the kanidm_rlm_python or pykanidm directories as the base you are working from, rather than the kanidm repository root, so they can auto-load integrations etc.

Running a test RADIUS container

From the root directory of the Kanidm repository:

  1. Build the container - this'll give you a container image called kanidm/radius with the tag devel:
make build/radiusd
  1. Once the process has completed, check the container exists in your docker environment:
➜ docker image ls kanidm/radius
REPOSITORY      TAG       IMAGE ID       CREATED              SIZE
kanidm/radius   devel     5dabe894134c   About a minute ago   622MB

Note: If you're just looking to play with a pre-built container, images are also automatically built based on the development branch and available at ghcr.io/kanidm/radius:devel

  1. Generate some self-signed certificates by running the script - just hit enter on all the prompts if you don't want to customise them. This'll put the files in /tmp/kanidm:
  1. Run the container:
cd kanidm_rlm_python && ./run_radius_container.sh

You can pass the following environment variables to run_radius_container.sh to set other options:

  • IMAGE: an alternative image such as ghcr.io/kanidm/radius:devel
  • CONFIG_FILE: mount your own config file

For example:

IMAGE=ghcr.io/kanidm/radius:devel \
    CONFIG_FILE=~/.config/kanidm \

Testing authentication

Authentication can be tested through the client.localhost Network Access Server (NAS) configuration with:

docker exec -i -t radiusd radtest \
    <username> badpassword \ 10 testing123

docker exec -i -t radiusd radtest \
    <username> <radius show_secret value here> \ 10 testing123