Skip to content

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

feat(kafka): enforce random part in username templates for dynamic secrets

Dimitris Staratzis0e83c32f21f0
diff --git a/backend/src/ee/services/dynamic-secret/providers/kafka.test.ts b/backend/src/ee/services/dynamic-secret/providers/kafka.test.ts
index 867390cc60..f08e0651bf 100644
--- a/backend/src/ee/services/dynamic-secret/providers/kafka.test.ts
+++ b/backend/src/ee/services/dynamic-secret/providers/kafka.test.ts
@@ -323,10 +323,27 @@ describe("KafkaProvider.create", () => {
]);
});
+ test.each(["{{identity.name}}", "lease-user"])(
+ "refuses the username template %s, which has no random part",
+ async (usernameTemplate) => {
+ await expect(KafkaProvider().create(createArgs(baseInputs, usernameTemplate))).rejects.toThrow(
+ "username template has no random part"
+ );
+ expect(FakeConnection.instances).toHaveLength(0);
+ }
+ );
+
+ test.each(["{{randomUsername}}", "{{identity.name}}-{{random 8}}", "{{truncate randomUsername 12}}"])(
+ "accepts the username template %s",
+ async (usernameTemplate) => {
+ await expect(KafkaProvider().create(createArgs(baseInputs, usernameTemplate))).resolves.toBeDefined();
+ }
+ );
+
test.each([
["has SCRAM credentials", () => describeScramCredentials.mockResolvedValue({ results: [] } as never), undefined],
["has ACLs", () => describeAcls.mockResolvedValue({ resources: [{}] } as never), undefined],
- ["is the admin user", () => undefined, "admin"]
+ ["is the admin user", () => undefined, "admin{{random 0}}"]
])("refuses a username that %s without changing it", async (_case, setUp, usernameTemplate) => {
setUp();
diff --git a/backend/src/ee/services/dynamic-secret/providers/kafka.ts b/backend/src/ee/services/dynamic-secret/providers/kafka.ts
index d4b00951c0..9e8f6eebb2 100644
--- a/backend/src/ee/services/dynamic-secret/providers/kafka.ts
+++ b/backend/src/ee/services/dynamic-secret/providers/kafka.ts
@@ -47,6 +47,9 @@ const SCRAM_CREDENTIALS = [
{ mechanism: ScramMechanisms.SCRAM_SHA_512, digest: "sha512", keyLength: 64 }
] as const;
+// {{randomUsername}} or {{random N}}, on its own or inside a helper such as {{truncate randomUsername 12}}
+const RANDOM_TEMPLATE_PART = /{{[^}]*\b(?:randomUsername\b|random\s+\d)/;
+
const REQUIRED_APIS = [alterUserScramCredentialsV0.api, createAclsV3.api, deleteAclsV3.api];
const generatePassword = () => {
@@ -226,6 +229,14 @@ export const KafkaProvider = (): TDynamicProviderFns => {
dynamicSecret: TDynamicSecrets;
}) => {
const { inputs, usernameTemplate, identity, dynamicSecret } = data;
+ // A fixed name could match a user Infisical can't detect, such as a super user defined only in a broker's JAAS
+ // configuration, and the lease would take over that user's access
+ if (usernameTemplate && !RANDOM_TEMPLATE_PART.test(usernameTemplate)) {
+ throw new BadRequestError({
+ message:
+ "This dynamic secret's username template has no random part. Edit the dynamic secret and add one, such as {{randomUsername}} or {{random 8}}, so that each lease gets a new Kafka user."
+ });
+ }
const providerInputs = await validateProviderInputs(inputs);
const username = await generateUsername(usernameTemplate, {
diff --git a/docs/documentation/platform/dynamic-secrets/kafka.mdx b/docs/documentation/platform/dynamic-secrets/kafka.mdx
index 0d00098a3b..133e459934 100644
--- a/docs/documentation/platform/dynamic-secrets/kafka.mdx
+++ b/docs/documentation/platform/dynamic-secrets/kafka.mdx
@@ -75,9 +75,9 @@ Lease users log in with SCRAM-SHA-256 or SCRAM-SHA-512. To learn how leases work
<DynamicSecretUsernameTemplateParamField />
- <Warning>
- If you change the template, make sure it generates a different name for each lease, for example by including `{{randomUsername}}`. Infisical refuses a name that matches the admin user or a Kafka user with SCRAM credentials or ACLs, but it can't see users defined only in the brokers' JAAS configuration. If a lease gets the name of a super user defined there, the lease user has super user access.
- </Warning>
+ <Note>
+ The template must include a random part, such as `{{randomUsername}}` or `{{random 8}}` (for example, `{{identity.name}}-{{random 8}}`), so that each lease gets a new Kafka user. A fixed name could match a user that already exists, and the lease would take over that user's access.
+ </Note>
<ParamField path="Enable SSL" type="boolean" default="false">
Connect to the brokers over TLS. Turn this on if the listener uses `SASL_SSL`.
@@ -183,7 +183,7 @@ These examples show the ACLs to add in [Step 1](#step-1-create-the-dynamic-secre
The broker rejected the admin user's login. Check the **Password**, and check that the admin user has a credential for the **SASL Mechanism** you selected. For example, a user defined only in the brokers' JAAS configuration for PLAIN has no SCRAM credential.
</Accordion>
<Accordion title="A Kafka user with the generated username already exists">
- The username template generated the name of the admin user or of a Kafka user that already has SCRAM credentials or ACLs. Infisical doesn't change existing users, so change the **Username Template** to one that generates a different name for each lease, such as one that includes `{{randomUsername}}`.
+ The username template generated the name of the admin user or of a Kafka user that already has SCRAM credentials or ACLs, which can happen if the random part of the template is short. Infisical doesn't change existing users, so use a longer random part in the **Username Template**, such as `{{randomUsername}}`.
</Accordion>
<Accordion title="On a ZooKeeper cluster, Infisical can't connect to a broker you didn't add">
With ZooKeeper, only the controller broker accepts changes to SCRAM users, so Infisical connects to the controller at the address the controller advertises. Any broker can become the controller, so make sure Infisical can reach every broker's advertised address.
diff --git a/frontend/src/components/dynamic-secrets/DynamicSecretProviderForm/data-protocol-contract.test.ts b/frontend/src/components/dynamic-secrets/DynamicSecretProviderForm/data-protocol-contract.test.ts
index 57d4c23321..4b2a2be3d8 100644
--- a/frontend/src/components/dynamic-secrets/DynamicSecretProviderForm/data-protocol-contract.test.ts
+++ b/frontend/src/components/dynamic-secrets/DynamicSecretProviderForm/data-protocol-contract.test.ts
@@ -898,6 +898,11 @@ testDynamicSecretProviderContract({
inputs: { ...kafkaCreateValues.inputs, acls: [getDefaultKafkaAcl()] }
},
issuePaths: [["inputs", "acls", 0, "resourceName"]]
+ },
+ {
+ name: "username template has no random part",
+ values: { ...kafkaCreateValues, usernameTemplate: "{{identity.name}}" },
+ issuePaths: [["usernameTemplate"]]
}
]
},
diff --git a/frontend/src/components/dynamic-secrets/DynamicSecretProviderForm/providerDefinitions/kafkaContract.ts b/frontend/src/components/dynamic-secrets/DynamicSecretProviderForm/providerDefinitions/kafkaContract.ts
index e5684bf998..c3138f4ae2 100644
--- a/frontend/src/components/dynamic-secrets/DynamicSecretProviderForm/providerDefinitions/kafkaContract.ts
+++ b/frontend/src/components/dynamic-secrets/DynamicSecretProviderForm/providerDefinitions/kafkaContract.ts
@@ -66,11 +66,27 @@ export const kafkaEditInputsSchema = kafkaCreateInputsSchema.extend({
export type TKafkaFormInputs = z.input<typeof kafkaCreateInputsSchema>;
export type TKafkaFormValues = TDynamicSecretProviderFormValues<TKafkaFormInputs>;
+// Same rule as the backend's lease check: a fixed name could take over a Kafka user that already exists
+const RANDOM_TEMPLATE_PART = /{{[^}]*\b(?:randomUsername\b|random\s+\d)/;
+
+const kafkaUsernameTemplateSchema = z
+ .string()
+ .trim()
+ .nullable()
+ .optional()
+ .refine((template) => !template || RANDOM_TEMPLATE_PART.test(template), {
+ message:
+ "Include a random part, such as {{randomUsername}} or {{random 8}}, so that each lease gets a new Kafka user"
+ });
+
export const kafkaCreateFormSchema = createDynamicSecretProviderFormSchema(
- kafkaCreateInputsSchema
+ kafkaCreateInputsSchema,
+ {
+ usernameTemplateSchema: kafkaUsernameTemplateSchema
+ }
) as z.ZodType<TKafkaFormValues>;
export const kafkaEditFormSchema = editDynamicSecretProviderFormSchema(kafkaEditInputsSchema, {
- usernameTemplateSchema: z.string().trim().nullable().optional()
+ usernameTemplateSchema: kafkaUsernameTemplateSchema
}) as z.ZodType<TKafkaFormValues>;
export const getDefaultKafkaBootstrapServer = (): TKafkaFormInputs["bootstrapServers"][number] => ({