feat: add endpoints to oauth2 provider applications

These will show up when configuring the application along with the client ID and everything else. Should make it easier to configure the application, otherwise you will have to go look up the URLs in the docs (which are not yet written). Co-authored-by: Steven Masley <stevenmasley@gmail.com>
coder · code-asher · Jan 22, 2024 · Jan 19, 2024 · Jan 19, 2024 · 277269f97effc8978dae9ced82d85d652a213ddb
commit 277269f97effc8978dae9ced82d85d652a213ddb
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/database/db2sdk/db2sdk.go b/coderd/database/db2sdk/db2sdk.go
@@ -4,6 +4,7 @@ package db2sdk
 import (
 	"encoding/json"
 	"fmt"
+	"net/url"
 	"strconv"
 	"strings"
 	"time"
@@ -226,19 +227,29 @@ func templateVersionParameterOptions(rawOptions json.RawMessage) ([]codersdk.Tem
 	return options, nil
 }
 
-func OAuth2ProviderApp(dbApp database.OAuth2ProviderApp) codersdk.OAuth2ProviderApp {
+func OAuth2ProviderApp(accessURL *url.URL, dbApp database.OAuth2ProviderApp) codersdk.OAuth2ProviderApp {
 	return codersdk.OAuth2ProviderApp{
 		ID:          dbApp.ID,
 		Name:        dbApp.Name,
 		CallbackURL: dbApp.CallbackURL,
 		Icon:        dbApp.Icon,
+		Endpoints: codersdk.OAuth2AppEndpoints{
+			Authorization: accessURL.ResolveReference(&url.URL{
+				Path: "/login/oauth2/authorize",
+			}).String(),
+			Token: accessURL.ResolveReference(&url.URL{
+				Path: "/login/oauth2/tokens",
+			}).String(),
+			// We do not currently support DeviceAuth.
+			DeviceAuth: "",
+		},
 	}
 }
 
-func OAuth2ProviderApps(dbApps []database.OAuth2ProviderApp) []codersdk.OAuth2ProviderApp {
+func OAuth2ProviderApps(accessURL *url.URL, dbApps []database.OAuth2ProviderApp) []codersdk.OAuth2ProviderApp {
 	apps := []codersdk.OAuth2ProviderApp{}
 	for _, dbApp := range dbApps {
-		apps = append(apps, OAuth2ProviderApp(dbApp))
+		apps = append(apps, OAuth2ProviderApp(accessURL, dbApp))
 	}
 	return apps
 }

diff --git a/codersdk/oauth2.go b/codersdk/oauth2.go
@@ -14,6 +14,18 @@ type OAuth2ProviderApp struct {
 	Name        string    `json:"name"`
 	CallbackURL string    `json:"callback_url"`
 	Icon        string    `json:"icon"`
+
+	// Endpoints are included in the app response for easier discovery. The OAuth2
+	// spec does not have a defined place to find these (for comparison, OIDC has
+	// a '/.well-known/openid-configuration' endpoint).
+	Endpoints OAuth2AppEndpoints `json:"endpoints"`
+}
+
+type OAuth2AppEndpoints struct {
+	Authorization string `json:"authorization"`
+	Token         string `json:"token"`
+	// DeviceAuth is optional.
+	DeviceAuth string `json:"device_authorization"`
 }
 
 // OAuth2ProviderApps returns the applications configured to authenticate using

diff --git a/docs/api/enterprise.md b/docs/api/enterprise.md
diff --git a/docs/api/schemas.md b/docs/api/schemas.md
diff --git a/enterprise/coderd/oauth2.go b/enterprise/coderd/oauth2.go
@@ -54,7 +54,7 @@ func (api *API) oAuth2ProviderApps(rw http.ResponseWriter, r *http.Request) {
 		httpapi.InternalServerError(rw, err)
 		return
 	}
-	httpapi.Write(ctx, rw, http.StatusOK, db2sdk.OAuth2ProviderApps(dbApps))
+	httpapi.Write(ctx, rw, http.StatusOK, db2sdk.OAuth2ProviderApps(api.AccessURL, dbApps))
 }
 
 // @Summary Get OAuth2 application.
@@ -65,10 +65,10 @@ func (api *API) oAuth2ProviderApps(rw http.ResponseWriter, r *http.Request) {
 // @Param app path string true "App ID"
 // @Success 200 {object} codersdk.OAuth2ProviderApp
 // @Router /oauth2-provider/apps/{app} [get]
-func (*API) oAuth2ProviderApp(rw http.ResponseWriter, r *http.Request) {
+func (api *API) oAuth2ProviderApp(rw http.ResponseWriter, r *http.Request) {
 	ctx := r.Context()
 	app := httpmw.OAuth2ProviderApp(r)
-	httpapi.Write(ctx, rw, http.StatusOK, db2sdk.OAuth2ProviderApp(app))
+	httpapi.Write(ctx, rw, http.StatusOK, db2sdk.OAuth2ProviderApp(api.AccessURL, app))
 }
 
 // @Summary Create OAuth2 application.
@@ -101,7 +101,7 @@ func (api *API) postOAuth2ProviderApp(rw http.ResponseWriter, r *http.Request) {
 		})
 		return
 	}
-	httpapi.Write(ctx, rw, http.StatusCreated, db2sdk.OAuth2ProviderApp(app))
+	httpapi.Write(ctx, rw, http.StatusCreated, db2sdk.OAuth2ProviderApp(api.AccessURL, app))
 }
 
 // @Summary Update OAuth2 application.
@@ -135,7 +135,7 @@ func (api *API) putOAuth2ProviderApp(rw http.ResponseWriter, r *http.Request) {
 		})
 		return
 	}
