Merge pull request #38 from luizfonseca/fix/allow-additional-scopes-to-be-passed

fix: allow additional github scopes to be requested

Author: luizfonseca

README.md

@@ -63,6 +63,7 @@ providing a more secure way for users to access protected routes.
 |------------------------------|-------------------------------------------------------------------------------|---------|----------|
 | `GITHUB_OAUTH_CLIENT_ID`     | The GitHub OAuth App client id                                                |         | Yes      |
 | `GITHUB_OAUTH_CLIENT_SECRET` | The GitHub OAuth App client secret                                            |         | Yes      |
+| `GITHUB_OAUTH_SCOPES`        | Additional scopes to be added to the Oauth workflow.                          |         | No       |
 | `API_BASE_URL`               | The base URL of the Traefik GitHub OAuth server                               |         | Yes      |
 | `API_SECRET_KEY`             | The api secret key. You can ignore this if you are using the internal network |         | No       |
 | `SERVER_ADDRESS`             | The server address                                                            | `:80`   | No       |
@@ -89,6 +90,7 @@ whitelist:
   # The list of GitHub user ids that are whitelisted to access the resources
   ids:
     - 996
+
   # The list of GitHub user logins that are whitelisted to access the resources
   logins:
     - luizfonseca
@@ -105,7 +107,8 @@ You can follow the steps in the [GitHub documentation](https://docs.github.com/e
 
 #### OAuth Scopes
 - For `ids` and `logins` you don't need extra scopes.
-- For `teams` you will need to request the `read:org`, `user` or `repo` scopes from the user. See the [documentation](https://docs.github.com/en/rest/teams/teams?apiVersion=2022-11-28#list-teams-for-the-authenticated-user).
+- For `teams` you might need to request the `read:org` scope from the user. See the [documentation](https://docs.github.com/en/rest/teams/teams?apiVersion=2022-11-28#list-teams-for-the-authenticated-user).
+    - You can do so by updating the `GITHUB_OAUTH_SCOPES` environment variable with the desired additional scopes, e.g. `GITHUB_OAUTH_SCOPES="read:org"` via the **Server Configuration**.
 
 
 ## License

internal/app/traefik-github-oauth-server/app.go

@@ -63,6 +63,7 @@ func NewApp(
 			ClientID:     config.GitHubOAuthClientID,
 			ClientSecret: config.GitHubOAuthClientSecret,
 			Endpoint:     oauth2github.Endpoint,
+			Scopes:       config.GithubOauthScopes,
 		},
 		AuthRequestManager: authRequestManager,
 		Logger:             logger,

internal/app/traefik-github-oauth-server/config.go

@@ -2,6 +2,7 @@ package traefik_github_oauth_server
 
 import (
 	"os"
+	"strings"
 
 	"github.com/spf13/cast"
 )
@@ -15,6 +16,7 @@ type Config struct {
 	GitHubOAuthClientID     string
 	GitHubOAuthClientSecret string
 	Addr                    string
+	GithubOauthScopes       []string
 }
 
 func envWithDefault(key string, defaultValue string) string {
@@ -25,6 +27,15 @@ func envWithDefault(key string, defaultValue string) string {
 	return value
 }
 
+func githubOauthScopeConfigs() []string {
+	scopesFromEnv := os.Getenv("GITHUB_OAUTH_SCOPES")
+	if scopesFromEnv != "" {
+		return strings.Split(scopesFromEnv, ",")
+	}
+
+	return []string{}
+}
+
 func NewConfigFromEnv() *Config {
 	return &Config{
 		ApiBaseURL:              os.Getenv("API_BASE_URL"),
@@ -34,5 +45,6 @@ func NewConfigFromEnv() *Config {
 		LogLevel:                envWithDefault("LOG_LEVEL", "INFO"),
 		GitHubOAuthClientID:     os.Getenv("GITHUB_OAUTH_CLIENT_ID"),
 		GitHubOAuthClientSecret: os.Getenv("GITHUB_OAUTH_CLIENT_SECRET"),
+		GithubOauthScopes:       githubOauthScopeConfigs(),
 	}
 }