feat: allow external services to be authable

coder · kylecarbs · Oct 3, 2023 · Sep 30, 2023 · Oct 2, 2023 · Oct 2, 2023
commit a2ccfb08f4a4f963f0f7683b9f02da53ee60e851
diff --git a/cli/errors.go b/cli/errors.go
@@ -6,9 +6,10 @@ import (
 	"net/http/httptest"
 	"os"
 
+	"golang.org/x/xerrors"
+
 	"github.com/coder/coder/v2/cli/clibase"
 	"github.com/coder/coder/v2/codersdk"
-	"golang.org/x/xerrors"
 )
 
 func (RootCmd) errorExample() *clibase.Cmd {

diff --git a/cli/server.go b/cli/server.go
@@ -171,6 +171,10 @@ func ReadGitAuthProvidersFromEnv(environ []string) ([]codersdk.GitAuthConfig, er
 			provider.AppInstallURL = v.Value
 		case "APP_INSTALLATIONS_URL":
 			provider.AppInstallationsURL = v.Value
+		case "DISPLAY_NAME":
+			provider.DisplayName = v.Value
+		case "DISPLAY_ICON":
+			provider.DisplayIcon = v.Value
 		}
 		providers[providerNum] = provider
 	}

diff --git a/coderd/apidoc/docs.go b/coderd/apidoc/docs.go
diff --git a/coderd/apidoc/swagger.json b/coderd/apidoc/swagger.json
diff --git a/coderd/externalauth.go b/coderd/externalauth.go
@@ -33,7 +33,7 @@ func (api *API) externalAuthByID(w http.ResponseWriter, r *http.Request) {
 		Authenticated:    false,
 		Device:           config.DeviceAuth != nil,
 		AppInstallURL:    config.AppInstallURL,
-		Type:             config.Type.Pretty(),
+		DisplayName:      config.DisplayName,
 		AppInstallations: []codersdk.ExternalAuthAppInstallation{},
 	}
 

diff --git a/coderd/externalauth/config.go b/coderd/externalauth/config.go
@@ -37,6 +37,10 @@ type Config struct {
 	Type codersdk.ExternalAuthProvider
 	// DeviceAuth is set if the provider uses the device flow.
 	DeviceAuth *DeviceAuth
+	// DisplayName is the name of the provider to display to the user.
+	DisplayName string
+	// DisplayIcon is the path to an image that will be displayed to the user.
+	DisplayIcon string
 
 	// NoRefresh stops Coder from using the refresh token
 	// to renew the access token.
@@ -258,6 +262,8 @@ func ConvertConfig(entries []codersdk.GitAuthConfig, accessURL *url.URL) ([]*Con
 			typ = codersdk.ExternalAuthProviderGitHub
 		case codersdk.ExternalAuthProviderGitLab:
 			typ = codersdk.ExternalAuthProviderGitLab
+		case codersdk.ExternalAuthProviderOpenIDConnect:
+			typ = codersdk.ExternalAuthProviderOpenIDConnect
 		default:
 			return nil, xerrors.Errorf("unknown git provider type: %q", entry.Type)
 		}
@@ -332,6 +338,12 @@ func ConvertConfig(entries []codersdk.GitAuthConfig, accessURL *url.URL) ([]*Con
 			ValidateURL:         entry.ValidateURL,
 			AppInstallationsURL: entry.AppInstallationsURL,
 			AppInstallURL:       entry.AppInstallURL,
+			DisplayName:         entry.DisplayName,
+			DisplayIcon:         entry.DisplayIcon,
+		}
+
+		if cfg.DisplayName == "" {
+			cfg.DisplayName = typ.Pretty()
 		}
 
 		if entry.DeviceFlow {

diff --git a/coderd/templateversions.go b/coderd/templateversions.go
@@ -320,6 +320,8 @@ func (api *API) templateVersionExternalAuth(rw http.ResponseWriter, r *http.Requ
 			ID:              config.ID,
 			Type:            config.Type,
 			AuthenticateURL: redirectURL.String(),
+			DisplayName:     config.DisplayName,
+			DisplayIcon:     config.DisplayIcon,
 		}
 
 		authLink, err := api.Database.GetExternalAuthLink(ctx, database.GetExternalAuthLinkParams{

diff --git a/codersdk/deployment.go b/codersdk/deployment.go
@@ -336,6 +336,8 @@ type GitAuthConfig struct {
 	Scopes              []string `json:"scopes"`
 	DeviceFlow          bool     `json:"device_flow"`
 	DeviceCodeURL       string   `json:"device_code_url"`
+	DisplayName         string   `json:"display_name"`
+	DisplayIcon         string   `json:"display_icon"`
 }
 
 type ProvisionerConfig struct {

diff --git a/codersdk/externalauth.go b/codersdk/externalauth.go
@@ -10,7 +10,7 @@ import (
 type ExternalAuth struct {
 	Authenticated bool   `json:"authenticated"`
 	Device        bool   `json:"device"`
-	Type          string `json:"type"`
+	DisplayName   string `json:"display_name"`
 
 	// User is the user that authenticated with the provider.
 	User *ExternalAuthUser `json:"user"`

diff --git a/codersdk/templateversions.go b/codersdk/templateversions.go
@@ -36,6 +36,8 @@ type TemplateVersion struct {
 type TemplateVersionExternalAuth struct {
 	ID              string               `json:"id"`
 	Type            ExternalAuthProvider `json:"type"`
+	DisplayName     string               `json:"display_name"`
+	DisplayIcon     string               `json:"display_icon"`
 	AuthenticateURL string               `json:"authenticate_url"`
 	Authenticated   bool                 `json:"authenticated"`
 }

diff --git a/codersdk/workspaceagents.go b/codersdk/workspaceagents.go
@@ -770,7 +770,7 @@ const (
 	ExternalAuthProviderGitHub        ExternalAuthProvider = "github"
 	ExternalAuthProviderGitLab        ExternalAuthProvider = "gitlab"
 	ExternalAuthProviderBitBucket     ExternalAuthProvider = "bitbucket"
-	ExternalAuthProviderOpenIDConnect ExternalAuthProvider = "openid-connect"
+	ExternalAuthProviderOpenIDConnect ExternalAuthProvider = "oidc"
 )
 
 type WorkspaceAgentLog struct {

diff --git a/docs/api/general.md b/docs/api/general.md
diff --git a/docs/api/git.md b/docs/api/git.md
diff --git a/docs/api/schemas.md b/docs/api/schemas.md
diff --git a/docs/api/templates.md b/docs/api/templates.md