@terreno/api 57.3.0 → 57.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.ai/skills/mongoose-schema-safety/SKILL.md +23 -10
- package/README.md +11 -5
- package/bunfig.toml +1 -1
- package/dist/actions.js +197 -368
- package/dist/adminModelRouter.js +88 -173
- package/dist/adminTypes.d.ts +7 -0
- package/dist/adminTypes.js +6 -1
- package/dist/api.d.ts +10 -0
- package/dist/api.js +601 -792
- package/dist/audit/auditApp.d.ts +30 -0
- package/dist/audit/auditApp.js +114 -0
- package/dist/audit/auditEventModel.d.ts +29 -0
- package/dist/audit/auditEventModel.js +101 -0
- package/dist/audit/cloudTasksEnqueue.d.ts +32 -0
- package/dist/audit/cloudTasksEnqueue.js +69 -0
- package/dist/audit/diff.d.ts +10 -0
- package/dist/audit/diff.js +140 -0
- package/dist/audit/processQueue.d.ts +6 -0
- package/dist/audit/processQueue.js +56 -0
- package/dist/audit/rbacSink.d.ts +2 -0
- package/dist/audit/rbacSink.js +41 -0
- package/dist/audit/record.d.ts +56 -0
- package/dist/audit/record.js +251 -0
- package/dist/auth.js +432 -681
- package/dist/authRecovery.js +155 -269
- package/dist/authTokens.js +43 -118
- package/dist/betterAuth.d.ts +6 -0
- package/dist/betterAuthApp.js +25 -26
- package/dist/betterAuthSetup.js +258 -413
- package/dist/browserLogsRoute.d.ts +6 -0
- package/dist/browserLogsRoute.js +97 -0
- package/dist/collectionRegistry.d.ts +3 -1
- package/dist/collectionRegistry.js +43 -33
- package/dist/config.js +53 -122
- package/dist/configurationApp.js +180 -361
- package/dist/configurationPlugin.js +130 -302
- package/dist/consentApp.js +276 -421
- package/dist/docLoader.js +78 -126
- package/dist/envConfigurationPlugin.js +25 -147
- package/dist/errors.js +151 -247
- package/dist/example.js +28 -34
- package/dist/expressServer.d.ts +10 -0
- package/dist/expressServer.js +109 -255
- package/dist/frameworkModelNames.d.ts +24 -0
- package/dist/frameworkModelNames.js +31 -0
- package/dist/githubAuth.js +152 -216
- package/dist/httpClient.js +176 -264
- package/dist/index.d.ts +28 -1
- package/dist/index.js +53 -2
- package/dist/logger.js +145 -278
- package/dist/mcp/auth.js +76 -128
- package/dist/mcp/createMCPRequest.js +4 -5
- package/dist/mcp/handlers.js +268 -480
- package/dist/mcp/query.d.ts +0 -13
- package/dist/mcp/query.js +57 -151
- package/dist/mcp/registry.js +17 -30
- package/dist/mcp/schemaGenerator.js +95 -181
- package/dist/mcp/server.js +28 -100
- package/dist/mcp/serviceTokens.js +102 -191
- package/dist/mcp/toolGenerator.js +78 -191
- package/dist/middleware.js +15 -27
- package/dist/migrations/fixtures/all-down/20260910120000-one.d.ts +4 -0
- package/dist/migrations/fixtures/all-down/20260910120000-one.js +9 -0
- package/dist/migrations/fixtures/all-down/20260910120001-two.d.ts +4 -0
- package/dist/migrations/fixtures/all-down/20260910120001-two.js +9 -0
- package/dist/migrations/fixtures/bad-id/20260910120000-mismatch.d.ts +3 -0
- package/dist/migrations/fixtures/bad-id/20260910120000-mismatch.js +7 -0
- package/dist/migrations/fixtures/bad-name/not-a-migration.d.ts +3 -0
- package/dist/migrations/fixtures/bad-name/not-a-migration.js +7 -0
- package/dist/migrations/fixtures/missing-up/20260910120000-noup.d.ts +2 -0
- package/dist/migrations/fixtures/missing-up/20260910120000-noup.js +5 -0
- package/dist/migrations/fixtures/valid/20260910120000-alpha.d.ts +3 -0
- package/dist/migrations/fixtures/valid/20260910120000-alpha.js +7 -0
- package/dist/migrations/fixtures/valid/20260910120001-beta.d.ts +4 -0
- package/dist/migrations/fixtures/valid/20260910120001-beta.js +9 -0
- package/dist/migrations/generate.d.ts +17 -0
- package/dist/migrations/generate.js +155 -0
- package/dist/migrations/load.d.ts +20 -0
- package/dist/migrations/load.js +110 -0
- package/dist/migrations/lock.d.ts +13 -0
- package/dist/migrations/lock.js +73 -0
- package/dist/migrations/runner.d.ts +42 -0
- package/dist/migrations/runner.js +249 -0
- package/dist/migrations/schemaCatalog.d.ts +44 -0
- package/dist/migrations/schemaCatalog.js +185 -0
- package/dist/migrations/types.d.ts +87 -0
- package/dist/migrations/types.js +7 -0
- package/dist/models/consentForm.js +6 -6
- package/dist/models/consentResponse.js +5 -5
- package/dist/models/mcpServiceToken.js +66 -156
- package/dist/models/notification.d.ts +2 -0
- package/dist/models/notification.js +62 -0
- package/dist/models/notificationPreference.d.ts +2 -0
- package/dist/models/notificationPreference.js +49 -0
- package/dist/models/versionConfig.js +5 -5
- package/dist/notifications/notificationService.d.ts +40 -0
- package/dist/notifications/notificationService.js +183 -0
- package/dist/notifications/notificationsApp.d.ts +18 -0
- package/dist/notifications/notificationsApp.js +156 -0
- package/dist/notifications/notificationsBeforeSend.d.ts +14 -0
- package/dist/notifications/notificationsBeforeSend.js +32 -0
- package/dist/notifiers/googleChatNotifier.js +36 -117
- package/dist/notifiers/slackNotifier.d.ts +31 -2
- package/dist/notifiers/slackNotifier.js +170 -119
- package/dist/notifiers/zoomNotifier.js +60 -111
- package/dist/openApi.d.ts +1 -7
- package/dist/openApi.js +113 -127
- package/dist/openApiBuilder.d.ts +14 -3
- package/dist/openApiBuilder.js +117 -159
- package/dist/openApiCompat.js +81 -148
- package/dist/openApiEtag.js +7 -7
- package/dist/openApiValidator.d.ts +13 -1
- package/dist/openApiValidator.js +301 -246
- package/dist/orgs/orgContext.d.ts +23 -0
- package/dist/orgs/orgContext.js +128 -0
- package/dist/orgs/orgPermissions.d.ts +4 -0
- package/dist/orgs/orgPermissions.js +38 -0
- package/dist/orgs/orgPlugin.d.ts +13 -0
- package/dist/orgs/orgPlugin.js +66 -0
- package/dist/orgs/organizationModel.d.ts +13 -0
- package/dist/orgs/organizationModel.js +200 -0
- package/dist/orgs/organizationSettings.d.ts +19 -0
- package/dist/orgs/organizationSettings.js +113 -0
- package/dist/orgs/orgsApp.d.ts +28 -0
- package/dist/orgs/orgsApp.js +416 -0
- package/dist/permissions.d.ts +7 -13
- package/dist/permissions.js +95 -211
- package/dist/plugins.js +125 -218
- package/dist/populate.js +130 -240
- package/dist/rateLimit/applyTrustProxy.js +1 -1
- package/dist/rateLimit/createStore.js +7 -8
- package/dist/rateLimit/memoryStore.js +22 -100
- package/dist/rateLimit/middleware.d.ts +0 -8
- package/dist/rateLimit/middleware.js +49 -101
- package/dist/rateLimit/mongoStore.d.ts +1 -0
- package/dist/rateLimit/mongoStore.js +55 -112
- package/dist/rateLimit/policies.d.ts +0 -4
- package/dist/rateLimit/policies.js +44 -80
- package/dist/rateLimit/redisStore.d.ts +1 -0
- package/dist/rateLimit/redisStore.js +40 -133
- package/dist/rbac/access.js +122 -253
- package/dist/rbac/assertAllowed.js +95 -171
- package/dist/rbac/auditModel.js +14 -58
- package/dist/rbac/backfillAdmins.js +24 -130
- package/dist/rbac/fieldViews.js +46 -141
- package/dist/rbac/membershipOrgAdminSource.d.ts +6 -0
- package/dist/rbac/membershipOrgAdminSource.js +51 -0
- package/dist/rbac/middleware.js +30 -96
- package/dist/rbac/modelRouterAccess.d.ts +3 -0
- package/dist/rbac/modelRouterAccess.js +133 -307
- package/dist/rbac/permissionUtils.js +40 -179
- package/dist/rbac/realtimeAccess.js +81 -147
- package/dist/rbac/resolve.d.ts +1 -1
- package/dist/rbac/resolve.js +154 -319
- package/dist/rbac/roleManager.js +318 -700
- package/dist/rbac/roleModel.d.ts +2 -5
- package/dist/rbac/roleModel.js +60 -173
- package/dist/rbac/routes.js +93 -196
- package/dist/rbac/scopes.js +39 -133
- package/dist/rbac/statements.d.ts +10 -1
- package/dist/rbac/statements.js +42 -93
- package/dist/rbac/types.d.ts +5 -0
- package/dist/rbac/userPlugin.js +3 -29
- package/dist/realtime/changeStreamWatcher.d.ts +10 -4
- package/dist/realtime/changeStreamWatcher.js +499 -764
- package/dist/realtime/deprecation.d.ts +1 -0
- package/dist/realtime/deprecation.js +9 -10
- package/dist/realtime/queryMatcher.js +110 -191
- package/dist/realtime/queryStore.js +35 -118
- package/dist/realtime/realtimeApp.d.ts +1 -0
- package/dist/realtime/realtimeApp.js +248 -401
- package/dist/realtime/registry.js +19 -30
- package/dist/realtime/sessionRevalidation.js +132 -358
- package/dist/realtime/socketAuth.js +89 -208
- package/dist/realtime/socketUser.js +10 -56
- package/dist/requestContext.js +93 -139
- package/dist/schemaMetadata.js +181 -265
- package/dist/scriptRunner.js +96 -266
- package/dist/scrubAdminFields.js +36 -108
- package/dist/secretProviders.js +130 -299
- package/dist/seedRunner.js +221 -514
- package/dist/sync/adminBroadcastScope.d.ts +40 -0
- package/dist/sync/adminBroadcastScope.js +82 -0
- package/dist/sync/adminWindowAccess.d.ts +13 -0
- package/dist/sync/adminWindowAccess.js +25 -0
- package/dist/sync/adminWindowMutation.d.ts +88 -0
- package/dist/sync/adminWindowMutation.js +176 -0
- package/dist/sync/executors.d.ts +9 -3
- package/dist/sync/executors.js +425 -598
- package/dist/sync/loadHarness.js +392 -689
- package/dist/sync/models.js +181 -341
- package/dist/sync/mutationHandler.d.ts +5 -2
- package/dist/sync/mutationHandler.js +549 -697
- package/dist/sync/registrationSideEffects.js +41 -95
- package/dist/sync/registry.js +31 -47
- package/dist/sync/routes.d.ts +13 -0
- package/dist/sync/routes.js +484 -760
- package/dist/sync/scripts/compactTombstones.js +83 -228
- package/dist/sync/serialize.js +18 -58
- package/dist/sync/socketHandlers.d.ts +8 -2
- package/dist/sync/socketHandlers.js +271 -402
- package/dist/sync/streams.d.ts +2 -0
- package/dist/sync/streams.js +54 -116
- package/dist/sync/syncApp.d.ts +2 -1
- package/dist/sync/syncApp.js +14 -16
- package/dist/sync/syncBatch.d.ts +5 -2
- package/dist/sync/syncBatch.js +63 -168
- package/dist/sync/syncSeqPlugin.js +430 -702
- package/dist/sync/types.d.ts +18 -0
- package/dist/syncConsents.js +113 -253
- package/dist/terrenoApp.d.ts +29 -0
- package/dist/terrenoApp.js +184 -257
- package/dist/tests/createTestData.d.ts +1 -3
- package/dist/tests/createTestData.js +147 -259
- package/dist/tests/models.d.ts +1 -0
- package/dist/tests/models.js +23 -56
- package/dist/tests/mongoTestSetup.js +42 -103
- package/dist/tests/testHelper.d.ts +0 -5
- package/dist/tests/testHelper.js +32 -101
- package/dist/tests.js +12 -51
- package/dist/transformers.js +61 -164
- package/dist/types/authToken.d.ts +3 -3
- package/dist/types/mcpServiceToken.d.ts +2 -2
- package/dist/types/membership.d.ts +23 -0
- package/dist/types/membership.js +2 -0
- package/dist/types/notification.d.ts +28 -0
- package/dist/types/notification.js +2 -0
- package/dist/types/notificationPreference.d.ts +20 -0
- package/dist/types/notificationPreference.js +2 -0
- package/dist/types/organization.d.ts +36 -0
- package/dist/types/organization.js +2 -0
- package/dist/utils.js +31 -93
- package/dist/vendor/wesleytodd-openapi/index.js +37 -51
- package/dist/vendor/wesleytodd-openapi/lib/generate-doc.js +32 -40
- package/dist/vendor/wesleytodd-openapi/lib/layer-schema.js +3 -3
- package/dist/vendor/wesleytodd-openapi/lib/ui.js +50 -19
- package/dist/vendor/wesleytodd-openapi/lib/validate.js +19 -47
- package/dist/versionCheckPlugin.js +52 -100
- package/dist/webhooks/headerValue.js +2 -2
- package/dist/webhooks/idempotency/memoryStore.js +16 -59
- package/dist/webhooks/idempotency/mongoStore.js +55 -130
- package/dist/webhooks/idempotency/webhookReceipt.d.ts +4 -49
- package/dist/webhooks/idempotency/webhookReceipt.js +14 -14
- package/dist/webhooks/rawBody.d.ts +1 -0
- package/dist/webhooks/rawBody.js +2 -1
- package/dist/webhooks/timingSafeEqual.js +4 -5
- package/dist/webhooks/verifiers/hmac.js +17 -18
- package/dist/webhooks/verifiers/sendgrid.js +20 -22
- package/dist/webhooks/verifiers/stripe.js +31 -65
- package/dist/webhooks/verifiers/twilio.js +23 -73
- package/dist/webhooks/webhooksApp.js +78 -177
- package/dist/zodOpenApi.js +2 -2
- package/package.json +34 -28
- package/src/__snapshots__/openApi.test.ts.snap +192 -54
- package/src/__snapshots__/openApiBuilder.test.ts.snap +0 -18
- package/src/__snapshots__/schemaMetadata.test.ts.snap +0 -1
- package/src/__tests__/browserLogsRoute.test.ts +165 -0
- package/src/adminTypes.ts +8 -0
- package/src/api.test.ts +39 -2
- package/src/api.ts +68 -0
- package/src/audit/auditApp.test.ts +243 -0
- package/src/audit/auditApp.ts +139 -0
- package/src/audit/auditEventModel.ts +160 -0
- package/src/audit/auditRouter.test.ts +456 -0
- package/src/audit/cloudTasksEnqueue.test.ts +124 -0
- package/src/audit/cloudTasksEnqueue.ts +104 -0
- package/src/audit/diff.ts +163 -0
- package/src/audit/processQueue.ts +69 -0
- package/src/audit/rbacSink.test.ts +86 -0
- package/src/audit/rbacSink.ts +42 -0
- package/src/audit/record.test.ts +402 -0
- package/src/audit/record.ts +329 -0
- package/src/auth.test.ts +1 -1
- package/src/auth.ts +1 -1
- package/src/authRecovery.test.ts +43 -0
- package/src/authRecovery.ts +16 -10
- package/src/authTokens.ts +6 -2
- package/src/authVerification.test.ts +22 -0
- package/src/betterAuth.ts +7 -0
- package/src/betterAuthSetup.test.ts +27 -0
- package/src/betterAuthSetup.ts +1 -0
- package/src/browserLogsRoute.ts +110 -0
- package/src/collectionRegistry.test.ts +8 -9
- package/src/collectionRegistry.ts +21 -1
- package/src/configurationPlugin.test.ts +1 -11
- package/src/express.d.ts +2 -0
- package/src/expressServer.test.ts +50 -2
- package/src/expressServer.ts +10 -0
- package/src/frameworkModelNames.test.ts +62 -0
- package/src/frameworkModelNames.ts +33 -0
- package/src/index.ts +76 -0
- package/src/isolated/migrateCliConnect.isolated.ts +51 -0
- package/src/mcp/auth.test.ts +34 -1
- package/src/mcp/handlers.test.ts +275 -0
- package/src/mcp/query.ts +3 -3
- package/src/mcp/toolGenerator.test.ts +81 -0
- package/src/migrations/cli.test.ts +353 -0
- package/src/migrations/cli.ts +283 -0
- package/src/migrations/fixtures/all-down/20260910120000-one.ts +6 -0
- package/src/migrations/fixtures/all-down/20260910120001-two.ts +6 -0
- package/src/migrations/fixtures/bad-id/20260910120000-mismatch.ts +4 -0
- package/src/migrations/fixtures/bad-name/not-a-migration.ts +4 -0
- package/src/migrations/fixtures/missing-up/20260910120000-noup.ts +2 -0
- package/src/migrations/fixtures/valid/20260910120000-alpha.ts +4 -0
- package/src/migrations/fixtures/valid/20260910120001-beta.ts +6 -0
- package/src/migrations/generate.test.ts +333 -0
- package/src/migrations/generate.ts +216 -0
- package/src/migrations/load.test.ts +103 -0
- package/src/migrations/load.ts +124 -0
- package/src/migrations/lock.test.ts +133 -0
- package/src/migrations/lock.ts +118 -0
- package/src/migrations/runner.test.ts +504 -0
- package/src/migrations/runner.ts +358 -0
- package/src/migrations/schemaCatalog.test.ts +159 -0
- package/src/migrations/schemaCatalog.ts +262 -0
- package/src/migrations/types.ts +94 -0
- package/src/models/mcpServiceToken.ts +4 -3
- package/src/models/notification.ts +69 -0
- package/src/models/notificationPreference.ts +62 -0
- package/src/notifications/notificationService.ts +254 -0
- package/src/notifications/notificationsApp.test.ts +528 -0
- package/src/notifications/notificationsApp.ts +200 -0
- package/src/notifications/notificationsBeforeSend.ts +51 -0
- package/src/notifiers/slackNotifier.test.ts +186 -1
- package/src/notifiers/slackNotifier.ts +167 -8
- package/src/openApi.test.ts +0 -1
- package/src/openApi.ts +2 -1
- package/src/openApiBuilder.ts +14 -3
- package/src/openApiValidator.test.ts +221 -2
- package/src/openApiValidator.ts +218 -33
- package/src/orgs/orgAccessOptIn.test.ts +87 -0
- package/src/orgs/orgContext.test.ts +259 -0
- package/src/orgs/orgContext.ts +151 -0
- package/src/orgs/orgPermissions.test.ts +105 -0
- package/src/orgs/orgPermissions.ts +40 -0
- package/src/orgs/orgPlugin.test.ts +130 -0
- package/src/orgs/orgPlugin.ts +70 -0
- package/src/orgs/orgRbac.test.ts +267 -0
- package/src/orgs/orgSecurityDefects.test.ts +415 -0
- package/src/orgs/organizationModel.test.ts +205 -0
- package/src/orgs/organizationModel.ts +262 -0
- package/src/orgs/organizationSettings.test.ts +113 -0
- package/src/orgs/organizationSettings.ts +126 -0
- package/src/orgs/orgsApp.test.ts +382 -0
- package/src/orgs/orgsApp.ts +563 -0
- package/src/permissions.test.ts +62 -36
- package/src/permissions.ts +8 -30
- package/src/plugins.test.ts +5 -0
- package/src/plugins.ts +3 -0
- package/src/rateLimit/middleware.ts +1 -1
- package/src/rateLimit/mongoStore.ts +1 -0
- package/src/rateLimit/policies.ts +2 -2
- package/src/rateLimit/redisStore.ts +1 -0
- package/src/rbac/access.ts +11 -3
- package/src/rbac/membershipOrgAdminSource.ts +59 -0
- package/src/rbac/modelRouterAccess.ts +3 -0
- package/src/rbac/permissionUtils.test.ts +26 -5
- package/src/rbac/resolve.test.ts +34 -2
- package/src/rbac/resolve.ts +26 -7
- package/src/rbac/roleModel.test.ts +34 -1
- package/src/rbac/roleModel.ts +17 -1
- package/src/rbac/statements.test.ts +19 -0
- package/src/rbac/statements.ts +19 -1
- package/src/rbac/types.ts +5 -0
- package/src/realtime/changeStreamWatcher.ts +73 -33
- package/src/realtime/deprecation.ts +1 -0
- package/src/realtime/realtime.test.ts +357 -185
- package/src/realtime/realtimeApp.ts +2 -1
- package/src/schemaMetadata.test.ts +14 -0
- package/src/schemaMetadata.ts +5 -5
- package/src/sync/adminBroadcastConfig.test.ts +96 -0
- package/src/sync/adminBroadcastScope.test.ts +155 -0
- package/src/sync/adminBroadcastScope.ts +123 -0
- package/src/sync/adminWindowAccess.test.ts +57 -0
- package/src/sync/adminWindowAccess.ts +32 -0
- package/src/sync/adminWindowMutation.test.ts +450 -0
- package/src/sync/adminWindowMutation.ts +283 -0
- package/src/sync/executors.ts +33 -6
- package/src/sync/integration.test.ts +2 -2
- package/src/sync/mutationHandler.test.ts +277 -1
- package/src/sync/mutationHandler.ts +171 -29
- package/src/sync/registry.ts +4 -0
- package/src/sync/routes.ts +52 -8
- package/src/sync/socketHandlers.ts +154 -58
- package/src/sync/streams.ts +6 -0
- package/src/sync/sync.test.ts +3 -2
- package/src/sync/syncApp.ts +2 -1
- package/src/sync/syncBatch.ts +7 -2
- package/src/sync/syncRoutes.test.ts +297 -3
- package/src/sync/syncSocket.test.ts +229 -0
- package/src/sync/types.ts +20 -0
- package/src/terrenoApp.migrations.test.ts +114 -0
- package/src/terrenoApp.test.ts +41 -0
- package/src/terrenoApp.ts +97 -31
- package/src/tests/createTestData.ts +2 -2
- package/src/tests/models.ts +10 -2
- package/src/tests/testHelper.ts +1 -7
- package/src/types/authToken.ts +2 -4
- package/src/types/mcpServiceToken.ts +1 -7
- package/src/types/membership.ts +48 -0
- package/src/types/notification.ts +34 -0
- package/src/types/notificationPreference.ts +28 -0
- package/src/types/organization.ts +49 -0
- package/src/types.d.ts +1 -0
- package/src/webhooks/idempotency/webhookReceipt.ts +8 -10
- package/src/webhooks/rawBody.test.ts +33 -0
- package/src/webhooks/rawBody.ts +1 -0
- package/tsconfig.json +13 -54
- package/tsconfig.typedoc.json +4 -1
- package/dist/vendor/wesleytodd-openapi/lib/convert-yaml.d.ts +0 -2
- package/dist/vendor/wesleytodd-openapi/lib/convert-yaml.js +0 -13
- package/src/vendor/wesleytodd-openapi/lib/convert-yaml.js +0 -13
|
@@ -0,0 +1,163 @@
|
|
|
1
|
+
const DEFAULT_AUDIT_REDACT_SEGMENTS = [
|
|
2
|
+
"hash",
|
|
3
|
+
"password",
|
|
4
|
+
"refreshToken",
|
|
5
|
+
"salt",
|
|
6
|
+
"secret",
|
|
7
|
+
"token",
|
|
8
|
+
] as const;
|
|
9
|
+
|
|
10
|
+
const isPlainObject = (value: unknown): value is Record<string, unknown> => {
|
|
11
|
+
return Boolean(value) && typeof value === "object" && !Array.isArray(value);
|
|
12
|
+
};
|
|
13
|
+
|
|
14
|
+
const DEFAULT_REDACT_LOWER = DEFAULT_AUDIT_REDACT_SEGMENTS.map((segment) => segment.toLowerCase());
|
|
15
|
+
|
|
16
|
+
/** Split camelCase / snake_case keys so `tokenHash` matches default `token` and `hash`. */
|
|
17
|
+
const fieldNameParts = (name: string): string[] => {
|
|
18
|
+
return name
|
|
19
|
+
.replace(/([a-z0-9])([A-Z])/g, "$1 $2")
|
|
20
|
+
.replace(/([A-Z]+)([A-Z][a-z])/g, "$1 $2")
|
|
21
|
+
.split(/[^A-Za-z0-9]+/)
|
|
22
|
+
.filter((part) => part.length > 0)
|
|
23
|
+
.map((part) => part.toLowerCase());
|
|
24
|
+
};
|
|
25
|
+
|
|
26
|
+
const isRedactedSegment = (name: string, extraRedact: string[] = []): boolean => {
|
|
27
|
+
const lower = name.toLowerCase();
|
|
28
|
+
const parts = fieldNameParts(name);
|
|
29
|
+
if (
|
|
30
|
+
DEFAULT_REDACT_LOWER.includes(lower) ||
|
|
31
|
+
parts.some((part) => DEFAULT_REDACT_LOWER.includes(part))
|
|
32
|
+
) {
|
|
33
|
+
return true;
|
|
34
|
+
}
|
|
35
|
+
return extraRedact.some((segment) => segment.toLowerCase() === lower);
|
|
36
|
+
};
|
|
37
|
+
|
|
38
|
+
const redactValue = (value: unknown, extraRedact: string[]): unknown => {
|
|
39
|
+
if (Array.isArray(value)) {
|
|
40
|
+
return value.map((item) => redactValue(item, extraRedact));
|
|
41
|
+
}
|
|
42
|
+
if (isPlainObject(value)) {
|
|
43
|
+
return redactRecord(value, extraRedact);
|
|
44
|
+
}
|
|
45
|
+
return value;
|
|
46
|
+
};
|
|
47
|
+
|
|
48
|
+
const redactRecord = (
|
|
49
|
+
input: Record<string, unknown>,
|
|
50
|
+
extraRedact: string[]
|
|
51
|
+
): Record<string, unknown> => {
|
|
52
|
+
const out: Record<string, unknown> = {};
|
|
53
|
+
for (const [key, nested] of Object.entries(input)) {
|
|
54
|
+
if (isRedactedSegment(key, extraRedact)) {
|
|
55
|
+
continue;
|
|
56
|
+
}
|
|
57
|
+
out[key] = redactValue(nested, extraRedact);
|
|
58
|
+
}
|
|
59
|
+
return out;
|
|
60
|
+
};
|
|
61
|
+
|
|
62
|
+
export const toAuditPlain = (value: unknown): Record<string, unknown> | undefined => {
|
|
63
|
+
if (value === null || value === undefined) {
|
|
64
|
+
return undefined;
|
|
65
|
+
}
|
|
66
|
+
const withJson = value as {toJSON?: () => unknown};
|
|
67
|
+
const raw = typeof withJson.toJSON === "function" ? withJson.toJSON() : value;
|
|
68
|
+
if (!isPlainObject(raw)) {
|
|
69
|
+
return undefined;
|
|
70
|
+
}
|
|
71
|
+
return JSON.parse(JSON.stringify(raw)) as Record<string, unknown>;
|
|
72
|
+
};
|
|
73
|
+
|
|
74
|
+
const valuesEqual = (left: unknown, right: unknown): boolean => {
|
|
75
|
+
return JSON.stringify(left) === JSON.stringify(right);
|
|
76
|
+
};
|
|
77
|
+
|
|
78
|
+
const diffShallow = (
|
|
79
|
+
before: Record<string, unknown>,
|
|
80
|
+
after: Record<string, unknown>
|
|
81
|
+
): {after: Record<string, unknown>; before: Record<string, unknown>} => {
|
|
82
|
+
const beforeOut: Record<string, unknown> = {};
|
|
83
|
+
const afterOut: Record<string, unknown> = {};
|
|
84
|
+
const keys = new Set([...Object.keys(before), ...Object.keys(after)]);
|
|
85
|
+
for (const key of keys) {
|
|
86
|
+
const previous = before[key];
|
|
87
|
+
const next = after[key];
|
|
88
|
+
if (valuesEqual(previous, next)) {
|
|
89
|
+
continue;
|
|
90
|
+
}
|
|
91
|
+
if (previous !== undefined) {
|
|
92
|
+
beforeOut[key] = previous;
|
|
93
|
+
}
|
|
94
|
+
if (next !== undefined) {
|
|
95
|
+
afterOut[key] = next;
|
|
96
|
+
}
|
|
97
|
+
}
|
|
98
|
+
return {after: afterOut, before: beforeOut};
|
|
99
|
+
};
|
|
100
|
+
|
|
101
|
+
export const changedFieldDiff = ({
|
|
102
|
+
after,
|
|
103
|
+
before,
|
|
104
|
+
extraRedact = [],
|
|
105
|
+
}: {
|
|
106
|
+
after?: Record<string, unknown>;
|
|
107
|
+
before?: Record<string, unknown>;
|
|
108
|
+
extraRedact?: string[];
|
|
109
|
+
}): {after?: Record<string, unknown>; before?: Record<string, unknown>} => {
|
|
110
|
+
const redactedBefore = before ? redactRecord(before, extraRedact) : undefined;
|
|
111
|
+
const redactedAfter = after ? redactRecord(after, extraRedact) : undefined;
|
|
112
|
+
if (!redactedBefore) {
|
|
113
|
+
return redactedAfter ? {after: redactedAfter} : {};
|
|
114
|
+
}
|
|
115
|
+
if (!redactedAfter) {
|
|
116
|
+
return {before: redactedBefore};
|
|
117
|
+
}
|
|
118
|
+
|
|
119
|
+
const beforeOut: Record<string, unknown> = {};
|
|
120
|
+
const afterOut: Record<string, unknown> = {};
|
|
121
|
+
const keys = new Set([...Object.keys(redactedBefore), ...Object.keys(redactedAfter)]);
|
|
122
|
+
for (const key of keys) {
|
|
123
|
+
const previous = redactedBefore[key];
|
|
124
|
+
const next = redactedAfter[key];
|
|
125
|
+
if (isPlainObject(previous) && isPlainObject(next)) {
|
|
126
|
+
const nested = diffShallow(previous, next);
|
|
127
|
+
if (Object.keys(nested.before).length > 0) {
|
|
128
|
+
beforeOut[key] = nested.before;
|
|
129
|
+
}
|
|
130
|
+
if (Object.keys(nested.after).length > 0) {
|
|
131
|
+
afterOut[key] = nested.after;
|
|
132
|
+
}
|
|
133
|
+
continue;
|
|
134
|
+
}
|
|
135
|
+
if (valuesEqual(previous, next)) {
|
|
136
|
+
continue;
|
|
137
|
+
}
|
|
138
|
+
if (previous !== undefined) {
|
|
139
|
+
beforeOut[key] = previous;
|
|
140
|
+
}
|
|
141
|
+
if (next !== undefined) {
|
|
142
|
+
afterOut[key] = next;
|
|
143
|
+
}
|
|
144
|
+
}
|
|
145
|
+
|
|
146
|
+
return {
|
|
147
|
+
...(Object.keys(afterOut).length > 0 ? {after: afterOut} : {}),
|
|
148
|
+
...(Object.keys(beforeOut).length > 0 ? {before: beforeOut} : {}),
|
|
149
|
+
};
|
|
150
|
+
};
|
|
151
|
+
|
|
152
|
+
export const recordLabelFromDoc = (doc?: Record<string, unknown>): string | undefined => {
|
|
153
|
+
if (!doc) {
|
|
154
|
+
return undefined;
|
|
155
|
+
}
|
|
156
|
+
for (const field of ["title", "name", "email"]) {
|
|
157
|
+
const value = doc[field];
|
|
158
|
+
if (typeof value === "string" && value.length > 0) {
|
|
159
|
+
return value;
|
|
160
|
+
}
|
|
161
|
+
}
|
|
162
|
+
return undefined;
|
|
163
|
+
};
|
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
import {timingSafeEqual} from "node:crypto";
|
|
2
|
+
|
|
3
|
+
import type {Request, Response} from "express";
|
|
4
|
+
|
|
5
|
+
import {APIError} from "../errors";
|
|
6
|
+
import {AUDIT_SECRET_HEADER} from "./cloudTasksEnqueue";
|
|
7
|
+
import type {AuditEventWrite} from "./record";
|
|
8
|
+
import {persistEnqueuedAuditEvent} from "./record";
|
|
9
|
+
|
|
10
|
+
const secretsMatch = (provided: string | undefined, expected: string): boolean => {
|
|
11
|
+
if (!provided) {
|
|
12
|
+
return false;
|
|
13
|
+
}
|
|
14
|
+
const left = Buffer.from(provided);
|
|
15
|
+
const right = Buffer.from(expected);
|
|
16
|
+
if (left.length !== right.length) {
|
|
17
|
+
return false;
|
|
18
|
+
}
|
|
19
|
+
return timingSafeEqual(left, right);
|
|
20
|
+
};
|
|
21
|
+
|
|
22
|
+
const isAuditEventWrite = (value: unknown): value is AuditEventWrite => {
|
|
23
|
+
if (!value || typeof value !== "object") {
|
|
24
|
+
return false;
|
|
25
|
+
}
|
|
26
|
+
const record = value as Record<string, unknown>;
|
|
27
|
+
const validOperations: AuditEventWrite["operation"][] = [
|
|
28
|
+
"arrayPush",
|
|
29
|
+
"arrayRemove",
|
|
30
|
+
"arrayUpdate",
|
|
31
|
+
"create",
|
|
32
|
+
"delete",
|
|
33
|
+
"update",
|
|
34
|
+
];
|
|
35
|
+
const validSources: AuditEventWrite["source"][] = ["admin", "modelRouter", "rbac"];
|
|
36
|
+
const validVerbs: AuditEventWrite["verb"][] = ["created", "deleted", "updated"];
|
|
37
|
+
return (
|
|
38
|
+
typeof record.modelName === "string" &&
|
|
39
|
+
record.modelName.length > 0 &&
|
|
40
|
+
typeof record.operation === "string" &&
|
|
41
|
+
validOperations.includes(record.operation as AuditEventWrite["operation"]) &&
|
|
42
|
+
typeof record.source === "string" &&
|
|
43
|
+
validSources.includes(record.source as AuditEventWrite["source"]) &&
|
|
44
|
+
typeof record.verb === "string" &&
|
|
45
|
+
validVerbs.includes(record.verb as AuditEventWrite["verb"])
|
|
46
|
+
);
|
|
47
|
+
};
|
|
48
|
+
|
|
49
|
+
export const handleEnqueuedAuditWrite = async ({
|
|
50
|
+
req,
|
|
51
|
+
res,
|
|
52
|
+
secret,
|
|
53
|
+
}: {
|
|
54
|
+
req: Request;
|
|
55
|
+
res: Response;
|
|
56
|
+
secret: string;
|
|
57
|
+
}): Promise<Response> => {
|
|
58
|
+
const provided = req.header(AUDIT_SECRET_HEADER);
|
|
59
|
+
if (!secretsMatch(provided, secret)) {
|
|
60
|
+
throw new APIError({status: 401, title: "Unauthorized"});
|
|
61
|
+
}
|
|
62
|
+
if (!isAuditEventWrite(req.body)) {
|
|
63
|
+
// Cloud Tasks retries every non-2xx response. This authenticated task cannot
|
|
64
|
+
// become valid on retry, so acknowledge it rather than retrying it forever.
|
|
65
|
+
return res.status(204).end();
|
|
66
|
+
}
|
|
67
|
+
await persistEnqueuedAuditEvent(req.body);
|
|
68
|
+
return res.status(204).end();
|
|
69
|
+
};
|
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
import {afterEach, beforeEach, describe, it} from "bun:test";
|
|
2
|
+
import {assert} from "chai";
|
|
3
|
+
import mongoose from "mongoose";
|
|
4
|
+
|
|
5
|
+
import type {UserModel as AuthUserModel} from "../auth";
|
|
6
|
+
import {TerrenoApp} from "../terrenoApp";
|
|
7
|
+
import {setupDb, UserModel} from "../tests";
|
|
8
|
+
import {AuditApp} from "./auditApp";
|
|
9
|
+
import {persistRbacAuditToAuditEvent} from "./rbacSink";
|
|
10
|
+
import {flushAuditRecorderForTests, resetAuditRecorderForTests} from "./record";
|
|
11
|
+
|
|
12
|
+
const typedUserModel = UserModel as unknown as AuthUserModel;
|
|
13
|
+
|
|
14
|
+
const deleteAuditEventModel = (): void => {
|
|
15
|
+
if (mongoose.connection.models.TerrenoAuditEvent) {
|
|
16
|
+
mongoose.connection.deleteModel("TerrenoAuditEvent");
|
|
17
|
+
}
|
|
18
|
+
};
|
|
19
|
+
|
|
20
|
+
describe("persistRbacAuditToAuditEvent", () => {
|
|
21
|
+
beforeEach(async () => {
|
|
22
|
+
deleteAuditEventModel();
|
|
23
|
+
resetAuditRecorderForTests();
|
|
24
|
+
await setupDb();
|
|
25
|
+
await mongoose.connection.collection("auditevents").deleteMany({});
|
|
26
|
+
new TerrenoApp({
|
|
27
|
+
skipListen: true,
|
|
28
|
+
userModel: typedUserModel,
|
|
29
|
+
})
|
|
30
|
+
.register(new AuditApp())
|
|
31
|
+
.build();
|
|
32
|
+
});
|
|
33
|
+
|
|
34
|
+
afterEach(() => {
|
|
35
|
+
resetAuditRecorderForTests();
|
|
36
|
+
deleteAuditEventModel();
|
|
37
|
+
});
|
|
38
|
+
|
|
39
|
+
it("maps role.create to source rbac with created verb and permissionDelta", async () => {
|
|
40
|
+
const actorId = new mongoose.Types.ObjectId().toString();
|
|
41
|
+
await persistRbacAuditToAuditEvent({
|
|
42
|
+
action: "role.create",
|
|
43
|
+
actorId,
|
|
44
|
+
permissionDelta: {gained: {todo: ["read"]}, lost: {}},
|
|
45
|
+
targetRoleName: "manager",
|
|
46
|
+
});
|
|
47
|
+
await flushAuditRecorderForTests();
|
|
48
|
+
const events = await mongoose.connection.collection("auditevents").find({}).toArray();
|
|
49
|
+
assert.equal(events.length, 1);
|
|
50
|
+
assert.equal(events[0]?.source, "rbac");
|
|
51
|
+
assert.equal(events[0]?.verb, "created");
|
|
52
|
+
assert.equal(events[0]?.operation, "create");
|
|
53
|
+
assert.equal(events[0]?.modelName, "RbacRole");
|
|
54
|
+
assert.equal(events[0]?.recordLabel, "manager");
|
|
55
|
+
assert.deepEqual((events[0]?.after as {gained?: unknown})?.gained, {todo: ["read"]});
|
|
56
|
+
});
|
|
57
|
+
|
|
58
|
+
it("maps denied actions to updated", async () => {
|
|
59
|
+
const actorId = new mongoose.Types.ObjectId().toString();
|
|
60
|
+
await persistRbacAuditToAuditEvent({
|
|
61
|
+
action: "role.create",
|
|
62
|
+
actorId,
|
|
63
|
+
denied: true,
|
|
64
|
+
permissionDelta: {gained: {todo: ["delete"]}, lost: {}},
|
|
65
|
+
targetUserId: actorId,
|
|
66
|
+
});
|
|
67
|
+
await flushAuditRecorderForTests();
|
|
68
|
+
const events = await mongoose.connection.collection("auditevents").find({}).toArray();
|
|
69
|
+
assert.equal(events[0]?.verb, "updated");
|
|
70
|
+
assert.equal(events[0]?.source, "rbac");
|
|
71
|
+
assert.equal(events[0]?.modelName, "User");
|
|
72
|
+
});
|
|
73
|
+
|
|
74
|
+
it("omits a 12-character actorId that mongoose would otherwise coerce", async () => {
|
|
75
|
+
await persistRbacAuditToAuditEvent({
|
|
76
|
+
action: "role.create",
|
|
77
|
+
actorId: "microsoft123",
|
|
78
|
+
permissionDelta: {gained: {todo: ["read"]}, lost: {}},
|
|
79
|
+
targetRoleName: "manager",
|
|
80
|
+
});
|
|
81
|
+
await flushAuditRecorderForTests();
|
|
82
|
+
const event = await mongoose.connection.collection("auditevents").findOne({});
|
|
83
|
+
assert.equal(event?.modelName, "RbacRole");
|
|
84
|
+
assert.isUndefined(event?.actorId);
|
|
85
|
+
});
|
|
86
|
+
});
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
import type {RbacAuditWrite} from "../rbac/auditModel";
|
|
2
|
+
import type {AuditEventOperation, AuditEventVerb} from "./auditEventModel";
|
|
3
|
+
import {actorIdForAuditWrite, recordAuditEvent} from "./record";
|
|
4
|
+
|
|
5
|
+
const RBAC_AUDIT_VERBS: Record<string, AuditEventVerb> = {
|
|
6
|
+
"role.create": "created",
|
|
7
|
+
"role.remove": "deleted",
|
|
8
|
+
};
|
|
9
|
+
|
|
10
|
+
const operationFromVerb = (verb: AuditEventVerb): AuditEventOperation => {
|
|
11
|
+
if (verb === "created") {
|
|
12
|
+
return "create";
|
|
13
|
+
}
|
|
14
|
+
if (verb === "deleted") {
|
|
15
|
+
return "delete";
|
|
16
|
+
}
|
|
17
|
+
return "update";
|
|
18
|
+
};
|
|
19
|
+
|
|
20
|
+
export const persistRbacAuditToAuditEvent = async (record: RbacAuditWrite): Promise<void> => {
|
|
21
|
+
const mappedVerb = RBAC_AUDIT_VERBS[record.action];
|
|
22
|
+
const verb: AuditEventVerb = record.denied || !mappedVerb ? "updated" : mappedVerb;
|
|
23
|
+
const after: Record<string, unknown> = {
|
|
24
|
+
action: record.action,
|
|
25
|
+
denied: record.denied ?? false,
|
|
26
|
+
};
|
|
27
|
+
if (record.permissionDelta?.gained) {
|
|
28
|
+
after.gained = record.permissionDelta.gained;
|
|
29
|
+
}
|
|
30
|
+
const before = record.permissionDelta?.lost ? {lost: record.permissionDelta.lost} : undefined;
|
|
31
|
+
void recordAuditEvent({
|
|
32
|
+
actorId: actorIdForAuditWrite(record.actorId),
|
|
33
|
+
after,
|
|
34
|
+
before,
|
|
35
|
+
modelName: record.targetRoleName ? "RbacRole" : "User",
|
|
36
|
+
operation: operationFromVerb(verb),
|
|
37
|
+
recordId: record.targetUserId ?? record.targetRoleName,
|
|
38
|
+
recordLabel: record.targetRoleName ?? record.targetUserId,
|
|
39
|
+
source: "rbac",
|
|
40
|
+
verb,
|
|
41
|
+
});
|
|
42
|
+
};
|