[Identity] allowLoggingAccountIdentifiers support

[sadasant]

While investigating what sensitive logging to add to our credentials, we have determined that the most useful information we could log are the account identifiers after retrieving a token. This issue describes a flexible approach to add support to log the account information on our credentials.

Since we specifically didn’t want to depend on MSAL for this feature, and we only wanted the account identifiers, I’m parsing the access token and extracting some of the values for this feature. I’m doing that, and the logging, at the network layer of the Identity library, which covers all credentials.

This PR:

1. Adds allowLoggingAccountIdentifiers to the options of the credentials’ constructors.
2. Retrieves the account identifiers after authenticating.

• Parses the first section of the access token after the . (which can be obtained with access_token.split(“.”)[1]), then extracts the following properties: appid, upn, tid, oid.

3. After a token is retrieved and the identifiers have been extracted, if allowLoggingAccountIdentifiers was set in the constructor of the credential, now we log a message similar to the following: [Authenticated account] Client ID: ${appid}. Tenant ID: ${tid}. User Principal Name: ${upn || "No User Principal Name available"}. Object ID (user): ${oid}.

Feedback appreciated 🙏

Fixes #20502
Fixes #17460

[azure-sdk]

API changes have been detected in @azure/identity. You can review API changes here

API changes

+     allowLoggingAccountIdentifiers?: boolean;

[christothes]

Would it be possible to get any of this info from MSAL in a way that doesn't require us to parse the raw response? I'm a bit concerned that we could somehow unintentionally log the wrong sensitive data.

[sadasant]

As long as we limit ourselves to these 4 values we should be ok to not log something too sensitive.

MSAL does allow you to retrieve this with their AccountRecord, but we don’t use MSAL in every credential.

[azure-sdk]

API changes have been detected in @azure/identity. You can review API changes here

API changes

+     loggingOptions?: LogPolicyOptions & {
+             allowLoggingAccountIdentifiers?: boolean;
+         };

[check-enforcer]

This pull request is protected by Check Enforcer.

What is Check Enforcer?

Check Enforcer helps ensure all pull requests are covered by at least one check-run (typically an Azure Pipeline). When all check-runs associated with this pull request pass then Check Enforcer itself will pass.

Why am I getting this message?

You are getting this message because Check Enforcer did not detect any check-runs being associated with this pull request within five minutes. This may indicate that your pull request is not covered by any pipelines and so Check Enforcer is correctly blocking the pull request being merged.

What should I do now?

If the check-enforcer check-run is not passing and all other check-runs associated with this PR are passing (excluding license-cla) then you could try telling Check Enforcer to evaluate your pull request again. You can do this by adding a comment to this pull request as follows:
/check-enforcer evaluate
Typically evaulation only takes a few seconds. If you know that your pull request is not covered by a pipeline and this is expected you can override Check Enforcer using the following command:
/check-enforcer override
Note that using the override command triggers alerts so that follow-up investigations can occur (PRs still need to be approved as normal).

What if I am onboarding a new service?

Often, new services do not have validation pipelines associated with them, in order to bootstrap pipelines for a new service, you can issue the following command as a pull request comment:
/azp run prepare-pipelines
This will run a pipeline that analyzes the source tree and creates the pipelines necessary to build and validate your pull request. Once the pipeline has been created you can trigger the pipeline using the following comment:
/azp run js - [service] - ci

[KarishmaGhiya]

Looks great!!