Skip to content

Redact sensitive fields from the client config before loggging them. #26

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

Open
flyte wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Redact sensitive fields from the client config before loggging them. #26

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
13 changes: 12 additions & 1 deletion main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,17 @@ const Constants = {
RECONNECT_INVERVAL_MS: 1000
}

// Redact sensitive fields from the client config for logging purposes
function redactClientConfig(clientConfig) {
const redacted = { ...clientConfig }
for (const field of ['privateKey', 'password', 'passphrase']) {
if (redacted[field]) {
redacted[field] = '[REDACTED]'
}
}
return redacted
}

class SSHInstance extends InstanceBase {
constructor(internal) {
super(internal)
Expand Down Expand Up @@ -111,7 +122,7 @@ class SSHInstance extends InstanceBase {

this.sshClient.on('error', (err) => {
this.log('error', 'Server connection error: ' + err)
this.log('error', JSON.stringify(clientConfig))
this.log('error', JSON.stringify(redactClientConfig(clientConfig)))
this.updateStatus(InstanceStatus.ConnectionFailure)
this.queueReconnect()
})
Expand Down