Add back the SharedTokenCacheCredential to handle token which is cached by the InteractiveBrowserCredential

[ArthurKamalov]

The original problem: the InteractiveBrowserCredential required login by browser on each new run.

Observations:
It seems that the InteractiveBrowserCredential is able to save its token to persistent cache storage, but it is not able to use that cache later. ( It actually has its own method _acquire_token_silent, but, as far as I can see, it does not check for token in cache, but already expects an instance of the AuthenticationRecord class, which, I assume, we have to handle and store manually)
That's why I also made an assumtion that we should use SharedTokenCacheCredential for that. I know that the SharedTokenCacheCredential was previously removed by @vxfield and there might be a valid reason for that, but I haven't found any better workaround, so I would glad to hear whether we can use it or not.

[ArthurKamalov]

On Linux, when passing self.tenant_id to the SharedTokenCacheCredential, it fails due to a mismatch of this tenant_id with tenant_id from the cache. Still haven't figured it out why. It seems that it is able to work without it, but I am nearly sure that may cause additional problems too.

[vxfield]

even if the tenant_id is not passed, we automatically fetch it anyway by calling self._discover_tenant_id_()

[ArthurKamalov]

But that's for the constructor of the _DefaultAzureCredential, right? I meant passing the tenant_id to the SharedTokenCacheCredential itself. Is there a chance that the SharedTokenCacheCredential will pick a wrong data without specifying the tenant_id

[vxfield]

Also, since the InteractiveBrowserCredential already has support for caching, I'm confused why we need to add the SharedTokenCacheCredential in the list of credentials.

[vxfield]

Ok, I think I get it.
If we enable the caching in the InteractiveBrowserCredential it will fail even if the browser authentication would succeed but accessing the cache fails.

[vxfield]

Please see my latest commit.
Using our own cache will mitigate issues with tokens cached by other apps.
As Kirill mentioned, if there was a change of authority or tenant_id, the SharedTokenCacheCredential will be skipped and the user can authenticate with the InteractiveBrowserCredential (which will store a new token for these new parameters).

[vxfield]

Observations:
It seems that the InteractiveBrowserCredential is able to save its token to persistent cache storage, but it is not able to use that cache later. ( It actually has its own method _acquire_token_silent, but, as far as I can see, it does not check for token in cache, but already expects an instance of the AuthenticationRecord class, which, I assume, we have to handle and store manually)
That's why I also made an assumtion that we should use SharedTokenCacheCredential for that. I know that the SharedTokenCacheCredential was previously removed by @vxfield and there might be a valid reason for that, but I haven't found any better workaround, so I would glad to hear whether we can use it or not.

The _auth_record is automatically set upon successful Browser Authentication source.
We don't need to worry about it if we also use the SharedTokenCacheCredential as you said to use the cache on a different process or instantiation of our SDK.

[kikomiss]

I think we might also need to pass tenant_id=self.tenant_id to here. It will allow the filtering part to pick-up accounts only the discovered tenant

[vxfield]

done

[ArthurKamalov]

As I mentioned in this comment #603 (comment), on Linux I have a mismatch of a current tenant id and id from the cache, which leads to exception in the SharedTokenCacheCredential. Still trying to find the cause, still not sure if that's only on my machine or not.

[vxfield]

@ArthurKamalov, @kikomiss: I'll hand this back to you now.

I think the next steps would be to add test cases for the _DefaultAzureCredential.get_token() method with different authentication scenarios.

See how we instantiate the _DefaultAzureCredential here.

These new test cases:

• Can be added in the test_authentication.py file.
• Can mock the get_token() method of each credential that we support and check if _DefaultAzureCredential.get_token() is returning that token.
• Can mock the _get_persistence function to raise an Exception and check if a Warning is emitted during the _get_cache_options() method, and that it still returns the mocked InteractiveBrowserCredential token.
• etc...

[ArthurKamalov]

Sorry if I am missing something here, but should this be an error log level?

and what do we really guard here in that try/catch clause? cache._persistence.get_location() ?

[vxfield]

Good catch. I was using error log level for local testing. I updated it to info.

I guarded the cache._persistence.get_location() because:

