feat: SAML config in dashboard (#150)

* fix: boxy changes

* fix: show form for boxy

* fix: more boxy changes

* fix: boxy stuff

* fix: remaining boxy changes

* fix: redirect url validation

* fix: boxy

* fix: version and changelog

* fix: version

CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [unreleased]
 
+## [0.13.0]
+
+-   Adds support for SAML metadata
+
 ## [0.12.0]
 
 -   Adds Multitenancy support to the dashboard

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "dashboard",
-	"version": "0.12.0",
+	"version": "0.13.0",
 	"private": true,
 	"dependencies": {
 		"@babel/core": "^7.16.0",

server/index.ts

@@ -36,7 +36,7 @@ app.use(morgan("[:date[iso]] :url :method :status :response-time ms - :res[conte
 SuperTokens.init({
 	framework: "express",
 	supertokens: {
-		connectionURI: "try.supertokens.com",
+		connectionURI: "localhost:3567",
 	},
 	appInfo: {
 		appName: "Dashboard Dev Node",
@@ -101,8 +101,10 @@ app.use(
 	})
 );
 
+// @ts-ignore
 app.use(middleware());
 
+// @ts-ignore
 app.use(errorHandler());
 
 app.get("/status", (req, res) => {

src/api/tenants/index.ts

@@ -272,7 +272,7 @@ export const useCreateOrUpdateThirdPartyProviderService = () => {
 	const createOrUpdateThirdPartyProvider = async (
 		tenantId: string,
 		providerConfig: ProviderConfig
-	): Promise<{ status: "OK" } | { status: "UNKNOWN_TENANT_ERROR" }> => {
+	): Promise<{ status: "OK" } | { status: "UNKNOWN_TENANT_ERROR" } | { status: "BOXY_ERROR"; message: string }> => {
 		const response = await fetchData({
 			url: getApiUrl("/api/thirdparty/config", tenantId),
 			method: "PUT",

src/api/tenants/types.ts

@@ -40,7 +40,7 @@ export type ProviderClientConfig = {
 	clientSecret?: string;
 	scope?: string[] | null;
 	forcePKCE?: boolean;
-	additionalConfig?: { [key: string]: string };
+	additionalConfig?: { [key: string]: any };
 };
 
 export type ProviderConfig = CommonProviderConfig & {

src/ui/components/inputField/InputDropdown.tsx

@@ -99,6 +99,7 @@ const InputDropdown: React.FC<InputDropdownPropTypes> = (props) => {
 					} ${props.size === "small" ? "input-field-small" : ""}`}
 					type="text"
 					ref={inputRef}
+					autoComplete="off"
 				/>
 			</div>
 			{isFocused && (

src/ui/components/tenants/tenantDetail/thirdPartyPage/ThirdPartyPage.tsx

@@ -22,6 +22,7 @@ import { useTenantDetailContext } from "../TenantDetailContext";
 import { TenantDetailHeader } from "../TenantDetailHeader";
 import { PanelHeader, PanelHeaderTitleWithTooltip, PanelRoot } from "../tenantDetailPanel/TenantDetailPanel";
 import { ProviderInfoForm } from "../thirdPartyProviderConfig/ProviderInfoForm";
+import { ProviderInfoFormForBoxy } from "../thirdPartyProviderConfig/ProviderInfoFormForBoxy";
 import { ThirdPartyProviderInput } from "../thirdPartyProviderInput/ThirdPartyProviderInput";
 import "./thirdPartyPage.scss";
 
@@ -81,12 +82,24 @@ const ProviderInfo = ({
 		const response = await getThirdPartyProviderInfo(tenantInfo.tenantId, id, additionalConfig);
 		if (response.status === "OK") {
 			setProviderConfigResponse(response.providerConfig);
+
+			if (
+				id.startsWith("boxy-saml") &&
+				response.providerConfig.clients![0].additionalConfig?.boxyAPIKey === undefined
+			) {
+				setHasFilledCustomFieldsForProvider(false);
+			}
 		}
 		setIsProviderInfoLoading(false);
 	};
 
 	useEffect(() => {
-		if (providerId !== undefined && !(isAddingNewProvider && providerHasCustomFields)) {
+		setHasFilledCustomFieldsForProvider(false);
+
+		if (
+			providerId !== undefined &&
+			(!(isAddingNewProvider && providerHasCustomFields) || providerId.startsWith("boxy-saml"))
+		) {
 			void fetchProviderInfo(providerId);
 		}
 	}, [providerId]);
@@ -101,6 +114,24 @@ const ProviderInfo = ({
 				providerId={providerId}
 				fetchProviderInfo={fetchProviderInfo}
 				handleGoBack={handleGoBack}
+				currentAdditionalConfig={
+					providerId?.startsWith("boxy-saml")
+						? providerConfigResponse?.clients![0].additionalConfig
+						: undefined
+				}
+				isAddingNewProvider={isAddingNewProvider}
+			/>
+		);
+	}
+
+	if (providerId?.startsWith("boxy-saml") && !hasFilledCustomFieldsForProvider) {
+		return (
+			<ProviderAdditionalConfigForm
+				providerId={providerId}
+				fetchProviderInfo={fetchProviderInfo}
+				handleGoBack={handleGoBack}
+				currentAdditionalConfig={providerConfigResponse?.clients![0].additionalConfig}
+				isAddingNewProvider={isAddingNewProvider}
 			/>
 		);
 	}
@@ -109,6 +140,17 @@ const ProviderInfo = ({
 		return <Loader />;
 	}
 
+	if (providerId?.startsWith("boxy-saml")) {
+		return (
+			<ProviderInfoFormForBoxy
+				providerId={providerId}
+				providerConfig={providerConfigResponse}
+				handleGoBack={handleGoBack}
+				isAddingNewProvider={isAddingNewProvider}
+			/>
+		);
+	}
+
 	return (
 		<ProviderInfoForm
 			providerId={providerId}
@@ -123,10 +165,14 @@ const ProviderAdditionalConfigForm = ({
 	providerId,
 	fetchProviderInfo,
 	handleGoBack,
+	currentAdditionalConfig,
+	isAddingNewProvider,
 }: {
 	providerId: string;
 	fetchProviderInfo: (providerId: string, additionalConfig?: Record<string, string>) => void;
 	handleGoBack: () => void;
+	currentAdditionalConfig?: Record<string, string>;
+	isAddingNewProvider: boolean;
 }) => {
 	const handleContinue = (additionalConfig: Record<string, string>) => {
 		fetchProviderInfo(providerId, additionalConfig);
@@ -160,6 +206,8 @@ const ProviderAdditionalConfigForm = ({
 					<BoxySamlForm
 						handleContinue={handleContinue}
 						handleGoBack={handleGoBack}
+						currentAdditionalConfig={currentAdditionalConfig}
+						isAddingNewProvider={isAddingNewProvider}
 					/>
 				);
 			default:
@@ -184,20 +232,37 @@ const ProviderAdditionalConfigForm = ({
 type AdditionalConfigFormProps = {
 	handleContinue: (additionalConfig: Record<string, string>) => void;
 	handleGoBack: () => void;
+	currentAdditionalConfig?: Record<string, string>;
+	isAddingNewProvider?: boolean;
 };
 
-const BoxySamlForm = ({ handleContinue, handleGoBack }: AdditionalConfigFormProps) => {
+const BoxySamlForm = ({
+	handleContinue,
+	handleGoBack,
+	currentAdditionalConfig,
+	isAddingNewProvider,
+}: AdditionalConfigFormProps) => {
 	const [boxyUrl, setBoxyUrl] = useState("");
-	const [error, setError] = useState<string | null>(null);
+	const [boxyAPIKey, setBoxyAPIKey] = useState("");
+	const [error, setError] = useState<Record<string, string | undefined>>({});
+
+	useEffect(() => {
+		if (currentAdditionalConfig) {
+			setBoxyUrl(currentAdditionalConfig?.boxyURL ?? "");
+			setBoxyAPIKey(currentAdditionalConfig?.boxyAPIKey ?? "");
+		}
+	}, [currentAdditionalConfig]);
 
 	const onContinue = () => {
 		if (!isValidHttpUrl(boxyUrl)) {
-			setError("Please enter a valid URL");
+			setError({ boxyURL: "Please enter a valid URL" });
 			return;
 		}
-		handleContinue({ boxyUrl });
+		handleContinue({ boxyUrl, boxyAPIKey });
 	};
 
+	const isBoxyUrlDisabled = !isAddingNewProvider && currentAdditionalConfig?.boxyURL !== undefined;
+
 	return (
 		<div className="saml-intro-container">
 			<p className="saml-intro-container__header">
@@ -220,7 +285,7 @@ const BoxySamlForm = ({ handleContinue, handleGoBack }: AdditionalConfigFormProp
 				to get your Boxy URL and continue setup of your SAML client.
 			</SAMLInfoBox>
 
-			<p className="saml-intro-container__boxy-url-header">Add the Boxy URL below</p>
+			<p className="saml-intro-container__boxy-url-header">Add the Boxy Details below</p>
 
 			<div className="additional-config-field">
 				<ThirdPartyProviderInput
@@ -229,10 +294,27 @@ const BoxySamlForm = ({ handleContinue, handleGoBack }: AdditionalConfigFormProp
 					name="boxyURL"
 					value={boxyUrl}
 					forceShowError
-					error={error ?? undefined}
+					error={error.boxyURL}
+					disabled={isBoxyUrlDisabled}
+					isRequired={true}
 					handleChange={(e) => {
 						setBoxyUrl(e.target.value);
-						setError(null);
+						setError((prevError) => ({ ...prevError, boxyURL: undefined }));
+					}}
+				/>
+
+				<div style={{ height: "10px" }}></div>
+
+				<ThirdPartyProviderInput
+					label="Boxy API Key"
+					type="password"
+					name="boxyAPIKey"
+					value={boxyAPIKey}
+					forceShowError
+					error={error.boxyAPIKey}
+					handleChange={(e) => {
+						setBoxyAPIKey(e.target.value);
+						setError((prevError) => ({ ...prevError, boxyAPIKey: undefined }));
 					}}
 				/>
 			</div>