-	httpapi.Write(ctx, rw, http.StatusOK, db2sdk.OAuth2ProviderApp(app))
+	httpapi.Write(ctx, rw, http.StatusOK, db2sdk.OAuth2ProviderApp(api.AccessURL, app))
 }
 
 // @Summary Delete OAuth2 application.

diff --git a/site/src/api/typesGenerated.ts b/site/src/api/typesGenerated.ts
diff --git a/site/src/pages/DeploySettingsPage/OAuth2AppsSettingsPage/EditOAuth2AppPageView.tsx b/site/src/pages/DeploySettingsPage/OAuth2AppsSettingsPage/EditOAuth2AppPageView.tsx
@@ -1,4 +1,4 @@
-import { useTheme } from "@emotion/react";
+import { type Interpolation, type Theme, useTheme } from "@emotion/react";
 import CopyIcon from "@mui/icons-material/FileCopyOutlined";
 import KeyboardArrowLeft from "@mui/icons-material/KeyboardArrowLeft";
 import Divider from "@mui/material/Divider";
@@ -139,16 +139,28 @@ export const EditOAuth2AppPageView: FC<EditOAuth2AppProps> = ({
               onCancel={() => setShowDelete(false)}
             />
 
-            <h2 css={{ marginBottom: 0 }}>Client ID</h2>
-            <CopyableValue value={app.id}>
-              {app.id}{" "}
-              <CopyIcon
-                css={{
-                  width: 16,
-                  height: 16,
-                }}
-              />
-            </CopyableValue>
+            <dl css={styles.dataList}>
+              <dt>Client ID</dt>
+              <dd>
+                <CopyableValue value={app.id}>
+                  {app.id} <CopyIcon css={{ width: 16, height: 16 }} />
+                </CopyableValue>
+              </dd>
+              <dt>Authorization URL</dt>
+              <dd>
+                <CopyableValue value={app.endpoints.authorization}>
+                  {app.endpoints.authorization}{" "}
+                  <CopyIcon css={{ width: 16, height: 16 }} />
+                </CopyableValue>
+              </dd>
+              <dt>Token URL</dt>
+              <dd>
+                <CopyableValue value={app.endpoints.token}>
+                  {app.endpoints.token}{" "}
+                  <CopyIcon css={{ width: 16, height: 16 }} />
+                </CopyableValue>
+              </dd>
+            </dl>
 
             <Divider css={{ borderColor: theme.palette.divider }} />
 
@@ -303,3 +315,16 @@ const OAuth2SecretRow: FC<OAuth2SecretRowProps> = ({
     </TableRow>
   );
 };
+
+const styles = {
+  dataList: {
+    display: "grid",
+    gridTemplateColumns: "max-content auto",
+    "& > dt": {
+      fontWeight: "bold",
+    },
+    "& > dd": {
+      marginLeft: 10,
+    },
+  },
+} satisfies Record<string, Interpolation<Theme>>;
diff --git a/site/src/testHelpers/entities.ts b/site/src/testHelpers/entities.ts
@@ -3371,6 +3371,11 @@ export const MockOAuth2ProviderApps: TypesGen.OAuth2ProviderApp[] = [
     name: "foo",
     callback_url: "http://localhost:3001",
     icon: "/icon/github.svg",
+    endpoints: {
+      authorization: "http://localhost:3001/login/oauth2/authorize",
+      token: "http://localhost:3001/login/oauth2/token",
+      device_authorization: "",
+    },
   },
 ];