Skip to content
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

Mask EUII logs #1206

Merged
merged 7 commits into from
Feb 10, 2021
Merged

Mask EUII logs #1206

merged 7 commits into from
Feb 10, 2021

Conversation

oldalton
Copy link
Member

@oldalton oldalton commented Feb 2, 2021

Proposed changes

MSAL and broker provide logging callbacks that assist in diagnostics. By default the library will not return any messages with any user or organizational information. However, this might make diagnosing issues difficult.

The most sensitive information is EUII (things like upn, name, email etc).
This PR introduces a new logger flag and macro that allows masking only EUII, while keeping EUPI and OII intact.

When both piiEnabled is set to YES, and maskEUII is set to YES, MSAL logs will still include OII (organization identifiable information), and EUPI (end user pseudonymous identifiers), but MSAL will try to exclude and/or mask any EUII (end user identifiable information) like UPN, username, email from its logs.

This flag has no effect when piiEnabled is set to NO.
Default value is NO.

Type of change

  • Feature work
  • Bug fix
  • Documentation
  • Engineering change
  • Test
  • Logging/Telemetry

Risk

  • High – Errors could cause MAJOR regression of many scenarios. (Example: new large features or high level infrastructure changes)
  • Medium – Errors could cause regression of 1 or more scenarios. (Example: somewhat complex bug fixes, small new features)
  • Small – No issues are expected. (Example: Very small bug fixes, string changes, or configuration settings changes)

Additional information

@oldalton oldalton requested a review from a team as a code owner February 2, 2021 01:07
Copy link
Contributor

@kaisong1990 kaisong1990 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants