feat: external auth defaults for gitea

Add some sane defaults for gitea to make it easier to configure
coder · Emyrk · Feb 26, 2024 · Feb 26, 2024 · Feb 26, 2024 · Feb 26, 2024
commit 83f72546989d71633a4be3008548910ece76798e
diff --git a/coderd/externalauth/externalauth.go b/coderd/externalauth/externalauth.go
@@ -566,6 +566,9 @@ func applyDefaultsToConfig(config *codersdk.ExternalAuthConfig) {
 	case codersdk.EnhancedExternalAuthProviderJFrog:
 		copyDefaultSettings(config, jfrogArtifactoryDefaults(config))
 		return
+	case codersdk.EnhancedExternalAuthProviderGitea:
+		copyDefaultSettings(config, giteaDefaults(config))
+		return
 	default:
 		// No defaults for this type. We still want to run this apply with
 		// an empty set of defaults.
@@ -696,6 +699,37 @@ func jfrogArtifactoryDefaults(config *codersdk.ExternalAuthConfig) codersdk.Exte
 	return defaults
 }
 
+func giteaDefaults(config *codersdk.ExternalAuthConfig) codersdk.ExternalAuthConfig {
+	defaults := codersdk.ExternalAuthConfig{
+		DisplayName: "Gitea",
+		Scopes:      []string{"read:repository", " write:repository", "read:user"},
+		DisplayIcon: "/icon/gitea.svg",
+	}
+	// Gitea's servers will have some base url, e.g: https://gitea.coder.com.
+	// If an auth url is not set, we will assume they are using the default
+	// public Gitea.
+	if config.AuthURL == "" {
+		config.AuthURL = "https://gitea.com/login/oauth/authorize"
+	}
+
+	auth, err := url.Parse(config.AuthURL)
+	if err != nil {
+		// We need a valid URL to continue with.
+		return defaults
+	}
+
+	// Default regex should be anything using the same host as the auth url.
+	defaults.Regex = fmt.Sprintf(`^(https?://)?%s(/.*)?$`, strings.ReplaceAll(auth.Host, ".", `\.`))
+
+	tokenURL := auth.ResolveReference(&url.URL{Path: "/login/oauth/access_token"})
+	defaults.TokenURL = tokenURL.String()
+
+	validate := auth.ResolveReference(&url.URL{Path: "/login/oauth/userinfo"})
+	defaults.ValidateURL = validate.String()
+
+	return defaults
+}
+
 var staticDefaults = map[codersdk.EnhancedExternalAuthProvider]codersdk.ExternalAuthConfig{
 	codersdk.EnhancedExternalAuthProviderAzureDevops: {
 		AuthURL:     "https://app.vssps.visualstudio.com/oauth2/authorize",

diff --git a/codersdk/externalauth.go b/codersdk/externalauth.go
@@ -24,7 +24,8 @@ func (e EnhancedExternalAuthProvider) Git() bool {
 		EnhancedExternalAuthProviderGitLab,
 		EnhancedExternalAuthProviderBitBucketCloud,
 		EnhancedExternalAuthProviderBitBucketServer,
-		EnhancedExternalAuthProviderAzureDevops:
+		EnhancedExternalAuthProviderAzureDevops,
+		EnhancedExternalAuthProviderGitea:
 		return true
 	default:
 		return false
@@ -41,6 +42,7 @@ const (
 	EnhancedExternalAuthProviderBitBucketServer EnhancedExternalAuthProvider = "bitbucket-server"
 	EnhancedExternalAuthProviderSlack           EnhancedExternalAuthProvider = "slack"
 	EnhancedExternalAuthProviderJFrog           EnhancedExternalAuthProvider = "jfrog"
+	EnhancedExternalAuthProviderGitea           EnhancedExternalAuthProvider = "gitea"
 )
 
 type ExternalAuth struct {

diff --git a/docs/admin/external-auth.md b/docs/admin/external-auth.md
@@ -124,6 +124,17 @@ CODER_EXTERNAL_AUTH_0_TOKEN_URL="https://gitlab.company.org/oauth/token"
 CODER_EXTERNAL_AUTH_0_REGEX=gitlab\.company\.org
 ```
 
+### Gitea
+
+```env
+CODER_EXTERNAL_AUTH_0_ID="gitea"
+CODER_EXTERNAL_AUTH_0_TYPE=gitea
+CODER_EXTERNAL_AUTH_0_CLIENT_ID=xxxxxxx
+CODER_EXTERNAL_AUTH_0_CLIENT_SECRET=xxxxxxx
+# If self managed, set the Auth URL to your Gitea instance
+CODER_EXTERNAL_AUTH_0_AUTH_URL="https://gitea.com/login/oauth/authorize"
+```
+
 ### Self-managed git providers
 
 Custom authentication and token URLs should be used for self-managed Git

diff --git a/site/src/api/typesGenerated.ts b/site/src/api/typesGenerated.ts
diff --git a/site/static/icon/gitea.svg b/site/static/icon/gitea.svg