Skip to content

Infisical is the open-source platform for securing secrets, certificates, access, and AI Agents.

feat: renamed to oauth2.0

=3bd62286aa43
diff --git a/backend/src/ee/services/dynamic-secret/providers/index.ts b/backend/src/ee/services/dynamic-secret/providers/index.ts
index 3e4b8c54c2..491abb8ba8 100644
--- a/backend/src/ee/services/dynamic-secret/providers/index.ts
+++ b/backend/src/ee/services/dynamic-secret/providers/index.ts
@@ -21,7 +21,7 @@ import { MilvusProvider } from "./milvus";
import { DynamicSecretProviders, TDynamicProviderFns } from "./models";
import { MongoAtlasProvider } from "./mongo-atlas";
import { MongoDBProvider } from "./mongo-db";
-import { OAuthProvider } from "./oauth";
+import { OAuth2Provider } from "./oauth2";
import { RabbitMqProvider } from "./rabbit-mq";
import { RedisDatabaseProvider } from "./redis";
import { SapAseProvider } from "./sap-ase";
@@ -70,5 +70,5 @@ export const buildDynamicSecretProviders = ({
[DynamicSecretProviders.Ssh]: SshProvider(),
[DynamicSecretProviders.IbmApiConnect]: IbmApiConnectProvider(),
[DynamicSecretProviders.Tailscale]: TailscaleProvider(),
- [DynamicSecretProviders.OAuth]: OAuthProvider()
+ [DynamicSecretProviders.OAuth2]: OAuth2Provider()
});
diff --git a/backend/src/ee/services/dynamic-secret/providers/models.ts b/backend/src/ee/services/dynamic-secret/providers/models.ts
index 79242a05be..2b06cd012d 100644
--- a/backend/src/ee/services/dynamic-secret/providers/models.ts
+++ b/backend/src/ee/services/dynamic-secret/providers/models.ts
@@ -831,7 +831,7 @@ export enum DynamicSecretProviders {
Ssh = "ssh",
IbmApiConnect = "ibm-api-connect",
Tailscale = "tailscale",
- OAuth = "oauth"
+ OAuth2 = "oauth2"
}
export const DynamicSecretIbmApiConnectSchema = z.object({
@@ -974,15 +974,15 @@ export const DynamicSecretTailscaleSchema = z
}
});
-export enum OAuthGrantType {
+export enum OAuth2GrantType {
ClientCredentials = "client-credentials"
}
-export const OAUTH_MAX_EXTRA_PARAMS = 20;
+export const OAUTH2_MAX_EXTRA_PARAMS = 20;
// Parameters Infisical sets itself or that carry client authentication; letting extra params
// override them would change the grant or leak credentials into the request body.
-export const OAUTH_RESERVED_PARAMS = new Set([
+export const OAUTH2_RESERVED_PARAMS = new Set([
"grant_type",
"scope",
"client_id",
@@ -992,44 +992,44 @@ export const OAUTH_RESERVED_PARAMS = new Set([
]);
// RFC 6749 section 3.3: scope-token = 1*( %x21 / %x23-5B / %x5D-7E )
-const OAUTH_SCOPE_TOKEN_REGEX = new RE2(/^[\x21\x23-\x5B\x5D-\x7E]+$/);
-const OAUTH_PARAM_KEY_REGEX = new RE2(/^[A-Za-z0-9._~:[\]-]+$/);
+const OAUTH2_SCOPE_TOKEN_REGEX = new RE2(/^[\x21\x23-\x5B\x5D-\x7E]+$/);
+const OAUTH2_PARAM_KEY_REGEX = new RE2(/^[A-Za-z0-9._~:[\]-]+$/);
const WHITESPACE_REGEX = new RE2(/\s+/);
-export const normalizeOAuthScope = (scope: string) =>
+export const normalizeOAuth2Scope = (scope: string) =>
[...new Set(scope.split(WHITESPACE_REGEX).filter(Boolean))].join(" ");
// RFC 7591 registry names, so they match what servers advertise in token_endpoint_auth_methods_supported
-export enum OAuthClientAuthMethod {
+export enum OAuth2ClientAuthMethod {
ClientSecretBasic = "client_secret_basic",
ClientSecretPost = "client_secret_post"
}
-const OAuthClientSecretSchema = z
+const OAuth2ClientSecretSchema = z
.string()
.trim()
.min(1, "Client secret is required")
.max(4096)
- .describe("The OAuth client secret.");
+ .describe("The OAuth 2.0 client secret.");
-export const OAuthClientAuthSchema = z.discriminatedUnion("method", [
+export const OAuth2ClientAuthSchema = z.discriminatedUnion("method", [
z.object({
method: z
- .literal(OAuthClientAuthMethod.ClientSecretBasic)
+ .literal(OAuth2ClientAuthMethod.ClientSecretBasic)
.describe("Send the client credentials in an HTTP Basic Authorization header."),
- clientSecret: OAuthClientSecretSchema
+ clientSecret: OAuth2ClientSecretSchema
}),
z.object({
method: z
- .literal(OAuthClientAuthMethod.ClientSecretPost)
+ .literal(OAuth2ClientAuthMethod.ClientSecretPost)
.describe("Send the client credentials as client_id and client_secret form parameters."),
- clientSecret: OAuthClientSecretSchema
+ clientSecret: OAuth2ClientSecretSchema
})
]);
-export const DynamicSecretOAuthSchema = z.discriminatedUnion("grantType", [
+export const DynamicSecretOAuth2Schema = z.discriminatedUnion("grantType", [
z.object({
- grantType: z.literal(OAuthGrantType.ClientCredentials),
+ grantType: z.literal(OAuth2GrantType.ClientCredentials),
tokenUrl: z
.string()
.trim()
@@ -1042,8 +1042,8 @@ export const DynamicSecretOAuthSchema = z.discriminatedUnion("grantType", [
.max(2048)
.url("Revocation URL must be a valid URL")
.describe("The authorization server's RFC 7009 token revocation endpoint."),
- clientId: z.string().trim().min(1, "Client ID is required").max(1024).describe("The OAuth client ID."),
- clientAuth: OAuthClientAuthSchema.describe(
+ clientId: z.string().trim().min(1, "Client ID is required").max(1024).describe("The OAuth 2.0 client ID."),
+ clientAuth: OAuth2ClientAuthSchema.describe(
"How Infisical authenticates the client to the token and revocation endpoints."
),
scope: z
@@ -1053,7 +1053,7 @@ export const DynamicSecretOAuthSchema = z.discriminatedUnion("grantType", [
.superRefine((scope, ctx) => {
const invalidTokens = scope
.split(WHITESPACE_REGEX)
- .filter((token) => token && !OAUTH_SCOPE_TOKEN_REGEX.test(token));
+ .filter((token) => token && !OAUTH2_SCOPE_TOKEN_REGEX.test(token));
if (invalidTokens.length) {
ctx.addIssue({
code: z.ZodIssueCode.custom,
@@ -1061,7 +1061,7 @@ export const DynamicSecretOAuthSchema = z.discriminatedUnion("grantType", [
});
}
})
- .transform((scope) => normalizeOAuthScope(scope) || undefined)
+ .transform((scope) => normalizeOAuth2Scope(scope) || undefined)
.optional()
.describe("Space-separated scopes to request. Leave empty to use the client's default scopes."),
extraParams: z
@@ -1072,15 +1072,15 @@ export const DynamicSecretOAuthSchema = z.discriminatedUnion("grantType", [
.trim()
.min(1, "Parameter name is required")
.max(128)
- .refine((key) => OAUTH_PARAM_KEY_REGEX.test(key), "Parameter name contains invalid characters")
+ .refine((key) => OAUTH2_PARAM_KEY_REGEX.test(key), "Parameter name contains invalid characters")
.refine(
- (key) => !OAUTH_RESERVED_PARAMS.has(key.toLowerCase()),
+ (key) => !OAUTH2_RESERVED_PARAMS.has(key.toLowerCase()),
(key) => ({ message: `'${key}' is set by Infisical and can't be used as an extra parameter` })
),
value: z.string().trim().min(1, "Parameter value is required").max(2048)
})
)
- .max(OAUTH_MAX_EXTRA_PARAMS, `At most ${OAUTH_MAX_EXTRA_PARAMS} extra parameters are allowed`)
+ .max(OAUTH2_MAX_EXTRA_PARAMS, `At most ${OAUTH2_MAX_EXTRA_PARAMS} extra parameters are allowed`)
.superRefine((params, ctx) => {
const seen = new Set<string>();
params.forEach(({ key }, index) => {
@@ -1144,7 +1144,7 @@ export const DynamicSecretProviderSchema = z.discriminatedUnion("type", [
inputs: DynamicSecretIbmApiConnectSchema
}),
z.object({ type: z.literal(DynamicSecretProviders.Tailscale), inputs: DynamicSecretTailscaleSchema }),
- z.object({ type: z.literal(DynamicSecretProviders.OAuth), inputs: DynamicSecretOAuthSchema })
+ z.object({ type: z.literal(DynamicSecretProviders.OAuth2), inputs: DynamicSecretOAuth2Schema })
]);
// Extended metadata passed to a provider's create() call. When the project
diff --git a/backend/src/ee/services/dynamic-secret/providers/oauth.test.ts b/backend/src/ee/services/dynamic-secret/providers/oauth2.test.ts
similarity index 78%
rename from backend/src/ee/services/dynamic-secret/providers/oauth.test.ts
rename to backend/src/ee/services/dynamic-secret/providers/oauth2.test.ts
index 37c4a37a5e..978b53cab3 100644
--- a/backend/src/ee/services/dynamic-secret/providers/oauth.test.ts
+++ b/backend/src/ee/services/dynamic-secret/providers/oauth2.test.ts
@@ -5,8 +5,8 @@ import { TDynamicSecrets } from "@app/db/schemas";
import { BadRequestError } from "@app/lib/errors";
import { safeRequest } from "@app/lib/validator";
-import { DynamicSecretOAuthSchema, OAuthClientAuthMethod, OAuthGrantType } from "./models";
-import { OAuthProvider } from "./oauth";
+import { DynamicSecretOAuth2Schema, OAuth2ClientAuthMethod, OAuth2GrantType } from "./models";
+import { OAuth2Provider } from "./oauth2";
const { appConfig } = vi.hoisted(() => ({ appConfig: { isDevelopmentMode: false } }));
@@ -33,11 +33,11 @@ const TOKEN_URL = "https://auth.example.com/oauth2/token";
const REVOCATION_URL = "https://auth.example.com/oauth2/revoke";
const baseInputs = {
- grantType: OAuthGrantType.ClientCredentials,
+ grantType: OAuth2GrantType.ClientCredentials,
tokenUrl: TOKEN_URL,
revocationUrl: REVOCATION_URL,
clientId: "infisical-client",
- clientAuth: { method: OAuthClientAuthMethod.ClientSecretBasic, clientSecret: "super-secret-value" },
+ clientAuth: { method: OAuth2ClientAuthMethod.ClientSecretBasic, clientSecret: "super-secret-value" },
extraParams: []
};
@@ -80,18 +80,18 @@ const callAt = (index: number) => {
};
};
-describe("OAuth dynamic secret schema", () => {
+describe("OAuth 2.0 dynamic secret schema", () => {
test("normalizes scope by splitting on whitespace and removing duplicates", () => {
- const parsed = DynamicSecretOAuthSchema.parse({ ...baseInputs, scope: " read write\tread " });
+ const parsed = DynamicSecretOAuth2Schema.parse({ ...baseInputs, scope: " read write\tread " });
expect(parsed.scope).toBe("read write");
});
test("treats a blank scope as unset", () => {
- expect(DynamicSecretOAuthSchema.parse({ ...baseInputs, scope: " " }).scope).toBeUndefined();
+ expect(DynamicSecretOAuth2Schema.parse({ ...baseInputs, scope: " " }).scope).toBeUndefined();
});
test("rejects scope tokens with characters outside RFC 6749 section 3.3", () => {
- expect(() => DynamicSecretOAuthSchema.parse({ ...baseInputs, scope: 'read "write"' })).toThrow(
+ expect(() => DynamicSecretOAuth2Schema.parse({ ...baseInputs, scope: 'read "write"' })).toThrow(
"Scope contains invalid characters"
);
});
@@ -99,7 +99,7 @@ describe("OAuth dynamic secret schema", () => {
test.each(["grant_type", "scope", "client_id", "client_secret", "client_assertion", "Client_Assertion_Type"])(
"rejects the reserved extra parameter %s",
(key) => {
- expect(() => DynamicSecretOAuthSchema.parse({ ...baseInputs, extraParams: [{ key, value: "x" }] })).toThrow(
+ expect(() => DynamicSecretOAuth2Schema.parse({ ...baseInputs, extraParams: [{ key, value: "x" }] })).toThrow(
"can't be used as an extra parameter"
);
}
@@ -107,7 +107,7 @@ describe("OAuth dynamic secret schema", () => {
test("rejects duplicate and excessive extra parameters", () => {
expect(() =>
- DynamicSecretOAuthSchema.parse({
+ DynamicSecretOAuth2Schema.parse({
...baseInputs,
extraParams: [
{ key: "audience", value: "a" },
@@ -117,7 +117,7 @@ describe("OAuth dynamic secret schema", () => {
).toThrow("set more than once");
expect(() =>
- DynamicSecretOAuthSchema.parse({
+ DynamicSecretOAuth2Schema.parse({
...baseInputs,
extraParams: Array.from({ length: 21 }, (_, index) => ({ key: `param${index}`, value: "x" }))
})
@@ -125,27 +125,30 @@ describe("OAuth dynamic secret schema", () => {
});
});
-describe("OAuthProvider.validateProviderInputs", () => {
+describe("OAuth2Provider.validateProviderInputs", () => {
beforeEach(() => {
appConfig.isDevelopmentMode = false;
});
test("rejects http URLs outside development mode", async () => {
await expect(
- OAuthProvider().validateProviderInputs({ ...baseInputs, tokenUrl: "http://auth.example.com/token" }, metadata)
+ OAuth2Provider().validateProviderInputs({ ...baseInputs, tokenUrl: "http://auth.example.com/token" }, metadata)
).rejects.toThrow("Token URL must use https");
});
test("allows http URLs in development mode", async () => {
appConfig.isDevelopmentMode = true;
await expect(
- OAuthProvider().validateProviderInputs({ ...baseInputs, revocationUrl: "http://localhost:8080/revoke" }, metadata)
+ OAuth2Provider().validateProviderInputs(
+ { ...baseInputs, revocationUrl: "http://localhost:8080/revoke" },
+ metadata
+ )
).resolves.toMatchObject({ revocationUrl: "http://localhost:8080/revoke" });
});
test("rejects a token URL change while leases are active", async () => {
await expect(
- OAuthProvider().validateProviderInputs(
+ OAuth2Provider().validateProviderInputs(
{ ...baseInputs, tokenUrl: "https://other.example.com/token" },
{ ...metadata, previousInputs: baseInputs, hasActiveLeases: true }
)
@@ -154,7 +157,7 @@ describe("OAuthProvider.validateProviderInputs", () => {
test("rejects a client ID change while leases are active", async () => {
await expect(
- OAuthProvider().validateProviderInputs(
+ OAuth2Provider().validateProviderInputs(
{ ...baseInputs, clientId: "rotated-client" },
{ ...metadata, previousInputs: baseInputs, hasActiveLeases: true }
)
@@ -163,7 +166,7 @@ describe("OAuthProvider.validateProviderInputs", () => {
test("allows token URL and client ID changes when there are no leases", async () => {
await expect(
- OAuthProvider().validateProviderInputs(
+ OAuth2Provider().validateProviderInputs(
{ ...baseInputs, tokenUrl: "https://other.example.com/token", clientId: "rotated-client" },
{ ...metadata, previousInputs: baseInputs, hasActiveLeases: false }
)
@@ -172,11 +175,11 @@ describe("OAuthProvider.validateProviderInputs", () => {
test("allows rotating the secret, auth method and revocation URL while leases are active", async () => {
await expect(
- OAuthProvider().validateProviderInputs(
+ OAuth2Provider().validateProviderInputs(
{
...baseInputs,
revocationUrl: "https://auth.example.com/oauth2/v2/revoke",
- clientAuth: { method: OAuthClientAuthMethod.ClientSecretPost, clientSecret: "rotated-secret" }
+ clientAuth: { method: OAuth2ClientAuthMethod.ClientSecretPost, clientSecret: "rotated-secret" }
},
{ ...metadata, previousInputs: baseInputs, hasActiveLeases: true }
)
@@ -184,7 +187,7 @@ describe("OAuthProvider.validateProviderInputs", () => {
});
});
-describe("OAuthProvider token request", () => {
+describe("OAuth2Provider token request", () => {
beforeEach(() => {
mockedPost.mockReset();
appConfig.isDevelopmentMode = false;
@@ -193,11 +196,11 @@ describe("OAuthProvider token request", () => {
test("form-urlencodes client credentials before base64 encoding them", async () => {
mockedPost.mockResolvedValueOnce(tokenResponse({ access_token: "opaque-access-token" }));
- await OAuthProvider().create(
+ await OAuth2Provider().create(
createArgs(Date.now() + 60_000, {
...baseInputs,
clientId: "my client",
- clientAuth: { method: OAuthClientAuthMethod.ClientSecretBasic, clientSecret: "p+s%:w" }
+ clientAuth: { method: OAuth2ClientAuthMethod.ClientSecretBasic, clientSecret: "p+s%:w" }
})
);
@@ -207,10 +210,10 @@ describe("OAuthProvider token request", () => {
test("sends client credentials in the body without an Authorization header for client_secret_post", async () => {
mockedPost.mockResolvedValueOnce(tokenResponse({ access_token: "opaque-access-token" }));
- await OAuthProvider().create(
+ await OAuth2Provider().create(
createArgs(Date.now() + 60_000, {
...baseInputs,
- clientAuth: { method: OAuthClientAuthMethod.ClientSecretPost, clientSecret: "p+s%:w" }
+ clientAuth: { method: OAuth2ClientAuthMethod.ClientSecretPost, clientSecret: "p+s%:w" }
})
);
@@ -226,7 +229,7 @@ describe("OAuthProvider token request", () => {
test("sends grant_type, normalized scope and extra params with retries disabled", async () => {
mockedPost.mockResolvedValueOnce(tokenResponse({ access_token: "opaque-access-token" }));
- await OAuthProvider().create(
+ await OAuth2Provider().create(
createArgs(Date.now() + 60_000, {
...baseInputs,
scope: "read write read",
@@ -252,7 +255,7 @@ describe("OAuthProvider token request", () => {
);
const before = Date.now();
- const { entityId, data } = await OAuthProvider().create(createArgs(Date.now() + 60_000));
+ const { entityId, data } = await OAuth2Provider().create(createArgs(Date.now() + 60_000));
expect(entityId).toHaveLength(32);
const leaseData = data as Record<string, string>;
@@ -266,7 +269,7 @@ describe("OAuthProvider token request", () => {
const exp = Math.floor(Date.now() / 1000) + 1800;
mockedPost.mockResolvedValueOnce(tokenResponse({ access_token: jwtWithExp(exp) }));
- const { data } = await OAuthProvider().create(createArgs(Date.now() + 60_000));
+ const { data } = await OAuth2Provider().create(createArgs(Date.now() + 60_000));
expect((data as Record<string, string>).EXPIRES_AT).toBe(new Date(exp * 1000).toISOString());
});
@@ -274,7 +277,7 @@ describe("OAuthProvider token request", () => {
test("skips the TTL check when the lifetime is unknown", async () => {
mockedPost.mockResolvedValueOnce(tokenResponse({ access_token: "opaque-access-token" }));
- const { data } = await OAuthProvider().create(createArgs(Date.now() + 365 * 24 * 3_600_000));
+ const { data } = await OAuth2Provider().create(createArgs(Date.now() + 365 * 24 * 3_600_000));
expect(data).not.toHaveProperty("EXPIRES_AT");
expect(mockedPost).toHaveBeenCalledOnce();
@@ -283,7 +286,7 @@ describe("OAuthProvider token request", () => {
test("accepts a lease TTL within the 60s clock skew tolerance", async () => {
mockedPost.mockResolvedValueOnce(tokenResponse({ access_token: "opaque-access-token", expires_in: 3599 }));
- await expect(OAuthProvider().create(createArgs(Date.now() + 3_600_000))).resolves.toBeDefined();
+ await expect(OAuth2Provider().create(createArgs(Date.now() + 3_600_000))).resolves.toBeDefined();
});
test("rejects a lease TTL longer than the token lifetime and revokes the token", async () => {
@@ -291,7 +294,7 @@ describe("OAuthProvider token request", () => {
.mockResolvedValueOnce(tokenResponse({ access_token: "opaque-access-token", expires_in: 1800 }))
.mockResolvedValueOnce(tokenResponse(""));
- await expect(OAuthProvider().create(createArgs(Date.now() + 3_600_000))).rejects.toThrow(
+ await expect(OAuth2Provider().create(createArgs(Date.now() + 3_600_000))).rejects.toThrow(
/lease TTL \(3600s\) is longer than the lifetime of the access tokens the authorization server issues \(1800s\)/
);
@@ -309,7 +312,7 @@ describe("OAuthProvider token request", () => {
})
);
- const result = OAuthProvider().create(createArgs(Date.now() + 60_000));
+ const result = OAuth2Provider().create(createArgs(Date.now() + 60_000));
await expect(result).rejects.toBeInstanceOf(BadRequestError);
await expect(result).rejects.toThrow(/rejected the token request: invalid_client: Client authentication failed/);
@@ -321,10 +324,10 @@ describe("OAuthProvider token request", () => {
upstreamError(401, { error: "invalid_client", error_description: "bad secret p+s (sent as p%2Bs)" })
);
- const result = OAuthProvider().create(
+ const result = OAuth2Provider().create(
createArgs(Date.now() + 60_000, {
...baseInputs,
- clientAuth: { method: OAuthClientAuthMethod.ClientSecretBasic, clientSecret: "p+s" }
+ clientAuth: { method: OAuth2ClientAuthMethod.ClientSecretBasic, clientSecret: "p+s" }
})
);
@@ -334,11 +337,11 @@ describe("OAuthProvider token request", () => {
test("rejects a token response without an access_token", async () => {
mockedPost.mockResolvedValueOnce(tokenResponse({ token_type: "Bearer" }));
- await expect(OAuthProvider().create(createArgs(Date.now() + 60_000))).rejects.toThrow("without an access_token");
+ await expect(OAuth2Provider().create(createArgs(Date.now() + 60_000))).rejects.toThrow("without an access_token");
});
});
-describe("OAuthProvider.revoke", () => {
+describe("OAuth2Provider.revoke", () => {
beforeEach(() => {
mockedPost.mockReset();
});
@@ -346,7 +349,7 @@ describe("OAuthProvider.revoke", () => {
test("posts the stored token to the revocation endpoint with an access_token hint", async () => {
mockedPost.mockResolvedValueOnce(tokenResponse(""));
- await OAuthProvider().revoke(baseInputs, "entity-1", { ...metadata, leaseData: { ACCESS_TOKEN: "stored-token" } });
+ await OAuth2Provider().revoke(baseInputs, "entity-1", { ...metadata, leaseData: { ACCESS_TOKEN: "stored-token" } });
const { url, body, options } = callAt(0);
expect(url).toBe(REVOCATION_URL);
@@ -358,8 +361,8 @@ describe("OAuthProvider.revoke", () => {
test("authenticates the revocation request the same way as the token request for client_secret_post", async () => {
mockedPost.mockResolvedValueOnce(tokenResponse(""));
- await OAuthProvider().revoke(
- { ...baseInputs, clientAuth: { method: OAuthClientAuthMethod.ClientSecretPost, clientSecret: "post-secret" } },
+ await OAuth2Provider().revoke(
+ { ...baseInputs, clientAuth: { method: OAuth2ClientAuthMethod.ClientSecretPost, clientSecret: "post-secret" } },
"entity-1",
{ ...metadata, leaseData: { ACCESS_TOKEN: "stored-token" } }
);
@@ -379,10 +382,10 @@ describe("OAuthProvider.revoke", () => {
upstreamError(401, { error: "invalid_client", error_description: "unknown secret post-secret-value" })
);
- const result = OAuthProvider().revoke(
+ const result = OAuth2Provider().revoke(
{
...baseInputs,
- clientAuth: { method: OAuthClientAuthMethod.ClientSecretPost, clientSecret: "post-secret-value" }
+ clientAuth: { method: OAuth2ClientAuthMethod.ClientSecretPost, clientSecret: "post-secret-value" }
},
"entity-1",
{ ...metadata, leaseData: { ACCESS_TOKEN: "stored-token" } }
@@ -394,7 +397,7 @@ describe("OAuthProvider.revoke", () => {
test("rejects an unknown client auth method", async () => {
await expect(
- OAuthProvider().revoke(
+ OAuth2Provider().revoke(
{ ...baseInputs, clientAuth: { method: "private_key_jwt", privateKey: "key" } },
"entity-1",
{ ...metadata, leaseData: { ACCESS_TOKEN: "stored-token" } }
@@ -404,7 +407,7 @@ describe("OAuthProvider.revoke", () => {
});
test("throws a readable error when the lease has no stored token", async () => {
- await expect(OAuthProvider().revoke(baseInputs, "entity-1", metadata)).rejects.toThrow(
+ await expect(OAuth2Provider().revoke(baseInputs, "entity-1", metadata)).rejects.toThrow(
"This lease has no stored access token"
);
expect(mockedPost).not.toHaveBeenCalled();
@@ -416,7 +419,7 @@ describe("OAuthProvider.revoke", () => {
upstreamError(400, { error: "invalid_request", error_description: `bad token ${accessToken}` })
);
- const result = OAuthProvider().revoke(baseInputs, "entity-1", {
+ const result = OAuth2Provider().revoke(baseInputs, "entity-1", {
...metadata,
leaseData: { ACCESS_TOKEN: accessToken }
});
@@ -426,7 +429,7 @@ describe("OAuthProvider.revoke", () => {
});
});
-describe("OAuthProvider.validateConnection", () => {
+describe("OAuth2Provider.validateConnection", () => {
beforeEach(() => {
mockedPost.mockReset();
});
@@ -437,7 +440,7 @@ describe("OAuthProvider.validateConnection", () => {
.mockResolvedValueOnce(tokenResponse(""));
await expect(
- OAuthProvider().validateConnection(baseInputs, { ...metadata, defaultTTL: "30m", maxTTL: "1h" })
+ OAuth2Provider().validateConnection(baseInputs, { ...metadata, defaultTTL: "30m", maxTTL: "1h" })
).resolves.toBe(true);
expect(callAt(1).url).toBe(REVOCATION_URL);
@@ -450,7 +453,7 @@ describe("OAuthProvider.validateConnection", () => {
.mockResolvedValueOnce(tokenResponse(""));
await expect(
- OAuthProvider().validateConnection(baseInputs, { ...metadata, defaultTTL: "30m", maxTTL: "2h" })
+ OAuth2Provider().validateConnection(baseInputs, { ...metadata, defaultTTL: "30m", maxTTL: "2h" })
).rejects.toThrow(/max TTL \(7200s\)/);
expect(callAt(1).url).toBe(REVOCATION_URL);
});
@@ -460,16 +463,16 @@ describe("OAuthProvider.validateConnection", () => {
.mockResolvedValueOnce(tokenResponse({ access_token: "test-token", expires_in: 3600 }))
.mockRejectedValueOnce(upstreamError(400, { error: "unsupported_token_type" }));
- await expect(OAuthProvider().validateConnection(baseInputs, { ...metadata, defaultTTL: "30m" })).rejects.toThrow(
+ await expect(OAuth2Provider().validateConnection(baseInputs, { ...metadata, defaultTTL: "30m" })).rejects.toThrow(
/couldn't revoke it.*doesn't support revoking access tokens \(unsupported_token_type\)/
);
});
});
-describe("OAuthProvider.renew", () => {
+describe("OAuth2Provider.renew", () => {
test("is not supported", async () => {
- await expect(OAuthProvider().renew(baseInputs, "entity-1", Date.now(), metadata)).rejects.toThrow(
- "OAuth access tokens can't be extended"
+ await expect(OAuth2Provider().renew(baseInputs, "entity-1", Date.now(), metadata)).rejects.toThrow(
+ "OAuth 2.0 access tokens can't be extended"
);
});
});
diff --git a/backend/src/ee/services/dynamic-secret/providers/oauth.ts b/backend/src/ee/services/dynamic-secret/providers/oauth2.ts
similarity index 89%
rename from backend/src/ee/services/dynamic-secret/providers/oauth.ts
rename to backend/src/ee/services/dynamic-secret/providers/oauth2.ts
index 265a0e17b0..8ba87a68f0 100644
--- a/backend/src/ee/services/dynamic-secret/providers/oauth.ts
+++ b/backend/src/ee/services/dynamic-secret/providers/oauth2.ts
@@ -11,13 +11,13 @@ import { alphaNumericNanoId } from "@app/lib/nanoid";
import { safeRequest } from "@app/lib/validator";
import {
- DynamicSecretOAuthSchema,
- OAuthClientAuthMethod,
+ DynamicSecretOAuth2Schema,
+ OAuth2ClientAuthMethod,
TDynamicProviderFns,
TDynamicProviderValidateMetadata
} from "./models";
-type TOAuthProviderInputs = z.infer<typeof DynamicSecretOAuthSchema>;
+type TOAuth2ProviderInputs = z.infer<typeof DynamicSecretOAuth2Schema>;
type TIssuedToken = {
accessToken: string;
@@ -34,14 +34,14 @@ const TTL_TOLERANCE_MS = 60_000;
const MAX_UPSTREAM_ERROR_LENGTH = 300;
const MIN_LITERAL_IDENTIFIER_REDACTION_LENGTH = 8;
-const OAuthTokenResponseSchema = z.object({
+const OAuth2TokenResponseSchema = z.object({
access_token: z.string().min(1),
token_type: z.string().optional(),
scope: z.string().optional(),
expires_in: z.union([z.number(), z.string()]).optional()
});
-const OAuthLeaseDataSchema = z.object({
+const OAuth2LeaseDataSchema = z.object({
ACCESS_TOKEN: z.string().min(1)
});
@@ -50,24 +50,24 @@ const formEncode = (value: string) => new URLSearchParams([["", value]]).toStrin
// RFC 7009 section 2.1 requires the revocation request to authenticate the same way as the token request,
// so both go through here; it adds body parameters in place and returns any headers to send
-const applyClientAuth = ({ clientId, clientAuth }: TOAuthProviderInputs, body: URLSearchParams) => {
+const applyClientAuth = ({ clientId, clientAuth }: TOAuth2ProviderInputs, body: URLSearchParams) => {
switch (clientAuth.method) {
- case OAuthClientAuthMethod.ClientSecretBasic:
+ case OAuth2ClientAuthMethod.ClientSecretBasic:
return {
Authorization: `Basic ${Buffer.from(`${formEncode(clientId)}:${formEncode(clientAuth.clientSecret)}`).toString("base64")}`
};
- case OAuthClientAuthMethod.ClientSecretPost:
+ case OAuth2ClientAuthMethod.ClientSecretPost:
body.set("client_id", clientId);
body.set("client_secret", clientAuth.clientSecret);
return {};
default: {
const exhaustiveCheck: never = clientAuth;
- throw new Error(`Unhandled OAuth client auth method: ${JSON.stringify(exhaustiveCheck)}`);
+ throw new Error(`Unhandled OAuth 2.0 client auth method: ${JSON.stringify(exhaustiveCheck)}`);
}
}
};
-const getRedactionTargets = ({ clientId, clientAuth }: TOAuthProviderInputs, accessToken?: string) => ({
+const getRedactionTargets = ({ clientId, clientAuth }: TOAuth2ProviderInputs, accessToken?: string) => ({
secrets: [clientAuth.clientSecret, accessToken],
identifiers: [clientId]
});
@@ -149,9 +149,9 @@ const resolveExpiresAt = (accessToken: string, expiresIn: number | string | unde
return null;
};
-export const OAuthProvider = (): TDynamicProviderFns => {
+export const OAuth2Provider = (): TDynamicProviderFns => {
const $parseInputs = async (inputs: unknown) => {
- const providerInputs = await DynamicSecretOAuthSchema.parseAsync(inputs);
+ const providerInputs = await DynamicSecretOAuth2Schema.parseAsync(inputs);
assertSecureUrl(providerInputs.tokenUrl, "Token URL");
assertSecureUrl(providerInputs.revocationUrl, "Revocation URL");
return providerInputs;
@@ -184,7 +184,7 @@ export const OAuthProvider = (): TDynamicProviderFns => {
return providerInputs;
};
- const $requestToken = async (providerInputs: TOAuthProviderInputs): Promise<TIssuedToken> => {
+ const $requestToken = async (providerInputs: TOAuth2ProviderInputs): Promise<TIssuedToken> => {
const body = new URLSearchParams({ grant_type: "client_credentials" });
if (providerInputs.scope) body.set("scope", providerInputs.scope);
providerInputs.extraParams.forEach(({ key, value }) => body.set(key, value));
@@ -213,7 +213,7 @@ export const OAuthProvider = (): TDynamicProviderFns => {
});
}
- const parsed = OAuthTokenResponseSchema.safeParse(parseJsonBody(responseData));
+ const parsed = OAuth2TokenResponseSchema.safeParse(parseJsonBody(responseData));
if (!parsed.success) {
throw new BadRequestError({
message: `The authorization server at ${sanitizeUrlForLog(providerInputs.tokenUrl)} returned a token response without an access_token. Check that the token URL points to an OAuth 2.0 token endpoint.`
@@ -231,7 +231,7 @@ export const OAuthProvider = (): TDynamicProviderFns => {
};
};
- const $revokeToken = async (providerInputs: TOAuthProviderInputs, accessToken: string) => {
+ const $revokeToken = async (providerInputs: TOAuth2ProviderInputs, accessToken: string) => {
const body = new URLSearchParams({ token: accessToken, token_type_hint: "access_token" });
const authHeaders = applyClientAuth(providerInputs, body);
@@ -251,7 +251,7 @@ export const OAuthProvider = (): TDynamicProviderFns => {
if (code === "unsupported_token_type") {
throw new BadRequestError({
- message: `The authorization server at ${revocationUrl} doesn't support revoking access tokens (unsupported_token_type). The OAuth dynamic secret requires RFC 7009 access token revocation.`
+ message: `The authorization server at ${revocationUrl} doesn't support revoking access tokens (unsupported_token_type). The OAuth 2.0 dynamic secret requires RFC 7009 access token revocation.`
});
}
if (status === 503) {
@@ -276,12 +276,12 @@ export const OAuthProvider = (): TDynamicProviderFns => {
});
};
- const $revokeBestEffort = async (providerInputs: TOAuthProviderInputs, accessToken: string, reason: string) => {
+ const $revokeBestEffort = async (providerInputs: TOAuth2ProviderInputs, accessToken: string, reason: string) => {
try {
await $revokeToken(providerInputs, accessToken);
} catch (err) {
logger.warn(
- `OAuth dynamic secret: failed to revoke token after ${reason} [revocationUrl=${sanitizeUrlForLog(providerInputs.revocationUrl)}]: ${(err as Error)?.message}`
+ `OAuth 2.0 dynamic secret: failed to revoke token after ${reason} [revocationUrl=${sanitizeUrlForLog(providerInputs.revocationUrl)}]: ${(err as Error)?.message}`
);
}
};
@@ -337,7 +337,7 @@ export const OAuthProvider = (): TDynamicProviderFns => {
const revoke = async (inputs: unknown, entityId: string, metadata: { leaseData?: Record<string, string> }) => {
const providerInputs = await $parseInputs(inputs);
- const leaseData = OAuthLeaseDataSchema.safeParse(metadata.leaseData);
+ const leaseData = OAuth2LeaseDataSchema.safeParse(metadata.leaseData);
if (!leaseData.success) {
throw new BadRequestError({
message:
@@ -351,7 +351,7 @@ export const OAuthProvider = (): TDynamicProviderFns => {
const renew = async (): Promise<{ entityId: string }> => {
throw new BadRequestError({
- message: "OAuth access tokens can't be extended. Create a new lease to get a new token."
+ message: "OAuth 2.0 access tokens can't be extended. Create a new lease to get a new token."
});
};
diff --git a/backend/src/ee/services/dynamic-secret/providers/redact.test.ts b/backend/src/ee/services/dynamic-secret/providers/redact.test.ts
index 4fc5e20d7a..4b12bef9e7 100644
--- a/backend/src/ee/services/dynamic-secret/providers/redact.test.ts
+++ b/backend/src/ee/services/dynamic-secret/providers/redact.test.ts
@@ -2,15 +2,15 @@ import { describe, expect, test } from "vitest";
import { SshCertKeyAlgorithm } from "@app/lib/ssh";
-import { DynamicSecretProviders, OAuthClientAuthMethod, OAuthGrantType } from "./models";
+import { DynamicSecretProviders, OAuth2ClientAuthMethod, OAuth2GrantType } from "./models";
import { DYNAMIC_SECRET_SECRET_FIELDS, redactStoredInputs, restoreOmittedSecretFields } from "./redact";
-const oauthStoredInputs = {
- grantType: OAuthGrantType.ClientCredentials,
+const oauth2StoredInputs = {
+ grantType: OAuth2GrantType.ClientCredentials,
tokenUrl: "https://auth.example.com/token",
revocationUrl: "https://auth.example.com/revoke",
clientId: "client-id",
- clientAuth: { method: OAuthClientAuthMethod.ClientSecretPost, clientSecret: "stored-secret" },
+ clientAuth: { method: OAuth2ClientAuthMethod.ClientSecretPost, clientSecret: "stored-secret" },
extraParams: []
};
@@ -53,11 +53,11 @@ describe("redactStoredInputs", () => {
});
test("withholds a nested secret field and keeps its siblings", () => {
- const redacted = redactStoredInputs(DynamicSecretProviders.OAuth, oauthStoredInputs);
+ const redacted = redactStoredInputs(DynamicSecretProviders.OAuth2, oauth2StoredInputs);
expect(redacted).toStrictEqual({
- ...oauthStoredInputs,
- clientAuth: { method: OAuthClientAuthMethod.ClientSecretPost }
+ ...oauth2StoredInputs,
+ clientAuth: { method: OAuth2ClientAuthMethod.ClientSecretPost }
});
expect(JSON.stringify(redacted)).not.toContain("stored-secret");
});
@@ -65,24 +65,24 @@ describe("redactStoredInputs", () => {
describe("restoreOmittedSecretFields", () => {
test("restores a nested secret the edit left out", () => {
- const restored = restoreOmittedSecretFields(DynamicSecretProviders.OAuth, oauthStoredInputs, {
- ...oauthStoredInputs,
- clientAuth: { method: OAuthClientAuthMethod.ClientSecretBasic }
+ const restored = restoreOmittedSecretFields(DynamicSecretProviders.OAuth2, oauth2StoredInputs, {
+ ...oauth2StoredInputs,
+ clientAuth: { method: OAuth2ClientAuthMethod.ClientSecretBasic }
});
expect(restored).toStrictEqual({
- ...oauthStoredInputs,
- clientAuth: { method: OAuthClientAuthMethod.ClientSecretBasic, clientSecret: "stored-secret" }
+ ...oauth2StoredInputs,
+ clientAuth: { method: OAuth2ClientAuthMethod.ClientSecretBasic, clientSecret: "stored-secret" }
});
});
test("keeps a secret the edit supplied", () => {
const edited = {
- ...oauthStoredInputs,
- clientAuth: { method: OAuthClientAuthMethod.ClientSecretPost, clientSecret: "rotated-secret" }
+ ...oauth2StoredInputs,
+ clientAuth: { method: OAuth2ClientAuthMethod.ClientSecretPost, clientSecret: "rotated-secret" }
};
- expect(restoreOmittedSecretFields(DynamicSecretProviders.OAuth, oauthStoredInputs, edited)).toStrictEqual(edited);
+ expect(restoreOmittedSecretFields(DynamicSecretProviders.OAuth2, oauth2StoredInputs, edited)).toStrictEqual(edited);
});
test("leaves inputs untouched for a provider that declares no secret fields", () => {
diff --git a/backend/src/ee/services/dynamic-secret/providers/redact.ts b/backend/src/ee/services/dynamic-secret/providers/redact.ts
index 9c40c794f7..ea3ae8b405 100644
--- a/backend/src/ee/services/dynamic-secret/providers/redact.ts
+++ b/backend/src/ee/services/dynamic-secret/providers/redact.ts
@@ -28,7 +28,7 @@ export const DYNAMIC_SECRET_SECRET_FIELDS: Record<DynamicSecretProviders, readon
[DynamicSecretProviders.Milvus]: [],
[DynamicSecretProviders.IbmApiConnect]: [],
[DynamicSecretProviders.Tailscale]: [],
- [DynamicSecretProviders.OAuth]: ["clientAuth.clientSecret"]
+ [DynamicSecretProviders.OAuth2]: ["clientAuth.clientSecret"]
};
const isPlainObject = (value: unknown): value is Record<string, unknown> =>
diff --git a/docs/docs.json b/docs/docs.json
index 2a68bbed02..d2258617e7 100644
--- a/docs/docs.json
+++ b/docs/docs.json
@@ -385,7 +385,7 @@
"documentation/platform/dynamic-secrets/github",
"documentation/platform/dynamic-secrets/kubernetes",
"documentation/platform/dynamic-secrets/ldap",
- "documentation/platform/dynamic-secrets/oauth",
+ "documentation/platform/dynamic-secrets/oauth2",
"documentation/platform/dynamic-secrets/tailscale"
]
},
diff --git a/docs/documentation/platform/dynamic-secrets/oauth.mdx b/docs/documentation/platform/dynamic-secrets/oauth2.mdx
similarity index 100%
rename from docs/documentation/platform/dynamic-secrets/oauth.mdx
rename to docs/documentation/platform/dynamic-secrets/oauth2.mdx
diff --git a/docs/snippets/catalogs/dynamic-secrets.jsx b/docs/snippets/catalogs/dynamic-secrets.jsx
index 8e1c5c4ea7..40f98d935b 100644
--- a/docs/snippets/catalogs/dynamic-secrets.jsx
+++ b/docs/snippets/catalogs/dynamic-secrets.jsx
@@ -31,5 +31,5 @@ export const dynamicSecrets = [
{"name": "Milvus", "slug": "milvus", "path": "/documentation/platform/dynamic-secrets/milvus", "description": "Learn how to generate dynamic Milvus database credentials on-demand.", "category": "Databases"},
{"name": "Tailscale", "slug": "tailscale", "path": "/documentation/platform/dynamic-secrets/tailscale", "description": "Learn how to generate dynamic Tailscale credentials on-demand.", "category": "Authentication"},
{"name": "SSH", "slug": "ssh", "path": "/documentation/platform/dynamic-secrets/ssh", "description": "Learn how to generate dynamic SSH credentials on-demand.", "category": "Authentication"},
- {"name": "OAuth 2.0", "slug": "oauth", "path": "/documentation/platform/dynamic-secrets/oauth", "description": "Learn how to issue short-lived OAuth 2.0 access tokens on-demand.", "category": "Authentication"},
+ {"name": "OAuth 2.0", "slug": "oauth2", "path": "/documentation/platform/dynamic-secrets/oauth2", "description": "Learn how to issue short-lived OAuth 2.0 access tokens on-demand.", "category": "Authentication"},
];
diff --git a/frontend/src/components/dynamic-secrets/DynamicSecretProviderForm/oauth-contract.test.ts b/frontend/src/components/dynamic-secrets/DynamicSecretProviderForm/oauth2-contract.test.ts
similarity index 69%
rename from frontend/src/components/dynamic-secrets/DynamicSecretProviderForm/oauth-contract.test.ts
rename to frontend/src/components/dynamic-secrets/DynamicSecretProviderForm/oauth2-contract.test.ts
index e0caa9030a..c1389d3f26 100644
--- a/frontend/src/components/dynamic-secrets/DynamicSecretProviderForm/oauth-contract.test.ts
+++ b/frontend/src/components/dynamic-secrets/DynamicSecretProviderForm/oauth2-contract.test.ts
@@ -3,19 +3,19 @@ import { describe, it } from "vitest";
import {
DynamicSecretProviders,
- OAuthClientAuthMethod,
- OAuthGrantType
+ OAuth2ClientAuthMethod,
+ OAuth2GrantType
} from "@app/hooks/api/dynamicSecret/types";
import {
- getOAuthCreateDefaultValues,
- getOAuthCreatePayload,
- getOAuthEditDefaultValues,
- getOAuthEditPayload,
- OAUTH_CUSTOM_RENDERER_REASONS,
- oauthCreateFormSchema,
- oauthEditFormSchema
-} from "./providerDefinitions/oauthContract";
+ getOAuth2CreateDefaultValues,
+ getOAuth2CreatePayload,
+ getOAuth2EditDefaultValues,
+ getOAuth2EditPayload,
+ OAUTH2_CUSTOM_RENDERER_REASONS,
+ oauth2CreateFormSchema,
+ oauth2EditFormSchema
+} from "./providerDefinitions/oauth2Contract";
import { testDynamicSecretProviderContract } from "./providerContractTestHarness";
import type {
TCreateDynamicSecretProviderFormContext,
@@ -32,11 +32,11 @@ const createContext: TCreateDynamicSecretProviderFormContext = {
};
const storedInputs = {
- grantType: OAuthGrantType.ClientCredentials,
+ grantType: OAuth2GrantType.ClientCredentials,
tokenUrl: "https://auth.example.com/oauth2/token",
revocationUrl: "https://auth.example.com/oauth2/revoke",
clientId: "client-id",
- clientAuth: { method: OAuthClientAuthMethod.ClientSecretPost },
+ clientAuth: { method: OAuth2ClientAuthMethod.ClientSecretPost },
scope: "read write",
extraParams: [{ key: "audience", value: "https://api.example.com" }]
};
@@ -48,7 +48,7 @@ const editContext: TEditDynamicSecretProviderFormContext = {
dynamicSecret: {
id: "dynamic-secret-id",
name: "existing-secret",
- type: DynamicSecretProviders.OAuth,
+ type: DynamicSecretProviders.OAuth2,
createdAt: "2026-01-01",
updatedAt: "2026-01-01",
defaultTTL: "30m",
@@ -59,20 +59,20 @@ const editContext: TEditDynamicSecretProviderFormContext = {
const NoopRenderer = () => null;
-const oauthDynamicSecretProvider = defineDynamicSecretProvider({
- provider: DynamicSecretProviders.OAuth,
+const oauth2DynamicSecretProvider = defineDynamicSecretProvider({
+ provider: DynamicSecretProviders.OAuth2,
label: "OAuth 2.0",
- customRenderer: { reasons: OAUTH_CUSTOM_RENDERER_REASONS, Component: NoopRenderer },
+ customRenderer: { reasons: OAUTH2_CUSTOM_RENDERER_REASONS, Component: NoopRenderer },
create: {
- schema: oauthCreateFormSchema,
- getDefaultValues: getOAuthCreateDefaultValues,
- toPayload: getOAuthCreatePayload,
+ schema: oauth2CreateFormSchema,
+ getDefaultValues: getOAuth2CreateDefaultValues,
+ toPayload: getOAuth2CreatePayload,
submitLabel: "Submit"
},
edit: {
- schema: oauthEditFormSchema,
- getDefaultValues: getOAuthEditDefaultValues,
- toPayload: getOAuthEditPayload,
+ schema: oauth2EditFormSchema,
+ getDefaultValues: getOAuth2EditDefaultValues,
+ toPayload: getOAuth2EditPayload,
submitLabel: "Submit",
successMessage: "Successfully updated dynamic secret"
}
@@ -84,11 +84,11 @@ const createDefaults = {
maxTTL: "1h",
environment,
inputs: {
- grantType: OAuthGrantType.ClientCredentials,
+ grantType: OAuth2GrantType.ClientCredentials,
tokenUrl: "",
revocationUrl: "",
clientId: "",
- clientAuth: { method: OAuthClientAuthMethod.ClientSecretBasic, clientSecret: "" },
+ clientAuth: { method: OAuth2ClientAuthMethod.ClientSecretBasic, clientSecret: "" },
scope: "",
extraParams: []
}
@@ -96,39 +96,39 @@ const createDefaults = {
const createValues = {
...createDefaults,
- name: "oauth-secret",
+ name: "oauth2-secret",
inputs: {
...storedInputs,
- clientAuth: { method: OAuthClientAuthMethod.ClientSecretBasic, clientSecret: "client-secret" },
+ clientAuth: { method: OAuth2ClientAuthMethod.ClientSecretBasic, clientSecret: "client-secret" },
scope: " read write read "
}
};
const editValues = {
- name: "renamed-oauth-secret",
+ name: "renamed-oauth2-secret",
defaultTTL: "30m",
maxTTL: "1h",
inputs: {
...storedInputs,
- clientAuth: { method: OAuthClientAuthMethod.ClientSecretPost, clientSecret: "" },
+ clientAuth: { method: OAuth2ClientAuthMethod.ClientSecretPost, clientSecret: "" },
scope: ""
}
};
testDynamicSecretProviderContract({
name: "OAuth 2.0",
- definition: oauthDynamicSecretProvider,
+ definition: oauth2DynamicSecretProvider,
create: {
context: createContext,
defaultValues: createDefaults,
validValues: createValues,
payload: {
provider: {
- type: DynamicSecretProviders.OAuth,
+ type: DynamicSecretProviders.OAuth2,
inputs: {
...storedInputs,
clientAuth: {
- method: OAuthClientAuthMethod.ClientSecretBasic,
+ method: OAuth2ClientAuthMethod.ClientSecretBasic,
clientSecret: "client-secret"
},
scope: "read write"
@@ -136,7 +136,7 @@ testDynamicSecretProviderContract({
},
defaultTTL: "30m",
maxTTL: "1h",
- name: "oauth-secret",
+ name: "oauth2-secret",
path: "/folder",
projectSlug: "project",
environmentSlug: "dev"
@@ -153,7 +153,7 @@ testDynamicSecretProviderContract({
...createValues,
inputs: {
...createValues.inputs,
- clientAuth: { method: OAuthClientAuthMethod.ClientSecretBasic, clientSecret: "" }
+ clientAuth: { method: OAuth2ClientAuthMethod.ClientSecretBasic, clientSecret: "" }
}
},
issuePaths: [["inputs", "clientAuth", "clientSecret"]]
@@ -195,7 +195,7 @@ testDynamicSecretProviderContract({
maxTTL: "1h",
inputs: {
...storedInputs,
- clientAuth: { method: OAuthClientAuthMethod.ClientSecretPost, clientSecret: "" }
+ clientAuth: { method: OAuth2ClientAuthMethod.ClientSecretPost, clientSecret: "" }
}
},
validValues: editValues,
@@ -206,7 +206,7 @@ testDynamicSecretProviderContract({
environmentSlug: "dev",
data: {
inputs: { ...storedInputs, scope: "" },
- newName: "renamed-oauth-secret",
+ newName: "renamed-oauth2-secret",
defaultTTL: "30m",
maxTTL: "1h"
}
@@ -218,31 +218,31 @@ type TClientAuthPayload = { clientAuth: { method: string; clientSecret?: string
describe("OAuth 2.0 edit payload", () => {
it("omits a blank client secret so the stored one is kept", () => {
- const payload = getOAuthEditPayload(editValues, editContext);
+ const payload = getOAuth2EditPayload(editValues, editContext);
const { clientAuth } = payload.data.inputs as TClientAuthPayload;
- assert.deepEqual(clientAuth, { method: OAuthClientAuthMethod.ClientSecretPost });
+ assert.deepEqual(clientAuth, { method: OAuth2ClientAuthMethod.ClientSecretPost });
});
it("sends a new client secret and auth method when they change", () => {
- const payload = getOAuthEditPayload(
+ const payload = getOAuth2EditPayload(
{
...editValues,
inputs: {
...editValues.inputs,
- clientAuth: { method: OAuthClientAuthMethod.ClientSecretBasic, clientSecret: "rotated" }
+ clientAuth: { method: OAuth2ClientAuthMethod.ClientSecretBasic, clientSecret: "rotated" }
}
},
editContext
);
const { clientAuth } = payload.data.inputs as TClientAuthPayload;
assert.deepEqual(clientAuth, {
- method: OAuthClientAuthMethod.ClientSecretBasic,
+ method: OAuth2ClientAuthMethod.ClientSecretBasic,
clientSecret: "rotated"
});
});
it("hydrates the stored auth method on edit", () => {
- const defaults = getOAuthEditDefaultValues(editContext);
- assert.equal(defaults.inputs.clientAuth.method, OAuthClientAuthMethod.ClientSecretPost);
+ const defaults = getOAuth2EditDefaultValues(editContext);
+ assert.equal(defaults.inputs.clientAuth.method, OAuth2ClientAuthMethod.ClientSecretPost);
});
});
diff --git a/frontend/src/components/dynamic-secrets/DynamicSecretProviderForm/providerDefinitions/identityAccess.ts b/frontend/src/components/dynamic-secrets/DynamicSecretProviderForm/providerDefinitions/identityAccess.ts
index 9e7fb9ebeb..d97d78f447 100644
--- a/frontend/src/components/dynamic-secrets/DynamicSecretProviderForm/providerDefinitions/identityAccess.ts
+++ b/frontend/src/components/dynamic-secrets/DynamicSecretProviderForm/providerDefinitions/identityAccess.ts
@@ -8,7 +8,7 @@ import { gcpIamDynamicSecretProvider } from "./gcpIam";
import { githubDynamicSecretProvider } from "./github";
import { IDENTITY_ACCESS_DYNAMIC_SECRET_PROVIDERS } from "./identityAccessContract";
import { ldapDynamicSecretProvider } from "./ldap";
-import { oauthDynamicSecretProvider } from "./oauth";
+import { oauth2DynamicSecretProvider } from "./oauth2";
import { sshDynamicSecretProvider } from "./ssh";
import { tailscaleDynamicSecretProvider } from "./tailscale";
@@ -18,7 +18,7 @@ const definitionsByProvider = {
[DynamicSecretProviders.AzureEntraId]: azureEntraIdDynamicSecretProvider,
[DynamicSecretProviders.Github]: githubDynamicSecretProvider,
[DynamicSecretProviders.Tailscale]: tailscaleDynamicSecretProvider,
- [DynamicSecretProviders.OAuth]: oauthDynamicSecretProvider,
+ [DynamicSecretProviders.OAuth2]: oauth2DynamicSecretProvider,
[DynamicSecretProviders.Ssh]: sshDynamicSecretProvider,
[DynamicSecretProviders.Ldap]: ldapDynamicSecretProvider
} satisfies Record<
diff --git a/frontend/src/components/dynamic-secrets/DynamicSecretProviderForm/providerDefinitions/identityAccessContract.ts b/frontend/src/components/dynamic-secrets/DynamicSecretProviderForm/providerDefinitions/identityAccessContract.ts
index 7a32b44626..c0700bfeb3 100644
--- a/frontend/src/components/dynamic-secrets/DynamicSecretProviderForm/providerDefinitions/identityAccessContract.ts
+++ b/frontend/src/components/dynamic-secrets/DynamicSecretProviderForm/providerDefinitions/identityAccessContract.ts
@@ -7,7 +7,7 @@ export const IDENTITY_ACCESS_DYNAMIC_SECRET_PROVIDERS = [
DynamicSecretProviders.AzureEntraId,
DynamicSecretProviders.Github,
DynamicSecretProviders.Tailscale,
- DynamicSecretProviders.OAuth,
+ DynamicSecretProviders.OAuth2,
DynamicSecretProviders.Ssh,
DynamicSecretProviders.Ldap
] as const;
diff --git a/frontend/src/components/dynamic-secrets/DynamicSecretProviderForm/providerDefinitions/index.ts b/frontend/src/components/dynamic-secrets/DynamicSecretProviderForm/providerDefinitions/index.ts
index 487159a131..ddbc337279 100644
--- a/frontend/src/components/dynamic-secrets/DynamicSecretProviderForm/providerDefinitions/index.ts
+++ b/frontend/src/components/dynamic-secrets/DynamicSecretProviderForm/providerDefinitions/index.ts
@@ -7,7 +7,7 @@ export { identityAccessDynamicSecretProviders } from "./identityAccess";
export { IDENTITY_ACCESS_DYNAMIC_SECRET_PROVIDERS } from "./identityAccessContract";
export { ldapDynamicSecretProvider } from "./ldap";
export { managedStoresDynamicSecretProviders } from "./managedStores";
-export { oauthDynamicSecretProvider } from "./oauth";
+export { oauth2DynamicSecretProvider } from "./oauth2";
export { relationalWarehouseDynamicSecretProviders } from "./relationalWarehouse";
export { sshDynamicSecretProvider } from "./ssh";
export { sshDynamicSecretCreateBoundary, SshDynamicSecretCreateForm } from "./sshCreateForm";
diff --git a/frontend/src/components/dynamic-secrets/DynamicSecretProviderForm/providerDefinitions/oauth.tsx b/frontend/src/components/dynamic-secrets/DynamicSecretProviderForm/providerDefinitions/oauth2.tsx
similarity index 75%
rename from frontend/src/components/dynamic-secrets/DynamicSecretProviderForm/providerDefinitions/oauth.tsx
rename to frontend/src/components/dynamic-secrets/DynamicSecretProviderForm/providerDefinitions/oauth2.tsx
index e2692e0e29..f5c954d33a 100644
--- a/frontend/src/components/dynamic-secrets/DynamicSecretProviderForm/providerDefinitions/oauth.tsx
+++ b/frontend/src/components/dynamic-secrets/DynamicSecretProviderForm/providerDefinitions/oauth2.tsx
@@ -2,7 +2,7 @@ import { Controller, useFieldArray, useFormContext } from "react-hook-form";
import { PlusIcon, Trash2Icon } from "lucide-react";
import { Button, Field, FieldError, FieldLabel, IconButton, Input } from "@app/components/v3";
-import { DynamicSecretProviders, OAuthClientAuthMethod } from "@app/hooks/api/dynamicSecret/types";
+import { DynamicSecretProviders, OAuth2ClientAuthMethod } from "@app/hooks/api/dynamicSecret/types";
import { DynamicSecretProviderFields } from "../DynamicSecretProviderFields";
import { DynamicSecretProviderGroup } from "../DynamicSecretProviderGroup";
@@ -13,16 +13,16 @@ import {
TDynamicSecretProviderRendererProps
} from "../types";
import {
- getOAuthCreateDefaultValues,
- getOAuthCreatePayload,
- getOAuthEditDefaultValues,
- getOAuthEditPayload,
- OAUTH_CUSTOM_RENDERER_REASONS,
- OAUTH_MAX_EXTRA_PARAMS,
- oauthCreateFormSchema,
- oauthEditFormSchema,
- TOAuthEditFormValues
-} from "./oauthContract";
+ getOAuth2CreateDefaultValues,
+ getOAuth2CreatePayload,
+ getOAuth2EditDefaultValues,
+ getOAuth2EditPayload,
+ OAUTH2_CUSTOM_RENDERER_REASONS,
+ OAUTH2_MAX_EXTRA_PARAMS,
+ oauth2CreateFormSchema,
+ oauth2EditFormSchema,
+ TOAuth2EditFormValues
+} from "./oauth2Contract";
const getConnectionFields = (mode: TDynamicSecretProviderRendererProps["mode"]) =>
[
@@ -50,11 +50,11 @@ const getConnectionFields = (mode: TDynamicSecretProviderRendererProps["mode"])
options: [
{
label: "HTTP Basic Header",
- value: OAuthClientAuthMethod.ClientSecretBasic
+ value: OAuth2ClientAuthMethod.ClientSecretBasic
},
{
label: "Request Body",
- value: OAuthClientAuthMethod.ClientSecretPost
+ value: OAuth2ClientAuthMethod.ClientSecretPost
}
]
},
@@ -62,14 +62,14 @@ const getConnectionFields = (mode: TDynamicSecretProviderRendererProps["mode"])
name: "inputs.clientId",
type: "text",
label: "Client ID",
- placeholder: "Enter OAuth client ID",
+ placeholder: "Enter OAuth 2.0 client ID",
layout: "half"
},
{
name: "inputs.clientAuth.clientSecret",
type: "secret",
label: "Client Secret",
- placeholder: mode === "edit" ? "••••••••" : "Enter OAuth client secret",
+ placeholder: mode === "edit" ? "••••••••" : "Enter OAuth 2.0 client secret",
autoComplete: "new-password",
layout: "half",
...(mode === "edit"
@@ -84,20 +84,20 @@ const getConnectionFields = (mode: TDynamicSecretProviderRendererProps["mode"])
isOptional: true,
description: "Space-separated scopes. Leave blank to use the client's default scopes."
}
- ] satisfies readonly TDynamicSecretProviderField<TOAuthEditFormValues>[];
+ ] satisfies readonly TDynamicSecretProviderField<TOAuth2EditFormValues>[];
-const OAuthFields = ({ mode }: TDynamicSecretProviderRendererProps) => {
- const { control } = useFormContext<TOAuthEditFormValues>();
+const OAuth2Fields = ({ mode }: TDynamicSecretProviderRendererProps) => {
+ const { control } = useFormContext<TOAuth2EditFormValues>();
const extraParams = useFieldArray({ control, name: "inputs.extraParams" });
return (
<>
- <DynamicSecretProviderGroup id="oauth-configuration" presentation="panel">
- <DynamicSecretProviderFields<TOAuthEditFormValues> fields={getConnectionFields(mode)} />
+ <DynamicSecretProviderGroup id="oauth2-configuration" presentation="panel">
+ <DynamicSecretProviderFields<TOAuth2EditFormValues> fields={getConnectionFields(mode)} />
</DynamicSecretProviderGroup>
<DynamicSecretProviderGroup
- id="oauth-extra-params"
+ id="oauth2-extra-params"
presentation="panel"
surface
title="Extra Parameters"
@@ -115,7 +115,7 @@ const OAuthFields = ({ mode }: TDynamicSecretProviderRendererProps) => {
control={control}
name={`inputs.extraParams.${index}.${part}`}
render={({ field, fieldState: { error } }) => {
- const inputId = `oauth-extra-param-${index}-${part}`;
+ const inputId = `oauth2-extra-param-${index}-${part}`;
const errorId = `${inputId}-error`;
return (
@@ -155,7 +155,7 @@ const OAuthFields = ({ mode }: TDynamicSecretProviderRendererProps) => {
type="button"
size="sm"
className="self-start"
- isDisabled={extraParams.fields.length >= OAUTH_MAX_EXTRA_PARAMS}
+ isDisabled={extraParams.fields.length >= OAUTH2_MAX_EXTRA_PARAMS}
onClick={() => extraParams.append({ key: "", value: "" })}
>
<PlusIcon />
@@ -167,30 +167,30 @@ const OAuthFields = ({ mode }: TDynamicSecretProviderRendererProps) => {
);
};
-const oauthCommonFields: TDynamicSecretProviderCommonFields = {
+const oauth2CommonFields: TDynamicSecretProviderCommonFields = {
ttlDescription:
"TTLs must fit within the token lifetime the authorization server sets. They aren't checked if the server doesn't report a lifetime."
};
-export const oauthDynamicSecretProvider = defineDynamicSecretProvider({
- provider: DynamicSecretProviders.OAuth,
+export const oauth2DynamicSecretProvider = defineDynamicSecretProvider({
+ provider: DynamicSecretProviders.OAuth2,
label: "OAuth 2.0",
customRenderer: {
- reasons: OAUTH_CUSTOM_RENDERER_REASONS,
- Component: OAuthFields
+ reasons: OAUTH2_CUSTOM_RENDERER_REASONS,
+ Component: OAuth2Fields
},
create: {
- schema: oauthCreateFormSchema,
- getDefaultValues: getOAuthCreateDefaultValues,
- toPayload: getOAuthCreatePayload,
- commonFields: oauthCommonFields,
+ schema: oauth2CreateFormSchema,
+ getDefaultValues: getOAuth2CreateDefaultValues,
+ toPayload: getOAuth2CreatePayload,
+ commonFields: oauth2CommonFields,
submitLabel: "Submit"
},
edit: {
- schema: oauthEditFormSchema,
- getDefaultValues: getOAuthEditDefaultValues,
- toPayload: getOAuthEditPayload,
- commonFields: oauthCommonFields,
+ schema: oauth2EditFormSchema,
+ getDefaultValues: getOAuth2EditDefaultValues,
+ toPayload: getOAuth2EditPayload,
+ commonFields: oauth2CommonFields,
submitLabel: "Submit",
successMessage: "Successfully updated dynamic secret"
}
diff --git a/frontend/src/components/dynamic-secrets/DynamicSecretProviderForm/providerDefinitions/oauthContract.ts b/frontend/src/components/dynamic-secrets/DynamicSecretProviderForm/providerDefinitions/oauth2Contract.ts
similarity index 67%
rename from frontend/src/components/dynamic-secrets/DynamicSecretProviderForm/providerDefinitions/oauthContract.ts
rename to frontend/src/components/dynamic-secrets/DynamicSecretProviderForm/providerDefinitions/oauth2Contract.ts
index c3b029ea17..b169da9061 100644
--- a/frontend/src/components/dynamic-secrets/DynamicSecretProviderForm/providerDefinitions/oauthContract.ts
+++ b/frontend/src/components/dynamic-secrets/DynamicSecretProviderForm/providerDefinitions/oauth2Contract.ts
@@ -3,8 +3,8 @@ import { z } from "zod";
import {
DynamicSecretProviders,
- OAuthClientAuthMethod,
- OAuthGrantType,
+ OAuth2ClientAuthMethod,
+ OAuth2GrantType,
TDynamicSecretProvider,
TUpdateDynamicSecretDTO
} from "@app/hooks/api/dynamicSecret/types";
@@ -20,11 +20,11 @@ import {
TEditDynamicSecretProviderFormContext
} from "../types";
-export const OAUTH_CUSTOM_RENDERER_REASONS = ["repeatable-fields"] as const;
-export const OAUTH_MAX_EXTRA_PARAMS = 20;
+export const OAUTH2_CUSTOM_RENDERER_REASONS = ["repeatable-fields"] as const;
+export const OAUTH2_MAX_EXTRA_PARAMS = 20;
-// keep in sync with OAUTH_RESERVED_PARAMS in backend/src/ee/services/dynamic-secret/providers/models.ts
-const OAUTH_RESERVED_PARAMS = new Set([
+// keep in sync with OAUTH2_RESERVED_PARAMS in backend/src/ee/services/dynamic-secret/providers/models.ts
+const OAUTH2_RESERVED_PARAMS = new Set([
"grant_type",
"scope",
"client_id",
@@ -35,12 +35,12 @@ const OAUTH_RESERVED_PARAMS = new Set([
const SCOPE_TOKEN_REGEX = /^[\x21\x23-\x5B\x5D-\x7E]+$/;
const PARAM_KEY_REGEX = /^[A-Za-z0-9._~:[\]-]+$/;
-type TOAuthInputs = Extract<
+type TOAuth2Inputs = Extract<
TDynamicSecretProvider,
- { type: DynamicSecretProviders.OAuth }
+ { type: DynamicSecretProviders.OAuth2 }
>["inputs"];
-export const normalizeOAuthScope = (scope?: string) =>
+export const normalizeOAuth2Scope = (scope?: string) =>
[...new Set((scope ?? "").split(/\s+/).filter(Boolean))].join(" ");
const urlSchema = (label: string) =>
@@ -73,13 +73,13 @@ const extraParamsSchema = z
.max(128)
.regex(PARAM_KEY_REGEX, "Parameter name contains invalid characters")
.refine(
- (key) => !OAUTH_RESERVED_PARAMS.has(key.toLowerCase()),
+ (key) => !OAUTH2_RESERVED_PARAMS.has(key.toLowerCase()),
"Infisical sets this parameter"
),
value: z.string().trim().min(1, "Parameter value is required").max(2048)
})
)
- .max(OAUTH_MAX_EXTRA_PARAMS, `At most ${OAUTH_MAX_EXTRA_PARAMS} extra parameters are allowed`)
+ .max(OAUTH2_MAX_EXTRA_PARAMS, `At most ${OAUTH2_MAX_EXTRA_PARAMS} extra parameters are allowed`)
.superRefine((params, context) => {
const seen = new Set<string>();
params.forEach(({ key }, index) => {
@@ -94,8 +94,8 @@ const extraParamsSchema = z
});
});
-const oauthBaseInputs = {
- grantType: z.literal(OAuthGrantType.ClientCredentials),
+const oauth2BaseInputs = {
+ grantType: z.literal(OAuth2GrantType.ClientCredentials),
tokenUrl: urlSchema("Token URL"),
revocationUrl: urlSchema("Revocation URL"),
clientId: z.string().trim().min(1, "Client ID is required").max(1024),
@@ -105,26 +105,26 @@ const oauthBaseInputs = {
const makeClientAuthSchema = <T extends z.ZodTypeAny>(clientSecret: T) =>
z.discriminatedUnion("method", [
- z.object({ method: z.literal(OAuthClientAuthMethod.ClientSecretBasic), clientSecret }),
- z.object({ method: z.literal(OAuthClientAuthMethod.ClientSecretPost), clientSecret })
+ z.object({ method: z.literal(OAuth2ClientAuthMethod.ClientSecretBasic), clientSecret }),
+ z.object({ method: z.literal(OAuth2ClientAuthMethod.ClientSecretPost), clientSecret })
]);
-const oauthCreateInputsSchema = z.object({
- ...oauthBaseInputs,
+const oauth2CreateInputsSchema = z.object({
+ ...oauth2BaseInputs,
clientAuth: makeClientAuthSchema(z.string().trim().min(1, "Client secret is required").max(4096))
});
// the stored secret is never returned, so an empty value on edit keeps it
-const oauthEditInputsSchema = z.object({
- ...oauthBaseInputs,
+const oauth2EditInputsSchema = z.object({
+ ...oauth2BaseInputs,
clientAuth: makeClientAuthSchema(z.string().trim().max(4096).optional())
});
-export type TOAuthCreateFormValues = TDynamicSecretProviderFormValues<
- z.infer<typeof oauthCreateInputsSchema>
+export type TOAuth2CreateFormValues = TDynamicSecretProviderFormValues<
+ z.infer<typeof oauth2CreateInputsSchema>
>;
-export type TOAuthEditFormValues = TDynamicSecretProviderFormValues<
- z.infer<typeof oauthEditInputsSchema>
+export type TOAuth2EditFormValues = TDynamicSecretProviderFormValues<
+ z.infer<typeof oauth2EditInputsSchema>
>;
const withTtlOrder = <T extends z.ZodTypeAny>(schema: T) =>
@@ -139,47 +139,47 @@ const withTtlOrder = <T extends z.ZodTypeAny>(schema: T) =>
{ path: ["maxTTL"], message: "Max TTL must be greater than or equal to Default TTL" }
);
-export const oauthCreateFormSchema = withTtlOrder(
- createDynamicSecretProviderFormSchema(oauthCreateInputsSchema)
-) as z.ZodType<TOAuthCreateFormValues>;
+export const oauth2CreateFormSchema = withTtlOrder(
+ createDynamicSecretProviderFormSchema(oauth2CreateInputsSchema)
+) as z.ZodType<TOAuth2CreateFormValues>;
-export const oauthEditFormSchema = withTtlOrder(
- editDynamicSecretProviderFormSchema(oauthEditInputsSchema)
-) as z.ZodType<TOAuthEditFormValues>;
+export const oauth2EditFormSchema = withTtlOrder(
+ editDynamicSecretProviderFormSchema(oauth2EditInputsSchema)
+) as z.ZodType<TOAuth2EditFormValues>;
-export const getOAuthCreateDefaultValues = (
+export const getOAuth2CreateDefaultValues = (
context: TCreateDynamicSecretProviderFormContext
-): TOAuthCreateFormValues => ({
+): TOAuth2CreateFormValues => ({
name: "",
defaultTTL: "30m",
maxTTL: "1h",
environment: context.isSingleEnvironmentMode ? context.environments[0] : undefined,
inputs: {
- grantType: OAuthGrantType.ClientCredentials,
+ grantType: OAuth2GrantType.ClientCredentials,
tokenUrl: "",
revocationUrl: "",
clientId: "",
- clientAuth: { method: OAuthClientAuthMethod.ClientSecretBasic, clientSecret: "" },
+ clientAuth: { method: OAuth2ClientAuthMethod.ClientSecretBasic, clientSecret: "" },
scope: "",
extraParams: []
}
});
-export const getOAuthEditDefaultValues = (
+export const getOAuth2EditDefaultValues = (
context: TEditDynamicSecretProviderFormContext
-): TOAuthEditFormValues => {
- const inputs = context.dynamicSecret.inputs as Partial<TOAuthInputs>;
+): TOAuth2EditFormValues => {
+ const inputs = context.dynamicSecret.inputs as Partial<TOAuth2Inputs>;
return {
name: context.dynamicSecret.name,
defaultTTL: context.dynamicSecret.defaultTTL,
maxTTL: context.dynamicSecret.maxTTL,
inputs: {
- grantType: OAuthGrantType.ClientCredentials,
+ grantType: OAuth2GrantType.ClientCredentials,
tokenUrl: inputs.tokenUrl ?? "",
revocationUrl: inputs.revocationUrl ?? "",
clientId: inputs.clientId ?? "",
clientAuth: {
- method: inputs.clientAuth?.method ?? OAuthClientAuthMethod.ClientSecretBasic,
+ method: inputs.clientAuth?.method ?? OAuth2ClientAuthMethod.ClientSecretBasic,
clientSecret: ""
},
scope: inputs.scope ?? "",
@@ -188,10 +188,10 @@ export const getOAuthEditDefaultValues = (
};
};
-const buildInputs = (inputs: TOAuthEditFormValues["inputs"]) => {
+const buildInputs = (inputs: TOAuth2EditFormValues["inputs"]) => {
const clientSecret = inputs.clientAuth.clientSecret?.trim();
return {
- grantType: OAuthGrantType.ClientCredentials,
+ grantType: OAuth2GrantType.ClientCredentials,
tokenUrl: inputs.tokenUrl.trim(),
revocationUrl: inputs.revocationUrl.trim(),
clientId: inputs.clientId.trim(),
@@ -203,15 +203,15 @@ const buildInputs = (inputs: TOAuthEditFormValues["inputs"]) => {
} as const;
};
-export const getOAuthCreatePayload = (
- values: TOAuthCreateFormValues,
+export const getOAuth2CreatePayload = (
+ values: TOAuth2CreateFormValues,
context: TCreateDynamicSecretProviderFormContext
-): TCreateDynamicSecretProviderDTO<DynamicSecretProviders.OAuth> => ({
+): TCreateDynamicSecretProviderDTO<DynamicSecretProviders.OAuth2> => ({
provider: {
- type: DynamicSecretProviders.OAuth,
+ type: DynamicSecretProviders.OAuth2,
inputs: {
...buildInputs(values.inputs),
- scope: normalizeOAuthScope(values.inputs.scope) || undefined
+ scope: normalizeOAuth2Scope(values.inputs.scope) || undefined
}
},
defaultTTL: values.defaultTTL,
@@ -222,8 +222,8 @@ export const getOAuthCreatePayload = (
environmentSlug: values.environment?.slug ?? ""
});
-export const getOAuthEditPayload = (
- values: TOAuthEditFormValues,
+export const getOAuth2EditPayload = (
+ values: TOAuth2EditFormValues,
context: TEditDynamicSecretProviderFormContext
): TUpdateDynamicSecretDTO => ({
name: context.dynamicSecret.name,
@@ -232,7 +232,7 @@ export const getOAuthEditPayload = (
environmentSlug: context.environment,
data: {
// an omitted scope would keep the stored one, so a cleared scope is sent as ""
- inputs: { ...buildInputs(values.inputs), scope: normalizeOAuthScope(values.inputs.scope) },
+ inputs: { ...buildInputs(values.inputs), scope: normalizeOAuth2Scope(values.inputs.scope) },
newName: values.name === context.dynamicSecret.name ? undefined : values.name,
defaultTTL: values.defaultTTL,
maxTTL: values.maxTTL
diff --git a/frontend/src/components/dynamic-secrets/DynamicSecretProviderForm/registry.ts b/frontend/src/components/dynamic-secrets/DynamicSecretProviderForm/registry.ts
index cc50a3f0e8..c564437141 100644
--- a/frontend/src/components/dynamic-secrets/DynamicSecretProviderForm/registry.ts
+++ b/frontend/src/components/dynamic-secrets/DynamicSecretProviderForm/registry.ts
@@ -54,7 +54,7 @@ export const DYNAMIC_SECRET_PROVIDER_PICKER_ORDER = [
DynamicSecretProviders.Ssh,
DynamicSecretProviders.IbmApiConnect,
DynamicSecretProviders.Tailscale,
- DynamicSecretProviders.OAuth
+ DynamicSecretProviders.OAuth2
] as const satisfies readonly DynamicSecretProviders[];
const DYNAMIC_SECRET_PROVIDER_DOCS_SLUG: Partial<Record<DynamicSecretProviders, string>> = {
diff --git a/frontend/src/components/dynamic-secrets/DynamicSecretProviderForm/runtimeMetadata.test.ts b/frontend/src/components/dynamic-secrets/DynamicSecretProviderForm/runtimeMetadata.test.ts
index 7baf91d127..48ace2a462 100644
--- a/frontend/src/components/dynamic-secrets/DynamicSecretProviderForm/runtimeMetadata.test.ts
+++ b/frontend/src/components/dynamic-secrets/DynamicSecretProviderForm/runtimeMetadata.test.ts
@@ -50,7 +50,7 @@ describe("dynamic-secret provider runtime metadata", () => {
DynamicSecretProviders.Github,
DynamicSecretProviders.Ssh,
DynamicSecretProviders.Tailscale,
- DynamicSecretProviders.OAuth
+ DynamicSecretProviders.OAuth2
].forEach((provider) => {
assert.equal(
getDynamicSecretProviderRuntimeMetadata(provider).leaseCapabilities.supportsRenewal,
diff --git a/frontend/src/components/dynamic-secrets/DynamicSecretProviderForm/runtimeMetadata.ts b/frontend/src/components/dynamic-secrets/DynamicSecretProviderForm/runtimeMetadata.ts
index 18ea417e90..863441c790 100644
--- a/frontend/src/components/dynamic-secrets/DynamicSecretProviderForm/runtimeMetadata.ts
+++ b/frontend/src/components/dynamic-secrets/DynamicSecretProviderForm/runtimeMetadata.ts
@@ -247,8 +247,8 @@ const DYNAMIC_SECRET_PROVIDER_RUNTIME_METADATA = {
supportsRenewal: false
}
},
- [DynamicSecretProviders.OAuth]: {
- presentation: { providerFamily: "OAuth" },
+ [DynamicSecretProviders.OAuth2]: {
+ presentation: { providerFamily: "OAuth 2.0" },
leaseCapabilities: {
provisioner: "default",
output: oneTimeFields([
diff --git a/frontend/src/hooks/api/dynamicSecret/types.ts b/frontend/src/hooks/api/dynamicSecret/types.ts
index 2425aa5df1..4e177972b7 100644
--- a/frontend/src/hooks/api/dynamicSecret/types.ts
+++ b/frontend/src/hooks/api/dynamicSecret/types.ts
@@ -46,14 +46,14 @@ export enum DynamicSecretProviders {
Ssh = "ssh",
IbmApiConnect = "ibm-api-connect",
Tailscale = "tailscale",
- OAuth = "oauth"
+ OAuth2 = "oauth2"
}
-export enum OAuthGrantType {
+export enum OAuth2GrantType {
ClientCredentials = "client-credentials"
}
-export enum OAuthClientAuthMethod {
+export enum OAuth2ClientAuthMethod {
ClientSecretBasic = "client_secret_basic",
ClientSecretPost = "client_secret_post"
}
@@ -588,14 +588,14 @@ export type TDynamicSecretProvider =
};
}
| {
- type: DynamicSecretProviders.OAuth;
+ type: DynamicSecretProviders.OAuth2;
inputs: {
- grantType: OAuthGrantType.ClientCredentials;
+ grantType: OAuth2GrantType.ClientCredentials;
tokenUrl: string;
revocationUrl: string;
clientId: string;
clientAuth: {
- method: OAuthClientAuthMethod;
+ method: OAuth2ClientAuthMethod;
clientSecret?: string;
};
scope?: string;