Data source username and password are visible in the changelog

[mtbutler07]

NetBox version

v3.6.1

Feature type

Change to existing functionality

Proposed functionality

When creating a new data source (git) in NetBox with username/password fields populated, a changelog entry is created that contains the diff of the username/password in plain text.

This is not ideal for a number of reasons, the primary one being that it exposes credentials to other users that can view the NetBox changelog.

I'm proposing that the the username and password fields be masked or excluded entirely from the changelog entry to prevent exposing credentials.

Use case

It would prevent exposing credentials to other users that are able to view the changelog.

Database changes

No response

External dependencies

No response

[mtbutler07]

For the Amazon S3 type, it appears the aws_access_key_id and aws_secret_access_key are also displayed in plain text as well.

[jsenecal]

We probably need a custom method in the serializers for those models to obfuscate specific fields.

[abhi1693]

We set sensitive_parameters on the DataBackend class, maybe there is a way to call this within the to_objectchange method

netbox/netbox/core/data_backends.py

Line 40 in 2dfbd72

sensitive_parameters = []

[github-actions]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. NetBox is governed by a small group of core maintainers which means not all opened issues may receive direct feedback. Do not attempt to circumvent this process by "bumping" the issue; doing so will result in its immediate closure and you may be barred from participating in any future discussions. Please see our contributing guide.

[jeffgdotorg]

This one and feels important enough to rescue, for the sake of our security posture.

[abhi1693]

I'll take a stab at this and see if it's doable

[abhi1693]

I cannot find a way to pop out sensitive parameters from both pre and post change data. The most I was able to do was remove from post change using a hack but it caused slight performance degradation. Maybe another maintainer can help fix this.

[jeremystretch]

Talked about this a bit with @jeffgdotorg this morning. IIRC we have a mechanism in place already to denote sensitive parameters. I'll take a shot at incorporating this into the serialization logic for data sources.