fix(spec): redact mongo CSFLE kmsProviders key material on datasource reads#13755

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
os-warren merged 1 commit into from
Aug 31, 2026
Merged

fix(spec): redact mongo CSFLE kmsProviders key material on datasource reads #13755

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions .changeset/csfle-kms-providers-redacted.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
---
"@objectstack/spec": patch
---

fix(spec): redact mongo CSFLE `kmsProviders` key material on datasource reads (#13602)

`redactDatasourceConfig('mongodb', …)` used to serve the CSFLE KMS secret material
inside the `options` passthrough back in cleartext with no `redactedKeys` entry:
`options.autoEncryption.kmsProviders.aws.secretAccessKey` (and `aws.sessionToken`),
`azure.clientSecret`, `gcp.privateKey`, and `local.key`. All five positions are now
on `passthroughSecretPaths`, measured against `mongodb@7.5.0` both with the optional
`mongodb-client-encryption` dependency installed (the client reads every leaf at
construction) and without it (construction throws `MongoMissingDependencyError`
before reading any of them). The same families' identity halves (`aws.accessKeyId`,
`azure.tenantId`/`clientId`, `gcp.email`) and unmeasured neighbours
(`kmip.endpoint`, `keyVaultNamespace`, `schemaMap`) stay served unchanged. An
untouched Save still round-trips byte-identically: `restoreRedactedConfig` mirrors
the redactor structurally, so the stored CSFLE config keeps working.
45 changes: 45 additions & 0 deletions packages/services/service-datasource/src/__tests__/datasource-config-redaction.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -442,6 +442,51 @@ describe('#9040 — the passthrough spelling, both halves at the service door',
expect((records[0].config!.options as any).auth.password).toBe('PLAINTEXT-IN-METADATA');
});

it('an untouched round-trip keeps a working CSFLE config byte-identical — every kmsProviders family', async () => {
// The #13602 round-trip question, answered at the door that owns it: the
// read path drops the KMS key material (measured read by mongodb@7.5.0
// with mongodb-client-encryption installed; loud MongoMissingDependencyError
// without it), and an untouched Save grafts every stored leaf back, so the
// config the connect path hands the client never changes. Without the
// restore, the served projection is NOT a working client config (measured:
// construction throws `Failed to parse KMS provider` for aws/azure/gcp) —
// which is exactly why the structural mirror must cover these rows.
const CSFLE_MONGO: StoredDatasource = {
name: 'csfle_mongo',
driver: 'mongodb',
origin: 'runtime',
config: {
url: 'mongodb://app@mongo.internal:27017/events',
options: {
autoEncryption: {
keyVaultNamespace: 'encryption.__keyVault',
kmsProviders: {
aws: { accessKeyId: 'AKIAFAKEFAKEFAKEFAKE', secretAccessKey: 'AWS-SECRET', sessionToken: 'AWS-SESSION' },
azure: { tenantId: 'tenant-id', clientId: 'client-id', clientSecret: 'AZURE-SECRET' },
gcp: { email: 'svc@example.iam.gserviceaccount.com', privateKey: 'R0NQLUtFWQ==' },
local: { key: 'TE9DQUwtS0VZ' },
},
},
},
},
};
const { service, records } = makeService([CSFLE_MONGO]);
const read = await service.getDatasource('csfle_mongo');
// Served: key material withheld, and said so; identity halves intact.
expect(JSON.stringify(read!.config)).not.toMatch(/AWS-SECRET|AWS-SESSION|AZURE-SECRET|R0NQLUtFWQ|TE9DQUwtS0VZ/);
expect(read!.redactedConfigKeys).toEqual([
'options.autoEncryption.kmsProviders.aws.secretAccessKey',
'options.autoEncryption.kmsProviders.aws.sessionToken',
'options.autoEncryption.kmsProviders.azure.clientSecret',
'options.autoEncryption.kmsProviders.gcp.privateKey',
'options.autoEncryption.kmsProviders.local.key',
]);
// Untouched Save: the stored row comes back byte-identical.
await service.updateDatasource('csfle_mongo', { config: read!.config, label: 'Renamed' });
expect(records[0].label).toBe('Renamed');
expect(records[0].config).toEqual(CSFLE_MONGO.config);
});

it('an author who deletes the `auth` block WINS — a removed container is never re-grafted', async () => {
const { service, records } = makeService([LEGACY_MONGO]);
const read = await service.getDatasource('legacy_mongo');
Expand Down
74 changes: 74 additions & 0 deletions packages/spec/src/data/datasource-credential-redaction.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -341,6 +341,80 @@ describe('passthrough secret redaction (#9040) — the nested spellings the key-
]);
});

it('drops CSFLE `kmsProviders` key material in every family, keeps the identity halves', () => {
// Measured against mongodb@7.5.0 BOTH ways the optional
// `mongodb-client-encryption` dependency can go: with it installed (7.2.1,
// inside the pin's ^7.2.0 optional-peer range) an instrumented constructor
// reads every one of these leaves (BSON-serialized into the native
// MongoCrypt); without it the same construction throws
// MongoMissingDependencyError before reading any of them. Either way a
// stored copy is decryption-capable material served in cleartext — the
// AWS_SESSION_TOKEN posture.
const { config, redactedKeys } = redactDatasourceConfig('mongodb', {
url: 'mongodb://app@mongo.internal:27017/events',
options: {
replicaSet: 'rs0',
autoEncryption: {
keyVaultNamespace: 'encryption.__keyVault',
kmsProviders: {
aws: { accessKeyId: 'AKIAFAKEFAKEFAKEFAKE', secretAccessKey: 'AWS-SECRET', sessionToken: 'AWS-SESSION' },
azure: { tenantId: 'tenant-id', clientId: 'client-id', clientSecret: 'AZURE-SECRET' },
gcp: { email: 'svc@example.iam.gserviceaccount.com', privateKey: 'R0NQLUtFWQ==' },
local: { key: 'TE9DQUwtS0VZ' },
},
},
},
});
expect(config).toEqual({
url: 'mongodb://app@mongo.internal:27017/events',
options: {
replicaSet: 'rs0',
autoEncryption: {
keyVaultNamespace: 'encryption.__keyVault',
kmsProviders: {
// The identity halves the client also reads are NOT credential
// material (#8876's asymmetry) and stay served.
aws: { accessKeyId: 'AKIAFAKEFAKEFAKEFAKE' },
azure: { tenantId: 'tenant-id', clientId: 'client-id' },
gcp: { email: 'svc@example.iam.gserviceaccount.com' },
local: {},
},
},
},
});
expect(redactedKeys).toEqual([
'options.autoEncryption.kmsProviders.aws.secretAccessKey',
'options.autoEncryption.kmsProviders.aws.sessionToken',
'options.autoEncryption.kmsProviders.azure.clientSecret',
'options.autoEncryption.kmsProviders.gcp.privateKey',
'options.autoEncryption.kmsProviders.local.key',
]);
});

it('unmeasured `autoEncryption` neighbours stay served — the table is measurement-only', () => {
// Negative control for the CSFLE rows: positions the measurement did NOT
// establish as secret material (`kmip.endpoint`, `keyVaultNamespace`,
// `schemaMap`, `bypassAutoEncryption`) are not on the table, mirror no
// credential spelling, and come back byte-identical — the discipline that
// entries land only with a measurement quoted, never by name-shape.
const table = passthroughSecretPaths('mongodb').map((p) => p.join('.'));
expect(table).not.toContain('options.autoEncryption.kmsProviders.kmip.endpoint');
expect(table).not.toContain('options.autoEncryption.keyVaultNamespace');
const stored = {
options: {
autoEncryption: {
keyVaultNamespace: 'encryption.__keyVault',
bypassAutoEncryption: false,
schemaMap: { 'appdb.people': { bsonType: 'object' } },
kmsProviders: { kmip: { endpoint: 'kmip.internal:5696' } },
},
},
};
const { config, redactedKeys } = redactDatasourceConfig('mongodb', stored);
expect(config).toEqual(stored);
expect(redactedKeys).toEqual([]);
});

