|
|
||
|---|---|---|
| .github/workflows | ||
| develop | ||
| src | ||
| .dockerignore | ||
| .editorconfig | ||
| .gitattributes | ||
| .gitignore | ||
| dev.local.plantuml | ||
| docker-compose.debug.yml | ||
| docker-compose.secrets.yml.template | ||
| docker-compose.yml | ||
| LICENSE | ||
| README.md | ||
Steam OpenId Connect Provider
Steam OpenID 2.0 -> OpenID Connect Provider Proxy
About
This server allows you to use Steam as an OpenID Connect Identity provider (OIDC IDP). This way you can use Steam logins in KeyCloak or any other OpenID Connect based authentication client.
Setup
Add your Steam API Key as user-secrets like this:
dotnet user-secrets set "Steam:ApplicationKey" "MySteamApiKey"
Alternatively you can set it up via environment variables:
Steam__ApplicationKey=MySteamApiKey
(Keep in mind that this is easier but more insecure)
After that set up your redirect URI, ClientID and ClientSecret in the appsettings.json.
If you need to set up multiple redirect URIs, you can set them separated by a comma.
OpenID__RedirectUri="http://localhost:8080/auth/realms/master/broker/steam/endpoint, http://localhost:8080/auth/realms/dev/broker/steam/endpoint"
OpenID Configuration
You can access Authorization and Token endpoint details in
http://<Your Host>/.well-known/openid-configuration
Supported Scopes
The following scopes are supported: openid, profile.
If you use the profile scope, you get access to the picture, given_name, website and nickname claims too.
HTTPS Support
The server itself does not support https connections. If you want to use https connections please use a reverse proxy like nginx. The example docker-compose.yml contains an example setup.
Running behind reverse proxies
Some reverse proxy setups might require additional configuration, like setting the path base or origin.
To set the origin, set Hosting:PublicOrigin in the appsettings.json or the Hosting__PublicOrigin environment variable to your desired origin. If not set, the origin name is inferred from the request.
Similary, you can use the Hosting:PathBase in the appsettings.json or the Hosting__PathBase environment variable to set the path base. If not set, it will default to "/".
Health checks
This service contains a health check endpoint at /health. It checks if the Steam login servers are working.
Docker
A docker image is also available.
docker run -it \
-e OpenID__RedirectUri=http://localhost:8080/auth/realms/master/broker/steam/endpoint \
-e OpenID__ClientID=steamidp \
-e OpenID__ClientSecret=mysecret \
-e OpenID__ClientName=myclientname \
-e Steam__ApplicationKey=MySteamApiKey \
--restart unless-stopped \
--name steamidp \
ghcr.io/byo-software/steam-openid-connect-provider