Test SAML IdP

A simple and configurable SAML IdP for testing and development scenarios.

The IdP is built using:

• crewjam/saml
• gin-gonic/gin

Do not use this in production!

Getting Started

This project requires Go 1.21+ for development.

1. cp config.example.yml config.yml
2. Populate config.yml with your own service provider and user configuration
3. (Optional) Generate a certificate and private key
   1. make cert
   2. Update config.yml with the following lines:
      1. certificate: /etc/test-saml-idp/saml.crt
      2. key: /etc/test-saml-idp/saml.key

Usage

To run locally:

make server

This will launch the IdP on port 8080 by default. The default metadata url is: http://localhost:8080/metadata.

You can also run the Docker version of the IdP alongside an example Service Provider:

docker compose up

You can access the SP via: http://localhost:9009. If it fails to load the first time due to missing metadata, try killing it and running again.

Configuration

The IdP supports a few configuration options that can be obtained from environment variables:

Key	Description	Default
PORT	Controls which port that the IdP will bind to	8080
HOST	The DNS host that the IdP will use when constructing URLs in the metadata endpoint	http://localhost:8080

For more complex configuration, the IdP expects a config.yml file to exist either beside the executable or in /etc/test-saml-idp.

Please refer to config.example.yml for more information.

Docker Image

Each tagged release is published on GHCR.

Simply docker pull or add the image to your docker-compose.yml file.

To run the container, you will need to volume mount your customized config.yml file into /app/config.yml or /etc/test-saml-idp/config.yml.

If you have a specific architecture in mind that isn't currently supported, please open an Issue. PRs are welcomed too 🙃