@payez/next-mvp 4.8.1 → 4.8.2
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/POST-INSTALL.md +408 -408
- package/README.md +859 -859
- package/dist/components/account/MobileNavDrawer.js +18 -18
- package/dist/components/account/UserAvatarMenu.js +1 -1
- package/dist/components/admin/AlertSettingsTab.js +40 -40
- package/dist/components/admin/LoggingSettingsTab.js +28 -28
- package/dist/lib/session-store.js +21 -21
- package/dist/lib/startup-init.js +19 -19
- package/dist/pages/login/page.js +28 -28
- package/dist/pages/settings/EnhancedSettingsPage.js +17 -17
- package/dist/vibe/sessions.js +28 -3
- package/package.json +2 -2
- package/scripts/check-publish-eol.mjs +33 -15
- package/src/api/auth-handler.ts +550 -550
- package/src/api/index.ts +17 -17
- package/src/api-handlers/account/change-password.ts +170 -170
- package/src/api-handlers/account/masked-info.ts +46 -46
- package/src/api-handlers/account/profile.ts +99 -99
- package/src/api-handlers/account/recovery/forward.ts +117 -117
- package/src/api-handlers/account/recovery/initiate.ts +59 -59
- package/src/api-handlers/account/recovery/send-code.ts +21 -21
- package/src/api-handlers/account/recovery/verify-code.ts +20 -20
- package/src/api-handlers/account/reset-password.ts +87 -87
- package/src/api-handlers/account/send-code.ts +70 -70
- package/src/api-handlers/account/update-phone.ts +84 -84
- package/src/api-handlers/account/validate-password.ts +139 -139
- package/src/api-handlers/account/verify-email.ts +134 -134
- package/src/api-handlers/account/verify-sms.ts +134 -134
- package/src/api-handlers/admin/analytics.ts +452 -452
- package/src/api-handlers/admin/audit.ts +232 -232
- package/src/api-handlers/admin/index.ts +63 -63
- package/src/api-handlers/admin/redis-sessions.ts +259 -259
- package/src/api-handlers/admin/sessions.ts +327 -327
- package/src/api-handlers/admin/site-logs.ts +388 -388
- package/src/api-handlers/admin/stats.ts +260 -260
- package/src/api-handlers/admin/users.ts +251 -251
- package/src/api-handlers/admin/vibe-data.ts +333 -333
- package/src/api-handlers/anon/preferences.ts +123 -123
- package/src/api-handlers/auth/credential-login-email-code.ts +92 -92
- package/src/api-handlers/auth/credential-login.ts +948 -948
- package/src/api-handlers/auth/jwks.ts +31 -31
- package/src/api-handlers/auth/login.ts +252 -252
- package/src/api-handlers/auth/passkey-signin.ts +116 -116
- package/src/api-handlers/auth/refresh.ts +829 -829
- package/src/api-handlers/auth/signout.ts +201 -201
- package/src/api-handlers/auth/status.ts +23 -23
- package/src/api-handlers/auth/update-session.ts +144 -144
- package/src/api-handlers/auth/validate.ts +45 -45
- package/src/api-handlers/auth/verify-code.ts +116 -116
- package/src/api-handlers/mfa/backup-code-verify.ts +170 -170
- package/src/api-handlers/mfa/backup-codes.ts +42 -42
- package/src/api-handlers/mfa/methods.ts +47 -47
- package/src/api-handlers/mfa/totp-confirm.ts +43 -43
- package/src/api-handlers/mfa/totp-enroll.ts +43 -43
- package/src/api-handlers/mfa/totp-verify.ts +172 -172
- package/src/api-handlers/oauth/resume.ts +182 -182
- package/src/api-handlers/onboarding/send-email-code.ts +18 -18
- package/src/api-handlers/onboarding/set-password.ts +21 -21
- package/src/api-handlers/onboarding/verify-code.ts +20 -20
- package/src/api-handlers/onboarding/verify-welcome-email.ts +17 -17
- package/src/api-handlers/passkeys/list.ts +32 -32
- package/src/api-handlers/passkeys/manage.ts +55 -55
- package/src/api-handlers/passkeys/register-options.ts +43 -43
- package/src/api-handlers/passkeys/register-verify.ts +42 -42
- package/src/api-handlers/session/refresh-viability.ts +56 -56
- package/src/api-handlers/session/viability.ts +238 -238
- package/src/api-handlers/test/force-expire.ts +167 -167
- package/src/auth/auth-decision.ts +292 -292
- package/src/auth/better-auth.ts +1688 -1688
- package/src/auth/idp-oauth.ts +310 -310
- package/src/auth/password-reset-bridge.ts +98 -98
- package/src/auth/revocation-fields.ts +16 -16
- package/src/auth/route-config.ts +236 -236
- package/src/auth/safe-callback.ts +199 -199
- package/src/auth/session-cookie-clear.ts +30 -30
- package/src/auth/session-reset-link.ts +159 -159
- package/src/auth/session-response-sanitizer.ts +151 -151
- package/src/auth/types/auth-types.ts +555 -555
- package/src/auth/types/index.ts +7 -7
- package/src/auth/unauthenticated-routes.ts +2 -2
- package/src/auth/utils/idp-client.ts +364 -364
- package/src/auth/utils/index.ts +6 -6
- package/src/auth/utils/token-utils.ts +243 -243
- package/src/client/AuthContext.tsx +192 -192
- package/src/client/better-auth-client.ts +70 -70
- package/src/client/fetch-with-auth.ts +47 -47
- package/src/client/fetchWithSession.ts +21 -21
- package/src/client/index.ts +13 -13
- package/src/client/useAnonSession.ts +131 -131
- package/src/components/SessionSync.tsx +138 -138
- package/src/components/SignalRHealthCheck.tsx +131 -131
- package/src/components/account/MobileNavDrawer.tsx +305 -305
- package/src/components/account/UserAvatarMenu.tsx +277 -277
- package/src/components/account/index.ts +13 -13
- package/src/components/admin/AlertSettingsTab.tsx +728 -728
- package/src/components/admin/AnalyticsTab.tsx +703 -703
- package/src/components/admin/DataBrowserTab.tsx +508 -508
- package/src/components/admin/LoggingSettingsTab.tsx +665 -665
- package/src/components/admin/SessionsTab.tsx +421 -421
- package/src/components/admin/StatsTab.tsx +379 -379
- package/src/components/admin/VibeAdminContext.tsx +87 -87
- package/src/components/admin/VibeAdminLayout.tsx +187 -187
- package/src/components/admin/index.ts +59 -59
- package/src/components/auth/CredentialSignInForm.tsx +240 -240
- package/src/components/auth/FederatedAuthSection.tsx +129 -129
- package/src/components/auth/ModeAwareLoginPage.tsx +146 -146
- package/src/components/auth/ModeAwareSignupPage.tsx +200 -200
- package/src/components/auth/PasswordResetBridge.tsx +30 -30
- package/src/components/auth/TraditionalAuthSection.tsx +103 -103
- package/src/components/recovery/CompleteStep.tsx +36 -36
- package/src/components/recovery/InitiateRecoveryStep.tsx +68 -68
- package/src/components/recovery/RequestedStep.tsx +30 -30
- package/src/components/recovery/SelectMethodStep.tsx +73 -73
- package/src/components/recovery/SetPasswordStep.tsx +118 -118
- package/src/components/recovery/VerifyCodeStep.tsx +90 -90
- package/src/components/reserved/ReservedRecoveryWarning.tsx +160 -160
- package/src/components/reserved/ReservedStatusBox.tsx +118 -118
- package/src/components/ui/BetaBadge.tsx +58 -58
- package/src/components/ui/Footer.tsx +93 -93
- package/src/config/env.ts +55 -55
- package/src/config/logger.ts +62 -62
- package/src/config/logging-config.ts +82 -82
- package/src/config/unauthenticated-routes.ts +19 -19
- package/src/config/vibe-log-transport.ts +264 -264
- package/src/edge/internal-api-url.ts +65 -65
- package/src/edge/middleware.ts +42 -42
- package/src/hooks/useAuth.ts +117 -117
- package/src/hooks/useAuthSettings.ts +109 -109
- package/src/hooks/useAvailableProviders.ts +143 -143
- package/src/hooks/usePasswordValidation.ts +127 -127
- package/src/hooks/useProfile.ts +82 -82
- package/src/hooks/usePublicAuthSettings.ts +171 -171
- package/src/hooks/useSessionExpiration.ts +101 -101
- package/src/hooks/useViabilitySession.ts +337 -337
- package/src/index.ts +64 -64
- package/src/lib/anon-session.ts +213 -213
- package/src/lib/api-handler.ts +643 -643
- package/src/lib/app-slug.ts +228 -228
- package/src/lib/authorize-resume.ts +172 -172
- package/src/lib/bearer-fetch.ts +31 -31
- package/src/lib/client-key.ts +88 -88
- package/src/lib/code-step-copy.ts +83 -83
- package/src/lib/credential-sign-in-client.ts +101 -101
- package/src/lib/demo-mode.ts +18 -18
- package/src/lib/device-id.ts +67 -67
- package/src/lib/ensure-fresh-access-token.ts +509 -509
- package/src/lib/geolocation.ts +265 -265
- package/src/lib/idp-client-config.ts +1005 -1005
- package/src/lib/idp-fetch.ts +169 -169
- package/src/lib/idp-url-guard.ts +37 -37
- package/src/lib/internal-api.ts +171 -171
- package/src/lib/jwt-decode-client.ts +45 -45
- package/src/lib/jwt-decode.ts +82 -82
- package/src/lib/lock-window.ts +49 -49
- package/src/lib/login-error-message.ts +41 -41
- package/src/lib/never-in-response.ts +64 -64
- package/src/lib/nextauth-secret.ts +168 -168
- package/src/lib/onboarding-proxy.ts +57 -57
- package/src/lib/password-rules.ts +50 -50
- package/src/lib/rate-limit-service.ts +9 -9
- package/src/lib/redis.ts +105 -105
- package/src/lib/refresh-token-validator.ts +64 -64
- package/src/lib/roles.ts +177 -177
- package/src/lib/safe-error-response.ts +149 -149
- package/src/lib/secret-validation.ts +8 -8
- package/src/lib/session-cookie-shape.ts +185 -185
- package/src/lib/session-store.ts +1092 -1092
- package/src/lib/session.ts +34 -34
- package/src/lib/single-flight.ts +64 -64
- package/src/lib/site-logger.ts +245 -245
- package/src/lib/standardized-client-api.ts +901 -901
- package/src/lib/startup-init.ts +276 -276
- package/src/lib/test-aware-get-token.ts +41 -41
- package/src/lib/token-expiry.ts +40 -40
- package/src/lib/token-lifecycle.ts +546 -546
- package/src/lib/token-log-id.ts +69 -69
- package/src/lib/twofa-rejection.ts +91 -91
- package/src/lib/types/api-responses.ts +336 -336
- package/src/lib/user-agent-parser.ts +252 -252
- package/src/logging/api/admin-analytics.ts +51 -51
- package/src/logging/api/audit-log.ts +53 -53
- package/src/logging/components/AdminAnalyticsLayout.tsx +49 -49
- package/src/logging/components/AuditLogViewer.tsx +125 -125
- package/src/logging/components/ErrorMetricsCard.tsx +98 -98
- package/src/logging/components/HealthMetricsCard.tsx +70 -70
- package/src/logging/hooks/useAdminAnalytics.ts +22 -22
- package/src/logging/hooks/useAuditLog.ts +24 -24
- package/src/logging/hooks/useErrorMetrics.ts +40 -40
- package/src/logging/hooks/useHealthMetrics.ts +44 -44
- package/src/logging/index.ts +18 -18
- package/src/logging/types/analytics.ts +81 -81
- package/src/logging/types/audit.ts +31 -31
- package/src/logging/types/index.ts +3 -3
- package/src/middleware/create-middleware.ts +1141 -1141
- package/src/middleware/rbac-check.ts +279 -279
- package/src/middleware/twofa-presets.ts +224 -224
- package/src/models/DecodedAccessToken.ts +16 -16
- package/src/models/SessionModel.ts +331 -331
- package/src/pages/admin-login/page.tsx +111 -111
- package/src/pages/admin-page-permissions/PagePermissionsAdminPage.tsx +527 -527
- package/src/pages/admin-page-permissions/index.ts +7 -7
- package/src/pages/admin-roles/RolesAdminPage.tsx +533 -533
- package/src/pages/admin-roles/index.ts +9 -9
- package/src/pages/admin-roles/modals.tsx +469 -469
- package/src/pages/client-admin/ClientSiteAdminPage.tsx +382 -382
- package/src/pages/client-admin/index.ts +33 -33
- package/src/pages/coming-soon/page.tsx +83 -83
- package/src/pages/login/page.tsx +338 -338
- package/src/pages/onboarding/index.ts +11 -11
- package/src/pages/onboarding/page.tsx +212 -212
- package/src/pages/profile/EnhancedProfilePage.tsx +514 -514
- package/src/pages/profile/index.ts +9 -9
- package/src/pages/profile/page.tsx +166 -166
- package/src/pages/recovery/page.tsx +267 -267
- package/src/pages/roles/MyRolesPage.tsx +211 -211
- package/src/pages/roles/components.tsx +294 -294
- package/src/pages/roles/index.ts +17 -17
- package/src/pages/security/EnhancedSecurityPage.tsx +660 -660
- package/src/pages/security/index.ts +12 -12
- package/src/pages/security/page.tsx +507 -507
- package/src/pages/service-unavailable/page.tsx +63 -63
- package/src/pages/settings/EnhancedSettingsPage.tsx +642 -642
- package/src/pages/settings/index.ts +9 -9
- package/src/pages/settings/page.tsx +47 -47
- package/src/pages/showcase/ShowcasePage.tsx +532 -532
- package/src/pages/showcase/index.ts +13 -13
- package/src/pages/test-env/EmergencyLogoutPage.tsx +192 -192
- package/src/pages/test-env/JwtInspectPage.tsx +449 -449
- package/src/pages/test-env/RefreshTokenPage.tsx +178 -178
- package/src/pages/test-env/TestEnvPage.tsx +130 -130
- package/src/pages/test-env/guarded.tsx +81 -81
- package/src/pages/test-env/index.ts +77 -77
- package/src/pages/test-env/redact-credentials.ts +96 -96
- package/src/pages/verify-code/page.tsx +746 -746
- package/src/routes/account/index.ts +31 -31
- package/src/routes/account/masked-info.ts +36 -36
- package/src/routes/account/send-code.ts +39 -39
- package/src/routes/account/update-phone.ts +13 -13
- package/src/routes/account/verify-email.ts +40 -40
- package/src/routes/account/verify-sms.ts +40 -40
- package/src/routes/auth/credential-login-email-code.ts +6 -6
- package/src/routes/auth/credential-login.ts +6 -6
- package/src/routes/auth/index.ts +22 -22
- package/src/routes/auth/logout.ts +111 -111
- package/src/routes/auth/nextauth.ts +45 -45
- package/src/routes/auth/passkey-signin.ts +13 -13
- package/src/routes/auth/refresh.ts +77 -77
- package/src/routes/auth/session-reset.ts +37 -37
- package/src/routes/auth/session.ts +261 -261
- package/src/routes/auth/settings.ts +181 -181
- package/src/routes/auth/viability.ts +519 -519
- package/src/routes/index.ts +17 -17
- package/src/routes/mfa/backup-code-verify.ts +1 -1
- package/src/routes/mfa/backup-codes.ts +10 -10
- package/src/routes/mfa/methods.ts +22 -22
- package/src/routes/mfa/totp-confirm.ts +10 -10
- package/src/routes/mfa/totp-enroll.ts +10 -10
- package/src/routes/mfa/totp-verify.ts +14 -14
- package/src/routes/onboarding/index.ts +15 -15
- package/src/routes/onboarding/send-email-code.ts +2 -2
- package/src/routes/onboarding/set-password.ts +2 -2
- package/src/routes/onboarding/verify-code.ts +2 -2
- package/src/routes/onboarding/verify-welcome-email.ts +2 -2
- package/src/routes/passkeys/list.ts +10 -10
- package/src/routes/passkeys/manage.ts +23 -23
- package/src/routes/passkeys/register-options.ts +10 -10
- package/src/routes/passkeys/register-verify.ts +10 -10
- package/src/routes/session/index.ts +7 -7
- package/src/routes/session/refresh-viability.ts +17 -17
- package/src/server/auth-guard.ts +203 -203
- package/src/server/auth.ts +486 -486
- package/src/server/decode-session.ts +309 -309
- package/src/server/slim-middleware.ts +117 -117
- package/src/server/verified-session-token.ts +103 -103
- package/src/server/with-auth.ts +93 -93
- package/src/services/signalrActivityService.ts +258 -258
- package/src/stores/authStore.ts +1900 -1900
- package/src/templates/instrumentation.ts +60 -60
- package/src/theme/ThemeProvider.tsx +39 -39
- package/src/theme/default.ts +33 -33
- package/src/theme/index.ts +31 -31
- package/src/theme/types.ts +69 -69
- package/src/theme/useTheme.ts +57 -57
- package/src/theme/utils.ts +40 -40
- package/src/types/api.ts +12 -12
- package/src/types/auth.d.ts +23 -23
- package/src/types/auth.ts +48 -48
- package/src/types/logging.ts +11 -11
- package/src/types/recovery.ts +54 -54
- package/src/utils/api.ts +401 -401
- package/src/utils/circuitBreaker.ts +40 -40
- package/src/utils/error-message.ts +108 -108
- package/src/utils/layout/reservedSpace.ts +124 -124
- package/src/utils/logout.ts +30 -30
- package/src/vibe/client.ts +877 -877
- package/src/vibe/enterprise-auth.ts +208 -208
- package/src/vibe/errors.ts +209 -209
- package/src/vibe/generic.ts +339 -339
- package/src/vibe/hooks/index.ts +367 -367
- package/src/vibe/index.ts +133 -133
- package/src/vibe/sessions.ts +925 -899
- package/src/vibe/types.ts +577 -577
|
@@ -1,81 +1,81 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* SERVER-COMPONENT GUARDS for the test-env debug pages (card 249259, BAPert
|
|
3
|
-
* ruling 35321). These are what `@payez/next-mvp/pages/test-env` exports. The
|
|
4
|
-
* raw client components are NOT exported.
|
|
5
|
-
*
|
|
6
|
-
* ── WHAT THIS IS, AND WHAT IT IS EMPHATICALLY NOT ───────────────────────────
|
|
7
|
-
* MOUNTING IS STILL THE PRIMARY GATE. This wrapper is a backstop for a mount
|
|
8
|
-
* that should not have happened. It is NOT a licence to mount these freely:
|
|
9
|
-
* setting ENABLE_TEST_ROUTES=true in an environment where these pages are
|
|
10
|
-
* mounted gives you exactly the exposure this package spent 248991 documenting
|
|
11
|
-
* - a live session token and a copy button. If you are not actively debugging,
|
|
12
|
-
* DO NOT MOUNT THESE AT ALL. The safest configuration remains their absence.
|
|
13
|
-
*
|
|
14
|
-
* ── WHY A SERVER COMPONENT, AND WHY THE PAGES THEMSELVES CANNOT DO THIS ─────
|
|
15
|
-
* 248991 item 2 asked for a per-page env gate and it was correctly REFUSED:
|
|
16
|
-
* the pages are `'use client'`, and non-`NEXT_PUBLIC_` variables are not
|
|
17
|
-
* available in the browser (Next.js docs, environment-variables: "Non-
|
|
18
|
-
* NEXT_PUBLIC_ environment variables are only available in the Node.js
|
|
19
|
-
* environment"). A check written inside those files would read `undefined` on
|
|
20
|
-
* the client and deny ALWAYS - killing the tool in dev too - while reading the
|
|
21
|
-
* REAL value during SSR, producing a hydration mismatch. It would look like a
|
|
22
|
-
* gate, satisfy a grep for one, and protect nothing.
|
|
23
|
-
*
|
|
24
|
-
* A SERVER component can read the variable for real. That is the whole reason
|
|
25
|
-
* this file exists as a separate layer instead of a few lines in each page.
|
|
26
|
-
*
|
|
27
|
-
* ── FAIL CLOSED ─────────────────────────────────────────────────────────────
|
|
28
|
-
* The test is `=== 'true'`, not truthiness. Unset, empty, "false", "0", "TRUE"
|
|
29
|
-
* and every typo all deny. The UNSAFE state requires a deliberate, exact act;
|
|
30
|
-
* the SAFE state is what you get by doing nothing, including by misconfiguring
|
|
31
|
-
* it. A gate whose default is "open" is not a gate.
|
|
32
|
-
*
|
|
33
|
-
* `notFound()` is deliberate and is not a 403: a real 404 is indistinguishable
|
|
34
|
-
* from a route that was never registered, whereas a 403 CONFIRMS the page
|
|
35
|
-
* exists to anyone who probes for it. That is the same disclosure axis card
|
|
36
|
-
* 245920 was raised about, so shipping the confirming variant here would
|
|
37
|
-
* reintroduce next door the thing being fixed there.
|
|
38
|
-
*
|
|
39
|
-
* notFound() throws (NEXT_HTTP_ERROR_FALLBACK;404) and terminates rendering of
|
|
40
|
-
* the segment, so nothing below it runs and the client component is never sent
|
|
41
|
-
* to the browser. It does not need `return` - it is typed `never`.
|
|
42
|
-
*/
|
|
43
|
-
import { notFound } from 'next/navigation';
|
|
44
|
-
|
|
45
|
-
import { TestEnvPage as TestEnvPageUnguarded } from './TestEnvPage';
|
|
46
|
-
import { JwtInspectPage as JwtInspectPageUnguarded } from './JwtInspectPage';
|
|
47
|
-
import { RefreshTokenPage as RefreshTokenPageUnguarded } from './RefreshTokenPage';
|
|
48
|
-
import { EmergencyLogoutPage as EmergencyLogoutPageUnguarded } from './EmergencyLogoutPage';
|
|
49
|
-
|
|
50
|
-
/**
|
|
51
|
-
* The single gate. Exact-match on purpose - see FAIL CLOSED above.
|
|
52
|
-
*
|
|
53
|
-
* Read at REQUEST time inside each page rather than once at module scope: a
|
|
54
|
-
* module-scope constant would be captured at build time, so a consumer who
|
|
55
|
-
* changed the variable would keep whatever value was baked into the bundle and
|
|
56
|
-
* would have no way to tell. Reading per render costs an object property
|
|
57
|
-
* lookup and removes an entire class of "I turned it off and it stayed on".
|
|
58
|
-
*/
|
|
59
|
-
function testRoutesEnabled(): boolean {
|
|
60
|
-
return process.env.ENABLE_TEST_ROUTES === 'true';
|
|
61
|
-
}
|
|
62
|
-
|
|
63
|
-
export function TestEnvPage() {
|
|
64
|
-
if (!testRoutesEnabled()) notFound();
|
|
65
|
-
return <TestEnvPageUnguarded />;
|
|
66
|
-
}
|
|
67
|
-
|
|
68
|
-
export function JwtInspectPage() {
|
|
69
|
-
if (!testRoutesEnabled()) notFound();
|
|
70
|
-
return <JwtInspectPageUnguarded />;
|
|
71
|
-
}
|
|
72
|
-
|
|
73
|
-
export function RefreshTokenPage() {
|
|
74
|
-
if (!testRoutesEnabled()) notFound();
|
|
75
|
-
return <RefreshTokenPageUnguarded />;
|
|
76
|
-
}
|
|
77
|
-
|
|
78
|
-
export function EmergencyLogoutPage() {
|
|
79
|
-
if (!testRoutesEnabled()) notFound();
|
|
80
|
-
return <EmergencyLogoutPageUnguarded />;
|
|
81
|
-
}
|
|
1
|
+
/**
|
|
2
|
+
* SERVER-COMPONENT GUARDS for the test-env debug pages (card 249259, BAPert
|
|
3
|
+
* ruling 35321). These are what `@payez/next-mvp/pages/test-env` exports. The
|
|
4
|
+
* raw client components are NOT exported.
|
|
5
|
+
*
|
|
6
|
+
* ── WHAT THIS IS, AND WHAT IT IS EMPHATICALLY NOT ───────────────────────────
|
|
7
|
+
* MOUNTING IS STILL THE PRIMARY GATE. This wrapper is a backstop for a mount
|
|
8
|
+
* that should not have happened. It is NOT a licence to mount these freely:
|
|
9
|
+
* setting ENABLE_TEST_ROUTES=true in an environment where these pages are
|
|
10
|
+
* mounted gives you exactly the exposure this package spent 248991 documenting
|
|
11
|
+
* - a live session token and a copy button. If you are not actively debugging,
|
|
12
|
+
* DO NOT MOUNT THESE AT ALL. The safest configuration remains their absence.
|
|
13
|
+
*
|
|
14
|
+
* ── WHY A SERVER COMPONENT, AND WHY THE PAGES THEMSELVES CANNOT DO THIS ─────
|
|
15
|
+
* 248991 item 2 asked for a per-page env gate and it was correctly REFUSED:
|
|
16
|
+
* the pages are `'use client'`, and non-`NEXT_PUBLIC_` variables are not
|
|
17
|
+
* available in the browser (Next.js docs, environment-variables: "Non-
|
|
18
|
+
* NEXT_PUBLIC_ environment variables are only available in the Node.js
|
|
19
|
+
* environment"). A check written inside those files would read `undefined` on
|
|
20
|
+
* the client and deny ALWAYS - killing the tool in dev too - while reading the
|
|
21
|
+
* REAL value during SSR, producing a hydration mismatch. It would look like a
|
|
22
|
+
* gate, satisfy a grep for one, and protect nothing.
|
|
23
|
+
*
|
|
24
|
+
* A SERVER component can read the variable for real. That is the whole reason
|
|
25
|
+
* this file exists as a separate layer instead of a few lines in each page.
|
|
26
|
+
*
|
|
27
|
+
* ── FAIL CLOSED ─────────────────────────────────────────────────────────────
|
|
28
|
+
* The test is `=== 'true'`, not truthiness. Unset, empty, "false", "0", "TRUE"
|
|
29
|
+
* and every typo all deny. The UNSAFE state requires a deliberate, exact act;
|
|
30
|
+
* the SAFE state is what you get by doing nothing, including by misconfiguring
|
|
31
|
+
* it. A gate whose default is "open" is not a gate.
|
|
32
|
+
*
|
|
33
|
+
* `notFound()` is deliberate and is not a 403: a real 404 is indistinguishable
|
|
34
|
+
* from a route that was never registered, whereas a 403 CONFIRMS the page
|
|
35
|
+
* exists to anyone who probes for it. That is the same disclosure axis card
|
|
36
|
+
* 245920 was raised about, so shipping the confirming variant here would
|
|
37
|
+
* reintroduce next door the thing being fixed there.
|
|
38
|
+
*
|
|
39
|
+
* notFound() throws (NEXT_HTTP_ERROR_FALLBACK;404) and terminates rendering of
|
|
40
|
+
* the segment, so nothing below it runs and the client component is never sent
|
|
41
|
+
* to the browser. It does not need `return` - it is typed `never`.
|
|
42
|
+
*/
|
|
43
|
+
import { notFound } from 'next/navigation';
|
|
44
|
+
|
|
45
|
+
import { TestEnvPage as TestEnvPageUnguarded } from './TestEnvPage';
|
|
46
|
+
import { JwtInspectPage as JwtInspectPageUnguarded } from './JwtInspectPage';
|
|
47
|
+
import { RefreshTokenPage as RefreshTokenPageUnguarded } from './RefreshTokenPage';
|
|
48
|
+
import { EmergencyLogoutPage as EmergencyLogoutPageUnguarded } from './EmergencyLogoutPage';
|
|
49
|
+
|
|
50
|
+
/**
|
|
51
|
+
* The single gate. Exact-match on purpose - see FAIL CLOSED above.
|
|
52
|
+
*
|
|
53
|
+
* Read at REQUEST time inside each page rather than once at module scope: a
|
|
54
|
+
* module-scope constant would be captured at build time, so a consumer who
|
|
55
|
+
* changed the variable would keep whatever value was baked into the bundle and
|
|
56
|
+
* would have no way to tell. Reading per render costs an object property
|
|
57
|
+
* lookup and removes an entire class of "I turned it off and it stayed on".
|
|
58
|
+
*/
|
|
59
|
+
function testRoutesEnabled(): boolean {
|
|
60
|
+
return process.env.ENABLE_TEST_ROUTES === 'true';
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
export function TestEnvPage() {
|
|
64
|
+
if (!testRoutesEnabled()) notFound();
|
|
65
|
+
return <TestEnvPageUnguarded />;
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
export function JwtInspectPage() {
|
|
69
|
+
if (!testRoutesEnabled()) notFound();
|
|
70
|
+
return <JwtInspectPageUnguarded />;
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
export function RefreshTokenPage() {
|
|
74
|
+
if (!testRoutesEnabled()) notFound();
|
|
75
|
+
return <RefreshTokenPageUnguarded />;
|
|
76
|
+
}
|
|
77
|
+
|
|
78
|
+
export function EmergencyLogoutPage() {
|
|
79
|
+
if (!testRoutesEnabled()) notFound();
|
|
80
|
+
return <EmergencyLogoutPageUnguarded />;
|
|
81
|
+
}
|
|
@@ -1,77 +1,77 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* ⚠️ TEST-ENVIRONMENT DEBUG PAGES — NONE OF THESE BELONG IN PRODUCTION. ⚠️
|
|
3
|
-
*
|
|
4
|
-
* ────────────────────────── READ BEFORE COPYING ANYTHING BELOW (QAPert 35000) ──────────────────────────
|
|
5
|
-
* This barrel is the SPREAD MECHANISM. It ships compiled into dist and into
|
|
6
|
-
* the .d.ts, so it reaches every consuming developer's editor as hover text,
|
|
7
|
-
* and the block below is a four-line copy-paste that mounts every debug page
|
|
8
|
-
* this package has. It previously carried no warning at all.
|
|
9
|
-
*
|
|
10
|
-
* NONE of these pages has an env gate of its own. Unlike the force-expire
|
|
11
|
-
* handler (ENABLE_TEST_ROUTES) or the idp-token route
|
|
12
|
-
* (ENABLE_TOKEN_INSPECTOR), a mounted page is reachable exactly as far as your
|
|
13
|
-
* middleware allows. MOUNTING IS THE GATE — so gate the WHOLE /test-env
|
|
14
|
-
* segment, per environment, not page by page.
|
|
15
|
-
*
|
|
16
|
-
* They are not equally dangerous. In descending order:
|
|
17
|
-
* JwtInspectPage WORST. Copy-to-clipboard for the LIVE SESSION TOKEN
|
|
18
|
-
* and ACCESS TOKEN. A session token is exactly the
|
|
19
|
-
* precondition the 246007 finding needs.
|
|
20
|
-
* TestEnvPage The index. Harmless alone, but it ADVERTISES the
|
|
21
|
-
* other three to anyone who reaches it.
|
|
22
|
-
* RefreshTokenPage Drives the destructive /api/test/force-expire.
|
|
23
|
-
* EmergencyLogoutPage Mildest. Self-inflicted, recoverable.
|
|
24
|
-
*
|
|
25
|
-
* ── THESE PAGES ARE NOW ENV-GATED, FAIL-CLOSED (249259, BAPert ruling 35321) ──
|
|
26
|
-
* SUPERSEDES the previous note here, which said a gate was impossible and that
|
|
27
|
-
* mounting was the only control. That was correct about the PAGES and wrong as
|
|
28
|
-
* a conclusion: it CANNOT be done inside these `'use client'` files, but it CAN
|
|
29
|
-
* be done in a server component wrapping them. That wrapper now ships, and it
|
|
30
|
-
* is what the four names below resolve to — see ./guarded.tsx.
|
|
31
|
-
*
|
|
32
|
-
* ENABLE_TEST_ROUTES === 'true' -> the page renders
|
|
33
|
-
* anything else, including unset -> notFound()
|
|
34
|
-
*
|
|
35
|
-
* It is the DEFAULT, not an opt-in sibling: BAPert's ruling was explicit that
|
|
36
|
-
* "an opt-in safety gate is one nobody opts into". The raw ungated components
|
|
37
|
-
* are NOT exported. Same import path, same component names, same signatures —
|
|
38
|
-
* consumers add one env var to their dev environments and change no code.
|
|
39
|
-
*
|
|
40
|
-
* ── MOUNTING IS STILL THE PRIMARY GATE ──────────────────────────────────────
|
|
41
|
-
* Do not read the env var as making mounting safe. The wrapper is a backstop
|
|
42
|
-
* for a mount that should not have happened. With ENABLE_TEST_ROUTES=true in an
|
|
43
|
-
* environment where these are mounted you have exactly the exposure 248991
|
|
44
|
-
* documented: a live session token, one click from the clipboard. If you are
|
|
45
|
-
* not actively debugging, DO NOT MOUNT THESE AT ALL — the safest configuration
|
|
46
|
-
* is still their absence, and the env var does not change that.
|
|
47
|
-
*
|
|
48
|
-
* Each page's own docstring carries the detail. If you are not actively
|
|
49
|
-
* debugging, DO NOT MOUNT THESE AT ALL — the safest configuration is their
|
|
50
|
-
* absence.
|
|
51
|
-
*
|
|
52
|
-
* Usage — TEST/DEV ENVIRONMENTS ONLY:
|
|
53
|
-
* ```typescript
|
|
54
|
-
* // app/test-env/page.tsx
|
|
55
|
-
* export { TestEnvPage as default } from '@payez/next-mvp/pages/test-env';
|
|
56
|
-
*
|
|
57
|
-
* // app/test-env/jwt-inspect/page.tsx
|
|
58
|
-
* export { JwtInspectPage as default } from '@payez/next-mvp/pages/test-env';
|
|
59
|
-
*
|
|
60
|
-
* // app/test-env/refresh-token/page.tsx
|
|
61
|
-
* export { RefreshTokenPage as default } from '@payez/next-mvp/pages/test-env';
|
|
62
|
-
*
|
|
63
|
-
* // app/test-env/emergency-logout/page.tsx
|
|
64
|
-
* export { EmergencyLogoutPage as default } from '@payez/next-mvp/pages/test-env';
|
|
65
|
-
* ```
|
|
66
|
-
*/
|
|
67
|
-
|
|
68
|
-
// GUARDED wrappers only. Exporting the raw components from './TestEnvPage'
|
|
69
|
-
// etc. would reintroduce an ungated path to the same pages under a different
|
|
70
|
-
// import, which is the "opt-in gate nobody opts into" the ruling rejected.
|
|
71
|
-
export {
|
|
72
|
-
TestEnvPage,
|
|
73
|
-
TestEnvPage as default,
|
|
74
|
-
JwtInspectPage,
|
|
75
|
-
RefreshTokenPage,
|
|
76
|
-
EmergencyLogoutPage,
|
|
77
|
-
} from './guarded';
|
|
1
|
+
/**
|
|
2
|
+
* ⚠️ TEST-ENVIRONMENT DEBUG PAGES — NONE OF THESE BELONG IN PRODUCTION. ⚠️
|
|
3
|
+
*
|
|
4
|
+
* ────────────────────────── READ BEFORE COPYING ANYTHING BELOW (QAPert 35000) ──────────────────────────
|
|
5
|
+
* This barrel is the SPREAD MECHANISM. It ships compiled into dist and into
|
|
6
|
+
* the .d.ts, so it reaches every consuming developer's editor as hover text,
|
|
7
|
+
* and the block below is a four-line copy-paste that mounts every debug page
|
|
8
|
+
* this package has. It previously carried no warning at all.
|
|
9
|
+
*
|
|
10
|
+
* NONE of these pages has an env gate of its own. Unlike the force-expire
|
|
11
|
+
* handler (ENABLE_TEST_ROUTES) or the idp-token route
|
|
12
|
+
* (ENABLE_TOKEN_INSPECTOR), a mounted page is reachable exactly as far as your
|
|
13
|
+
* middleware allows. MOUNTING IS THE GATE — so gate the WHOLE /test-env
|
|
14
|
+
* segment, per environment, not page by page.
|
|
15
|
+
*
|
|
16
|
+
* They are not equally dangerous. In descending order:
|
|
17
|
+
* JwtInspectPage WORST. Copy-to-clipboard for the LIVE SESSION TOKEN
|
|
18
|
+
* and ACCESS TOKEN. A session token is exactly the
|
|
19
|
+
* precondition the 246007 finding needs.
|
|
20
|
+
* TestEnvPage The index. Harmless alone, but it ADVERTISES the
|
|
21
|
+
* other three to anyone who reaches it.
|
|
22
|
+
* RefreshTokenPage Drives the destructive /api/test/force-expire.
|
|
23
|
+
* EmergencyLogoutPage Mildest. Self-inflicted, recoverable.
|
|
24
|
+
*
|
|
25
|
+
* ── THESE PAGES ARE NOW ENV-GATED, FAIL-CLOSED (249259, BAPert ruling 35321) ──
|
|
26
|
+
* SUPERSEDES the previous note here, which said a gate was impossible and that
|
|
27
|
+
* mounting was the only control. That was correct about the PAGES and wrong as
|
|
28
|
+
* a conclusion: it CANNOT be done inside these `'use client'` files, but it CAN
|
|
29
|
+
* be done in a server component wrapping them. That wrapper now ships, and it
|
|
30
|
+
* is what the four names below resolve to — see ./guarded.tsx.
|
|
31
|
+
*
|
|
32
|
+
* ENABLE_TEST_ROUTES === 'true' -> the page renders
|
|
33
|
+
* anything else, including unset -> notFound()
|
|
34
|
+
*
|
|
35
|
+
* It is the DEFAULT, not an opt-in sibling: BAPert's ruling was explicit that
|
|
36
|
+
* "an opt-in safety gate is one nobody opts into". The raw ungated components
|
|
37
|
+
* are NOT exported. Same import path, same component names, same signatures —
|
|
38
|
+
* consumers add one env var to their dev environments and change no code.
|
|
39
|
+
*
|
|
40
|
+
* ── MOUNTING IS STILL THE PRIMARY GATE ──────────────────────────────────────
|
|
41
|
+
* Do not read the env var as making mounting safe. The wrapper is a backstop
|
|
42
|
+
* for a mount that should not have happened. With ENABLE_TEST_ROUTES=true in an
|
|
43
|
+
* environment where these are mounted you have exactly the exposure 248991
|
|
44
|
+
* documented: a live session token, one click from the clipboard. If you are
|
|
45
|
+
* not actively debugging, DO NOT MOUNT THESE AT ALL — the safest configuration
|
|
46
|
+
* is still their absence, and the env var does not change that.
|
|
47
|
+
*
|
|
48
|
+
* Each page's own docstring carries the detail. If you are not actively
|
|
49
|
+
* debugging, DO NOT MOUNT THESE AT ALL — the safest configuration is their
|
|
50
|
+
* absence.
|
|
51
|
+
*
|
|
52
|
+
* Usage — TEST/DEV ENVIRONMENTS ONLY:
|
|
53
|
+
* ```typescript
|
|
54
|
+
* // app/test-env/page.tsx
|
|
55
|
+
* export { TestEnvPage as default } from '@payez/next-mvp/pages/test-env';
|
|
56
|
+
*
|
|
57
|
+
* // app/test-env/jwt-inspect/page.tsx
|
|
58
|
+
* export { JwtInspectPage as default } from '@payez/next-mvp/pages/test-env';
|
|
59
|
+
*
|
|
60
|
+
* // app/test-env/refresh-token/page.tsx
|
|
61
|
+
* export { RefreshTokenPage as default } from '@payez/next-mvp/pages/test-env';
|
|
62
|
+
*
|
|
63
|
+
* // app/test-env/emergency-logout/page.tsx
|
|
64
|
+
* export { EmergencyLogoutPage as default } from '@payez/next-mvp/pages/test-env';
|
|
65
|
+
* ```
|
|
66
|
+
*/
|
|
67
|
+
|
|
68
|
+
// GUARDED wrappers only. Exporting the raw components from './TestEnvPage'
|
|
69
|
+
// etc. would reintroduce an ungated path to the same pages under a different
|
|
70
|
+
// import, which is the "opt-in gate nobody opts into" the ruling rejected.
|
|
71
|
+
export {
|
|
72
|
+
TestEnvPage,
|
|
73
|
+
TestEnvPage as default,
|
|
74
|
+
JwtInspectPage,
|
|
75
|
+
RefreshTokenPage,
|
|
76
|
+
EmergencyLogoutPage,
|
|
77
|
+
} from './guarded';
|
|
@@ -1,96 +1,96 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* redact-credentials - what the test-env debug pages may show of a credential: a stable hash and a length, never
|
|
3
|
-
* characters of the value (PAY-1470, BAPert rulings 59022 and 59040).
|
|
4
|
-
*
|
|
5
|
-
* PAY-1481 item 2 (QAPert, PR 186 review 59083): this was a DENYLIST (keys ending in token/secret/password/...).
|
|
6
|
-
* Opaque credentials under `tokens.access`, `redisSessionId`, `sid`, `authorization`, `cookie`, `backupCodes[]` and
|
|
7
|
-
* `code` passed unmasked. It is now an ALLOWLIST: a string is shown only when its key is a known DISPLAYABLE field
|
|
8
|
-
* (identity, roles, timestamps, provider and flag metadata, standard JWT claims). Every other string - an unknown
|
|
9
|
-
* key, an array item under an unknown key, a top-level string - becomes maskToken. A new field is hidden until
|
|
10
|
-
* someone decides it is displayable, which is the safe direction for a page reachable in production builds.
|
|
11
|
-
*
|
|
12
|
-
* Kept from the denylist era, and applied EVEN under a displayable key, because a credential can sit under an
|
|
13
|
-
* innocent name: a JWT (three base64url segments, length floors so "4.1.42" is not one), a PEM armour band, and the
|
|
14
|
-
* password in scheme://user:password@host. Numbers, booleans and null are never credentials and stay readable.
|
|
15
|
-
*
|
|
16
|
-
* There is no Reveal and no copy. "Never renders token material" includes click-to-reveal (59040).
|
|
17
|
-
*/
|
|
18
|
-
import { tokenLogId } from '../../lib/token-log-id';
|
|
19
|
-
|
|
20
|
-
/** A stable, non-reversible stand-in for a credential: `h:<12 hex> (<n> chars, hidden)`. */
|
|
21
|
-
export function maskToken(value: string): string {
|
|
22
|
-
return `${tokenLogId(value)} (${value.length} chars, hidden)`;
|
|
23
|
-
}
|
|
24
|
-
|
|
25
|
-
/**
|
|
26
|
-
* Keys whose string values are displayable. Exact names (case-insensitive), plus timestamp / flag suffix patterns.
|
|
27
|
-
* An exact listed key wins (tokenType is metadata); otherwise a key naming a credential (CREDENTIAL_NAME) is refused.
|
|
28
|
-
*/
|
|
29
|
-
const DISPLAYABLE_KEYS = new Set(
|
|
30
|
-
[
|
|
31
|
-
// identity
|
|
32
|
-
'id', 'userId', 'user_id', 'sub', 'email', 'name', 'given_name', 'family_name', 'preferred_username', 'image',
|
|
33
|
-
'picture', 'locale', 'phone_number_verified',
|
|
34
|
-
// authorisation metadata
|
|
35
|
-
'role', 'roles', 'scope', 'scopes', 'permissions', 'authenticationMethods', 'authenticationLevel', 'amr', 'acr',
|
|
36
|
-
'oauthProvider', 'provider', 'providerId', 'tokenType', 'token_type', 'type', 'typ', 'alg', 'kid', 'iss', 'aud',
|
|
37
|
-
'azp', 'jti',
|
|
38
|
-
// client / tenant
|
|
39
|
-
'clientId', 'client_id', 'idpClientId', 'clientSlug', 'slug', 'tenant', 'tenantId', 'merchantId', 'appSlug',
|
|
40
|
-
// result / status fields of the test-env routes
|
|
41
|
-
'status', 'statusText', 'success', 'action', 'message', 'error', 'reason', 'outcome', 'source', 'shape', 'mode',
|
|
42
|
-
].map((k) => k.toLowerCase()),
|
|
43
|
-
);
|
|
44
|
-
/** Timestamps, durations and booleans-as-strings by suffix: expires, accessTokenExpires, mfaCompletedAt, iat... */
|
|
45
|
-
const DISPLAYABLE_SUFFIX = /(expires|_at|iat|exp|nbf|hours|seconds|verified|required|enabled|count|version)$/i;
|
|
46
|
-
/** camelCase timestamps (createdAt, mfaCompletedAt): tested on the ORIGINAL key so `format` / `chat` do not match. */
|
|
47
|
-
const CAMEL_AT = /[a-z0-9]At$/;
|
|
48
|
-
/** A key that names a credential is never displayable, whatever suffix it has (e.g. refreshTokenCreatedAt stays OK
|
|
49
|
-
* because it names a TIME; `authorization`, `cookie`, `sid`, `code` are credentials). */
|
|
50
|
-
const CREDENTIAL_NAME = /(token|secret|password|passwd|apikey|api_key|credential|authorization|cookie|^sid$|session_?id$|^code$|codes?$|otp|pin$|signature|private)/i;
|
|
51
|
-
|
|
52
|
-
const URL_WITH_USERINFO = /^([a-z][a-z0-9+.-]*:\/\/)([^/\s:@]+):([^/\s@]+)@/i;
|
|
53
|
-
const PEM_BLOCK = /-----BEGIN [A-Z0-9][A-Z0-9 ]*-----/;
|
|
54
|
-
|
|
55
|
-
function looksLikeJwt(v: string): boolean {
|
|
56
|
-
if (v.length < 40) return false;
|
|
57
|
-
const parts = v.split('.');
|
|
58
|
-
return parts.length === 3 && parts.every((p) => p.length >= 8 && /^[A-Za-z0-9_-]+$/.test(p));
|
|
59
|
-
}
|
|
60
|
-
|
|
61
|
-
/** Is a string under this key displayable? Credential names lose even when a timestamp suffix matches. */
|
|
62
|
-
export function isDisplayableKey(keyName: string): boolean {
|
|
63
|
-
if (!keyName) return false;
|
|
64
|
-
const k = keyName.toLowerCase();
|
|
65
|
-
// 1. An exact, deliberately listed field (tokenType is metadata even though it says "token").
|
|
66
|
-
if (DISPLAYABLE_KEYS.has(k)) return true;
|
|
67
|
-
// 2. A key naming a credential is refused - unless what it names is a TIME about it (accessTokenExpires).
|
|
68
|
-
const namesTime = /(expires|_at|iat|exp|nbf|hours|seconds)$/i.test(k) || CAMEL_AT.test(keyName);
|
|
69
|
-
if (CREDENTIAL_NAME.test(k) && !namesTime) return false;
|
|
70
|
-
// 3. Metadata by suffix: timestamps, durations, flags, counts, versions, URLs (userinfo is still masked).
|
|
71
|
-
return DISPLAYABLE_SUFFIX.test(k) || CAMEL_AT.test(keyName) || /url$/i.test(k);
|
|
72
|
-
}
|
|
73
|
-
|
|
74
|
-
/** A deep copy of `value` in which every string not under a displayable key is replaced by maskToken. */
|
|
75
|
-
export function redactCredentials(value: unknown, keyName = ''): unknown {
|
|
76
|
-
// Array items inherit the array's key: backupCodes[] items are credentials, roles[] items are not.
|
|
77
|
-
if (Array.isArray(value)) return value.map((v) => redactCredentials(v, keyName));
|
|
78
|
-
if (value && typeof value === 'object') {
|
|
79
|
-
return Object.fromEntries(
|
|
80
|
-
Object.entries(value as Record<string, unknown>).map(([k, v]) => [k, redactCredentials(v, k)]),
|
|
81
|
-
);
|
|
82
|
-
}
|
|
83
|
-
// NightHawk (PR 204 review): a numeric OTP / code under a credential-named key is a credential too.
|
|
84
|
-
if (typeof value === 'number' && keyName && !isDisplayableKey(keyName) && CREDENTIAL_NAME.test(keyName)) {
|
|
85
|
-
return maskToken(String(value));
|
|
86
|
-
}
|
|
87
|
-
if (typeof value !== 'string' || value.length === 0) return value;
|
|
88
|
-
if (looksLikeJwt(value)) return maskToken(value);
|
|
89
|
-
if (PEM_BLOCK.test(value)) return '••• PEM block redacted (' + value.length + ' chars) •••';
|
|
90
|
-
if (!isDisplayableKey(keyName)) return maskToken(value);
|
|
91
|
-
let shown = value;
|
|
92
|
-
if (URL_WITH_USERINFO.test(shown)) shown = shown.replace(URL_WITH_USERINFO, '$1$2:•••••@');
|
|
93
|
-
// NightHawk (PR 204 review): a URL's query and fragment carry tokens (?token=, #access_token=). Names stay, values go.
|
|
94
|
-
shown = shown.replace(/([?&#][^=&#\s]+=)[^&#\s]*/g, '$1•••');
|
|
95
|
-
return shown;
|
|
96
|
-
}
|
|
1
|
+
/**
|
|
2
|
+
* redact-credentials - what the test-env debug pages may show of a credential: a stable hash and a length, never
|
|
3
|
+
* characters of the value (PAY-1470, BAPert rulings 59022 and 59040).
|
|
4
|
+
*
|
|
5
|
+
* PAY-1481 item 2 (QAPert, PR 186 review 59083): this was a DENYLIST (keys ending in token/secret/password/...).
|
|
6
|
+
* Opaque credentials under `tokens.access`, `redisSessionId`, `sid`, `authorization`, `cookie`, `backupCodes[]` and
|
|
7
|
+
* `code` passed unmasked. It is now an ALLOWLIST: a string is shown only when its key is a known DISPLAYABLE field
|
|
8
|
+
* (identity, roles, timestamps, provider and flag metadata, standard JWT claims). Every other string - an unknown
|
|
9
|
+
* key, an array item under an unknown key, a top-level string - becomes maskToken. A new field is hidden until
|
|
10
|
+
* someone decides it is displayable, which is the safe direction for a page reachable in production builds.
|
|
11
|
+
*
|
|
12
|
+
* Kept from the denylist era, and applied EVEN under a displayable key, because a credential can sit under an
|
|
13
|
+
* innocent name: a JWT (three base64url segments, length floors so "4.1.42" is not one), a PEM armour band, and the
|
|
14
|
+
* password in scheme://user:password@host. Numbers, booleans and null are never credentials and stay readable.
|
|
15
|
+
*
|
|
16
|
+
* There is no Reveal and no copy. "Never renders token material" includes click-to-reveal (59040).
|
|
17
|
+
*/
|
|
18
|
+
import { tokenLogId } from '../../lib/token-log-id';
|
|
19
|
+
|
|
20
|
+
/** A stable, non-reversible stand-in for a credential: `h:<12 hex> (<n> chars, hidden)`. */
|
|
21
|
+
export function maskToken(value: string): string {
|
|
22
|
+
return `${tokenLogId(value)} (${value.length} chars, hidden)`;
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
/**
|
|
26
|
+
* Keys whose string values are displayable. Exact names (case-insensitive), plus timestamp / flag suffix patterns.
|
|
27
|
+
* An exact listed key wins (tokenType is metadata); otherwise a key naming a credential (CREDENTIAL_NAME) is refused.
|
|
28
|
+
*/
|
|
29
|
+
const DISPLAYABLE_KEYS = new Set(
|
|
30
|
+
[
|
|
31
|
+
// identity
|
|
32
|
+
'id', 'userId', 'user_id', 'sub', 'email', 'name', 'given_name', 'family_name', 'preferred_username', 'image',
|
|
33
|
+
'picture', 'locale', 'phone_number_verified',
|
|
34
|
+
// authorisation metadata
|
|
35
|
+
'role', 'roles', 'scope', 'scopes', 'permissions', 'authenticationMethods', 'authenticationLevel', 'amr', 'acr',
|
|
36
|
+
'oauthProvider', 'provider', 'providerId', 'tokenType', 'token_type', 'type', 'typ', 'alg', 'kid', 'iss', 'aud',
|
|
37
|
+
'azp', 'jti',
|
|
38
|
+
// client / tenant
|
|
39
|
+
'clientId', 'client_id', 'idpClientId', 'clientSlug', 'slug', 'tenant', 'tenantId', 'merchantId', 'appSlug',
|
|
40
|
+
// result / status fields of the test-env routes
|
|
41
|
+
'status', 'statusText', 'success', 'action', 'message', 'error', 'reason', 'outcome', 'source', 'shape', 'mode',
|
|
42
|
+
].map((k) => k.toLowerCase()),
|
|
43
|
+
);
|
|
44
|
+
/** Timestamps, durations and booleans-as-strings by suffix: expires, accessTokenExpires, mfaCompletedAt, iat... */
|
|
45
|
+
const DISPLAYABLE_SUFFIX = /(expires|_at|iat|exp|nbf|hours|seconds|verified|required|enabled|count|version)$/i;
|
|
46
|
+
/** camelCase timestamps (createdAt, mfaCompletedAt): tested on the ORIGINAL key so `format` / `chat` do not match. */
|
|
47
|
+
const CAMEL_AT = /[a-z0-9]At$/;
|
|
48
|
+
/** A key that names a credential is never displayable, whatever suffix it has (e.g. refreshTokenCreatedAt stays OK
|
|
49
|
+
* because it names a TIME; `authorization`, `cookie`, `sid`, `code` are credentials). */
|
|
50
|
+
const CREDENTIAL_NAME = /(token|secret|password|passwd|apikey|api_key|credential|authorization|cookie|^sid$|session_?id$|^code$|codes?$|otp|pin$|signature|private)/i;
|
|
51
|
+
|
|
52
|
+
const URL_WITH_USERINFO = /^([a-z][a-z0-9+.-]*:\/\/)([^/\s:@]+):([^/\s@]+)@/i;
|
|
53
|
+
const PEM_BLOCK = /-----BEGIN [A-Z0-9][A-Z0-9 ]*-----/;
|
|
54
|
+
|
|
55
|
+
function looksLikeJwt(v: string): boolean {
|
|
56
|
+
if (v.length < 40) return false;
|
|
57
|
+
const parts = v.split('.');
|
|
58
|
+
return parts.length === 3 && parts.every((p) => p.length >= 8 && /^[A-Za-z0-9_-]+$/.test(p));
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
/** Is a string under this key displayable? Credential names lose even when a timestamp suffix matches. */
|
|
62
|
+
export function isDisplayableKey(keyName: string): boolean {
|
|
63
|
+
if (!keyName) return false;
|
|
64
|
+
const k = keyName.toLowerCase();
|
|
65
|
+
// 1. An exact, deliberately listed field (tokenType is metadata even though it says "token").
|
|
66
|
+
if (DISPLAYABLE_KEYS.has(k)) return true;
|
|
67
|
+
// 2. A key naming a credential is refused - unless what it names is a TIME about it (accessTokenExpires).
|
|
68
|
+
const namesTime = /(expires|_at|iat|exp|nbf|hours|seconds)$/i.test(k) || CAMEL_AT.test(keyName);
|
|
69
|
+
if (CREDENTIAL_NAME.test(k) && !namesTime) return false;
|
|
70
|
+
// 3. Metadata by suffix: timestamps, durations, flags, counts, versions, URLs (userinfo is still masked).
|
|
71
|
+
return DISPLAYABLE_SUFFIX.test(k) || CAMEL_AT.test(keyName) || /url$/i.test(k);
|
|
72
|
+
}
|
|
73
|
+
|
|
74
|
+
/** A deep copy of `value` in which every string not under a displayable key is replaced by maskToken. */
|
|
75
|
+
export function redactCredentials(value: unknown, keyName = ''): unknown {
|
|
76
|
+
// Array items inherit the array's key: backupCodes[] items are credentials, roles[] items are not.
|
|
77
|
+
if (Array.isArray(value)) return value.map((v) => redactCredentials(v, keyName));
|
|
78
|
+
if (value && typeof value === 'object') {
|
|
79
|
+
return Object.fromEntries(
|
|
80
|
+
Object.entries(value as Record<string, unknown>).map(([k, v]) => [k, redactCredentials(v, k)]),
|
|
81
|
+
);
|
|
82
|
+
}
|
|
83
|
+
// NightHawk (PR 204 review): a numeric OTP / code under a credential-named key is a credential too.
|
|
84
|
+
if (typeof value === 'number' && keyName && !isDisplayableKey(keyName) && CREDENTIAL_NAME.test(keyName)) {
|
|
85
|
+
return maskToken(String(value));
|
|
86
|
+
}
|
|
87
|
+
if (typeof value !== 'string' || value.length === 0) return value;
|
|
88
|
+
if (looksLikeJwt(value)) return maskToken(value);
|
|
89
|
+
if (PEM_BLOCK.test(value)) return '••• PEM block redacted (' + value.length + ' chars) •••';
|
|
90
|
+
if (!isDisplayableKey(keyName)) return maskToken(value);
|
|
91
|
+
let shown = value;
|
|
92
|
+
if (URL_WITH_USERINFO.test(shown)) shown = shown.replace(URL_WITH_USERINFO, '$1$2:•••••@');
|
|
93
|
+
// NightHawk (PR 204 review): a URL's query and fragment carry tokens (?token=, #access_token=). Names stay, values go.
|
|
94
|
+
shown = shown.replace(/([?&#][^=&#\s]+=)[^&#\s]*/g, '$1•••');
|
|
95
|
+
return shown;
|
|
96
|
+
}
|