feat(secret-sync): Add Azure Devops Secret Sync

2026-10-15 04:14:38 +00:00 · 2025-06-05 13:57:41 -03:00
parent 83c53b9d5a
commit 7f8d5ec11a
53 changed files with 1683 additions and 3 deletions
@@ -14,6 +14,7 @@ import { Auth0ConnectionForm } from "./Auth0ConnectionForm";
 import { AwsConnectionForm } from "./AwsConnectionForm";
 import { AzureAppConfigurationConnectionForm } from "./AzureAppConfigurationConnectionForm";
 import { AzureClientSecretsConnectionForm } from "./AzureClientSecretsConnectionForm";
+import { AzureDevOpsConnectionForm } from "./AzureDevOpsConnectionForm";
 import { AzureKeyVaultConnectionForm } from "./AzureKeyVaultConnectionForm";
 import { CamundaConnectionForm } from "./CamundaConnectionForm";
 import { DatabricksConnectionForm } from "./DatabricksConnectionForm";
@@ -99,6 +100,8 @@ const CreateForm = ({ app, onComplete }: CreateFormProps) => {
      return <CamundaConnectionForm onSubmit={onSubmit} />;
    case AppConnection.AzureClientSecrets:
      return <AzureClientSecretsConnectionForm />;
+    case AppConnection.AzureDevOps:
+      return <AzureDevOpsConnectionForm onSubmit={onSubmit} />;
    case AppConnection.Windmill:
      return <WindmillConnectionForm onSubmit={onSubmit} />;
    case AppConnection.Auth0:
@@ -179,6 +182,8 @@ const UpdateForm = ({ appConnection, onComplete }: UpdateFormProps) => {
      return <CamundaConnectionForm onSubmit={onSubmit} appConnection={appConnection} />;
    case AppConnection.AzureClientSecrets:
      return <AzureClientSecretsConnectionForm appConnection={appConnection} />;
+    case AppConnection.AzureDevOps:
+      return <AzureDevOpsConnectionForm appConnection={appConnection} onSubmit={onSubmit} />;
    case AppConnection.Windmill:
      return <WindmillConnectionForm onSubmit={onSubmit} appConnection={appConnection} />;
    case AppConnection.Auth0:
@@ -0,0 +1,291 @@
+/* eslint-disable no-case-declarations */
+import crypto from "crypto";
+
+import { useState } from "react";
+import { Controller, FormProvider, useForm } from "react-hook-form";
+import { zodResolver } from "@hookform/resolvers/zod";
+import { z } from "zod";
+
+import { Button, FormControl, Input, ModalClose, Select, SelectItem } from "@app/components/v2";
+import { APP_CONNECTION_MAP, getAppConnectionMethodDetails } from "@app/helpers/appConnections";
+import { isInfisicalCloud } from "@app/helpers/platform";
+import {
+  AzureDevOpsConnectionMethod,
+  TAzureDevOpsConnection,
+  useGetAppConnectionOption
+} from "@app/hooks/api/appConnections";
+import { AppConnection } from "@app/hooks/api/appConnections/enums";
+
+import {
+  genericAppConnectionFieldsSchema,
+  GenericAppConnectionsFields
+} from "./GenericAppConnectionFields";
+
+type ApiTokenForm = z.infer<typeof apiTokenSchema>;
+
+type Props = {
+  appConnection?: TAzureDevOpsConnection;
+  onSubmit: (formData: ApiTokenForm) => Promise<void>;
+};
+
+// Base schema with common fields
+const baseSchema = genericAppConnectionFieldsSchema.extend({
+  app: z.literal(AppConnection.AzureDevOps),
+  method: z.nativeEnum(AzureDevOpsConnectionMethod)
+});
+
+// Method-specific schemas
+const oauthSchema = baseSchema.extend({
+  method: z.literal(AzureDevOpsConnectionMethod.OAuth),
+  tenantId: z.string().trim().min(1, "Tenant ID is required"),
+  orgName: z.string().trim().min(1, "Organization name is required")
+});
+
+const apiTokenSchema = baseSchema.extend({
+  method: z.literal(AzureDevOpsConnectionMethod.ApiToken),
+  credentials: z.object({
+    apiKey: z.string().trim().min(1, "API Key is required"),
+    orgName: z.string().trim().min(1, "Organization name is required")
+  })
+});
+
+// Union schema
+const formSchema = z.discriminatedUnion("method", [oauthSchema, apiTokenSchema]);
+
+type FormData = z.infer<typeof formSchema>;
+
+const getDefaultValues = (appConnection?: TAzureDevOpsConnection): Partial<FormData> => {
+  if (!appConnection) {
+    return {
+      app: AppConnection.AzureDevOps,
+      method: AzureDevOpsConnectionMethod.OAuth
+    };
+  }
+
+  const base = {
+    name: appConnection.name,
+    description: appConnection.description,
+    app: appConnection.app,
+    method: appConnection.method
+  };
+  const { credentials } = appConnection;
+
+  switch (appConnection.method) {
+    case AzureDevOpsConnectionMethod.OAuth:
+      if ("tenantId" in credentials && "orgName" in credentials) {
+        return {
+          ...base,
+          method: AzureDevOpsConnectionMethod.OAuth,
+          tenantId: credentials.tenantId,
+          orgName: credentials.orgName
+        };
+      }
+      break;
+    case AzureDevOpsConnectionMethod.ApiToken:
+      if ("apiKey" in credentials && "orgName" in credentials) {
+        return {
+          ...base,
+          method: AzureDevOpsConnectionMethod.ApiToken,
+          credentials: {
+            apiKey: credentials.apiKey,
+            orgName: credentials.orgName
+          }
+        };
+      }
+      break;
+    default:
+      return base;
+  }
+
+  return base;
+};
+
+export const AzureDevOpsConnectionForm = ({ appConnection, onSubmit }: Props) => {
+  const isUpdate = Boolean(appConnection);
+  const [isRedirecting, setIsRedirecting] = useState(false);
+
+  const {
+    option: { oauthClientId },
+    isLoading
+  } = useGetAppConnectionOption(AppConnection.AzureDevOps);
+
+  const form = useForm<FormData>({
+    resolver: zodResolver(formSchema),
+    defaultValues: getDefaultValues(appConnection)
+  });
+
+  const {
+    handleSubmit,
+    control,
+    watch,
+    formState: { isSubmitting, isDirty }
+  } = form;
+
+  const selectedMethod = watch("method");
+
+  const onSubmitHandler = async (formData: FormData) => {
+    switch (formData.method) {
+      case AzureDevOpsConnectionMethod.OAuth:
+        setIsRedirecting(true);
+        const state = crypto.randomBytes(16).toString("hex");
+        localStorage.setItem("latestCSRFToken", state);
+        localStorage.setItem(
+          "azureDevOpsConnectionFormData",
+          JSON.stringify({ ...formData, connectionId: appConnection?.id })
+        );
+
+        window.location.assign(
+          `https://login.microsoftonline.com/${formData.tenantId || "common"}/oauth2/v2.0/authorize?client_id=${oauthClientId}&response_type=code&redirect_uri=${window.location.origin}/organization/app-connections/azure/oauth/callback&response_mode=query&scope=https://azconfig.io/.default%20openid%20offline_access&state=${state}<:>azure-devops`
+        );
+        break;
+
+      case AzureDevOpsConnectionMethod.ApiToken:
+        onSubmit(formData);
+        break;
+
+      default:
+        throw new Error(`Unhandled Azure Connection method: ${(formData as FormData).method}`);
+    }
+  };
+
+  const isMissingConfig = selectedMethod === AzureDevOpsConnectionMethod.OAuth && !oauthClientId;
+  const methodDetails = getAppConnectionMethodDetails(selectedMethod);
+
+  return (
+    <FormProvider {...form}>
+      <form onSubmit={handleSubmit(onSubmitHandler)} className="space-y-6">
+        {!isUpdate && <GenericAppConnectionsFields />}
+
+        <Controller
+          name="method"
+          control={control}
+          render={({ field: { value, onChange }, fieldState: { error } }) => (
+            <FormControl
+              tooltipText={`The method you would like to use to connect with ${
+                APP_CONNECTION_MAP[AppConnection.AzureDevOps].name
+              }. This field cannot be changed after creation.`}
+              errorText={
+                !isLoading && isMissingConfig
+                  ? `Environment variables have not been configured. ${
+                      isInfisicalCloud()
+                        ? "Please contact Infisical."
+                        : `See documentation to configure Azure ${methodDetails.name} Connections.`
+                    }`
+                  : error?.message
+              }
+              isError={Boolean(error?.message) || isMissingConfig}
+              label="Method"
+            >
+              <Select
+                isDisabled={isUpdate}
+                value={value}
+                onValueChange={(val) => onChange(val)}
+                className="w-full border border-mineshaft-500"
+                position="popper"
+                dropdownContainerClassName="max-w-none"
+              >
+                {Object.values(AzureDevOpsConnectionMethod).map((method) => {
+                  return (
+                    <SelectItem value={method} key={method}>
+                      {getAppConnectionMethodDetails(method).name}
+                    </SelectItem>
+                  );
+                })}
+              </Select>
+            </FormControl>
+          )}
+        />
+
+        {/* OAuth-specific fields */}
+        {selectedMethod === AzureDevOpsConnectionMethod.OAuth && (
+          <>
+            <Controller
+              name="tenantId"
+              control={control}
+              render={({ field, fieldState: { error } }) => (
+                <FormControl
+                  tooltipText="The Directory (tenant) ID."
+                  isError={Boolean(error?.message)}
+                  label="Tenant ID"
+                  errorText={error?.message}
+                >
+                  <Input {...field} placeholder="e4f34ea5-ad23-4291-8585-66d20d603cc8" />
+                </FormControl>
+              )}
+            />
+            <Controller
+              name="orgName"
+              control={control}
+              render={({ field, fieldState: { error } }) => (
+                <FormControl
+                  tooltipText="Your Azure DevOps organization name."
+                  isError={Boolean(error?.message)}
+                  label="Organization Name"
+                  errorText={error?.message}
+                >
+                  <Input {...field} placeholder="myorganization" />
+                </FormControl>
+              )}
+            />
+          </>
+        )}
+
+        {/* API Token-specific fields */}
+        {selectedMethod === AzureDevOpsConnectionMethod.ApiToken && (
+          <>
+            <Controller
+              name="credentials.apiKey"
+              control={control}
+              render={({ field, fieldState: { error } }) => (
+                <FormControl
+                  tooltipText="Personal Access Token from Azure DevOps."
+                  isError={Boolean(error?.message)}
+                  label="API Key"
+                  errorText={error?.message}
+                >
+                  <Input
+                    {...field}
+                    type="password"
+                    placeholder="Enter your Personal Access Token"
+                  />
+                </FormControl>
+              )}
+            />
+            <Controller
+              name="credentials.orgName"
+              control={control}
+              render={({ field, fieldState: { error } }) => (
+                <FormControl
+                  tooltipText="Your Azure DevOps organization name."
+                  isError={Boolean(error?.message)}
+                  label="Organization Name"
+                  errorText={error?.message}
+                >
+                  <Input {...field} placeholder="myorganization" />
+                </FormControl>
+              )}
+            />
+          </>
+        )}
+
+        <div className="mt-8 flex items-center">
+          <Button
+            className="mr-4"
+            size="sm"
+            type="submit"
+            colorSchema="secondary"
+            isLoading={isSubmitting || isRedirecting}
+            isDisabled={isSubmitting || (!isUpdate && !isDirty) || isMissingConfig || isRedirecting}
+          >
+            {isUpdate ? "Reconnect to Azure" : "Connect to Azure"}
+          </Button>
+          <ModalClose asChild>
+            <Button colorSchema="secondary" variant="plain">
+              Cancel
+            </Button>
+          </ModalClose>
+        </div>
+      </form>
+    </FormProvider>
+  );
+};
@@ -8,10 +8,12 @@ import { APP_CONNECTION_MAP } from "@app/helpers/appConnections";
 import {
  AzureAppConfigurationConnectionMethod,
  AzureClientSecretsConnectionMethod,
+  AzureDevOpsConnectionMethod,
  AzureKeyVaultConnectionMethod,
  GitHubConnectionMethod,
  TAzureAppConfigurationConnection,
  TAzureClientSecretsConnection,
+  TAzureDevOpsConnection,
  TAzureKeyVaultConnection,
  TGitHubConnection,
  TGitHubRadarConnection,
@@ -42,6 +44,19 @@ type AzureClientSecretsFormData = BaseFormData &
  Pick<TAzureClientSecretsConnection, "name" | "method" | "description"> &
  Pick<TAzureClientSecretsConnection["credentials"], "tenantId">;

+type OAuthCredentials = Extract<
+  TAzureDevOpsConnection,
+  { method: AzureDevOpsConnectionMethod.OAuth }
+>["credentials"];
+type ApiTokenCredentials = Extract<
+  TAzureDevOpsConnection,
+  { method: AzureDevOpsConnectionMethod.ApiToken }
+>["credentials"];
+
+type AzureDevOpsFormData = BaseFormData &
+  Pick<TAzureDevOpsConnection, "name" | "method" | "description"> &
+  (Pick<OAuthCredentials, "tenantId" | "orgName"> | Pick<ApiTokenCredentials, "orgName">);
+
 type FormDataMap = {
  [AppConnection.GitHub]: GithubFormData & { app: AppConnection.GitHub };
  [AppConnection.GitHubRadar]: GithubRadarFormData & { app: AppConnection.GitHubRadar };
@@ -52,6 +67,9 @@ type FormDataMap = {
  [AppConnection.AzureClientSecrets]: AzureClientSecretsFormData & {
    app: AppConnection.AzureClientSecrets;
  };
+  [AppConnection.AzureDevOps]: AzureDevOpsFormData & {
+    app: AppConnection.AzureDevOps;
+  };
 };

 const formDataStorageFieldMap: Partial<Record<AppConnection, string>> = {
@@ -59,7 +77,8 @@ const formDataStorageFieldMap: Partial<Record<AppConnection, string>> = {
  [AppConnection.GitHubRadar]: "githubRadarConnectionFormData",
  [AppConnection.AzureKeyVault]: "azureKeyVaultConnectionFormData",
  [AppConnection.AzureAppConfiguration]: "azureAppConfigurationConnectionFormData",
-  [AppConnection.AzureClientSecrets]: "azureClientSecretsConnectionFormData"
+  [AppConnection.AzureClientSecrets]: "azureClientSecretsConnectionFormData",
+  [AppConnection.AzureDevOps]: "azureDevOpsConnectionFormData"
 };

 export const OAuthCallbackPage = () => {
@@ -258,6 +277,60 @@ export const OAuthCallbackPage = () => {
    };
  }, []);

+  const handleAzureDevOps = useCallback(async () => {
+    const formData = getFormData(AppConnection.AzureDevOps);
+    if (formData === null) return null;
+
+    clearState(AppConnection.AzureDevOps);
+
+    const { connectionId, name, description, returnUrl } = formData;
+
+    try {
+      if (!("tenantId" in formData)) {
+        throw new Error("Expected OAuth form data but got API token data");
+      }
+
+      if (connectionId) {
+        await updateAppConnection.mutateAsync({
+          app: AppConnection.AzureDevOps,
+          connectionId,
+          credentials: {
+            code: code as string,
+            tenantId: formData.tenantId as string,
+            orgName: formData.orgName
+          }
+        });
+      } else {
+        await createAppConnection.mutateAsync({
+          app: AppConnection.AzureDevOps,
+          name,
+          description,
+          method: AzureDevOpsConnectionMethod.OAuth,
+          credentials: {
+            code: code as string,
+            tenantId: formData.tenantId as string,
+            orgName: formData.orgName
+          }
+        });
+      }
+    } catch (err: any) {
+      createNotification({
+        title: `Failed to ${connectionId ? "update" : "add"} Azure DevOps Connection`,
+        text: err?.message,
+        type: "error"
+      });
+      navigate({
+        to: returnUrl ?? "/organization/app-connections"
+      });
+    }
+
+    return {
+      connectionId,
+      returnUrl,
+      appConnectionName: formData.app
+    };
+  }, []);
+
  const handleGithub = useCallback(async () => {
    const formData = getFormData(AppConnection.GitHub);
    if (formData === null) return null;
@@ -396,6 +469,8 @@ export const OAuthCallbackPage = () => {
        data = await handleAzureAppConfiguration();
      } else if (appConnection === AppConnection.AzureClientSecrets) {
        data = await handleAzureClientSecrets();
+      } else if (appConnection === AppConnection.AzureDevOps) {
+        data = await handleAzureDevOps();
      }

      if (data) {
@@ -0,0 +1,14 @@
+import { TAzureDevOpsSync } from "@app/hooks/api/secretSyncs/types/azure-devops-sync";
+
+import { getSecretSyncDestinationColValues } from "../helpers";
+import { SecretSyncTableCell } from "../SecretSyncTableCell";
+
+type Props = {
+  secretSync: TAzureDevOpsSync;
+};
+
+export const AzureDevOpsSyncDestinationCol = ({ secretSync }: Props) => {
+  const { primaryText, secondaryText } = getSecretSyncDestinationColValues(secretSync);
+
+  return <SecretSyncTableCell primaryText={primaryText} secondaryText={secondaryText} />;
+};
@@ -4,6 +4,7 @@ import { OnePassSyncDestinationCol } from "./1PasswordSyncDestinationCol";
 import { AwsParameterStoreSyncDestinationCol } from "./AwsParameterStoreSyncDestinationCol";
 import { AwsSecretsManagerSyncDestinationCol } from "./AwsSecretsManagerSyncDestinationCol";
 import { AzureAppConfigurationDestinationSyncCol } from "./AzureAppConfigurationDestinationSyncCol";
+import { AzureDevOpsSyncDestinationCol } from "./AzureDevopsDestinationCol";
 import { AzureKeyVaultDestinationSyncCol } from "./AzureKeyVaultDestinationSyncCol";
 import { CamundaSyncDestinationCol } from "./CamundaSyncDestinationCol";
 import { DatabricksSyncDestinationCol } from "./DatabricksSyncDestinationCol";
@@ -55,6 +56,8 @@ export const SecretSyncDestinationCol = ({ secretSync }: Props) => {
      return <OCIVaultSyncDestinationCol secretSync={secretSync} />;
    case SecretSync.OnePass:
      return <OnePassSyncDestinationCol secretSync={secretSync} />;
+    case SecretSync.AzureDevOps:
+      return <AzureDevOpsSyncDestinationCol secretSync={secretSync} />;
    default:
      throw new Error(
        `Unhandled Secret Sync Destination Col: ${(secretSync as TSecretSync).destination}`
@@ -110,6 +110,9 @@ export const getSecretSyncDestinationColValues = (secretSync: TSecretSync) => {
      primaryText = destinationConfig.vaultId;
      secondaryText = "Vault ID";
      break;
+    case SecretSync.AzureDevOps:
+      primaryText = destinationConfig.devopsProjectName;
+      break;
    default:
      throw new Error(`Unhandled Destination Col Values ${destination}`);
  }
@@ -0,0 +1,14 @@
+import { GenericFieldLabel } from "@app/components/secret-syncs";
+import { TAzureDevOpsSync } from "@app/hooks/api/secretSyncs/types/azure-devops-sync";
+
+type Props = {
+  secretSync: TAzureDevOpsSync;
+};
+
+export const AzureDevOpsSyncDestinationSection = ({ secretSync }: Props) => {
+  const {
+    destinationConfig: { devopsProjectName }
+  } = secretSync;
+
+  return <GenericFieldLabel label="Project">{devopsProjectName}</GenericFieldLabel>;
+};
@@ -14,6 +14,7 @@ import { OnePassSyncDestinationSection } from "./1PasswordSyncDestinationSection
 import { AwsParameterStoreSyncDestinationSection } from "./AwsParameterStoreSyncDestinationSection";
 import { AwsSecretsManagerSyncDestinationSection } from "./AwsSecretsManagerSyncDestinationSection";
 import { AzureAppConfigurationSyncDestinationSection } from "./AzureAppConfigurationSyncDestinationSection";
+import { AzureDevOpsSyncDestinationSection } from "./AzureDevopsSyncDestinationSection";
 import { AzureKeyVaultSyncDestinationSection } from "./AzureKeyVaultSyncDestinationSection";
 import { CamundaSyncDestinationSection } from "./CamundaSyncDestinationSection";
 import { DatabricksSyncDestinationSection } from "./DatabricksSyncDestinationSection";
@@ -89,6 +90,9 @@ export const SecretSyncDestinationSection = ({ secretSync, onEditDestination }:
    case SecretSync.OnePass:
      DestinationComponents = <OnePassSyncDestinationSection secretSync={secretSync} />;
      break;
+    case SecretSync.AzureDevOps:
+      DestinationComponents = <AzureDevOpsSyncDestinationSection secretSync={secretSync} />;
+      break;
    default:
      throw new Error(`Unhandled Destination Section components: ${destination}`);
  }
@@ -41,6 +41,7 @@ export const SecretSyncOptionsSection = ({ secretSync, onEditOptions }: Props) =
    case SecretSync.GCPSecretManager:
    case SecretSync.AzureKeyVault:
    case SecretSync.AzureAppConfiguration:
+    case SecretSync.AzureDevOps:
    case SecretSync.Databricks:
    case SecretSync.Humanitec:
    case SecretSync.TerraformCloud: