mirrors/steam-openid-connect-provider
1
0
Fork 0
mirror of https://github.com/byo-software/steam-openid-connect-provider.git synced 2025-01-09 18:06:22 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update Readme

Browse source
This commit is contained in:
Silvino Escalona 2020-12-01 12:40:36 -04:00
parent 2dbefdbfb8
commit b109b12e62
1 changed files with 16 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
README.md
View file

@ -1,10 +1,13 @@
# Steam OpenId Connect Provider # Steam OpenId Connect Provider
Steam OpenID 2.0 -> OpenID Connect Provider Proxy Steam OpenID 2.0 -> OpenID Connect Provider Proxy
## About ## 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.
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 ## Setup
Add your Steam API Key as user-secrets like this: Add your Steam API Key as user-secrets like this:
`dotnet user-secrets set "Authentication:Steam:ApplicationKey" "MySteamApiKey"` `dotnet user-secrets set "Authentication:Steam:ApplicationKey" "MySteamApiKey"`
@ -14,19 +17,26 @@ Alternatively you can set it up via environment variables:
After that set up your redirect URI, ClientID and ClientSecret in the appsettings.json. 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 ## OpenID Configuration
You can access Authorization and Token endpoint details in You can access Authorization and Token endpoint details in
`http://<Your Host>/.well-known/openid-configuration` `http://<Your Host>/.well-known/openid-configuration`
## Supported Scopes ## Supported Scopes
The following scopes are supported: `openid`, `profile`. 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. If you use the `profile` scope, you get access to the `picture`, `given_name`, `website` and `nickname` claims too.
## HTTPS Support ## HTTPS Support
This server does not support https connections. If you want to use https connections please use a reverse proxy like nginx. This server does not support https connections. If you want to use https connections please use a reverse proxy like nginx.
## Running behind reverse proxies ## Running behind reverse proxies
Some reverse proxy setups might require additional configuration, like setting the path base or origin. 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. 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.
@ -34,20 +44,24 @@ To set the origin, set `Hosting:PublicOrigin` in the appsettings.json or the `Ho
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 "/". 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 ## Health checks
This service contains a health check endpoint at `/health`. It checks if the Steam login servers are working. This service contains a health check endpoint at `/health`. It checks if the Steam login servers are working.
## Docker ## Docker
[A docker image](https://hub.docker.com/r/imperialplugins/steam-openid-connect-provider) is also available. [A docker image](https://hub.docker.com/r/imperialplugins/steam-openid-connect-provider) is also available.
``` ```
docker run -it \ docker run -it \
-e OpenID__RedirectUri=http://localhost:8080/auth/realms/master/broker/steam/endpoint \ -e OpenID__RedirectUri=http://localhost:8080/auth/realms/master/broker/steam/endpoint \
-e OpenID__ClientID=steamidp \ -e OpenID__ClientID=steamidp \
-e OpenID__ClientSecret=mysecret \ -e OpenID__ClientSecret=mysecret \
-e Authentication__Steam__ApplicationKey=MySteamApiKey \ -e Authentication__Steam__ApplicationKey=MySteamApiKey \
--restart unless-stopped \ --restart unless-stopped \
--name steamidp \ --name steamidp \
imperialplugins/steam-openid-connect-provider imperialplugins/steam-openid-connect-provider
``` ```
## License ## License
[MIT](https://github.com/ImperialPlugins/steam-openid-connect-provider/blob/master/LICENSE) [MIT](https://github.com/ImperialPlugins/steam-openid-connect-provider/blob/master/LICENSE)