-
Notifications
You must be signed in to change notification settings - Fork 6k
Adding sections about logging sensitive information #46492
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.
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
mariamgerges
wants to merge
5
commits into
main
Choose a base branch
from
mariamaziz/logging-redaction
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+108
−0
Open
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change | ||||||
---|---|---|---|---|---|---|---|---|
|
@@ -183,3 +183,52 @@ public sealed class StarRedactorProvider : IRedactorProvider | |||||||
public Redactor GetRedactor(DataClassificationSet classifications) => _starRedactor; | ||||||||
} | ||||||||
``` | ||||||||
|
||||||||
## Logging sensitive information | ||||||||
|
||||||||
Logging is a common source of accidental data exposure. Sensitive information such as personal data, credentials, or financial details should never be written to logs in plain text. To prevent this, always use redaction when logging potentially sensitive data. | ||||||||
|
||||||||
### Steps for logging sensitive data | ||||||||
|
||||||||
1. **Install logging extensions package**: Install [Microsoft.Extensions.Telemetry](https://www.nuget.org/packages/Microsoft.Extensions.Telemetry) to be able to use the extended logger to enable redaction feature. | ||||||||
2. **Setup redaction**: Integrate redactors with your logging pipeline by calling <xref:Microsoft.Extensions.DependencyInjection.RedactionServiceCollectionExtensions.AddRedaction(Microsoft.Extensions.DependencyInjection.IServiceCollection)> method, to automatically sanitize or mask sensitive fields before they are written to logs. | ||||||||
3. **Identify sensitive fields**: Know which data in your application is sensitive and requires protection, mark them with appropriate data classification. | ||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||
4. **Review log output**: Regularly audit your logs to ensure no sensitive data is exposed. | ||||||||
|
||||||||
### Example: Redacting data in logs | ||||||||
|
||||||||
When using Microsoft.Extensions.Logging, you can combine redaction with logging as follows: | ||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||
|
||||||||
```csharp | ||||||||
using Microsoft.Extensions.Telemetry; | ||||||||
using Microsoft.Extensions.Compliance.Redaction; | ||||||||
|
||||||||
var services = new ServiceCollection(); | ||||||||
services.AddLogging(builder => | ||||||||
{ | ||||||||
// Enable redaction. | ||||||||
builder.EnableRedaction(); | ||||||||
}); | ||||||||
|
||||||||
services.AddRedaction(builder => | ||||||||
{ | ||||||||
builder.SetRedactor<StarRedactor>(MyTaxonomyClassifications.Private); | ||||||||
}); | ||||||||
|
||||||||
// Use StarRedactor to redact SSN data. | ||||||||
[LoggerMessage(0, LogLevel.Information, "User SSN: {SSN}")] | ||||||||
public static partial void LogPrivateInformation( | ||||||||
this ILogger logger, | ||||||||
[MyTaxonomyClassifications.Private] string SSN); | ||||||||
|
||||||||
public void TestLogging() | ||||||||
{ | ||||||||
LogPrivateInformation("MySSN"); | ||||||||
} | ||||||||
``` | ||||||||
|
||||||||
The output should be like this: | ||||||||
|
||||||||
`User SSN: *****` | ||||||||
|
||||||||
This ensures that sensitive data is redacted before being logged, reducing the risk of data leaks. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.