satosa pulls statistics

Quick reference

• Maintained by: the Identity Python project • Where to get help: the Identity Python mailing list or the Identity Python Slack workspace (invitation)

Supported tags and respective Dockerfile links

(See "What's the difference between 'Shared' and 'Simple' tags?" in the FAQ.)

Simple Tags

• 8.6.0-trixie, 8.6-trixie, 8-trixie, trixie • 8.6.0-alpine3.24, 8.6-alpine3.24, 8-alpine3.24, alpine3.24, 8.6.0-alpine, 8.6-alpine, 8-alpine, alpine

Shared Tags

• 8.6.0, 8.6, 8, latest: • 8.6.0-trixie

Quick reference (cont.)

• Where to file issues: https://github.com/IdentityPython/satosa-docker/issues • Supported architectures: (more info) amd64, arm64v8 • Published image artifact details: repo-info repo's repos/satosa/ directory (history) (image metadata, transfer size, etc) • Image updates: official-images repo's library/satosa label official-images repo's library/satosa file (history) • Source of this description: docs repo's satosa/ directory (history)

What is SATOSA?

SATOSA is a configurable proxy for translating between different authentication protocols such as SAML2, OpenID Connect, and OAuth2.

Using This Image

The basic pattern for starting a satosa instance is:

To access the instance from the host without the container's IP, use port mappings:

The entrypoint script outputs SAML2 metadata to the container log at start time. This metadata refers to the instance's base URL, e.g., https://example.com. Browsers must be able to access the instance over HTTPS.

Configuration files

The satosa image stores its configuration in /etc/satosa. This configuration must persist among instances, particularly the SAML2 entity ID (derived from the proxy's base URL by default) and related keying material. Use volumes, bind mounts, or custom images to maintain this configuration.

Entrypoint script

The satosa image's entrypoint script runs Gunicorn by default if the first argument looks like a command-line flag. For example, the following will use a bind mount to provide an X.509 certificate and corresponding private key to the instance, and it will run Gunicorn with HTTPS enabled:

If the first argument looks like a command instead of a flag, the entrypoint script will run that instead of Gunicorn. For example, the following will start an interactive, unprivileged shell inside the container:

Environment variables

The entrypoint script uses environment variables to generate the initial configuration, which requires customization. All of the environment variables are OPTIONAL.

Environment variables' values can be read from Docker secrets. Append _FILE to the variable name (e.g., STATE_ENCRYPTION_KEY_FILE), and set it to the pathname of the corresponding secret (e.g., /run/secrets/state_encryption_key).

BASE_URL

SATOSA MUST be hosted at the root of the website. This environment variable specifies the website's base URL, which defaults to http://example.com. If set, the base URL *must* be a method plus a hostname without any trailing slash or path components, e.g., https://idproxy.example.com, not https://idproxy.example.com/ nor https://idproxy.example.com/satosa.

STATE_ENCRYPTION_KEY

SATOSA uses encrypted cookies to track the progress of an authentication flow. This environment variable optionally sets the state cookies' encryption key. If set, the state encryption key *must* be an alphanumeric value, e.g., 12345SameAsMyLuggage. If not specified, a new random 32-character key will be generated.

SAML2_BACKEND_DISCO_SRV

When part of a SAML trust federation, SATOSA will ask the user to choose an identity provider using a SAML discovery service. This environment variable sets the discovery service URL, which defaults to SeamlessAccess.

SAML2_BACKEND_CERT and SAML2_BACKEND_KEY

SATOSA's default SAML back-end microservice acts like a service provider (relying party), requesting authentication by and attributes from the user-selected identity provider. The microservice uses public key cryptography to sign authentication requests and decrypt responses. These environment variables provide the requisite keying material in the PEM format. If not specified, a new 2048-bit RSA key-pair will be generated using the hostname part of BASE_URL.

SAML2_FRONTEND_CERT and SAML2_FRONTEND_KEY

SATOSA's default SAML front-end microservice acts like an identity provider (credential service provider), processing authentication requests from and returning user attributes to trusted websites. It uses public key cryptography to sign authentication responses. These environment variables provide the requisite keying material, also in the PEM format. If not specified, a new 2048-bit RSA key-pair will be generated using the hostname part of BASE_URL.

Image Variants

The satosa images come in many flavors, each designed for a specific use case.

satosa:

This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of.

Some of these tags may have names like trixie in them. These are the suite code names for releases of Debian and indicate which release the image is based on. If your image needs to install any additional packages beyond what comes with the image, you'll likely want to specify one of these explicitly to minimize breakage when there are new releases of Debian.

satosa:-alpine

This image is based on the popular Alpine Linux project, available in the alpine official image. Alpine Linux is much smaller than most distribution base images (~5MB), and thus leads to much slimmer images in general.…

Description from the Docker Hub listing.