it('a config without the passthrough — or with a malformed one — is untouched', () => {
expect(redactDatasourceConfig('mongodb', { database: 'events' }).redactedKeys).toEqual([]);
// Off-shape walks fall off silently rather than throwing on a stored row.
Expand Down
25 changes: 25 additions & 0 deletions packages/spec/src/data/datasource-credential-redaction.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -155,6 +155,26 @@ const STILL_WRITABLE_CREDENTIAL_KEYS: Record<string, readonly string[]> = {
* Either way a stored copy is a secret served in cleartext, and serving it
* back is a leak under any boundary (the same asymmetry with the write
* door this module already documents for the inline keys).
* - `options.autoEncryption.kmsProviders.{aws.secretAccessKey,
* aws.sessionToken, azure.clientSecret, gcp.privateKey, local.key}` —
* CSFLE KMS key material, measured both ways the client's OPTIONAL
* `mongodb-client-encryption` dependency can go (the answer differs, so
* both were run). With it installed (7.2.1, inside the pin's `^7.2.0`
* optional-peer range): an instrumented `new MongoClient(url,
* { …, ...options })` READS every one of these leaves at construction —
* the kmsProviders record is BSON-serialized into the native MongoCrypt —
* and `connect()` proceeds into live CSFLE machinery. Without it: the same
* construction throws `MongoMissingDependencyError` before reading any of
* them. Either way a stored copy is decryption-capable material served in
* cleartext (the AWS_SESSION_TOKEN posture: a loud client failure does not
* make serving the secret back acceptable). Still WRITABLE — the binder's
* one slot is the login password, the proxyPassword posture — but never
* SERVED. The same families' identity halves (`aws.accessKeyId`,
* `azure.tenantId` / `clientId`, `gcp.email`) are read by the client too
* but are not credential material (#8876's asymmetry), and the unmeasured
* neighbours (`kmip.endpoint`, `keyVaultNamespace`, `schemaMap`) mirror no
* credential spelling — deliberately not here: entries land on this table
* with a measurement quoted, never by name-shape.
*
* Keyed by CANONICAL driver id and looked up through {@link resolveDriverId},
* so a stored legacy `driver: 'mongo'` row is scrubbed identically to
Expand All@@ -168,6 +188,11 @@ const PASSTHROUGH_SECRET_PATHS: Readonly<Record<string, readonly (readonly strin
['options', 'key'],
['options', 'passphrase'],
['options', 'authMechanismProperties', 'AWS_SESSION_TOKEN'],
['options', 'autoEncryption', 'kmsProviders', 'aws', 'secretAccessKey'],
['options', 'autoEncryption', 'kmsProviders', 'aws', 'sessionToken'],
['options', 'autoEncryption', 'kmsProviders', 'azure', 'clientSecret'],
['options', 'autoEncryption', 'kmsProviders', 'gcp', 'privateKey'],
['options', 'autoEncryption', 'kmsProviders', 'local', 'key'],
],
};

Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
fix(spec): redact mongo CSFLE kmsProviders key material on datasource reads#13755

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

os-warren
merged 1 commit into

from

Aug 31, 2026
 Merged


fix(spec): redact mongo CSFLE kmsProviders key material on datasource reads
#13755
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


18 changes: 18 additions & 0 deletions
.changeset/csfle-kms-providers-redacted.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
---
"@objectstack/spec": patch
---

fix(spec): redact mongo CSFLE `kmsProviders` key material on datasource reads (#13602)

`redactDatasourceConfig('mongodb', …)` used to serve the CSFLE KMS secret material
inside the `options` passthrough back in cleartext with no `redactedKeys` entry:
`options.autoEncryption.kmsProviders.aws.secretAccessKey` (and `aws.sessionToken`),
`azure.clientSecret`, `gcp.privateKey`, and `local.key`. All five positions are now
on `passthroughSecretPaths`, measured against `mongodb@7.5.0` both with the optional
`mongodb-client-encryption` dependency installed (the client reads every leaf at
construction) and without it (construction throws `MongoMissingDependencyError`
before reading any of them). The same families' identity halves (`aws.accessKeyId`,
`azure.tenantId`/`clientId`, `gcp.email`) and unmeasured neighbours
(`kmip.endpoint`, `keyVaultNamespace`, `schemaMap`) stay served unchanged. An
untouched Save still round-trips byte-identically: `restoreRedactedConfig` mirrors
the redactor structurally, so the stored CSFLE config keeps working.

45 changes: 45 additions & 0 deletions
packages/services/service-datasource/src/__tests__/datasource-config-redaction.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -442,6 +442,51 @@ describe('#9040 — the passthrough spelling, both halves at the service door',
 expect((records[0].config!.options as any).auth.password).toBe('PLAINTEXT-IN-METADATA');
 });

 it('an untouched round-trip keeps a working CSFLE config byte-identical — every kmsProviders family', async () => {
 // The #13602 round-trip question, answered at the door that owns it: the
 // read path drops the KMS key material (measured read by mongodb@7.5.0
 // with mongodb-client-encryption installed; loud MongoMissingDependencyError
 // without it), and an untouched Save grafts every stored leaf back, so the
 // config the connect path hands the client never changes. Without the
 // restore, the served projection is NOT a working client config (measured:
 // construction throws `Failed to parse KMS provider` for aws/azure/gcp) —
 // which is exactly why the structural mirror must cover these rows.
 const CSFLE_MONGO: StoredDatasource = {
 name: 'csfle_mongo',
 driver: 'mongodb',
 origin: 'runtime',
 config: {
 url: 'mongodb://app@mongo.internal:27017/events',
 options: {
 autoEncryption: {
 keyVaultNamespace: 'encryption.__keyVault',
 kmsProviders: {
 aws: { accessKeyId: 'AKIAFAKEFAKEFAKEFAKE', secretAccessKey: 'AWS-SECRET', sessionToken: 'AWS-SESSION' },
 azure: { tenantId: 'tenant-id', clientId: 'client-id', clientSecret: 'AZURE-SECRET' },
 gcp: { email: 'svc@example.iam.gserviceaccount.com', privateKey: 'R0NQLUtFWQ==' },
 local: { key: 'TE9DQUwtS0VZ' },
 },
 },
 },
 },
 };
 const { service, records } = makeService([CSFLE_MONGO]);
 const read = await service.getDatasource('csfle_mongo');
 // Served: key material withheld, and said so; identity halves intact.
 expect(JSON.stringify(read!.config)).not.toMatch(/AWS-SECRET|AWS-SESSION|AZURE-SECRET|R0NQLUtFWQ|TE9DQUwtS0VZ/);
 expect(read!.redactedConfigKeys).toEqual([
 'options.autoEncryption.kmsProviders.aws.secretAccessKey',
 'options.autoEncryption.kmsProviders.aws.sessionToken',
 'options.autoEncryption.kmsProviders.azure.clientSecret',
 'options.autoEncryption.kmsProviders.gcp.privateKey',
 'options.autoEncryption.kmsProviders.local.key',
 ]);
 // Untouched Save: the stored row comes back byte-identical.
 await service.updateDatasource('csfle_mongo', { config: read!.config, label: 'Renamed' });
 expect(records[0].label).toBe('Renamed');
 expect(records[0].config).toEqual(CSFLE_MONGO.config);
 });

 it('an author who deletes the `auth` block WINS — a removed container is never re-grafted', async () => {
 const { service, records } = makeService([LEGACY_MONGO]);
 const read = await service.getDatasource('legacy_mongo');
Expand Down

74 changes: 74 additions & 0 deletions
packages/spec/src/data/datasource-credential-redaction.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -341,6 +341,80 @@ describe('passthrough secret redaction (#9040) — the nested spellings the key-
 ]);
 });

 it('drops CSFLE `kmsProviders` key material in every family, keeps the identity halves', () => {
 // Measured against mongodb@7.5.0 BOTH ways the optional
 // `mongodb-client-encryption` dependency can go: with it installed (7.2.1,
 // inside the pin's ^7.2.0 optional-peer range) an instrumented constructor
 // reads every one of these leaves (BSON-serialized into the native
 // MongoCrypt); without it the same construction throws
 // MongoMissingDependencyError before reading any of them. Either way a
 // stored copy is decryption-capable material served in cleartext — the
 // AWS_SESSION_TOKEN posture.
 const { config, redactedKeys } = redactDatasourceConfig('mongodb', {
 url: 'mongodb://app@mongo.internal:27017/events',
 options: {
 replicaSet: 'rs0',
 autoEncryption: {
 keyVaultNamespace: 'encryption.__keyVault',
 kmsProviders: {
 aws: { accessKeyId: 'AKIAFAKEFAKEFAKEFAKE', secretAccessKey: 'AWS-SECRET', sessionToken: 'AWS-SESSION' },
 azure: { tenantId: 'tenant-id', clientId: 'client-id', clientSecret: 'AZURE-SECRET' },
 gcp: { email: 'svc@example.iam.gserviceaccount.com', privateKey: 'R0NQLUtFWQ==' },
 local: { key: 'TE9DQUwtS0VZ' },
 },
 },
 },
 });
 expect(config).toEqual({
 url: 'mongodb://app@mongo.internal:27017/events',
 options: {
 replicaSet: 'rs0',
 autoEncryption: {
 keyVaultNamespace: 'encryption.__keyVault',
 kmsProviders: {
 // The identity halves the client also reads are NOT credential
 // material (#8876's asymmetry) and stay served.
 aws: { accessKeyId: 'AKIAFAKEFAKEFAKEFAKE' },
 azure: { tenantId: 'tenant-id', clientId: 'client-id' },
 gcp: { email: 'svc@example.iam.gserviceaccount.com' },
 local: {},
 },
 },
 },
 });
 expect(redactedKeys).toEqual([
 'options.autoEncryption.kmsProviders.aws.secretAccessKey',
 'options.autoEncryption.kmsProviders.aws.sessionToken',
 'options.autoEncryption.kmsProviders.azure.clientSecret',
 'options.autoEncryption.kmsProviders.gcp.privateKey',
 'options.autoEncryption.kmsProviders.local.key',
 ]);
 });

 it('unmeasured `autoEncryption` neighbours stay served — the table is measurement-only', () => {
 // Negative control for the CSFLE rows: positions the measurement did NOT
 // establish as secret material (`kmip.endpoint`, `keyVaultNamespace`,
 // `schemaMap`, `bypassAutoEncryption`) are not on the table, mirror no
 // credential spelling, and come back byte-identical — the discipline that
 // entries land only with a measurement quoted, never by name-shape.
 const table = passthroughSecretPaths('mongodb').map((p) => p.join('.'));
 expect(table).not.toContain('options.autoEncryption.kmsProviders.kmip.endpoint');
 expect(table).not.toContain('options.autoEncryption.keyVaultNamespace');
 const stored = {
 options: {
 autoEncryption: {
 keyVaultNamespace: 'encryption.__keyVault',
 bypassAutoEncryption: false,
 schemaMap: { 'appdb.people': { bsonType: 'object' } },
 kmsProviders: { kmip: { endpoint: 'kmip.internal:5696' } },
 },
 },
 };
 const { config, redactedKeys } = redactDatasourceConfig('mongodb', stored);
 expect(config).toEqual(stored);
 expect(redactedKeys).toEqual([]);
 });

 it('a config without the passthrough — or with a malformed one — is untouched', () => {
 expect(redactDatasourceConfig('mongodb', { database: 'events' }).redactedKeys).toEqual([]);
 // Off-shape walks fall off silently rather than throwing on a stored row.
Expand Down

25 changes: 25 additions & 0 deletions
packages/spec/src/data/datasource-credential-redaction.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -155,6 +155,26 @@ const STILL_WRITABLE_CREDENTIAL_KEYS: Record<string, readonly string[]> = {
 * Either way a stored copy is a secret served in cleartext, and serving it
 * back is a leak under any boundary (the same asymmetry with the write
 * door this module already documents for the inline keys).
 * - `options.autoEncryption.kmsProviders.{aws.secretAccessKey,
 * aws.sessionToken, azure.clientSecret, gcp.privateKey, local.key}` —
 * CSFLE KMS key material, measured both ways the client's OPTIONAL
 * `mongodb-client-encryption` dependency can go (the answer differs, so
 * both were run). With it installed (7.2.1, inside the pin's `^7.2.0`
 * optional-peer range): an instrumented `new MongoClient(url,
 * { …, ...options })` READS every one of these leaves at construction —
 * the kmsProviders record is BSON-serialized into the native MongoCrypt —
 * and `connect()` proceeds into live CSFLE machinery. Without it: the same
 * construction throws `MongoMissingDependencyError` before reading any of
 * them. Either way a stored copy is decryption-capable material served in
 * cleartext (the AWS_SESSION_TOKEN posture: a loud client failure does not
 * make serving the secret back acceptable). Still WRITABLE — the binder's
 * one slot is the login password, the proxyPassword posture — but never
 * SERVED. The same families' identity halves (`aws.accessKeyId`,
 * `azure.tenantId` / `clientId`, `gcp.email`) are read by the client too
 * but are not credential material (#8876's asymmetry), and the unmeasured
 * neighbours (`kmip.endpoint`, `keyVaultNamespace`, `schemaMap`) mirror no
 * credential spelling — deliberately not here: entries land on this table
 * with a measurement quoted, never by name-shape.
 *
 * Keyed by CANONICAL driver id and looked up through {@link resolveDriverId},
 * so a stored legacy `driver: 'mongo'` row is scrubbed identically to
Expand All@@ -168,6 +188,11 @@ const PASSTHROUGH_SECRET_PATHS: Readonly<Record<string, readonly (readonly strin
 ['options', 'key'],
 ['options', 'passphrase'],
 ['options', 'authMechanismProperties', 'AWS_SESSION_TOKEN'],
 ['options', 'autoEncryption', 'kmsProviders', 'aws', 'secretAccessKey'],
 ['options', 'autoEncryption', 'kmsProviders', 'aws', 'sessionToken'],
 ['options', 'autoEncryption', 'kmsProviders', 'azure', 'clientSecret'],
 ['options', 'autoEncryption', 'kmsProviders', 'gcp', 'privateKey'],
 ['options', 'autoEncryption', 'kmsProviders', 'local', 'key'],
 ],
};

Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
fix(spec): redact mongo CSFLE kmsProviders key material on datasource reads#13755

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

os-warren
merged 1 commit into

from

Aug 31, 2026
 Merged


fix(spec): redact mongo CSFLE kmsProviders key material on datasource reads
#13755
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


18 changes: 18 additions & 0 deletions
.changeset/csfle-kms-providers-redacted.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
---
"@objectstack/spec": patch
---

fix(spec): redact mongo CSFLE `kmsProviders` key material on datasource reads (#13602)

`redactDatasourceConfig('mongodb', …)` used to serve the CSFLE KMS secret material
inside the `options` passthrough back in cleartext with no `redactedKeys` entry:
`options.autoEncryption.kmsProviders.aws.secretAccessKey` (and `aws.sessionToken`),
`azure.clientSecret`, `gcp.privateKey`, and `local.key`. All five positions are now
on `passthroughSecretPaths`, measured against `mongodb@7.5.0` both with the optional
`mongodb-client-encryption` dependency installed (the client reads every leaf at
construction) and without it (construction throws `MongoMissingDependencyError`
before reading any of them). The same families' identity halves (`aws.accessKeyId`,
`azure.tenantId`/`clientId`, `gcp.email`) and unmeasured neighbours
(`kmip.endpoint`, `keyVaultNamespace`, `schemaMap`) stay served unchanged. An
untouched Save still round-trips byte-identically: `restoreRedactedConfig` mirrors
the redactor structurally, so the stored CSFLE config keeps working.

45 changes: 45 additions & 0 deletions
packages/services/service-datasource/src/__tests__/datasource-config-redaction.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -442,6 +442,51 @@ describe('#9040 — the passthrough spelling, both halves at the service door',
 expect((records[0].config!.options as any).auth.password).toBe('PLAINTEXT-IN-METADATA');
 });

 it('an untouched round-trip keeps a working CSFLE config byte-identical — every kmsProviders family', async () => {
 // The #13602 round-trip question, answered at the door that owns it: the
 // read path drops the KMS key material (measured read by mongodb@7.5.0
 // with mongodb-client-encryption installed; loud MongoMissingDependencyError
 // without it), and an untouched Save grafts every stored leaf back, so the
 // config the connect path hands the client never changes. Without the
 // restore, the served projection is NOT a working client config (measured:
 // construction throws `Failed to parse KMS provider` for aws/azure/gcp) —
 // which is exactly why the structural mirror must cover these rows.
 const CSFLE_MONGO: StoredDatasource = {
 name: 'csfle_mongo',
 driver: 'mongodb',
 origin: 'runtime',
 config: {
 url: 'mongodb://app@mongo.internal:27017/events',
 options: {
 autoEncryption: {
 keyVaultNamespace: 'encryption.__keyVault',
 kmsProviders: {
 aws: { accessKeyId: 'AKIAFAKEFAKEFAKEFAKE', secretAccessKey: 'AWS-SECRET', sessionToken: 'AWS-SESSION' },
 azure: { tenantId: 'tenant-id', clientId: 'client-id', clientSecret: 'AZURE-SECRET' },
 gcp: { email: 'svc@example.iam.gserviceaccount.com', privateKey: 'R0NQLUtFWQ==' },
 local: { key: 'TE9DQUwtS0VZ' },
 },
 },
 },
 },
 };
 const { service, records } = makeService([CSFLE_MONGO]);
 const read = await service.getDatasource('csfle_mongo');
 // Served: key material withheld, and said so; identity halves intact.
 expect(JSON.stringify(read!.config)).not.toMatch(/AWS-SECRET|AWS-SESSION|AZURE-SECRET|R0NQLUtFWQ|TE9DQUwtS0VZ/);
 expect(read!.redactedConfigKeys).toEqual([
 'options.autoEncryption.kmsProviders.aws.secretAccessKey',
 'options.autoEncryption.kmsProviders.aws.sessionToken',
 'options.autoEncryption.kmsProviders.azure.clientSecret',
 'options.autoEncryption.kmsProviders.gcp.privateKey',
 'options.autoEncryption.kmsProviders.local.key',
 ]);
 // Untouched Save: the stored row comes back byte-identical.
 await service.updateDatasource('csfle_mongo', { config: read!.config, label: 'Renamed' });
 expect(records[0].label).toBe('Renamed');
 expect(records[0].config).toEqual(CSFLE_MONGO.config);
 });

 it('an author who deletes the `auth` block WINS — a removed container is never re-grafted', async () => {
 const { service, records } = makeService([LEGACY_MONGO]);
 const read = await service.getDatasource('legacy_mongo');
Expand Down

74 changes: 74 additions & 0 deletions
packages/spec/src/data/datasource-credential-redaction.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -341,6 +341,80 @@ describe('passthrough secret redaction (#9040) — the nested spellings the key-
 ]);
 });

 it('drops CSFLE `kmsProviders` key material in every family, keeps the identity halves', () => {
 // Measured against mongodb@7.5.0 BOTH ways the optional
 // `mongodb-client-encryption` dependency can go: with it installed (7.2.1,
 // inside the pin's ^7.2.0 optional-peer range) an instrumented constructor
 // reads every one of these leaves (BSON-serialized into the native
 // MongoCrypt); without it the same construction throws
 // MongoMissingDependencyError before reading any of them. Either way a
 // stored copy is decryption-capable material served in cleartext — the
 // AWS_SESSION_TOKEN posture.
 const { config, redactedKeys } = redactDatasourceConfig('mongodb', {
 url: 'mongodb://app@mongo.internal:27017/events',
 options: {
 replicaSet: 'rs0',
 autoEncryption: {
 keyVaultNamespace: 'encryption.__keyVault',
 kmsProviders: {
 aws: { accessKeyId: 'AKIAFAKEFAKEFAKEFAKE', secretAccessKey: 'AWS-SECRET', sessionToken: 'AWS-SESSION' },
 azure: { tenantId: 'tenant-id', clientId: 'client-id', clientSecret: 'AZURE-SECRET' },
 gcp: { email: 'svc@example.iam.gserviceaccount.com', privateKey: 'R0NQLUtFWQ==' },
 local: { key: 'TE9DQUwtS0VZ' },
 },
 },
 },
 });
 expect(config).toEqual({
 url: 'mongodb://app@mongo.internal:27017/events',
 options: {
 replicaSet: 'rs0',
 autoEncryption: {
 keyVaultNamespace: 'encryption.__keyVault',
 kmsProviders: {
 // The identity halves the client also reads are NOT credential
 // material (#8876's asymmetry) and stay served.
 aws: { accessKeyId: 'AKIAFAKEFAKEFAKEFAKE' },
 azure: { tenantId: 'tenant-id', clientId: 'client-id' },
 gcp: { email: 'svc@example.iam.gserviceaccount.com' },
 local: {},
 },
 },
 },
 });
 expect(redactedKeys).toEqual([
 'options.autoEncryption.kmsProviders.aws.secretAccessKey',
 'options.autoEncryption.kmsProviders.aws.sessionToken',
 'options.autoEncryption.kmsProviders.azure.clientSecret',
 'options.autoEncryption.kmsProviders.gcp.privateKey',
 'options.autoEncryption.kmsProviders.local.key',
 ]);
 });

 it('unmeasured `autoEncryption` neighbours stay served — the table is measurement-only', () => {
 // Negative control for the CSFLE rows: positions the measurement did NOT
 // establish as secret material (`kmip.endpoint`, `keyVaultNamespace`,
 // `schemaMap`, `bypassAutoEncryption`) are not on the table, mirror no
 // credential spelling, and come back byte-identical — the discipline that
 // entries land only with a measurement quoted, never by name-shape.
 const table = passthroughSecretPaths('mongodb').map((p) => p.join('.'));
 expect(table).not.toContain('options.autoEncryption.kmsProviders.kmip.endpoint');
 expect(table).not.toContain('options.autoEncryption.keyVaultNamespace');
 const stored = {
 options: {
 autoEncryption: {
 keyVaultNamespace: 'encryption.__keyVault',
 bypassAutoEncryption: false,
 schemaMap: { 'appdb.people': { bsonType: 'object' } },
 kmsProviders: { kmip: { endpoint: 'kmip.internal:5696' } },
 },
 },
 };
 const { config, redactedKeys } = redactDatasourceConfig('mongodb', stored);
 expect(config).toEqual(stored);
 expect(redactedKeys).toEqual([]);
 });

 it('a config without the passthrough — or with a malformed one — is untouched', () => {
 expect(redactDatasourceConfig('mongodb', { database: 'events' }).redactedKeys).toEqual([]);
 // Off-shape walks fall off silently rather than throwing on a stored row.
Expand Down

25 changes: 25 additions & 0 deletions
packages/spec/src/data/datasource-credential-redaction.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -155,6 +155,26 @@ const STILL_WRITABLE_CREDENTIAL_KEYS: Record<string, readonly string[]> = {
 * Either way a stored copy is a secret served in cleartext, and serving it
 * back is a leak under any boundary (the same asymmetry with the write
 * door this module already documents for the inline keys).
 * - `options.autoEncryption.kmsProviders.{aws.secretAccessKey,
 * aws.sessionToken, azure.clientSecret, gcp.privateKey, local.key}` —
 * CSFLE KMS key material, measured both ways the client's OPTIONAL
 * `mongodb-client-encryption` dependency can go (the answer differs, so
 * both were run). With it installed (7.2.1, inside the pin's `^7.2.0`
 * optional-peer range): an instrumented `new MongoClient(url,
 * { …, ...options })` READS every one of these leaves at construction —
 * the kmsProviders record is BSON-serialized into the native MongoCrypt —
 * and `connect()` proceeds into live CSFLE machinery. Without it: the same
 * construction throws `MongoMissingDependencyError` before reading any of
 * them. Either way a stored copy is decryption-capable material served in
 * cleartext (the AWS_SESSION_TOKEN posture: a loud client failure does not
 * make serving the secret back acceptable). Still WRITABLE — the binder's
 * one slot is the login password, the proxyPassword posture — but never
 * SERVED. The same families' identity halves (`aws.accessKeyId`,
 * `azure.tenantId` / `clientId`, `gcp.email`) are read by the client too
 * but are not credential material (#8876's asymmetry), and the unmeasured
 * neighbours (`kmip.endpoint`, `keyVaultNamespace`, `schemaMap`) mirror no
 * credential spelling — deliberately not here: entries land on this table
 * with a measurement quoted, never by name-shape.
 *
 * Keyed by CANONICAL driver id and looked up through {@link resolveDriverId},
 * so a stored legacy `driver: 'mongo'` row is scrubbed identically to
Expand All@@ -168,6 +188,11 @@ const PASSTHROUGH_SECRET_PATHS: Readonly<Record<string, readonly (readonly strin
 ['options', 'key'],
 ['options', 'passphrase'],
 ['options', 'authMechanismProperties', 'AWS_SESSION_TOKEN'],
 ['options', 'autoEncryption', 'kmsProviders', 'aws', 'secretAccessKey'],
 ['options', 'autoEncryption', 'kmsProviders', 'aws', 'sessionToken'],
 ['options', 'autoEncryption', 'kmsProviders', 'azure', 'clientSecret'],
 ['options', 'autoEncryption', 'kmsProviders', 'gcp', 'privateKey'],
 ['options', 'autoEncryption', 'kmsProviders', 'local', 'key'],
 ],
};

Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
fix(spec): redact mongo CSFLE kmsProviders key material on datasource reads#13755

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

os-warren
merged 1 commit into

from

Aug 31, 2026
 Merged


fix(spec): redact mongo CSFLE kmsProviders key material on datasource reads
#13755
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


18 changes: 18 additions & 0 deletions
.changeset/csfle-kms-providers-redacted.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
---
"@objectstack/spec": patch
---

fix(spec): redact mongo CSFLE `kmsProviders` key material on datasource reads (#13602)

`redactDatasourceConfig('mongodb', …)` used to serve the CSFLE KMS secret material
inside the `options` passthrough back in cleartext with no `redactedKeys` entry:
`options.autoEncryption.kmsProviders.aws.secretAccessKey` (and `aws.sessionToken`),
`azure.clientSecret`, `gcp.privateKey`, and `local.key`. All five positions are now
on `passthroughSecretPaths`, measured against `mongodb@7.5.0` both with the optional
`mongodb-client-encryption` dependency installed (the client reads every leaf at
construction) and without it (construction throws `MongoMissingDependencyError`
before reading any of them). The same families' identity halves (`aws.accessKeyId`,
`azure.tenantId`/`clientId`, `gcp.email`) and unmeasured neighbours
(`kmip.endpoint`, `keyVaultNamespace`, `schemaMap`) stay served unchanged. An
untouched Save still round-trips byte-identically: `restoreRedactedConfig` mirrors
the redactor structurally, so the stored CSFLE config keeps working.

45 changes: 45 additions & 0 deletions
packages/services/service-datasource/src/__tests__/datasource-config-redaction.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -442,6 +442,51 @@ describe('#9040 — the passthrough spelling, both halves at the service door',
 expect((records[0].config!.options as any).auth.password).toBe('PLAINTEXT-IN-METADATA');
 });

 it('an untouched round-trip keeps a working CSFLE config byte-identical — every kmsProviders family', async () => {
 // The #13602 round-trip question, answered at the door that owns it: the
 // read path drops the KMS key material (measured read by mongodb@7.5.0
 // with mongodb-client-encryption installed; loud MongoMissingDependencyError
 // without it), and an untouched Save grafts every stored leaf back, so the
 // config the connect path hands the client never changes. Without the
 // restore, the served projection is NOT a working client config (measured:
 // construction throws `Failed to parse KMS provider` for aws/azure/gcp) —
 // which is exactly why the structural mirror must cover these rows.
 const CSFLE_MONGO: StoredDatasource = {
 name: 'csfle_mongo',
 driver: 'mongodb',
 origin: 'runtime',
 config: {
 url: 'mongodb://app@mongo.internal:27017/events',
 options: {
 autoEncryption: {
 keyVaultNamespace: 'encryption.__keyVault',
 kmsProviders: {
 aws: { accessKeyId: 'AKIAFAKEFAKEFAKEFAKE', secretAccessKey: 'AWS-SECRET', sessionToken: 'AWS-SESSION' },
 azure: { tenantId: 'tenant-id', clientId: 'client-id', clientSecret: 'AZURE-SECRET' },
 gcp: { email: 'svc@example.iam.gserviceaccount.com', privateKey: 'R0NQLUtFWQ==' },
 local: { key: 'TE9DQUwtS0VZ' },
 },
 },
 },
 },
 };
 const { service, records } = makeService([CSFLE_MONGO]);
 const read = await service.getDatasource('csfle_mongo');
 // Served: key material withheld, and said so; identity halves intact.
 expect(JSON.stringify(read!.config)).not.toMatch(/AWS-SECRET|AWS-SESSION|AZURE-SECRET|R0NQLUtFWQ|TE9DQUwtS0VZ/);
 expect(read!.redactedConfigKeys).toEqual([
 'options.autoEncryption.kmsProviders.aws.secretAccessKey',
 'options.autoEncryption.kmsProviders.aws.sessionToken',
 'options.autoEncryption.kmsProviders.azure.clientSecret',
 'options.autoEncryption.kmsProviders.gcp.privateKey',
 'options.autoEncryption.kmsProviders.local.key',
 ]);
 // Untouched Save: the stored row comes back byte-identical.
 await service.updateDatasource('csfle_mongo', { config: read!.config, label: 'Renamed' });
 expect(records[0].label).toBe('Renamed');
 expect(records[0].config).toEqual(CSFLE_MONGO.config);
 });

 it('an author who deletes the `auth` block WINS — a removed container is never re-grafted', async () => {
 const { service, records } = makeService([LEGACY_MONGO]);
 const read = await service.getDatasource('legacy_mongo');
Expand Down

74 changes: 74 additions & 0 deletions
packages/spec/src/data/datasource-credential-redaction.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -341,6 +341,80 @@ describe('passthrough secret redaction (#9040) — the nested spellings the key-
 ]);
 });

 it('drops CSFLE `kmsProviders` key material in every family, keeps the identity halves', () => {
 // Measured against mongodb@7.5.0 BOTH ways the optional
 // `mongodb-client-encryption` dependency can go: with it installed (7.2.1,
 // inside the pin's ^7.2.0 optional-peer range) an instrumented constructor
 // reads every one of these leaves (BSON-serialized into the native
 // MongoCrypt); without it the same construction throws
 // MongoMissingDependencyError before reading any of them. Either way a
 // stored copy is decryption-capable material served in cleartext — the
 // AWS_SESSION_TOKEN posture.
 const { config, redactedKeys } = redactDatasourceConfig('mongodb', {
 url: 'mongodb://app@mongo.internal:27017/events',
 options: {
 replicaSet: 'rs0',
 autoEncryption: {
 keyVaultNamespace: 'encryption.__keyVault',
 kmsProviders: {
 aws: { accessKeyId: 'AKIAFAKEFAKEFAKEFAKE', secretAccessKey: 'AWS-SECRET', sessionToken: 'AWS-SESSION' },
 azure: { tenantId: 'tenant-id', clientId: 'client-id', clientSecret: 'AZURE-SECRET' },
 gcp: { email: 'svc@example.iam.gserviceaccount.com', privateKey: 'R0NQLUtFWQ==' },
 local: { key: 'TE9DQUwtS0VZ' },
 },
 },
 },
 });
 expect(config).toEqual({
 url: 'mongodb://app@mongo.internal:27017/events',
 options: {
 replicaSet: 'rs0',
 autoEncryption: {
 keyVaultNamespace: 'encryption.__keyVault',
 kmsProviders: {
 // The identity halves the client also reads are NOT credential
 // material (#8876's asymmetry) and stay served.
 aws: { accessKeyId: 'AKIAFAKEFAKEFAKEFAKE' },
 azure: { tenantId: 'tenant-id', clientId: 'client-id' },
 gcp: { email: 'svc@example.iam.gserviceaccount.com' },
 local: {},
 },
 },
 },
 });
 expect(redactedKeys).toEqual([
 'options.autoEncryption.kmsProviders.aws.secretAccessKey',
 'options.autoEncryption.kmsProviders.aws.sessionToken',
 'options.autoEncryption.kmsProviders.azure.clientSecret',
 'options.autoEncryption.kmsProviders.gcp.privateKey',
 'options.autoEncryption.kmsProviders.local.key',
 ]);
 });

 it('unmeasured `autoEncryption` neighbours stay served — the table is measurement-only', () => {
 // Negative control for the CSFLE rows: positions the measurement did NOT
 // establish as secret material (`kmip.endpoint`, `keyVaultNamespace`,
 // `schemaMap`, `bypassAutoEncryption`) are not on the table, mirror no
 // credential spelling, and come back byte-identical — the discipline that
 // entries land only with a measurement quoted, never by name-shape.
 const table = passthroughSecretPaths('mongodb').map((p) => p.join('.'));
 expect(table).not.toContain('options.autoEncryption.kmsProviders.kmip.endpoint');
 expect(table).not.toContain('options.autoEncryption.keyVaultNamespace');
 const stored = {
 options: {
 autoEncryption: {
 keyVaultNamespace: 'encryption.__keyVault',
 bypassAutoEncryption: false,
 schemaMap: { 'appdb.people': { bsonType: 'object' } },
 kmsProviders: { kmip: { endpoint: 'kmip.internal:5696' } },
 },
 },
 };
 const { config, redactedKeys } = redactDatasourceConfig('mongodb', stored);
 expect(config).toEqual(stored);
 expect(redactedKeys).toEqual([]);
 });

 it('a config without the passthrough — or with a malformed one — is untouched', () => {
 expect(redactDatasourceConfig('mongodb', { database: 'events' }).redactedKeys).toEqual([]);
 // Off-shape walks fall off silently rather than throwing on a stored row.
Expand Down

25 changes: 25 additions & 0 deletions
packages/spec/src/data/datasource-credential-redaction.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -155,6 +155,26 @@ const STILL_WRITABLE_CREDENTIAL_KEYS: Record<string, readonly string[]> = {
 * Either way a stored copy is a secret served in cleartext, and serving it
 * back is a leak under any boundary (the same asymmetry with the write
 * door this module already documents for the inline keys).
 * - `options.autoEncryption.kmsProviders.{aws.secretAccessKey,
 * aws.sessionToken, azure.clientSecret, gcp.privateKey, local.key}` —
 * CSFLE KMS key material, measured both ways the client's OPTIONAL
 * `mongodb-client-encryption` dependency can go (the answer differs, so
 * both were run). With it installed (7.2.1, inside the pin's `^7.2.0`
 * optional-peer range): an instrumented `new MongoClient(url,
 * { …, ...options })` READS every one of these leaves at construction —
 * the kmsProviders record is BSON-serialized into the native MongoCrypt —
 * and `connect()` proceeds into live CSFLE machinery. Without it: the same
 * construction throws `MongoMissingDependencyError` before reading any of
 * them. Either way a stored copy is decryption-capable material served in
 * cleartext (the AWS_SESSION_TOKEN posture: a loud client failure does not
 * make serving the secret back acceptable). Still WRITABLE — the binder's
 * one slot is the login password, the proxyPassword posture — but never
 * SERVED. The same families' identity halves (`aws.accessKeyId`,
 * `azure.tenantId` / `clientId`, `gcp.email`) are read by the client too
 * but are not credential material (#8876's asymmetry), and the unmeasured
 * neighbours (`kmip.endpoint`, `keyVaultNamespace`, `schemaMap`) mirror no
 * credential spelling — deliberately not here: entries land on this table
 * with a measurement quoted, never by name-shape.
 *
 * Keyed by CANONICAL driver id and looked up through {@link resolveDriverId},
 * so a stored legacy `driver: 'mongo'` row is scrubbed identically to
Expand All@@ -168,6 +188,11 @@ const PASSTHROUGH_SECRET_PATHS: Readonly<Record<string, readonly (readonly strin
 ['options', 'key'],
 ['options', 'passphrase'],
 ['options', 'authMechanismProperties', 'AWS_SESSION_TOKEN'],
 ['options', 'autoEncryption', 'kmsProviders', 'aws', 'secretAccessKey'],
 ['options', 'autoEncryption', 'kmsProviders', 'aws', 'sessionToken'],
 ['options', 'autoEncryption', 'kmsProviders', 'azure', 'clientSecret'],
 ['options', 'autoEncryption', 'kmsProviders', 'gcp', 'privateKey'],
 ['options', 'autoEncryption', 'kmsProviders', 'local', 'key'],
 ],
};

Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
fix(spec): redact mongo CSFLE kmsProviders key material on datasource reads#13755

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

os-warren
merged 1 commit into

from

Aug 31, 2026
 Merged


fix(spec): redact mongo CSFLE kmsProviders key material on datasource reads
#13755
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


18 changes: 18 additions & 0 deletions
.changeset/csfle-kms-providers-redacted.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
---
"@objectstack/spec": patch
---

fix(spec): redact mongo CSFLE `kmsProviders` key material on datasource reads (#13602)

`redactDatasourceConfig('mongodb', …)` used to serve the CSFLE KMS secret material
inside the `options` passthrough back in cleartext with no `redactedKeys` entry:
`options.autoEncryption.kmsProviders.aws.secretAccessKey` (and `aws.sessionToken`),
`azure.clientSecret`, `gcp.privateKey`, and `local.key`. All five positions are now
on `passthroughSecretPaths`, measured against `mongodb@7.5.0` both with the optional
`mongodb-client-encryption` dependency installed (the client reads every leaf at
construction) and without it (construction throws `MongoMissingDependencyError`
before reading any of them). The same families' identity halves (`aws.accessKeyId`,
`azure.tenantId`/`clientId`, `gcp.email`) and unmeasured neighbours
(`kmip.endpoint`, `keyVaultNamespace`, `schemaMap`) stay served unchanged. An
untouched Save still round-trips byte-identically: `restoreRedactedConfig` mirrors
the redactor structurally, so the stored CSFLE config keeps working.

45 changes: 45 additions & 0 deletions
packages/services/service-datasource/src/__tests__/datasource-config-redaction.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -442,6 +442,51 @@ describe('#9040 — the passthrough spelling, both halves at the service door',
 expect((records[0].config!.options as any).auth.password).toBe('PLAINTEXT-IN-METADATA');
 });

 it('an untouched round-trip keeps a working CSFLE config byte-identical — every kmsProviders family', async () => {
 // The #13602 round-trip question, answered at the door that owns it: the
 // read path drops the KMS key material (measured read by mongodb@7.5.0
 // with mongodb-client-encryption installed; loud MongoMissingDependencyError
 // without it), and an untouched Save grafts every stored leaf back, so the
 // config the connect path hands the client never changes. Without the
 // restore, the served projection is NOT a working client config (measured:
 // construction throws `Failed to parse KMS provider` for aws/azure/gcp) —
 // which is exactly why the structural mirror must cover these rows.
 const CSFLE_MONGO: StoredDatasource = {
 name: 'csfle_mongo',
 driver: 'mongodb',
 origin: 'runtime',
 config: {
 url: 'mongodb://app@mongo.internal:27017/events',
 options: {
 autoEncryption: {
 keyVaultNamespace: 'encryption.__keyVault',
 kmsProviders: {
 aws: { accessKeyId: 'AKIAFAKEFAKEFAKEFAKE', secretAccessKey: 'AWS-SECRET', sessionToken: 'AWS-SESSION' },
 azure: { tenantId: 'tenant-id', clientId: 'client-id', clientSecret: 'AZURE-SECRET' },
 gcp: { email: 'svc@example.iam.gserviceaccount.com', privateKey: 'R0NQLUtFWQ==' },
 local: { key: 'TE9DQUwtS0VZ' },
 },
 },
 },
 },
 };
 const { service, records } = makeService([CSFLE_MONGO]);
 const read = await service.getDatasource('csfle_mongo');
 // Served: key material withheld, and said so; identity halves intact.
 expect(JSON.stringify(read!.config)).not.toMatch(/AWS-SECRET|AWS-SESSION|AZURE-SECRET|R0NQLUtFWQ|TE9DQUwtS0VZ/);
 expect(read!.redactedConfigKeys).toEqual([
 'options.autoEncryption.kmsProviders.aws.secretAccessKey',
 'options.autoEncryption.kmsProviders.aws.sessionToken',
 'options.autoEncryption.kmsProviders.azure.clientSecret',
 'options.autoEncryption.kmsProviders.gcp.privateKey',
 'options.autoEncryption.kmsProviders.local.key',
 ]);
 // Untouched Save: the stored row comes back byte-identical.
 await service.updateDatasource('csfle_mongo', { config: read!.config, label: 'Renamed' });
 expect(records[0].label).toBe('Renamed');
 expect(records[0].config).toEqual(CSFLE_MONGO.config);
 });

 it('an author who deletes the `auth` block WINS — a removed container is never re-grafted', async () => {
 const { service, records } = makeService([LEGACY_MONGO]);
 const read = await service.getDatasource('legacy_mongo');
Expand Down

74 changes: 74 additions & 0 deletions
packages/spec/src/data/datasource-credential-redaction.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -341,6 +341,80 @@ describe('passthrough secret redaction (#9040) — the nested spellings the key-
 ]);
 });

 it('drops CSFLE `kmsProviders` key material in every family, keeps the identity halves', () => {
 // Measured against mongodb@7.5.0 BOTH ways the optional
 // `mongodb-client-encryption` dependency can go: with it installed (7.2.1,
 // inside the pin's ^7.2.0 optional-peer range) an instrumented constructor
 // reads every one of these leaves (BSON-serialized into the native
 // MongoCrypt); without it the same construction throws
 // MongoMissingDependencyError before reading any of them. Either way a
 // stored copy is decryption-capable material served in cleartext — the
 // AWS_SESSION_TOKEN posture.
 const { config, redactedKeys } = redactDatasourceConfig('mongodb', {
 url: 'mongodb://app@mongo.internal:27017/events',
 options: {
 replicaSet: 'rs0',
 autoEncryption: {
 keyVaultNamespace: 'encryption.__keyVault',
 kmsProviders: {
 aws: { accessKeyId: 'AKIAFAKEFAKEFAKEFAKE', secretAccessKey: 'AWS-SECRET', sessionToken: 'AWS-SESSION' },
 azure: { tenantId: 'tenant-id', clientId: 'client-id', clientSecret: 'AZURE-SECRET' },
 gcp: { email: 'svc@example.iam.gserviceaccount.com', privateKey: 'R0NQLUtFWQ==' },
 local: { key: 'TE9DQUwtS0VZ' },
 },
 },
 },
 });
 expect(config).toEqual({
 url: 'mongodb://app@mongo.internal:27017/events',
 options: {
 replicaSet: 'rs0',
 autoEncryption: {
 keyVaultNamespace: 'encryption.__keyVault',
 kmsProviders: {
 // The identity halves the client also reads are NOT credential
 // material (#8876's asymmetry) and stay served.
 aws: { accessKeyId: 'AKIAFAKEFAKEFAKEFAKE' },
 azure: { tenantId: 'tenant-id', clientId: 'client-id' },
 gcp: { email: 'svc@example.iam.gserviceaccount.com' },
 local: {},
 },
 },
 },
 });
 expect(redactedKeys).toEqual([
 'options.autoEncryption.kmsProviders.aws.secretAccessKey',
 'options.autoEncryption.kmsProviders.aws.sessionToken',
 'options.autoEncryption.kmsProviders.azure.clientSecret',
 'options.autoEncryption.kmsProviders.gcp.privateKey',
 'options.autoEncryption.kmsProviders.local.key',
 ]);
 });

 it('unmeasured `autoEncryption` neighbours stay served — the table is measurement-only', () => {
 // Negative control for the CSFLE rows: positions the measurement did NOT
 // establish as secret material (`kmip.endpoint`, `keyVaultNamespace`,
 // `schemaMap`, `bypassAutoEncryption`) are not on the table, mirror no
 // credential spelling, and come back byte-identical — the discipline that
 // entries land only with a measurement quoted, never by name-shape.
 const table = passthroughSecretPaths('mongodb').map((p) => p.join('.'));
 expect(table).not.toContain('options.autoEncryption.kmsProviders.kmip.endpoint');
 expect(table).not.toContain('options.autoEncryption.keyVaultNamespace');
 const stored = {
 options: {
 autoEncryption: {
 keyVaultNamespace: 'encryption.__keyVault',
 bypassAutoEncryption: false,
 schemaMap: { 'appdb.people': { bsonType: 'object' } },
 kmsProviders: { kmip: { endpoint: 'kmip.internal:5696' } },
 },
 },
 };
 const { config, redactedKeys } = redactDatasourceConfig('mongodb', stored);
 expect(config).toEqual(stored);
 expect(redactedKeys).toEqual([]);
 });

 it('a config without the passthrough — or with a malformed one — is untouched', () => {
 expect(redactDatasourceConfig('mongodb', { database: 'events' }).redactedKeys).toEqual([]);
 // Off-shape walks fall off silently rather than throwing on a stored row.
Expand Down

25 changes: 25 additions & 0 deletions
packages/spec/src/data/datasource-credential-redaction.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -155,6 +155,26 @@ const STILL_WRITABLE_CREDENTIAL_KEYS: Record<string, readonly string[]> = {
 * Either way a stored copy is a secret served in cleartext, and serving it
 * back is a leak under any boundary (the same asymmetry with the write
 * door this module already documents for the inline keys).
 * - `options.autoEncryption.kmsProviders.{aws.secretAccessKey,
 * aws.sessionToken, azure.clientSecret, gcp.privateKey, local.key}` —
 * CSFLE KMS key material, measured both ways the client's OPTIONAL
 * `mongodb-client-encryption` dependency can go (the answer differs, so
 * both were run). With it installed (7.2.1, inside the pin's `^7.2.0`
 * optional-peer range): an instrumented `new MongoClient(url,
 * { …, ...options })` READS every one of these leaves at construction —
 * the kmsProviders record is BSON-serialized into the native MongoCrypt —
 * and `connect()` proceeds into live CSFLE machinery. Without it: the same
 * construction throws `MongoMissingDependencyError` before reading any of
 * them. Either way a stored copy is decryption-capable material served in
 * cleartext (the AWS_SESSION_TOKEN posture: a loud client failure does not
 * make serving the secret back acceptable). Still WRITABLE — the binder's
 * one slot is the login password, the proxyPassword posture — but never
 * SERVED. The same families' identity halves (`aws.accessKeyId`,
 * `azure.tenantId` / `clientId`, `gcp.email`) are read by the client too
 * but are not credential material (#8876's asymmetry), and the unmeasured
 * neighbours (`kmip.endpoint`, `keyVaultNamespace`, `schemaMap`) mirror no
 * credential spelling — deliberately not here: entries land on this table
 * with a measurement quoted, never by name-shape.
 *
 * Keyed by CANONICAL driver id and looked up through {@link resolveDriverId},
 * so a stored legacy `driver: 'mongo'` row is scrubbed identically to
Expand All@@ -168,6 +188,11 @@ const PASSTHROUGH_SECRET_PATHS: Readonly<Record<string, readonly (readonly strin
 ['options', 'key'],
 ['options', 'passphrase'],
 ['options', 'authMechanismProperties', 'AWS_SESSION_TOKEN'],
 ['options', 'autoEncryption', 'kmsProviders', 'aws', 'secretAccessKey'],
 ['options', 'autoEncryption', 'kmsProviders', 'aws', 'sessionToken'],
 ['options', 'autoEncryption', 'kmsProviders', 'azure', 'clientSecret'],
 ['options', 'autoEncryption', 'kmsProviders', 'gcp', 'privateKey'],
 ['options', 'autoEncryption', 'kmsProviders', 'local', 'key'],
 ],
};

Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
fix(spec): redact mongo CSFLE kmsProviders key material on datasource reads#13755

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

os-warren
merged 1 commit into

from

Aug 31, 2026
 Merged


fix(spec): redact mongo CSFLE kmsProviders key material on datasource reads
#13755
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


18 changes: 18 additions & 0 deletions
.changeset/csfle-kms-providers-redacted.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
---
"@objectstack/spec": patch
---

fix(spec): redact mongo CSFLE `kmsProviders` key material on datasource reads (#13602)

`redactDatasourceConfig('mongodb', …)` used to serve the CSFLE KMS secret material
inside the `options` passthrough back in cleartext with no `redactedKeys` entry:
`options.autoEncryption.kmsProviders.aws.secretAccessKey` (and `aws.sessionToken`),
`azure.clientSecret`, `gcp.privateKey`, and `local.key`. All five positions are now
on `passthroughSecretPaths`, measured against `mongodb@7.5.0` both with the optional
`mongodb-client-encryption` dependency installed (the client reads every leaf at
construction) and without it (construction throws `MongoMissingDependencyError`
before reading any of them). The same families' identity halves (`aws.accessKeyId`,
`azure.tenantId`/`clientId`, `gcp.email`) and unmeasured neighbours
(`kmip.endpoint`, `keyVaultNamespace`, `schemaMap`) stay served unchanged. An
untouched Save still round-trips byte-identically: `restoreRedactedConfig` mirrors
the redactor structurally, so the stored CSFLE config keeps working.

45 changes: 45 additions & 0 deletions
packages/services/service-datasource/src/__tests__/datasource-config-redaction.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -442,6 +442,51 @@ describe('#9040 — the passthrough spelling, both halves at the service door',
 expect((records[0].config!.options as any).auth.password).toBe('PLAINTEXT-IN-METADATA');
 });

 it('an untouched round-trip keeps a working CSFLE config byte-identical — every kmsProviders family', async () => {
 // The #13602 round-trip question, answered at the door that owns it: the
 // read path drops the KMS key material (measured read by mongodb@7.5.0
 // with mongodb-client-encryption installed; loud MongoMissingDependencyError
 // without it), and an untouched Save grafts every stored leaf back, so the
 // config the connect path hands the client never changes. Without the
 // restore, the served projection is NOT a working client config (measured:
 // construction throws `Failed to parse KMS provider` for aws/azure/gcp) —
 // which is exactly why the structural mirror must cover these rows.
 const CSFLE_MONGO: StoredDatasource = {
 name: 'csfle_mongo',
 driver: 'mongodb',
 origin: 'runtime',
 config: {
 url: 'mongodb://app@mongo.internal:27017/events',
 options: {
 autoEncryption: {
 keyVaultNamespace: 'encryption.__keyVault',
 kmsProviders: {
 aws: { accessKeyId: 'AKIAFAKEFAKEFAKEFAKE', secretAccessKey: 'AWS-SECRET', sessionToken: 'AWS-SESSION' },
 azure: { tenantId: 'tenant-id', clientId: 'client-id', clientSecret: 'AZURE-SECRET' },
 gcp: { email: 'svc@example.iam.gserviceaccount.com', privateKey: 'R0NQLUtFWQ==' },
 local: { key: 'TE9DQUwtS0VZ' },
 },
 },
 },
 },
 };
 const { service, records } = makeService([CSFLE_MONGO]);
 const read = await service.getDatasource('csfle_mongo');
 // Served: key material withheld, and said so; identity halves intact.
 expect(JSON.stringify(read!.config)).not.toMatch(/AWS-SECRET|AWS-SESSION|AZURE-SECRET|R0NQLUtFWQ|TE9DQUwtS0VZ/);
 expect(read!.redactedConfigKeys).toEqual([
 'options.autoEncryption.kmsProviders.aws.secretAccessKey',
 'options.autoEncryption.kmsProviders.aws.sessionToken',
 'options.autoEncryption.kmsProviders.azure.clientSecret',
 'options.autoEncryption.kmsProviders.gcp.privateKey',
 'options.autoEncryption.kmsProviders.local.key',
 ]);
 // Untouched Save: the stored row comes back byte-identical.
 await service.updateDatasource('csfle_mongo', { config: read!.config, label: 'Renamed' });
 expect(records[0].label).toBe('Renamed');
 expect(records[0].config).toEqual(CSFLE_MONGO.config);
 });

 it('an author who deletes the `auth` block WINS — a removed container is never re-grafted', async () => {
 const { service, records } = makeService([LEGACY_MONGO]);
 const read = await service.getDatasource('legacy_mongo');
Expand Down

74 changes: 74 additions & 0 deletions
packages/spec/src/data/datasource-credential-redaction.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -341,6 +341,80 @@ describe('passthrough secret redaction (#9040) — the nested spellings the key-
 ]);
 });

 it('drops CSFLE `kmsProviders` key material in every family, keeps the identity halves', () => {
 // Measured against mongodb@7.5.0 BOTH ways the optional
 // `mongodb-client-encryption` dependency can go: with it installed (7.2.1,
 // inside the pin's ^7.2.0 optional-peer range) an instrumented constructor
 // reads every one of these leaves (BSON-serialized into the native
 // MongoCrypt); without it the same construction throws
 // MongoMissingDependencyError before reading any of them. Either way a
 // stored copy is decryption-capable material served in cleartext — the
 // AWS_SESSION_TOKEN posture.
 const { config, redactedKeys } = redactDatasourceConfig('mongodb', {
 url: 'mongodb://app@mongo.internal:27017/events',
 options: {
 replicaSet: 'rs0',
 autoEncryption: {
 keyVaultNamespace: 'encryption.__keyVault',
 kmsProviders: {
 aws: { accessKeyId: 'AKIAFAKEFAKEFAKEFAKE', secretAccessKey: 'AWS-SECRET', sessionToken: 'AWS-SESSION' },
 azure: { tenantId: 'tenant-id', clientId: 'client-id', clientSecret: 'AZURE-SECRET' },
 gcp: { email: 'svc@example.iam.gserviceaccount.com', privateKey: 'R0NQLUtFWQ==' },
 local: { key: 'TE9DQUwtS0VZ' },
 },
 },
 },
 });
 expect(config).toEqual({
 url: 'mongodb://app@mongo.internal:27017/events',
 options: {
 replicaSet: 'rs0',
 autoEncryption: {
 keyVaultNamespace: 'encryption.__keyVault',
 kmsProviders: {
 // The identity halves the client also reads are NOT credential
 // material (#8876's asymmetry) and stay served.
 aws: { accessKeyId: 'AKIAFAKEFAKEFAKEFAKE' },
 azure: { tenantId: 'tenant-id', clientId: 'client-id' },
 gcp: { email: 'svc@example.iam.gserviceaccount.com' },
 local: {},
 },
 },
 },
 });
 expect(redactedKeys).toEqual([
 'options.autoEncryption.kmsProviders.aws.secretAccessKey',
 'options.autoEncryption.kmsProviders.aws.sessionToken',
 'options.autoEncryption.kmsProviders.azure.clientSecret',
 'options.autoEncryption.kmsProviders.gcp.privateKey',
 'options.autoEncryption.kmsProviders.local.key',
 ]);
 });

 it('unmeasured `autoEncryption` neighbours stay served — the table is measurement-only', () => {
 // Negative control for the CSFLE rows: positions the measurement did NOT
 // establish as secret material (`kmip.endpoint`, `keyVaultNamespace`,
 // `schemaMap`, `bypassAutoEncryption`) are not on the table, mirror no
 // credential spelling, and come back byte-identical — the discipline that
 // entries land only with a measurement quoted, never by name-shape.
 const table = passthroughSecretPaths('mongodb').map((p) => p.join('.'));
 expect(table).not.toContain('options.autoEncryption.kmsProviders.kmip.endpoint');
 expect(table).not.toContain('options.autoEncryption.keyVaultNamespace');
 const stored = {
 options: {
 autoEncryption: {
 keyVaultNamespace: 'encryption.__keyVault',
 bypassAutoEncryption: false,
 schemaMap: { 'appdb.people': { bsonType: 'object' } },
 kmsProviders: { kmip: { endpoint: 'kmip.internal:5696' } },
 },
 },
 };
 const { config, redactedKeys } = redactDatasourceConfig('mongodb', stored);
 expect(config).toEqual(stored);
 expect(redactedKeys).toEqual([]);
 });

 it('a config without the passthrough — or with a malformed one — is untouched', () => {
 expect(redactDatasourceConfig('mongodb', { database: 'events' }).redactedKeys).toEqual([]);
 // Off-shape walks fall off silently rather than throwing on a stored row.
Expand Down

25 changes: 25 additions & 0 deletions
packages/spec/src/data/datasource-credential-redaction.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -155,6 +155,26 @@ const STILL_WRITABLE_CREDENTIAL_KEYS: Record<string, readonly string[]> = {
 * Either way a stored copy is a secret served in cleartext, and serving it
 * back is a leak under any boundary (the same asymmetry with the write
 * door this module already documents for the inline keys).
 * - `options.autoEncryption.kmsProviders.{aws.secretAccessKey,
 * aws.sessionToken, azure.clientSecret, gcp.privateKey, local.key}` —
 * CSFLE KMS key material, measured both ways the client's OPTIONAL
 * `mongodb-client-encryption` dependency can go (the answer differs, so
 * both were run). With it installed (7.2.1, inside the pin's `^7.2.0`
 * optional-peer range): an instrumented `new MongoClient(url,
 * { …, ...options })` READS every one of these leaves at construction —
 * the kmsProviders record is BSON-serialized into the native MongoCrypt —
 * and `connect()` proceeds into live CSFLE machinery. Without it: the same
 * construction throws `MongoMissingDependencyError` before reading any of
 * them. Either way a stored copy is decryption-capable material served in
 * cleartext (the AWS_SESSION_TOKEN posture: a loud client failure does not
 * make serving the secret back acceptable). Still WRITABLE — the binder's
 * one slot is the login password, the proxyPassword posture — but never
 * SERVED. The same families' identity halves (`aws.accessKeyId`,
 * `azure.tenantId` / `clientId`, `gcp.email`) are read by the client too
 * but are not credential material (#8876's asymmetry), and the unmeasured
 * neighbours (`kmip.endpoint`, `keyVaultNamespace`, `schemaMap`) mirror no
 * credential spelling — deliberately not here: entries land on this table
 * with a measurement quoted, never by name-shape.
 *
 * Keyed by CANONICAL driver id and looked up through {@link resolveDriverId},
 * so a stored legacy `driver: 'mongo'` row is scrubbed identically to
Expand All@@ -168,6 +188,11 @@ const PASSTHROUGH_SECRET_PATHS: Readonly<Record<string, readonly (readonly strin
 ['options', 'key'],
 ['options', 'passphrase'],
 ['options', 'authMechanismProperties', 'AWS_SESSION_TOKEN'],
 ['options', 'autoEncryption', 'kmsProviders', 'aws', 'secretAccessKey'],
 ['options', 'autoEncryption', 'kmsProviders', 'aws', 'sessionToken'],
 ['options', 'autoEncryption', 'kmsProviders', 'azure', 'clientSecret'],
 ['options', 'autoEncryption', 'kmsProviders', 'gcp', 'privateKey'],
 ['options', 'autoEncryption', 'kmsProviders', 'local', 'key'],
 ],
};

Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
fix(spec): redact mongo CSFLE kmsProviders key material on datasource reads#13755

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

os-warren
merged 1 commit into

from

Aug 31, 2026
 Merged


fix(spec): redact mongo CSFLE kmsProviders key material on datasource reads
#13755
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


18 changes: 18 additions & 0 deletions
.changeset/csfle-kms-providers-redacted.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
---
"@objectstack/spec": patch
---

fix(spec): redact mongo CSFLE `kmsProviders` key material on datasource reads (#13602)

`redactDatasourceConfig('mongodb', …)` used to serve the CSFLE KMS secret material
inside the `options` passthrough back in cleartext with no `redactedKeys` entry:
`options.autoEncryption.kmsProviders.aws.secretAccessKey` (and `aws.sessionToken`),
`azure.clientSecret`, `gcp.privateKey`, and `local.key`. All five positions are now
on `passthroughSecretPaths`, measured against `mongodb@7.5.0` both with the optional
`mongodb-client-encryption` dependency installed (the client reads every leaf at
construction) and without it (construction throws `MongoMissingDependencyError`
before reading any of them). The same families' identity halves (`aws.accessKeyId`,
`azure.tenantId`/`clientId`, `gcp.email`) and unmeasured neighbours
(`kmip.endpoint`, `keyVaultNamespace`, `schemaMap`) stay served unchanged. An
untouched Save still round-trips byte-identically: `restoreRedactedConfig` mirrors
the redactor structurally, so the stored CSFLE config keeps working.

45 changes: 45 additions & 0 deletions
packages/services/service-datasource/src/__tests__/datasource-config-redaction.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -442,6 +442,51 @@ describe('#9040 — the passthrough spelling, both halves at the service door',
 expect((records[0].config!.options as any).auth.password).toBe('PLAINTEXT-IN-METADATA');
 });

 it('an untouched round-trip keeps a working CSFLE config byte-identical — every kmsProviders family', async () => {
 // The #13602 round-trip question, answered at the door that owns it: the
 // read path drops the KMS key material (measured read by mongodb@7.5.0
 // with mongodb-client-encryption installed; loud MongoMissingDependencyError
 // without it), and an untouched Save grafts every stored leaf back, so the
 // config the connect path hands the client never changes. Without the
 // restore, the served projection is NOT a working client config (measured:
 // construction throws `Failed to parse KMS provider` for aws/azure/gcp) —
 // which is exactly why the structural mirror must cover these rows.
 const CSFLE_MONGO: StoredDatasource = {
 name: 'csfle_mongo',
 driver: 'mongodb',
 origin: 'runtime',
 config: {
 url: 'mongodb://app@mongo.internal:27017/events',
 options: {
 autoEncryption: {
 keyVaultNamespace: 'encryption.__keyVault',
 kmsProviders: {
 aws: { accessKeyId: 'AKIAFAKEFAKEFAKEFAKE', secretAccessKey: 'AWS-SECRET', sessionToken: 'AWS-SESSION' },
 azure: { tenantId: 'tenant-id', clientId: 'client-id', clientSecret: 'AZURE-SECRET' },
 gcp: { email: 'svc@example.iam.gserviceaccount.com', privateKey: 'R0NQLUtFWQ==' },
 local: { key: 'TE9DQUwtS0VZ' },
 },
 },
 },
 },
 };
 const { service, records } = makeService([CSFLE_MONGO]);
 const read = await service.getDatasource('csfle_mongo');
 // Served: key material withheld, and said so; identity halves intact.
 expect(JSON.stringify(read!.config)).not.toMatch(/AWS-SECRET|AWS-SESSION|AZURE-SECRET|R0NQLUtFWQ|TE9DQUwtS0VZ/);
 expect(read!.redactedConfigKeys).toEqual([
 'options.autoEncryption.kmsProviders.aws.secretAccessKey',
 'options.autoEncryption.kmsProviders.aws.sessionToken',
 'options.autoEncryption.kmsProviders.azure.clientSecret',
 'options.autoEncryption.kmsProviders.gcp.privateKey',
 'options.autoEncryption.kmsProviders.local.key',
 ]);
 // Untouched Save: the stored row comes back byte-identical.
 await service.updateDatasource('csfle_mongo', { config: read!.config, label: 'Renamed' });
 expect(records[0].label).toBe('Renamed');
 expect(records[0].config).toEqual(CSFLE_MONGO.config);
 });

 it('an author who deletes the `auth` block WINS — a removed container is never re-grafted', async () => {
 const { service, records } = makeService([LEGACY_MONGO]);
 const read = await service.getDatasource('legacy_mongo');
Expand Down

74 changes: 74 additions & 0 deletions
packages/spec/src/data/datasource-credential-redaction.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -341,6 +341,80 @@ describe('passthrough secret redaction (#9040) — the nested spellings the key-
 ]);
 });

 it('drops CSFLE `kmsProviders` key material in every family, keeps the identity halves', () => {
 // Measured against mongodb@7.5.0 BOTH ways the optional
 // `mongodb-client-encryption` dependency can go: with it installed (7.2.1,
 // inside the pin's ^7.2.0 optional-peer range) an instrumented constructor
 // reads every one of these leaves (BSON-serialized into the native
 // MongoCrypt); without it the same construction throws
 // MongoMissingDependencyError before reading any of them. Either way a
 // stored copy is decryption-capable material served in cleartext — the
 // AWS_SESSION_TOKEN posture.
 const { config, redactedKeys } = redactDatasourceConfig('mongodb', {
 url: 'mongodb://app@mongo.internal:27017/events',
 options: {
 replicaSet: 'rs0',
 autoEncryption: {
 keyVaultNamespace: 'encryption.__keyVault',
 kmsProviders: {
 aws: { accessKeyId: 'AKIAFAKEFAKEFAKEFAKE', secretAccessKey: 'AWS-SECRET', sessionToken: 'AWS-SESSION' },
 azure: { tenantId: 'tenant-id', clientId: 'client-id', clientSecret: 'AZURE-SECRET' },
 gcp: { email: 'svc@example.iam.gserviceaccount.com', privateKey: 'R0NQLUtFWQ==' },
 local: { key: 'TE9DQUwtS0VZ' },
 },
 },
 },
 });
 expect(config).toEqual({
 url: 'mongodb://app@mongo.internal:27017/events',
 options: {
 replicaSet: 'rs0',
 autoEncryption: {
 keyVaultNamespace: 'encryption.__keyVault',
 kmsProviders: {
 // The identity halves the client also reads are NOT credential
 // material (#8876's asymmetry) and stay served.
 aws: { accessKeyId: 'AKIAFAKEFAKEFAKEFAKE' },
 azure: { tenantId: 'tenant-id', clientId: 'client-id' },
 gcp: { email: 'svc@example.iam.gserviceaccount.com' },
 local: {},
 },
 },
 },
 });
 expect(redactedKeys).toEqual([
 'options.autoEncryption.kmsProviders.aws.secretAccessKey',
 'options.autoEncryption.kmsProviders.aws.sessionToken',
 'options.autoEncryption.kmsProviders.azure.clientSecret',
 'options.autoEncryption.kmsProviders.gcp.privateKey',
 'options.autoEncryption.kmsProviders.local.key',
 ]);
 });

 it('unmeasured `autoEncryption` neighbours stay served — the table is measurement-only', () => {
 // Negative control for the CSFLE rows: positions the measurement did NOT
 // establish as secret material (`kmip.endpoint`, `keyVaultNamespace`,
 // `schemaMap`, `bypassAutoEncryption`) are not on the table, mirror no
 // credential spelling, and come back byte-identical — the discipline that
 // entries land only with a measurement quoted, never by name-shape.
 const table = passthroughSecretPaths('mongodb').map((p) => p.join('.'));
 expect(table).not.toContain('options.autoEncryption.kmsProviders.kmip.endpoint');
 expect(table).not.toContain('options.autoEncryption.keyVaultNamespace');
 const stored = {
 options: {
 autoEncryption: {
 keyVaultNamespace: 'encryption.__keyVault',
 bypassAutoEncryption: false,
 schemaMap: { 'appdb.people': { bsonType: 'object' } },
 kmsProviders: { kmip: { endpoint: 'kmip.internal:5696' } },
 },
 },
 };
 const { config, redactedKeys } = redactDatasourceConfig('mongodb', stored);
 expect(config).toEqual(stored);
 expect(redactedKeys).toEqual([]);
 });

 it('a config without the passthrough — or with a malformed one — is untouched', () => {
 expect(redactDatasourceConfig('mongodb', { database: 'events' }).redactedKeys).toEqual([]);
 // Off-shape walks fall off silently rather than throwing on a stored row.
Expand Down

25 changes: 25 additions & 0 deletions
packages/spec/src/data/datasource-credential-redaction.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -155,6 +155,26 @@ const STILL_WRITABLE_CREDENTIAL_KEYS: Record<string, readonly string[]> = {
 * Either way a stored copy is a secret served in cleartext, and serving it
 * back is a leak under any boundary (the same asymmetry with the write
 * door this module already documents for the inline keys).
 * - `options.autoEncryption.kmsProviders.{aws.secretAccessKey,
 * aws.sessionToken, azure.clientSecret, gcp.privateKey, local.key}` —
 * CSFLE KMS key material, measured both ways the client's OPTIONAL
 * `mongodb-client-encryption` dependency can go (the answer differs, so
 * both were run). With it installed (7.2.1, inside the pin's `^7.2.0`
 * optional-peer range): an instrumented `new MongoClient(url,
 * { …, ...options })` READS every one of these leaves at construction —
 * the kmsProviders record is BSON-serialized into the native MongoCrypt —
 * and `connect()` proceeds into live CSFLE machinery. Without it: the same
 * construction throws `MongoMissingDependencyError` before reading any of
 * them. Either way a stored copy is decryption-capable material served in
 * cleartext (the AWS_SESSION_TOKEN posture: a loud client failure does not
 * make serving the secret back acceptable). Still WRITABLE — the binder's
 * one slot is the login password, the proxyPassword posture — but never
 * SERVED. The same families' identity halves (`aws.accessKeyId`,
 * `azure.tenantId` / `clientId`, `gcp.email`) are read by the client too
 * but are not credential material (#8876's asymmetry), and the unmeasured
 * neighbours (`kmip.endpoint`, `keyVaultNamespace`, `schemaMap`) mirror no
 * credential spelling — deliberately not here: entries land on this table
 * with a measurement quoted, never by name-shape.
 *
 * Keyed by CANONICAL driver id and looked up through {@link resolveDriverId},
 * so a stored legacy `driver: 'mongo'` row is scrubbed identically to
Expand All@@ -168,6 +188,11 @@ const PASSTHROUGH_SECRET_PATHS: Readonly<Record<string, readonly (readonly strin
 ['options', 'key'],
 ['options', 'passphrase'],
 ['options', 'authMechanismProperties', 'AWS_SESSION_TOKEN'],
 ['options', 'autoEncryption', 'kmsProviders', 'aws', 'secretAccessKey'],
 ['options', 'autoEncryption', 'kmsProviders', 'aws', 'sessionToken'],
 ['options', 'autoEncryption', 'kmsProviders', 'azure', 'clientSecret'],
 ['options', 'autoEncryption', 'kmsProviders', 'gcp', 'privateKey'],
 ['options', 'autoEncryption', 'kmsProviders', 'local', 'key'],
 ],
};

Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
fix(spec): redact mongo CSFLE kmsProviders key material on datasource reads#13755

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

os-warren
merged 1 commit into

from

Aug 31, 2026
 Merged


fix(spec): redact mongo CSFLE kmsProviders key material on datasource reads
#13755
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


18 changes: 18 additions & 0 deletions
.changeset/csfle-kms-providers-redacted.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
---
"@objectstack/spec": patch
---

fix(spec): redact mongo CSFLE `kmsProviders` key material on datasource reads (#13602)

`redactDatasourceConfig('mongodb', …)` used to serve the CSFLE KMS secret material
inside the `options` passthrough back in cleartext with no `redactedKeys` entry:
`options.autoEncryption.kmsProviders.aws.secretAccessKey` (and `aws.sessionToken`),
`azure.clientSecret`, `gcp.privateKey`, and `local.key`. All five positions are now
on `passthroughSecretPaths`, measured against `mongodb@7.5.0` both with the optional
`mongodb-client-encryption` dependency installed (the client reads every leaf at
construction) and without it (construction throws `MongoMissingDependencyError`
before reading any of them). The same families' identity halves (`aws.accessKeyId`,
`azure.tenantId`/`clientId`, `gcp.email`) and unmeasured neighbours
(`kmip.endpoint`, `keyVaultNamespace`, `schemaMap`) stay served unchanged. An
untouched Save still round-trips byte-identically: `restoreRedactedConfig` mirrors
the redactor structurally, so the stored CSFLE config keeps working.

45 changes: 45 additions & 0 deletions
packages/services/service-datasource/src/__tests__/datasource-config-redaction.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -442,6 +442,51 @@ describe('#9040 — the passthrough spelling, both halves at the service door',
 expect((records[0].config!.options as any).auth.password).toBe('PLAINTEXT-IN-METADATA');
 });

 it('an untouched round-trip keeps a working CSFLE config byte-identical — every kmsProviders family', async () => {
 // The #13602 round-trip question, answered at the door that owns it: the
 // read path drops the KMS key material (measured read by mongodb@7.5.0
 // with mongodb-client-encryption installed; loud MongoMissingDependencyError
 // without it), and an untouched Save grafts every stored leaf back, so the
 // config the connect path hands the client never changes. Without the
 // restore, the served projection is NOT a working client config (measured:
 // construction throws `Failed to parse KMS provider` for aws/azure/gcp) —
 // which is exactly why the structural mirror must cover these rows.
 const CSFLE_MONGO: StoredDatasource = {
 name: 'csfle_mongo',
 driver: 'mongodb',
 origin: 'runtime',
 config: {
 url: 'mongodb://app@mongo.internal:27017/events',
 options: {
 autoEncryption: {
 keyVaultNamespace: 'encryption.__keyVault',
 kmsProviders: {
 aws: { accessKeyId: 'AKIAFAKEFAKEFAKEFAKE', secretAccessKey: 'AWS-SECRET', sessionToken: 'AWS-SESSION' },
 azure: { tenantId: 'tenant-id', clientId: 'client-id', clientSecret: 'AZURE-SECRET' },
 gcp: { email: 'svc@example.iam.gserviceaccount.com', privateKey: 'R0NQLUtFWQ==' },
 local: { key: 'TE9DQUwtS0VZ' },
 },
 },
 },
 },
 };
 const { service, records } = makeService([CSFLE_MONGO]);
 const read = await service.getDatasource('csfle_mongo');
 // Served: key material withheld, and said so; identity halves intact.
 expect(JSON.stringify(read!.config)).not.toMatch(/AWS-SECRET|AWS-SESSION|AZURE-SECRET|R0NQLUtFWQ|TE9DQUwtS0VZ/);
 expect(read!.redactedConfigKeys).toEqual([
 'options.autoEncryption.kmsProviders.aws.secretAccessKey',
 'options.autoEncryption.kmsProviders.aws.sessionToken',
 'options.autoEncryption.kmsProviders.azure.clientSecret',
 'options.autoEncryption.kmsProviders.gcp.privateKey',
 'options.autoEncryption.kmsProviders.local.key',
 ]);
 // Untouched Save: the stored row comes back byte-identical.
 await service.updateDatasource('csfle_mongo', { config: read!.config, label: 'Renamed' });
 expect(records[0].label).toBe('Renamed');
 expect(records[0].config).toEqual(CSFLE_MONGO.config);
 });

 it('an author who deletes the `auth` block WINS — a removed container is never re-grafted', async () => {
 const { service, records } = makeService([LEGACY_MONGO]);
 const read = await service.getDatasource('legacy_mongo');
Expand Down

74 changes: 74 additions & 0 deletions
packages/spec/src/data/datasource-credential-redaction.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -341,6 +341,80 @@ describe('passthrough secret redaction (#9040) — the nested spellings the key-
 ]);
 });

 it('drops CSFLE `kmsProviders` key material in every family, keeps the identity halves', () => {
 // Measured against mongodb@7.5.0 BOTH ways the optional
 // `mongodb-client-encryption` dependency can go: with it installed (7.2.1,
 // inside the pin's ^7.2.0 optional-peer range) an instrumented constructor
 // reads every one of these leaves (BSON-serialized into the native
 // MongoCrypt); without it the same construction throws
 // MongoMissingDependencyError before reading any of them. Either way a
 // stored copy is decryption-capable material served in cleartext — the
 // AWS_SESSION_TOKEN posture.
 const { config, redactedKeys } = redactDatasourceConfig('mongodb', {
 url: 'mongodb://app@mongo.internal:27017/events',
 options: {
 replicaSet: 'rs0',
 autoEncryption: {
 keyVaultNamespace: 'encryption.__keyVault',
 kmsProviders: {
 aws: { accessKeyId: 'AKIAFAKEFAKEFAKEFAKE', secretAccessKey: 'AWS-SECRET', sessionToken: 'AWS-SESSION' },
 azure: { tenantId: 'tenant-id', clientId: 'client-id', clientSecret: 'AZURE-SECRET' },
 gcp: { email: 'svc@example.iam.gserviceaccount.com', privateKey: 'R0NQLUtFWQ==' },
 local: { key: 'TE9DQUwtS0VZ' },
 },
 },
 },
 });
 expect(config).toEqual({
 url: 'mongodb://app@mongo.internal:27017/events',
 options: {
 replicaSet: 'rs0',
 autoEncryption: {
 keyVaultNamespace: 'encryption.__keyVault',
 kmsProviders: {
 // The identity halves the client also reads are NOT credential
 // material (#8876's asymmetry) and stay served.
 aws: { accessKeyId: 'AKIAFAKEFAKEFAKEFAKE' },
 azure: { tenantId: 'tenant-id', clientId: 'client-id' },
 gcp: { email: 'svc@example.iam.gserviceaccount.com' },
 local: {},
 },
 },
 },
 });
 expect(redactedKeys).toEqual([
 'options.autoEncryption.kmsProviders.aws.secretAccessKey',
 'options.autoEncryption.kmsProviders.aws.sessionToken',
 'options.autoEncryption.kmsProviders.azure.clientSecret',
 'options.autoEncryption.kmsProviders.gcp.privateKey',
 'options.autoEncryption.kmsProviders.local.key',
 ]);
 });

 it('unmeasured `autoEncryption` neighbours stay served — the table is measurement-only', () => {
 // Negative control for the CSFLE rows: positions the measurement did NOT
 // establish as secret material (`kmip.endpoint`, `keyVaultNamespace`,
 // `schemaMap`, `bypassAutoEncryption`) are not on the table, mirror no
 // credential spelling, and come back byte-identical — the discipline that
 // entries land only with a measurement quoted, never by name-shape.
 const table = passthroughSecretPaths('mongodb').map((p) => p.join('.'));
 expect(table).not.toContain('options.autoEncryption.kmsProviders.kmip.endpoint');
 expect(table).not.toContain('options.autoEncryption.keyVaultNamespace');
 const stored = {
 options: {
 autoEncryption: {
 keyVaultNamespace: 'encryption.__keyVault',
 bypassAutoEncryption: false,
 schemaMap: { 'appdb.people': { bsonType: 'object' } },
 kmsProviders: { kmip: { endpoint: 'kmip.internal:5696' } },
 },
 },
 };
 const { config, redactedKeys } = redactDatasourceConfig('mongodb', stored);
 expect(config).toEqual(stored);
 expect(redactedKeys).toEqual([]);
 });

 it('a config without the passthrough — or with a malformed one — is untouched', () => {
 expect(redactDatasourceConfig('mongodb', { database: 'events' }).redactedKeys).toEqual([]);
 // Off-shape walks fall off silently rather than throwing on a stored row.
Expand Down

25 changes: 25 additions & 0 deletions
packages/spec/src/data/datasource-credential-redaction.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -155,6 +155,26 @@ const STILL_WRITABLE_CREDENTIAL_KEYS: Record<string, readonly string[]> = {
 * Either way a stored copy is a secret served in cleartext, and serving it
 * back is a leak under any boundary (the same asymmetry with the write
 * door this module already documents for the inline keys).
 * - `options.autoEncryption.kmsProviders.{aws.secretAccessKey,
 * aws.sessionToken, azure.clientSecret, gcp.privateKey, local.key}` —
 * CSFLE KMS key material, measured both ways the client's OPTIONAL
 * `mongodb-client-encryption` dependency can go (the answer differs, so
 * both were run). With it installed (7.2.1, inside the pin's `^7.2.0`
 * optional-peer range): an instrumented `new MongoClient(url,
 * { …, ...options })` READS every one of these leaves at construction —
 * the kmsProviders record is BSON-serialized into the native MongoCrypt —
 * and `connect()` proceeds into live CSFLE machinery. Without it: the same
 * construction throws `MongoMissingDependencyError` before reading any of
 * them. Either way a stored copy is decryption-capable material served in
 * cleartext (the AWS_SESSION_TOKEN posture: a loud client failure does not
 * make serving the secret back acceptable). Still WRITABLE — the binder's
 * one slot is the login password, the proxyPassword posture — but never
 * SERVED. The same families' identity halves (`aws.accessKeyId`,
 * `azure.tenantId` / `clientId`, `gcp.email`) are read by the client too
 * but are not credential material (#8876's asymmetry), and the unmeasured
 * neighbours (`kmip.endpoint`, `keyVaultNamespace`, `schemaMap`) mirror no
 * credential spelling — deliberately not here: entries land on this table
 * with a measurement quoted, never by name-shape.
 *
 * Keyed by CANONICAL driver id and looked up through {@link resolveDriverId},
 * so a stored legacy `driver: 'mongo'` row is scrubbed identically to
Expand All@@ -168,6 +188,11 @@ const PASSTHROUGH_SECRET_PATHS: Readonly<Record<string, readonly (readonly strin
 ['options', 'key'],
 ['options', 'passphrase'],
 ['options', 'authMechanismProperties', 'AWS_SESSION_TOKEN'],
 ['options', 'autoEncryption', 'kmsProviders', 'aws', 'secretAccessKey'],
 ['options', 'autoEncryption', 'kmsProviders', 'aws', 'sessionToken'],
 ['options', 'autoEncryption', 'kmsProviders', 'azure', 'clientSecret'],
 ['options', 'autoEncryption', 'kmsProviders', 'gcp', 'privateKey'],
 ['options', 'autoEncryption', 'kmsProviders', 'local', 'key'],
 ],
};

Expand Down
Loading