1. We are calling it just for tracing / info logging purposes
2. _persistence is a private attribute that can change in the future
3. get_location() could raise an expected exception in a particular situation that we are not aware of
4. The cache implementation is different for each OS and would be hard for us to guarantee it always work
5. Finally, I thought it's not worth the risk of this info logging to break our auth :-)

But feel free to modify the code as you see better.
Like we could try to get the location, but even if fails, it we could log the rest of the info ("Using Azure.Identity Token Cache.").

[vxfield]

I made a small improvement based on my own comment, but feel free to adjust it.

[ArthurKamalov]

Yeah, that makes a lot of sense now, thanks :)

[vxfield]

@kikomiss, hopefully this can provide additional guidance for users facing issues with libsecret, but it's a best effort try, and I like your idea of having some documentation in Microsoft Learn docs.

[vxfield]

If we want to check if libsecret is working (instead of checking a ValueError message that can change in the future) we could call msal_extensions.trial_run() if sys.platform.startswith("linux").

[vxfield]

Again, I implemented my own comment :-)

[microsoft-github-policy-service]

@ArthurKamalov please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

• (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.

@microsoft-github-policy-service agree

• (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.

@microsoft-github-policy-service agree company="Microsoft"

Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your
contributions to Microsoft open source projects. This Agreement is effective as of the latest signature
date below.

1. Definitions.
   “Code” means the computer software code, whether in human-readable or machine-executable form,
   that is delivered by You to Microsoft under this Agreement.
   “Project” means any of the projects owned or managed by Microsoft and offered under a license
   approved by the Open Source Initiative (www.opensource.org).
   “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
   Project, including but not limited to communication on electronic mailing lists, source code control
   systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
   discussing and improving that Project, but excluding communication that is conspicuously marked or
   otherwise designated in writing by You as “Not a Submission.”
   “Submission” means the Code and any other copyrightable material Submitted by You, including any
   associated comments and documentation.
2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
   Project. This Agreement covers any and all Submissions that You, now or in the future (except as
   described in Section 4 below), Submit to any Project.
3. Originality of Work. You represent that each of Your Submissions is entirely Your original work.
   Should You wish to Submit materials that are not Your original work, You may Submit them separately
   to the Project if You (a) retain all copyright and license information that was in the materials as You
   received them, (b) in the description accompanying Your Submission, include the phrase “Submission
   containing materials of a third party:” followed by the names of the third party and any licenses or other
   restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
   guidelines concerning Submissions.
4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
   for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
   Submission is made in the course of Your work for an employer or Your employer has intellectual
   property rights in Your Submission by contract or applicable law, You must secure permission from Your
   employer to make the Submission before signing this Agreement. In that case, the term “You” in this
   Agreement will refer to You and the employer collectively. If You change employers in the future and
   desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
   and secure permission from the new employer before Submitting those Submissions.
5. Licenses.

• Copyright License. You grant Microsoft, and those who receive the Submission directly or
  indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
  Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
  the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
  parties.
• Patent License. You grant Microsoft, and those who receive the Submission directly or
  indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
  Your patent claims that are necessarily infringed by the Submission or the combination of the
  Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
  import or otherwise dispose of the Submission alone or with the Project.
• Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
  No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
  granted by implication, exhaustion, estoppel or otherwise.

6. Representations and Warranties. You represent that You are legally entitled to grant the above
   licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
   have disclosed under Section 3). You represent that You have secured permission from Your employer to
   make the Submission in cases where Your Submission is made in the course of Your work for Your
   employer or Your employer has intellectual property rights in Your Submission by contract or applicable
   law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
   have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
   You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
   REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
   EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
   PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
   NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
7. Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
   You later become aware that would make Your representations in this Agreement inaccurate in any
   respect.
8. Information about Submissions. You agree that contributions to Projects and information about
   contributions may be maintained indefinitely and disclosed publicly, including Your name and other
   information that You submit with Your Submission.
9. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
   the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
   Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
   exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
   defenses of lack of personal jurisdiction and forum non-conveniens.
10. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
    supersedes any and all prior agreements, understandings or communications, written or oral, between
    the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.