Skip to content

fix: redact sensitive fields in logs #12913

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
alexghr merged 1 commit into from
Mar 20, 2025
Merged

fix: redact sensitive fields in logs #12913

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
27 changes: 27 additions & 0 deletions yarn-project/foundation/src/log/pino-logger.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,11 +99,38 @@ const customLevels = { verbose: 25 };

// Global pino options, tweaked for google cloud if running there.
const useGcloudLogging = parseBooleanEnv(process.env['USE_GCLOUD_LOGGING' satisfies EnvVar]);

const redactedPaths = [
'validatorPrivateKey',
// for both the validator and the prover
'publisherPrivateKey',
'peerIdPrivateKey',
// bot keys
'l1PrivateKey',
'senderPrivateKey',
// blob sink
'l1ConsensusHostApiKey',
// sensitive options used in the CLI
'privateKey',
'mnemonic',
'l1Mnemonic',
'l1PrivateKey',
];

const pinoOpts: pino.LoggerOptions<keyof typeof customLevels> = {
customLevels,
messageKey: 'msg',
useOnlyCustomLevels: false,
level: logLevel,
redact: {
paths: [
...redactedPaths,
...redactedPaths.map(p => `config.${p}`),
...redactedPaths.map(p => `cfg.${p}`),
...redactedPaths.map(p => `options.${p}`),
...redactedPaths.map(p => `opts.${p}`),
],
},
...(useGcloudLogging ? GoogleCloudLoggerConfig : {}),
};

Expand Down