This PR improves the handling of sensitive data, like passwords and auth tokens, by making it possible to easily configure the replacing of sensitive values, headers etc. in the package configuration. It does this by integrating the existing MessageAccessor (#13) with the `PsrMessageToStringConverter``
The configuration file template now includes detailed documentation on replacement options available for sensitive data, including:
Replace anywhere in the message
Replace values
Replace headers
Replace JSON path
Backward Compatibility: By default, this update does not alter the package’s behavior, ensuring compatibility for existing users. However, since logging sensitive data is such a widespread problem, it may be worthwhile to consider in a future release to mask the Authentication and Authorization headers by default.
Type of change
Please delete options that are not relevant.
[X] New feature (non-breaking change which adds functionality)
[X] This change requires a documentation update (documentation change included)
Checklist
[X] I have made corresponding changes to the documentation
[X] My changes generate no new warnings
[X] I have added tests that prove my fix is effective or that my feature works
[X] New and existing unit tests pass locally with my changes
Description
This PR improves the handling of sensitive data, like passwords and auth tokens, by making it possible to easily configure the replacing of sensitive values, headers etc. in the package configuration. It does this by integrating the existing
MessageAccessor(#13) with the `PsrMessageToStringConverter``The configuration file template now includes detailed documentation on replacement options available for sensitive data, including:
Backward Compatibility: By default, this update does not alter the package’s behavior, ensuring compatibility for existing users. However, since logging sensitive data is such a widespread problem, it may be worthwhile to consider in a future release to mask the
AuthenticationandAuthorizationheaders by default.Type of change
Please delete options that are not relevant.
Checklist