diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
new file mode 100644
index 00000000..cbd8381f
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,32 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: "[Bug] "
+labels: needs attention, untriaged
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to our [off-the-shelf samples](https://github.com/AzureAD/microsoft-authentication-library-for-python/tree/dev/sample) and pick one that is closest to your usage scenario. You should not need to modify the sample.
+2. Follow the description of the sample, typically at the beginning of it, to prepare a `config.json` containing your test configurations
+3. Run such sample, typically by `python sample.py config.json`
+4. See the error
+5. In this bug report, tell us the sample you choose, paste the content of the config.json with your test setup (which you can choose to skip your credentials, and/or mail it to our developer's email).
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**What you see instead**
+Paste the sample output, or add screenshots to help explain your problem.
+
+**The MSAL Python version you are using**
+Paste the output of this
+`python -c "import msal; print(msal.__version__)"`
+
+**Additional context**
+Add any other context about the problem here.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml
new file mode 100644
index 00000000..ddc73b5c
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.yaml
@@ -0,0 +1,40 @@
+name: Feature request
+description: Suggest a new feature for MSAL Python.
+labels: ["feature request", "untriaged", "needs attention"]
+title : '[Feature Request] '
+body:
+- type: markdown
+ attributes:
+ value: |
+ ## Before submitting your feature request
+ Please make sure that your question or issue is not already covered in [MSAL documentation](https://learn.microsoft.com/entra/msal/python/) or [samples](https://learn.microsoft.com/azure/active-directory/develop/sample-v2-code?tabs=apptype).
+
+- type: markdown
+ attributes:
+ value: |
+ ## Feature request for MSAL Python
+
+- type: dropdown
+ attributes:
+ label: MSAL client type
+ description: Are you using Public Client (desktop apps, CLI apps) or Confidential Client (web apps, web APIs, service-to-service, managed identity)?
+ multiple: true
+ options:
+ - "Public"
+ - "Confidential"
+ validations:
+ required: true
+
+- type: textarea
+ attributes:
+ label: Problem Statement
+ description: "Describe the problem or context for this feature request."
+ validations:
+ required: true
+
+- type: textarea
+ attributes:
+ label: Proposed solution
+ description: "Describe the solution you'd like."
+ validations:
+ required: false
diff --git a/.github/workflows/python-package.yml b/.github/workflows/python-package.yml
new file mode 100644
index 00000000..db891158
--- /dev/null
+++ b/.github/workflows/python-package.yml
@@ -0,0 +1,133 @@
+# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+
+name: CI/CD
+
+on:
+ push:
+ pull_request:
+ branches: [ dev ]
+
+ # This guards against unknown PR until a community member vet it and label it.
+ types: [ labeled ]
+
+jobs:
+ ci:
+ env:
+ # Fake a TRAVIS env so that the pre-existing test cases would behave like before
+ TRAVIS: true
+ LAB_APP_CLIENT_ID: ${{ secrets.LAB_APP_CLIENT_ID }}
+ LAB_APP_CLIENT_SECRET: ${{ secrets.LAB_APP_CLIENT_SECRET }}
+ LAB_APP_CLIENT_CERT_BASE64: ${{ secrets.LAB_APP_CLIENT_CERT_BASE64 }}
+ LAB_APP_CLIENT_CERT_PFX_PATH: lab_cert.pfx
+ LAB_OBO_CLIENT_SECRET: ${{ secrets.LAB_OBO_CLIENT_SECRET }}
+ LAB_OBO_CONFIDENTIAL_CLIENT_ID: ${{ secrets.LAB_OBO_CONFIDENTIAL_CLIENT_ID }}
+ LAB_OBO_PUBLIC_CLIENT_ID: ${{ secrets.LAB_OBO_PUBLIC_CLIENT_ID }}
+
+ # Derived from https://docs.github.com/en/actions/guides/building-and-testing-python#starting-with-the-python-workflow-template
+ runs-on: ubuntu-latest # It switched to 22.04 shortly after 2022-Nov-8
+ strategy:
+ matrix:
+ python-version: [3.7, 3.8, 3.9, "3.10", "3.11", "3.12"]
+
+ steps:
+ - uses: actions/checkout@v4
+ - name: Set up Python ${{ matrix.python-version }}
+ uses: actions/setup-python@v5
+ # It automatically takes care of pip cache, according to
+ # https://docs.github.com/en/actions/using-workflows/caching-dependencies-to-speed-up-workflows#about-caching-workflow-dependencies
+ with:
+ python-version: ${{ matrix.python-version }}
+ cache: 'pip'
+
+ - name: Install dependencies
+ run: |
+ python -m pip install --upgrade pip
+ python -m pip install flake8 pytest
+ if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+ - name: Populate lab cert.pfx
+ # https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions#storing-base64-binary-blobs-as-secrets
+ run: echo $LAB_APP_CLIENT_CERT_BASE64 | base64 -d > $LAB_APP_CLIENT_CERT_PFX_PATH
+ - name: Test with pytest
+ run: pytest --benchmark-skip
+ - name: Lint with flake8
+ run: |
+ # stop the build if there are Python syntax errors or undefined names
+ #flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+ # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+ #flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+
+ cb:
+ # Benchmark only after the correctness has been tested by CI,
+ # and then run benchmark only once (sampling with only one Python version).
+ needs: ci
+ runs-on: ubuntu-latest
+ permissions:
+ contents: write
+ steps:
+ - uses: actions/checkout@v4
+ - name: Set up Python 3.9
+ uses: actions/setup-python@v5
+ with:
+ python-version: 3.9
+ cache: 'pip'
+ - name: Install dependencies
+ run: |
+ python -m pip install --upgrade pip
+ if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+ - name: Setup an updatable cache for Performance Baselines
+ uses: actions/cache@v4
+ with:
+ path: .perf.baseline
+ key: ${{ runner.os }}-performance-${{ hashFiles('tests/test_benchmark.py') }}
+ restore-keys: ${{ runner.os }}-performance-
+ - name: Run benchmark
+ run: pytest --benchmark-only --benchmark-json benchmark.json --log-cli-level INFO tests/test_benchmark.py
+ - name: Render benchmark result
+ uses: benchmark-action/github-action-benchmark@v1
+ with:
+ tool: 'pytest'
+ output-file-path: benchmark.json
+ fail-on-alert: true
+ - name: Publish Gibhub Pages
+ run: git push origin gh-pages
+
+ cd:
+ needs: ci
+ # Note: github.event.pull_request.draft == false WON'T WORK in "if" statement,
+ # because the triggered event is a push, not a pull_request.
+ # This means each commit will trigger a release on TestPyPI.
+ # Those releases will only succeed when each push has a new version number: a1, a2, a3, etc.
+ if: |
+ github.event_name == 'push' &&
+ (
+ startsWith(github.ref, 'refs/tags') ||
+ startsWith(github.ref, 'refs/heads/release-')
+ )
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v4
+ - name: Set up Python 3.9
+ uses: actions/setup-python@v5
+ with:
+ python-version: 3.9
+ cache: 'pip'
+ - name: Build a package for release
+ run: |
+ python -m pip install build --user
+ python -m build --sdist --wheel --outdir dist/ .
+ - name: |
+ Publish to TestPyPI when pushing to release-* branch.
+ You better test with a1, a2, b1, b2 releases first.
+ uses: pypa/gh-action-pypi-publish@v1.4.2
+ if: startsWith(github.ref, 'refs/heads/release-')
+ with:
+ user: __token__
+ password: ${{ secrets.TEST_PYPI_API_TOKEN }}
+ repository_url: https://test.pypi.org/legacy/
+ - name: Publish to PyPI when tagged
+ if: startsWith(github.ref, 'refs/tags')
+ uses: pypa/gh-action-pypi-publish@v1.4.2
+ with:
+ user: __token__
+ password: ${{ secrets.PYPI_API_TOKEN }}
diff --git a/.gitignore b/.gitignore
index eb93430d..36b43713 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,48 +1,62 @@
-.DS_Store
-*.py[co]
+# Python cache
+__pycache__/
+*.pyc
-# Packages
-*.egg
-*.egg-info
-dist
-build
-eggs
-parts
-var
-sdist
-develop-eggs
-.installed.cfg
+# PTVS analysis
+.ptvs/
+*.pyproj
-# Installer logs
-pip-log.txt
+# Build results
+/bin/
+/obj/
+/dist/
+/MANIFEST
-# Unit test / coverage reports
-.coverage
-.tox
+# Result of running python setup.py install/pip install -e
+/build/
+/msal.egg-info/
-#Translations
-*.mo
+# Test results
+/TestResults/
-#Mr Developer
-.mr.developer.cfg
+# User-specific files
+*.suo
+*.user
+*.sln.docstates
+/tests/config.py
-# Emacs backup files
-*~
+# Windows image file caches
+Thumbs.db
+ehthumbs.db
-# IDEA / PyCharm IDE
-.idea/
+# Folder config file
+Desktop.ini
-# vim
-*.vim
-*.swp
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Mac desktop service store files
+.DS_Store
-# Virtualenvs
-env*
+.idea
+src/build
+*.iml
+/doc/_build
-docs/source/reference/services
-tests/coverage.xml
-tests/nosetests.xml
+# Virtual Environments
+/env*
+.venv/
+docs/_build/
+# Visual Studio Files
+/.vs/*
+/tests/.vs/*
+
+# vim files
+*.swp
# The test configuration file(s) could potentially contain credentials
tests/config.json
+
+.env
+.perf.baseline
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
new file mode 100644
index 00000000..d74e663d
--- /dev/null
+++ b/.readthedocs.yaml
@@ -0,0 +1,22 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+ os: ubuntu-22.04
+ tools:
+ python: "3.12"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+ configuration: docs/conf.py
+
+# We recommend specifying your dependencies to enable reproducible builds:
+# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+ install:
+ - requirements: docs/requirements.txt
diff --git a/.travis.yml b/.travis.yml
new file mode 100644
index 00000000..85917242
--- /dev/null
+++ b/.travis.yml
@@ -0,0 +1,46 @@
+sudo: false
+language: python
+python:
+ - "2.7"
+ - "3.5"
+ - "3.6"
+# Borrowed from https://github.com/travis-ci/travis-ci/issues/9815
+# Enable 3.7 without globally enabling sudo and dist: xenial for other build jobs
+matrix:
+ include:
+ - python: 3.7
+ dist: xenial
+ sudo: true
+ - python: 3.8
+ dist: xenial
+ sudo: true
+
+install:
+ - pip install -r requirements.txt
+script:
+ - python -m unittest discover -s tests
+
+deploy:
+ - # test pypi
+ provider: pypi
+ distributions: "sdist bdist_wheel"
+ server: https://test.pypi.org/legacy/
+ user: "nugetaad"
+ password:
+ secure: KkjKySJujYxx31B15mlAZr2Jo4P99LcrMj3uON/X/WMXAqYVcVsYJ6JSzUvpNnCAgk+1hc24Qp6nibQHV824yiK+eG4qV+lpzkEEedkRx6NOW/h09OkT+pOSVMs0kcIhz7FzqChpl+jf6ZZpb13yJpQg2LoZIA4g8UdYHHFidWt4m5u1FZ9LPCqQ0OT3gnKK4qb0HIDaECfz5GYzrelLLces0PPwj1+X5eb38xUVtbkA1UJKLGKI882D8Rq5eBdbnDGsfDnF6oU+EBnGZ7o6HVQLdBgagDoVdx7yoXyntULeNxTENMTOZJEJbncQwxRgeEqJWXTTEW57O6Jo5uiHEpJA9lAePlRbS+z6BPDlnQogqOdTsYS0XMfOpYE0/r3cbtPUjETOmGYQxjQzfrFBfM7jaWnUquymZRYqCQ66VDo3I/ykNOCoM9qTmWt5L/MFfOZyoxLHnDThZBdJ3GXHfbivg+v+vOfY1gG8e2H2lQY+/LIMIJibF+MS4lJgrB81dcNdBzyxMNByuWQjSL1TY7un0QzcRcZz2NLrFGg8+9d67LQq4mK5ySimc6zdgnanuROU02vGr1EApT6D/qUItiulFgWqInNKrFXE9q74UP/WSooZPoLa3Du8y5s4eKerYYHQy5eSfIC8xKKDU8MSgoZhwQhCUP46G9Nsty0PYQc=
+ on:
+ branch: master
+ tags: false
+ condition: $TRAVIS_PYTHON_VERSION = "2.7"
+
+ - # production pypi
+ provider: pypi
+ distributions: "sdist bdist_wheel"
+ user: "nugetaad"
+ password:
+ secure: KkjKySJujYxx31B15mlAZr2Jo4P99LcrMj3uON/X/WMXAqYVcVsYJ6JSzUvpNnCAgk+1hc24Qp6nibQHV824yiK+eG4qV+lpzkEEedkRx6NOW/h09OkT+pOSVMs0kcIhz7FzqChpl+jf6ZZpb13yJpQg2LoZIA4g8UdYHHFidWt4m5u1FZ9LPCqQ0OT3gnKK4qb0HIDaECfz5GYzrelLLces0PPwj1+X5eb38xUVtbkA1UJKLGKI882D8Rq5eBdbnDGsfDnF6oU+EBnGZ7o6HVQLdBgagDoVdx7yoXyntULeNxTENMTOZJEJbncQwxRgeEqJWXTTEW57O6Jo5uiHEpJA9lAePlRbS+z6BPDlnQogqOdTsYS0XMfOpYE0/r3cbtPUjETOmGYQxjQzfrFBfM7jaWnUquymZRYqCQ66VDo3I/ykNOCoM9qTmWt5L/MFfOZyoxLHnDThZBdJ3GXHfbivg+v+vOfY1gG8e2H2lQY+/LIMIJibF+MS4lJgrB81dcNdBzyxMNByuWQjSL1TY7un0QzcRcZz2NLrFGg8+9d67LQq4mK5ySimc6zdgnanuROU02vGr1EApT6D/qUItiulFgWqInNKrFXE9q74UP/WSooZPoLa3Du8y5s4eKerYYHQy5eSfIC8xKKDU8MSgoZhwQhCUP46G9Nsty0PYQc=
+ on:
+ branch: master
+ tags: true
+ condition: $TRAVIS_PYTHON_VERSION = "2.7"
+
diff --git a/CODEOWNERS b/CODEOWNERS
new file mode 100644
index 00000000..dd24b01a
--- /dev/null
+++ b/CODEOWNERS
@@ -0,0 +1 @@
+* @AzureAD/id4s-msal-team
diff --git a/LICENSE b/LICENSE
index 844a00f9..e7a9ff04 100644
--- a/LICENSE
+++ b/LICENSE
@@ -1,7 +1,6 @@
The MIT License (MIT)
-Copyright (c) 2021 Ray Luo
-Copyright (c) 2018-2021 Microsoft Corporation.
+Copyright (c) Microsoft Corporation.
All rights reserved.
This code is licensed under the MIT License.
@@ -22,4 +21,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+THE SOFTWARE.
\ No newline at end of file
diff --git a/README.md b/README.md
new file mode 100644
index 00000000..cda5a1e8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,149 @@
+# Microsoft Authentication Library (MSAL) for Python
+
+| `dev` branch | Reference Docs | # of Downloads per different platforms | # of Downloads per recent MSAL versions | Benchmark Diagram |
+|:------------:|:--------------:|:--------------------------------------:|:---------------------------------------:|:-----------------:|
+ [](https://github.com/AzureAD/microsoft-authentication-library-for-python/actions) | [](https://msal-python.readthedocs.io/en/latest/?badge=latest) | [](https://pypistats.org/packages/msal) | [](https://pepy.tech/project/msal) | [📉](https://azuread.github.io/microsoft-authentication-library-for-python/dev/bench/)
+
+The Microsoft Authentication Library for Python enables applications to integrate with the [Microsoft identity platform](https://aka.ms/aaddevv2). It allows you to sign in users or apps with Microsoft identities ([Microsoft Entra ID](https://www.microsoft.com/security/business/identity-access/microsoft-entra-id), [External identities](https://www.microsoft.com/security/business/identity-access/microsoft-entra-external-id), [Microsoft Accounts](https://account.microsoft.com) and [Azure AD B2C](https://azure.microsoft.com/services/active-directory-b2c/) accounts) and obtain tokens to call Microsoft APIs such as [Microsoft Graph](https://graph.microsoft.io/) or your own APIs registered with the Microsoft identity platform. It is built using industry standard OAuth2 and OpenID Connect protocols
+
+Not sure whether this is the SDK you are looking for your app? There are other Microsoft Identity SDKs
+[here](https://github.com/AzureAD/microsoft-authentication-library-for-python/wiki/Microsoft-Authentication-Client-Libraries).
+
+Quick links:
+
+| [Getting Started](https://learn.microsoft.com/azure/active-directory/develop/web-app-quickstart?pivots=devlang-python)| [Docs](https://github.com/AzureAD/microsoft-authentication-library-for-python/wiki) | [Samples](https://aka.ms/aaddevsamplesv2) | [Support](README.md#community-help-and-support) | [Feedback](https://forms.office.com/r/TMjZkDbzjY) |
+| --- | --- | --- | --- | --- |
+
+## Scenarios supported
+
+Click on the following thumbnail to visit a large map with clickable links to proper samples.
+
+[](https://msal-python.readthedocs.io/en/latest/)
+
+## Installation
+
+You can find MSAL Python on [Pypi](https://pypi.org/project/msal/).
+
+1. If you haven't already, [install and/or upgrade the pip](https://pip.pypa.io/en/stable/installing/)
+ of your Python environment to a recent version. We tested with pip 18.1.
+1. As usual, just run `pip install msal`.
+
+## Versions
+
+This library follows [Semantic Versioning](http://semver.org/).
+
+You can find the changes for each version under
+[Releases](https://github.com/AzureAD/microsoft-authentication-library-for-python/releases).
+
+## Usage
+
+Before using MSAL Python (or any MSAL SDKs, for that matter), you will have to
+[register your application with the Microsoft identity platform](https://docs.microsoft.com/azure/active-directory/develop/quickstart-v2-register-an-app).
+
+Acquiring tokens with MSAL Python follows this 3-step pattern.
+(Note: That is the high level conceptual pattern.
+There will be some variations for different flows. They are demonstrated in
+[runnable samples hosted right in this repo](https://github.com/AzureAD/microsoft-authentication-library-for-python/tree/dev/sample).
+)
+
+
+1. MSAL proposes a clean separation between
+ [public client applications, and confidential client applications](https://tools.ietf.org/html/rfc6749#section-2.1).
+ So you will first create either a `PublicClientApplication` or a `ConfidentialClientApplication` instance,
+ and ideally reuse it during the lifecycle of your app. The following example shows a `PublicClientApplication`:
+
+ ```python
+ from msal import PublicClientApplication
+ app = PublicClientApplication(
+ "your_client_id",
+ authority="https://login.microsoftonline.com/Enter_the_Tenant_Name_Here")
+ ```
+
+ Later, each time you would want an access token, you start by:
+ ```python
+ result = None # It is just an initial value. Please follow instructions below.
+ ```
+
+2. The API model in MSAL provides you explicit control on how to utilize token cache.
+ This cache part is technically optional, but we highly recommend you to harness the power of MSAL cache.
+ It will automatically handle the token refresh for you.
+
+ ```python
+ # We now check the cache to see
+ # whether we already have some accounts that the end user already used to sign in before.
+ accounts = app.get_accounts()
+ if accounts:
+ # If so, you could then somehow display these accounts and let end user choose
+ print("Pick the account you want to use to proceed:")
+ for a in accounts:
+ print(a["username"])
+ # Assuming the end user chose this one
+ chosen = accounts[0]
+ # Now let's try to find a token in cache for this account
+ result = app.acquire_token_silent(["your_scope"], account=chosen)
+ ```
+
+3. Either there is no suitable token in the cache, or you chose to skip the previous step,
+ now it is time to actually send a request to AAD to obtain a token.
+ There are different methods based on your client type and scenario. Here we demonstrate a placeholder flow.
+
+ ```python
+ if not result:
+ # So no suitable token exists in cache. Let's get a new one from AAD.
+ result = app.acquire_token_by_one_of_the_actual_method(..., scopes=["User.Read"])
+ if "access_token" in result:
+ print(result["access_token"]) # Yay!
+ else:
+ print(result.get("error"))
+ print(result.get("error_description"))
+ print(result.get("correlation_id")) # You may need this when reporting a bug
+ ```
+
+Refer the [Wiki](https://github.com/AzureAD/microsoft-authentication-library-for-python/wiki) pages for more details on the MSAL Python functionality and usage.
+
+## Migrating from ADAL
+
+If your application is using ADAL Python, we recommend you to update to use MSAL Python. No new feature work will be done in ADAL Python.
+
+See the [ADAL to MSAL migration](https://github.com/AzureAD/microsoft-authentication-library-for-python/wiki/Migrate-to-MSAL-Python) guide.
+
+## Roadmap
+
+You can follow the latest updates and plans for MSAL Python in the [Roadmap](https://github.com/AzureAD/microsoft-authentication-library-for-python/wiki/Roadmap) published on our Wiki.
+
+## Samples and Documentation
+
+MSAL Python supports multiple [application types and authentication scenarios](https://docs.microsoft.com/azure/active-directory/develop/authentication-flows-app-scenarios).
+The generic documents on
+[Auth Scenarios](https://docs.microsoft.com/azure/active-directory/develop/authentication-scenarios)
+and
+[Auth protocols](https://docs.microsoft.com/azure/active-directory/develop/active-directory-v2-protocols)
+are recommended reading.
+
+We provide a [full suite of sample applications](https://aka.ms/aaddevsamplesv2) and [documentation](https://aka.ms/aaddevv2) to help you get started with learning the Microsoft identity platform.
+
+## Community Help and Support
+
+We leverage Stack Overflow to work with the community on supporting Microsoft Entra and its SDKs, including this one!
+We highly recommend you ask your questions on Stack Overflow (we're all on there!)
+Also browser existing issues to see if someone has had your question before.
+
+We recommend you use the "msal" tag so we can see it!
+Here is the latest Q&A on Stack Overflow for MSAL:
+[http://stackoverflow.com/questions/tagged/msal](http://stackoverflow.com/questions/tagged/msal)
+
+## Submit Feedback
+
+We'd like your thoughts on this library. Please complete [this short survey.](https://forms.office.com/r/TMjZkDbzjY)
+
+## Security Reporting
+
+If you find a security issue with our libraries or services please report it to [secure@microsoft.com](mailto:secure@microsoft.com) with as much detail as possible. Your submission may be eligible for a bounty through the [Microsoft Bounty](http://aka.ms/bugbounty) program. Please do not post security issues to GitHub Issues or any other public site. We will contact you shortly upon receiving the information. We encourage you to get notifications of when security incidents occur by visiting [this page](https://technet.microsoft.com/security/dd252948) and subscribing to Security Advisory Alerts.
+
+## Contributing
+
+All code is licensed under the MIT license and we triage actively on GitHub. We enthusiastically welcome contributions and feedback. Please read the [contributing guide](./contributing.md) before starting.
+
+## We Value and Adhere to the Microsoft Open Source Code of Conduct
+
+This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
diff --git a/contributing.md b/contributing.md
new file mode 100644
index 00000000..e78c1ce1
--- /dev/null
+++ b/contributing.md
@@ -0,0 +1,122 @@
+# CONTRIBUTING
+
+Azure Active Directory SDK projects welcomes new contributors. This document will guide you
+through the process.
+
+### CONTRIBUTOR LICENSE AGREEMENT
+
+Please visit [https://cla.microsoft.com/](https://cla.microsoft.com/) and sign the Contributor License
+Agreement. You only need to do that once. We can not look at your code until you've submitted this request.
+
+
+### FORK
+
+Fork this project on GitHub and check out your copy.
+
+Example for Project Foo (which can be any ADAL or MSAL or just any library):
+
+```
+$ git clone git@github.com:username/project-foo.git
+$ cd project-foo
+$ git remote add upstream git@github.com:AzureAD/project-foo.git
+```
+
+No need to decide if you want your feature or bug fix to go into the dev branch
+or the master branch. **All bug fixes and new features should go into the dev branch.**
+
+The master branch is effectively frozen; patches that change the SDKs
+protocols or API surface area or affect the run-time behavior of the SDK will be rejected.
+
+Some of our SDKs have bundled dependencies that are not part of the project proper.
+Any changes to files in those directories or its subdirectories should be sent to their respective projects.
+Do not send your patch to us, we cannot accept it.
+
+In case of doubt, open an issue in the [issue tracker](issues).
+
+Especially do so if you plan to work on a major change in functionality. Nothing is more
+frustrating than seeing your hard work go to waste because your vision
+does not align with our goals for the SDK.
+
+
+### BRANCH
+
+Okay, so you have decided on the proper branch. Create a feature branch
+and start hacking:
+
+```
+$ git checkout -b my-feature-branch
+```
+
+### COMMIT
+
+Make sure git knows your name and email address:
+
+```
+$ git config --global user.name "J. Random User"
+$ git config --global user.email "j.random.user@example.com"
+```
+
+Writing good commit logs is important. A commit log should describe what
+changed and why. Follow these guidelines when writing one:
+
+1. The first line should be 50 characters or less and contain a short
+ description of the change prefixed with the name of the changed
+ subsystem (e.g. "net: add localAddress and localPort to Socket").
+2. Keep the second line blank.
+3. Wrap all other lines at 72 columns.
+
+A good commit log looks like this:
+
+```
+fix: explaining the commit in one line
+
+Body of commit message is a few lines of text, explaining things
+in more detail, possibly giving some background about the issue
+being fixed, etc etc.
+
+The body of the commit message can be several paragraphs, and
+please do proper word-wrap and keep columns shorter than about
+72 characters or so. That way `git log` will show things
+nicely even when it is indented.
+```
+
+The header line should be meaningful; it is what other people see when they
+run `git shortlog` or `git log --oneline`.
+
+Check the output of `git log --oneline files_that_you_changed` to find out
+what directories your changes touch.
+
+
+### REBASE
+
+Use `git rebase` (not `git merge`) to sync your work from time to time.
+
+```
+$ git fetch upstream
+$ git rebase upstream/v0.1 # or upstream/master
+```
+
+
+### TEST
+
+Bug fixes and features should come with tests. Add your tests in the
+test directory. This varies by repository but often follows the same convention of /src/test. Look at other tests to see how they should be
+structured (license boilerplate, common includes, etc.).
+
+
+Make sure that all tests pass.
+
+
+### PUSH
+
+```
+$ git push origin my-feature-branch
+```
+
+Go to https://github.com/username/microsoft-authentication-library-for-***.git and select your feature branch. Click
+the 'Pull Request' button and fill out the form.
+
+Pull requests are usually reviewed within a few days. If there are comments
+to address, apply your changes in a separate commit and push that to your
+feature branch. Post a comment in the pull request afterwards; GitHub does
+not send out notifications when you add commits.
diff --git a/docs/Makefile b/docs/Makefile
new file mode 100644
index 00000000..298ea9e2
--- /dev/null
+++ b/docs/Makefile
@@ -0,0 +1,19 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS =
+SPHINXBUILD = sphinx-build
+SOURCEDIR = .
+BUILDDIR = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+ @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+ @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
\ No newline at end of file
diff --git a/docs/conf.py b/docs/conf.py
new file mode 100644
index 00000000..f9762ca2
--- /dev/null
+++ b/docs/conf.py
@@ -0,0 +1,186 @@
+# -*- coding: utf-8 -*-
+#
+# Configuration file for the Sphinx documentation builder.
+#
+# This file does only contain a selection of the most common options. For a
+# full list see the documentation:
+# http://www.sphinx-doc.org/en/master/config
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+from datetime import date
+import os
+import sys
+sys.path.insert(0, os.path.abspath('..'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = u'MSAL Python'
+copyright = u'{0}, Microsoft'.format(date.today().year)
+author = u'Microsoft'
+
+# The short X.Y version
+from msal import __version__ as version
+# The full version, including alpha/beta/rc tags
+release = version
+
+
+# -- General configuration ---------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+ 'sphinx.ext.autodoc', # This seems need to be the first extension to load
+ 'sphinx.ext.githubpages',
+ 'sphinx_paramlinks',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = "en"
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = [u'_build', 'Thumbs.db', '.DS_Store']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = None
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages. See the documentation for
+# a list of builtin themes.
+#
+# html_theme = 'alabaster'
+html_theme = 'furo'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further. For a list of options available for each theme, see the
+# documentation.
+#
+html_theme_options = {
+ "light_css_variables": {
+ "font-stack": "'Segoe UI', SegoeUI, 'Helvetica Neue', Helvetica, Arial, sans-serif",
+ "font-stack--monospace": "SFMono-Regular, Consolas, 'Liberation Mono', Menlo, Courier, monospace",
+ },
+}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+#html_static_path = ['_static']
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# The default sidebars (for documents that don't match any pattern) are
+# defined by theme itself. Builtin themes are using these templates by
+# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
+# 'searchbox.html']``.
+#
+# html_sidebars = {}
+
+
+# -- Options for HTMLHelp output ---------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'MSALPythondoc'
+
+
+# -- Options for LaTeX output ------------------------------------------------
+
+latex_elements = {
+ # The paper size ('letterpaper' or 'a4paper').
+ #
+ # 'papersize': 'letterpaper',
+
+ # The font size ('10pt', '11pt' or '12pt').
+ #
+ # 'pointsize': '10pt',
+
+ # Additional stuff for the LaTeX preamble.
+ #
+ # 'preamble': '',
+
+ # Latex figure (float) alignment
+ #
+ # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+# author, documentclass [howto, manual, or own class]).
+latex_documents = [
+ (master_doc, 'MSALPython.tex', u'MSAL Python Documentation',
+ u'Microsoft', 'manual'),
+]
+
+
+# -- Options for manual page output ------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+ (master_doc, 'msalpython', u'MSAL Python Documentation',
+ [author], 1)
+]
+
+
+# -- Options for Texinfo output ----------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+# dir menu entry, description, category)
+texinfo_documents = [
+ (master_doc, 'MSALPython', u'MSAL Python Documentation',
+ author, 'MSALPython', 'One line description of project.',
+ 'Miscellaneous'),
+]
+
+
+# -- Options for Epub output -------------------------------------------------
+
+# Bibliographic Dublin Core info.
+epub_title = project
+
+# The unique identifier of the text. This can be a ISBN number
+# or the project homepage.
+#
+# epub_identifier = ''
+
+# A unique identification for the text.
+#
+# epub_uid = ''
+
+# A list of files that should not be packed into the epub file.
+epub_exclude_files = ['search.html']
+
+
+# -- Extension configuration -------------------------------------------------
diff --git a/docs/daemon-app.svg b/docs/daemon-app.svg
new file mode 100644
index 00000000..8f1af659
--- /dev/null
+++ b/docs/daemon-app.svg
@@ -0,0 +1,1074 @@
+
+
+
+
\ No newline at end of file
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 00000000..1c5d79bc
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,190 @@
+=========================
+MSAL Python Documentation
+=========================
+
+.. toctree::
+ :maxdepth: 2
+ :caption: Contents:
+ :hidden:
+
+..
+ Comment: Perhaps because of the theme, only the first level sections will show in TOC,
+ regardless of maxdepth setting.
+ UPDATE: And now (early 2024) suddenly a function-level, long TOC is generated,
+ even though maxdepth is set to 2.
+
+You can find high level conceptual documentations in the project
+`README `_.
+
+Scenarios
+=========
+
+There are many `different application scenarios `_.
+MSAL Python supports some of them.
+**The following diagram serves as a map. Locate your application scenario on the map.**
+**If the corresponding icon is clickable, it will bring you to an MSAL Python sample for that scenario.**
+
+* Most authentication scenarios acquire tokens representing the signed-in user.
+
+ .. raw:: html
+
+
+
+
+
+
+* There are also daemon apps, who acquire tokens representing themselves, not a user.
+
+ .. raw:: html
+
+
+
+
+
+
+* There are other less common samples, such for ADAL-to-MSAL migration,
+ `available inside the project code base
+ `_.
+
+
+API Reference
+=============
+.. note::
+
+ Only the contents inside
+ `this source file `_
+ and their documented methods (unless otherwise marked as deprecated)
+ are MSAL Python public API,
+ which are guaranteed to be backward-compatible until the next major version.
+
+ Everything else, regardless of their naming, are all internal helpers,
+ which could change at anytime in the future, without prior notice.
+
+The following section is the API Reference of MSAL Python.
+The API Reference is like a dictionary, which is useful when:
+
+* You already followed our sample(s) above and have your app up and running,
+ but want to know more on how you could tweak the authentication experience
+ by using other optional parameters (there are plenty of them!)
+* Some important features have their in-depth documentations in the API Reference.
+
+MSAL proposes a clean separation between
+`public client applications and confidential client applications
+`_.
+
+They are implemented as two separated classes,
+with different methods for different authentication scenarios.
+
+ClientApplication
+-----------------
+
+.. autoclass:: msal.ClientApplication
+ :members:
+ :inherited-members:
+
+ .. automethod:: __init__
+
+PublicClientApplication
+-----------------------
+
+.. autoclass:: msal.PublicClientApplication
+ :members:
+
+ .. autoattribute:: msal.PublicClientApplication.CONSOLE_WINDOW_HANDLE
+ .. automethod:: __init__
+
+ConfidentialClientApplication
+-----------------------------
+
+.. autoclass:: msal.ConfidentialClientApplication
+ :members:
+
+
+TokenCache
+----------
+
+One of the parameters accepted by
+both `PublicClientApplication` and `ConfidentialClientApplication`
+is the `TokenCache`.
+
+.. autoclass:: msal.TokenCache
+ :members:
+
+You can subclass it to add new behavior, such as, token serialization.
+See `SerializableTokenCache` for example.
+
+.. autoclass:: msal.SerializableTokenCache
+ :members:
+
+Prompt
+------
+.. autoclass:: msal.Prompt
+ :members:
+
+ .. autoattribute:: msal.Prompt.SELECT_ACCOUNT
+ .. autoattribute:: msal.Prompt.NONE
+ .. autoattribute:: msal.Prompt.CONSENT
+ .. autoattribute:: msal.Prompt.LOGIN
+
+PopAuthScheme
+-------------
+
+This is used as the `auth_scheme` parameter in many of the acquire token methods
+to support for Proof of Possession (PoP) tokens.
+
+New in MSAL Python 1.26
+
+.. autoclass:: msal.PopAuthScheme
+ :members:
+
+ .. autoattribute:: msal.PopAuthScheme.HTTP_GET
+ .. autoattribute:: msal.PopAuthScheme.HTTP_POST
+ .. autoattribute:: msal.PopAuthScheme.HTTP_PUT
+ .. autoattribute:: msal.PopAuthScheme.HTTP_DELETE
+ .. autoattribute:: msal.PopAuthScheme.HTTP_PATCH
+ .. automethod:: __init__
+
+
+Exceptions
+----------
+These are exceptions that MSAL Python may raise.
+You should not need to create them directly.
+You may want to catch them to provide a better error message to your end users.
+
+.. autoclass:: msal.IdTokenError
+
+
+Managed Identity
+================
+MSAL supports
+`Managed Identity `_.
+
+You can create one of these two kinds of managed identity configuration objects:
+
+.. autoclass:: msal.SystemAssignedManagedIdentity
+ :members:
+
+.. autoclass:: msal.UserAssignedManagedIdentity
+ :members:
+
+And then feed the configuration object into a :class:`ManagedIdentityClient` object.
+
+.. autoclass:: msal.ManagedIdentityClient
+ :members:
+
+ .. automethod:: __init__
diff --git a/docs/make.bat b/docs/make.bat
new file mode 100644
index 00000000..27f573b8
--- /dev/null
+++ b/docs/make.bat
@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+ set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+ echo.
+ echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+ echo.installed, then set the SPHINXBUILD environment variable to point
+ echo.to the full path of the 'sphinx-build' executable. Alternatively you
+ echo.may add the Sphinx directory to PATH.
+ echo.
+ echo.If you don't have Sphinx installed, grab it from
+ echo.http://sphinx-doc.org/
+ exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd
diff --git a/docs/requirements.txt b/docs/requirements.txt
new file mode 100644
index 00000000..0fd0c33a
--- /dev/null
+++ b/docs/requirements.txt
@@ -0,0 +1,3 @@
+furo
+sphinx-paramlinks
+-r ../requirements.txt
diff --git a/docs/scenarios-with-users.svg b/docs/scenarios-with-users.svg
new file mode 100644
index 00000000..fffdec47
--- /dev/null
+++ b/docs/scenarios-with-users.svg
@@ -0,0 +1,2789 @@
+
+
+
+
\ No newline at end of file
diff --git a/docs/thumbnail.png b/docs/thumbnail.png
new file mode 100644
index 00000000..e1606e91
Binary files /dev/null and b/docs/thumbnail.png differ
diff --git a/msal/__init__.py b/msal/__init__.py
new file mode 100644
index 00000000..bba53af7
--- /dev/null
+++ b/msal/__init__.py
@@ -0,0 +1,49 @@
+#------------------------------------------------------------------------------
+#
+# Copyright (c) Microsoft Corporation.
+# All rights reserved.
+#
+# This code is licensed under the MIT License.
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files(the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions :
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+#
+#------------------------------------------------------------------------------
+
+from .application import (
+ __version__,
+ ClientApplication,
+ ConfidentialClientApplication,
+ PublicClientApplication,
+ )
+from .oauth2cli.oidc import Prompt, IdTokenError
+from .token_cache import TokenCache, SerializableTokenCache
+from .auth_scheme import PopAuthScheme
+from .managed_identity import (
+ SystemAssignedManagedIdentity, UserAssignedManagedIdentity,
+ ManagedIdentityClient,
+ ManagedIdentityError,
+ ArcPlatformNotSupportedError,
+ )
+
+# Putting module-level exceptions into the package namespace, to make them
+# 1. officially part of the MSAL public API, and
+# 2. can still be caught by the user code even if we change the module structure.
+from .oauth2cli.oauth2 import BrowserInteractionTimeoutError
+from .oauth2cli.assertion import AutoRefresher
+
diff --git a/msal/__main__.py b/msal/__main__.py
new file mode 100644
index 00000000..0c6c59f7
--- /dev/null
+++ b/msal/__main__.py
@@ -0,0 +1,343 @@
+# It is currently shipped inside msal library.
+# Pros: It is always available wherever msal is installed.
+# Cons: Its 3rd-party dependencies (if any) may become msal's dependency.
+"""MSAL Python Tester
+
+Usage 1: Run it on the fly.
+ python -m msal
+ Note: We choose to not define a console script to avoid name conflict.
+
+Usage 2: Build an all-in-one executable file for bug bash.
+ shiv -e msal.__main__._main -o msaltest-on-os-name.pyz .
+"""
+import base64, getpass, json, logging, sys, os, atexit, msal
+
+_token_cache_filename = "msal_cache.bin"
+global_cache = msal.SerializableTokenCache()
+atexit.register(lambda:
+ open(_token_cache_filename, "w").write(global_cache.serialize())
+ # Hint: The following optional line persists only when state changed
+ if global_cache.has_state_changed else None
+ )
+
+_AZURE_CLI = "04b07795-8ddb-461a-bbee-02f9e1bf7b46"
+_VISUAL_STUDIO = "04f0c124-f2bc-4f59-8241-bf6df9866bbd"
+placeholder_auth_scheme = msal.PopAuthScheme(
+ http_method=msal.PopAuthScheme.HTTP_GET,
+ url="https://example.com/endpoint",
+ nonce="placeholder",
+ )
+
+def print_json(blob):
+ print(json.dumps(blob, indent=2, sort_keys=True))
+
+def _input_boolean(message):
+ return input(
+ "{} (N/n/F/f or empty means False, otherwise it is True): ".format(message)
+ ) not in ('N', 'n', 'F', 'f', '')
+
+def _input(message, default=None):
+ return input(message.format(default=default)).strip() or default
+
+def _select_options(
+ options, header="Your options:", footer=" Your choice? ", option_renderer=str,
+ accept_nonempty_string=False,
+ ):
+ assert options, "options must not be empty"
+ if header:
+ print(header)
+ for i, o in enumerate(options, start=1):
+ print(" {}: {}".format(i, option_renderer(o)))
+ if accept_nonempty_string:
+ print(" Or you can just type in your input.")
+ while True:
+ raw_data = input(footer)
+ try:
+ choice = int(raw_data)
+ if 1 <= choice <= len(options):
+ return options[choice - 1]
+ except ValueError:
+ if raw_data and accept_nonempty_string:
+ return raw_data
+
+enable_debug_log = _input_boolean("Enable MSAL Python's DEBUG log?")
+logging.basicConfig(level=logging.DEBUG if enable_debug_log else logging.INFO)
+try:
+ from dotenv import load_dotenv
+ load_dotenv()
+ logging.info("Loaded environment variables from .env file")
+except ImportError:
+ logging.warning(
+ "python-dotenv is not installed. "
+ "You may need to set environment variables manually.")
+
+def _input_scopes():
+ scopes = _select_options([
+ "https://graph.microsoft.com/.default",
+ "https://management.azure.com/.default",
+ "User.Read",
+ "User.ReadBasic.All",
+ ],
+ header="Select a scope (multiple scopes can only be input by manually typing them, delimited by space):",
+ accept_nonempty_string=True,
+ ).split() # It also converts the input string(s) into a list
+ if "https://pas.windows.net/CheckMyAccess/Linux/.default" in scopes:
+ raise ValueError("SSH Cert scope shall be tested by its dedicated functions")
+ return scopes
+
+def _select_account(app):
+ accounts = app.get_accounts()
+ if accounts:
+ return _select_options(
+ accounts,
+ option_renderer=lambda a: "{}, came from {}".format(a["username"], a["account_source"]),
+ header="Account(s) already signed in inside MSAL Python:",
+ )
+ else:
+ print("No account available inside MSAL Python. Use other methods to acquire token first.")
+
+def _acquire_token_silent(app):
+ """acquire_token_silent() - with an account already signed into MSAL Python."""
+ account = _select_account(app)
+ if account:
+ print_json(app.acquire_token_silent_with_error(
+ _input_scopes(),
+ account=account,
+ force_refresh=_input_boolean("Bypass MSAL Python's token cache?"),
+ auth_scheme=placeholder_auth_scheme
+ if app.is_pop_supported() and _input_boolean("Acquire AT POP via Broker?")
+ else None,
+ ))
+
+def _acquire_token_interactive(app, scopes=None, data=None):
+ """acquire_token_interactive() - User will be prompted if app opts to do select_account."""
+ assert isinstance(app, msal.PublicClientApplication)
+ scopes = scopes or _input_scopes() # Let user input scope param before less important prompt and login_hint
+ prompt = _select_options([
+ {"value": None, "description": "Unspecified. Proceed silently with a default account (if any), fallback to prompt."},
+ {"value": "none", "description": "none. Proceed silently with a default account (if any), or error out."},
+ {"value": "select_account", "description": "select_account. Prompt with an account picker."},
+ ],
+ option_renderer=lambda o: o["description"],
+ header="Prompt behavior?")["value"]
+ if prompt == "select_account":
+ login_hint = None # login_hint is unnecessary when prompt=select_account
+ else:
+ raw_login_hint = _select_options(
+ [None] + [a["username"] for a in app.get_accounts()],
+ header="login_hint? (If you have multiple signed-in sessions in browser/broker, and you specify a login_hint to match one of them, you will bypass the account picker.)",
+ accept_nonempty_string=True,
+ )
+ login_hint = raw_login_hint["username"] if isinstance(raw_login_hint, dict) else raw_login_hint
+ result = app.acquire_token_interactive(
+ scopes,
+ parent_window_handle=app.CONSOLE_WINDOW_HANDLE, # This test app is a console app
+ enable_msa_passthrough=app.client_id in [ # Apps are expected to set this right
+ _AZURE_CLI, _VISUAL_STUDIO,
+ ], # Here this test app mimics the setting for some known MSA-PT apps
+ port=1234, # Hard coded for testing. Real app typically uses default value.
+ prompt=prompt, login_hint=login_hint, data=data or {},
+ auth_scheme=placeholder_auth_scheme
+ if app.is_pop_supported() and _input_boolean("Acquire AT POP via Broker?")
+ else None,
+ )
+ if login_hint and "id_token_claims" in result:
+ signed_in_user = result.get("id_token_claims", {}).get("preferred_username")
+ if signed_in_user != login_hint:
+ logging.warning('Signed-in user "%s" does not match login_hint', signed_in_user)
+ print_json(result)
+ return result
+
+def _acquire_token_by_username_password(app):
+ """acquire_token_by_username_password() - See constraints here: https://docs.microsoft.com/en-us/azure/active-directory/develop/msal-authentication-flows#constraints-for-ropc"""
+ print_json(app.acquire_token_by_username_password(
+ _input("username: "), getpass.getpass("password: "), scopes=_input_scopes()))
+
+def _acquire_token_by_device_flow(app):
+ """acquire_token_by_device_flow() - Note that this one does not go through broker"""
+ assert isinstance(app, msal.PublicClientApplication)
+ flow = app.initiate_device_flow(scopes=_input_scopes())
+ print(flow["message"])
+ sys.stdout.flush() # Some terminal needs this to ensure the message is shown
+ input("After you completed the step above, press ENTER in this console to continue...")
+ result = app.acquire_token_by_device_flow(flow) # By default it will block
+ print_json(result)
+
+_JWK1 = """{"kty":"RSA", "n":"2tNr73xwcj6lH7bqRZrFzgSLj7OeLfbn8216uOMDHuaZ6TEUBDN8Uz0ve8jAlKsP9CQFCSVoSNovdE-fs7c15MxEGHjDcNKLWonznximj8pDGZQjVdfK-7mG6P6z-lgVcLuYu5JcWU_PeEqIKg5llOaz-qeQ4LEDS4T1D2qWRGpAra4rJX1-kmrWmX_XIamq30C9EIO0gGuT4rc2hJBWQ-4-FnE1NXmy125wfT3NdotAJGq5lMIfhjfglDbJCwhc8Oe17ORjO3FsB5CLuBRpYmP7Nzn66lRY3Fe11Xz8AEBl3anKFSJcTvlMnFtu3EpD-eiaHfTgRBU7CztGQqVbiQ", "e":"AQAB"}"""
+_SSH_CERT_DATA = {"token_type": "ssh-cert", "key_id": "key1", "req_cnf": _JWK1}
+_SSH_CERT_SCOPE = ["https://pas.windows.net/CheckMyAccess/Linux/.default"]
+
+def _acquire_ssh_cert_silently(app):
+ """Acquire an SSH Cert silently- This typically only works with Azure CLI"""
+ assert isinstance(app, msal.PublicClientApplication)
+ account = _select_account(app)
+ if account:
+ result = app.acquire_token_silent(
+ _SSH_CERT_SCOPE,
+ account,
+ data=_SSH_CERT_DATA,
+ force_refresh=_input_boolean("Bypass MSAL Python's token cache?"),
+ )
+ print_json(result)
+ if result and result.get("token_type") != "ssh-cert":
+ logging.error("Unable to acquire an ssh-cert.")
+
+def _acquire_ssh_cert_interactive(app):
+ """Acquire an SSH Cert interactively - This typically only works with Azure CLI"""
+ assert isinstance(app, msal.PublicClientApplication)
+ result = _acquire_token_interactive(app, scopes=_SSH_CERT_SCOPE, data=_SSH_CERT_DATA)
+ if result.get("token_type") != "ssh-cert":
+ logging.error("Unable to acquire an ssh-cert")
+
+_POP_KEY_ID = 'AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA-AAAAAAAA' # Fake key with a certain format and length
+_RAW_REQ_CNF = json.dumps({"kid": _POP_KEY_ID, "xms_ksl": "sw"})
+_POP_DATA = { # Sampled from Azure CLI's plugin connectedk8s
+ 'token_type': 'pop',
+ 'key_id': _POP_KEY_ID,
+ "req_cnf": base64.urlsafe_b64encode(_RAW_REQ_CNF.encode('utf-8')).decode('utf-8').rstrip('='),
+ # Note: Sending _RAW_REQ_CNF without base64 encoding would result in an http 500 error
+} # See also https://github.com/Azure/azure-cli-extensions/blob/main/src/connectedk8s/azext_connectedk8s/_clientproxyutils.py#L86-L92
+
+def _acquire_pop_token_interactive(app):
+ """Acquire a POP token interactively - This typically only works with Azure CLI"""
+ assert isinstance(app, msal.PublicClientApplication)
+ POP_SCOPE = ['6256c85f-0aad-4d50-b960-e6e9b21efe35/.default'] # KAP 1P Server App Scope, obtained from https://github.com/Azure/azure-cli-extensions/pull/4468/files#diff-a47efa3186c7eb4f1176e07d0b858ead0bf4a58bfd51e448ee3607a5b4ef47f6R116
+ result = _acquire_token_interactive(app, scopes=POP_SCOPE, data=_POP_DATA)
+ print_json(result)
+ if result.get("token_type") != "pop":
+ logging.error("Unable to acquire a pop token")
+
+def _remove_account(app):
+ """remove_account() - Invalidate account and/or token(s) from cache, so that acquire_token_silent() would be reset"""
+ account = _select_account(app)
+ if account:
+ app.remove_account(account)
+ print('Account "{}" and/or its token(s) are signed out from MSAL Python'.format(account["username"]))
+
+def _acquire_token_for_client(app):
+ """CCA.acquire_token_for_client() - Rerun this will get same token from cache."""
+ assert isinstance(app, msal.ConfidentialClientApplication)
+ print_json(app.acquire_token_for_client(scopes=_input_scopes()))
+
+def _remove_tokens_for_client(app):
+ """CCA.remove_tokens_for_client() - Run this to evict tokens from cache."""
+ assert isinstance(app, msal.ConfidentialClientApplication)
+ app.remove_tokens_for_client()
+
+def _exit(app):
+ """Exit"""
+ bug_link = (
+ "https://identitydivision.visualstudio.com/Engineering/_queries/query/79b3a352-a775-406f-87cd-a487c382a8ed/"
+ if app._enable_broker else
+ "https://github.com/AzureAD/microsoft-authentication-library-for-python/issues/new/choose"
+ )
+ print("Bye. If you found a bug, please report it here: {}".format(bug_link))
+ sys.exit()
+
+def _main():
+ print("Welcome to the Msal Python {} Tester (Experimental)\n".format(msal.__version__))
+ cache_choice = _select_options([
+ {
+ "choice": "empty",
+ "desc": "Start with an empty token cache. Suitable for one-off tests.",
+ },
+ {
+ "choice": "reuse",
+ "desc": "Reuse the previous token cache {} (if any) "
+ "which was created during last test app exit. "
+ "Useful for testing acquire_token_silent() repeatedly".format(
+ _token_cache_filename),
+ },
+ ],
+ option_renderer=lambda o: o["desc"],
+ header="What token cache state do you want to begin with?",
+ accept_nonempty_string=False)
+ if cache_choice["choice"] == "reuse" and os.path.exists(_token_cache_filename):
+ try:
+ global_cache.deserialize(open(_token_cache_filename, "r").read())
+ except IOError:
+ pass # Use empty token cache
+ chosen_app = _select_options([
+ {"client_id": _AZURE_CLI, "name": "Azure CLI (Correctly configured for MSA-PT)"},
+ {"client_id": _VISUAL_STUDIO, "name": "Visual Studio (Correctly configured for MSA-PT)"},
+ {"client_id": "95de633a-083e-42f5-b444-a4295d8e9314", "name": "Whiteboard Services (Non MSA-PT app. Accepts AAD & MSA accounts.)"},
+ {
+ "client_id": os.getenv("CLIENT_ID"),
+ "client_secret": os.getenv("CLIENT_SECRET"),
+ "name": "A confidential client app (CCA) whose settings are defined "
+ "in environment variables CLIENT_ID and CLIENT_SECRET",
+ },
+ ],
+ option_renderer=lambda a: a["name"],
+ header="Impersonate this app "
+ "(or you can type in the client_id of your own public client app)",
+ accept_nonempty_string=True)
+ is_cca = isinstance(chosen_app, dict) and "client_secret" in chosen_app
+ if is_cca and not (chosen_app["client_id"] and chosen_app["client_secret"]):
+ raise ValueError("You need to set environment variables CLIENT_ID and CLIENT_SECRET")
+ enable_broker = (not is_cca) and _input_boolean("Enable broker? "
+ "(It will error out later if your app has not registered some redirect URI)"
+ )
+ enable_pii_log = _input_boolean("Enable PII in broker's log?") if enable_broker and enable_debug_log else False
+ authority = _select_options([
+ "https://login.microsoftonline.com/common",
+ "https://login.microsoftonline.com/organizations",
+ "https://login.microsoftonline.com/microsoft.onmicrosoft.com",
+ "https://login.microsoftonline.com/msidlab4.onmicrosoft.com",
+ "https://login.microsoftonline.com/consumers",
+ ],
+ header="Input authority (Note that MSA-PT apps would NOT use the /common authority)",
+ accept_nonempty_string=True,
+ )
+ instance_discovery = _input_boolean(
+ "You input an unusual authority which might fail the Instance Discovery. "
+ "Now, do you want to perform Instance Discovery on your input authority?"
+ ) if authority and not authority.startswith(
+ "https://login.microsoftonline.com") else None
+ app = msal.PublicClientApplication(
+ chosen_app["client_id"] if isinstance(chosen_app, dict) else chosen_app,
+ authority=authority,
+ instance_discovery=instance_discovery,
+ enable_broker_on_windows=enable_broker,
+ enable_broker_on_mac=enable_broker,
+ enable_pii_log=enable_pii_log,
+ token_cache=global_cache,
+ ) if not is_cca else msal.ConfidentialClientApplication(
+ chosen_app["client_id"],
+ client_credential=chosen_app["client_secret"],
+ authority=authority,
+ instance_discovery=instance_discovery,
+ enable_pii_log=enable_pii_log,
+ token_cache=global_cache,
+ )
+ methods_to_be_tested = [
+ _acquire_token_silent,
+ ] + ([
+ _acquire_token_interactive,
+ _acquire_token_by_device_flow,
+ _acquire_ssh_cert_silently,
+ _acquire_ssh_cert_interactive,
+ _acquire_pop_token_interactive,
+ ] if isinstance(app, msal.PublicClientApplication) else []
+ ) + [
+ _acquire_token_by_username_password,
+ _remove_account,
+ ] + ([
+ _acquire_token_for_client,
+ _remove_tokens_for_client,
+ ] if isinstance(app, msal.ConfidentialClientApplication) else []
+ )
+ while True:
+ func = _select_options(
+ methods_to_be_tested + [_exit],
+ option_renderer=lambda f: f.__doc__, header="MSAL Python APIs:")
+ try:
+ func(app)
+ except ValueError as e:
+ logging.error("Invalid input: %s", e)
+ except KeyboardInterrupt: # Useful for bailing out a stuck interactive flow
+ print("Aborted")
+
+if __name__ == "__main__":
+ _main()
+
diff --git a/msal/application.py b/msal/application.py
new file mode 100644
index 00000000..7dd9e749
--- /dev/null
+++ b/msal/application.py
@@ -0,0 +1,2460 @@
+import functools
+import json
+import time
+import logging
+import sys
+import warnings
+from threading import Lock
+import os
+
+from .oauth2cli import Client, JwtAssertionCreator
+from .oauth2cli.oidc import decode_part
+from .authority import Authority, WORLD_WIDE
+from .mex import send_request as mex_send_request
+from .wstrust_request import send_request as wst_send_request
+from .wstrust_response import *
+from .token_cache import TokenCache, _get_username, _GRANT_TYPE_BROKER
+import msal.telemetry
+from .region import _detect_region
+from .throttled_http_client import ThrottledHttpClient
+from .cloudshell import _is_running_in_cloud_shell
+
+
+# The __init__.py will import this. Not the other way around.
+__version__ = "1.31.0" # When releasing, also check and bump our dependencies's versions if needed
+
+logger = logging.getLogger(__name__)
+_AUTHORITY_TYPE_CLOUDSHELL = "CLOUDSHELL"
+
+def _init_broker(enable_pii_log): # Make it a function to allow mocking
+ from . import broker # Trigger Broker's initialization, lazily
+ if enable_pii_log:
+ broker._enable_pii_log()
+
+def extract_certs(public_cert_content):
+ # Parses raw public certificate file contents and returns a list of strings
+ # Usage: headers = {"x5c": extract_certs(open("my_cert.pem").read())}
+ public_certificates = re.findall(
+ r'-----BEGIN CERTIFICATE-----(?P[^-]+)-----END CERTIFICATE-----',
+ public_cert_content, re.I)
+ if public_certificates:
+ return [cert.strip() for cert in public_certificates]
+ # The public cert tags are not found in the input,
+ # let's make best effort to exclude a private key pem file.
+ if "PRIVATE KEY" in public_cert_content:
+ raise ValueError(
+ "We expect your public key but detect a private key instead")
+ return [public_cert_content.strip()]
+
+
+def _merge_claims_challenge_and_capabilities(capabilities, claims_challenge):
+ # Represent capabilities as {"access_token": {"xms_cc": {"values": capabilities}}}
+ # and then merge/add it into incoming claims
+ if not capabilities:
+ return claims_challenge
+ claims_dict = json.loads(claims_challenge) if claims_challenge else {}
+ for key in ["access_token"]: # We could add "id_token" if we'd decide to
+ claims_dict.setdefault(key, {}).update(xms_cc={"values": capabilities})
+ return json.dumps(claims_dict)
+
+
+def _str2bytes(raw):
+ # A conversion based on duck-typing rather than six.text_type
+ try:
+ return raw.encode(encoding="utf-8")
+ except:
+ return raw
+
+
+def _parse_pfx(pfx_path, passphrase_bytes):
+ # Cert concepts https://security.stackexchange.com/a/226758/125264
+ from cryptography.hazmat.primitives import hashes, serialization
+ from cryptography.hazmat.primitives.serialization import pkcs12
+ with open(pfx_path, 'rb') as f:
+ private_key, cert, _ = pkcs12.load_key_and_certificates( # cryptography 2.5+
+ # https://cryptography.io/en/latest/hazmat/primitives/asymmetric/serialization/#cryptography.hazmat.primitives.serialization.pkcs12.load_key_and_certificates
+ f.read(), passphrase_bytes)
+ if not (private_key and cert):
+ raise ValueError("Your PFX file shall contain both private key and cert")
+ cert_pem = cert.public_bytes(encoding=serialization.Encoding.PEM).decode() # cryptography 1.0+
+ x5c = [
+ '\n'.join(cert_pem.splitlines()[1:-1]) # Strip the "--- header ---" and "--- footer ---"
+ ]
+ sha256_thumbprint = cert.fingerprint(hashes.SHA256()).hex() # cryptography 0.7+
+ sha1_thumbprint = cert.fingerprint(hashes.SHA1()).hex() # cryptography 0.7+
+ # https://cryptography.io/en/latest/x509/reference/#x-509-certificate-object
+ return private_key, sha256_thumbprint, sha1_thumbprint, x5c
+
+
+def _load_private_key_from_pem_str(private_key_pem_str, passphrase_bytes):
+ from cryptography.hazmat.primitives import serialization
+ from cryptography.hazmat.backends import default_backend
+ return serialization.load_pem_private_key( # cryptography 0.6+
+ _str2bytes(private_key_pem_str),
+ passphrase_bytes,
+ backend=default_backend(), # It was a required param until 2020
+ )
+
+
+def _pii_less_home_account_id(home_account_id):
+ parts = home_account_id.split(".") # It could contain one or two parts
+ parts[0] = "********"
+ return ".".join(parts)
+
+
+def _clean_up(result):
+ if isinstance(result, dict):
+ if "_msalruntime_telemetry" in result or "_msal_python_telemetry" in result:
+ result["msal_telemetry"] = json.dumps({ # Telemetry as an opaque string
+ "msalruntime_telemetry": result.get("_msalruntime_telemetry"),
+ "msal_python_telemetry": result.get("_msal_python_telemetry"),
+ }, separators=(",", ":"))
+ return_value = {
+ k: result[k] for k in result
+ if k != "refresh_in" # MSAL handled refresh_in, customers need not
+ and not k.startswith('_') # Skim internal properties
+ }
+ if "refresh_in" in result: # To encourage proactive refresh
+ return_value["refresh_on"] = int(time.time() + result["refresh_in"])
+ return return_value
+ return result # It could be None
+
+
+def _preferred_browser():
+ """Register Edge and return a name suitable for subsequent webbrowser.get(...)
+ when appropriate. Otherwise return None.
+ """
+ # On Linux, only Edge will provide device-based Conditional Access support
+ if sys.platform != "linux": # On other platforms, we have no browser preference
+ return None
+ browser_path = "/usr/bin/microsoft-edge" # Use a full path owned by sys admin
+ # Note: /usr/bin/microsoft-edge, /usr/bin/microsoft-edge-stable, etc.
+ # are symlinks that point to the actual binaries which are found under
+ # /opt/microsoft/msedge/msedge or /opt/microsoft/msedge-beta/msedge.
+ # Either method can be used to detect an Edge installation.
+ user_has_no_preference = "BROWSER" not in os.environ
+ user_wont_mind_edge = "microsoft-edge" in os.environ.get("BROWSER", "") # Note:
+ # BROWSER could contain "microsoft-edge" or "/path/to/microsoft-edge".
+ # Python documentation (https://docs.python.org/3/library/webbrowser.html)
+ # does not document the name being implicitly register,
+ # so there is no public API to know whether the ENV VAR browser would work.
+ # Therefore, we would not bother examine the env var browser's type.
+ # We would just register our own Edge instance.
+ if (user_has_no_preference or user_wont_mind_edge) and os.path.exists(browser_path):
+ try:
+ import webbrowser # Lazy import. Some distro may not have this.
+ browser_name = "msal-edge" # Avoid popular name "microsoft-edge"
+ # otherwise `BROWSER="microsoft-edge"; webbrowser.get("microsoft-edge")`
+ # would return a GenericBrowser instance which won't work.
+ try:
+ registration_available = isinstance(
+ webbrowser.get(browser_name), webbrowser.BackgroundBrowser)
+ except webbrowser.Error:
+ registration_available = False
+ if not registration_available:
+ logger.debug("Register %s with %s", browser_name, browser_path)
+ # By registering our own browser instance with our own name,
+ # rather than populating a process-wide BROWSER enn var,
+ # this approach does not have side effect on non-MSAL code path.
+ webbrowser.register( # Even double-register happens to work fine
+ browser_name, None, webbrowser.BackgroundBrowser(browser_path))
+ return browser_name
+ except ImportError:
+ pass # We may still proceed
+ return None
+
+
+class _ClientWithCcsRoutingInfo(Client):
+
+ def initiate_auth_code_flow(self, **kwargs):
+ if kwargs.get("login_hint"): # eSTS could have utilized this as-is, but nope
+ kwargs["X-AnchorMailbox"] = "UPN:%s" % kwargs["login_hint"]
+ return super(_ClientWithCcsRoutingInfo, self).initiate_auth_code_flow(
+ client_info=1, # To be used as CSS Routing info
+ **kwargs)
+
+ def obtain_token_by_auth_code_flow(
+ self, auth_code_flow, auth_response, **kwargs):
+ # Note: the obtain_token_by_browser() is also covered by this
+ assert isinstance(auth_code_flow, dict) and isinstance(auth_response, dict)
+ headers = kwargs.pop("headers", {})
+ client_info = json.loads(
+ decode_part(auth_response["client_info"])
+ ) if auth_response.get("client_info") else {}
+ if "uid" in client_info and "utid" in client_info:
+ # Note: The value of X-AnchorMailbox is also case-insensitive
+ headers["X-AnchorMailbox"] = "Oid:{uid}@{utid}".format(**client_info)
+ return super(_ClientWithCcsRoutingInfo, self).obtain_token_by_auth_code_flow(
+ auth_code_flow, auth_response, headers=headers, **kwargs)
+
+ def obtain_token_by_username_password(self, username, password, **kwargs):
+ headers = kwargs.pop("headers", {})
+ headers["X-AnchorMailbox"] = "upn:{}".format(username)
+ return super(_ClientWithCcsRoutingInfo, self).obtain_token_by_username_password(
+ username, password, headers=headers, **kwargs)
+
+
+class ClientApplication(object):
+ """You do not usually directly use this class. Use its subclasses instead:
+ :class:`PublicClientApplication` and :class:`ConfidentialClientApplication`.
+ """
+ ACQUIRE_TOKEN_SILENT_ID = "84"
+ ACQUIRE_TOKEN_BY_REFRESH_TOKEN = "85"
+ ACQUIRE_TOKEN_BY_USERNAME_PASSWORD_ID = "301"
+ ACQUIRE_TOKEN_ON_BEHALF_OF_ID = "523"
+ ACQUIRE_TOKEN_BY_DEVICE_FLOW_ID = "622"
+ ACQUIRE_TOKEN_FOR_CLIENT_ID = "730"
+ ACQUIRE_TOKEN_BY_AUTHORIZATION_CODE_ID = "832"
+ ACQUIRE_TOKEN_INTERACTIVE = "169"
+ GET_ACCOUNTS_ID = "902"
+ REMOVE_ACCOUNT_ID = "903"
+
+ ATTEMPT_REGION_DISCOVERY = True # "TryAutoDetect"
+ _TOKEN_SOURCE = "token_source"
+ _TOKEN_SOURCE_IDP = "identity_provider"
+ _TOKEN_SOURCE_CACHE = "cache"
+ _TOKEN_SOURCE_BROKER = "broker"
+
+ _enable_broker = False
+ _AUTH_SCHEME_UNSUPPORTED = (
+ "auth_scheme is currently only available from broker. "
+ "You can enable broker by following these instructions. "
+ "https://msal-python.readthedocs.io/en/latest/#publicclientapplication")
+
+ def __init__(
+ self, client_id,
+ client_credential=None, authority=None, validate_authority=True,
+ token_cache=None,
+ http_client=None,
+ verify=True, proxies=None, timeout=None,
+ client_claims=None, app_name=None, app_version=None,
+ client_capabilities=None,
+ azure_region=None, # Note: We choose to add this param in this base class,
+ # despite it is currently only needed by ConfidentialClientApplication.
+ # This way, it holds the same positional param place for PCA,
+ # when we would eventually want to add this feature to PCA in future.
+ exclude_scopes=None,
+ http_cache=None,
+ instance_discovery=None,
+ allow_broker=None,
+ enable_pii_log=None,
+ oidc_authority=None,
+ ):
+ """Create an instance of application.
+
+ :param str client_id: Your app has a client_id after you register it on Microsoft Entra admin center.
+
+ :param client_credential:
+ For :class:`PublicClientApplication`, you use `None` here.
+
+ For :class:`ConfidentialClientApplication`,
+ it supports many different input formats for different scenarios.
+
+ .. admonition:: Support using a client secret.
+
+ Just feed in a string, such as ``"your client secret"``.
+
+ .. admonition:: Support using a certificate in X.509 (.pem) format
+
+ Feed in a dict in this form::
+
+ {
+ "private_key": "...-----BEGIN PRIVATE KEY-----... in PEM format",
+ "thumbprint": "A1B2C3D4E5F6...",
+ "passphrase": "Passphrase if the private_key is encrypted (Optional. Added in version 1.6.0)",
+ }
+
+ MSAL Python requires a "private_key" in PEM format.
+ If your cert is in PKCS12 (.pfx) format,
+ you can convert it to X.509 (.pem) format,
+ by ``openssl pkcs12 -in file.pfx -out file.pem -nodes``.
+
+ The thumbprint is available in your app's registration in Azure Portal.
+ Alternatively, you can `calculate the thumbprint `_.
+
+ .. admonition:: Support Subject Name/Issuer Auth with a cert in .pem
+
+ `Subject Name/Issuer Auth
+ `_
+ is an approach to allow easier certificate rotation.
+
+ *Added in version 0.5.0*::
+
+ {
+ "private_key": "...-----BEGIN PRIVATE KEY-----... in PEM format",
+ "thumbprint": "A1B2C3D4E5F6...",
+ "public_certificate": "...-----BEGIN CERTIFICATE-----...",
+ "passphrase": "Passphrase if the private_key is encrypted (Optional. Added in version 1.6.0)",
+ }
+
+ ``public_certificate`` (optional) is public key certificate
+ which will be sent through 'x5c' JWT header only for
+ subject name and issuer authentication to support cert auto rolls.
+
+ Per `specs `_,
+ "the certificate containing
+ the public key corresponding to the key used to digitally sign the
+ JWS MUST be the first certificate. This MAY be followed by
+ additional certificates, with each subsequent certificate being the
+ one used to certify the previous one."
+ However, your certificate's issuer may use a different order.
+ So, if your attempt ends up with an error AADSTS700027 -
+ "The provided signature value did not match the expected signature value",
+ you may try use only the leaf cert (in PEM/str format) instead.
+
+ .. admonition:: Supporting raw assertion obtained from elsewhere
+
+ *Added in version 1.32.0*:
+
+ MSAL Python accepts a callback which shall obtain an assertion::
+
+ import msal
+
+ def assertion_callback():
+ return '''A fresh JWT with claims:
+ aud, exp, iss, jti, nbf, and sub'''
+
+ smart_callback = msal.AutoRefresher(
+ assertion_callback,
+ expires_in=3600, # Whatever value that you see fit
+ ) # This ensures the original callback will be cached
+
+ app = msal.ConfidentialClientApplication(
+ ...,
+ client_credential={"client_assertion": smart_callback},
+ )
+
+ *Added in version 1.13.0*:
+
+ Deprecated.
+
+ It can also be a completely pre-signed assertion that you've assembled yourself.
+ Simply pass a container containing only the key "client_assertion", like this::
+
+ {
+ "client_assertion": "...a JWT with claims aud, exp, iss, jti, nbf, and sub..."
+ }
+
+ .. admonition:: Supporting reading client cerficates from PFX files
+
+ *Added in version 1.29.0*:
+ Feed in a dictionary containing the path to a PFX file::
+
+ {
+ "private_key_pfx_path": "/path/to/your.pfx",
+ "passphrase": "Passphrase if the private_key is encrypted (Optional)",
+ }
+
+ The following command will generate a .pfx file from your .key and .pem file::
+
+ openssl pkcs12 -export -out certificate.pfx -inkey privateKey.key -in certificate.pem
+
+ .. admonition:: Support Subject Name/Issuer Auth with a cert in .pfx
+
+ *Added in version 1.30.0*:
+ If your .pfx file contains both the private key and public cert,
+ you can opt in for Subject Name/Issuer Auth like this::
+
+ {
+ "private_key_pfx_path": "/path/to/your.pfx",
+ "public_certificate": True,
+ "passphrase": "Passphrase if the private_key is encrypted (Optional)",
+ }
+
+ :type client_credential: Union[dict, str, None]
+
+ :param dict client_claims:
+ *Added in version 0.5.0*:
+ It is a dictionary of extra claims that would be signed by
+ by this :class:`ConfidentialClientApplication` 's private key.
+ For example, you can use {"client_ip": "x.x.x.x"}.
+ You may also override any of the following default claims::
+
+ {
+ "aud": the_token_endpoint,
+ "iss": self.client_id,
+ "sub": same_as_issuer,
+ "exp": now + 10_min,
+ "iat": now,
+ "jti": a_random_uuid
+ }
+
+ :param str authority:
+ A URL that identifies a token authority. It should be of the format
+ ``https://login.microsoftonline.com/your_tenant``
+ By default, we will use ``https://login.microsoftonline.com/common``
+
+ *Changed in version 1.17*: you can also use predefined constant
+ and a builder like this::
+
+ from msal.authority import (
+ AuthorityBuilder,
+ AZURE_US_GOVERNMENT, AZURE_CHINA, AZURE_PUBLIC)
+ my_authority = AuthorityBuilder(AZURE_PUBLIC, "contoso.onmicrosoft.com")
+ # Now you get an equivalent of
+ # "https://login.microsoftonline.com/contoso.onmicrosoft.com"
+
+ # You can feed such an authority to msal's ClientApplication
+ from msal import PublicClientApplication
+ app = PublicClientApplication("my_client_id", authority=my_authority, ...)
+
+ :param bool validate_authority: (optional) Turns authority validation
+ on or off. This parameter default to true.
+ :param TokenCache token_cache:
+ Sets the token cache used by this ClientApplication instance.
+ By default, an in-memory cache will be created and used.
+ :param http_client: (optional)
+ Your implementation of abstract class HttpClient
+ Defaults to a requests session instance.
+ Since MSAL 1.11.0, the default session would be configured
+ to attempt one retry on connection error.
+ If you are providing your own http_client,
+ it will be your http_client's duty to decide whether to perform retry.
+
+ :param verify: (optional)
+ It will be passed to the
+ `verify parameter in the underlying requests library
+ `_
+ This does not apply if you have chosen to pass your own Http client
+ :param proxies: (optional)
+ It will be passed to the
+ `proxies parameter in the underlying requests library
+ `_
+ This does not apply if you have chosen to pass your own Http client
+ :param timeout: (optional)
+ It will be passed to the
+ `timeout parameter in the underlying requests library
+ `_
+ This does not apply if you have chosen to pass your own Http client
+ :param app_name: (optional)
+ You can provide your application name for Microsoft telemetry purposes.
+ Default value is None, means it will not be passed to Microsoft.
+ :param app_version: (optional)
+ You can provide your application version for Microsoft telemetry purposes.
+ Default value is None, means it will not be passed to Microsoft.
+ :param list[str] client_capabilities: (optional)
+ Allows configuration of one or more client capabilities, e.g. ["CP1"].
+
+ Client capability is meant to inform the Microsoft identity platform
+ (STS) what this client is capable for,
+ so STS can decide to turn on certain features.
+ For example, if client is capable to handle *claims challenge*,
+ STS may issue
+ `Continuous Access Evaluation (CAE) `_
+ access tokens to resources,
+ knowing that when the resource emits a *claims challenge*
+ the client will be able to handle those challenges.
+
+ Implementation details:
+ Client capability is implemented using "claims" parameter on the wire,
+ for now.
+ MSAL will combine them into
+ `claims parameter `_
+ which you will later provide via one of the acquire-token request.
+
+ :param str azure_region: (optional)
+ Instructs MSAL to use the Entra regional token service. This legacy feature is only available to
+ first-party applications. Only ``acquire_token_for_client()`` is supported.
+
+ Supports 3 values:
+
+ ``azure_region=None`` - meaning no region is used. This is the default value.
+ ``azure_region="some_region"`` - meaning the specified region is used.
+ ``azure_region=True`` - meaning MSAL will try to auto-detect the region. This is not recommended.
+
+ .. note::
+ Region auto-discovery has been tested on VMs and on Azure Functions. It is unreliable.
+ Applications using this option should configure a short timeout.
+
+ For more details and for the values of the region string
+ see https://learn.microsoft.com/entra/msal/dotnet/resources/region-discovery-troubleshooting
+
+ New in version 1.12.0.
+
+ :param list[str] exclude_scopes: (optional)
+ Historically MSAL hardcodes `offline_access` scope,
+ which would allow your app to have prolonged access to user's data.
+ If that is unnecessary or undesirable for your app,
+ now you can use this parameter to supply an exclusion list of scopes,
+ such as ``exclude_scopes = ["offline_access"]``.
+
+ :param dict http_cache:
+ MSAL has long been caching tokens in the ``token_cache``.
+ Recently, MSAL also introduced a concept of ``http_cache``,
+ by automatically caching some finite amount of non-token http responses,
+ so that *long-lived*
+ ``PublicClientApplication`` and ``ConfidentialClientApplication``
+ would be more performant and responsive in some situations.
+
+ This ``http_cache`` parameter accepts any dict-like object.
+ If not provided, MSAL will use an in-memory dict.
+
+ If your app is a command-line app (CLI),
+ you would want to persist your http_cache across different CLI runs.
+ The following recipe shows a way to do so::
+
+ # Just add the following lines at the beginning of your CLI script
+ import sys, atexit, pickle
+ http_cache_filename = sys.argv[0] + ".http_cache"
+ try:
+ with open(http_cache_filename, "rb") as f:
+ persisted_http_cache = pickle.load(f) # Take a snapshot
+ except (
+ FileNotFoundError, # Or IOError in Python 2
+ pickle.UnpicklingError, # A corrupted http cache file
+ ):
+ persisted_http_cache = {} # Recover by starting afresh
+ atexit.register(lambda: pickle.dump(
+ # When exit, flush it back to the file.
+ # It may occasionally overwrite another process's concurrent write,
+ # but that is fine. Subsequent runs will reach eventual consistency.
+ persisted_http_cache, open(http_cache_file, "wb")))
+
+ # And then you can implement your app as you normally would
+ app = msal.PublicClientApplication(
+ "your_client_id",
+ ...,
+ http_cache=persisted_http_cache, # Utilize persisted_http_cache
+ ...,
+ #token_cache=..., # You may combine the old token_cache trick
+ # Please refer to token_cache recipe at
+ # https://msal-python.readthedocs.io/en/latest/#msal.SerializableTokenCache
+ )
+ app.acquire_token_interactive(["your", "scope"], ...)
+
+ Content inside ``http_cache`` are cheap to obtain.
+ There is no need to share them among different apps.
+
+ Content inside ``http_cache`` will contain no tokens nor
+ Personally Identifiable Information (PII). Encryption is unnecessary.
+
+ New in version 1.16.0.
+
+ :param boolean instance_discovery:
+ Historically, MSAL would connect to a central endpoint located at
+ ``https://login.microsoftonline.com`` to acquire some metadata,
+ especially when using an unfamiliar authority.
+ This behavior is known as Instance Discovery.
+
+ This parameter defaults to None, which enables the Instance Discovery.
+
+ If you know some authorities which you allow MSAL to operate with as-is,
+ without involving any Instance Discovery, the recommended pattern is::
+
+ known_authorities = frozenset([ # Treat your known authorities as const
+ "https://contoso.com/adfs", "https://login.azs/foo"])
+ ...
+ authority = "https://contoso.com/adfs" # Assuming your app will use this
+ app1 = PublicClientApplication(
+ "client_id",
+ authority=authority,
+ # Conditionally disable Instance Discovery for known authorities
+ instance_discovery=authority not in known_authorities,
+ )
+
+ If you do not know some authorities beforehand,
+ yet still want MSAL to accept any authority that you will provide,
+ you can use a ``False`` to unconditionally disable Instance Discovery.
+
+ New in version 1.19.0.
+
+ :param boolean allow_broker:
+ Deprecated. Please use ``enable_broker_on_windows`` instead.
+
+ :param boolean enable_pii_log:
+ When enabled, logs may include PII (Personal Identifiable Information).
+ This can be useful in troubleshooting broker behaviors.
+ The default behavior is False.
+
+ New in version 1.24.0.
+
+ :param str oidc_authority:
+ *Added in version 1.28.0*:
+ It is a URL that identifies an OpenID Connect (OIDC) authority of
+ the format ``https://contoso.com/tenant``.
+ MSAL will append ".well-known/openid-configuration" to the authority
+ and retrieve the OIDC metadata from there, to figure out the endpoints.
+
+ Note: Broker will NOT be used for OIDC authority.
+ """
+ self.client_id = client_id
+ self.client_credential = client_credential
+ self.client_claims = client_claims
+ self._client_capabilities = client_capabilities
+ self._instance_discovery = instance_discovery
+
+ if exclude_scopes and not isinstance(exclude_scopes, list):
+ raise ValueError(
+ "Invalid exclude_scopes={}. It need to be a list of strings.".format(
+ repr(exclude_scopes)))
+ self._exclude_scopes = frozenset(exclude_scopes or [])
+ if "openid" in self._exclude_scopes:
+ raise ValueError(
+ 'Invalid exclude_scopes={}. You can not opt out "openid" scope'.format(
+ repr(exclude_scopes)))
+
+ if http_client:
+ self.http_client = http_client
+ else:
+ import requests # Lazy load
+
+ self.http_client = requests.Session()
+ self.http_client.verify = verify
+ self.http_client.proxies = proxies
+ # Requests, does not support session - wide timeout
+ # But you can patch that (https://github.com/psf/requests/issues/3341):
+ self.http_client.request = functools.partial(
+ self.http_client.request, timeout=timeout)
+
+ # Enable a minimal retry. Better than nothing.
+ # https://github.com/psf/requests/blob/v2.25.1/requests/adapters.py#L94-L108
+ a = requests.adapters.HTTPAdapter(max_retries=1)
+ self.http_client.mount("http://", a)
+ self.http_client.mount("https://", a)
+ self.http_client = ThrottledHttpClient(
+ self.http_client,
+ http_cache=http_cache,
+ default_throttle_time=60
+ # The default value 60 was recommended mainly for PCA at the end of
+ # https://identitydivision.visualstudio.com/devex/_git/AuthLibrariesApiReview?version=GBdev&path=%2FService%20protection%2FIntial%20set%20of%20protection%20measures.md&_a=preview
+ if isinstance(self, PublicClientApplication) else 5,
+ )
+
+ self.app_name = app_name
+ self.app_version = app_version
+
+ # Here the self.authority will not be the same type as authority in input
+ if oidc_authority and authority:
+ raise ValueError("You can not provide both authority and oidc_authority")
+ try:
+ authority_to_use = authority or "https://{}/common/".format(WORLD_WIDE)
+ self.authority = Authority(
+ authority_to_use,
+ self.http_client,
+ validate_authority=validate_authority,
+ instance_discovery=self._instance_discovery,
+ oidc_authority_url=oidc_authority,
+ )
+ except ValueError: # Those are explicit authority validation errors
+ raise
+ except Exception: # The rest are typically connection errors
+ if validate_authority and azure_region and not oidc_authority:
+ # Since caller opts in to use region, here we tolerate connection
+ # errors happened during authority validation at non-region endpoint
+ self.authority = Authority(
+ authority_to_use,
+ self.http_client,
+ instance_discovery=False,
+ )
+ else:
+ raise
+
+ self._decide_broker(allow_broker, enable_pii_log)
+ self.token_cache = token_cache or TokenCache()
+ self._region_configured = azure_region
+ self._region_detected = None
+ self.client, self._regional_client = self._build_client(
+ client_credential, self.authority)
+ self.authority_groups = None
+ self._telemetry_buffer = {}
+ self._telemetry_lock = Lock()
+
+ def _decide_broker(self, allow_broker, enable_pii_log):
+ is_confidential_app = self.client_credential or isinstance(
+ self, ConfidentialClientApplication)
+ if is_confidential_app and allow_broker:
+ raise ValueError("allow_broker=True is only supported in PublicClientApplication")
+ # Historically, we chose to support ClientApplication("client_id", allow_broker=True)
+ if allow_broker:
+ warnings.warn(
+ "allow_broker is deprecated. "
+ "Please use PublicClientApplication(..., "
+ "enable_broker_on_windows=True, "
+ "enable_broker_on_mac=...)",
+ DeprecationWarning)
+ opted_in_for_broker = (
+ self._enable_broker # True means Opted-in from PCA
+ or (
+ # When we started the broker project on Windows platform,
+ # the allow_broker was meant to be cross-platform. Now we realize
+ # that other platforms have different redirect_uri requirements,
+ # so the old allow_broker is deprecated and will only for Windows.
+ allow_broker and sys.platform == "win32")
+ )
+ self._enable_broker = ( # This same variable will also store the state
+ opted_in_for_broker
+ and not is_confidential_app
+ and not self.authority.is_adfs
+ and not self.authority._is_b2c
+ )
+ if self._enable_broker:
+ try:
+ _init_broker(enable_pii_log)
+ except RuntimeError:
+ self._enable_broker = False
+ logger.exception(
+ "Broker is unavailable on this platform. "
+ "We will fallback to non-broker.")
+ logger.debug("Broker enabled? %s", self._enable_broker)
+
+ def is_pop_supported(self):
+ """Returns True if this client supports Proof-of-Possession Access Token."""
+ return self._enable_broker
+
+ def _decorate_scope(
+ self, scopes,
+ reserved_scope=frozenset(['openid', 'profile', 'offline_access'])):
+ if not isinstance(scopes, (list, set, tuple)):
+ raise ValueError("The input scopes should be a list, tuple, or set")
+ scope_set = set(scopes) # Input scopes is typically a list. Copy it to a set.
+ if scope_set & reserved_scope:
+ # These scopes are reserved for the API to provide good experience.
+ # We could make the developer pass these and then if they do they will
+ # come back asking why they don't see refresh token or user information.
+ raise ValueError(
+ """You cannot use any scope value that is reserved.
+Your input: {}
+The reserved list: {}""".format(list(scope_set), list(reserved_scope)))
+ raise ValueError(
+ "You cannot use any scope value that is in this reserved list: {}".format(
+ list(reserved_scope)))
+
+ # client_id can also be used as a scope in B2C
+ decorated = scope_set | reserved_scope
+ decorated -= self._exclude_scopes
+ return list(decorated)
+
+ def _build_telemetry_context(
+ self, api_id, correlation_id=None, refresh_reason=None):
+ return msal.telemetry._TelemetryContext(
+ self._telemetry_buffer, self._telemetry_lock, api_id,
+ correlation_id=correlation_id, refresh_reason=refresh_reason)
+
+ def _get_regional_authority(self, central_authority):
+ if not self._region_configured: # User did not opt-in to ESTS-R
+ return None # Short circuit to completely bypass region detection
+ self._region_detected = self._region_detected or _detect_region(
+ self.http_client if self._region_configured is not None else None)
+ if (self._region_configured != self.ATTEMPT_REGION_DISCOVERY
+ and self._region_configured != self._region_detected):
+ logger.warning('Region configured ({}) != region detected ({})'.format(
+ repr(self._region_configured), repr(self._region_detected)))
+ region_to_use = (
+ self._region_detected
+ if self._region_configured == self.ATTEMPT_REGION_DISCOVERY
+ else self._region_configured) # It will retain the None i.e. opted out
+ logger.debug('Region to be used: {}'.format(repr(region_to_use)))
+ if region_to_use:
+ regional_host = ("{}.login.microsoft.com".format(region_to_use)
+ if central_authority.instance in (
+ # The list came from point 3 of the algorithm section in this internal doc
+ # https://identitydivision.visualstudio.com/DevEx/_git/AuthLibrariesApiReview?path=/PinAuthToRegion/AAD%20SDK%20Proposal%20to%20Pin%20Auth%20to%20region.md&anchor=algorithm&_a=preview
+ "login.microsoftonline.com",
+ "login.microsoft.com",
+ "login.windows.net",
+ "sts.windows.net",
+ )
+ else "{}.{}".format(region_to_use, central_authority.instance))
+ return Authority( # The central_authority has already been validated
+ "https://{}/{}".format(regional_host, central_authority.tenant),
+ self.http_client,
+ instance_discovery=False,
+ )
+ return None
+
+ def _build_client(self, client_credential, authority, skip_regional_client=False):
+ client_assertion = None
+ client_assertion_type = None
+ default_headers = {
+ "x-client-sku": "MSAL.Python", "x-client-ver": __version__,
+ "x-client-os": sys.platform,
+ "x-ms-lib-capability": "retry-after, h429",
+ }
+ if self.app_name:
+ default_headers['x-app-name'] = self.app_name
+ if self.app_version:
+ default_headers['x-app-ver'] = self.app_version
+ default_body = {"client_info": 1}
+ if isinstance(client_credential, dict):
+ client_assertion_type = Client.CLIENT_ASSERTION_TYPE_JWT
+ # Use client_credential.get("...") rather than "..." in client_credential
+ # so that we can ignore an empty string came from an empty ENV VAR.
+ if client_credential.get("client_assertion"):
+ if isinstance(client_credential["client_assertion"], str):
+ warnings.warn(
+ "Please use a callback instead of a string. See also "
+ "https://msal-python.readthedocs.io/en/latest/#msal.ClientApplication.params.client_credential",
+ DeprecationWarning)
+ client_assertion = client_credential['client_assertion']
+ else:
+ headers = {}
+ sha1_thumbprint = sha256_thumbprint = None
+ passphrase_bytes = _str2bytes(
+ client_credential["passphrase"]
+ ) if client_credential.get("passphrase") else None
+ if client_credential.get("private_key_pfx_path"):
+ private_key, sha256_thumbprint, sha1_thumbprint, x5c = _parse_pfx(
+ client_credential["private_key_pfx_path"],
+ passphrase_bytes)
+ if client_credential.get("public_certificate") is True and x5c:
+ headers["x5c"] = x5c
+ elif (
+ client_credential.get("private_key") # PEM blob
+ and client_credential.get("thumbprint")):
+ sha1_thumbprint = client_credential["thumbprint"]
+ if passphrase_bytes:
+ private_key = _load_private_key_from_pem_str(
+ client_credential['private_key'], passphrase_bytes)
+ else: # PEM without passphrase
+ private_key = client_credential['private_key']
+ else:
+ raise ValueError(
+ "client_credential needs to follow this format "
+ "https://msal-python.readthedocs.io/en/latest/#msal.ClientApplication.params.client_credential")
+ if ("x5c" not in headers # So the .pfx file contains no certificate
+ and isinstance(client_credential.get('public_certificate'), str)
+ ): # Then we treat the public_certificate value as PEM content
+ headers["x5c"] = extract_certs(client_credential['public_certificate'])
+ if sha256_thumbprint and not authority.is_adfs:
+ assertion_params = {
+ "algorithm": "PS256", "sha256_thumbprint": sha256_thumbprint,
+ }
+ else: # Fall back
+ if not sha1_thumbprint:
+ raise ValueError("You shall provide a thumbprint in SHA1.")
+ assertion_params = {
+ "algorithm": "RS256", "sha1_thumbprint": sha1_thumbprint,
+ }
+ assertion = JwtAssertionCreator(
+ private_key, headers=headers, **assertion_params)
+ client_assertion = assertion.create_regenerative_assertion(
+ audience=authority.token_endpoint, issuer=self.client_id,
+ additional_claims=self.client_claims or {})
+ else:
+ default_body['client_secret'] = client_credential
+ central_configuration = {
+ "authorization_endpoint": authority.authorization_endpoint,
+ "token_endpoint": authority.token_endpoint,
+ "device_authorization_endpoint": authority.device_authorization_endpoint,
+ }
+ central_client = _ClientWithCcsRoutingInfo(
+ central_configuration,
+ self.client_id,
+ http_client=self.http_client,
+ default_headers=default_headers,
+ default_body=default_body,
+ client_assertion=client_assertion,
+ client_assertion_type=client_assertion_type,
+ on_obtaining_tokens=lambda event: self.token_cache.add(dict(
+ event, environment=authority.instance)),
+ on_removing_rt=self.token_cache.remove_rt,
+ on_updating_rt=self.token_cache.update_rt)
+
+ regional_client = None
+ if (client_credential # Currently regional endpoint only serves some CCA flows
+ and not skip_regional_client):
+ regional_authority = self._get_regional_authority(authority)
+ if regional_authority:
+ regional_configuration = {
+ "authorization_endpoint": regional_authority.authorization_endpoint,
+ "token_endpoint": regional_authority.token_endpoint,
+ "device_authorization_endpoint":
+ regional_authority.device_authorization_endpoint,
+ }
+ regional_client = _ClientWithCcsRoutingInfo(
+ regional_configuration,
+ self.client_id,
+ http_client=self.http_client,
+ default_headers=default_headers,
+ default_body=default_body,
+ client_assertion=client_assertion,
+ client_assertion_type=client_assertion_type,
+ on_obtaining_tokens=lambda event: self.token_cache.add(dict(
+ event, environment=authority.instance)),
+ on_removing_rt=self.token_cache.remove_rt,
+ on_updating_rt=self.token_cache.update_rt)
+ return central_client, regional_client
+
+ def initiate_auth_code_flow(
+ self,
+ scopes, # type: list[str]
+ redirect_uri=None,
+ state=None, # Recommended by OAuth2 for CSRF protection
+ prompt=None,
+ login_hint=None, # type: Optional[str]
+ domain_hint=None, # type: Optional[str]
+ claims_challenge=None,
+ max_age=None,
+ response_mode=None, # type: Optional[str]
+ ):
+ """Initiate an auth code flow.
+
+ Later when the response reaches your redirect_uri,
+ you can use :func:`~acquire_token_by_auth_code_flow()`
+ to complete the authentication/authorization.
+
+ :param list scopes:
+ It is a list of case-sensitive strings.
+ :param str redirect_uri:
+ Optional. If not specified, server will use the pre-registered one.
+ :param str state:
+ An opaque value used by the client to
+ maintain state between the request and callback.
+ If absent, this library will automatically generate one internally.
+ :param str prompt:
+ By default, no prompt value will be sent, not even string ``"none"``.
+ You will have to specify a value explicitly.
+ Its valid values are the constants defined in
+ :class:`Prompt `.
+
+ :param str login_hint:
+ Optional. Identifier of the user. Generally a User Principal Name (UPN).
+ :param domain_hint:
+ Can be one of "consumers" or "organizations" or your tenant domain "contoso.com".
+ If included, it will skip the email-based discovery process that user goes
+ through on the sign-in page, leading to a slightly more streamlined user experience.
+ More information on possible values available in
+ `Auth Code Flow doc `_ and
+ `domain_hint doc `_.
+
+ :param int max_age:
+ OPTIONAL. Maximum Authentication Age.
+ Specifies the allowable elapsed time in seconds
+ since the last time the End-User was actively authenticated.
+ If the elapsed time is greater than this value,
+ Microsoft identity platform will actively re-authenticate the End-User.
+
+ MSAL Python will also automatically validate the auth_time in ID token.
+
+ New in version 1.15.
+
+ :param str response_mode:
+ OPTIONAL. Specifies the method with which response parameters should be returned.
+ The default value is equivalent to ``query``, which is still secure enough in MSAL Python
+ (because MSAL Python does not transfer tokens via query parameter in the first place).
+ For even better security, we recommend using the value ``form_post``.
+ In "form_post" mode, response parameters
+ will be encoded as HTML form values that are transmitted via the HTTP POST method and
+ encoded in the body using the application/x-www-form-urlencoded format.
+ Valid values can be either "form_post" for HTTP POST to callback URI or
+ "query" (the default) for HTTP GET with parameters encoded in query string.
+ More information on possible values
+ `here `
+ and `here `
+
+ :return:
+ The auth code flow. It is a dict in this form::
+
+ {
+ "auth_uri": "https://...", // Guide user to visit this
+ "state": "...", // You may choose to verify it by yourself,
+ // or just let acquire_token_by_auth_code_flow()
+ // do that for you.
+ "...": "...", // Everything else are reserved and internal
+ }
+
+ The caller is expected to:
+
+ 1. somehow store this content, typically inside the current session,
+ 2. guide the end user (i.e. resource owner) to visit that auth_uri,
+ 3. and then relay this dict and subsequent auth response to
+ :func:`~acquire_token_by_auth_code_flow()`.
+ """
+ client = _ClientWithCcsRoutingInfo(
+ {"authorization_endpoint": self.authority.authorization_endpoint},
+ self.client_id,
+ http_client=self.http_client)
+ flow = client.initiate_auth_code_flow(
+ redirect_uri=redirect_uri, state=state, login_hint=login_hint,
+ prompt=prompt,
+ scope=self._decorate_scope(scopes),
+ domain_hint=domain_hint,
+ claims=_merge_claims_challenge_and_capabilities(
+ self._client_capabilities, claims_challenge),
+ max_age=max_age,
+ response_mode=response_mode,
+ )
+ flow["claims_challenge"] = claims_challenge
+ return flow
+
+ def get_authorization_request_url(
+ self,
+ scopes, # type: list[str]
+ login_hint=None, # type: Optional[str]
+ state=None, # Recommended by OAuth2 for CSRF protection
+ redirect_uri=None,
+ response_type="code", # Could be "token" if you use Implicit Grant
+ prompt=None,
+ nonce=None,
+ domain_hint=None, # type: Optional[str]
+ claims_challenge=None,
+ **kwargs):
+ """Constructs a URL for you to start a Authorization Code Grant.
+
+ :param list[str] scopes: (Required)
+ Scopes requested to access a protected API (a resource).
+ :param str state: Recommended by OAuth2 for CSRF protection.
+ :param str login_hint:
+ Identifier of the user. Generally a User Principal Name (UPN).
+ :param str redirect_uri:
+ Address to return to upon receiving a response from the authority.
+ :param str response_type:
+ Default value is "code" for an OAuth2 Authorization Code grant.
+
+ You could use other content such as "id_token" or "token",
+ which would trigger an Implicit Grant, but that is
+ `not recommended `_.
+
+ :param str prompt:
+ By default, no prompt value will be sent, not even string ``"none"``.
+ You will have to specify a value explicitly.
+ Its valid values are the constants defined in
+ :class:`Prompt `.
+ :param nonce:
+ A cryptographically random value used to mitigate replay attacks. See also
+ `OIDC specs `_.
+ :param domain_hint:
+ Can be one of "consumers" or "organizations" or your tenant domain "contoso.com".
+ If included, it will skip the email-based discovery process that user goes
+ through on the sign-in page, leading to a slightly more streamlined user experience.
+ More information on possible values available in
+ `Auth Code Flow doc `_ and
+ `domain_hint doc `_.
+ :param claims_challenge:
+ The claims_challenge parameter requests specific claims requested by the resource provider
+ in the form of a claims_challenge directive in the www-authenticate header to be
+ returned from the UserInfo Endpoint and/or in the ID Token and/or Access Token.
+ It is a string of a JSON object which contains lists of claims being requested from these locations.
+
+ :return: The authorization url as a string.
+ """
+ authority = kwargs.pop("authority", None) # Historically we support this
+ if authority:
+ warnings.warn(
+ "We haven't decided if this method will accept authority parameter")
+ # The previous implementation is, it will use self.authority by default.
+ # Multi-tenant app can use new authority on demand
+ the_authority = Authority(
+ authority,
+ self.http_client,
+ instance_discovery=self._instance_discovery,
+ ) if authority else self.authority
+
+ client = _ClientWithCcsRoutingInfo(
+ {"authorization_endpoint": the_authority.authorization_endpoint},
+ self.client_id,
+ http_client=self.http_client)
+ warnings.warn(
+ "Change your get_authorization_request_url() "
+ "to initiate_auth_code_flow()", DeprecationWarning)
+ with warnings.catch_warnings(record=True):
+ return client.build_auth_request_uri(
+ response_type=response_type,
+ redirect_uri=redirect_uri, state=state, login_hint=login_hint,
+ prompt=prompt,
+ scope=self._decorate_scope(scopes),
+ nonce=nonce,
+ domain_hint=domain_hint,
+ claims=_merge_claims_challenge_and_capabilities(
+ self._client_capabilities, claims_challenge),
+ )
+
+ def acquire_token_by_auth_code_flow(
+ self, auth_code_flow, auth_response, scopes=None, **kwargs):
+ """Validate the auth response being redirected back, and obtain tokens.
+
+ It automatically provides nonce protection.
+
+ :param dict auth_code_flow:
+ The same dict returned by :func:`~initiate_auth_code_flow()`.
+ :param dict auth_response:
+ A dict of the query string received from auth server.
+ :param list[str] scopes:
+ Scopes requested to access a protected API (a resource).
+
+ Most of the time, you can leave it empty.
+
+ If you requested user consent for multiple resources, here you will
+ need to provide a subset of what you required in
+ :func:`~initiate_auth_code_flow()`.
+
+ OAuth2 was designed mostly for singleton services,
+ where tokens are always meant for the same resource and the only
+ changes are in the scopes.
+ In Microsoft Entra, tokens can be issued for multiple 3rd party resources.
+ You can ask authorization code for multiple resources,
+ but when you redeem it, the token is for only one intended
+ recipient, called audience.
+ So the developer need to specify a scope so that we can restrict the
+ token to be issued for the corresponding audience.
+
+ :return:
+ * A dict containing "access_token" and/or "id_token", among others,
+ depends on what scope was used.
+ (See https://tools.ietf.org/html/rfc6749#section-5.1)
+ * A dict containing "error", optionally "error_description", "error_uri".
+ (It is either `this `_
+ or `that `_)
+ * Most client-side data error would result in ValueError exception.
+ So the usage pattern could be without any protocol details::
+
+ def authorize(): # A controller in a web app
+ try:
+ result = msal_app.acquire_token_by_auth_code_flow(
+ session.get("flow", {}), request.args)
+ if "error" in result:
+ return render_template("error.html", result)
+ use(result) # Token(s) are available in result and cache
+ except ValueError: # Usually caused by CSRF
+ pass # Simply ignore them
+ return redirect(url_for("index"))
+ """
+ self._validate_ssh_cert_input_data(kwargs.get("data", {}))
+ telemetry_context = self._build_telemetry_context(
+ self.ACQUIRE_TOKEN_BY_AUTHORIZATION_CODE_ID)
+ response = _clean_up(self.client.obtain_token_by_auth_code_flow(
+ auth_code_flow,
+ auth_response,
+ scope=self._decorate_scope(scopes) if scopes else None,
+ headers=telemetry_context.generate_headers(),
+ data=dict(
+ kwargs.pop("data", {}),
+ claims=_merge_claims_challenge_and_capabilities(
+ self._client_capabilities,
+ auth_code_flow.pop("claims_challenge", None))),
+ **kwargs))
+ if "access_token" in response:
+ response[self._TOKEN_SOURCE] = self._TOKEN_SOURCE_IDP
+ telemetry_context.update_telemetry(response)
+ return response
+
+ def acquire_token_by_authorization_code(
+ self,
+ code,
+ scopes, # Syntactically required. STS accepts empty value though.
+ redirect_uri=None,
+ # REQUIRED, if the "redirect_uri" parameter was included in the
+ # authorization request as described in Section 4.1.1, and their
+ # values MUST be identical.
+ nonce=None,
+ claims_challenge=None,
+ **kwargs):
+ """The second half of the Authorization Code Grant.
+
+ :param code: The authorization code returned from Authorization Server.
+ :param list[str] scopes: (Required)
+ Scopes requested to access a protected API (a resource).
+
+ If you requested user consent for multiple resources, here you will
+ typically want to provide a subset of what you required in AuthCode.
+
+ OAuth2 was designed mostly for singleton services,
+ where tokens are always meant for the same resource and the only
+ changes are in the scopes.
+ In Microsoft Entra, tokens can be issued for multiple 3rd party resources.
+ You can ask authorization code for multiple resources,
+ but when you redeem it, the token is for only one intended
+ recipient, called audience.
+ So the developer need to specify a scope so that we can restrict the
+ token to be issued for the corresponding audience.
+
+ :param nonce:
+ If you provided a nonce when calling :func:`get_authorization_request_url`,
+ same nonce should also be provided here, so that we'll validate it.
+ An exception will be raised if the nonce in id token mismatches.
+
+ :param claims_challenge:
+ The claims_challenge parameter requests specific claims requested by the resource provider
+ in the form of a claims_challenge directive in the www-authenticate header to be
+ returned from the UserInfo Endpoint and/or in the ID Token and/or Access Token.
+ It is a string of a JSON object which contains lists of claims being requested from these locations.
+
+ :return: A dict representing the json response from Microsoft Entra:
+
+ - A successful response would contain "access_token" key,
+ - an error response would contain "error" and usually "error_description".
+ """
+ # If scope is absent on the wire, STS will give you a token associated
+ # to the FIRST scope sent during the authorization request.
+ # So in theory, you can omit scope here when you were working with only
+ # one scope. But, MSAL decorates your scope anyway, so they are never
+ # really empty.
+ assert isinstance(scopes, list), "Invalid parameter type"
+ self._validate_ssh_cert_input_data(kwargs.get("data", {}))
+ warnings.warn(
+ "Change your acquire_token_by_authorization_code() "
+ "to acquire_token_by_auth_code_flow()", DeprecationWarning)
+ with warnings.catch_warnings(record=True):
+ telemetry_context = self._build_telemetry_context(
+ self.ACQUIRE_TOKEN_BY_AUTHORIZATION_CODE_ID)
+ response = _clean_up(self.client.obtain_token_by_authorization_code(
+ code, redirect_uri=redirect_uri,
+ scope=self._decorate_scope(scopes),
+ headers=telemetry_context.generate_headers(),
+ data=dict(
+ kwargs.pop("data", {}),
+ claims=_merge_claims_challenge_and_capabilities(
+ self._client_capabilities, claims_challenge)),
+ nonce=nonce,
+ **kwargs))
+ if "access_token" in response:
+ response[self._TOKEN_SOURCE] = self._TOKEN_SOURCE_IDP
+ telemetry_context.update_telemetry(response)
+ return response
+
+ def get_accounts(self, username=None):
+ """Get a list of accounts which previously signed in, i.e. exists in cache.
+
+ An account can later be used in :func:`~acquire_token_silent`
+ to find its tokens.
+
+ :param username:
+ Filter accounts with this username only. Case insensitive.
+ :return: A list of account objects.
+ Each account is a dict. For now, we only document its "username" field.
+ Your app can choose to display those information to end user,
+ and allow user to choose one of his/her accounts to proceed.
+ """
+ accounts = self._find_msal_accounts(environment=self.authority.instance)
+ if not accounts: # Now try other aliases of this authority instance
+ for alias in self._get_authority_aliases(self.authority.instance):
+ accounts = self._find_msal_accounts(environment=alias)
+ if accounts:
+ break
+ if username:
+ # Federated account["username"] from AAD could contain mixed case
+ lowercase_username = username.lower()
+ accounts = [a for a in accounts
+ if a["username"].lower() == lowercase_username]
+ if not accounts:
+ logger.debug(( # This would also happen when the cache is empty
+ "get_accounts(username='{}') finds no account. "
+ "If tokens were acquired without 'profile' scope, "
+ "they would contain no username for filtering. "
+ "Consider calling get_accounts(username=None) instead."
+ ).format(username))
+ # Does not further filter by existing RTs here. It probably won't matter.
+ # Because in most cases Accounts and RTs co-exist.
+ # Even in the rare case when an RT is revoked and then removed,
+ # acquire_token_silent() would then yield no result,
+ # apps would fall back to other acquire methods. This is the standard pattern.
+ return accounts
+
+ def _find_msal_accounts(self, environment):
+ interested_authority_types = [
+ TokenCache.AuthorityType.ADFS, TokenCache.AuthorityType.MSSTS]
+ if _is_running_in_cloud_shell():
+ interested_authority_types.append(_AUTHORITY_TYPE_CLOUDSHELL)
+ grouped_accounts = {
+ a.get("home_account_id"): # Grouped by home tenant's id
+ { # These are minimal amount of non-tenant-specific account info
+ "home_account_id": a.get("home_account_id"),
+ "environment": a.get("environment"),
+ "username": a.get("username"),
+ "account_source": a.get("account_source"),
+
+ # The following fields for backward compatibility, for now
+ "authority_type": a.get("authority_type"),
+ "local_account_id": a.get("local_account_id"), # Tenant-specific
+ "realm": a.get("realm"), # Tenant-specific
+ }
+ for a in self.token_cache.search(
+ TokenCache.CredentialType.ACCOUNT,
+ query={"environment": environment})
+ if a["authority_type"] in interested_authority_types
+ }
+ return list(grouped_accounts.values())
+
+ def _get_instance_metadata(self): # This exists so it can be mocked in unit test
+ resp = self.http_client.get(
+ "https://login.microsoftonline.com/common/discovery/instance?api-version=1.1&authorization_endpoint=https://login.microsoftonline.com/common/oauth2/authorize", # TBD: We may extend this to use self._instance_discovery endpoint
+ headers={'Accept': 'application/json'})
+ resp.raise_for_status()
+ return json.loads(resp.text)['metadata']
+
+ def _get_authority_aliases(self, instance):
+ if self._instance_discovery is False:
+ return []
+ if self.authority._is_known_to_developer:
+ # Then it is an ADFS/B2C/known_authority_hosts situation
+ # which may not reach the central endpoint, so we skip it.
+ return []
+ if not self.authority_groups:
+ self.authority_groups = [
+ set(group['aliases']) for group in self._get_instance_metadata()]
+ for group in self.authority_groups:
+ if instance in group:
+ return [alias for alias in group if alias != instance]
+ return []
+
+ def remove_account(self, account):
+ """Sign me out and forget me from token cache"""
+ if self._enable_broker:
+ from .broker import _signout_silently
+ error = _signout_silently(self.client_id, account["local_account_id"])
+ if error:
+ logger.debug("_signout_silently() returns error: %s", error)
+ # Broker sign-out has been attempted, even if the _forget_me() below throws.
+ self._forget_me(account)
+
+ def _sign_out(self, home_account):
+ # Remove all relevant RTs and ATs from token cache
+ owned_by_home_account = {
+ "environment": home_account["environment"],
+ "home_account_id": home_account["home_account_id"],} # realm-independent
+ app_metadata = self._get_app_metadata(home_account["environment"])
+ # Remove RTs/FRTs, and they are realm-independent
+ for rt in [ # Remove RTs from a static list (rather than from a dynamic generator),
+ # to avoid changing self.token_cache while it is being iterated
+ rt for rt in self.token_cache.search(
+ TokenCache.CredentialType.REFRESH_TOKEN, query=owned_by_home_account)
+ # Do RT's app ownership check as a precaution, in case family apps
+ # and 3rd-party apps share same token cache, although they should not.
+ if rt["client_id"] == self.client_id or (
+ app_metadata.get("family_id") # Now let's settle family business
+ and rt.get("family_id") == app_metadata["family_id"])
+ ]:
+ self.token_cache.remove_rt(rt)
+ for at in list(self.token_cache.search( # Remove ATs from a static list,
+ # to avoid changing self.token_cache while it is being iterated
+ TokenCache.CredentialType.ACCESS_TOKEN, query=owned_by_home_account,
+ # Regardless of realm, b/c we've removed realm-independent RTs anyway
+ )):
+ # To avoid the complexity of locating sibling family app's AT,
+ # we skip AT's app ownership check.
+ # It means ATs for other apps will also be removed, it is OK because:
+ # * non-family apps are not supposed to share token cache to begin with;
+ # * Even if it happens, we keep other app's RT already, so SSO still works
+ self.token_cache.remove_at(at)
+
+ def _forget_me(self, home_account):
+ # It implies signout, and then also remove all relevant accounts and IDTs
+ self._sign_out(home_account)
+ owned_by_home_account = {
+ "environment": home_account["environment"],
+ "home_account_id": home_account["home_account_id"],} # realm-independent
+ for idt in list(self.token_cache.search( # Remove IDTs from a static list,
+ # to avoid changing self.token_cache while it is being iterated
+ TokenCache.CredentialType.ID_TOKEN, query=owned_by_home_account, # regardless of realm
+ )):
+ self.token_cache.remove_idt(idt)
+ for a in list(self.token_cache.search( # Remove Accounts from a static list,
+ # to avoid changing self.token_cache while it is being iterated
+ TokenCache.CredentialType.ACCOUNT, query=owned_by_home_account, # regardless of realm
+ )):
+ self.token_cache.remove_account(a)
+
+ def _acquire_token_by_cloud_shell(self, scopes, data=None):
+ from .cloudshell import _obtain_token
+ response = _obtain_token(
+ self.http_client, scopes, client_id=self.client_id, data=data)
+ if "error" not in response:
+ self.token_cache.add(dict(
+ client_id=self.client_id,
+ scope=response["scope"].split() if "scope" in response else scopes,
+ token_endpoint=self.authority.token_endpoint,
+ response=response,
+ data=data or {},
+ authority_type=_AUTHORITY_TYPE_CLOUDSHELL,
+ ))
+ if "access_token" in response:
+ response[self._TOKEN_SOURCE] = self._TOKEN_SOURCE_BROKER
+ return response
+
+ def acquire_token_silent(
+ self,
+ scopes, # type: List[str]
+ account, # type: Optional[Account]
+ authority=None, # See get_authorization_request_url()
+ force_refresh=False, # type: Optional[boolean]
+ claims_challenge=None,
+ auth_scheme=None,
+ **kwargs):
+ """Acquire an access token for given account, without user interaction.
+
+ It has same parameters as the :func:`~acquire_token_silent_with_error`.
+ The difference is the behavior of the return value.
+ This method will combine the cache empty and refresh error
+ into one return value, `None`.
+ If your app does not care about the exact token refresh error during
+ token cache look-up, then this method is easier and recommended.
+
+ :return:
+ - A dict containing no "error" key,
+ and typically contains an "access_token" key,
+ if cache lookup succeeded.
+ - None when cache lookup does not yield a token.
+ """
+ if not account:
+ return None # A backward-compatible NO-OP to drop the account=None usage
+ result = _clean_up(self._acquire_token_silent_with_error(
+ scopes, account, authority=authority, force_refresh=force_refresh,
+ claims_challenge=claims_challenge, auth_scheme=auth_scheme, **kwargs))
+ return result if result and "error" not in result else None
+
+ def acquire_token_silent_with_error(
+ self,
+ scopes, # type: List[str]
+ account, # type: Optional[Account]
+ authority=None, # See get_authorization_request_url()
+ force_refresh=False, # type: Optional[boolean]
+ claims_challenge=None,
+ auth_scheme=None,
+ **kwargs):
+ """Acquire an access token for given account, without user interaction.
+
+ It is done either by finding a valid access token from cache,
+ or by finding a valid refresh token from cache and then automatically
+ use it to redeem a new access token.
+
+ This method will differentiate cache empty from token refresh error.
+ If your app cares the exact token refresh error during
+ token cache look-up, then this method is suitable.
+ Otherwise, the other method :func:`~acquire_token_silent` is recommended.
+
+ :param list[str] scopes: (Required)
+ Scopes requested to access a protected API (a resource).
+ :param account: (Required)
+ One of the account object returned by :func:`~get_accounts`.
+ Starting from MSAL Python 1.23,
+ a ``None`` input will become a NO-OP and always return ``None``.
+ :param force_refresh:
+ If True, it will skip Access Token look-up,
+ and try to find a Refresh Token to obtain a new Access Token.
+ :param claims_challenge:
+ The claims_challenge parameter requests specific claims requested by the resource provider
+ in the form of a claims_challenge directive in the www-authenticate header to be
+ returned from the UserInfo Endpoint and/or in the ID Token and/or Access Token.
+ It is a string of a JSON object which contains lists of claims being requested from these locations.
+ :param object auth_scheme:
+ You can provide an ``msal.auth_scheme.PopAuthScheme`` object
+ so that MSAL will get a Proof-of-Possession (POP) token for you.
+
+ New in version 1.26.0.
+
+ :return:
+ - A dict containing no "error" key,
+ and typically contains an "access_token" key,
+ if cache lookup succeeded.
+ - None when there is simply no token in the cache.
+ - A dict containing an "error" key, when token refresh failed.
+ """
+ if not account:
+ return None # A backward-compatible NO-OP to drop the account=None usage
+ return _clean_up(self._acquire_token_silent_with_error(
+ scopes, account, authority=authority, force_refresh=force_refresh,
+ claims_challenge=claims_challenge, auth_scheme=auth_scheme, **kwargs))
+
+ def _acquire_token_silent_with_error(
+ self,
+ scopes, # type: List[str]
+ account, # type: Optional[Account]
+ authority=None, # See get_authorization_request_url()
+ force_refresh=False, # type: Optional[boolean]
+ claims_challenge=None,
+ auth_scheme=None,
+ **kwargs):
+ assert isinstance(scopes, list), "Invalid parameter type"
+ self._validate_ssh_cert_input_data(kwargs.get("data", {}))
+ correlation_id = msal.telemetry._get_new_correlation_id()
+ if authority:
+ warnings.warn("We haven't decided how/if this method will accept authority parameter")
+ # the_authority = Authority(
+ # authority,
+ # self.http_client,
+ # instance_discovery=self._instance_discovery,
+ # ) if authority else self.authority
+ result = self._acquire_token_silent_from_cache_and_possibly_refresh_it(
+ scopes, account, self.authority, force_refresh=force_refresh,
+ claims_challenge=claims_challenge,
+ correlation_id=correlation_id,
+ auth_scheme=auth_scheme,
+ **kwargs)
+ if result and "error" not in result:
+ return result
+ final_result = result
+ for alias in self._get_authority_aliases(self.authority.instance):
+ if not list(self.token_cache.search( # Need a list to test emptiness
+ self.token_cache.CredentialType.REFRESH_TOKEN,
+ # target=scopes, # MUST NOT filter by scopes, because:
+ # 1. AAD RTs are scope-independent;
+ # 2. therefore target is optional per schema;
+ query={"environment": alias})):
+ # Skip heavy weight logic when RT for this alias doesn't exist
+ continue
+ the_authority = Authority(
+ "https://" + alias + "/" + self.authority.tenant,
+ self.http_client,
+ instance_discovery=False,
+ )
+ result = self._acquire_token_silent_from_cache_and_possibly_refresh_it(
+ scopes, account, the_authority, force_refresh=force_refresh,
+ claims_challenge=claims_challenge,
+ correlation_id=correlation_id,
+ auth_scheme=auth_scheme,
+ **kwargs)
+ if result:
+ if "error" not in result:
+ return result
+ final_result = result
+ if final_result and final_result.get("suberror"):
+ final_result["classification"] = { # Suppress these suberrors, per #57
+ "bad_token": "",
+ "token_expired": "",
+ "protection_policy_required": "",
+ "client_mismatch": "",
+ "device_authentication_failed": "",
+ }.get(final_result["suberror"], final_result["suberror"])
+ return final_result
+
+ def _acquire_token_silent_from_cache_and_possibly_refresh_it(
+ self,
+ scopes, # type: List[str]
+ account, # type: Optional[Account]
+ authority, # This can be different than self.authority
+ force_refresh=False, # type: Optional[boolean]
+ claims_challenge=None,
+ correlation_id=None,
+ http_exceptions=None,
+ auth_scheme=None,
+ **kwargs):
+ # This internal method has two calling patterns:
+ # it accepts a non-empty account to find token for a user,
+ # and accepts account=None to find a token for the current app.
+ access_token_from_cache = None
+ if not (force_refresh or claims_challenge or auth_scheme): # Then attempt AT cache
+ query={
+ "client_id": self.client_id,
+ "environment": authority.instance,
+ "realm": authority.tenant,
+ "home_account_id": (account or {}).get("home_account_id"),
+ }
+ key_id = kwargs.get("data", {}).get("key_id")
+ if key_id: # Some token types (SSH-certs, POP) are bound to a key
+ query["key_id"] = key_id
+ now = time.time()
+ refresh_reason = msal.telemetry.AT_ABSENT
+ for entry in self.token_cache.search( # A generator allows us to
+ # break early in cache-hit without finding a full list
+ self.token_cache.CredentialType.ACCESS_TOKEN,
+ target=scopes,
+ query=query,
+ ): # This loop is about token search, not about token deletion.
+ # Note that search() holds a lock during this loop;
+ # that is fine because this loop is fast
+ expires_in = int(entry["expires_on"]) - now
+ if expires_in < 5*60: # Then consider it expired
+ refresh_reason = msal.telemetry.AT_EXPIRED
+ continue # Removal is not necessary, it will be overwritten
+ logger.debug("Cache hit an AT")
+ access_token_from_cache = { # Mimic a real response
+ "access_token": entry["secret"],
+ "token_type": entry.get("token_type", "Bearer"),
+ "expires_in": int(expires_in), # OAuth2 specs defines it as int
+ self._TOKEN_SOURCE: self._TOKEN_SOURCE_CACHE,
+ }
+ if "refresh_on" in entry:
+ access_token_from_cache["refresh_on"] = int(entry["refresh_on"])
+ if int(entry["refresh_on"]) < now: # aging
+ refresh_reason = msal.telemetry.AT_AGING
+ break # With a fallback in hand, we break here to go refresh
+ self._build_telemetry_context(-1).hit_an_access_token()
+ return access_token_from_cache # It is still good as new
+ else:
+ refresh_reason = msal.telemetry.FORCE_REFRESH # TODO: It could also mean claims_challenge
+ assert refresh_reason, "It should have been established at this point"
+ if not http_exceptions: # It can be a tuple of exceptions
+ # The exact HTTP exceptions are transportation-layer dependent
+ from requests.exceptions import RequestException # Lazy load
+ http_exceptions = (RequestException,)
+ try:
+ data = kwargs.get("data", {})
+ if account and account.get("authority_type") == _AUTHORITY_TYPE_CLOUDSHELL:
+ if auth_scheme:
+ raise ValueError("auth_scheme is not supported in Cloud Shell")
+ return self._acquire_token_by_cloud_shell(scopes, data=data)
+
+ if self._enable_broker and account and account.get("account_source") in (
+ _GRANT_TYPE_BROKER, # Broker successfully established this account previously.
+ None, # Unknown data from older MSAL. Broker might still work.
+ ):
+ from .broker import _acquire_token_silently
+ response = _acquire_token_silently(
+ "https://{}/{}".format(self.authority.instance, self.authority.tenant),
+ self.client_id,
+ account["local_account_id"],
+ scopes,
+ claims=_merge_claims_challenge_and_capabilities(
+ self._client_capabilities, claims_challenge),
+ correlation_id=correlation_id,
+ auth_scheme=auth_scheme,
+ **data)
+ if response: # Broker provides a decisive outcome
+ account_was_established_by_broker = account.get(
+ "account_source") == _GRANT_TYPE_BROKER
+ broker_attempt_succeeded_just_now = "error" not in response
+ if account_was_established_by_broker or broker_attempt_succeeded_just_now:
+ return self._process_broker_response(response, scopes, data)
+
+ if auth_scheme:
+ raise ValueError(self._AUTH_SCHEME_UNSUPPORTED)
+ if account:
+ result = self._acquire_token_silent_by_finding_rt_belongs_to_me_or_my_family(
+ authority, self._decorate_scope(scopes), account,
+ refresh_reason=refresh_reason, claims_challenge=claims_challenge,
+ correlation_id=correlation_id,
+ **kwargs)
+ else: # The caller is acquire_token_for_client()
+ result = self._acquire_token_for_client(
+ scopes, refresh_reason, claims_challenge=claims_challenge,
+ **kwargs)
+ if result and "access_token" in result:
+ result[self._TOKEN_SOURCE] = self._TOKEN_SOURCE_IDP
+ if (result and "error" not in result) or (not access_token_from_cache):
+ return result
+ except http_exceptions:
+ # Typically network error. Potential AAD outage?
+ if not access_token_from_cache: # It means there is no fall back option
+ raise # We choose to bubble up the exception
+ return access_token_from_cache
+
+ def _process_broker_response(self, response, scopes, data):
+ if "error" not in response:
+ self.token_cache.add(dict(
+ client_id=self.client_id,
+ scope=response["scope"].split() if "scope" in response else scopes,
+ token_endpoint=self.authority.token_endpoint,
+ response=response,
+ data=data,
+ _account_id=response["_account_id"],
+ environment=self.authority.instance, # Be consistent with non-broker flows
+ grant_type=_GRANT_TYPE_BROKER, # A pseudo grant type for TokenCache to mark account_source as broker
+ ))
+ response[self._TOKEN_SOURCE] = self._TOKEN_SOURCE_BROKER
+ return _clean_up(response)
+
+ def _acquire_token_silent_by_finding_rt_belongs_to_me_or_my_family(
+ self, authority, scopes, account, **kwargs):
+ query = {
+ "environment": authority.instance,
+ "home_account_id": (account or {}).get("home_account_id"),
+ # "realm": authority.tenant, # AAD RTs are tenant-independent
+ }
+ app_metadata = self._get_app_metadata(authority.instance)
+ if not app_metadata: # Meaning this app is now used for the first time.
+ # When/if we have a way to directly detect current app's family,
+ # we'll rewrite this block, to support multiple families.
+ # For now, we try existing RTs (*). If it works, we are in that family.
+ # (*) RTs of a different app/family are not supposed to be
+ # shared with or accessible by us in the first place.
+ at = self._acquire_token_silent_by_finding_specific_refresh_token(
+ authority, scopes,
+ dict(query, family_id="1"), # A hack, we have only 1 family for now
+ rt_remover=lambda rt_item: None, # NO-OP b/c RTs are likely not mine
+ break_condition=lambda response: # Break loop when app not in family
+ # Based on an AAD-only behavior mentioned in internal doc here
+ # https://msazure.visualstudio.com/One/_git/ESTS-Docs/pullrequest/1138595
+ "client_mismatch" in response.get("error_additional_info", []),
+ **kwargs)
+ if at and "error" not in at:
+ return at
+ last_resp = None
+ if app_metadata.get("family_id"): # Meaning this app belongs to this family
+ last_resp = at = self._acquire_token_silent_by_finding_specific_refresh_token(
+ authority, scopes, dict(query, family_id=app_metadata["family_id"]),
+ **kwargs)
+ if at and "error" not in at:
+ return at
+ # Either this app is an orphan, so we will naturally use its own RT;
+ # or all attempts above have failed, so we fall back to non-foci behavior.
+ return self._acquire_token_silent_by_finding_specific_refresh_token(
+ authority, scopes, dict(query, client_id=self.client_id),
+ **kwargs) or last_resp
+
+ def _get_app_metadata(self, environment):
+ return self.token_cache._get_app_metadata(
+ environment=environment, client_id=self.client_id, default={})
+
+ def _acquire_token_silent_by_finding_specific_refresh_token(
+ self, authority, scopes, query,
+ rt_remover=None, break_condition=lambda response: False,
+ refresh_reason=None, correlation_id=None, claims_challenge=None,
+ **kwargs):
+ matches = list(self.token_cache.search( # We want a list to test emptiness
+ self.token_cache.CredentialType.REFRESH_TOKEN,
+ # target=scopes, # AAD RTs are scope-independent
+ query=query))
+ logger.debug("Found %d RTs matching %s", len(matches), {
+ k: _pii_less_home_account_id(v) if k == "home_account_id" and v else v
+ for k, v in query.items()
+ })
+
+ response = None # A distinguishable value to mean cache is empty
+ if not matches: # Then exit early to avoid expensive operations
+ return response
+ client, _ = self._build_client(
+ # Potentially expensive if building regional client
+ self.client_credential, authority, skip_regional_client=True)
+ telemetry_context = self._build_telemetry_context(
+ self.ACQUIRE_TOKEN_SILENT_ID,
+ correlation_id=correlation_id, refresh_reason=refresh_reason)
+ for entry in sorted( # Since unfit RTs would not be aggressively removed,
+ # we start from newer RTs which are more likely fit.
+ matches,
+ key=lambda e: int(e.get("last_modification_time", "0")),
+ reverse=True):
+ logger.debug("Cache attempts an RT")
+ headers = telemetry_context.generate_headers()
+ if query.get("home_account_id"): # Then use it as CCS Routing info
+ headers["X-AnchorMailbox"] = "Oid:{}".format( # case-insensitive value
+ query["home_account_id"].replace(".", "@"))
+ response = client.obtain_token_by_refresh_token(
+ entry, rt_getter=lambda token_item: token_item["secret"],
+ on_removing_rt=lambda rt_item: None, # Disable RT removal,
+ # because an invalid_grant could be caused by new MFA policy,
+ # the RT could still be useful for other MFA-less scope or tenant
+ on_obtaining_tokens=lambda event: self.token_cache.add(dict(
+ event,
+ environment=authority.instance,
+ skip_account_creation=True, # To honor a concurrent remove_account()
+ )),
+ scope=scopes,
+ headers=headers,
+ data=dict(
+ kwargs.pop("data", {}),
+ claims=_merge_claims_challenge_and_capabilities(
+ self._client_capabilities, claims_challenge)),
+ **kwargs)
+ telemetry_context.update_telemetry(response)
+ if "error" not in response:
+ return response
+ logger.debug("Refresh failed. {error}: {error_description}".format(
+ error=response.get("error"),
+ error_description=response.get("error_description"),
+ ))
+ if break_condition(response):
+ break
+ return response # Returns the latest error (if any), or just None
+
+ def _validate_ssh_cert_input_data(self, data):
+ if data.get("token_type") == "ssh-cert":
+ if not data.get("req_cnf"):
+ raise ValueError(
+ "When requesting an SSH certificate, "
+ "you must include a string parameter named 'req_cnf' "
+ "containing the public key in JWK format "
+ "(https://tools.ietf.org/html/rfc7517).")
+ if not data.get("key_id"):
+ raise ValueError(
+ "When requesting an SSH certificate, "
+ "you must include a string parameter named 'key_id' "
+ "which identifies the key in the 'req_cnf' argument.")
+
+ def acquire_token_by_refresh_token(self, refresh_token, scopes, **kwargs):
+ """Acquire token(s) based on a refresh token (RT) obtained from elsewhere.
+
+ You use this method only when you have old RTs from elsewhere,
+ and now you want to migrate them into MSAL.
+ Calling this method results in new tokens automatically storing into MSAL.
+
+ You do NOT need to use this method if you are already using MSAL.
+ MSAL maintains RT automatically inside its token cache,
+ and an access token can be retrieved
+ when you call :func:`~acquire_token_silent`.
+
+ :param str refresh_token: The old refresh token, as a string.
+
+ :param list scopes:
+ The scopes associate with this old RT.
+ Each scope needs to be in the Microsoft identity platform (v2) format.
+ See `Scopes not resources `_.
+
+ :return:
+ * A dict contains "error" and some other keys, when error happened.
+ * A dict contains no "error" key means migration was successful.
+ """
+ self._validate_ssh_cert_input_data(kwargs.get("data", {}))
+ telemetry_context = self._build_telemetry_context(
+ self.ACQUIRE_TOKEN_BY_REFRESH_TOKEN,
+ refresh_reason=msal.telemetry.FORCE_REFRESH)
+ response = _clean_up(self.client.obtain_token_by_refresh_token(
+ refresh_token,
+ scope=self._decorate_scope(scopes),
+ headers=telemetry_context.generate_headers(),
+ rt_getter=lambda rt: rt,
+ on_updating_rt=False,
+ on_removing_rt=lambda rt_item: None, # No OP
+ **kwargs))
+ if "access_token" in response:
+ response[self._TOKEN_SOURCE] = self._TOKEN_SOURCE_IDP
+ telemetry_context.update_telemetry(response)
+ return response
+
+ def acquire_token_by_username_password(
+ self, username, password, scopes, claims_challenge=None,
+ # Note: We shouldn't need to surface enable_msa_passthrough,
+ # because this ROPC won't work with MSA account anyway.
+ auth_scheme=None,
+ **kwargs):
+ """Gets a token for a given resource via user credentials.
+
+ See this page for constraints of Username Password Flow.
+ https://github.com/AzureAD/microsoft-authentication-library-for-python/wiki/Username-Password-Authentication
+
+ :param str username: Typically a UPN in the form of an email address.
+ :param str password: The password.
+ :param list[str] scopes:
+ Scopes requested to access a protected API (a resource).
+ :param claims_challenge:
+ The claims_challenge parameter requests specific claims requested by the resource provider
+ in the form of a claims_challenge directive in the www-authenticate header to be
+ returned from the UserInfo Endpoint and/or in the ID Token and/or Access Token.
+ It is a string of a JSON object which contains lists of claims being requested from these locations.
+
+ :param object auth_scheme:
+ You can provide an ``msal.auth_scheme.PopAuthScheme`` object
+ so that MSAL will get a Proof-of-Possession (POP) token for you.
+
+ New in version 1.26.0.
+
+ :return: A dict representing the json response from Microsoft Entra:
+
+ - A successful response would contain "access_token" key,
+ - an error response would contain "error" and usually "error_description".
+ """
+ claims = _merge_claims_challenge_and_capabilities(
+ self._client_capabilities, claims_challenge)
+ if self._enable_broker:
+ from .broker import _signin_silently
+ response = _signin_silently(
+ "https://{}/{}".format(self.authority.instance, self.authority.tenant),
+ self.client_id,
+ scopes, # Decorated scopes won't work due to offline_access
+ MSALRuntime_Username=username,
+ MSALRuntime_Password=password,
+ validateAuthority="no" if (
+ self.authority._is_known_to_developer
+ or self._instance_discovery is False) else None,
+ claims=claims,
+ auth_scheme=auth_scheme,
+ )
+ return self._process_broker_response(response, scopes, kwargs.get("data", {}))
+
+ if auth_scheme:
+ raise ValueError(self._AUTH_SCHEME_UNSUPPORTED)
+ scopes = self._decorate_scope(scopes)
+ telemetry_context = self._build_telemetry_context(
+ self.ACQUIRE_TOKEN_BY_USERNAME_PASSWORD_ID)
+ headers = telemetry_context.generate_headers()
+ data = dict(kwargs.pop("data", {}), claims=claims)
+ response = None
+ if not self.authority.is_adfs:
+ user_realm_result = self.authority.user_realm_discovery(
+ username, correlation_id=headers[msal.telemetry.CLIENT_REQUEST_ID])
+ if user_realm_result.get("account_type") == "Federated":
+ response = _clean_up(self._acquire_token_by_username_password_federated(
+ user_realm_result, username, password, scopes=scopes,
+ data=data,
+ headers=headers, **kwargs))
+ if response is None: # Either ADFS or not federated
+ response = _clean_up(self.client.obtain_token_by_username_password(
+ username, password, scope=scopes,
+ headers=headers,
+ data=data,
+ **kwargs))
+ if "access_token" in response:
+ response[self._TOKEN_SOURCE] = self._TOKEN_SOURCE_IDP
+ telemetry_context.update_telemetry(response)
+ return response
+
+ def _acquire_token_by_username_password_federated(
+ self, user_realm_result, username, password, scopes=None, **kwargs):
+ wstrust_endpoint = {}
+ if user_realm_result.get("federation_metadata_url"):
+ wstrust_endpoint = mex_send_request(
+ user_realm_result["federation_metadata_url"],
+ self.http_client)
+ if wstrust_endpoint is None:
+ raise ValueError("Unable to find wstrust endpoint from MEX. "
+ "This typically happens when attempting MSA accounts. "
+ "More details available here. "
+ "https://github.com/AzureAD/microsoft-authentication-library-for-python/wiki/Username-Password-Authentication")
+ logger.debug("wstrust_endpoint = %s", wstrust_endpoint)
+ wstrust_result = wst_send_request(
+ username, password,
+ user_realm_result.get("cloud_audience_urn", "urn:federation:MicrosoftOnline"),
+ wstrust_endpoint.get("address",
+ # Fallback to an AAD supplied endpoint
+ user_realm_result.get("federation_active_auth_url")),
+ wstrust_endpoint.get("action"), self.http_client)
+ if not ("token" in wstrust_result and "type" in wstrust_result):
+ raise RuntimeError("Unsuccessful RSTR. %s" % wstrust_result)
+ GRANT_TYPE_SAML1_1 = 'urn:ietf:params:oauth:grant-type:saml1_1-bearer'
+ grant_type = {
+ SAML_TOKEN_TYPE_V1: GRANT_TYPE_SAML1_1,
+ SAML_TOKEN_TYPE_V2: self.client.GRANT_TYPE_SAML2,
+ WSS_SAML_TOKEN_PROFILE_V1_1: GRANT_TYPE_SAML1_1,
+ WSS_SAML_TOKEN_PROFILE_V2: self.client.GRANT_TYPE_SAML2
+ }.get(wstrust_result.get("type"))
+ if not grant_type:
+ raise RuntimeError(
+ "RSTR returned unknown token type: %s", wstrust_result.get("type"))
+ self.client.grant_assertion_encoders.setdefault( # Register a non-standard type
+ grant_type, self.client.encode_saml_assertion)
+ return self.client.obtain_token_by_assertion(
+ wstrust_result["token"], grant_type, scope=scopes,
+ on_obtaining_tokens=lambda event: self.token_cache.add(dict(
+ event,
+ environment=self.authority.instance,
+ username=username, # Useful in case IDT contains no such info
+ )),
+ **kwargs)
+
+
+class PublicClientApplication(ClientApplication): # browser app or mobile app
+
+ DEVICE_FLOW_CORRELATION_ID = "_correlation_id"
+ CONSOLE_WINDOW_HANDLE = object()
+
+ def __init__(self, client_id, client_credential=None, **kwargs):
+ """Same as :func:`ClientApplication.__init__`,
+ except that ``client_credential`` parameter shall remain ``None``.
+
+ .. note::
+
+ You may set enable_broker_on_windows and/or enable_broker_on_mac to True.
+
+ **What is a broker, and why use it?**
+
+ A broker is a component installed on your device.
+ Broker implicitly gives your device an identity. By using a broker,
+ your device becomes a factor that can satisfy MFA (Multi-factor authentication).
+ This factor would become mandatory
+ if a tenant's admin enables a corresponding Conditional Access (CA) policy.
+ The broker's presence allows Microsoft identity platform
+ to have higher confidence that the tokens are being issued to your device,
+ and that is more secure.
+
+ An additional benefit of broker is,
+ it runs as a long-lived process with your device's OS,
+ and maintains its own cache,
+ so that your broker-enabled apps (even a CLI)
+ could automatically SSO from a previously established signed-in session.
+
+ **You shall only enable broker when your app:**
+
+ 1. is running on supported platforms,
+ and already registered their corresponding redirect_uri
+
+ * ``ms-appx-web://Microsoft.AAD.BrokerPlugin/your_client_id``
+ if your app is expected to run on Windows 10+
+ * ``msauth.com.msauth.unsignedapp://auth``
+ if your app is expected to run on Mac
+
+ 2. installed broker dependency,
+ e.g. ``pip install msal[broker]>=1.31,<2``.
+
+ 3. tested with ``acquire_token_interactive()`` and ``acquire_token_silent()``.
+
+ **The fallback behaviors of MSAL Python's broker support**
+
+ MSAL will either error out, or silently fallback to non-broker flows.
+
+ 1. MSAL will ignore the `enable_broker_...` and bypass broker
+ on those auth flows that are known to be NOT supported by broker.
+ This includes ADFS, B2C, etc..
+ For other "could-use-broker" scenarios, please see below.
+ 2. MSAL errors out when app developer opted-in to use broker
+ but a direct dependency "mid-tier" package is not installed.
+ Error message guides app developer to declare the correct dependency
+ ``msal[broker]``.
+ We error out here because the error is actionable to app developers.
+ 3. MSAL silently "deactivates" the broker and fallback to non-broker,
+ when opted-in, dependency installed yet failed to initialize.
+ We anticipate this would happen on a device whose OS is too old
+ or the underlying broker component is somehow unavailable.
+ There is not much an app developer or the end user can do here.
+ Eventually, the conditional access policy shall
+ force the user to switch to a different device.
+ 4. MSAL errors out when broker is opted in, installed, initialized,
+ but subsequent token request(s) failed.
+
+ :param boolean enable_broker_on_windows:
+ This setting is only effective if your app is running on Windows 10+.
+ This parameter defaults to None, which means MSAL will not utilize a broker.
+
+ New in MSAL Python 1.25.0.
+
+ :param boolean enable_broker_on_mac:
+ This setting is only effective if your app is running on Mac.
+ This parameter defaults to None, which means MSAL will not utilize a broker.
+
+ New in MSAL Python 1.31.0.
+ """
+ if client_credential is not None:
+ raise ValueError("Public Client should not possess credentials")
+ # Using kwargs notation for now. We will switch to keyword-only arguments.
+ enable_broker_on_windows = kwargs.pop("enable_broker_on_windows", False)
+ enable_broker_on_mac = kwargs.pop("enable_broker_on_mac", False)
+ self._enable_broker = bool(
+ enable_broker_on_windows and sys.platform == "win32"
+ or enable_broker_on_mac and sys.platform == "darwin")
+ super(PublicClientApplication, self).__init__(
+ client_id, client_credential=None, **kwargs)
+
+ def acquire_token_interactive(
+ self,
+ scopes, # type: list[str]
+ prompt=None,
+ login_hint=None, # type: Optional[str]
+ domain_hint=None, # type: Optional[str]
+ claims_challenge=None,
+ timeout=None,
+ port=None,
+ extra_scopes_to_consent=None,
+ max_age=None,
+ parent_window_handle=None,
+ on_before_launching_ui=None,
+ auth_scheme=None,
+ **kwargs):
+ """Acquire token interactively i.e. via a local browser.
+
+ Prerequisite: In Azure Portal, configure the Redirect URI of your
+ "Mobile and Desktop application" as ``http://localhost``.
+ If you opts in to use broker during ``PublicClientApplication`` creation,
+ your app also need this Redirect URI:
+ ``ms-appx-web://Microsoft.AAD.BrokerPlugin/YOUR_CLIENT_ID``
+
+ :param list scopes:
+ It is a list of case-sensitive strings.
+ :param str prompt:
+ By default, no prompt value will be sent, not even string ``"none"``.
+ You will have to specify a value explicitly.
+ Its valid values are the constants defined in
+ :class:`Prompt `.
+ :param str login_hint:
+ Optional. Identifier of the user. Generally a User Principal Name (UPN).
+ :param domain_hint:
+ Can be one of "consumers" or "organizations" or your tenant domain "contoso.com".
+ If included, it will skip the email-based discovery process that user goes
+ through on the sign-in page, leading to a slightly more streamlined user experience.
+ More information on possible values available in
+ `Auth Code Flow doc `_ and
+ `domain_hint doc `_.
+
+ :param claims_challenge:
+ The claims_challenge parameter requests specific claims requested by the resource provider
+ in the form of a claims_challenge directive in the www-authenticate header to be
+ returned from the UserInfo Endpoint and/or in the ID Token and/or Access Token.
+ It is a string of a JSON object which contains lists of claims being requested from these locations.
+
+ :param int timeout:
+ This method will block the current thread.
+ This parameter specifies the timeout value in seconds.
+ Default value ``None`` means wait indefinitely.
+
+ :param int port:
+ The port to be used to listen to an incoming auth response.
+ By default we will use a system-allocated port.
+ (The rest of the redirect_uri is hard coded as ``http://localhost``.)
+
+ :param list extra_scopes_to_consent:
+ "Extra scopes to consent" is a concept only available in Microsoft Entra.
+ It refers to other resources you might want to prompt to consent for,
+ in the same interaction, but for which you won't get back a
+ token for in this particular operation.
+
+ :param int max_age:
+ OPTIONAL. Maximum Authentication Age.
+ Specifies the allowable elapsed time in seconds
+ since the last time the End-User was actively authenticated.
+ If the elapsed time is greater than this value,
+ Microsoft identity platform will actively re-authenticate the End-User.
+
+ MSAL Python will also automatically validate the auth_time in ID token.
+
+ New in version 1.15.
+
+ :param int parent_window_handle:
+ OPTIONAL.
+
+ * If your app does not opt in to use broker,
+ you do not need to provide a ``parent_window_handle`` here.
+
+ * If your app opts in to use broker,
+ ``parent_window_handle`` is required.
+
+ - If your app is a GUI app running on Windows or Mac system,
+ you are required to also provide its window handle,
+ so that the sign-in window will pop up on top of your window.
+ - If your app is a console app running on Windows or Mac system,
+ you can use a placeholder
+ ``PublicClientApplication.CONSOLE_WINDOW_HANDLE``.
+
+ Most Python scripts are console apps.
+
+ New in version 1.20.0.
+
+ :param function on_before_launching_ui:
+ A callback with the form of
+ ``lambda ui="xyz", **kwargs: print("A {} will be launched".format(ui))``,
+ where ``ui`` will be either "browser" or "broker".
+ You can use it to inform your end user to expect a pop-up window.
+
+ New in version 1.20.0.
+
+ :param object auth_scheme:
+ You can provide an ``msal.auth_scheme.PopAuthScheme`` object
+ so that MSAL will get a Proof-of-Possession (POP) token for you.
+
+ New in version 1.26.0.
+
+ :return:
+ - A dict containing no "error" key,
+ and typically contains an "access_token" key.
+ - A dict containing an "error" key, when token refresh failed.
+ """
+ data = kwargs.pop("data", {})
+ enable_msa_passthrough = kwargs.pop( # MUST remove it from kwargs
+ "enable_msa_passthrough", # Keep it as a hidden param, for now.
+ # OPTIONAL. MSA-Passthrough is a legacy configuration,
+ # needed by a small amount of Microsoft first-party apps,
+ # which would login MSA accounts via ".../organizations" authority.
+ # If you app belongs to this category, AND you are enabling broker,
+ # you would want to enable this flag. Default value is False.
+ # More background of MSA-PT is available from this internal docs:
+ # https://microsoft.sharepoint.com/:w:/t/Identity-DevEx/EatIUauX3c9Ctw1l7AQ6iM8B5CeBZxc58eoQCE0IuZ0VFw?e=tgc3jP&CID=39c853be-76ea-79d7-ee73-f1b2706ede05
+ False
+ ) and data.get("token_type") != "ssh-cert" # Work around a known issue as of PyMsalRuntime 0.8
+ self._validate_ssh_cert_input_data(data)
+ if not on_before_launching_ui:
+ on_before_launching_ui = lambda **kwargs: None
+ if _is_running_in_cloud_shell() and prompt == "none":
+ # Note: _acquire_token_by_cloud_shell() is always silent,
+ # so we would not fire on_before_launching_ui()
+ return self._acquire_token_by_cloud_shell(scopes, data=data)
+ claims = _merge_claims_challenge_and_capabilities(
+ self._client_capabilities, claims_challenge)
+ if self._enable_broker:
+ if parent_window_handle is None:
+ raise ValueError(
+ "parent_window_handle is required when you opted into using broker. "
+ "You need to provide the window handle of your GUI application, "
+ "or use msal.PublicClientApplication.CONSOLE_WINDOW_HANDLE "
+ "when and only when your application is a console app.")
+ if extra_scopes_to_consent:
+ logger.warning(
+ "Ignoring parameter extra_scopes_to_consent, "
+ "which is not supported by broker")
+ response = self._acquire_token_interactive_via_broker(
+ scopes,
+ parent_window_handle,
+ enable_msa_passthrough,
+ claims,
+ data,
+ on_before_launching_ui,
+ auth_scheme,
+ prompt=prompt,
+ login_hint=login_hint,
+ max_age=max_age,
+ )
+ return self._process_broker_response(response, scopes, data)
+
+ if auth_scheme:
+ raise ValueError(self._AUTH_SCHEME_UNSUPPORTED)
+ on_before_launching_ui(ui="browser")
+ telemetry_context = self._build_telemetry_context(
+ self.ACQUIRE_TOKEN_INTERACTIVE)
+ response = _clean_up(self.client.obtain_token_by_browser(
+ scope=self._decorate_scope(scopes) if scopes else None,
+ extra_scope_to_consent=extra_scopes_to_consent,
+ redirect_uri="http://localhost:{port}".format(
+ # Hardcode the host, for now. AAD portal rejects 127.0.0.1 anyway
+ port=port or 0),
+ prompt=prompt,
+ login_hint=login_hint,
+ max_age=max_age,
+ timeout=timeout,
+ auth_params={
+ "claims": claims,
+ "domain_hint": domain_hint,
+ },
+ data=dict(data, claims=claims),
+ headers=telemetry_context.generate_headers(),
+ browser_name=_preferred_browser(),
+ **kwargs))
+ if "access_token" in response:
+ response[self._TOKEN_SOURCE] = self._TOKEN_SOURCE_IDP
+ telemetry_context.update_telemetry(response)
+ return response
+
+ def _acquire_token_interactive_via_broker(
+ self,
+ scopes, # type: list[str]
+ parent_window_handle, # type: int
+ enable_msa_passthrough, # type: boolean
+ claims, # type: str
+ data, # type: dict
+ on_before_launching_ui, # type: callable
+ auth_scheme, # type: object
+ prompt=None,
+ login_hint=None, # type: Optional[str]
+ max_age=None,
+ **kwargs):
+ from .broker import _signin_interactively, _signin_silently, _acquire_token_silently
+ if "welcome_template" in kwargs:
+ logger.debug(kwargs["welcome_template"]) # Experimental
+ authority = "https://{}/{}".format(
+ self.authority.instance, self.authority.tenant)
+ validate_authority = "no" if (
+ self.authority._is_known_to_developer
+ or self._instance_discovery is False) else None
+ # Calls different broker methods to mimic the OIDC behaviors
+ if login_hint and prompt != "select_account": # OIDC prompts when the user did not sign in
+ accounts = self.get_accounts(username=login_hint)
+ if len(accounts) == 1: # Unambiguously proceed with this account
+ logger.debug("Calling broker._acquire_token_silently()")
+ response = _acquire_token_silently( # When it works, it bypasses prompt
+ authority,
+ self.client_id,
+ accounts[0]["local_account_id"],
+ scopes,
+ claims=claims,
+ auth_scheme=auth_scheme,
+ **data)
+ if response and "error" not in response:
+ return response
+ # login_hint undecisive or not exists
+ if prompt == "none" or not prompt: # Must/Can attempt _signin_silently()
+ logger.debug("Calling broker._signin_silently()")
+ response = _signin_silently( # Unlike OIDC, it doesn't honor login_hint
+ authority, self.client_id, scopes,
+ validateAuthority=validate_authority,
+ claims=claims,
+ max_age=max_age,
+ enable_msa_pt=enable_msa_passthrough,
+ auth_scheme=auth_scheme,
+ **data)
+ is_wrong_account = bool(
+ # _signin_silently() only gets tokens for default account,
+ # but this seems to have been fixed in PyMsalRuntime 0.11.2
+ "access_token" in response and login_hint
+ and response.get("id_token_claims", {}) != login_hint)
+ wrong_account_error_message = (
+ 'prompt="none" will not work for login_hint="non-default-user"')
+ if is_wrong_account:
+ logger.debug(wrong_account_error_message)
+ if prompt == "none":
+ return response if not is_wrong_account else {
+ "error": "broker_error",
+ "error_description": wrong_account_error_message,
+ }
+ else:
+ assert bool(prompt) is False
+ from pymsalruntime import Response_Status
+ recoverable_errors = frozenset([
+ Response_Status.Status_AccountUnusable,
+ Response_Status.Status_InteractionRequired,
+ ])
+ if is_wrong_account or "error" in response and response.get(
+ "_broker_status") in recoverable_errors:
+ pass # It will fall back to the _signin_interactively()
+ else:
+ return response
+
+ logger.debug("Falls back to broker._signin_interactively()")
+ on_before_launching_ui(ui="broker")
+ return _signin_interactively(
+ authority, self.client_id, scopes,
+ None if parent_window_handle is self.CONSOLE_WINDOW_HANDLE
+ else parent_window_handle,
+ validateAuthority=validate_authority,
+ login_hint=login_hint,
+ prompt=prompt,
+ claims=claims,
+ max_age=max_age,
+ enable_msa_pt=enable_msa_passthrough,
+ auth_scheme=auth_scheme,
+ **data)
+
+ def initiate_device_flow(self, scopes=None, **kwargs):
+ """Initiate a Device Flow instance,
+ which will be used in :func:`~acquire_token_by_device_flow`.
+
+ :param list[str] scopes:
+ Scopes requested to access a protected API (a resource).
+ :return: A dict representing a newly created Device Flow object.
+
+ - A successful response would contain "user_code" key, among others
+ - an error response would contain some other readable key/value pairs.
+ """
+ correlation_id = msal.telemetry._get_new_correlation_id()
+ flow = self.client.initiate_device_flow(
+ scope=self._decorate_scope(scopes or []),
+ headers={msal.telemetry.CLIENT_REQUEST_ID: correlation_id},
+ **kwargs)
+ flow[self.DEVICE_FLOW_CORRELATION_ID] = correlation_id
+ return flow
+
+ def acquire_token_by_device_flow(self, flow, claims_challenge=None, **kwargs):
+ """Obtain token by a device flow object, with customizable polling effect.
+
+ :param dict flow:
+ A dict previously generated by :func:`~initiate_device_flow`.
+ By default, this method's polling effect will block current thread.
+ You can abort the polling loop at any time,
+ by changing the value of the flow's "expires_at" key to 0.
+ :param claims_challenge:
+ The claims_challenge parameter requests specific claims requested by the resource provider
+ in the form of a claims_challenge directive in the www-authenticate header to be
+ returned from the UserInfo Endpoint and/or in the ID Token and/or Access Token.
+ It is a string of a JSON object which contains lists of claims being requested from these locations.
+
+ :return: A dict representing the json response from Microsoft Entra:
+
+ - A successful response would contain "access_token" key,
+ - an error response would contain "error" and usually "error_description".
+ """
+ telemetry_context = self._build_telemetry_context(
+ self.ACQUIRE_TOKEN_BY_DEVICE_FLOW_ID,
+ correlation_id=flow.get(self.DEVICE_FLOW_CORRELATION_ID))
+ response = _clean_up(self.client.obtain_token_by_device_flow(
+ flow,
+ data=dict(
+ kwargs.pop("data", {}),
+ code=flow["device_code"], # 2018-10-4 Hack:
+ # during transition period,
+ # service seemingly need both device_code and code parameter.
+ claims=_merge_claims_challenge_and_capabilities(
+ self._client_capabilities, claims_challenge),
+ ),
+ headers=telemetry_context.generate_headers(),
+ **kwargs))
+ if "access_token" in response:
+ response[self._TOKEN_SOURCE] = self._TOKEN_SOURCE_IDP
+ telemetry_context.update_telemetry(response)
+ return response
+
+
+class ConfidentialClientApplication(ClientApplication): # server-side web app
+ """Same as :func:`ClientApplication.__init__`,
+ except that ``allow_broker`` parameter shall remain ``None``.
+ """
+
+ def acquire_token_for_client(self, scopes, claims_challenge=None, **kwargs):
+ """Acquires token for the current confidential client, not for an end user.
+
+ Since MSAL Python 1.23, it will automatically look for token from cache,
+ and only send request to Identity Provider when cache misses.
+
+ :param list[str] scopes: (Required)
+ Scopes requested to access a protected API (a resource).
+ :param claims_challenge:
+ The claims_challenge parameter requests specific claims requested by the resource provider
+ in the form of a claims_challenge directive in the www-authenticate header to be
+ returned from the UserInfo Endpoint and/or in the ID Token and/or Access Token.
+ It is a string of a JSON object which contains lists of claims being requested from these locations.
+
+ :return: A dict representing the json response from Microsoft Entra:
+
+ - A successful response would contain "access_token" key,
+ - an error response would contain "error" and usually "error_description".
+ """
+ if kwargs.get("force_refresh"):
+ raise ValueError( # We choose to disallow force_refresh
+ "Historically, this method does not support force_refresh behavior. "
+ )
+ return _clean_up(self._acquire_token_silent_with_error(
+ scopes, None, claims_challenge=claims_challenge, **kwargs))
+
+ def _acquire_token_for_client(
+ self,
+ scopes,
+ refresh_reason,
+ claims_challenge=None,
+ **kwargs
+ ):
+ if self.authority.tenant.lower() in ["common", "organizations"]:
+ warnings.warn(
+ "Using /common or /organizations authority "
+ "in acquire_token_for_client() is unreliable. "
+ "Please use a specific tenant instead.", DeprecationWarning)
+ self._validate_ssh_cert_input_data(kwargs.get("data", {}))
+ telemetry_context = self._build_telemetry_context(
+ self.ACQUIRE_TOKEN_FOR_CLIENT_ID, refresh_reason=refresh_reason)
+ client = self._regional_client or self.client
+ response = client.obtain_token_for_client(
+ scope=scopes, # This grant flow requires no scope decoration
+ headers=telemetry_context.generate_headers(),
+ data=dict(
+ kwargs.pop("data", {}),
+ claims=_merge_claims_challenge_and_capabilities(
+ self._client_capabilities, claims_challenge)),
+ **kwargs)
+ telemetry_context.update_telemetry(response)
+ return response
+
+ def remove_tokens_for_client(self):
+ """Remove all tokens that were previously acquired via
+ :func:`~acquire_token_for_client()` for the current client."""
+ for env in [self.authority.instance] + self._get_authority_aliases(
+ self.authority.instance):
+ for at in list(self.token_cache.search( # Remove ATs from a snapshot
+ TokenCache.CredentialType.ACCESS_TOKEN, query={
+ "client_id": self.client_id,
+ "environment": env,
+ "home_account_id": None, # These are mostly app-only tokens
+ })):
+ self.token_cache.remove_at(at)
+ # acquire_token_for_client() obtains no RTs, so we have no RT to remove
+
+ def acquire_token_on_behalf_of(self, user_assertion, scopes, claims_challenge=None, **kwargs):
+ """Acquires token using on-behalf-of (OBO) flow.
+
+ The current app is a middle-tier service which was called with a token
+ representing an end user.
+ The current app can use such token (a.k.a. a user assertion) to request
+ another token to access downstream web API, on behalf of that user.
+ See `detail docs here `_ .
+
+ The current middle-tier app has no user interaction to obtain consent.
+ See how to gain consent upfront for your middle-tier app from this article.
+ https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-oauth2-on-behalf-of-flow#gaining-consent-for-the-middle-tier-application
+
+ :param str user_assertion: The incoming token already received by this app
+ :param list[str] scopes: Scopes required by downstream API (a resource).
+ :param claims_challenge:
+ The claims_challenge parameter requests specific claims requested by the resource provider
+ in the form of a claims_challenge directive in the www-authenticate header to be
+ returned from the UserInfo Endpoint and/or in the ID Token and/or Access Token.
+ It is a string of a JSON object which contains lists of claims being requested from these locations.
+
+ :return: A dict representing the json response from Microsoft Entra:
+
+ - A successful response would contain "access_token" key,
+ - an error response would contain "error" and usually "error_description".
+ """
+ telemetry_context = self._build_telemetry_context(
+ self.ACQUIRE_TOKEN_ON_BEHALF_OF_ID)
+ # The implementation is NOT based on Token Exchange (RFC 8693)
+ response = _clean_up(self.client.obtain_token_by_assertion( # bases on assertion RFC 7521
+ user_assertion,
+ self.client.GRANT_TYPE_JWT, # IDTs and AAD ATs are all JWTs
+ scope=self._decorate_scope(scopes), # Decoration is used for:
+ # 1. Explicitly requesting an RT, without relying on AAD default
+ # behavior, even though it currently still issues an RT.
+ # 2. Requesting an IDT (which would otherwise be unavailable)
+ # so that the calling app could use id_token_claims to implement
+ # their own cache mapping, which is likely needed in web apps.
+ data=dict(
+ kwargs.pop("data", {}),
+ requested_token_use="on_behalf_of",
+ claims=_merge_claims_challenge_and_capabilities(
+ self._client_capabilities, claims_challenge)),
+ headers=telemetry_context.generate_headers(),
+ # TBD: Expose a login_hint (or ccs_routing_hint) param for web app
+ **kwargs))
+ if "access_token" in response:
+ response[self._TOKEN_SOURCE] = self._TOKEN_SOURCE_IDP
+ telemetry_context.update_telemetry(response)
+ return response
diff --git a/msal/auth_scheme.py b/msal/auth_scheme.py
new file mode 100644
index 00000000..841adab3
--- /dev/null
+++ b/msal/auth_scheme.py
@@ -0,0 +1,34 @@
+try:
+ from urllib.parse import urlparse
+except ImportError: # Fall back to Python 2
+ from urlparse import urlparse
+
+# We may support more auth schemes in the future
+class PopAuthScheme(object):
+ HTTP_GET = "GET"
+ HTTP_POST = "POST"
+ HTTP_PUT = "PUT"
+ HTTP_DELETE = "DELETE"
+ HTTP_PATCH = "PATCH"
+ _HTTP_METHODS = (HTTP_GET, HTTP_POST, HTTP_PUT, HTTP_DELETE, HTTP_PATCH)
+ # Internal design: https://identitydivision.visualstudio.com/DevEx/_git/AuthLibrariesApiReview?path=/PoPTokensProtocol/PopTokensProtocol.md
+ def __init__(self, http_method=None, url=None, nonce=None):
+ """Create an auth scheme which is needed to obtain a Proof-of-Possession token.
+
+ :param str http_method:
+ Its value is an uppercase http verb, such as "GET" and "POST".
+ :param str url:
+ The url to be signed.
+ :param str nonce:
+ The nonce came from resource's challenge.
+ """
+ if not (http_method and url and nonce):
+ # In the future, we may also support accepting an http_response as input
+ raise ValueError("All http_method, url and nonce are required parameters")
+ if http_method not in self._HTTP_METHODS:
+ raise ValueError("http_method must be uppercase, according to "
+ "https://datatracker.ietf.org/doc/html/draft-ietf-oauth-signed-http-request-03#section-3")
+ self._http_method = http_method
+ self._url = urlparse(url)
+ self._nonce = nonce
+
diff --git a/msal/authority.py b/msal/authority.py
new file mode 100644
index 00000000..faf11603
--- /dev/null
+++ b/msal/authority.py
@@ -0,0 +1,225 @@
+import json
+try:
+ from urllib.parse import urlparse
+except ImportError: # Fall back to Python 2
+ from urlparse import urlparse
+import logging
+
+
+logger = logging.getLogger(__name__)
+
+# Endpoints were copied from here
+# https://docs.microsoft.com/en-us/azure/active-directory/develop/authentication-national-cloud#azure-ad-authentication-endpoints
+AZURE_US_GOVERNMENT = "login.microsoftonline.us"
+AZURE_CHINA = "login.chinacloudapi.cn"
+AZURE_PUBLIC = "login.microsoftonline.com"
+
+WORLD_WIDE = 'login.microsoftonline.com' # There was an alias login.windows.net
+WELL_KNOWN_AUTHORITY_HOSTS = set([
+ WORLD_WIDE,
+ AZURE_CHINA,
+ 'login-us.microsoftonline.com',
+ AZURE_US_GOVERNMENT,
+ ])
+WELL_KNOWN_B2C_HOSTS = [
+ "b2clogin.com",
+ "b2clogin.cn",
+ "b2clogin.us",
+ "b2clogin.de",
+ "ciamlogin.com",
+ ]
+_CIAM_DOMAIN_SUFFIX = ".ciamlogin.com"
+
+
+class AuthorityBuilder(object):
+ def __init__(self, instance, tenant):
+ """A helper to save caller from doing string concatenation.
+
+ Usage is documented in :func:`application.ClientApplication.__init__`.
+ """
+ self._instance = instance.rstrip("/")
+ self._tenant = tenant.strip("/")
+
+ def __str__(self):
+ return "https://{}/{}".format(self._instance, self._tenant)
+
+
+class Authority(object):
+ """This class represents an (already-validated) authority.
+
+ Once constructed, it contains members named "*_endpoint" for this instance.
+ TODO: It will also cache the previously-validated authority instances.
+ """
+ _domains_without_user_realm_discovery = set([])
+
+ def __init__(
+ self, authority_url, http_client,
+ validate_authority=True,
+ instance_discovery=None,
+ oidc_authority_url=None,
+ ):
+ """Creates an authority instance, and also validates it.
+
+ :param validate_authority:
+ The Authority validation process actually checks two parts:
+ instance (a.k.a. host) and tenant. We always do a tenant discovery.
+ This parameter only controls whether an instance discovery will be
+ performed.
+ """
+ self._http_client = http_client
+ if oidc_authority_url:
+ logger.debug("Initializing with OIDC authority: %s", oidc_authority_url)
+ tenant_discovery_endpoint = self._initialize_oidc_authority(
+ oidc_authority_url)
+ else:
+ logger.debug("Initializing with Entra authority: %s", authority_url)
+ tenant_discovery_endpoint = self._initialize_entra_authority(
+ authority_url, validate_authority, instance_discovery)
+ try:
+ openid_config = tenant_discovery(
+ tenant_discovery_endpoint,
+ self._http_client)
+ except ValueError:
+ error_message = (
+ "Unable to get OIDC authority configuration for {url} "
+ "because its OIDC Discovery endpoint is unavailable at "
+ "{url}/.well-known/openid-configuration ".format(url=oidc_authority_url)
+ if oidc_authority_url else
+ "Unable to get authority configuration for {}. "
+ "Authority would typically be in a format of "
+ "https://login.microsoftonline.com/your_tenant "
+ "or https://tenant_name.ciamlogin.com "
+ "or https://tenant_name.b2clogin.com/tenant.onmicrosoft.com/policy. "
+ .format(authority_url)
+ ) + " Also please double check your tenant name or GUID is correct."
+ raise ValueError(error_message)
+ logger.debug(
+ 'openid_config("%s") = %s', tenant_discovery_endpoint, openid_config)
+ self.authorization_endpoint = openid_config['authorization_endpoint']
+ self.token_endpoint = openid_config['token_endpoint']
+ self.device_authorization_endpoint = openid_config.get('device_authorization_endpoint')
+ _, _, self.tenant = canonicalize(self.token_endpoint) # Usually a GUID
+
+ def _initialize_oidc_authority(self, oidc_authority_url):
+ authority, self.instance, tenant = canonicalize(oidc_authority_url)
+ self.is_adfs = tenant.lower() == 'adfs' # As a convention
+ self._is_b2c = True # Not exactly true, but
+ # OIDC Authority was designed for CIAM which is the next gen of B2C.
+ # Besides, application.py uses this to bypass broker.
+ self._is_known_to_developer = True # Not really relevant, but application.py uses this to bypass authority validation
+ return oidc_authority_url + "/.well-known/openid-configuration"
+
+ def _initialize_entra_authority(
+ self, authority_url, validate_authority, instance_discovery):
+ # :param instance_discovery:
+ # By default, the known-to-Microsoft validation will use an
+ # instance discovery endpoint located at ``login.microsoftonline.com``.
+ # You can customize the endpoint by providing a url as a string.
+ # Or you can turn this behavior off by passing in a False here.
+ if isinstance(authority_url, AuthorityBuilder):
+ authority_url = str(authority_url)
+ authority, self.instance, tenant = canonicalize(authority_url)
+ is_ciam = self.instance.endswith(_CIAM_DOMAIN_SUFFIX)
+ self.is_adfs = tenant.lower() == 'adfs' and not is_ciam
+ parts = authority.path.split('/')
+ self._is_b2c = any(
+ self.instance.endswith("." + d) for d in WELL_KNOWN_B2C_HOSTS
+ ) or (len(parts) == 3 and parts[2].lower().startswith("b2c_"))
+ self._is_known_to_developer = self.is_adfs or self._is_b2c or not validate_authority
+ is_known_to_microsoft = self.instance in WELL_KNOWN_AUTHORITY_HOSTS
+ instance_discovery_endpoint = 'https://{}/common/discovery/instance'.format( # Note: This URL seemingly returns V1 endpoint only
+ WORLD_WIDE # Historically using WORLD_WIDE. Could use self.instance too
+ # See https://github.com/AzureAD/microsoft-authentication-library-for-dotnet/blob/4.0.0/src/Microsoft.Identity.Client/Instance/AadInstanceDiscovery.cs#L101-L103
+ # and https://github.com/AzureAD/microsoft-authentication-library-for-dotnet/blob/4.0.0/src/Microsoft.Identity.Client/Instance/AadAuthority.cs#L19-L33
+ ) if instance_discovery in (None, True) else instance_discovery
+ if instance_discovery_endpoint and not (
+ is_known_to_microsoft or self._is_known_to_developer):
+ payload = _instance_discovery(
+ "https://{}{}/oauth2/v2.0/authorize".format(
+ self.instance, authority.path),
+ self._http_client,
+ instance_discovery_endpoint)
+ if payload.get("error") == "invalid_instance":
+ raise ValueError(
+ "invalid_instance: "
+ "The authority you provided, %s, is not whitelisted. "
+ "If it is indeed your legit customized domain name, "
+ "you can turn off this check by passing in "
+ "instance_discovery=False"
+ % authority_url)
+ tenant_discovery_endpoint = payload['tenant_discovery_endpoint']
+ else:
+ tenant_discovery_endpoint = authority._replace(
+ path="{prefix}{version}/.well-known/openid-configuration".format(
+ prefix=tenant if is_ciam and len(authority.path) <= 1 # Path-less CIAM
+ else authority.path, # In B2C, it is "/tenant/policy"
+ version="" if self.is_adfs else "/v2.0",
+ )
+ ).geturl() # Keeping original port and query. Query is useful for test.
+ return tenant_discovery_endpoint
+
+ def user_realm_discovery(self, username, correlation_id=None, response=None):
+ # It will typically return a dict containing "ver", "account_type",
+ # "federation_protocol", "cloud_audience_urn",
+ # "federation_metadata_url", "federation_active_auth_url", etc.
+ if self.instance not in self.__class__._domains_without_user_realm_discovery:
+ resp = response or self._http_client.get(
+ "https://{netloc}/common/userrealm/{username}?api-version=1.0".format(
+ netloc=self.instance, username=username),
+ headers={'Accept': 'application/json',
+ 'client-request-id': correlation_id},)
+ if resp.status_code != 404:
+ resp.raise_for_status()
+ return json.loads(resp.text)
+ self.__class__._domains_without_user_realm_discovery.add(self.instance)
+ return {} # This can guide the caller to fall back normal ROPC flow
+
+
+def canonicalize(authority_or_auth_endpoint):
+ # Returns (url_parsed_result, hostname_in_lowercase, tenant)
+ authority = urlparse(authority_or_auth_endpoint)
+ if authority.scheme == "https":
+ parts = authority.path.split("/")
+ first_part = parts[1] if len(parts) >= 2 and parts[1] else None
+ if authority.hostname.endswith(_CIAM_DOMAIN_SUFFIX): # CIAM
+ # Use path in CIAM authority. It will be validated by OIDC Discovery soon
+ tenant = first_part if first_part else "{}.onmicrosoft.com".format(
+ # Fallback to sub domain name. This variation may not be advertised
+ authority.hostname.rsplit(_CIAM_DOMAIN_SUFFIX, 1)[0])
+ return authority, authority.hostname, tenant
+ # AAD
+ if len(parts) >= 2 and parts[1]:
+ return authority, authority.hostname, parts[1]
+ raise ValueError(
+ "Your given address (%s) should consist of "
+ "an https url with a minimum of one segment in a path: e.g. "
+ "https://login.microsoftonline.com/{tenant} "
+ "or https://{tenant_name}.ciamlogin.com/{tenant} "
+ "or https://{tenant_name}.b2clogin.com/{tenant_name}.onmicrosoft.com/policy"
+ % authority_or_auth_endpoint)
+
+def _instance_discovery(url, http_client, instance_discovery_endpoint, **kwargs):
+ resp = http_client.get(
+ instance_discovery_endpoint,
+ params={'authorization_endpoint': url, 'api-version': '1.0'},
+ **kwargs)
+ return json.loads(resp.text)
+
+def tenant_discovery(tenant_discovery_endpoint, http_client, **kwargs):
+ # Returns Openid Configuration
+ resp = http_client.get(tenant_discovery_endpoint, **kwargs)
+ if resp.status_code == 200:
+ return json.loads(resp.text) # It could raise ValueError
+ if 400 <= resp.status_code < 500:
+ # Nonexist tenant would hit this path
+ # e.g. https://login.microsoftonline.com/nonexist_tenant/v2.0/.well-known/openid-configuration
+ raise ValueError("OIDC Discovery failed on {}. HTTP status: {}, Error: {}".format(
+ tenant_discovery_endpoint,
+ resp.status_code,
+ resp.text, # Expose it as-is b/c OIDC defines no error response format
+ ))
+ # Transient network error would hit this path
+ resp.raise_for_status()
+ raise RuntimeError( # A fallback here, in case resp.raise_for_status() is no-op
+ "Unable to complete OIDC Discovery: %d, %s" % (resp.status_code, resp.text))
+
diff --git a/msal/broker.py b/msal/broker.py
new file mode 100644
index 00000000..e16e6102
--- /dev/null
+++ b/msal/broker.py
@@ -0,0 +1,265 @@
+"""This module is an adaptor to the underlying broker.
+It relies on PyMsalRuntime which is the package providing broker's functionality.
+"""
+import json
+import logging
+import sys
+import time
+import uuid
+
+
+logger = logging.getLogger(__name__)
+try:
+ import pymsalruntime # Its API description is available in site-packages/pymsalruntime/PyMsalRuntime.pyi
+ pymsalruntime.register_logging_callback(lambda message, level: { # New in pymsalruntime 0.7
+ pymsalruntime.LogLevel.TRACE: logger.debug, # Python has no TRACE level
+ pymsalruntime.LogLevel.DEBUG: logger.debug,
+ # Let broker's excess info, warning and error logs map into default DEBUG, for now
+ #pymsalruntime.LogLevel.INFO: logger.info,
+ #pymsalruntime.LogLevel.WARNING: logger.warning,
+ #pymsalruntime.LogLevel.ERROR: logger.error,
+ pymsalruntime.LogLevel.FATAL: logger.critical,
+ }.get(level, logger.debug)(message))
+except (ImportError, AttributeError): # AttributeError happens when a prior pymsalruntime uninstallation somehow leaved an empty folder behind
+ # PyMsalRuntime currently supports these Windows versions, listed in this MSFT internal link
+ # https://github.com/AzureAD/microsoft-authentication-library-for-cpp/pull/2406/files
+ raise ImportError('You need to install dependency by: pip install "msal[broker]>=1.20,<2"')
+# It could throw RuntimeError when running on ancient versions of Windows
+
+
+class RedirectUriError(ValueError):
+ pass
+
+
+class TokenTypeError(ValueError):
+ pass
+
+
+_redirect_uri_on_mac = "msauth.com.msauth.unsignedapp://auth" # Note:
+ # On Mac, the native Python has a team_id which links to bundle id
+ # com.apple.python3 however it won't give Python scripts better security.
+ # Besides, the homebrew-installed Pythons have no team_id
+ # so they have to use a generic placeholder anyway.
+ # The v-team chose to combine two situations into using same placeholder.
+
+
+def _convert_error(error, client_id):
+ context = error.get_context() # Available since pymsalruntime 0.0.4
+ if (
+ "AADSTS50011" in context # In WAM, this could happen on both interactive and silent flows
+ or "AADSTS7000218" in context # This "request body must contain ... client_secret" is just a symptom of current app has no WAM redirect_uri
+ ):
+ raise RedirectUriError( # This would be seen by either the app developer or end user
+ "MsalRuntime needs the current app to register these redirect_uri "
+ "(1) ms-appx-web://Microsoft.AAD.BrokerPlugin/{} (2) {}".format(
+ client_id, _redirect_uri_on_mac))
+ # OTOH, AAD would emit other errors when other error handling branch was hit first,
+ # so, the AADSTS50011/RedirectUriError is not guaranteed to happen.
+ return {
+ "error": "broker_error", # Note: Broker implies your device needs to be compliant.
+ # You may use "dsregcmd /status" to check your device state
+ # https://docs.microsoft.com/en-us/azure/active-directory/devices/troubleshoot-device-dsregcmd
+ "error_description": "{}. Status: {}, Error code: {}, Tag: {}".format(
+ context,
+ error.get_status(), error.get_error_code(), error.get_tag()),
+ "_broker_status": error.get_status(),
+ "_broker_error_code": error.get_error_code(),
+ "_broker_tag": error.get_tag(),
+ }
+
+
+def _read_account_by_id(account_id, correlation_id):
+ """Return an instance of MSALRuntimeError or MSALRuntimeAccount, or None"""
+ callback_data = pymsalruntime.CallbackData()
+ pymsalruntime.read_account_by_id(
+ account_id,
+ correlation_id,
+ lambda result, callback_data=callback_data: callback_data.complete(result)
+ )
+ callback_data.signal.wait()
+ error = callback_data.result.get_error()
+ if error:
+ logger.debug("read_account_by_id() error: %s", _convert_error(error, None))
+ return None
+ account = callback_data.result.get_account()
+ if account:
+ return account
+ return None # None happens when the account was not created by broker
+
+
+def _convert_result(result, client_id, expected_token_type=None): # Mimic an on-the-wire response from AAD
+ telemetry = result.get_telemetry_data()
+ telemetry.pop("wam_telemetry", None) # In pymsalruntime 0.13, it contains PII "account_id"
+ error = result.get_error()
+ if error:
+ return dict(_convert_error(error, client_id), _msalruntime_telemetry=telemetry)
+ id_token_claims = json.loads(result.get_id_token()) if result.get_id_token() else {}
+ account = result.get_account()
+ assert account, "Account is expected to be always available"
+ # Note: There are more account attribute getters available in pymsalruntime 0.13+
+ return_value = {k: v for k, v in {
+ "access_token":
+ result.get_authorization_header() # It returns "pop SignedHttpRequest"
+ .split()[1]
+ if result.is_pop_authorization() else result.get_access_token(),
+ "expires_in": result.get_access_token_expiry_time() - int(time.time()), # Convert epoch to count-down
+ "id_token": result.get_raw_id_token(), # New in pymsalruntime 0.8.1
+ "id_token_claims": id_token_claims,
+ "client_info": account.get_client_info(),
+ "_account_id": account.get_account_id(),
+ "token_type": "pop" if result.is_pop_authorization() else (
+ expected_token_type or "bearer"), # Workaround "ssh-cert"'s absence from broker
+ }.items() if v}
+ likely_a_cert = return_value["access_token"].startswith("AAAA") # Empirical observation
+ if return_value["token_type"].lower() == "ssh-cert" and not likely_a_cert:
+ raise TokenTypeError("Broker could not get an SSH Cert: {}...".format(
+ return_value["access_token"][:8]))
+ granted_scopes = result.get_granted_scopes() # New in pymsalruntime 0.3.x
+ if granted_scopes:
+ return_value["scope"] = " ".join(granted_scopes) # Mimic the on-the-wire data format
+ return dict(return_value, _msalruntime_telemetry=telemetry)
+
+
+def _get_new_correlation_id():
+ return str(uuid.uuid4())
+
+
+def _enable_msa_pt(params):
+ params.set_additional_parameter("msal_request_type", "consumer_passthrough") # PyMsalRuntime 0.8+
+
+
+def _signin_silently(
+ authority, client_id, scopes, correlation_id=None, claims=None,
+ enable_msa_pt=False,
+ auth_scheme=None,
+ **kwargs):
+ params = pymsalruntime.MSALRuntimeAuthParameters(client_id, authority)
+ params.set_requested_scopes(scopes)
+ if claims:
+ params.set_decoded_claims(claims)
+ if auth_scheme:
+ params.set_pop_params(
+ auth_scheme._http_method, auth_scheme._url.netloc, auth_scheme._url.path,
+ auth_scheme._nonce)
+ callback_data = pymsalruntime.CallbackData()
+ for k, v in kwargs.items(): # This can be used to support domain_hint, max_age, etc.
+ if v is not None:
+ params.set_additional_parameter(k, str(v))
+ if enable_msa_pt:
+ _enable_msa_pt(params)
+ pymsalruntime.signin_silently(
+ params,
+ correlation_id or _get_new_correlation_id(),
+ lambda result, callback_data=callback_data: callback_data.complete(result))
+ callback_data.signal.wait()
+ return _convert_result(
+ callback_data.result, client_id, expected_token_type=kwargs.get("token_type"))
+
+
+def _signin_interactively(
+ authority, client_id, scopes,
+ parent_window_handle, # None means auto-detect for console apps
+ prompt=None, # Note: This function does not really use this parameter
+ login_hint=None,
+ claims=None,
+ correlation_id=None,
+ enable_msa_pt=False,
+ auth_scheme=None,
+ **kwargs):
+ params = pymsalruntime.MSALRuntimeAuthParameters(client_id, authority)
+ params.set_requested_scopes(scopes)
+ params.set_redirect_uri(
+ _redirect_uri_on_mac if sys.platform == "darwin" else
+ "https://login.microsoftonline.com/common/oauth2/nativeclient"
+ # This default redirect_uri value is not currently used by WAM
+ # but it is required by the MSAL.cpp to be set to a non-empty valid URI.
+ )
+ if prompt:
+ if prompt == "select_account":
+ if login_hint:
+ # FWIW, AAD's browser interactive flow would honor select_account
+ # and ignore login_hint in such a case.
+ # But pymsalruntime 0.3.x would pop up a meaningless account picker
+ # and then force the account_hint user to re-input password. Not what we want.
+ # https://identitydivision.visualstudio.com/Engineering/_workitems/edit/1744492
+ login_hint = None # Mimicing the AAD behavior
+ logger.warning("Using both select_account and login_hint is ambiguous. Ignoring login_hint.")
+ else:
+ logger.warning("prompt=%s is not supported by this module", prompt)
+ if parent_window_handle is None:
+ # This fixes account picker hanging in IDE debug mode on some machines
+ params.set_additional_parameter("msal_gui_thread", "true") # Since pymsalruntime 0.8.1
+ if enable_msa_pt:
+ _enable_msa_pt(params)
+ if auth_scheme:
+ params.set_pop_params(
+ auth_scheme._http_method, auth_scheme._url.netloc, auth_scheme._url.path,
+ auth_scheme._nonce)
+ for k, v in kwargs.items(): # This can be used to support domain_hint, max_age, etc.
+ if v is not None:
+ params.set_additional_parameter(k, str(v))
+ if claims:
+ params.set_decoded_claims(claims)
+ callback_data = pymsalruntime.CallbackData(is_interactive=True)
+ pymsalruntime.signin_interactively(
+ parent_window_handle or pymsalruntime.get_console_window() or pymsalruntime.get_desktop_window(), # Since pymsalruntime 0.2+
+ params,
+ correlation_id or _get_new_correlation_id(),
+ login_hint, # None value will be accepted since pymsalruntime 0.3+
+ lambda result, callback_data=callback_data: callback_data.complete(result))
+ callback_data.signal.wait()
+ return _convert_result(
+ callback_data.result, client_id, expected_token_type=kwargs.get("token_type"))
+
+
+def _acquire_token_silently(
+ authority, client_id, account_id, scopes, claims=None, correlation_id=None,
+ auth_scheme=None,
+ **kwargs):
+ # For MSA PT scenario where you use the /organizations, yes,
+ # acquireTokenSilently is expected to fail. - Sam Wilson
+ correlation_id = correlation_id or _get_new_correlation_id()
+ account = _read_account_by_id(account_id, correlation_id)
+ if account is None:
+ return
+ params = pymsalruntime.MSALRuntimeAuthParameters(client_id, authority)
+ params.set_requested_scopes(scopes)
+ if claims:
+ params.set_decoded_claims(claims)
+ if auth_scheme:
+ params.set_pop_params(
+ auth_scheme._http_method, auth_scheme._url.netloc, auth_scheme._url.path,
+ auth_scheme._nonce)
+ for k, v in kwargs.items(): # This can be used to support domain_hint, max_age, etc.
+ if v is not None:
+ params.set_additional_parameter(k, str(v))
+ callback_data = pymsalruntime.CallbackData()
+ pymsalruntime.acquire_token_silently(
+ params,
+ correlation_id,
+ account,
+ lambda result, callback_data=callback_data: callback_data.complete(result))
+ callback_data.signal.wait()
+ return _convert_result(
+ callback_data.result, client_id, expected_token_type=kwargs.get("token_type"))
+
+
+def _signout_silently(client_id, account_id, correlation_id=None):
+ correlation_id = correlation_id or _get_new_correlation_id()
+ account = _read_account_by_id(account_id, correlation_id)
+ if account is None:
+ return
+ callback_data = pymsalruntime.CallbackData()
+ pymsalruntime.signout_silently( # New in PyMsalRuntime 0.7
+ client_id,
+ correlation_id,
+ account,
+ lambda result, callback_data=callback_data: callback_data.complete(result))
+ callback_data.signal.wait()
+ error = callback_data.result.get_error()
+ if error:
+ return _convert_error(error, client_id)
+
+def _enable_pii_log():
+ pymsalruntime.set_is_pii_enabled(1) # New in PyMsalRuntime 0.13.0
+
diff --git a/msal/cloudshell.py b/msal/cloudshell.py
new file mode 100644
index 00000000..f4feaf44
--- /dev/null
+++ b/msal/cloudshell.py
@@ -0,0 +1,122 @@
+# Copyright (c) Microsoft Corporation.
+# All rights reserved.
+#
+# This code is licensed under the MIT License.
+
+"""This module wraps Cloud Shell's IMDS-like interface inside an OAuth2-like helper"""
+import base64
+import json
+import logging
+import os
+import time
+try: # Python 2
+ from urlparse import urlparse
+except: # Python 3
+ from urllib.parse import urlparse
+from .oauth2cli.oidc import decode_part
+
+
+logger = logging.getLogger(__name__)
+
+
+def _is_running_in_cloud_shell():
+ return os.environ.get("AZUREPS_HOST_ENVIRONMENT", "").startswith("cloud-shell")
+
+
+def _scope_to_resource(scope): # This is an experimental reasonable-effort approach
+ cloud_shell_supported_audiences = [
+ "https://analysis.windows.net/powerbi/api", # Came from https://msazure.visualstudio.com/One/_git/compute-CloudShell?path=/src/images/agent/env/envconfig.PROD.json
+ "https://pas.windows.net/CheckMyAccess/Linux/.default", # Cloud Shell accepts it as-is
+ ]
+ for a in cloud_shell_supported_audiences:
+ if scope.startswith(a):
+ return a
+ u = urlparse(scope)
+ if u.scheme:
+ return "{}://{}".format(u.scheme, u.netloc)
+ return scope # There is no much else we can do here
+
+
+def _obtain_token(http_client, scopes, client_id=None, data=None):
+ resp = http_client.post(
+ "http://localhost:50342/oauth2/token",
+ data=dict(
+ data or {},
+ resource=" ".join(map(_scope_to_resource, scopes))),
+ headers={"Metadata": "true"},
+ )
+ if resp.status_code >= 300:
+ logger.debug("Cloud Shell IMDS error: %s", resp.text)
+ cs_error = json.loads(resp.text).get("error", {})
+ return {k: v for k, v in {
+ "error": cs_error.get("code"),
+ "error_description": cs_error.get("message"),
+ }.items() if v}
+ imds_payload = json.loads(resp.text)
+ BEARER = "Bearer"
+ oauth2_response = {
+ "access_token": imds_payload["access_token"],
+ "expires_in": int(imds_payload["expires_in"]),
+ "token_type": imds_payload.get("token_type", BEARER),
+ }
+ expected_token_type = (data or {}).get("token_type", BEARER)
+ if oauth2_response["token_type"] != expected_token_type:
+ return { # Generate a normal error (rather than an intrusive exception)
+ "error": "broker_error",
+ "error_description": "token_type {} is not supported by this version of Azure Portal".format(
+ expected_token_type),
+ }
+ parts = imds_payload["access_token"].split(".")
+
+ # The following default values are useful in SSH Cert scenario
+ client_info = { # Default value, in case the real value will be unavailable
+ "uid": "user",
+ "utid": "cloudshell",
+ }
+ now = time.time()
+ preferred_username = "currentuser@cloudshell"
+ oauth2_response["id_token_claims"] = { # First 5 claims are required per OIDC
+ "iss": "cloudshell",
+ "sub": "user",
+ "aud": client_id,
+ "exp": now + 3600,
+ "iat": now,
+ "preferred_username": preferred_username, # Useful as MSAL account's username
+ }
+
+ if len(parts) == 3: # Probably a JWT. Use it to derive client_info and id token.
+ try:
+ # Data defined in https://docs.microsoft.com/en-us/azure/active-directory/develop/access-tokens#payload-claims
+ jwt_payload = json.loads(decode_part(parts[1]))
+ client_info = {
+ # Mimic a real home_account_id,
+ # so that this pseudo account and a real account would interop.
+ "uid": jwt_payload.get("oid", "user"),
+ "utid": jwt_payload.get("tid", "cloudshell"),
+ }
+ oauth2_response["id_token_claims"] = {
+ "iss": jwt_payload["iss"],
+ "sub": jwt_payload["sub"], # Could use oid instead
+ "aud": client_id,
+ "exp": jwt_payload["exp"],
+ "iat": jwt_payload["iat"],
+ "preferred_username": jwt_payload.get("preferred_username") # V2
+ or jwt_payload.get("unique_name") # V1
+ or preferred_username,
+ }
+ except ValueError:
+ logger.debug("Unable to decode jwt payload: %s", parts[1])
+ oauth2_response["client_info"] = base64.b64encode(
+ # Mimic a client_info, so that MSAL would create an account
+ json.dumps(client_info).encode("utf-8")).decode("utf-8")
+ oauth2_response["id_token_claims"]["tid"] = client_info["utid"] # TBD
+
+ ## Note: Decided to not surface resource back as scope,
+ ## because they would cause the downstream OAuth2 code path to
+ ## cache the token with a different scope and won't hit them later.
+ #if imds_payload.get("resource"):
+ # oauth2_response["scope"] = imds_payload["resource"]
+ if imds_payload.get("refresh_token"):
+ oauth2_response["refresh_token"] = imds_payload["refresh_token"]
+ return oauth2_response
+
diff --git a/msal/exceptions.py b/msal/exceptions.py
new file mode 100644
index 00000000..5e9ee151
--- /dev/null
+++ b/msal/exceptions.py
@@ -0,0 +1,38 @@
+#------------------------------------------------------------------------------
+#
+# Copyright (c) Microsoft Corporation.
+# All rights reserved.
+#
+# This code is licensed under the MIT License.
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files(the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions :
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+#
+#------------------------------------------------------------------------------
+
+class MsalError(Exception):
+ # Define the template in Unicode to accommodate possible Unicode variables
+ msg = u'An unspecified error'
+
+ def __init__(self, *args, **kwargs):
+ super(MsalError, self).__init__(self.msg.format(**kwargs), *args)
+ self.kwargs = kwargs
+
+class MsalServiceError(MsalError):
+ msg = u"{error}: {error_description}"
+
diff --git a/msal/individual_cache.py b/msal/individual_cache.py
new file mode 100644
index 00000000..4c6fa00e
--- /dev/null
+++ b/msal/individual_cache.py
@@ -0,0 +1,286 @@
+from functools import wraps
+import time
+try:
+ from collections.abc import MutableMapping # Python 3.3+
+except ImportError:
+ from collections import MutableMapping # Python 2.7+
+import heapq
+from threading import Lock
+
+
+class _ExpiringMapping(MutableMapping):
+ _INDEX = "_index_"
+
+ def __init__(self, mapping=None, capacity=None, expires_in=None, lock=None,
+ *args, **kwargs):
+ """Items in this mapping can have individual shelf life,
+ just like food items in your refrigerator have their different shelf life
+ determined by each food, not by the refrigerator.
+
+ Expired items will be automatically evicted.
+ The clean-up will be done at each time when adding a new item,
+ or when looping or counting the entire mapping.
+ (This is better than being done indecisively by a background thread,
+ which might not always happen before your accessing the mapping.)
+
+ This implementation uses no dependency other than Python standard library.
+
+ :param MutableMapping mapping:
+ A dict-like key-value mapping, which needs to support __setitem__(),
+ __getitem__(), __delitem__(), get(), pop().
+
+ The default mapping is an in-memory dict.
+
+ You could potentially supply a file-based dict-like object, too.
+ This implementation deliberately avoid mapping.__iter__(),
+ which could be slow on a file-based mapping.
+
+ :param int capacity:
+ How many items this mapping will hold.
+ When you attempt to add new item into a full mapping,
+ it will automatically delete the item that is expiring soonest.
+
+ The default value is None, which means there is no capacity limit.
+
+ :param int expires_in:
+ How many seconds an item would expire and be purged from this mapping.
+ Also known as time-to-live (TTL).
+ You can also use :func:`~set()` to provide per-item expires_in value.
+
+ :param Lock lock:
+ A locking mechanism with context manager interface.
+ If no lock is provided, a threading.Lock will be used.
+ But you may want to supply a different lock,
+ if your customized mapping is being shared differently.
+ """
+ super(_ExpiringMapping, self).__init__(*args, **kwargs)
+ self._mapping = mapping if mapping is not None else {}
+ self._capacity = capacity
+ self._expires_in = expires_in
+ self._lock = Lock() if lock is None else lock
+
+ def _validate_key(self, key):
+ if key == self._INDEX:
+ raise ValueError("key {} is a reserved keyword in {}".format(
+ key, self.__class__.__name__))
+
+ def set(self, key, value, expires_in):
+ # This method's name was chosen so that it matches its cousin __setitem__(),
+ # and it also complements the counterpart get().
+ # The downside is such a name shadows the built-in type set in this file,
+ # but you can overcome that by defining a global alias for set.
+ """It sets the key-value pair into this mapping, with its per-item expires_in.
+
+ It will take O(logN) time, because it will run some maintenance.
+ This worse-than-constant time is acceptable, because in a cache scenario,
+ __setitem__() would only be called during a cache miss,
+ which would already incur an expensive target function call anyway.
+
+ By the way, most other methods of this mapping still have O(1) constant time.
+ """
+ with self._lock:
+ self._set(key, value, expires_in)
+
+ def _set(self, key, value, expires_in):
+ # This internal implementation powers both set() and __setitem__(),
+ # so that they don't depend on each other.
+ self._validate_key(key)
+ sequence, timestamps = self._mapping.get(self._INDEX, ([], {}))
+ self._maintenance(sequence, timestamps) # O(logN)
+ now = int(time.time())
+ expires_at = now + expires_in
+ entry = [expires_at, now, key]
+ is_new_item = key not in timestamps
+ is_beyond_capacity = self._capacity and len(timestamps) >= self._capacity
+ if is_new_item and is_beyond_capacity:
+ self._drop_indexed_entry(timestamps, heapq.heappushpop(sequence, entry))
+ else: # Simply add new entry. The old one would become a harmless orphan.
+ heapq.heappush(sequence, entry)
+ timestamps[key] = [expires_at, now] # It overwrites existing key, if any
+ self._mapping[key] = value
+ self._mapping[self._INDEX] = sequence, timestamps
+
+ def _maintenance(self, sequence, timestamps): # O(logN)
+ """It will modify input sequence and timestamps in-place"""
+ now = int(time.time())
+ while sequence: # Clean up expired items
+ expires_at, created_at, key = sequence[0]
+ if created_at <= now < expires_at: # Then all remaining items are fresh
+ break
+ self._drop_indexed_entry(timestamps, sequence[0]) # It could error out
+ heapq.heappop(sequence) # Only pop it after a successful _drop_indexed_entry()
+ while self._capacity is not None and len(timestamps) > self._capacity:
+ self._drop_indexed_entry(timestamps, sequence[0]) # It could error out
+ heapq.heappop(sequence) # Only pop it after a successful _drop_indexed_entry()
+
+ def _drop_indexed_entry(self, timestamps, entry):
+ """For an entry came from index, drop it from timestamps and self._mapping"""
+ expires_at, created_at, key = entry
+ if [expires_at, created_at] == timestamps.get(key): # So it is not an orphan
+ self._mapping.pop(key, None) # It could raise exception
+ timestamps.pop(key, None) # This would probably always succeed
+
+ def __setitem__(self, key, value):
+ """Implements the __setitem__().
+
+ Same characteristic as :func:`~set()`,
+ but use class-wide expires_in which was specified by :func:`~__init__()`.
+ """
+ if self._expires_in is None:
+ raise ValueError("Need a numeric value for expires_in during __init__()")
+ with self._lock:
+ self._set(key, value, self._expires_in)
+
+ def __getitem__(self, key): # O(1)
+ """If the item you requested already expires, KeyError will be raised."""
+ self._validate_key(key)
+ with self._lock:
+ # Skip self._maintenance(), because it would need O(logN) time
+ sequence, timestamps = self._mapping.get(self._INDEX, ([], {}))
+ expires_at, created_at = timestamps[key] # Would raise KeyError accordingly
+ now = int(time.time())
+ if not created_at <= now < expires_at:
+ self._mapping.pop(key, None)
+ timestamps.pop(key, None)
+ self._mapping[self._INDEX] = sequence, timestamps
+ raise KeyError("{} {}".format(
+ key,
+ "expired" if now >= expires_at else "created in the future?",
+ ))
+ return self._mapping[key] # O(1)
+
+ def __delitem__(self, key): # O(1)
+ """If the item you requested already expires, KeyError will be raised."""
+ self._validate_key(key)
+ with self._lock:
+ # Skip self._maintenance(), because it would need O(logN) time
+ self._mapping.pop(key, None) # O(1)
+ sequence, timestamps = self._mapping.get(self._INDEX, ([], {}))
+ del timestamps[key] # O(1)
+ self._mapping[self._INDEX] = sequence, timestamps
+
+ def __len__(self): # O(logN)
+ """Drop all expired items and return the remaining length"""
+ with self._lock:
+ sequence, timestamps = self._mapping.get(self._INDEX, ([], {}))
+ self._maintenance(sequence, timestamps) # O(logN)
+ self._mapping[self._INDEX] = sequence, timestamps
+ return len(timestamps) # Faster than iter(self._mapping) when it is on disk
+
+ def __iter__(self):
+ """Drop all expired items and return an iterator of the remaining items"""
+ with self._lock:
+ sequence, timestamps = self._mapping.get(self._INDEX, ([], {}))
+ self._maintenance(sequence, timestamps) # O(logN)
+ self._mapping[self._INDEX] = sequence, timestamps
+ return iter(timestamps) # Faster than iter(self._mapping) when it is on disk
+
+
+class _IndividualCache(object):
+ # The code structure below can decorate both function and method.
+ # It is inspired by https://stackoverflow.com/a/9417088
+ # We may potentially switch to build upon
+ # https://github.com/micheles/decorator/blob/master/docs/documentation.md#statement-of-the-problem
+ def __init__(self, mapping=None, key_maker=None, expires_in=None):
+ """Constructs a cache decorator that allows item-by-item control on
+ how to cache the return value of the decorated function.
+
+ :param MutableMapping mapping:
+ The cached items will be stored inside.
+ You'd want to use a ExpiringMapping
+ if you plan to utilize the ``expires_in`` behavior.
+
+ If nothing is provided, an in-memory dict will be used,
+ but it will provide no expiry functionality.
+
+ .. note::
+
+ When using this class as a decorator,
+ your mapping needs to be available at "compile" time,
+ so it would typically be a global-, module- or class-level mapping::
+
+ module_mapping = {}
+
+ @IndividualCache(mapping=module_mapping, ...)
+ def foo():
+ ...
+
+ If you want to use a mapping available only at run-time,
+ you have to manually decorate your function at run-time, too::
+
+ def foo():
+ ...
+
+ def bar(runtime_mapping):
+ foo = IndividualCache(mapping=runtime_mapping...)(foo)
+
+ :param callable key_maker:
+ A callable which should have signature as
+ ``lambda function, args, kwargs: "return a string as key"``.
+
+ If key_maker happens to return ``None``, the cache will be bypassed,
+ the underlying function will be invoked directly,
+ and the invoke result will not be cached either.
+
+ :param callable expires_in:
+ The default value is ``None``,
+ which means the content being cached has no per-item expiry,
+ and will subject to the underlying mapping's global expiry time.
+
+ It can be an integer indicating
+ how many seconds the result will be cached.
+ In particular, if the value is 0,
+ it means the result expires after zero second (i.e. immediately),
+ therefore the result will *not* be cached.
+ (Mind the difference between ``expires_in=0`` and ``expires_in=None``.)
+
+ Or it can be a callable with the signature as
+ ``lambda function=function, args=args, kwargs=kwargs, result=result: 123``
+ to calculate the expiry on the fly.
+ Its return value will be interpreted in the same way as above.
+ """
+ self._mapping = mapping if mapping is not None else {}
+ self._key_maker = key_maker or (lambda function, args, kwargs: (
+ function, # This default implementation uses function as part of key,
+ # so that the cache is partitioned by function.
+ # However, you could have many functions to use same namespace,
+ # so different decorators could share same cache.
+ args,
+ tuple(kwargs.items()), # raw kwargs is not hashable
+ ))
+ self._expires_in = expires_in
+
+ def __call__(self, function):
+
+ @wraps(function)
+ def wrapper(*args, **kwargs):
+ key = self._key_maker(function, args, kwargs)
+ if key is None: # Then bypass the cache
+ return function(*args, **kwargs)
+
+ now = int(time.time())
+ try:
+ return self._mapping[key]
+ except KeyError:
+ # We choose to NOT call function(...) in this block, otherwise
+ # potential exception from function(...) would become a confusing
+ # "During handling of the above exception, another exception occurred"
+ pass
+ value = function(*args, **kwargs)
+
+ expires_in = self._expires_in(
+ function=function,
+ args=args,
+ kwargs=kwargs,
+ result=value,
+ ) if callable(self._expires_in) else self._expires_in
+ if expires_in == 0:
+ return value
+ if expires_in is None:
+ self._mapping[key] = value
+ else:
+ self._mapping.set(key, value, expires_in)
+ return value
+
+ return wrapper
+
diff --git a/msal/managed_identity.py b/msal/managed_identity.py
new file mode 100644
index 00000000..608bc1bf
--- /dev/null
+++ b/msal/managed_identity.py
@@ -0,0 +1,649 @@
+# Copyright (c) Microsoft Corporation.
+# All rights reserved.
+#
+# This code is licensed under the MIT License.
+import json
+import logging
+import os
+import socket
+import sys
+import time
+from urllib.parse import urlparse # Python 3+
+from collections import UserDict # Python 3+
+from typing import Optional, Union # Needed in Python 3.7 & 3.8
+from .token_cache import TokenCache
+from .individual_cache import _IndividualCache as IndividualCache
+from .throttled_http_client import ThrottledHttpClientBase, RetryAfterParser
+from .cloudshell import _is_running_in_cloud_shell
+
+
+logger = logging.getLogger(__name__)
+
+
+class ManagedIdentityError(ValueError):
+ pass
+
+
+class ManagedIdentity(UserDict):
+ """Feed an instance of this class to :class:`msal.ManagedIdentityClient`
+ to acquire token for the specified managed identity.
+ """
+ # The key names used in config dict
+ ID_TYPE = "ManagedIdentityIdType" # Contains keyword ManagedIdentity so its json equivalent will be more readable
+ ID = "Id"
+
+ # Valid values for key ID_TYPE
+ CLIENT_ID = "ClientId"
+ RESOURCE_ID = "ResourceId"
+ OBJECT_ID = "ObjectId"
+ SYSTEM_ASSIGNED = "SystemAssigned"
+
+ _types_mapping = { # Maps type name in configuration to type name on wire
+ CLIENT_ID: "client_id",
+ RESOURCE_ID: "msi_res_id", # VM's IMDS prefers msi_res_id https://github.com/Azure/azure-rest-api-specs/blob/dba6ed1f03bda88ac6884c0a883246446cc72495/specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2018-10-01/imds.json#L233-L239
+ OBJECT_ID: "object_id",
+ }
+
+ @classmethod
+ def is_managed_identity(cls, unknown):
+ return (isinstance(unknown, ManagedIdentity)
+ or cls.is_system_assigned(unknown)
+ or cls.is_user_assigned(unknown))
+
+ @classmethod
+ def is_system_assigned(cls, unknown):
+ return isinstance(unknown, SystemAssignedManagedIdentity) or (
+ isinstance(unknown, dict)
+ and unknown.get(cls.ID_TYPE) == cls.SYSTEM_ASSIGNED)
+
+ @classmethod
+ def is_user_assigned(cls, unknown):
+ return isinstance(unknown, UserAssignedManagedIdentity) or (
+ isinstance(unknown, dict)
+ and unknown.get(cls.ID_TYPE) in cls._types_mapping
+ and unknown.get(cls.ID))
+
+ def __init__(self, identifier=None, id_type=None):
+ # Undocumented. Use subclasses instead.
+ super(ManagedIdentity, self).__init__({
+ self.ID_TYPE: id_type,
+ self.ID: identifier,
+ })
+
+
+class SystemAssignedManagedIdentity(ManagedIdentity):
+ """Represent a system-assigned managed identity.
+
+ It is equivalent to a Python dict of::
+
+ {"ManagedIdentityIdType": "SystemAssigned", "Id": None}
+
+ or a JSON blob of::
+
+ {"ManagedIdentityIdType": "SystemAssigned", "Id": null}
+ """
+ def __init__(self):
+ super(SystemAssignedManagedIdentity, self).__init__(id_type=self.SYSTEM_ASSIGNED)
+
+
+class UserAssignedManagedIdentity(ManagedIdentity):
+ """Represent a user-assigned managed identity.
+
+ Depends on the id you provided, the outcome is equivalent to one of the below::
+
+ {"ManagedIdentityIdType": "ClientId", "Id": "foo"}
+ {"ManagedIdentityIdType": "ResourceId", "Id": "foo"}
+ {"ManagedIdentityIdType": "ObjectId", "Id": "foo"}
+ """
+ def __init__(self, *, client_id=None, resource_id=None, object_id=None):
+ if client_id and not resource_id and not object_id:
+ super(UserAssignedManagedIdentity, self).__init__(
+ id_type=self.CLIENT_ID, identifier=client_id)
+ elif not client_id and resource_id and not object_id:
+ super(UserAssignedManagedIdentity, self).__init__(
+ id_type=self.RESOURCE_ID, identifier=resource_id)
+ elif not client_id and not resource_id and object_id:
+ super(UserAssignedManagedIdentity, self).__init__(
+ id_type=self.OBJECT_ID, identifier=object_id)
+ else:
+ raise ManagedIdentityError(
+ "You shall specify one of the three parameters: "
+ "client_id, resource_id, object_id")
+
+
+class _ThrottledHttpClient(ThrottledHttpClientBase):
+ def __init__(self, http_client, **kwargs):
+ super(_ThrottledHttpClient, self).__init__(http_client, **kwargs)
+ self.get = IndividualCache( # All MIs (except Cloud Shell) use GETs
+ mapping=self._expiring_mapping,
+ key_maker=lambda func, args, kwargs: "REQ {} hash={} 429/5xx/Retry-After".format(
+ args[0], # It is the endpoint, typically a constant per MI type
+ self._hash(
+ # Managed Identity flavors have inconsistent parameters.
+ # We simply choose to hash them all.
+ str(kwargs.get("params")) + str(kwargs.get("data"))),
+ ),
+ expires_in=RetryAfterParser(5).parse, # 5 seconds default for non-PCA
+ )(http_client.get)
+
+
+class ManagedIdentityClient(object):
+ """This API encapsulates multiple managed identity back-ends:
+ VM, App Service, Azure Automation (Runbooks), Azure Function, Service Fabric,
+ and Azure Arc.
+
+ It also provides token cache support.
+
+ .. note::
+
+ Cloud Shell support is NOT implemented in this class.
+ Since MSAL Python 1.18 in May 2022, it has been implemented in
+ :func:`PublicClientApplication.acquire_token_interactive` via calling pattern
+ ``PublicClientApplication(...).acquire_token_interactive(scopes=[...], prompt="none")``.
+ That is appropriate, because Cloud Shell yields a token with
+ delegated permissions for the end user who has signed in to the Azure Portal
+ (like what a ``PublicClientApplication`` does),
+ not a token with application permissions for an app.
+ """
+ __instance, _tenant = None, "managed_identity" # Placeholders
+ _TOKEN_SOURCE = "token_source"
+ _TOKEN_SOURCE_IDP = "identity_provider"
+ _TOKEN_SOURCE_CACHE = "cache"
+
+ def __init__(
+ self,
+ managed_identity: Union[
+ dict,
+ ManagedIdentity, # Could use Type[ManagedIdentity] but it is deprecatred in Python 3.9+
+ SystemAssignedManagedIdentity,
+ UserAssignedManagedIdentity,
+ ],
+ *,
+ http_client,
+ token_cache=None,
+ http_cache=None,
+ ):
+ """Create a managed identity client.
+
+ :param managed_identity:
+ It accepts an instance of :class:`SystemAssignedManagedIdentity`
+ or :class:`UserAssignedManagedIdentity`.
+ They are equivalent to a dict with a certain shape,
+ which may be loaded from a JSON configuration file or an env var.
+
+ :param http_client:
+ An http client object. For example, you can use ``requests.Session()``,
+ optionally with exponential backoff behavior demonstrated in this recipe::
+
+ import msal, requests
+ from requests.adapters import HTTPAdapter, Retry
+ s = requests.Session()
+ retries = Retry(total=3, backoff_factor=0.1, status_forcelist=[
+ 429, 500, 501, 502, 503, 504])
+ s.mount('https://', HTTPAdapter(max_retries=retries))
+ managed_identity = ...
+ client = msal.ManagedIdentityClient(managed_identity, http_client=s)
+
+ :param token_cache:
+ Optional. It accepts a :class:`msal.TokenCache` instance to store tokens.
+ It will use an in-memory token cache by default.
+
+ :param http_cache:
+ Optional. It has the same characteristics as the
+ :paramref:`msal.ClientApplication.http_cache`.
+
+ Recipe 1: Hard code a managed identity for your app::
+
+ import msal, requests
+ client = msal.ManagedIdentityClient(
+ msal.UserAssignedManagedIdentity(client_id="foo"),
+ http_client=requests.Session(),
+ )
+ token = client.acquire_token_for_client("resource")
+
+ Recipe 2: Write once, run everywhere.
+ If you use different managed identity on different deployment,
+ you may use an environment variable (such as MY_MANAGED_IDENTITY_CONFIG)
+ to store a json blob like
+ ``{"ManagedIdentityIdType": "ClientId", "Id": "foo"}`` or
+ ``{"ManagedIdentityIdType": "SystemAssignedManagedIdentity", "Id": null})``.
+ The following app can load managed identity configuration dynamically::
+
+ import json, os, msal, requests
+ config = os.getenv("MY_MANAGED_IDENTITY_CONFIG")
+ assert config, "An ENV VAR with value should exist"
+ client = msal.ManagedIdentityClient(
+ json.loads(config),
+ http_client=requests.Session(),
+ )
+ token = client.acquire_token_for_client("resource")
+ """
+ if not ManagedIdentity.is_managed_identity(managed_identity):
+ raise ManagedIdentityError(
+ f"Incorrect managed_identity: {managed_identity}")
+ self._managed_identity = managed_identity
+ self._http_client = _ThrottledHttpClient(
+ # This class only throttles excess token acquisition requests.
+ # It does not provide retry.
+ # Retry is the http_client or caller's responsibility, not MSAL's.
+ #
+ # FWIW, here is the inconsistent retry recommendation.
+ # 1. Only MI on VM defines exotic 404 and 410 retry recommendations
+ # ( https://learn.microsoft.com/en-us/entra/identity/managed-identities-azure-resources/how-to-use-vm-token#error-handling )
+ # (especially for 410 which was supposed to be a permanent failure).
+ # 2. MI on Service Fabric specifically suggests to not retry on 404.
+ # ( https://learn.microsoft.com/en-us/azure/service-fabric/how-to-managed-cluster-managed-identity-service-fabric-app-code#error-handling )
+ http_client.http_client # Patch the raw (unpatched) http client
+ if isinstance(http_client, ThrottledHttpClientBase) else http_client,
+ http_cache=http_cache,
+ )
+ self._token_cache = token_cache or TokenCache()
+
+ def _get_instance(self):
+ if self.__instance is None:
+ self.__instance = socket.getfqdn() # Moved from class definition to here
+ return self.__instance
+
+ def acquire_token_for_client(
+ self,
+ *,
+ resource: str, # If/when we support scope, resource will become optional
+ claims_challenge: Optional[str] = None,
+ ):
+ """Acquire token for the managed identity.
+
+ The result will be automatically cached.
+ Subsequent calls will automatically search from cache first.
+
+ :param resource: The resource for which the token is acquired.
+
+ :param claims_challenge:
+ Optional.
+ It is a string representation of a JSON object
+ (which contains lists of claims being requested).
+
+ The tenant admin may choose to revoke all Managed Identity tokens,
+ and then a *claims challenge* will be returned by the target resource,
+ as a `claims_challenge` directive in the `www-authenticate` header,
+ even if the app developer did not opt in for the "CP1" client capability.
+ Upon receiving a `claims_challenge`, MSAL will skip a token cache read,
+ and will attempt to acquire a new token.
+
+ .. note::
+
+ Known issue: When an Azure VM has only one user-assigned managed identity,
+ and your app specifies to use system-assigned managed identity,
+ Azure VM may still return a token for your user-assigned identity.
+
+ This is a service-side behavior that cannot be changed by this library.
+ `Azure VM docs `_
+ """
+ access_token_from_cache = None
+ client_id_in_cache = self._managed_identity.get(
+ ManagedIdentity.ID, "SYSTEM_ASSIGNED_MANAGED_IDENTITY")
+ now = time.time()
+ if not claims_challenge: # Then attempt token cache search
+ matches = self._token_cache.find(
+ self._token_cache.CredentialType.ACCESS_TOKEN,
+ target=[resource],
+ query=dict(
+ client_id=client_id_in_cache,
+ environment=self._get_instance(),
+ realm=self._tenant,
+ home_account_id=None,
+ ),
+ )
+ for entry in matches:
+ expires_in = int(entry["expires_on"]) - now
+ if expires_in < 5*60: # Then consider it expired
+ continue # Removal is not necessary, it will be overwritten
+ logger.debug("Cache hit an AT")
+ access_token_from_cache = { # Mimic a real response
+ "access_token": entry["secret"],
+ "token_type": entry.get("token_type", "Bearer"),
+ "expires_in": int(expires_in), # OAuth2 specs defines it as int
+ self._TOKEN_SOURCE: self._TOKEN_SOURCE_CACHE,
+ }
+ if "refresh_on" in entry:
+ access_token_from_cache["refresh_on"] = int(entry["refresh_on"])
+ if int(entry["refresh_on"]) < now: # aging
+ break # With a fallback in hand, we break here to go refresh
+ return access_token_from_cache # It is still good as new
+ try:
+ result = _obtain_token(self._http_client, self._managed_identity, resource)
+ if "access_token" in result:
+ expires_in = result.get("expires_in", 3600)
+ if "refresh_in" not in result and expires_in >= 7200:
+ result["refresh_in"] = int(expires_in / 2)
+ self._token_cache.add(dict(
+ client_id=client_id_in_cache,
+ scope=[resource],
+ token_endpoint="https://{}/{}".format(
+ self._get_instance(), self._tenant),
+ response=result,
+ params={},
+ data={},
+ ))
+ if "refresh_in" in result:
+ result["refresh_on"] = int(now + result["refresh_in"])
+ result[self._TOKEN_SOURCE] = self._TOKEN_SOURCE_IDP
+ if (result and "error" not in result) or (not access_token_from_cache):
+ return result
+ except: # The exact HTTP exception is transportation-layer dependent
+ # Typically network error. Potential AAD outage?
+ if not access_token_from_cache: # It means there is no fall back option
+ raise # We choose to bubble up the exception
+ return access_token_from_cache
+
+
+def _scope_to_resource(scope): # This is an experimental reasonable-effort approach
+ u = urlparse(scope)
+ if u.scheme:
+ return "{}://{}".format(u.scheme, u.netloc)
+ return scope # There is no much else we can do here
+
+
+def _get_arc_endpoint():
+ if "IDENTITY_ENDPOINT" in os.environ and "IMDS_ENDPOINT" in os.environ:
+ return os.environ["IDENTITY_ENDPOINT"]
+ if ( # Defined in https://msazure.visualstudio.com/One/_wiki/wikis/One.wiki/233012/VM-Extension-Authoring-for-Arc?anchor=determining-which-endpoint-to-use
+ sys.platform == "linux" and os.path.exists("/var/opt/azcmagent/bin/himds")
+ or sys.platform == "win32" and os.path.exists(os.path.expandvars(
+ r"%ProgramFiles%\AzureConnectedMachineAgent\himds.exe"))
+ ):
+ return "http://localhost:40342/metadata/identity/oauth2/token"
+
+
+APP_SERVICE = object()
+AZURE_ARC = object()
+CLOUD_SHELL = object() # In MSAL Python, token acquisition was done by
+ # PublicClientApplication(...).acquire_token_interactive(..., prompt="none")
+MACHINE_LEARNING = object()
+SERVICE_FABRIC = object()
+DEFAULT_TO_VM = object() # Unknown environment; default to VM; you may want to probe
+def get_managed_identity_source():
+ """Detect the current environment and return the likely identity source.
+
+ When this function returns ``CLOUD_SHELL``, you should use
+ :func:`msal.PublicClientApplication.acquire_token_interactive` with ``prompt="none"``
+ to obtain a token.
+ """
+ if ("IDENTITY_ENDPOINT" in os.environ and "IDENTITY_HEADER" in os.environ
+ and "IDENTITY_SERVER_THUMBPRINT" in os.environ
+ ):
+ return SERVICE_FABRIC
+ if "IDENTITY_ENDPOINT" in os.environ and "IDENTITY_HEADER" in os.environ:
+ return APP_SERVICE
+ if "MSI_ENDPOINT" in os.environ and "MSI_SECRET" in os.environ:
+ return MACHINE_LEARNING
+ if _get_arc_endpoint():
+ return AZURE_ARC
+ if _is_running_in_cloud_shell():
+ return CLOUD_SHELL
+ return DEFAULT_TO_VM
+
+
+def _obtain_token(http_client, managed_identity, resource):
+ # A unified low-level API that talks to different Managed Identity
+ if ("IDENTITY_ENDPOINT" in os.environ and "IDENTITY_HEADER" in os.environ
+ and "IDENTITY_SERVER_THUMBPRINT" in os.environ
+ ):
+ if managed_identity:
+ logger.debug(
+ "Ignoring managed_identity parameter. "
+ "Managed Identity in Service Fabric is configured in the cluster, "
+ "not during runtime. See also "
+ "https://learn.microsoft.com/en-us/azure/service-fabric/configure-existing-cluster-enable-managed-identity-token-service")
+ return _obtain_token_on_service_fabric(
+ http_client,
+ os.environ["IDENTITY_ENDPOINT"],
+ os.environ["IDENTITY_HEADER"],
+ os.environ["IDENTITY_SERVER_THUMBPRINT"],
+ resource,
+ )
+ if "IDENTITY_ENDPOINT" in os.environ and "IDENTITY_HEADER" in os.environ:
+ return _obtain_token_on_app_service(
+ http_client,
+ os.environ["IDENTITY_ENDPOINT"],
+ os.environ["IDENTITY_HEADER"],
+ managed_identity,
+ resource,
+ )
+ if "MSI_ENDPOINT" in os.environ and "MSI_SECRET" in os.environ:
+ # Back ported from https://github.com/Azure/azure-sdk-for-python/blob/azure-identity_1.15.0/sdk/identity/azure-identity/azure/identity/_credentials/azure_ml.py
+ return _obtain_token_on_machine_learning(
+ http_client,
+ os.environ["MSI_ENDPOINT"],
+ os.environ["MSI_SECRET"],
+ managed_identity,
+ resource,
+ )
+ arc_endpoint = _get_arc_endpoint()
+ if arc_endpoint:
+ if ManagedIdentity.is_user_assigned(managed_identity):
+ raise ManagedIdentityError( # Note: Azure Identity for Python raised exception too
+ "Invalid managed_identity parameter. "
+ "Azure Arc supports only system-assigned managed identity, "
+ "See also "
+ "https://learn.microsoft.com/en-us/azure/service-fabric/configure-existing-cluster-enable-managed-identity-token-service")
+ return _obtain_token_on_arc(http_client, arc_endpoint, resource)
+ return _obtain_token_on_azure_vm(http_client, managed_identity, resource)
+
+
+def _adjust_param(params, managed_identity, types_mapping=None):
+ # Modify the params dict in place
+ id_name = (types_mapping or ManagedIdentity._types_mapping).get(
+ managed_identity.get(ManagedIdentity.ID_TYPE))
+ if id_name:
+ params[id_name] = managed_identity[ManagedIdentity.ID]
+
+def _obtain_token_on_azure_vm(http_client, managed_identity, resource):
+ # Based on https://docs.microsoft.com/en-us/azure/active-directory/managed-identities-azure-resources/how-to-use-vm-token#get-a-token-using-http
+ logger.debug("Obtaining token via managed identity on Azure VM")
+ params = {
+ "api-version": "2018-02-01",
+ "resource": resource,
+ }
+ _adjust_param(params, managed_identity)
+ resp = http_client.get(
+ "http://169.254.169.254/metadata/identity/oauth2/token",
+ params=params,
+ headers={"Metadata": "true"},
+ )
+ try:
+ payload = json.loads(resp.text)
+ if payload.get("access_token") and payload.get("expires_in"):
+ return { # Normalizing the payload into OAuth2 format
+ "access_token": payload["access_token"],
+ "expires_in": int(payload["expires_in"]),
+ "resource": payload.get("resource"),
+ "token_type": payload.get("token_type", "Bearer"),
+ }
+ return payload # It would be {"error": ..., "error_description": ...} according to https://learn.microsoft.com/en-us/entra/identity/managed-identities-azure-resources/how-to-use-vm-token#error-handling
+ except json.decoder.JSONDecodeError:
+ logger.debug("IMDS emits unexpected payload: %s", resp.text)
+ raise
+
+def _obtain_token_on_app_service(
+ http_client, endpoint, identity_header, managed_identity, resource,
+):
+ """Obtains token for
+ `App Service `_,
+ Azure Functions, and Azure Automation.
+ """
+ # Prerequisite: Create your app service https://docs.microsoft.com/en-us/azure/app-service/quickstart-python
+ # Assign it a managed identity https://docs.microsoft.com/en-us/azure/app-service/overview-managed-identity?tabs=portal%2Chttp
+ # SSH into your container for testing https://docs.microsoft.com/en-us/azure/app-service/configure-linux-open-ssh-session
+ logger.debug("Obtaining token via managed identity on Azure App Service")
+ params = {
+ "api-version": "2019-08-01",
+ "resource": resource,
+ }
+ _adjust_param(params, managed_identity, types_mapping={
+ ManagedIdentity.CLIENT_ID: "client_id",
+ ManagedIdentity.RESOURCE_ID: "mi_res_id", # App Service's resource id uses "mi_res_id"
+ ManagedIdentity.OBJECT_ID: "object_id",
+ })
+
+ resp = http_client.get(
+ endpoint,
+ params=params,
+ headers={
+ "X-IDENTITY-HEADER": identity_header,
+ "Metadata": "true", # Unnecessary yet harmless for App Service,
+ # It will be needed by Azure Automation
+ # https://docs.microsoft.com/en-us/azure/automation/enable-managed-identity-for-automation#get-access-token-for-system-assigned-managed-identity-using-http-get
+ },
+ )
+ try:
+ payload = json.loads(resp.text)
+ if payload.get("access_token") and payload.get("expires_on"):
+ return { # Normalizing the payload into OAuth2 format
+ "access_token": payload["access_token"],
+ "expires_in": int(payload["expires_on"]) - int(time.time()),
+ "resource": payload.get("resource"),
+ "token_type": payload.get("token_type", "Bearer"),
+ }
+ return {
+ "error": "invalid_scope", # Empirically, wrong resource ends up with a vague statusCode=500
+ "error_description": "{}, {}".format(
+ payload.get("statusCode"), payload.get("message")),
+ }
+ except json.decoder.JSONDecodeError:
+ logger.debug("IMDS emits unexpected payload: %s", resp.text)
+ raise
+
+def _obtain_token_on_machine_learning(
+ http_client, endpoint, secret, managed_identity, resource,
+):
+ # Could not find protocol docs from https://docs.microsoft.com/en-us/azure/machine-learning
+ # The following implementation is back ported from Azure Identity 1.15.0
+ logger.debug("Obtaining token via managed identity on Azure Machine Learning")
+ params = {"api-version": "2017-09-01", "resource": resource}
+ _adjust_param(params, managed_identity)
+ if params["api-version"] == "2017-09-01" and "client_id" in params:
+ # Workaround for a known bug in Azure ML 2017 API
+ params["clientid"] = params.pop("client_id")
+ resp = http_client.get(
+ endpoint,
+ params=params,
+ headers={"secret": secret},
+ )
+ try:
+ payload = json.loads(resp.text)
+ if payload.get("access_token") and payload.get("expires_on"):
+ return { # Normalizing the payload into OAuth2 format
+ "access_token": payload["access_token"],
+ "expires_in": int(payload["expires_on"]) - int(time.time()),
+ "resource": payload.get("resource"),
+ "token_type": payload.get("token_type", "Bearer"),
+ }
+ return {
+ "error": "invalid_scope", # TODO: To be tested
+ "error_description": "{}".format(payload),
+ }
+ except json.decoder.JSONDecodeError:
+ logger.debug("IMDS emits unexpected payload: %s", resp.text)
+ raise
+
+
+def _obtain_token_on_service_fabric(
+ http_client, endpoint, identity_header, server_thumbprint, resource,
+):
+ """Obtains token for
+ `Service Fabric `_
+ """
+ # Deployment https://learn.microsoft.com/en-us/azure/service-fabric/service-fabric-get-started-containers-linux
+ # See also https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/identity/azure-identity/tests/managed-identity-live/service-fabric/service_fabric.md
+ # Protocol https://learn.microsoft.com/en-us/azure/service-fabric/how-to-managed-identity-service-fabric-app-code#acquiring-an-access-token-using-rest-api
+ logger.debug("Obtaining token via managed identity on Azure Service Fabric")
+ resp = http_client.get(
+ endpoint,
+ params={"api-version": "2019-07-01-preview", "resource": resource},
+ headers={"Secret": identity_header},
+ )
+ try:
+ payload = json.loads(resp.text)
+ if payload.get("access_token") and payload.get("expires_on"):
+ return { # Normalizing the payload into OAuth2 format
+ "access_token": payload["access_token"],
+ "expires_in": int( # Despite the example in docs shows an integer,
+ payload["expires_on"] # Azure SDK team's test obtained a string.
+ ) - int(time.time()),
+ "resource": payload.get("resource"),
+ "token_type": payload["token_type"],
+ }
+ error = payload.get("error", {}) # https://learn.microsoft.com/en-us/azure/service-fabric/how-to-managed-identity-service-fabric-app-code#error-handling
+ error_mapping = { # Map Service Fabric errors into OAuth2 errors https://www.rfc-editor.org/rfc/rfc6749#section-5.2
+ "SecretHeaderNotFound": "unauthorized_client",
+ "ManagedIdentityNotFound": "invalid_client",
+ "ArgumentNullOrEmpty": "invalid_scope",
+ }
+ return {
+ "error": error_mapping.get(payload["error"]["code"], "invalid_request"),
+ "error_description": resp.text,
+ }
+ except json.decoder.JSONDecodeError:
+ logger.debug("IMDS emits unexpected payload: %s", resp.text)
+ raise
+
+
+_supported_arc_platforms_and_their_prefixes = {
+ "linux": "/var/opt/azcmagent/tokens",
+ "win32": os.path.expandvars(r"%ProgramData%\AzureConnectedMachineAgent\Tokens"),
+}
+
+class ArcPlatformNotSupportedError(ManagedIdentityError):
+ pass
+
+def _obtain_token_on_arc(http_client, endpoint, resource):
+ # https://learn.microsoft.com/en-us/azure/azure-arc/servers/managed-identity-authentication
+ logger.debug("Obtaining token via managed identity on Azure Arc")
+ resp = http_client.get(
+ endpoint,
+ params={"api-version": "2020-06-01", "resource": resource},
+ headers={"Metadata": "true"},
+ )
+ www_auth = "www-authenticate" # Header in lower case
+ challenge = {
+ # Normalized to lowercase, because header names are case-insensitive
+ # https://datatracker.ietf.org/doc/html/rfc7230#section-3.2
+ k.lower(): v for k, v in resp.headers.items() if k.lower() == www_auth
+ }.get(www_auth, "").split("=") # Output will be ["Basic realm", "content"]
+ if not ( # https://datatracker.ietf.org/doc/html/rfc7617#section-2
+ len(challenge) == 2 and challenge[0].lower() == "basic realm"):
+ raise ManagedIdentityError(
+ "Unrecognizable WWW-Authenticate header: {}".format(resp.headers))
+ if sys.platform not in _supported_arc_platforms_and_their_prefixes:
+ raise ArcPlatformNotSupportedError(
+ f"Platform {sys.platform} was undefined and unsupported")
+ filename = os.path.join(
+ # This algorithm is documented in an internal doc https://msazure.visualstudio.com/One/_wiki/wikis/One.wiki/233012/VM-Extension-Authoring-for-Arc?anchor=2.-obtaining-tokens
+ _supported_arc_platforms_and_their_prefixes[sys.platform],
+ os.path.splitext(os.path.basename(challenge[1]))[0] + ".key")
+ if os.stat(filename).st_size > 4096: # Check size BEFORE loading its content
+ raise ManagedIdentityError("Local key file shall not be larger than 4KB")
+ with open(filename) as f:
+ secret = f.read()
+ response = http_client.get(
+ endpoint,
+ params={"api-version": "2020-06-01", "resource": resource},
+ headers={"Metadata": "true", "Authorization": "Basic {}".format(secret)},
+ )
+ try:
+ payload = json.loads(response.text)
+ if payload.get("access_token") and payload.get("expires_in"):
+ # Example: https://learn.microsoft.com/en-us/azure/azure-arc/servers/media/managed-identity-authentication/bash-token-output-example.png
+ return {
+ "access_token": payload["access_token"],
+ "expires_in": int(payload["expires_in"]),
+ "token_type": payload.get("token_type", "Bearer"),
+ "resource": payload.get("resource"),
+ }
+ except json.decoder.JSONDecodeError:
+ pass
+ return {
+ "error": "invalid_request",
+ "error_description": response.text,
+ }
+
diff --git a/msal/mex.py b/msal/mex.py
new file mode 100644
index 00000000..e6f3ed07
--- /dev/null
+++ b/msal/mex.py
@@ -0,0 +1,137 @@
+#------------------------------------------------------------------------------
+#
+# Copyright (c) Microsoft Corporation.
+# All rights reserved.
+#
+# This code is licensed under the MIT License.
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files(the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions :
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+#
+#------------------------------------------------------------------------------
+
+try:
+ from urllib.parse import urlparse
+except ImportError:
+ from urlparse import urlparse
+try:
+ from xml.etree import cElementTree as ET
+except ImportError:
+ from xml.etree import ElementTree as ET
+import logging
+
+
+logger = logging.getLogger(__name__)
+
+def _xpath_of_root(route_to_leaf):
+ # Construct an xpath suitable to find a root node which has a specified leaf
+ return '/'.join(route_to_leaf + ['..'] * (len(route_to_leaf)-1))
+
+
+def send_request(mex_endpoint, http_client, **kwargs):
+ mex_resp = http_client.get(mex_endpoint, **kwargs)
+ mex_resp.raise_for_status()
+ try:
+ return Mex(mex_resp.text).get_wstrust_username_password_endpoint()
+ except ET.ParseError:
+ logger.exception(
+ "Malformed MEX document: %s, %s", mex_resp.status_code, mex_resp.text)
+ raise
+
+
+class Mex(object):
+
+ NS = { # Also used by wstrust_*.py
+ 'wsdl': 'http://schemas.xmlsoap.org/wsdl/',
+ 'sp': 'http://docs.oasis-open.org/ws-sx/ws-securitypolicy/200702',
+ 'sp2005': 'http://schemas.xmlsoap.org/ws/2005/07/securitypolicy',
+ 'wsu': 'http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd',
+ 'wsa': 'http://www.w3.org/2005/08/addressing', # Duplicate?
+ 'wsa10': 'http://www.w3.org/2005/08/addressing',
+ 'http': 'http://schemas.microsoft.com/ws/06/2004/policy/http',
+ 'soap12': 'http://schemas.xmlsoap.org/wsdl/soap12/',
+ 'wsp': 'http://schemas.xmlsoap.org/ws/2004/09/policy',
+ 's': 'http://www.w3.org/2003/05/soap-envelope',
+ 'wst': 'http://docs.oasis-open.org/ws-sx/ws-trust/200512',
+ 'trust': "http://docs.oasis-open.org/ws-sx/ws-trust/200512", # Duplicate?
+ 'saml': "urn:oasis:names:tc:SAML:1.0:assertion",
+ 'wst2005': 'http://schemas.xmlsoap.org/ws/2005/02/trust', # was named "t"
+ }
+ ACTION_13 = 'http://docs.oasis-open.org/ws-sx/ws-trust/200512/RST/Issue'
+ ACTION_2005 = 'http://schemas.xmlsoap.org/ws/2005/02/trust/RST/Issue'
+
+ def __init__(self, mex_document):
+ self.dom = ET.fromstring(mex_document)
+
+ def _get_policy_ids(self, components_to_leaf, binding_xpath):
+ id_attr = '{%s}Id' % self.NS['wsu']
+ return set(["#{}".format(policy.get(id_attr))
+ for policy in self.dom.findall(_xpath_of_root(components_to_leaf), self.NS)
+ # If we did not find any binding, this is potentially bad.
+ if policy.find(binding_xpath, self.NS) is not None])
+
+ def _get_username_password_policy_ids(self):
+ path = ['wsp:Policy', 'wsp:ExactlyOne', 'wsp:All',
+ 'sp:SignedEncryptedSupportingTokens', 'wsp:Policy',
+ 'sp:UsernameToken', 'wsp:Policy', 'sp:WssUsernameToken10']
+ policies = self._get_policy_ids(path, './/sp:TransportBinding')
+ path2005 = ['wsp:Policy', 'wsp:ExactlyOne', 'wsp:All',
+ 'sp2005:SignedSupportingTokens', 'wsp:Policy',
+ 'sp2005:UsernameToken', 'wsp:Policy', 'sp2005:WssUsernameToken10']
+ policies.update(self._get_policy_ids(path2005, './/sp2005:TransportBinding'))
+ return policies
+
+ def _get_iwa_policy_ids(self):
+ return self._get_policy_ids(
+ ['wsp:Policy', 'wsp:ExactlyOne', 'wsp:All', 'http:NegotiateAuthentication'],
+ './/sp2005:TransportBinding')
+
+ def _get_bindings(self):
+ bindings = {} # {binding_name: {"policy_uri": "...", "version": "..."}}
+ for binding in self.dom.findall("wsdl:binding", self.NS):
+ if (binding.find('soap12:binding', self.NS).get("transport") !=
+ 'http://schemas.xmlsoap.org/soap/http'):
+ continue
+ action = binding.find(
+ 'wsdl:operation/soap12:operation', self.NS).get("soapAction")
+ for pr in binding.findall("wsp:PolicyReference", self.NS):
+ bindings[binding.get("name")] = {
+ "policy_uri": pr.get("URI"), "action": action}
+ return bindings
+
+ def _get_endpoints(self, bindings, policy_ids):
+ endpoints = []
+ for port in self.dom.findall('wsdl:service/wsdl:port', self.NS):
+ binding_name = port.get("binding").split(':')[-1] # Should have 2 parts
+ binding = bindings.get(binding_name)
+ if binding and binding["policy_uri"] in policy_ids:
+ address = port.find('wsa10:EndpointReference/wsa10:Address', self.NS)
+ if address is not None and address.text.lower().startswith("https://"):
+ endpoints.append(
+ {"address": address.text, "action": binding["action"]})
+ return endpoints
+
+ def get_wstrust_username_password_endpoint(self):
+ """Returns {"address": "https://...", "action": "the soapAction value"}"""
+ endpoints = self._get_endpoints(
+ self._get_bindings(), self._get_username_password_policy_ids())
+ for e in endpoints:
+ if e["action"] == self.ACTION_13:
+ return e # Historically, we prefer ACTION_13 a.k.a. WsTrust13
+ return endpoints[0] if endpoints else None
+
diff --git a/oauth2cli/__init__.py b/msal/oauth2cli/__init__.py
similarity index 100%
rename from oauth2cli/__init__.py
rename to msal/oauth2cli/__init__.py
diff --git a/oauth2cli/assertion.py b/msal/oauth2cli/assertion.py
similarity index 100%
rename from oauth2cli/assertion.py
rename to msal/oauth2cli/assertion.py
diff --git a/oauth2cli/authcode.py b/msal/oauth2cli/authcode.py
similarity index 100%
rename from oauth2cli/authcode.py
rename to msal/oauth2cli/authcode.py
diff --git a/oauth2cli/http.py b/msal/oauth2cli/http.py
similarity index 100%
rename from oauth2cli/http.py
rename to msal/oauth2cli/http.py
diff --git a/oauth2cli/oauth2.py b/msal/oauth2cli/oauth2.py
similarity index 100%
rename from oauth2cli/oauth2.py
rename to msal/oauth2cli/oauth2.py
diff --git a/oauth2cli/oidc.py b/msal/oauth2cli/oidc.py
similarity index 100%
rename from oauth2cli/oidc.py
rename to msal/oauth2cli/oidc.py
diff --git a/msal/region.py b/msal/region.py
new file mode 100644
index 00000000..c540dc71
--- /dev/null
+++ b/msal/region.py
@@ -0,0 +1,45 @@
+import os
+import logging
+
+logger = logging.getLogger(__name__)
+
+
+def _detect_region(http_client=None):
+ region = os.environ.get("REGION_NAME", "").replace(" ", "").lower() # e.g. westus2
+ if region:
+ return region
+ if http_client:
+ return _detect_region_of_azure_vm(http_client) # It could hang for minutes
+ return None
+
+
+def _detect_region_of_azure_vm(http_client):
+ url = (
+ "http://169.254.169.254/metadata/instance"
+
+ # Utilize the "route parameters" feature to obtain region as a string
+ # https://docs.microsoft.com/en-us/azure/virtual-machines/windows/instance-metadata-service?tabs=linux#route-parameters
+ "/compute/location?format=text"
+
+ # Location info is available since API version 2017-04-02
+ # https://docs.microsoft.com/en-us/azure/virtual-machines/windows/instance-metadata-service?tabs=linux#response-1
+ "&api-version=2021-01-01"
+ )
+ logger.info(
+ "Connecting to IMDS {}. "
+ "It may take a while if you are running outside of Azure. "
+ "You should consider opting in/out region behavior on-demand, "
+ 'by loading a boolean flag "is_deployed_in_azure" '
+ 'from your per-deployment config and then do '
+ '"app = ConfidentialClientApplication(..., '
+ 'azure_region=is_deployed_in_azure)"'.format(url))
+ try:
+ # https://docs.microsoft.com/en-us/azure/virtual-machines/windows/instance-metadata-service?tabs=linux#instance-metadata
+ resp = http_client.get(url, headers={"Metadata": "true"})
+ except:
+ logger.info(
+ "IMDS {} unavailable. Perhaps not running in Azure VM?".format(url))
+ return None
+ else:
+ return resp.text.strip()
+
diff --git a/msal/telemetry.py b/msal/telemetry.py
new file mode 100644
index 00000000..b07ab3ed
--- /dev/null
+++ b/msal/telemetry.py
@@ -0,0 +1,78 @@
+import uuid
+import logging
+
+
+logger = logging.getLogger(__name__)
+
+CLIENT_REQUEST_ID = 'client-request-id'
+CLIENT_CURRENT_TELEMETRY = "x-client-current-telemetry"
+CLIENT_LAST_TELEMETRY = "x-client-last-telemetry"
+NON_SILENT_CALL = 0
+FORCE_REFRESH = 1
+AT_ABSENT = 2
+AT_EXPIRED = 3
+AT_AGING = 4
+RESERVED = 5
+
+
+def _get_new_correlation_id():
+ return str(uuid.uuid4())
+
+
+class _TelemetryContext(object):
+ """It is used for handling the telemetry context for current OAuth2 "exchange"."""
+ # https://identitydivision.visualstudio.com/DevEx/_git/AuthLibrariesApiReview?path=%2FTelemetry%2FMSALServerSideTelemetry.md&_a=preview
+ _SUCCEEDED = "succeeded"
+ _FAILED = "failed"
+ _FAILURE_SIZE = "failure_size"
+ _CURRENT_HEADER_SIZE_LIMIT = 100
+ _LAST_HEADER_SIZE_LIMIT = 350
+
+ def __init__(self, buffer, lock, api_id, correlation_id=None, refresh_reason=None):
+ self._buffer = buffer
+ self._lock = lock
+ self._api_id = api_id
+ self._correlation_id = correlation_id or _get_new_correlation_id()
+ self._refresh_reason = refresh_reason or NON_SILENT_CALL
+ logger.debug("Generate or reuse correlation_id: %s", self._correlation_id)
+
+ def generate_headers(self):
+ with self._lock:
+ current = "4|{api_id},{cache_refresh}|".format(
+ api_id=self._api_id, cache_refresh=self._refresh_reason)
+ if len(current) > self._CURRENT_HEADER_SIZE_LIMIT:
+ logger.warning(
+ "Telemetry header greater than {} will be truncated by AAD".format(
+ self._CURRENT_HEADER_SIZE_LIMIT))
+ failures = self._buffer.get(self._FAILED, [])
+ return {
+ CLIENT_REQUEST_ID: self._correlation_id,
+ CLIENT_CURRENT_TELEMETRY: current,
+ CLIENT_LAST_TELEMETRY: "4|{succeeded}|{failed_requests}|{errors}|".format(
+ succeeded=self._buffer.get(self._SUCCEEDED, 0),
+ failed_requests=",".join("{a},{c}".format(**f) for f in failures),
+ errors=",".join(f["e"] for f in failures),
+ )
+ }
+
+ def hit_an_access_token(self):
+ with self._lock:
+ self._buffer[self._SUCCEEDED] = self._buffer.get(self._SUCCEEDED, 0) + 1
+
+ def update_telemetry(self, auth_result):
+ if auth_result:
+ with self._lock:
+ if "error" in auth_result:
+ self._record_failure(auth_result["error"])
+ else: # Telemetry sent successfully. Reset buffer
+ self._buffer.clear() # This won't work: self._buffer = {}
+
+ def _record_failure(self, error):
+ simulation = len(",{api_id},{correlation_id},{error}".format(
+ api_id=self._api_id, correlation_id=self._correlation_id, error=error))
+ if self._buffer.get(self._FAILURE_SIZE, 0) + simulation < self._LAST_HEADER_SIZE_LIMIT:
+ self._buffer[self._FAILURE_SIZE] = self._buffer.get(
+ self._FAILURE_SIZE, 0) + simulation
+ self._buffer.setdefault(self._FAILED, []).append({
+ "a": self._api_id, "c": self._correlation_id, "e": error})
+
diff --git a/msal/throttled_http_client.py b/msal/throttled_http_client.py
new file mode 100644
index 00000000..ebad76c7
--- /dev/null
+++ b/msal/throttled_http_client.py
@@ -0,0 +1,148 @@
+from threading import Lock
+from hashlib import sha256
+
+from .individual_cache import _IndividualCache as IndividualCache
+from .individual_cache import _ExpiringMapping as ExpiringMapping
+
+
+# https://datatracker.ietf.org/doc/html/rfc8628#section-3.4
+DEVICE_AUTH_GRANT = "urn:ietf:params:oauth:grant-type:device_code"
+
+
+class RetryAfterParser(object):
+ def __init__(self, default_value=None):
+ self._default_value = 5 if default_value is None else default_value
+
+ def parse(self, *, result, **ignored):
+ """Return seconds to throttle"""
+ response = result
+ lowercase_headers = {k.lower(): v for k, v in getattr(
+ # Historically, MSAL's HttpResponse does not always have headers
+ response, "headers", {}).items()}
+ if not (response.status_code == 429 or response.status_code >= 500
+ or "retry-after" in lowercase_headers):
+ return 0 # Quick exit
+ retry_after = lowercase_headers.get("retry-after", self._default_value)
+ try:
+ # AAD's retry_after uses integer format only
+ # https://stackoverflow.microsoft.com/questions/264931/264932
+ delay_seconds = int(retry_after)
+ except ValueError:
+ delay_seconds = self._default_value
+ return min(3600, delay_seconds)
+
+
+def _extract_data(kwargs, key, default=None):
+ data = kwargs.get("data", {}) # data is usually a dict, but occasionally a string
+ return data.get(key) if isinstance(data, dict) else default
+
+
+class ThrottledHttpClientBase(object):
+ """Throttle the given http_client by storing and retrieving data from cache.
+
+ This wrapper exists so that our patching post() and get() would prevent
+ re-patching side effect when/if same http_client being reused.
+
+ The subclass should implement post() and/or get()
+ """
+ def __init__(self, http_client, *, http_cache=None):
+ self.http_client = http_client
+ self._expiring_mapping = ExpiringMapping( # It will automatically clean up
+ mapping=http_cache if http_cache is not None else {},
+ capacity=1024, # To prevent cache blowing up especially for CCA
+ lock=Lock(), # TODO: This should ideally also allow customization
+ )
+
+ def post(self, *args, **kwargs):
+ return self.http_client.post(*args, **kwargs)
+
+ def get(self, *args, **kwargs):
+ return self.http_client.get(*args, **kwargs)
+
+ def close(self):
+ return self.http_client.close()
+
+ @staticmethod
+ def _hash(raw):
+ return sha256(repr(raw).encode("utf-8")).hexdigest()
+
+
+class ThrottledHttpClient(ThrottledHttpClientBase):
+ def __init__(self, http_client, *, default_throttle_time=None, **kwargs):
+ super(ThrottledHttpClient, self).__init__(http_client, **kwargs)
+
+ _post = http_client.post # We'll patch _post, and keep original post() intact
+
+ _post = IndividualCache(
+ # Internal specs requires throttling on at least token endpoint,
+ # here we have a generic patch for POST on all endpoints.
+ mapping=self._expiring_mapping,
+ key_maker=lambda func, args, kwargs:
+ "POST {} client_id={} scope={} hash={} 429/5xx/Retry-After".format(
+ args[0], # It is the url, typically containing authority and tenant
+ _extract_data(kwargs, "client_id"), # Per internal specs
+ _extract_data(kwargs, "scope"), # Per internal specs
+ self._hash(
+ # The followings are all approximations of the "account" concept
+ # to support per-account throttling.
+ # TODO: We may want to disable it for confidential client, though
+ _extract_data(kwargs, "refresh_token", # "account" during refresh
+ _extract_data(kwargs, "code", # "account" of auth code grant
+ _extract_data(kwargs, "username")))), # "account" of ROPC
+ ),
+ expires_in=RetryAfterParser(default_throttle_time or 5).parse,
+ )(_post)
+
+ _post = IndividualCache( # It covers the "UI required cache"
+ mapping=self._expiring_mapping,
+ key_maker=lambda func, args, kwargs: "POST {} hash={} 400".format(
+ args[0], # It is the url, typically containing authority and tenant
+ self._hash(
+ # Here we use literally all parameters, even those short-lived
+ # parameters containing timestamps (WS-Trust or POP assertion),
+ # because they will automatically be cleaned up by ExpiringMapping.
+ #
+ # Furthermore, there is no need to implement
+ # "interactive requests would reset the cache",
+ # because acquire_token_silent()'s would be automatically unblocked
+ # due to token cache layer operates on top of http cache layer.
+ #
+ # And, acquire_token_silent(..., force_refresh=True) will NOT
+ # bypass http cache, because there is no real gain from that.
+ # We won't bother implement it, nor do we want to encourage
+ # acquire_token_silent(..., force_refresh=True) pattern.
+ str(kwargs.get("params")) + str(kwargs.get("data"))),
+ ),
+ expires_in=lambda result=None, kwargs=None, **ignored:
+ 60
+ if result.status_code == 400
+ # Here we choose to cache exact HTTP 400 errors only (rather than 4xx)
+ # because they are the ones defined in OAuth2
+ # (https://datatracker.ietf.org/doc/html/rfc6749#section-5.2)
+ # Other 4xx errors might have different requirements e.g.
+ # "407 Proxy auth required" would need a key including http headers.
+ and not( # Exclude Device Flow whose retry is expected and regulated
+ isinstance(kwargs.get("data"), dict)
+ and kwargs["data"].get("grant_type") == DEVICE_AUTH_GRANT
+ )
+ and "retry-after" not in set( # Leave it to the Retry-After decorator
+ h.lower() for h in getattr(result, "headers", {}).keys())
+ else 0,
+ )(_post)
+
+ self.post = _post
+
+ self.get = IndividualCache( # Typically those discovery GETs
+ mapping=self._expiring_mapping,
+ key_maker=lambda func, args, kwargs: "GET {} hash={} 2xx".format(
+ args[0], # It is the url, sometimes containing inline params
+ self._hash(kwargs.get("params", "")),
+ ),
+ expires_in=lambda result=None, **ignored:
+ 3600*24 if 200 <= result.status_code < 300 else 0,
+ )(http_client.get)
+
+ # The following 2 methods have been defined dynamically by __init__()
+ #def post(self, *args, **kwargs): pass
+ #def get(self, *args, **kwargs): pass
+
diff --git a/msal/token_cache.py b/msal/token_cache.py
new file mode 100644
index 00000000..e554e118
--- /dev/null
+++ b/msal/token_cache.py
@@ -0,0 +1,418 @@
+import json
+import threading
+import time
+import logging
+import warnings
+
+from .authority import canonicalize
+from .oauth2cli.oidc import decode_part, decode_id_token
+from .oauth2cli.oauth2 import Client
+
+
+logger = logging.getLogger(__name__)
+_GRANT_TYPE_BROKER = "broker"
+
+def is_subdict_of(small, big):
+ return dict(big, **small) == big
+
+def _get_username(id_token_claims):
+ return id_token_claims.get(
+ "preferred_username", # AAD
+ id_token_claims.get("upn")) # ADFS 2019
+
+class TokenCache(object):
+ """This is considered as a base class containing minimal cache behavior.
+
+ Although it maintains tokens using unified schema across all MSAL libraries,
+ this class does not serialize/persist them.
+ See subclass :class:`SerializableTokenCache` for details on serialization.
+ """
+
+ class CredentialType:
+ ACCESS_TOKEN = "AccessToken"
+ REFRESH_TOKEN = "RefreshToken"
+ ACCOUNT = "Account" # Not exactly a credential type, but we put it here
+ ID_TOKEN = "IdToken"
+ APP_METADATA = "AppMetadata"
+
+ class AuthorityType:
+ ADFS = "ADFS"
+ MSSTS = "MSSTS" # MSSTS means AAD v2 for both AAD & MSA
+
+ def __init__(self):
+ self._lock = threading.RLock()
+ self._cache = {}
+ self.key_makers = {
+ self.CredentialType.REFRESH_TOKEN:
+ lambda home_account_id=None, environment=None, client_id=None,
+ target=None, **ignored_payload_from_a_real_token:
+ "-".join([
+ home_account_id or "",
+ environment or "",
+ self.CredentialType.REFRESH_TOKEN,
+ client_id or "",
+ "", # RT is cross-tenant in AAD
+ target or "", # raw value could be None if deserialized from other SDK
+ ]).lower(),
+ self.CredentialType.ACCESS_TOKEN:
+ lambda home_account_id=None, environment=None, client_id=None,
+ realm=None, target=None, **ignored_payload_from_a_real_token:
+ "-".join([
+ home_account_id or "",
+ environment or "",
+ self.CredentialType.ACCESS_TOKEN,
+ client_id or "",
+ realm or "",
+ target or "",
+ ]).lower(),
+ self.CredentialType.ID_TOKEN:
+ lambda home_account_id=None, environment=None, client_id=None,
+ realm=None, **ignored_payload_from_a_real_token:
+ "-".join([
+ home_account_id or "",
+ environment or "",
+ self.CredentialType.ID_TOKEN,
+ client_id or "",
+ realm or "",
+ "" # Albeit irrelevant, schema requires an empty scope here
+ ]).lower(),
+ self.CredentialType.ACCOUNT:
+ lambda home_account_id=None, environment=None, realm=None,
+ **ignored_payload_from_a_real_entry:
+ "-".join([
+ home_account_id or "",
+ environment or "",
+ realm or "",
+ ]).lower(),
+ self.CredentialType.APP_METADATA:
+ lambda environment=None, client_id=None, **kwargs:
+ "appmetadata-{}-{}".format(environment or "", client_id or ""),
+ }
+
+ def _get_access_token(
+ self,
+ home_account_id, environment, client_id, realm, target, # Together they form a compound key
+ default=None,
+ ): # O(1)
+ return self._get(
+ self.CredentialType.ACCESS_TOKEN,
+ self.key_makers[TokenCache.CredentialType.ACCESS_TOKEN](
+ home_account_id=home_account_id,
+ environment=environment,
+ client_id=client_id,
+ realm=realm,
+ target=" ".join(target),
+ ),
+ default=default)
+
+ def _get_app_metadata(self, environment, client_id, default=None): # O(1)
+ return self._get(
+ self.CredentialType.APP_METADATA,
+ self.key_makers[TokenCache.CredentialType.APP_METADATA](
+ environment=environment,
+ client_id=client_id,
+ ),
+ default=default)
+
+ def _get(self, credential_type, key, default=None): # O(1)
+ with self._lock:
+ return self._cache.get(credential_type, {}).get(key, default)
+
+ @staticmethod
+ def _is_matching(entry: dict, query: dict, target_set: set = None) -> bool:
+ return is_subdict_of(query or {}, entry) and (
+ target_set <= set(entry.get("target", "").split())
+ if target_set else True)
+
+ def search(self, credential_type, target=None, query=None): # O(n) generator
+ """Returns a generator of matching entries.
+
+ It is O(1) for AT hits, and O(n) for other types.
+ Note that it holds a lock during the entire search.
+ """
+ target = sorted(target or []) # Match the order sorted by add()
+ assert isinstance(target, list), "Invalid parameter type"
+
+ preferred_result = None
+ if (credential_type == self.CredentialType.ACCESS_TOKEN
+ and isinstance(query, dict)
+ and "home_account_id" in query and "environment" in query
+ and "client_id" in query and "realm" in query and target
+ ): # Special case for O(1) AT lookup
+ preferred_result = self._get_access_token(
+ query["home_account_id"], query["environment"],
+ query["client_id"], query["realm"], target)
+ if preferred_result and self._is_matching(
+ preferred_result, query,
+ # Needs no target_set here because it is satisfied by dict key
+ ):
+ yield preferred_result
+
+ target_set = set(target)
+ with self._lock:
+ # Since the target inside token cache key is (per schema) unsorted,
+ # there is no point to attempt an O(1) key-value search here.
+ # So we always do an O(n) in-memory search.
+ for entry in self._cache.get(credential_type, {}).values():
+ if (entry != preferred_result # Avoid yielding the same entry twice
+ and self._is_matching(entry, query, target_set=target_set)
+ ):
+ yield entry
+
+ def find(self, credential_type, target=None, query=None):
+ """Equivalent to list(search(...))."""
+ warnings.warn(
+ "Use list(search(...)) instead to explicitly get a list.",
+ DeprecationWarning)
+ return list(self.search(credential_type, target=target, query=query))
+
+ def add(self, event, now=None):
+ """Handle a token obtaining event, and add tokens into cache."""
+ def make_clean_copy(dictionary, sensitive_fields): # Masks sensitive info
+ return {
+ k: "********" if k in sensitive_fields else v
+ for k, v in dictionary.items()
+ }
+ clean_event = dict(
+ event,
+ data=make_clean_copy(event.get("data", {}), (
+ "password", "client_secret", "refresh_token", "assertion",
+ )),
+ response=make_clean_copy(event.get("response", {}), (
+ "id_token_claims", # Provided by broker
+ "access_token", "refresh_token", "id_token", "username",
+ )),
+ )
+ logger.debug("event=%s", json.dumps(
+ # We examined and concluded that this log won't have Log Injection risk,
+ # because the event payload is already in JSON so CR/LF will be escaped.
+ clean_event,
+ indent=4, sort_keys=True,
+ default=str, # assertion is in bytes in Python 3
+ ))
+ return self.__add(event, now=now)
+
+ def __parse_account(self, response, id_token_claims):
+ """Return client_info and home_account_id"""
+ if "client_info" in response: # It happens when client_info and profile are in request
+ client_info = json.loads(decode_part(response["client_info"]))
+ if "uid" in client_info and "utid" in client_info:
+ return client_info, "{uid}.{utid}".format(**client_info)
+ # https://github.com/AzureAD/microsoft-authentication-library-for-python/issues/387
+ if id_token_claims: # This would be an end user on ADFS-direct scenario
+ sub = id_token_claims["sub"] # "sub" always exists, per OIDC specs
+ return {"uid": sub}, sub
+ # client_credentials flow will reach this code path
+ return {}, None
+
+ def __add(self, event, now=None):
+ # event typically contains: client_id, scope, token_endpoint,
+ # response, params, data, grant_type
+ environment = realm = None
+ if "token_endpoint" in event:
+ _, environment, realm = canonicalize(event["token_endpoint"])
+ if "environment" in event: # Always available unless in legacy test cases
+ environment = event["environment"] # Set by application.py
+ response = event.get("response", {})
+ data = event.get("data", {})
+ access_token = response.get("access_token")
+ refresh_token = response.get("refresh_token")
+ id_token = response.get("id_token")
+ id_token_claims = response.get("id_token_claims") or ( # Prefer the claims from broker
+ # Only use decode_id_token() when necessary, it contains time-sensitive validation
+ decode_id_token(id_token, client_id=event["client_id"]) if id_token else {})
+ client_info, home_account_id = self.__parse_account(response, id_token_claims)
+
+ target = ' '.join(sorted(event.get("scope") or [])) # Schema should have required sorting
+
+ with self._lock:
+ now = int(time.time() if now is None else now)
+
+ if access_token:
+ default_expires_in = ( # https://www.rfc-editor.org/rfc/rfc6749#section-5.1
+ int(response.get("expires_on")) - now # Some Managed Identity emits this
+ ) if response.get("expires_on") else 600
+ expires_in = int( # AADv1-like endpoint returns a string
+ response.get("expires_in", default_expires_in))
+ ext_expires_in = int( # AADv1-like endpoint returns a string
+ response.get("ext_expires_in", expires_in))
+ at = {
+ "credential_type": self.CredentialType.ACCESS_TOKEN,
+ "secret": access_token,
+ "home_account_id": home_account_id,
+ "environment": environment,
+ "client_id": event.get("client_id"),
+ "target": target,
+ "realm": realm,
+ "token_type": response.get("token_type", "Bearer"),
+ "cached_at": str(now), # Schema defines it as a string
+ "expires_on": str(now + expires_in), # Same here
+ "extended_expires_on": str(now + ext_expires_in) # Same here
+ }
+ if data.get("key_id"): # It happens in SSH-cert or POP scenario
+ at["key_id"] = data.get("key_id")
+ if "refresh_in" in response:
+ refresh_in = response["refresh_in"] # It is an integer
+ at["refresh_on"] = str(now + refresh_in) # Schema wants a string
+ self.modify(self.CredentialType.ACCESS_TOKEN, at, at)
+
+ if client_info and not event.get("skip_account_creation"):
+ account = {
+ "home_account_id": home_account_id,
+ "environment": environment,
+ "realm": realm,
+ "local_account_id": event.get(
+ "_account_id", # Came from mid-tier code path.
+ # Emperically, it is the oid in AAD or cid in MSA.
+ id_token_claims.get("oid", id_token_claims.get("sub"))),
+ "username": _get_username(id_token_claims)
+ or data.get("username") # Falls back to ROPC username
+ or event.get("username") # Falls back to Federated ROPC username
+ or "", # The schema does not like null
+ "authority_type": event.get(
+ "authority_type", # Honor caller's choice of authority_type
+ self.AuthorityType.ADFS if realm == "adfs"
+ else self.AuthorityType.MSSTS),
+ # "client_info": response.get("client_info"), # Optional
+ }
+ grant_types_that_establish_an_account = (
+ _GRANT_TYPE_BROKER, "authorization_code", "password",
+ Client.DEVICE_FLOW["GRANT_TYPE"])
+ if event.get("grant_type") in grant_types_that_establish_an_account:
+ account["account_source"] = event["grant_type"]
+ self.modify(self.CredentialType.ACCOUNT, account, account)
+
+ if id_token:
+ idt = {
+ "credential_type": self.CredentialType.ID_TOKEN,
+ "secret": id_token,
+ "home_account_id": home_account_id,
+ "environment": environment,
+ "realm": realm,
+ "client_id": event.get("client_id"),
+ # "authority": "it is optional",
+ }
+ self.modify(self.CredentialType.ID_TOKEN, idt, idt)
+
+ if refresh_token:
+ rt = {
+ "credential_type": self.CredentialType.REFRESH_TOKEN,
+ "secret": refresh_token,
+ "home_account_id": home_account_id,
+ "environment": environment,
+ "client_id": event.get("client_id"),
+ "target": target, # Optional per schema though
+ "last_modification_time": str(now), # Optional. Schema defines it as a string.
+ }
+ if "foci" in response:
+ rt["family_id"] = response["foci"]
+ self.modify(self.CredentialType.REFRESH_TOKEN, rt, rt)
+
+ app_metadata = {
+ "client_id": event.get("client_id"),
+ "environment": environment,
+ }
+ if "foci" in response:
+ app_metadata["family_id"] = response.get("foci")
+ self.modify(self.CredentialType.APP_METADATA, app_metadata, app_metadata)
+
+ def modify(self, credential_type, old_entry, new_key_value_pairs=None):
+ # Modify the specified old_entry with new_key_value_pairs,
+ # or remove the old_entry if the new_key_value_pairs is None.
+
+ # This helper exists to consolidate all token add/modify/remove behaviors,
+ # so that the sub-classes will have only one method to work on,
+ # instead of patching a pair of update_xx() and remove_xx() per type.
+ # You can monkeypatch self.key_makers to support more types on-the-fly.
+ key = self.key_makers[credential_type](**old_entry)
+ with self._lock:
+ if new_key_value_pairs: # Update with them
+ entries = self._cache.setdefault(credential_type, {})
+ entries[key] = dict(
+ old_entry, # Do not use entries[key] b/c it might not exist
+ **new_key_value_pairs)
+ else: # Remove old_entry
+ self._cache.setdefault(credential_type, {}).pop(key, None)
+
+ def remove_rt(self, rt_item):
+ assert rt_item.get("credential_type") == self.CredentialType.REFRESH_TOKEN
+ return self.modify(self.CredentialType.REFRESH_TOKEN, rt_item)
+
+ def update_rt(self, rt_item, new_rt):
+ assert rt_item.get("credential_type") == self.CredentialType.REFRESH_TOKEN
+ return self.modify(self.CredentialType.REFRESH_TOKEN, rt_item, {
+ "secret": new_rt,
+ "last_modification_time": str(int(time.time())), # Optional. Schema defines it as a string.
+ })
+
+ def remove_at(self, at_item):
+ assert at_item.get("credential_type") == self.CredentialType.ACCESS_TOKEN
+ return self.modify(self.CredentialType.ACCESS_TOKEN, at_item)
+
+ def remove_idt(self, idt_item):
+ assert idt_item.get("credential_type") == self.CredentialType.ID_TOKEN
+ return self.modify(self.CredentialType.ID_TOKEN, idt_item)
+
+ def remove_account(self, account_item):
+ assert "authority_type" in account_item
+ return self.modify(self.CredentialType.ACCOUNT, account_item)
+
+
+class SerializableTokenCache(TokenCache):
+ """This serialization can be a starting point to implement your own persistence.
+
+ This class does NOT actually persist the cache on disk/db/etc..
+ Depending on your need,
+ the following simple recipe for file-based, unencrypted persistence may be sufficient::
+
+ import os, atexit, msal
+ cache_filename = os.path.join( # Persist cache into this file
+ os.getenv(
+ # Automatically wipe out the cache from Linux when user's ssh session ends.
+ # See also https://github.com/AzureAD/microsoft-authentication-library-for-python/issues/690
+ "XDG_RUNTIME_DIR", ""),
+ "my_cache.bin")
+ cache = msal.SerializableTokenCache()
+ if os.path.exists(cache_filename):
+ cache.deserialize(open(cache_filename, "r").read())
+ atexit.register(lambda:
+ open(cache_filename, "w").write(cache.serialize())
+ # Hint: The following optional line persists only when state changed
+ if cache.has_state_changed else None
+ )
+ app = msal.ClientApplication(..., token_cache=cache)
+ ...
+
+ Alternatively, you may use a more sophisticated cache persistence library,
+ `MSAL Extensions `_,
+ which provides token cache persistence with encryption, and more.
+
+ :var bool has_state_changed:
+ Indicates whether the cache state in the memory has changed since last
+ :func:`~serialize` or :func:`~deserialize` call.
+ """
+ has_state_changed = False
+
+ def add(self, event, **kwargs):
+ super(SerializableTokenCache, self).add(event, **kwargs)
+ self.has_state_changed = True
+
+ def modify(self, credential_type, old_entry, new_key_value_pairs=None):
+ super(SerializableTokenCache, self).modify(
+ credential_type, old_entry, new_key_value_pairs)
+ self.has_state_changed = True
+
+ def deserialize(self, state):
+ # type: (Optional[str]) -> None
+ """Deserialize the cache from a state previously obtained by serialize()"""
+ with self._lock:
+ self._cache = json.loads(state) if state else {}
+ self.has_state_changed = False # reset
+
+ def serialize(self):
+ # type: () -> str
+ """Serialize the current cache state into a string."""
+ with self._lock:
+ self.has_state_changed = False
+ return json.dumps(self._cache, indent=4)
+
diff --git a/msal/wstrust_request.py b/msal/wstrust_request.py
new file mode 100644
index 00000000..43a2804f
--- /dev/null
+++ b/msal/wstrust_request.py
@@ -0,0 +1,129 @@
+#------------------------------------------------------------------------------
+#
+# Copyright (c) Microsoft Corporation.
+# All rights reserved.
+#
+# This code is licensed under the MIT License.
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files(the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions :
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+#
+#------------------------------------------------------------------------------
+
+import uuid
+from datetime import datetime, timedelta
+import logging
+
+from .mex import Mex
+from .wstrust_response import parse_response
+
+logger = logging.getLogger(__name__)
+
+def send_request(
+ username, password, cloud_audience_urn, endpoint_address, soap_action, http_client,
+ **kwargs):
+ if not endpoint_address:
+ raise ValueError("WsTrust endpoint address can not be empty")
+ if soap_action is None:
+ if '/trust/2005/usernamemixed' in endpoint_address:
+ soap_action = Mex.ACTION_2005
+ elif '/trust/13/usernamemixed' in endpoint_address:
+ soap_action = Mex.ACTION_13
+ if soap_action not in (Mex.ACTION_13, Mex.ACTION_2005):
+ raise ValueError("Unsupported soap action: %s. "
+ "Contact your administrator to check your ADFS's MEX settings." % soap_action)
+ data = _build_rst(
+ username, password, cloud_audience_urn, endpoint_address, soap_action)
+ resp = http_client.post(endpoint_address, data=data, headers={
+ 'Content-type':'application/soap+xml; charset=utf-8',
+ 'SOAPAction': soap_action,
+ }, **kwargs)
+ if resp.status_code >= 400:
+ logger.debug("Unsuccessful WsTrust request receives: %s", resp.text)
+ # It turns out ADFS uses 5xx status code even with client-side incorrect password error
+ # resp.raise_for_status()
+ return parse_response(resp.text)
+
+
+def escape_password(password):
+ return (password.replace('&', '&').replace('"', '"')
+ .replace("'", ''') # the only one not provided by cgi.escape(s, True)
+ .replace('<', '<').replace('>', '>'))
+
+
+def wsu_time_format(datetime_obj):
+ # WsTrust (http://docs.oasis-open.org/ws-sx/ws-trust/v1.4/ws-trust.html)
+ # does not seem to define timestamp format, but we see YYYY-mm-ddTHH:MM:SSZ
+ # here (https://www.ibm.com/developerworks/websphere/library/techarticles/1003_chades/1003_chades.html)
+ # It avoids the uncertainty of the optional ".ssssss" in datetime.isoformat()
+ # https://docs.python.org/2/library/datetime.html#datetime.datetime.isoformat
+ return datetime_obj.strftime('%Y-%m-%dT%H:%M:%SZ')
+
+
+def _build_rst(username, password, cloud_audience_urn, endpoint_address, soap_action):
+ now = datetime.utcnow()
+ return """
+
+ {soap_action}
+ urn:uuid:{message_id}
+
+ http://www.w3.org/2005/08/addressing/anonymous
+
+ {endpoint_address}
+
+
+
+ {time_now}
+ {time_expire}
+
+
+ {username}
+ {password}
+
+
+
+
+
+
+
+
+ {applies_to}
+
+
+ {key_type}
+ {request_type}
+
+
+ """.format(
+ s=Mex.NS["s"], wsu=Mex.NS["wsu"], wsa=Mex.NS["wsa10"],
+ soap_action=soap_action, message_id=str(uuid.uuid4()),
+ endpoint_address=endpoint_address,
+ time_now=wsu_time_format(now),
+ time_expire=wsu_time_format(now + timedelta(minutes=10)),
+ username=username, password=escape_password(password),
+ wst=Mex.NS["wst"] if soap_action == Mex.ACTION_13 else Mex.NS["wst2005"],
+ applies_to=cloud_audience_urn,
+ key_type='http://docs.oasis-open.org/ws-sx/ws-trust/200512/Bearer'
+ if soap_action == Mex.ACTION_13 else
+ 'http://schemas.xmlsoap.org/ws/2005/05/identity/NoProofKey',
+ request_type='http://docs.oasis-open.org/ws-sx/ws-trust/200512/Issue'
+ if soap_action == Mex.ACTION_13 else
+ 'http://schemas.xmlsoap.org/ws/2005/02/trust/Issue',
+ )
+
diff --git a/msal/wstrust_response.py b/msal/wstrust_response.py
new file mode 100644
index 00000000..9c58af23
--- /dev/null
+++ b/msal/wstrust_response.py
@@ -0,0 +1,94 @@
+#------------------------------------------------------------------------------
+#
+# Copyright (c) Microsoft Corporation.
+# All rights reserved.
+#
+# This code is licensed under the MIT License.
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files(the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions :
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+#
+#------------------------------------------------------------------------------
+
+try:
+ from xml.etree import cElementTree as ET
+except ImportError:
+ from xml.etree import ElementTree as ET
+import re
+
+from .mex import Mex
+
+
+SAML_TOKEN_TYPE_V1 = 'urn:oasis:names:tc:SAML:1.0:assertion'
+SAML_TOKEN_TYPE_V2 = 'urn:oasis:names:tc:SAML:2.0:assertion'
+
+# http://docs.oasis-open.org/wss-m/wss/v1.1.1/os/wss-SAMLTokenProfile-v1.1.1-os.html#_Toc307397288
+WSS_SAML_TOKEN_PROFILE_V1_1 = "http://docs.oasis-open.org/wss/oasis-wss-saml-token-profile-1.1#SAMLV1.1"
+WSS_SAML_TOKEN_PROFILE_V2 = "http://docs.oasis-open.org/wss/oasis-wss-saml-token-profile-1.1#SAMLV2.0"
+
+def parse_response(body): # Returns {"token": "", "type": "..."}
+ token = parse_token_by_re(body)
+ if token:
+ return token
+ error = parse_error(body)
+ raise RuntimeError("WsTrust server returned error in RSTR: %s" % (error or body))
+
+def parse_error(body): # Returns error as a dict. See unit test case for an example.
+ dom = ET.fromstring(body)
+ reason_text_node = dom.find('s:Body/s:Fault/s:Reason/s:Text', Mex.NS)
+ subcode_value_node = dom.find('s:Body/s:Fault/s:Code/s:Subcode/s:Value', Mex.NS)
+ if reason_text_node is not None or subcode_value_node is not None:
+ return {"reason": reason_text_node.text, "code": subcode_value_node.text}
+
+def findall_content(xml_string, tag):
+ """
+ Given a tag name without any prefix,
+ this function returns a list of the raw content inside this tag as-is.
+
+ >>> findall_content(" what ever content ", "foo")
+ [" what ever content "]
+
+ Motivation:
+
+ Usually we would use XML parser to extract the data by xpath.
+ However the ElementTree in Python will implicitly normalize the output
+ by "hoisting" the inner inline namespaces into the outmost element.
+ The result will be a semantically equivalent XML snippet,
+ but not fully identical to the original one.
+ While this effect shouldn't become a problem in all other cases,
+ it does not seem to fully comply with Exclusive XML Canonicalization spec
+ (https://www.w3.org/TR/xml-exc-c14n/), and void the SAML token signature.
+ SAML signature algo needs the "XML -> C14N(XML) -> Signed(C14N(Xml))" order.
+
+ The binary extention lxml is probably the canonical way to solve this
+ (https://stackoverflow.com/questions/22959577/python-exclusive-xml-canonicalization-xml-exc-c14n)
+ but here we use this workaround, based on Regex, to return raw content as-is.
+ """
+ # \w+ is good enough for https://www.w3.org/TR/REC-xml/#NT-NameChar
+ pattern = r"<(?:\w+:)?%(tag)s(?:[^>]*)>(.*)=0.21,<2
+
+pytest-benchmark>=4,<5
+perf_baseline>=0.1,<0.2
+
diff --git a/sample/.env.sample.entra-id b/sample/.env.sample.entra-id
new file mode 100644
index 00000000..ea0e75c4
--- /dev/null
+++ b/sample/.env.sample.entra-id
@@ -0,0 +1,30 @@
+# This sample can be configured to work with Microsoft Entra ID.
+#
+# If you are using a Microsoft Entra ID tenant,
+# configure the AUTHORITY variable as
+# "https://login.microsoftonline.com/TENANT_GUID"
+# or "https://login.microsoftonline.com/contoso.onmicrosoft.com".
+#
+# Alternatively, use "https://login.microsoftonline.com/common" for multi-tenant app.
+AUTHORITY=
+
+CLIENT_ID=
+
+# Uncomment the following setting if you are using a confidential client
+# which has a client secret. Example value: your password
+#CLIENT_SECRET=
+
+# Configure this if you are using a confidential client which has a client credential.
+# Example value: {"private_key_pfx_path": "/path/to/your.pfx"}
+CLIENT_CREDENTIAL_JSON=
+
+# Multiple scopes can be added into the same line, separated by a space.
+# Here we use a Microsoft Graph API as an example
+# You may need to use your own API's scope.
+SCOPE=
+
+# Required if the sample app wants to call an API.
+#ENDPOINT=https://graph.microsoft.com/v1.0/me
+
+# Required if you are testing the username_password_sample.py
+#USERNAME=
diff --git a/sample/.env.sample.external-id b/sample/.env.sample.external-id
new file mode 100644
index 00000000..68e739f1
--- /dev/null
+++ b/sample/.env.sample.external-id
@@ -0,0 +1,26 @@
+# This sample can be configured to work with Microsoft External ID.
+#
+# If you are using a Microsoft Entra External ID for customers (CIAM) tenant,
+# configure AUTHORITY as https://contoso.ciamlogin.com/contoso.onmicrosoft.com
+AUTHORITY=
+
+CLIENT_ID=
+
+# Uncomment the following setting if you are using a confidential client
+# which has a client secret. Example value: your password
+#CLIENT_SECRET=
+
+# Configure this if you are using a confidential client which has a client credential.
+# Example value: {"private_key_pfx_path": "/path/to/your.pfx"}
+CLIENT_CREDENTIAL_JSON=
+
+# Multiple scopes can be added into the same line, separated by a space.
+# Here we use a Microsoft Graph API as an example
+# You may need to use your own API's scope.
+SCOPE=
+
+# Required if the sample app wants to call an API.
+#ENDPOINT=https://graph.microsoft.com/v1.0/me
+
+# Required if you are testing the username_password_sample.py
+#USERNAME=
diff --git a/sample/.env.sample.external-id-custom-domain b/sample/.env.sample.external-id-custom-domain
new file mode 100644
index 00000000..1d903302
--- /dev/null
+++ b/sample/.env.sample.external-id-custom-domain
@@ -0,0 +1,27 @@
+# This sample can be configured to work with Microsoft External ID with custom domain.
+#
+# If you are using a Microsoft External ID tenant with custom domain,
+# configure the OIDC_AUTHORITY variable as
+# "https://www.contoso.com/TENANT_GUID/v2.0"
+OIDC_AUTHORITY=
+
+CLIENT_ID=
+
+# Uncomment the following setting if you are using a confidential client
+# which has a client secret. Example value: your password
+#CLIENT_SECRET=
+
+# Configure this if you are using a confidential client which has a client credential.
+# Example value: {"private_key_pfx_path": "/path/to/your.pfx"}
+CLIENT_CREDENTIAL_JSON=
+
+# Multiple scopes can be added into the same line, separated by a space.
+# Here we use a Microsoft Graph API as an example
+# You may need to use your own API's scope.
+SCOPE=
+
+# Required if the sample app wants to call an API.
+#ENDPOINT=https://graph.microsoft.com/v1.0/me
+
+# Required if you are testing the username_password_sample.py
+#USERNAME=
diff --git a/sample/.env.sample.managed_identity b/sample/.env.sample.managed_identity
new file mode 100644
index 00000000..8b62f4f1
--- /dev/null
+++ b/sample/.env.sample.managed_identity
@@ -0,0 +1,17 @@
+# This sample can be configured to work with Microsoft Entra ID's Managed Identity.
+#
+# A user-assigned managed identity can be represented as a JSON blob.
+# Check MSAL Python's API Reference for its syntax.
+# https://msal-python.readthedocs.io/en/latest/#managed-identity
+#
+# Example value when using a user-assigned managed identity:
+# {"ManagedIdentityIdType": "ClientId", "Id": "your_managed_identity_id"}
+# Leave it empty or absent if you are using a system-assigned managed identity.
+MANAGED_IDENTITY=
+
+# Managed Identity works with resource, not scopes.
+RESOURCE=
+
+# Required if the sample app wants to call an API.
+#ENDPOINT=https://graph.microsoft.com/v1.0/me
+
diff --git a/sample/authorization-code-flow-sample/authorization_code_flow_sample.py b/sample/authorization-code-flow-sample/authorization_code_flow_sample.py
new file mode 100644
index 00000000..fb1503d0
--- /dev/null
+++ b/sample/authorization-code-flow-sample/authorization_code_flow_sample.py
@@ -0,0 +1,3 @@
+# We have moved!
+#
+# Please visit https://github.com/Azure-Samples/ms-identity-python-webapp
diff --git a/sample/confidential_client_sample.py b/sample/confidential_client_sample.py
new file mode 100644
index 00000000..e65af15a
--- /dev/null
+++ b/sample/confidential_client_sample.py
@@ -0,0 +1,78 @@
+"""
+This sample demonstrates a daemon application that acquires a token using a
+client secret and then calls a web API with the token.
+
+This sample loads its configuration from a .env file.
+
+To make this sample work, you need to choose one of the following templates:
+
+ .env.sample.entra-id
+ .env.sample.external-id
+ .env.sample.external-id-with-custom-domain
+
+Copy the chosen template to a new file named .env, and fill in the values.
+
+You can then run this sample:
+
+ python name_of_this_script.py
+"""
+
+import json
+import logging
+import os
+import time
+
+from dotenv import load_dotenv # Need "pip install python-dotenv"
+import msal
+import requests
+
+
+# Optional logging
+# logging.basicConfig(level=logging.DEBUG) # Enable DEBUG log for entire script
+# logging.getLogger("msal").setLevel(logging.INFO) # Optionally disable MSAL DEBUG logs
+
+load_dotenv() # We use this to load configuration from a .env file
+
+# If for whatever reason you plan to recreate same ClientApplication periodically,
+# you shall create one global token cache and reuse it by each ClientApplication
+global_token_cache = msal.TokenCache() # The TokenCache() is in-memory.
+ # See more options in https://msal-python.readthedocs.io/en/latest/#tokencache
+
+# Create a preferably long-lived app instance, to avoid the overhead of app creation
+global_app = msal.ConfidentialClientApplication(
+ os.getenv('CLIENT_ID'),
+ authority=os.getenv('AUTHORITY'), # For Entra ID or External ID
+ oidc_authority=os.getenv('OIDC_AUTHORITY'), # For External ID with custom domain
+ client_credential=os.getenv('CLIENT_SECRET') # ENV VAR contains a quotation mark-less string
+ or json.loads(os.getenv('CLIENT_CREDENTIAL_JSON')), # ENV VAR contains a JSON blob as a string
+ token_cache=global_token_cache, # Let this app (re)use an existing token cache.
+ # If absent, ClientApplication will create its own empty token cache
+ )
+scopes = os.getenv("SCOPE", "").split()
+
+
+def acquire_and_use_token():
+ # Since MSAL 1.23, acquire_token_for_client(...) will automatically look up
+ # a token from cache, and fall back to acquire a fresh token when needed.
+ result = global_app.acquire_token_for_client(scopes=scopes)
+
+ if "access_token" in result:
+ print("Token was obtained from:", result["token_source"]) # Since MSAL 1.25
+ if os.getenv('ENDPOINT'):
+ # Calling a web API using the access token
+ api_result = requests.get(
+ os.getenv('ENDPOINT'),
+ headers={'Authorization': 'Bearer ' + result['access_token']},
+ ).json() # Assuming the response is JSON
+ print("Web API call result", json.dumps(api_result, indent=2))
+ else:
+ print("Token acquisition result", json.dumps(result, indent=2))
+ else:
+ print("Token acquisition failed", result) # Examine result["error_description"] etc. to diagnose error
+
+
+while True: # Here we mimic a long-lived daemon
+ acquire_and_use_token()
+ print("Press Ctrl-C to stop.")
+ time.sleep(5) # Let's say your app would run a workload every X minutes
+
diff --git a/sample/device_flow_sample.py b/sample/device_flow_sample.py
new file mode 100644
index 00000000..8883d4b2
--- /dev/null
+++ b/sample/device_flow_sample.py
@@ -0,0 +1,112 @@
+"""
+This sample demonstrates a headless application that acquires a token using
+the device code flow and then calls a web API with the token.
+The configuration file would look like this:
+
+This sample loads its configuration from a .env file.
+
+To make this sample work, you need to choose one of the following templates:
+
+ .env.sample.entra-id
+ .env.sample.external-id
+ .env.sample.external-id-with-custom-domain
+
+Copy the chosen template to a new file named .env, and fill in the values.
+
+You can then run this sample:
+
+ python name_of_this_script.py
+"""
+
+import json
+import logging
+import os
+import sys
+import time
+
+from dotenv import load_dotenv # Need "pip install python-dotenv"
+import msal
+import requests
+
+
+# Optional logging
+# logging.basicConfig(level=logging.DEBUG) # Enable DEBUG log for entire script
+# logging.getLogger("msal").setLevel(logging.INFO) # Optionally disable MSAL DEBUG logs
+
+load_dotenv() # We use this to load configuration from a .env file
+
+# If for whatever reason you plan to recreate same ClientApplication periodically,
+# you shall create one global token cache and reuse it by each ClientApplication
+global_token_cache = msal.TokenCache() # The TokenCache() is in-memory.
+ # See more options in https://msal-python.readthedocs.io/en/latest/#tokencache
+
+# Create a preferably long-lived app instance, to avoid the overhead of app creation
+global_app = msal.PublicClientApplication(
+ os.getenv('CLIENT_ID'),
+ authority=os.getenv('AUTHORITY'), # For Entra ID or External ID
+ oidc_authority=os.getenv('OIDC_AUTHORITY'), # For External ID with custom domain
+ token_cache=global_token_cache, # Let this app (re)use an existing token cache.
+ # If absent, ClientApplication will create its own empty token cache
+ )
+scopes = os.getenv("SCOPE", "").split()
+
+
+def acquire_and_use_token():
+ # The pattern to acquire a token looks like this.
+ result = None
+
+ # Note: If your device-flow app does not have any interactive ability, you can
+ # completely skip the following cache part. But here we demonstrate it anyway.
+ # We now check the cache to see if we have some end users signed in before.
+ accounts = global_app.get_accounts()
+ if accounts:
+ logging.info("Account(s) exists in cache, probably with token too. Let's try.")
+ print("Pick the account you want to use to proceed:")
+ for a in accounts:
+ print(a["username"])
+ # Assuming the end user chose this one
+ chosen = accounts[0]
+ # Now let's try to find a token in cache for this account
+ result = global_app.acquire_token_silent(scopes, account=chosen)
+
+ if not result:
+ logging.info("No suitable token exists in cache. Let's get a new one from AAD.")
+
+ flow = global_app.initiate_device_flow(scopes=scopes)
+ if "user_code" not in flow:
+ raise ValueError(
+ "Fail to create device flow. Err: %s" % json.dumps(flow, indent=4))
+
+ print(flow["message"])
+ sys.stdout.flush() # Some terminal needs this to ensure the message is shown
+
+ # Ideally you should wait here, in order to save some unnecessary polling
+ # input("Press Enter after signing in from another device to proceed, CTRL+C to abort.")
+
+ result = global_app.acquire_token_by_device_flow(flow) # By default it will block
+ # You can follow this instruction to shorten the block time
+ # https://msal-python.readthedocs.io/en/latest/#msal.PublicClientApplication.acquire_token_by_device_flow
+ # or you may even turn off the blocking behavior,
+ # and then keep calling acquire_token_by_device_flow(flow) in your own customized loop.
+
+ if "access_token" in result:
+ print("Token was obtained from:", result["token_source"]) # Since MSAL 1.25
+ if os.getenv('ENDPOINT'):
+ # Calling a web API using the access token
+ api_result = requests.get(
+ os.getenv('ENDPOINT'),
+ headers={'Authorization': 'Bearer ' + result['access_token']},
+ ).json() # Assuming the response is JSON
+ print("Web API call result", json.dumps(api_result, indent=2))
+ else:
+ print("Token acquisition result", json.dumps(result, indent=2))
+ else:
+ print("Token acquisition failed", result) # Examine result["error_description"] etc. to diagnose error
+
+
+while True: # Here we mimic a long-lived daemon
+ acquire_and_use_token()
+ print("Press Ctrl-C to stop.")
+ time.sleep(5) # Let's say your app would run a workload every X minutes.
+ # The first acquire_and_use_token() call will prompt. Others hit the cache.
+
diff --git a/sample/interactive_sample.py b/sample/interactive_sample.py
new file mode 100644
index 00000000..8c3f2df9
--- /dev/null
+++ b/sample/interactive_sample.py
@@ -0,0 +1,111 @@
+"""
+This sample demonstrates a desktop application that acquires a token interactively
+and then calls a web API with the token.
+
+Prerequisite is documented here:
+https://msal-python.readthedocs.io/en/latest/#msal.PublicClientApplication.acquire_token_interactive
+
+This sample loads its configuration from a .env file.
+
+To make this sample work, you need to choose one of the following templates:
+
+ .env.sample.entra-id
+ .env.sample.external-id
+ .env.sample.external-id-with-custom-domain
+
+Copy the chosen template to a new file named .env, and fill in the values.
+
+You can then run this sample:
+
+ python name_of_this_script.py
+"""
+import json
+import logging
+import os
+import time
+
+from dotenv import load_dotenv # Need "pip install python-dotenv"
+import msal
+import requests
+
+
+# Optional logging
+# logging.basicConfig(level=logging.DEBUG) # Enable DEBUG log for entire script
+# logging.getLogger("msal").setLevel(logging.INFO) # Optionally disable MSAL DEBUG logs
+
+load_dotenv() # We use this to load configuration from a .env file
+
+# If for whatever reason you plan to recreate same ClientApplication periodically,
+# you shall create one global token cache and reuse it by each ClientApplication
+global_token_cache = msal.TokenCache() # The TokenCache() is in-memory.
+ # See more options in https://msal-python.readthedocs.io/en/latest/#tokencache
+
+# Create a preferably long-lived app instance, to avoid the overhead of app creation
+global_app = msal.PublicClientApplication(
+ os.getenv('CLIENT_ID'),
+ authority=os.getenv('AUTHORITY'), # For Entra ID or External ID
+ oidc_authority=os.getenv('OIDC_AUTHORITY'), # For External ID with custom domain
+ #enable_broker_on_windows=True, # Opted in. You will be guided to meet the prerequisites, if your app hasn't already
+ #enable_broker_on_mac=True, # Opted in. You will be guided to meet the prerequisites, if your app hasn't already
+
+ token_cache=global_token_cache, # Let this app (re)use an existing token cache.
+ # If absent, ClientApplication will create its own empty token cache
+ )
+scopes = os.getenv("SCOPE", "").split()
+
+
+def acquire_and_use_token():
+ # The pattern to acquire a token looks like this.
+ result = None
+
+ # Firstly, check the cache to see if this end user has signed in before
+ accounts = global_app.get_accounts(username=os.getenv("USERNAME"))
+ if accounts:
+ logging.info("Account(s) exists in cache, probably with token too. Let's try.")
+ print("Account(s) already signed in:")
+ for a in accounts:
+ print(a["username"])
+ chosen = accounts[0] # Assuming the end user chose this one to proceed
+ print("Proceed with account: %s" % chosen["username"])
+ # Now let's try to find a token in cache for this account
+ result = global_app.acquire_token_silent(scopes, account=chosen)
+
+ if not result:
+ logging.info("No suitable token exists in cache. Let's get a new one from AAD.")
+ print("A local browser window will be open for you to sign in. CTRL+C to cancel.")
+ result = global_app.acquire_token_interactive( # Only works if your app is registered with redirect_uri as http://localhost
+ scopes,
+ #parent_window_handle=..., # If broker is enabled, you will be guided to provide a window handle
+ login_hint=os.getenv("USERNAME"), # Optional.
+ # If you know the username ahead of time, this parameter can pre-fill
+ # the username (or email address) field of the sign-in page for the user,
+ # Often, apps use this parameter during reauthentication,
+ # after already extracting the username from an earlier sign-in
+ # by using the preferred_username claim from returned id_token_claims.
+
+ #prompt=msal.Prompt.SELECT_ACCOUNT, # Or simply "select_account". Optional. It forces to show account selector page
+ #prompt=msal.Prompt.CREATE, # Or simply "create". Optional. It brings user to a self-service sign-up flow.
+ # Prerequisite: https://docs.microsoft.com/en-us/azure/active-directory/external-identities/self-service-sign-up-user-flow
+ )
+
+ if "access_token" in result:
+ print("Token was obtained from:", result["token_source"]) # Since MSAL 1.25
+ if os.getenv('ENDPOINT'):
+ # Calling a web API using the access token
+ api_result = requests.get(
+ os.getenv('ENDPOINT'),
+ headers={'Authorization': 'Bearer ' + result['access_token']},
+ ).json() # Assuming the response is JSON
+ print("Web API call result", json.dumps(api_result, indent=2))
+ else:
+ print("Token acquisition result", json.dumps(result, indent=2))
+ else:
+ print("Token acquisition failed", result) # Examine result["error_description"] etc. to diagnose error
+
+
+while True: # Here we mimic a long-lived daemon
+ acquire_and_use_token()
+ print("Press Ctrl-C to stop.")
+ time.sleep(5) # Let's say your app would run a workload every X minutes
+ # The first acquire_and_use_token() call will prompt. Others hit the cache.
+
diff --git a/sample/managed_identity_sample.py b/sample/managed_identity_sample.py
new file mode 100644
index 00000000..95bf1b28
--- /dev/null
+++ b/sample/managed_identity_sample.py
@@ -0,0 +1,77 @@
+"""
+This sample demonstrates a daemon application that acquires a token using a
+managed identity and then calls a web API with the token.
+
+This sample loads its configuration from a .env file.
+
+To make this sample work, you need to choose this template:
+
+ .env.sample.managed_identity
+
+Copy the chosen template to a new file named .env, and fill in the values.
+
+You can then run this sample:
+
+ python name_of_this_script.py
+"""
+import json
+import logging
+import os
+import time
+
+from dotenv import load_dotenv # Need "pip install python-dotenv"
+import msal
+import requests
+
+
+# Optional logging
+# logging.basicConfig(level=logging.DEBUG) # Enable DEBUG log for entire script
+# logging.getLogger("msal").setLevel(logging.INFO) # Optionally disable MSAL DEBUG logs
+
+load_dotenv() # We use this to load configuration from a .env file
+
+# If for whatever reason you plan to recreate same ClientApplication periodically,
+# you shall create one global token cache and reuse it by each ClientApplication
+global_token_cache = msal.TokenCache() # The TokenCache() is in-memory.
+ # See more options in https://msal-python.readthedocs.io/en/latest/#tokencache
+
+# Create a managed identity instance based on the environment variable value
+if os.getenv('MANAGED_IDENTITY'):
+ managed_identity = json.loads(os.getenv('MANAGED_IDENTITY'))
+else:
+ managed_identity = msal.SystemAssignedManagedIdentity()
+
+# Create a preferably long-lived app instance, to avoid the overhead of app creation
+global_app = msal.ManagedIdentityClient(
+ managed_identity,
+ http_client=requests.Session(),
+ token_cache=global_token_cache, # Let this app (re)use an existing token cache.
+ # If absent, ClientApplication will create its own empty token cache
+ )
+resource = os.getenv("RESOURCE")
+
+
+def acquire_and_use_token():
+ # ManagedIdentityClient.acquire_token_for_client(...) will automatically look up
+ # a token from cache, and fall back to acquire a fresh token when needed.
+ result = global_app.acquire_token_for_client(resource=resource)
+
+ if "access_token" in result:
+ if os.getenv('ENDPOINT'):
+ # Calling a web API using the access token
+ api_result = requests.get(
+ os.getenv('ENDPOINT'),
+ headers={'Authorization': 'Bearer ' + result['access_token']},
+ ).json() # Assuming the response is JSON
+ print("Web API call result", json.dumps(api_result, indent=2))
+ else:
+ print("Token acquisition result", json.dumps(result, indent=2))
+ else:
+ print("Token acquisition failed", result) # Examine result["error_description"] etc. to diagnose error
+
+
+while True: # Here we mimic a long-lived daemon
+ acquire_and_use_token()
+ print("Press Ctrl-C to stop.")
+ time.sleep(5) # Let's say your app would run a workload every X minutes
+
diff --git a/sample/migrate_rt.py b/sample/migrate_rt.py
new file mode 100644
index 00000000..e854866d
--- /dev/null
+++ b/sample/migrate_rt.py
@@ -0,0 +1,67 @@
+"""
+The configuration file would look like this:
+
+{
+ "authority": "https://login.microsoftonline.com/organizations",
+ "client_id": "your_client_id came from https://learn.microsoft.com/entra/identity-platform/quickstart-register-app",
+ "scope": ["User.ReadBasic.All"],
+ // You can find the other permission names from this document
+ // https://docs.microsoft.com/en-us/graph/permissions-reference
+}
+
+You can then run this sample with a JSON configuration file:
+
+ python sample.py parameters.json
+"""
+
+import sys # For simplicity, we'll read config file from 1st CLI param sys.argv[1]
+import json
+import logging
+
+import msal
+
+
+# Optional logging
+# logging.basicConfig(level=logging.DEBUG) # Enable DEBUG log for entire script
+# logging.getLogger("msal").setLevel(logging.INFO) # Optionally disable MSAL DEBUG logs
+
+def get_preexisting_rt_and_their_scopes_from_elsewhere():
+ # Maybe you have an ADAL-powered app like this
+ # https://github.com/AzureAD/azure-activedirectory-library-for-python/blob/1.2.3/sample/device_code_sample.py#L72
+ # which uses a resource rather than a scope,
+ # you need to convert your v1 resource into v2 scopes
+ # See https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison#scopes-not-resources
+ # You may be able to append "/.default" to your v1 resource to form a scope
+ # See https://docs.microsoft.com/azure/active-directory/develop/v2-permissions-and-consent#the-default-scope
+
+ # Or maybe you have an app already talking to Microsoft identity platform v2,
+ # powered by some 3rd-party auth library, and persist its tokens somehow.
+
+ # Either way, you need to extract RTs from there, and return them like this.
+ return [
+ ("old_rt_1", ["scope1", "scope2"]),
+ ("old_rt_2", ["scope3", "scope4"]),
+ ]
+
+
+# We will migrate all the old RTs into a new app powered by MSAL
+config = json.load(open(sys.argv[1]))
+app = msal.PublicClientApplication(
+ config["client_id"], authority=config["authority"],
+ # token_cache=... # Default cache is in memory only.
+ # You can learn how to use SerializableTokenCache from
+ # https://msal-python.readthedocs.io/en/latest/#msal.SerializableTokenCache
+ )
+
+# We choose a migration strategy of migrating all RTs in one loop
+for old_rt, scopes in get_preexisting_rt_and_their_scopes_from_elsewhere():
+ result = app.acquire_token_by_refresh_token(old_rt, scopes)
+ if "error" in result:
+ print("Discarding unsuccessful RT. Error: ", json.dumps(result, indent=2))
+
+print("Migration completed")
+
+# From now on, those successfully-migrated RTs are saved inside MSAL's cache,
+# and becomes available in normal MSAL coding pattern, which is NOT part of migration.
+# You can refer to:
+# https://github.com/AzureAD/microsoft-authentication-library-for-python/blob/1.2.0/sample/device_flow_sample.py#L42-L60
diff --git a/sample/username_password_sample.py b/sample/username_password_sample.py
new file mode 100644
index 00000000..661d2db2
--- /dev/null
+++ b/sample/username_password_sample.py
@@ -0,0 +1,98 @@
+"""
+This sample demonstrates a desktop application that acquires a token using a
+pair of username and password, and then calls a web API with the token.
+
+This sample loads its configuration from a .env file.
+
+To make this sample work, you need to choose one of the following templates:
+
+ .env.sample.entra-id
+ .env.sample.external-id
+ .env.sample.external-id-with-custom-domain
+
+Copy the chosen template to a new file named .env, and fill in the values.
+
+You can then run this sample:
+
+ python name_of_this_script.py
+"""
+
+import getpass
+import json
+import logging
+import os
+import sys
+import time
+
+from dotenv import load_dotenv # Need "pip install python-dotenv"
+import msal
+import requests
+
+
+# Optional logging
+# logging.basicConfig(level=logging.DEBUG) # Enable DEBUG log for entire script
+# logging.getLogger("msal").setLevel(logging.INFO) # Optionally disable MSAL DEBUG logs
+
+load_dotenv() # We use this to load configuration from a .env file
+if not os.getenv("USERNAME"):
+ sys.exit("Please provide a username in the environment variable USERNAME.")
+password = getpass.getpass("Password for {}: ".format(os.getenv("USERNAME")))
+
+# If for whatever reason you plan to recreate same ClientApplication periodically,
+# you shall create one global token cache and reuse it by each ClientApplication
+global_token_cache = msal.TokenCache() # The TokenCache() is in-memory.
+ # See more options in https://msal-python.readthedocs.io/en/latest/#tokencache
+
+# Create a preferably long-lived app instance, to avoid the overhead of app creation
+global_app = msal.ClientApplication(
+ os.getenv('CLIENT_ID'),
+ authority=os.getenv('AUTHORITY'), # For Entra ID or External ID
+ oidc_authority=os.getenv('OIDC_AUTHORITY'), # For External ID with custom domain
+ client_credential=os.getenv('CLIENT_SECRET') or None, # Treat empty string as None
+ token_cache=global_token_cache, # Let this app (re)use an existing token cache.
+ # If absent, ClientApplication will create its own empty token cache
+ )
+scopes = os.getenv("SCOPE", "").split()
+
+
+def acquire_and_use_token():
+ # The pattern to acquire a token looks like this.
+ result = None
+
+ # Firstly, check the cache to see if this end user has signed in before
+ accounts = global_app.get_accounts(username=os.getenv("USERNAME"))
+ if accounts:
+ logging.info("Account(s) exists in cache, probably with token too. Let's try.")
+ result = global_app.acquire_token_silent(scopes, account=accounts[0])
+
+ if not result:
+ logging.info("No suitable token exists in cache. Let's get a new one from AAD.")
+ # See this page for constraints of Username Password Flow.
+ # https://github.com/AzureAD/microsoft-authentication-library-for-python/wiki/Username-Password-Authentication
+ result = global_app.acquire_token_by_username_password(
+ os.getenv("USERNAME"), password, scopes=scopes)
+
+ if "access_token" in result:
+ print("Token was obtained from:", result["token_source"]) # Since MSAL 1.25
+ if os.getenv('ENDPOINT'):
+ # Calling a web API using the access token
+ api_result = requests.get(
+ os.getenv('ENDPOINT'),
+ headers={'Authorization': 'Bearer ' + result['access_token']},
+ ).json() # Assuming the response is JSON
+ print("Web API call result", json.dumps(api_result, indent=2))
+ else:
+ print("Token acquisition result", json.dumps(result, indent=2))
+ else:
+ print("Token acquisition failed", result) # Examine result["error_description"] etc. to diagnose error
+ if 65001 in result.get("error_codes", []): # Not mean to be coded programatically, but...
+ raise RuntimeError(
+ "Microsoft Entra ID requires user consent for U/P flow to succeed. "
+ "Run acquire_token_interactive() instead.")
+
+
+while True: # Here we mimic a long-lived daemon
+ acquire_and_use_token()
+ print("Press Ctrl-C to stop.")
+ time.sleep(5) # Let's say your app would run a workload every X minutes.
+
diff --git a/sample/vault_jwt_sample.py b/sample/vault_jwt_sample.py
new file mode 100644
index 00000000..b9c51912
--- /dev/null
+++ b/sample/vault_jwt_sample.py
@@ -0,0 +1,142 @@
+"""
+The configuration file would look like this (sans those // comments):
+{
+ "tenant": "your_tenant_name",
+ // Your target tenant, DNS name
+ "client_id": "your_client_id came from https://learn.microsoft.com/entra/identity-platform/quickstart-register-app",
+ // Target app ID in Azure AD
+ "scope": ["https://graph.microsoft.com/.default"],
+ // Specific to Client Credentials Grant i.e. acquire_token_for_client(),
+ // you don't specify, in the code, the individual scopes you want to access.
+ // Instead, you statically declared them when registering your application.
+ // Therefore the only possible scope is "resource/.default"
+ // (here "https://graph.microsoft.com/.default")
+ // which means "the static permissions defined in the application".
+ "vault_tenant": "your_vault_tenant_name",
+ // Your Vault tenant may be different to your target tenant
+ // If that's not the case, you can set this to the same
+ // as "tenant"
+ "vault_clientid": "your_vault_client_id",
+ // Client ID of your vault app in your vault tenant
+ "vault_clientsecret": "your_vault_client_secret",
+ // Secret for your vault app
+ "vault_url": "your_vault_url",
+ // URL of your vault app
+ "cert": "your_cert_name",
+ // Name of your certificate in your vault
+ "cert_thumb": "your_cert_thumbprint",
+ // Thumbprint of your certificate
+ "endpoint": "https://graph.microsoft.com/v1.0/users"
+ // For this resource to work, you need to visit Application Permissions
+ // page in portal, declare scope User.Read.All, which needs admin consent
+ // https://github.com/Azure-Samples/ms-identity-python-daemon/blob/master/2-Call-MsGraph-WithCertificate/README.md
+}
+You can then run this sample with a JSON configuration file:
+ python sample.py parameters.json
+"""
+
+import base64
+import json
+import logging
+import requests
+import sys
+import time
+import uuid
+import msal
+
+# Optional logging
+# logging.basicConfig(level=logging.DEBUG) # Enable DEBUG log for entire script
+# logging.getLogger("msal").setLevel(logging.INFO) # Optionally disable MSAL DEBUG logs
+
+from azure.keyvault import KeyVaultClient, KeyVaultAuthentication
+from azure.common.credentials import ServicePrincipalCredentials
+from cryptography.hazmat.backends import default_backend
+from cryptography.hazmat.primitives import hashes
+
+config = json.load(open(sys.argv[1]))
+
+def auth_vault_callback(server, resource, scope):
+ credentials = ServicePrincipalCredentials(
+ client_id=config['vault_clientid'],
+ secret=config['vault_clientsecret'],
+ tenant=config['vault_tenant'],
+ resource='https://vault.azure.net'
+ )
+ token = credentials.token
+ return token['token_type'], token['access_token']
+
+
+def make_vault_jwt():
+
+ header = {
+ 'alg': 'RS256',
+ 'typ': 'JWT',
+ 'x5t': base64.b64encode(
+ config['cert_thumb'].decode('hex'))
+ }
+ header_b64 = base64.b64encode(json.dumps(header).encode('utf-8'))
+
+ body = {
+ 'aud': "https://login.microsoftonline.com/%s/oauth2/token" %
+ config['tenant'],
+ 'exp': (int(time.time()) + 600),
+ 'iss': config['client_id'],
+ 'jti': str(uuid.uuid4()),
+ 'nbf': int(time.time()),
+ 'sub': config['client_id']
+ }
+ body_b64 = base64.b64encode(json.dumps(body).encode('utf-8'))
+
+ full_b64 = b'.'.join([header_b64, body_b64])
+
+ client = KeyVaultClient(KeyVaultAuthentication(auth_vault_callback))
+ chosen_hash = hashes.SHA256()
+ hasher = hashes.Hash(chosen_hash, default_backend())
+ hasher.update(full_b64)
+ digest = hasher.finalize()
+ signed_digest = client.sign(config['vault_url'],
+ config['cert'], '', 'RS256',
+ digest).result
+
+ full_token = b'.'.join([full_b64, base64.b64encode(signed_digest)])
+
+ return full_token
+
+
+
+# If for whatever reason you plan to recreate same ClientApplication periodically,
+# you shall create one global token cache and reuse it by each ClientApplication
+global_token_cache = msal.TokenCache() # The TokenCache() is in-memory.
+ # See more options in https://msal-python.readthedocs.io/en/latest/#tokencache
+
+# Create a preferably long-lived app instance, to avoid the overhead of app creation
+global_app = msal.ConfidentialClientApplication(
+ config['client_id'],
+ authority="https://login.microsoftonline.com/%s" % config['tenant'],
+ client_credential={"client_assertion": make_vault_jwt()},
+ token_cache=global_token_cache, # Let this app (re)use an existing token cache.
+ # If absent, ClientApplication will create its own empty token cache
+ )
+
+
+def acquire_and_use_token():
+ # Since MSAL 1.23, acquire_token_for_client(...) will automatically look up
+ # a token from cache, and fall back to acquire a fresh token when needed.
+ result = global_app.acquire_token_for_client(scopes=config["scope"])
+
+ if "access_token" in result:
+ print("Token was obtained from:", result["token_source"]) # Since MSAL 1.25
+ # Calling graph using the access token
+ graph_data = requests.get( # Use token to call downstream service
+ config["endpoint"],
+ headers={'Authorization': 'Bearer ' + result['access_token']},).json()
+ print("Graph API call result: %s" % json.dumps(graph_data, indent=2))
+ else:
+ print("Token acquisition failed", result) # Examine result["error_description"] etc. to diagnose error
+
+
+while True: # Here we mimic a long-lived daemon
+ acquire_and_use_token()
+ print("Press Ctrl-C to stop.")
+ time.sleep(5) # Let's say your app would run a workload every X minutes
+
diff --git a/setup.cfg b/setup.cfg
new file mode 100644
index 00000000..33ec3f06
--- /dev/null
+++ b/setup.cfg
@@ -0,0 +1,71 @@
+# Format https://setuptools.pypa.io/en/latest/userguide/declarative_config.html
+
+[bdist_wheel]
+universal=0
+
+[metadata]
+name = msal
+version = attr: msal.__version__
+description = The Microsoft Authentication Library (MSAL) for Python library enables your app to access the Microsoft Cloud by supporting authentication of users with Microsoft Azure Active Directory accounts (AAD) and Microsoft Accounts (MSA) using industry standard OAuth2 and OpenID Connect.
+long_description = file: README.md
+long_description_content_type = text/markdown
+license = MIT
+author = Microsoft Corporation
+author_email = nugetaad@microsoft.com
+url = https://github.com/AzureAD/microsoft-authentication-library-for-python
+classifiers =
+ Development Status :: 5 - Production/Stable
+ Programming Language :: Python
+ Programming Language :: Python :: 3 :: Only
+ Programming Language :: Python :: 3
+ Programming Language :: Python :: 3.7
+ Programming Language :: Python :: 3.8
+ Programming Language :: Python :: 3.9
+ Programming Language :: Python :: 3.10
+ Programming Language :: Python :: 3.11
+ Programming Language :: Python :: 3.12
+ License :: OSI Approved :: MIT License
+ Operating System :: OS Independent
+
+project_urls =
+ Changelog = https://github.com/AzureAD/microsoft-authentication-library-for-python/releases
+ Documentation = https://msal-python.readthedocs.io/
+ Questions = https://stackoverflow.com/questions/tagged/azure-ad-msal+python
+ Feature/Bug Tracker = https://github.com/AzureAD/microsoft-authentication-library-for-python/issues
+
+
+[options]
+include_package_data = False # We used to ship LICENSE, but our __init__.py already mentions MIT
+packages = find:
+# Our test pipeline currently still covers Py37
+python_requires = >=3.7
+install_requires =
+ requests>=2.0.0,<3
+
+ # MSAL does not use jwt.decode(),
+ # therefore is insusceptible to CVE-2022-29217 so no need to bump to PyJWT 2.4+
+ PyJWT[crypto]>=1.0.0,<3
+
+ # load_key_and_certificates() is available since 2.5
+ # https://cryptography.io/en/latest/hazmat/primitives/asymmetric/serialization/#cryptography.hazmat.primitives.serialization.pkcs12.load_key_and_certificates
+ #
+ # And we will use the cryptography (X+3).0.0 as the upper bound,
+ # based on their latest deprecation policy
+ # https://cryptography.io/en/latest/api-stability/#deprecation
+ cryptography>=2.5,<46
+
+
+[options.extras_require]
+broker =
+ # The broker is defined as optional dependency,
+ # so that downstream apps can opt in. The opt-in is needed, partially because
+ # most existing MSAL Python apps do not have the redirect_uri needed by broker.
+ #
+ # We need pymsalruntime.CallbackData introduced in PyMsalRuntime 0.14
+ pymsalruntime>=0.14,<0.18; python_version>='3.6' and platform_system=='Windows'
+ # On Mac, PyMsalRuntime 0.17+ is expected to support SSH cert and ROPC
+ pymsalruntime>=0.17,<0.18; python_version>='3.8' and platform_system=='Darwin'
+
+[options.packages.find]
+exclude =
+ tests
diff --git a/setup.py b/setup.py
index a849b87b..1f21e1d5 100644
--- a/setup.py
+++ b/setup.py
@@ -1,36 +1,3 @@
-#!/usr/bin/env python
-from setuptools import setup
-import re, io
+from setuptools import setup
+setup()
-# setup.py shall not import its target package
-__version__ = re.search(
- r'__version__\s*=\s*[\'"]([^\'"]*)[\'"]', # It excludes inline comment too
- io.open('oauth2cli/__init__.py', encoding='utf_8_sig').read()
- ).group(1)
-
-setup(
- name='oauth2cli',
- version=__version__,
- description=('The generic, spec-compliant OAuth2 client-side library, '
- 'with callbacks for token storage.'),
- license='MIT',
- author='Ray Luo',
- author_email='rayluo.mba@gmail.com',
- url='https://github.com/rayluo/oauth2cli',
- classifiers=[
- 'Development Status :: 3 - Alpha',
- 'Programming Language :: Python',
- 'Programming Language :: Python :: 2',
- 'Programming Language :: Python :: 2.7',
- 'Programming Language :: Python :: 3',
- 'Programming Language :: Python :: 3.4',
- 'Programming Language :: Python :: 3.5',
- 'Programming Language :: Python :: 3.6',
- 'License :: OSI Approved :: MIT License',
- ],
- packages=['oauth2cli'],
- install_requires=[
- 'requests>=2.0.0,<3',
- 'PyJWT>=1.0.0,<3',
- ]
-)
diff --git a/tests/__init__.py b/tests/__init__.py
index 8c717de0..741b1e08 100644
--- a/tests/__init__.py
+++ b/tests/__init__.py
@@ -1,5 +1,6 @@
import sys
import logging
+
if sys.version_info[:2] < (2, 7):
# The unittest module got a significant overhaul in Python 2.7,
# so if we're in 2.6 we can use the backported version unittest2.
diff --git a/tests/archan.us.mex.xml b/tests/archan.us.mex.xml
new file mode 100644
index 00000000..00bc35eb
--- /dev/null
+++ b/tests/archan.us.mex.xml
@@ -0,0 +1,915 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ http://schemas.xmlsoap.org/ws/2005/02/trust/PublicKey
+ http://www.w3.org/2001/04/xmlenc#rsa-oaep-mgf1p
+ http://www.w3.org/2000/09/xmldsig#rsa-sha1
+ http://www.w3.org/2001/10/xml-exc-c14n#
+ http://www.w3.org/2001/04/xmlenc#aes256-cbc
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ http://schemas.xmlsoap.org/ws/2005/02/trust/SymmetricKey
+ 256
+ http://www.w3.org/2001/04/xmlenc#aes256-cbc
+ http://www.w3.org/2000/09/xmldsig#hmac-sha1
+ http://www.w3.org/2001/10/xml-exc-c14n#
+ http://www.w3.org/2001/04/xmlenc#aes256-cbc
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ http://docs.oasis-open.org/ws-sx/ws-trust/200512/PublicKey
+ http://www.w3.org/2001/04/xmlenc#rsa-oaep-mgf1p
+ http://www.w3.org/2001/04/xmlenc#rsa-oaep-mgf1p
+ http://www.w3.org/2000/09/xmldsig#rsa-sha1
+ http://www.w3.org/2001/10/xml-exc-c14n#
+ http://www.w3.org/2001/04/xmlenc#aes256-cbc
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ http://docs.oasis-open.org/ws-sx/ws-trust/200512/SymmetricKey
+ 256
+ http://www.w3.org/2001/04/xmlenc#rsa-oaep-mgf1p
+ http://www.w3.org/2001/04/xmlenc#aes256-cbc
+ http://www.w3.org/2000/09/xmldsig#hmac-sha1
+ http://www.w3.org/2001/10/xml-exc-c14n#
+ http://www.w3.org/2001/04/xmlenc#aes256-cbc
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ https://arvmserver2012.archan.us/adfs/services/trust/2005/windowstransport
+
+ host/ARVMServer2012.archan.us
+
+
+
+
+
+
+ https://arvmserver2012.archan.us/adfs/services/trust/2005/certificatemixed
+
+
+
+
+
+ https://arvmserver2012.archan.us/adfs/services/trust/2005/certificatetransport
+
+
+
+
+
+ https://arvmserver2012.archan.us/adfs/services/trust/2005/usernamemixed
+
+
+
+
+
+ https://arvmserver2012.archan.us/adfs/services/trust/2005/kerberosmixed
+
+
+
+
+
+ https://arvmserver2012.archan.us/adfs/services/trust/2005/issuedtokenmixedasymmetricbasic256
+
+
+
+
+
+ https://arvmserver2012.archan.us/adfs/services/trust/2005/issuedtokenmixedsymmetricbasic256
+
+
+
+
+
+ https://arvmserver2012.archan.us/adfs/services/trust/13/kerberosmixed
+
+
+
+
+
+ https://arvmserver2012.archan.us/adfs/services/trust/13/certificatemixed
+
+
+
+
+
+ https://arvmserver2012.archan.us/adfs/services/trust/13/usernamemixed
+
+
+
+
+
+ https://arvmserver2012.archan.us/adfs/services/trust/13/issuedtokenmixedasymmetricbasic256
+
+
+
+
+
+ https://arvmserver2012.archan.us/adfs/services/trust/13/issuedtokenmixedsymmetricbasic256
+
+
+
+
+
+ https://arvmserver2012.archan.us/adfs/services/trust/13/windowstransport
+
+ host/ARVMServer2012.archan.us
+
+
+
+
+
\ No newline at end of file
diff --git a/tests/arupela.mex.xml b/tests/arupela.mex.xml
new file mode 100644
index 00000000..03dd84c1
--- /dev/null
+++ b/tests/arupela.mex.xml
@@ -0,0 +1,866 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ http://schemas.xmlsoap.org/ws/2005/02/trust/PublicKey
+ http://www.w3.org/2001/04/xmlenc#rsa-oaep-mgf1p
+ http://www.w3.org/2000/09/xmldsig#rsa-sha1
+ http://www.w3.org/2001/10/xml-exc-c14n#
+ http://www.w3.org/2001/04/xmlenc#aes256-cbc
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ http://schemas.xmlsoap.org/ws/2005/02/trust/SymmetricKey
+ 256
+ http://www.w3.org/2001/04/xmlenc#aes256-cbc
+ http://www.w3.org/2000/09/xmldsig#hmac-sha1
+ http://www.w3.org/2001/10/xml-exc-c14n#
+ http://www.w3.org/2001/04/xmlenc#aes256-cbc
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ http://docs.oasis-open.org/ws-sx/ws-trust/200512/PublicKey
+ http://www.w3.org/2001/04/xmlenc#rsa-oaep-mgf1p
+ http://www.w3.org/2001/04/xmlenc#rsa-oaep-mgf1p
+ http://www.w3.org/2000/09/xmldsig#rsa-sha1
+ http://www.w3.org/2001/10/xml-exc-c14n#
+ http://www.w3.org/2001/04/xmlenc#aes256-cbc
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ http://docs.oasis-open.org/ws-sx/ws-trust/200512/SymmetricKey
+ 256
+ http://www.w3.org/2001/04/xmlenc#rsa-oaep-mgf1p
+ http://www.w3.org/2001/04/xmlenc#aes256-cbc
+ http://www.w3.org/2000/09/xmldsig#hmac-sha1
+ http://www.w3.org/2001/10/xml-exc-c14n#
+ http://www.w3.org/2001/04/xmlenc#aes256-cbc
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ https://fs.arupela.com/adfs/services/trust/2005/windowstransport
+
+ host/fs.arupela.com
+
+
+
+
+
+
+ https://fs.arupela.com/adfs/services/trust/2005/certificatemixed
+
+
+
+
+
+ https://fs.arupela.com:49443/adfs/services/trust/2005/certificatetransport
+
+
+
+
+
+ https://fs.arupela.com/adfs/services/trust/2005/usernamemixed
+
+
+
+
+
+ https://fs.arupela.com/adfs/services/trust/2005/kerberosmixed
+
+
+
+
+
+ https://fs.arupela.com/adfs/services/trust/2005/issuedtokenmixedasymmetricbasic256
+
+
+
+
+
+ https://fs.arupela.com/adfs/services/trust/2005/issuedtokenmixedsymmetricbasic256
+
+
+
+
+
+ https://fs.arupela.com/adfs/services/trust/13/kerberosmixed
+
+
+
+
+
+ https://fs.arupela.com/adfs/services/trust/13/certificatemixed
+
+
+
+
+
+ https://fs.arupela.com/adfs/services/trust/13/usernamemixed
+
+
+
+
+
+ https://fs.arupela.com/adfs/services/trust/13/issuedtokenmixedasymmetricbasic256
+
+
+
+
+
+ https://fs.arupela.com/adfs/services/trust/13/issuedtokenmixedsymmetricbasic256
+
+
+
+
\ No newline at end of file
diff --git a/tests/broker-test.py b/tests/broker-test.py
new file mode 100644
index 00000000..cdcc4817
--- /dev/null
+++ b/tests/broker-test.py
@@ -0,0 +1,95 @@
+"""This script is used to impersonate Azure CLI
+and run 3 pairs of end-to-end tests with broker.
+Although not fully automated, it requires only several clicks to finish.
+
+Each time a new PyMsalRuntime is going to be released,
+we can use this script to test it with a given version of MSAL Python.
+
+1. If you are on a modern Windows device, broker WAM is already built-in;
+ If you are on a mac device, install CP (Company Portal), login an account in CP and finish the MDM process.
+2. For installing MSAL Python from its latest `dev` branch:
+ `pip install --force-reinstall "git+https://github.com/AzureAD/microsoft-authentication-library-for-python.git[broker]"`
+3. (Optional) A proper version of `PyMsalRuntime` has already been installed by the previous command.
+ But if you want to test a specific version of `PyMsalRuntime`,
+ you shall manually install that version now.
+4. Run this test by `python broker-test.py` and make sure all the tests passed.
+
+"""
+import msal
+import getpass
+import os
+try:
+ from dotenv import load_dotenv # Use this only in local dev machine
+ load_dotenv() # take environment variables from .env.
+except:
+ pass
+
+_AZURE_CLI = "04b07795-8ddb-461a-bbee-02f9e1bf7b46"
+SCOPE_ARM = "https://management.azure.com/.default"
+placeholder_auth_scheme = msal.PopAuthScheme(
+ http_method=msal.PopAuthScheme.HTTP_GET,
+ url="https://example.com/endpoint",
+ nonce="placeholder",
+ )
+_JWK1 = """{"kty":"RSA", "n":"2tNr73xwcj6lH7bqRZrFzgSLj7OeLfbn8216uOMDHuaZ6TEUBDN8Uz0ve8jAlKsP9CQFCSVoSNovdE-fs7c15MxEGHjDcNKLWonznximj8pDGZQjVdfK-7mG6P6z-lgVcLuYu5JcWU_PeEqIKg5llOaz-qeQ4LEDS4T1D2qWRGpAra4rJX1-kmrWmX_XIamq30C9EIO0gGuT4rc2hJBWQ-4-FnE1NXmy125wfT3NdotAJGq5lMIfhjfglDbJCwhc8Oe17ORjO3FsB5CLuBRpYmP7Nzn66lRY3Fe11Xz8AEBl3anKFSJcTvlMnFtu3EpD-eiaHfTgRBU7CztGQqVbiQ", "e":"AQAB"}"""
+_SSH_CERT_DATA = {"token_type": "ssh-cert", "key_id": "key1", "req_cnf": _JWK1}
+_SSH_CERT_SCOPE = "https://pas.windows.net/CheckMyAccess/Linux/.default"
+
+pca = msal.PublicClientApplication(
+ _AZURE_CLI,
+ authority="https://login.microsoftonline.com/organizations",
+ enable_broker_on_mac=True,
+ enable_broker_on_windows=True)
+
+def interactive_and_silent(scopes, auth_scheme, data, expected_token_type):
+ print("An account picker shall be pop up, possibly behind this console. Continue from there.")
+ result = pca.acquire_token_interactive(
+ scopes,
+ prompt="select_account", # "az login" does this
+ parent_window_handle=pca.CONSOLE_WINDOW_HANDLE, # This script is a console app
+ enable_msa_passthrough=True, # Azure CLI is an MSA-passthrough app
+ auth_scheme=auth_scheme,
+ data=data or {},
+ )
+ _assert(result, expected_token_type)
+
+ accounts = pca.get_accounts()
+ assert accounts, "The logged in account should have been established by interactive flow"
+ result = pca.acquire_token_silent(
+ scopes,
+ account=accounts[0],
+ force_refresh=True, # Bypass MSAL Python's token cache to test PyMsalRuntime
+ auth_scheme=auth_scheme,
+ data=data or {},
+ )
+ _assert(result, expected_token_type)
+
+def test_broker_username_password(scopes, expected_token_type):
+ print("Testing broker username password flows by using accounts in local .env")
+ username = os.getenv("BROKER_TEST_ACCOUNT") or input("Input test account for broker test: ")
+ password = os.getenv("BROKER_TEST_ACCOUNT_PASSWORD") or getpass.getpass("Input test account's password: ")
+ assert(username and password, "You need to provide a test account and its password")
+ result = pca.acquire_token_by_username_password(username, password, scopes)
+ _assert(result, expected_token_type)
+ assert(result.get("token_source") == "broker")
+ print("Username password test succeeds.")
+
+def _assert(result, expected_token_type):
+ assert result.get("access_token"), f"We should obtain a token. Got {result} instead."
+ assert result.get("token_source") == "broker", "Token should be obtained via broker"
+ assert result.get("token_type").lower() == expected_token_type.lower(), f"{expected_token_type} not found"
+
+for i in range(2): # Mimic Azure CLI's issue report
+ interactive_and_silent(
+ scopes=[SCOPE_ARM], auth_scheme=None, data=None, expected_token_type="bearer")
+
+interactive_and_silent(
+ scopes=[SCOPE_ARM], auth_scheme=placeholder_auth_scheme, data=None, expected_token_type="pop")
+interactive_and_silent(
+ scopes=[_SSH_CERT_SCOPE],
+ data=_SSH_CERT_DATA,
+ auth_scheme=None,
+ expected_token_type="ssh-cert",
+ )
+
+test_broker_username_password(scopes=[SCOPE_ARM], expected_token_type="bearer")
diff --git a/tests/certificate-with-password.pem b/tests/certificate-with-password.pem
new file mode 100644
index 00000000..bca1bb58
--- /dev/null
+++ b/tests/certificate-with-password.pem
@@ -0,0 +1,51 @@
+-----BEGIN ENCRYPTED PRIVATE KEY-----
+MIIFHDBOBgkqhkiG9w0BBQ0wQTApBgkqhkiG9w0BBQwwHAQIpDOLr9sNuTwCAggA
+MAwGCCqGSIb3DQIJBQAwFAYIKoZIhvcNAwcECIWEFMkTyS60BIIEyPvMPGyf1shr
+ql0UnZzMWDz/9bqdRIZe5N7F1qYjgZNms/QXVzZOQ2J9YwaLHbwpEv2QigfHXq/3
+nLyTm4HFyg3qpCqWa33A0r/v5B6WtjgYbuPePqpM2UV34CMGylkmhMVUUbs1X6j7
+ezwmipq/paOslokC0RYl16cQD/uLTD0usTDtWoEs3S4gbcGUj/b9Ll2urG9zBYwI
+faSWQcwcRgfYk/OZSbv6zNT74dYMAOW3mjsS/ackc/+h2XWFQSVjN7BBXamfCQ3C
+qE27Py85PP8Qt7MbHuoj8rMuoaQ3NIi++1RkW6cyFo5n+HBi7YYCP74loG1OCTN8
+H5StIi2aLbls9ZbQJHLM2+J1tBwJqIR/UogITESV++17ZVHfDLk8uaad7i6Kj+u5
+6vbruehnFqo5P80lZRuqHfGf/5v8Hbsve/zL24wdQ+tFDHaC6v+kiz9unnO/+k86
+9gph/WTly4N4wJhdxhoYxJLMdPcWk6AxA7ZsJ/mI9+t8iHdSOZY91FyN3sDlDB4C
+yLi8t1WP+VB9KfMjSN0AuULWrwwQ1YGRUsKaS9pxTy8MbXQ1OgXGGHzHKDm6vqyp
+Jow9wD8Ql+V7zPsNgBpeRWXzA5VS6nEyIuOolkJnNoC5d69/LtDaBn58TZQ4z1Ja
+wGXG6n9BeFrgwgH5X5kGslLDXZ71V/aT0HHoBbiAPWf90teccGJ5nVXv3kMaC/zc
+klzNCrQ2koFphQgW1bU/FZ46yd2rvlFo8wbxAwRieldZpkwRcFVKz+cRh4/QsTpl
+uPKtPpI0c2jgiSReNXi2kRlkOPg1UVHnapvv2yRUoq4NvzaOegSVJG1oe/XdLS02
+5JoDNajEcIvHQpLZL1ecQSwpge843mW4F5twm8/1MKY8G2CTXjKif77n3WVR2Tvp
+RdOm86TbIB4FpbLAqiN11A/8cLNfVmioQkNdULLELfKiOeQZABSMPJMVGVxgODN0
+nP31BMibPayqApLLEFIQbSLhZvWIJ5ircZ5XKPHeuqpnxFoeIwrGQuqHo6gvSp5J
+CPv4Pul43y0s3vxRpJAqmXO4aAzsPsrYGJiNckbD43OxRV9ZDDeD1Wrc4u82zQxo
+frSy5XhVPsKH1lFZ7l6te4Tkro4vMxRVu+W2acToJI6QZct0xrlp+ScmD/9CEOGU
+Wj5SN4Y8YW+UfeYhDAhntzruRx4HjdocbvwYsY9gAkim4P9AdiG6eeRUyU9GCUwd
+MrjMt5HUzsTQiIyN9jnv9yWNdYmzgJ2V0ZOwVHaEZhZnkgYoK0O/NXSg0FsPo5LU
+qdYncK+BMAGnEl/riaJRmnsIH29jKPjZDOvfo1+0UJM3+zPjYy4985+CH7xWGWnb
+NQFBtwiPyWzlDyV3119T4rY+Ad6z90vG4hgvpvue1Qcuaure8NwkUEEh1/d8PN20
+kP4vWhpDeHbO5R5byXlJMNzmgVm3mc2t6mA/ouUcMmUOTvjdYALXqgw9RgOsqkob
+DNjEK4VZUu3Vd6AsK+s796KTLgQvZhrcahoer/88j7Nu0PyQGrVN202IfmbjIwer
+NNcieLmok6r2k8GvyUYP51hpdkXO5j3BsrtBeq4xn3qxzOtEUL8ITZ/BU20+xJq6
+GoGDjvCSBpzesnQFlvUtEw==
+-----END ENCRYPTED PRIVATE KEY-----
+-----BEGIN CERTIFICATE-----
+MIIDbTCCAlWgAwIBAgIUHBH8mppwjLI2dFOQ7haLnd6iRjQwDQYJKoZIhvcNAQEL
+BQAwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgMClNvbWUtU3RhdGUxITAfBgNVBAoM
+GEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZDAgFw0yMDAxMDMxODE2MzlaGA8yMTk5
+MDYwODE4MTYzOVowRTELMAkGA1UEBhMCQVUxEzARBgNVBAgMClNvbWUtU3RhdGUx
+ITAfBgNVBAoMGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZDCCASIwDQYJKoZIhvcN
+AQEBBQADggEPADCCAQoCggEBANMXamdgXR+0B2b6zt2nURcYcwC0YrqjvTH/ofF3
+MjUzZ1uKziPNxxAYrUY0O0zIcZWo9Aqfi10vS5oNya/aDrKoWxVRCsLltAV9dbLJ
+65zF7wbVE7ZnZ7Nknop+ytd1t1VNTlpbxgWdT6z/WTn4ydqH7Hlh0Ucu2Q3QGQL3
+G9He0kOMog4Y0myxP2xNGjLoig2kh60KEwtxbudOxVN4rLpqhT/1n/L5s+7rznKc
+cB4MRqPJMdycIYhTD2mfp/E9hDWRcVJY+9GlqzyxXFTsDsO1SzGgpMEjdO5mtc6N
+A0dd8fZQLt1BHLFJlpsuk5Fk40y7HtT3kYKUcD55Xd0pd6ECAwEAAaNTMFEwHQYD
+VR0OBBYEFKG65qd+cChhFLB8y4po+vL3HwxuMB8GA1UdIwQYMBaAFKG65qd+cChh
+FLB8y4po+vL3HwxuMA8GA1UdEwEB/wQFMAMBAf8wDQYJKoZIhvcNAQELBQADggEB
+AAlEqWO8tGKprQrqfdZDsMyKyne+WYYA7RqRxYzKJ5j1zsPa4f7RKhLYzx6TqWK3
+keBc6aw9aeNYNqTBeDLGHRHRRwdHwwU5HdqowhE0sEQzOIJvs2JK5L+LcoSkTViy
+PzidZ0qoAHRluuFw8Ag9sahcQfao6rqJOFY/16KEjDthATGo/4mHRsuAM+xza+2m
+GbqJH/iO/q0lsPb3culm8aoJNxULTHrU5YWhuGvRypSYrfdL7RBkzW4VEt5LcRK6
+KcfmfHMrjPl/XxSSvrBmly7nYNH80DGSMRP/lnrQ8OS+hSiDy1KBaCcNhja5Dyzn
+K0dXlMGmWrnDMs8m+4cUoIM=
+-----END CERTIFICATE-----
diff --git a/tests/certificate-with-password.pfx b/tests/certificate-with-password.pfx
new file mode 100644
index 00000000..a8d830c9
Binary files /dev/null and b/tests/certificate-with-password.pfx differ
diff --git a/tests/microsoft.mex.xml b/tests/microsoft.mex.xml
new file mode 100644
index 00000000..e68a8bef
--- /dev/null
+++ b/tests/microsoft.mex.xml
@@ -0,0 +1,916 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ http://schemas.xmlsoap.org/ws/2005/02/trust/PublicKey
+ http://www.w3.org/2001/04/xmlenc#rsa-oaep-mgf1p
+ http://www.w3.org/2000/09/xmldsig#rsa-sha1
+ http://www.w3.org/2001/10/xml-exc-c14n#
+ http://www.w3.org/2001/04/xmlenc#aes256-cbc
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ http://schemas.xmlsoap.org/ws/2005/02/trust/SymmetricKey
+ 256
+ http://www.w3.org/2001/04/xmlenc#aes256-cbc
+ http://www.w3.org/2000/09/xmldsig#hmac-sha1
+ http://www.w3.org/2001/10/xml-exc-c14n#
+ http://www.w3.org/2001/04/xmlenc#aes256-cbc
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ http://docs.oasis-open.org/ws-sx/ws-trust/200512/PublicKey
+ http://www.w3.org/2001/04/xmlenc#rsa-oaep-mgf1p
+ http://www.w3.org/2001/04/xmlenc#rsa-oaep-mgf1p
+ http://www.w3.org/2000/09/xmldsig#rsa-sha1
+ http://www.w3.org/2001/10/xml-exc-c14n#
+ http://www.w3.org/2001/04/xmlenc#aes256-cbc
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ http://docs.oasis-open.org/ws-sx/ws-trust/200512/SymmetricKey
+ 256
+ http://www.w3.org/2001/04/xmlenc#rsa-oaep-mgf1p
+ http://www.w3.org/2001/04/xmlenc#aes256-cbc
+ http://www.w3.org/2000/09/xmldsig#hmac-sha1
+ http://www.w3.org/2001/10/xml-exc-c14n#
+ http://www.w3.org/2001/04/xmlenc#aes256-cbc
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ https://corp.sts.microsoft.com/adfs/services/trust/2005/windowstransport
+
+ iamfed@redmond.corp.microsoft.com
+
+
+
+
+
+
+ https://corp.sts.microsoft.com/adfs/services/trust/2005/certificatemixed
+
+
+
+
+
+ https://corp.sts.microsoft.com/adfs/services/trust/2005/usernamemixed
+
+
+
+
+
+ https://corp.sts.microsoft.com/adfs/services/trust/2005/kerberosmixed
+
+
+
+
+
+ https://corp.sts.microsoft.com/adfs/services/trust/2005/issuedtokenmixedasymmetricbasic256
+
+
+
+
+
+ https://corp.sts.microsoft.com/adfs/services/trust/2005/issuedtokenmixedsymmetricbasic256
+
+
+
+
+
+ https://corp.sts.microsoft.com/adfs/services/trust/13/kerberosmixed
+
+
+
+
+
+ https://corp.sts.microsoft.com/adfs/services/trust/13/certificatemixed
+
+
+
+
+
+ https://corp.sts.microsoft.com/adfs/services/trust/13/usernamemixed
+
+
+
+
+
+ https://corp.sts.microsoft.com/adfs/services/trust/13/issuedtokenmixedasymmetricbasic256
+
+
+
+
+
+ https://corp.sts.microsoft.com/adfs/services/trust/13/issuedtokenmixedsymmetricbasic256
+
+
+
+
+
+ https://corp.sts.microsoft.com/adfs/services/trust/13/windowstransport
+
+ iamfed@redmond.corp.microsoft.com
+
+
+
+
+
\ No newline at end of file
diff --git a/tests/rst_response.xml b/tests/rst_response.xml
new file mode 100644
index 00000000..c0c06206
--- /dev/null
+++ b/tests/rst_response.xml
@@ -0,0 +1,90 @@
+
+
+ http://docs.oasis-open.org/ws-sx/ws-trust/200512/RSTRC/IssueFinal
+
+
+ 2013-11-15T03:08:25.221Z
+ 2013-11-15T03:13:25.221Z
+
+
+
+
+
+
+
+ 2013-11-15T03:08:25.205Z
+ 2013-11-15T04:08:25.205Z
+
+
+
+ https://login.microsoftonline.com/extSTS.srf
+
+
+
+
+
+
+ https://login.microsoftonline.com/extSTS.srf
+
+
+
+
+ 1TIu064jGEmmf+hnI+F0Jg==
+
+ urn:oasis:names:tc:SAML:1.0:cm:bearer
+
+
+
+ frizzo@richard-randall.com
+
+
+ 1TIu064jGEmmf+hnI+F0Jg==
+
+
+
+
+ 1TIu064jGEmmf+hnI+F0Jg==
+
+ urn:oasis:names:tc:SAML:1.0:cm:bearer
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 3i95D+nRbsyRitSPeT7ZtEr5vbM=
+
+
+ aVNmmKLNdAlBxxcNciWVfxynZUPR9ql8ZZSZt/qpqL/GB3HX/cL/QnfG2OOKrmhgEaR0Ul4grZhGJxlxMPDL0fhnBz+VJ5HwztMFgMYs3Md8A2sZd9n4dfu7+CByAna06lCwwfdFWlNV1MBFvlWvYtCLNkpYVr/aglmb9zpMkNxEOmHe/cwxUtYlzH4RpIsIT5pruoJtUxKcqTRDEeeYdzjBAiJuguQTChLmHNoMPdX1RmtJlPsrZ1s9R/IJky7fHLjB7jiTDceRCS5QUbgUqYbLG1MjFXthY2Hr7K9kpYjxxIk6xmM7mFQE3Hts3bj6UU7ElUvHpX9bxxk3pqzlhg==
+
+
+ MIIC6DCCAdCgAwIBAgIQaztYF2TpvZZG6yreA3NRpzANBgkqhkiG9w0BAQsFADAwMS4wLAYDVQQDEyVBREZTIFNpZ25pbmcgLSBmcy5yaWNoYXJkLXJhbmRhbGwuY29tMB4XDTEzMTExMTAzNTMwMFoXDTE0MTExMTAzNTMwMFowMDEuMCwGA1UEAxMlQURGUyBTaWduaW5nIC0gZnMucmljaGFyZC1yYW5kYWxsLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAO+1VWY/sYDdN3hdsvT+mWHTcOwjp2G9e0AEZdmgh7bS54WUJw9y0cMxJmGB0jAAW40zomzIbS8/o3iuxcJyFgBVtMFfXwFjVQJnZJ7IMXFs1V/pJHrwWHxePz/WzXFtMaqEIe8QummJ07UBg9UsYZUYTGO9NDGw1Yr/oRNsl7bLA0S/QlW6yryf6l3snHzIgtO2xiWn6q3vCJTTVNMROkI2YKNKdYiD5fFD77kFACfJmOwP8MN9u+HM2IN6g0Nv5s7rMyw077Co/xKefamWQCB0jLpv89jo3hLgkwIgWX4cMVgHSNmdzXSgC3owG8ivRuJDATh83GiqI6jzA1+x4rkCAwEAATANBgkqhkiG9w0BAQsFAAOCAQEAxA5MQZHw9lJYDpU4f45EYrWPEaAPnncaoxIeLE9fG14gA01frajRfdyoO0AKqb+ZG6sePKngsuq4QHA2EnEI4Di5uWKsXy1Id0AXUSUhLpe63alZ8OwiNKDKn71nwpXnlGwKqljnG3xBMniGtGKrFS4WM+joEHzaKpvgtGRGoDdtXF4UXZJcn2maw6d/kiHrQ3kWoQcQcJ9hVIo8bC0BPvxV0Qh4TF3Nb3tKhaXsY68eMxMGbHok9trVHQ3Vew35FuTg1JzsfCFSDF8sxu7FJ4iZ7VLM8MQLnvIMcubLJvc57EHSsNyeiqBFQIYkdg7MSf+Ot2qJjfExgo+NOtWN+g==
+
+
+
+
+
+
+
+ _9bd2b280-f153-471a-9b73-c1df0d555075
+
+
+
+
+ _9bd2b280-f153-471a-9b73-c1df0d555075
+
+
+ urn:oasis:names:tc:SAML:1.0:assertion
+ http://docs.oasis-open.org/ws-sx/ws-trust/200512/Issue
+ http://docs.oasis-open.org/ws-sx/ws-trust/200512/Bearer
+
+
+
+
\ No newline at end of file
diff --git a/tests/simulator.py b/tests/simulator.py
new file mode 100644
index 00000000..ea82cf38
--- /dev/null
+++ b/tests/simulator.py
@@ -0,0 +1,69 @@
+"""Simulator(s) that can be used to create MSAL instance
+whose token cache is in a certain state, and remains unchanged.
+This generic simulator(s) becomes the test subject for different benchmark tools.
+
+For example, you can install pyperf and then run:
+
+ pyperf timeit -s "from tests.simulator import ClientCredentialGrantSimulator as T; t=T(tokens_per_tenant=1, cache_hit=True)" "t.run()"
+"""
+import json
+import logging
+import random
+from unittest.mock import patch
+
+import msal
+from tests.http_client import MinimalResponse
+
+
+logger = logging.getLogger(__name__)
+
+
+def _count_access_tokens(app):
+ return len(app.token_cache._cache[app.token_cache.CredentialType.ACCESS_TOKEN])
+
+
+class ClientCredentialGrantSimulator(object):
+
+ def __init__(self, number_of_tenants=1, tokens_per_tenant=1, cache_hit=False):
+ logger.info(
+ "number_of_tenants=%d, tokens_per_tenant=%d, cache_hit=%s",
+ number_of_tenants, tokens_per_tenant, cache_hit)
+ with patch.object(msal.authority, "tenant_discovery", return_value={
+ "authorization_endpoint": "https://contoso.com/placeholder",
+ "token_endpoint": "https://contoso.com/placeholder",
+ }) as _: # Otherwise it would fail on OIDC discovery
+ self.apps = [ # In MSAL Python, each CCA binds to one tenant only
+ msal.ConfidentialClientApplication(
+ "client_id", client_credential="foo",
+ authority="https://login.microsoftonline.com/tenant_%s" % t,
+ ) for t in range(number_of_tenants)
+ ]
+ for app in self.apps:
+ for i in range(tokens_per_tenant): # Populate token cache
+ self.run(app=app, scope="scope_{}".format(i))
+ assert tokens_per_tenant == _count_access_tokens(app), (
+ "Token cache did not populate correctly: {}".format(json.dumps(
+ app.token_cache._cache, indent=4)))
+
+ if cache_hit:
+ self.run(app=app)["access_token"] # Populate 1 token to be hit
+ expected_tokens = tokens_per_tenant + 1
+ else:
+ expected_tokens = tokens_per_tenant
+ app.token_cache.modify = lambda *args, **kwargs: None # Cache becomes read-only
+ self.run(app=app)["access_token"]
+ assert expected_tokens == _count_access_tokens(app), "Cache shall not grow"
+
+ def run(self, app=None, scope=None):
+ # This implementation shall be as concise as possible
+ app = app or random.choice(self.apps)
+ #return app.acquire_token_for_client([scope or "scope"], post=_fake)
+ return app.acquire_token_for_client(
+ [scope or "scope"],
+ post=lambda url, **kwargs: MinimalResponse( # Using an inline lambda is as fast as a standalone function
+ status_code=200, text='''{
+ "access_token": "AT for %s",
+ "token_type": "bearer"
+ }''' % kwargs["data"]["scope"],
+ ))
+
diff --git a/tests/smoke-test.md b/tests/smoke-test.md
new file mode 100644
index 00000000..a0d35daf
--- /dev/null
+++ b/tests/smoke-test.md
@@ -0,0 +1,68 @@
+# How to Smoke Test MSAL Python
+
+The experimental `python -m msal` usage is designed to be an interactive tool,
+which can impersonate arbitrary apps and test most of the MSAL Python APIs.
+Note that MSAL Python API's behavior is modeled after OIDC behavior in browser,
+which are not exactly the same as the broker API's behavior,
+despite that the two sets of API happen to have similar names.
+
+Tokens acquired during the tests will be cached by MSAL Python.
+MSAL Python uses an in-memory token cache by default.
+This test tool, however, saves a token cache snapshot on disk upon each exit,
+and you may choose to reuse it or start afresh during start up.
+
+Typical test cases are listed below.
+
+1. The tool starts with an empty token cache.
+ In this state, acquire_token_silent() shall always return empty result.
+
+2. When testing with broker, apps would need to register a certain redirect_uri
+ for the test cases below to work.
+ We will also test an app without the required redirect_uri registration,
+ MSAL Python shall return a meaningful error message on what URIs to register.
+
+3. Interactive acquire_token_interactive() shall get a token. In particular,
+
+ * The prompt=none option shall succeed when there is a default account,
+ or error out otherwise.
+ * The prompt=select_account option shall always prompt with an account picker.
+ * The prompt=absent option shall prompt an account picker UI
+ if there are multiple accounts available in browser
+ and none of them is considered a default account.
+ In such a case, an optional login_hint=`one_of_the_account@contoso.com`
+ shall bypass the account picker.
+
+ With a broker, the behavior shall largely match the browser behavior,
+ unless stated otherwise below.
+
+ * Broker (PyMsalRuntime) on Mac does not support silent signin,
+ so the prompt=absent will also always prompt.
+
+4. ROPC (Resource Owner Password Credential, a.k.a. the username password flow).
+ The acquire_token_by_username_password() is supported by broker on Windows.
+ As of Oct 2023, it is not yet supported by broker on Mac,
+ so it will fall back to non-broker behavior.
+
+5. After step 3 or 4, the acquire_token_silently() shall return a token fast,
+ because that is the same token returned by step 3 or 4, cached in MSAL Python.
+ We shall also retest this with the force_refresh=True,
+ a new token shall be obtained,
+ typically slower than a token served from MSAL Python's token cache.
+
+6. POP token.
+ POP token is supported via broker.
+ This tool test the POP token by using a hardcoded Signed Http Request (SHR).
+ A test is successful if the POP test function return a token with type as POP.
+
+7. SSH Cert.
+ The interactive test and silent test shall behave similarly to
+ their non ssh-cert counterparts, only the `token_type` would be different.
+
+8. Test the remove_account() API. It shall always be successful.
+ This effectively signs out an account from MSAL Python,
+ we can confirm that by running acquire_token_silent()
+ and see that account was gone.
+
+ The remove_account() shall also sign out from broker (if broker was enabled),
+ it does not sign out account from browser (even when browser was used).
+
diff --git a/tests/test_account_source.py b/tests/test_account_source.py
new file mode 100644
index 00000000..662f0419
--- /dev/null
+++ b/tests/test_account_source.py
@@ -0,0 +1,78 @@
+import json
+try:
+ from unittest.mock import patch
+except:
+ from mock import patch
+try:
+ import pymsalruntime
+ broker_available = True
+except ImportError:
+ broker_available = False
+import msal
+from tests import unittest
+from tests.test_token_cache import build_response
+from tests.http_client import MinimalResponse
+
+
+SCOPE = "scope_foo"
+TOKEN_RESPONSE = build_response(
+ access_token="at",
+ uid="uid", utid="utid", # So that it will create an account
+ scope=SCOPE, refresh_token="rt", # So that non-broker's acquire_token_silent() would work
+)
+
+def _mock_post(url, headers=None, *args, **kwargs):
+ return MinimalResponse(status_code=200, text=json.dumps(TOKEN_RESPONSE))
+
+@unittest.skipUnless(broker_available, "These test cases need pip install msal[broker]")
+@patch("msal.broker._acquire_token_silently", return_value=dict(
+ TOKEN_RESPONSE, _account_id="placeholder"))
+@patch.object(msal.authority, "tenant_discovery", return_value={
+ "authorization_endpoint": "https://contoso.com/placeholder",
+ "token_endpoint": "https://contoso.com/placeholder",
+}) # Otherwise it would fail on OIDC discovery
+class TestAccountSourceBehavior(unittest.TestCase):
+
+ def test_device_flow_and_its_silent_call_should_bypass_broker(self, _, mocked_broker_ats):
+ app = msal.PublicClientApplication("client_id", enable_broker_on_windows=True)
+ result = app.acquire_token_by_device_flow({"device_code": "123"}, post=_mock_post)
+ self.assertEqual(result["token_source"], "identity_provider")
+
+ account = app.get_accounts()[0]
+ self.assertEqual(account["account_source"], "urn:ietf:params:oauth:grant-type:device_code")
+
+ result = app.acquire_token_silent_with_error(
+ [SCOPE], account, force_refresh=True, post=_mock_post)
+ mocked_broker_ats.assert_not_called()
+ self.assertEqual(result["token_source"], "identity_provider")
+
+ def test_ropc_flow_and_its_silent_call_should_invoke_broker(self, _, mocked_broker_ats):
+ app = msal.PublicClientApplication("client_id", enable_broker_on_windows=True)
+ with patch("msal.broker._signin_silently", return_value=dict(TOKEN_RESPONSE, _account_id="placeholder")):
+ result = app.acquire_token_by_username_password(
+ "username", "placeholder", [SCOPE], post=_mock_post)
+ self.assertEqual(result["token_source"], "broker")
+
+ account = app.get_accounts()[0]
+ self.assertEqual(account["account_source"], "broker")
+
+ result = app.acquire_token_silent_with_error(
+ [SCOPE], account, force_refresh=True, post=_mock_post)
+ self.assertEqual(result["token_source"], "broker")
+
+ def test_interactive_flow_and_its_silent_call_should_invoke_broker(self, _, mocked_broker_ats):
+ app = msal.PublicClientApplication("client_id", enable_broker_on_windows=True)
+ with patch.object(app, "_acquire_token_interactive_via_broker", return_value=dict(
+ TOKEN_RESPONSE, _account_id="placeholder")):
+ result = app.acquire_token_interactive(
+ [SCOPE], parent_window_handle=app.CONSOLE_WINDOW_HANDLE)
+ self.assertEqual(result["token_source"], "broker")
+
+ account = app.get_accounts()[0]
+ self.assertEqual(account["account_source"], "broker")
+
+ result = app.acquire_token_silent_with_error(
+ [SCOPE], account, force_refresh=True, post=_mock_post)
+ mocked_broker_ats.assert_called_once()
+ self.assertEqual(result["token_source"], "broker")
+
diff --git a/tests/test_application.py b/tests/test_application.py
new file mode 100644
index 00000000..de916153
--- /dev/null
+++ b/tests/test_application.py
@@ -0,0 +1,829 @@
+# Note: Since Aug 2019 we move all e2e tests into test_e2e.py,
+# so this test_application file contains only unit tests without dependency.
+import json
+import logging
+import sys
+import time
+from unittest.mock import patch, Mock
+import msal
+from msal.application import (
+ extract_certs,
+ ClientApplication, PublicClientApplication, ConfidentialClientApplication,
+ _str2bytes, _merge_claims_challenge_and_capabilities,
+)
+from tests import unittest
+from tests.test_token_cache import build_id_token, build_response
+from tests.http_client import MinimalHttpClient, MinimalResponse
+from msal.telemetry import CLIENT_CURRENT_TELEMETRY, CLIENT_LAST_TELEMETRY
+
+
+logger = logging.getLogger(__name__)
+logging.basicConfig(level=logging.DEBUG)
+
+
+class TestHelperExtractCerts(unittest.TestCase): # It is used by SNI scenario
+
+ def test_extract_a_tag_less_public_cert(self):
+ pem = "my_cert"
+ self.assertEqual(["my_cert"], extract_certs(pem))
+
+ def test_extract_a_tag_enclosed_cert(self):
+ pem = """
+ -----BEGIN CERTIFICATE-----
+ my_cert
+ -----END CERTIFICATE-----
+ """
+ self.assertEqual(["my_cert"], extract_certs(pem))
+
+ def test_extract_multiple_tag_enclosed_certs(self):
+ pem = """
+ -----BEGIN CERTIFICATE-----
+ my_cert1
+ -----END CERTIFICATE-----
+
+ -----BEGIN CERTIFICATE-----
+ my_cert2
+ -----END CERTIFICATE-----
+ """
+ self.assertEqual(["my_cert1", "my_cert2"], extract_certs(pem))
+
+
+class TestBytesConversion(unittest.TestCase):
+ def test_string_to_bytes(self):
+ self.assertEqual(type(_str2bytes("some string")), type(b"bytes"))
+
+ def test_bytes_to_bytes(self):
+ self.assertEqual(type(_str2bytes(b"some bytes")), type(b"bytes"))
+
+
+class TestClientApplicationAcquireTokenSilentErrorBehaviors(unittest.TestCase):
+
+ def setUp(self):
+ self.authority_url = "https://login.microsoftonline.com/common"
+ self.authority = msal.authority.Authority(
+ self.authority_url, MinimalHttpClient())
+ self.scopes = ["s1", "s2"]
+ self.uid = "my_uid"
+ self.utid = "my_utid"
+ self.account = {"home_account_id": "{}.{}".format(self.uid, self.utid)}
+ self.rt = "this is a rt"
+ self.cache = msal.SerializableTokenCache()
+ self.client_id = "my_app"
+ self.cache.add({ # Pre-populate the cache
+ "client_id": self.client_id,
+ "scope": self.scopes,
+ "token_endpoint": "{}/oauth2/v2.0/token".format(self.authority_url),
+ "response": build_response(
+ access_token="an expired AT to trigger refresh", expires_in=-99,
+ uid=self.uid, utid=self.utid, refresh_token=self.rt),
+ }) # The add(...) helper populates correct home_account_id for future searching
+ self.app = ClientApplication(
+ self.client_id, authority=self.authority_url, token_cache=self.cache)
+
+ def test_cache_empty_will_be_returned_as_None(self):
+ self.app.token_cache = msal.SerializableTokenCache() # Reset it to empty
+ self.assertEqual(
+ None, self.app.acquire_token_silent_with_error(['cache_miss'], self.account))
+
+ def test_acquire_token_silent_will_suppress_error(self):
+ error_response = '{"error": "invalid_grant", "suberror": "xyz"}'
+ def tester(url, **kwargs):
+ return MinimalResponse(status_code=400, text=error_response)
+ self.assertEqual(None, self.app.acquire_token_silent(
+ self.scopes, self.account, post=tester))
+
+ def test_acquire_token_silent_with_error_will_return_error(self):
+ error_response = '{"error": "invalid_grant", "error_description": "xyz"}'
+ def tester(url, **kwargs):
+ return MinimalResponse(status_code=400, text=error_response)
+ self.assertEqual(json.loads(error_response), self.app.acquire_token_silent_with_error(
+ self.scopes, self.account, post=tester))
+
+ def test_atswe_will_map_some_suberror_to_classification_as_is(self):
+ error_response = '{"error": "invalid_grant", "suberror": "basic_action"}'
+ def tester(url, **kwargs):
+ return MinimalResponse(status_code=400, text=error_response)
+ result = self.app.acquire_token_silent_with_error(
+ self.scopes, self.account, post=tester)
+ self.assertEqual("basic_action", result.get("classification"))
+
+ def test_atswe_will_map_some_suberror_to_classification_to_empty_string(self):
+ error_response = '{"error": "invalid_grant", "suberror": "client_mismatch"}'
+ def tester(url, **kwargs):
+ return MinimalResponse(status_code=400, text=error_response)
+ result = self.app.acquire_token_silent_with_error(
+ self.scopes, self.account, post=tester)
+ self.assertEqual("", result.get("classification"))
+
+
+class TestClientApplicationAcquireTokenSilentFociBehaviors(unittest.TestCase):
+
+ def setUp(self):
+ self.authority_url = "https://login.microsoftonline.com/common"
+ self.authority = msal.authority.Authority(
+ self.authority_url, MinimalHttpClient())
+ self.scopes = ["s1", "s2"]
+ self.uid = "my_uid"
+ self.utid = "my_utid"
+ self.account = {"home_account_id": "{}.{}".format(self.uid, self.utid)}
+ self.frt = "what the frt"
+ self.cache = msal.SerializableTokenCache()
+ self.preexisting_family_app_id = "preexisting_family_app"
+ self.cache.add({ # Pre-populate a FRT
+ "client_id": self.preexisting_family_app_id,
+ "scope": self.scopes,
+ "token_endpoint": "{}/oauth2/v2.0/token".format(self.authority_url),
+ "response": build_response(
+ access_token="Siblings won't share AT. test_remove_account() will.",
+ id_token=build_id_token(aud=self.preexisting_family_app_id),
+ uid=self.uid, utid=self.utid, refresh_token=self.frt, foci="1"),
+ }) # The add(...) helper populates correct home_account_id for future searching
+
+ def test_unknown_orphan_app_will_attempt_frt_and_not_remove_it(self):
+ app = ClientApplication(
+ "unknown_orphan", authority=self.authority_url, token_cache=self.cache)
+ logger.debug("%s.cache = %s", self.id(), self.cache.serialize())
+ error_response = '{"error": "invalid_grant","error_description": "Was issued to another client"}'
+ def tester(url, data=None, **kwargs):
+ self.assertEqual(self.frt, data.get("refresh_token"), "Should attempt the FRT")
+ return MinimalResponse(status_code=400, text=error_response)
+ app._acquire_token_silent_by_finding_rt_belongs_to_me_or_my_family(
+ self.authority, self.scopes, self.account, post=tester)
+ self.assertNotEqual([], app.token_cache.find(
+ msal.TokenCache.CredentialType.REFRESH_TOKEN, query={"secret": self.frt}),
+ "The FRT should not be removed from the cache")
+
+ def test_known_orphan_app_will_skip_frt_and_only_use_its_own_rt(self):
+ app = ClientApplication(
+ "known_orphan", authority=self.authority_url, token_cache=self.cache)
+ rt = "RT for this orphan app. We will check it being used by this test case."
+ self.cache.add({ # Populate its RT and AppMetadata, so it becomes a known orphan app
+ "client_id": app.client_id,
+ "scope": self.scopes,
+ "token_endpoint": "{}/oauth2/v2.0/token".format(self.authority_url),
+ "response": build_response(uid=self.uid, utid=self.utid, refresh_token=rt),
+ })
+ logger.debug("%s.cache = %s", self.id(), self.cache.serialize())
+ def tester(url, data=None, **kwargs):
+ self.assertEqual(rt, data.get("refresh_token"), "Should attempt the RT")
+ return MinimalResponse(status_code=200, text='{}')
+ app._acquire_token_silent_by_finding_rt_belongs_to_me_or_my_family(
+ self.authority, self.scopes, self.account, post=tester)
+
+ def test_unknown_family_app_will_attempt_frt_and_join_family(self):
+ def tester(url, data=None, **kwargs):
+ self.assertEqual(
+ self.frt, data.get("refresh_token"), "Should attempt the FRT")
+ return MinimalResponse(
+ status_code=200, text=json.dumps(build_response(
+ uid=self.uid, utid=self.utid, foci="1", access_token="at")))
+ app = ClientApplication(
+ "unknown_family_app", authority=self.authority_url, token_cache=self.cache)
+ at = app._acquire_token_silent_by_finding_rt_belongs_to_me_or_my_family(
+ self.authority, self.scopes, self.account, post=tester)
+ logger.debug("%s.cache = %s", self.id(), self.cache.serialize())
+ self.assertEqual("at", at.get("access_token"), "New app should get a new AT")
+ app_metadata = app.token_cache.find(
+ msal.TokenCache.CredentialType.APP_METADATA,
+ query={"client_id": app.client_id})
+ self.assertNotEqual([], app_metadata, "Should record new app's metadata")
+ self.assertEqual("1", app_metadata[0].get("family_id"),
+ "The new family app should be recorded as in the same family")
+ # Known family app will simply use FRT, which is largely the same as this one
+
+ # Will not test scenario of app leaving family. Per specs, it won't happen.
+
+ def test_preexisting_family_app_will_attempt_frt_and_return_error(self):
+ error_response = '{"error": "invalid_grant", "error_description": "xyz"}'
+ def tester(url, data=None, **kwargs):
+ self.assertEqual(
+ self.frt, data.get("refresh_token"), "Should attempt the FRT")
+ return MinimalResponse(status_code=400, text=error_response)
+ app = ClientApplication(
+ "preexisting_family_app", authority=self.authority_url, token_cache=self.cache)
+ resp = app._acquire_token_silent_by_finding_rt_belongs_to_me_or_my_family(
+ self.authority, self.scopes, self.account, post=tester)
+ logger.debug("%s.cache = %s", self.id(), self.cache.serialize())
+ self.assertEqual(json.loads(error_response), resp, "Error raised will be returned")
+
+ def test_family_app_remove_account(self):
+ logger.debug("%s.cache = %s", self.id(), self.cache.serialize())
+ app = ClientApplication(
+ self.preexisting_family_app_id,
+ authority=self.authority_url, token_cache=self.cache)
+ account = app.get_accounts()[0]
+ mine = {"home_account_id": account["home_account_id"]}
+
+ self.assertNotEqual([], self.cache.find(
+ self.cache.CredentialType.ACCESS_TOKEN, query=mine))
+ self.assertNotEqual([], self.cache.find(
+ self.cache.CredentialType.REFRESH_TOKEN, query=mine))
+ self.assertNotEqual([], self.cache.find(
+ self.cache.CredentialType.ID_TOKEN, query=mine))
+ self.assertNotEqual([], self.cache.find(
+ self.cache.CredentialType.ACCOUNT, query=mine))
+
+ app.remove_account(account)
+
+ self.assertEqual([], self.cache.find(
+ self.cache.CredentialType.ACCESS_TOKEN, query=mine))
+ self.assertEqual([], self.cache.find(
+ self.cache.CredentialType.REFRESH_TOKEN, query=mine))
+ self.assertEqual([], self.cache.find(
+ self.cache.CredentialType.ID_TOKEN, query=mine))
+ self.assertEqual([], self.cache.find(
+ self.cache.CredentialType.ACCOUNT, query=mine))
+
+
+class TestClientApplicationForAuthorityMigration(unittest.TestCase):
+
+ @classmethod
+ def setUp(self):
+ self.environment_in_cache = "sts.windows.net"
+ self.authority_url_in_app = "https://login.microsoftonline.com/common"
+ self.scopes = ["s1", "s2"]
+ uid = "uid"
+ utid = "utid"
+ self.account = {"home_account_id": "{}.{}".format(uid, utid)}
+ self.client_id = "my_app"
+ self.access_token = "access token for testing authority aliases"
+ self.cache = msal.SerializableTokenCache()
+ self.cache.add({
+ "client_id": self.client_id,
+ "scope": self.scopes,
+ "token_endpoint": "https://{}/common/oauth2/v2.0/token".format(
+ self.environment_in_cache),
+ "response": build_response(
+ uid=uid, utid=utid,
+ access_token=self.access_token, refresh_token="some refresh token"),
+ }) # The add(...) helper populates correct home_account_id for future searching
+ self.app = ClientApplication(
+ self.client_id,
+ authority=self.authority_url_in_app, token_cache=self.cache)
+
+ def test_get_accounts_should_find_accounts_under_different_alias(self):
+ accounts = self.app.get_accounts()
+ self.assertNotEqual([], accounts)
+ self.assertEqual(self.environment_in_cache, accounts[0].get("environment"),
+ "We should be able to find an account under an authority alias")
+
+ def test_acquire_token_silent_should_find_at_under_different_alias(self):
+ result = self.app.acquire_token_silent(self.scopes, self.account)
+ self.assertNotEqual(None, result)
+ self.assertEqual(result[self.app._TOKEN_SOURCE], self.app._TOKEN_SOURCE_CACHE)
+ self.assertEqual(self.access_token, result.get('access_token'))
+
+ def test_acquire_token_silent_should_find_rt_under_different_alias(self):
+ self.cache._cache["AccessToken"] = {} # A hacky way to clear ATs
+ class ExpectedBehavior(Exception):
+ pass
+ def helper(scopes, account, authority, *args, **kwargs):
+ if authority.instance == self.environment_in_cache:
+ raise ExpectedBehavior("RT of different alias being attempted")
+ self.app._acquire_token_silent_from_cache_and_possibly_refresh_it = helper
+
+ with self.assertRaises(ExpectedBehavior):
+ self.app.acquire_token_silent(["different scope"], self.account)
+
+
+class TestApplicationForClientCapabilities(unittest.TestCase):
+
+ def test_capabilities_and_id_token_claims_merge(self):
+ client_capabilities = ["foo", "bar"]
+ claims_challenge = '''{"id_token": {"auth_time": {"essential": true}}}'''
+ merged_claims = '''{"id_token": {"auth_time": {"essential": true}},
+ "access_token": {"xms_cc": {"values": ["foo", "bar"]}}}'''
+ # Comparing dictionaries as JSON object order differs based on python version
+ self.assertEqual(
+ json.loads(merged_claims),
+ json.loads(_merge_claims_challenge_and_capabilities(
+ client_capabilities, claims_challenge)))
+
+ def test_capabilities_and_id_token_claims_and_access_token_claims_merge(self):
+ client_capabilities = ["foo", "bar"]
+ claims_challenge = '''{"id_token": {"auth_time": {"essential": true}},
+ "access_token": {"nbf":{"essential":true, "value":"1563308371"}}}'''
+ merged_claims = '''{"id_token": {"auth_time": {"essential": true}},
+ "access_token": {"nbf": {"essential": true, "value": "1563308371"},
+ "xms_cc": {"values": ["foo", "bar"]}}}'''
+ # Comparing dictionaries as JSON object order differs based on python version
+ self.assertEqual(
+ json.loads(merged_claims),
+ json.loads(_merge_claims_challenge_and_capabilities(
+ client_capabilities, claims_challenge)))
+
+ def test_no_capabilities_only_claims_merge(self):
+ claims_challenge = '''{"id_token": {"auth_time": {"essential": true}}}'''
+ self.assertEqual(
+ json.loads(claims_challenge),
+ json.loads(_merge_claims_challenge_and_capabilities(None, claims_challenge)))
+
+ def test_only_client_capabilities_no_claims_merge(self):
+ client_capabilities = ["foo", "bar"]
+ merged_claims = '''{"access_token": {"xms_cc": {"values": ["foo", "bar"]}}}'''
+ self.assertEqual(
+ json.loads(merged_claims),
+ json.loads(_merge_claims_challenge_and_capabilities(client_capabilities, None)))
+
+ def test_both_claims_and_capabilities_none(self):
+ self.assertEqual(_merge_claims_challenge_and_capabilities(None, None), None)
+
+
+class TestApplicationForRefreshInBehaviors(unittest.TestCase):
+ """The following test cases were based on design doc here
+ https://identitydivision.visualstudio.com/DevEx/_git/AuthLibrariesApiReview?path=%2FRefreshAtExpirationPercentage%2Foverview.md&version=GBdev&_a=preview&anchor=scenarios
+ """
+ authority_url = "https://login.microsoftonline.com/common"
+ scopes = ["s1", "s2"]
+ uid = "my_uid"
+ utid = "my_utid"
+ account = {"home_account_id": "{}.{}".format(uid, utid)}
+ rt = "this is a rt"
+ client_id = "my_app"
+
+ @classmethod
+ def setUpClass(cls): # Initialization at runtime, not interpret-time
+ cls.app = ClientApplication(cls.client_id, authority=cls.authority_url)
+
+ def setUp(self):
+ self.app.token_cache = self.cache = msal.SerializableTokenCache()
+
+ def populate_cache(self, access_token="at", expires_in=86400, refresh_in=43200):
+ self.cache.add({
+ "client_id": self.client_id,
+ "scope": self.scopes,
+ "token_endpoint": "{}/oauth2/v2.0/token".format(self.authority_url),
+ "response": build_response(
+ access_token=access_token,
+ expires_in=expires_in, refresh_in=refresh_in,
+ uid=self.uid, utid=self.utid, refresh_token=self.rt),
+ })
+
+ def assertRefreshOn(self, result, refresh_in):
+ refresh_on = int(time.time() + refresh_in)
+ self.assertTrue(
+ refresh_on - 1 < result.get("refresh_on", 0) < refresh_on + 1,
+ "refresh_on should be set properly")
+
+ def test_fresh_token_should_be_returned_from_cache(self):
+ # a.k.a. Return unexpired token that is not above token refresh expiration threshold
+ refresh_in = 450
+ access_token = "An access token prepopulated into cache"
+ self.populate_cache(
+ access_token=access_token, expires_in=900, refresh_in=refresh_in)
+ result = self.app.acquire_token_silent(
+ ['s1'], self.account,
+ post=lambda url, *args, **kwargs: # Utilize the undocumented test feature
+ self.fail("I/O shouldn't happen in cache hit AT scenario")
+ )
+ self.assertEqual(result[self.app._TOKEN_SOURCE], self.app._TOKEN_SOURCE_CACHE)
+ self.assertEqual(access_token, result.get("access_token"))
+ self.assertNotIn("refresh_in", result, "Customers need not know refresh_in")
+ self.assertRefreshOn(result, refresh_in)
+
+ def test_aging_token_and_available_aad_should_return_new_token(self):
+ # a.k.a. Attempt to refresh unexpired token when AAD available
+ self.populate_cache(access_token="old AT", expires_in=3599, refresh_in=-1)
+ new_access_token = "new AT"
+ new_refresh_in = 123
+ def mock_post(url, headers=None, *args, **kwargs):
+ self.assertEqual("4|84,4|", (headers or {}).get(CLIENT_CURRENT_TELEMETRY))
+ return MinimalResponse(status_code=200, text=json.dumps({
+ "access_token": new_access_token,
+ "refresh_in": new_refresh_in,
+ }))
+ result = self.app.acquire_token_silent(['s1'], self.account, post=mock_post)
+ self.assertEqual(result[self.app._TOKEN_SOURCE], self.app._TOKEN_SOURCE_IDP)
+ self.assertEqual(new_access_token, result.get("access_token"))
+ self.assertNotIn("refresh_in", result, "Customers need not know refresh_in")
+ self.assertRefreshOn(result, new_refresh_in)
+
+ def test_aging_token_and_unavailable_aad_should_return_old_token(self):
+ # a.k.a. Attempt refresh unexpired token when AAD unavailable
+ refresh_in = -1
+ old_at = "old AT"
+ self.populate_cache(
+ access_token=old_at, expires_in=3599, refresh_in=refresh_in)
+ def mock_post(url, headers=None, *args, **kwargs):
+ self.assertEqual("4|84,4|", (headers or {}).get(CLIENT_CURRENT_TELEMETRY))
+ return MinimalResponse(status_code=400, text=json.dumps({"error": "foo"}))
+ result = self.app.acquire_token_silent(['s1'], self.account, post=mock_post)
+ self.assertEqual(result[self.app._TOKEN_SOURCE], self.app._TOKEN_SOURCE_CACHE)
+ self.assertEqual(old_at, result.get("access_token"))
+ self.assertRefreshOn(result, refresh_in)
+
+ def test_expired_token_and_unavailable_aad_should_return_error(self):
+ # a.k.a. Attempt refresh expired token when AAD unavailable
+ self.populate_cache(access_token="expired at", expires_in=-1, refresh_in=-900)
+ error = "something went wrong"
+ def mock_post(url, headers=None, *args, **kwargs):
+ self.assertEqual("4|84,3|", (headers or {}).get(CLIENT_CURRENT_TELEMETRY))
+ return MinimalResponse(status_code=400, text=json.dumps({"error": error}))
+ result = self.app.acquire_token_silent_with_error(
+ ['s1'], self.account, post=mock_post)
+ self.assertEqual(error, result.get("error"), "Error should be returned")
+
+ def test_expired_token_and_available_aad_should_return_new_token(self):
+ # a.k.a. Attempt refresh expired token when AAD available
+ self.populate_cache(access_token="expired at", expires_in=-1, refresh_in=-900)
+ new_access_token = "new AT"
+ new_refresh_in = 123
+ def mock_post(url, headers=None, *args, **kwargs):
+ self.assertEqual("4|84,3|", (headers or {}).get(CLIENT_CURRENT_TELEMETRY))
+ return MinimalResponse(status_code=200, text=json.dumps({
+ "access_token": new_access_token,
+ "refresh_in": new_refresh_in,
+ }))
+ result = self.app.acquire_token_silent(['s1'], self.account, post=mock_post)
+ self.assertEqual(result[self.app._TOKEN_SOURCE], self.app._TOKEN_SOURCE_IDP)
+ self.assertEqual(new_access_token, result.get("access_token"))
+ self.assertNotIn("refresh_in", result, "Customers need not know refresh_in")
+ self.assertRefreshOn(result, new_refresh_in)
+
+
+class TestTelemetryMaintainingOfflineState(unittest.TestCase):
+ authority_url = "https://login.microsoftonline.com/common"
+ scopes = ["s1", "s2"]
+ uid = "my_uid"
+ utid = "my_utid"
+ account = {"home_account_id": "{}.{}".format(uid, utid)}
+ rt = "this is a rt"
+ client_id = "my_app"
+
+ def populate_cache(self, cache, access_token="at"):
+ cache.add({
+ "client_id": self.client_id,
+ "scope": self.scopes,
+ "token_endpoint": "{}/oauth2/v2.0/token".format(self.authority_url),
+ "response": build_response(
+ access_token=access_token,
+ uid=self.uid, utid=self.utid, refresh_token=self.rt),
+ })
+
+ def test_maintaining_offline_state_and_sending_them(self):
+ app = PublicClientApplication(
+ self.client_id,
+ authority=self.authority_url, token_cache=msal.SerializableTokenCache())
+ cached_access_token = "cached_at"
+ self.populate_cache(app.token_cache, access_token=cached_access_token)
+
+ result = app.acquire_token_silent(
+ self.scopes, self.account,
+ post=lambda url, *args, **kwargs: # Utilize the undocumented test feature
+ self.fail("I/O shouldn't happen in cache hit AT scenario")
+ )
+ self.assertEqual(result[app._TOKEN_SOURCE], app._TOKEN_SOURCE_CACHE)
+ self.assertEqual(cached_access_token, result.get("access_token"))
+
+ error1 = "error_1"
+ def mock_post(url, headers=None, *args, **kwargs):
+ self.assertEqual("4|622,0|", (headers or {}).get(CLIENT_CURRENT_TELEMETRY))
+ self.assertEqual("4|1|||", (headers or {}).get(CLIENT_LAST_TELEMETRY),
+ "The previous cache hit should result in success counter value as 1")
+ return MinimalResponse(status_code=400, text=json.dumps({"error": error1}))
+ result = app.acquire_token_by_device_flow({ # It allows customizing correlation_id
+ "device_code": "123",
+ PublicClientApplication.DEVICE_FLOW_CORRELATION_ID: "id_1",
+ }, post=mock_post)
+ self.assertEqual(error1, result.get("error"))
+
+ error2 = "error_2"
+ def mock_post(url, headers=None, *args, **kwargs):
+ self.assertEqual("4|622,0|", (headers or {}).get(CLIENT_CURRENT_TELEMETRY))
+ self.assertEqual("4|1|622,id_1|error_1|", (headers or {}).get(CLIENT_LAST_TELEMETRY),
+ "The previous error should result in same success counter plus latest error info")
+ return MinimalResponse(status_code=400, text=json.dumps({"error": error2}))
+ result = app.acquire_token_by_device_flow({
+ "device_code": "123",
+ PublicClientApplication.DEVICE_FLOW_CORRELATION_ID: "id_2",
+ }, post=mock_post)
+ self.assertEqual(error2, result.get("error"))
+
+ at = "ensures the successful path (which includes the mock) been used"
+ def mock_post(url, headers=None, *args, **kwargs):
+ self.assertEqual("4|622,0|", (headers or {}).get(CLIENT_CURRENT_TELEMETRY))
+ self.assertEqual("4|1|622,id_1,622,id_2|error_1,error_2|", (headers or {}).get(CLIENT_LAST_TELEMETRY),
+ "The previous error should result in same success counter plus latest error info")
+ return MinimalResponse(status_code=200, text=json.dumps({"access_token": at}))
+ result = app.acquire_token_by_device_flow({"device_code": "123"}, post=mock_post)
+ self.assertEqual(result[app._TOKEN_SOURCE], app._TOKEN_SOURCE_IDP)
+ self.assertEqual(at, result.get("access_token"))
+
+ def mock_post(url, headers=None, *args, **kwargs):
+ self.assertEqual("4|622,0|", (headers or {}).get(CLIENT_CURRENT_TELEMETRY))
+ self.assertEqual("4|0|||", (headers or {}).get(CLIENT_LAST_TELEMETRY),
+ "The previous success should reset all offline telemetry counters")
+ return MinimalResponse(status_code=200, text=json.dumps({"access_token": at}))
+ result = app.acquire_token_by_device_flow({"device_code": "123"}, post=mock_post)
+ self.assertEqual(result[app._TOKEN_SOURCE], app._TOKEN_SOURCE_IDP)
+ self.assertEqual(at, result.get("access_token"))
+
+
+class TestTelemetryOnClientApplication(unittest.TestCase):
+ @classmethod
+ def setUpClass(cls): # Initialization at runtime, not interpret-time
+ cls.app = ClientApplication(
+ "client_id", authority="https://login.microsoftonline.com/common")
+
+ def test_acquire_token_by_auth_code_flow(self):
+ at = "this is an access token"
+ def mock_post(url, headers=None, *args, **kwargs):
+ self.assertEqual("4|832,0|", (headers or {}).get(CLIENT_CURRENT_TELEMETRY))
+ return MinimalResponse(status_code=200, text=json.dumps({"access_token": at}))
+ state = "foo"
+ result = self.app.acquire_token_by_auth_code_flow(
+ {"state": state, "code_verifier": "bar"}, {"state": state, "code": "012"},
+ post=mock_post)
+ self.assertEqual(result[self.app._TOKEN_SOURCE], self.app._TOKEN_SOURCE_IDP)
+ self.assertEqual(at, result.get("access_token"))
+
+ def test_acquire_token_by_refresh_token(self):
+ at = "this is an access token"
+ def mock_post(url, headers=None, *args, **kwargs):
+ self.assertEqual("4|85,1|", (headers or {}).get(CLIENT_CURRENT_TELEMETRY))
+ return MinimalResponse(status_code=200, text=json.dumps({"access_token": at}))
+ result = self.app.acquire_token_by_refresh_token("rt", ["s"], post=mock_post)
+ self.assertEqual(result[self.app._TOKEN_SOURCE], self.app._TOKEN_SOURCE_IDP)
+ self.assertEqual(at, result.get("access_token"))
+
+
+class TestTelemetryOnPublicClientApplication(unittest.TestCase):
+ @classmethod
+ def setUpClass(cls): # Initialization at runtime, not interpret-time
+ cls.app = PublicClientApplication(
+ "client_id", authority="https://login.microsoftonline.com/common")
+
+ # For now, acquire_token_interactive() is verified by code review.
+
+ def test_acquire_token_by_device_flow(self):
+ at = "this is an access token"
+ def mock_post(url, headers=None, *args, **kwargs):
+ self.assertEqual("4|622,0|", (headers or {}).get(CLIENT_CURRENT_TELEMETRY))
+ return MinimalResponse(status_code=200, text=json.dumps({"access_token": at}))
+ result = self.app.acquire_token_by_device_flow(
+ {"device_code": "123"}, post=mock_post)
+ self.assertEqual(result[self.app._TOKEN_SOURCE], self.app._TOKEN_SOURCE_IDP)
+ self.assertEqual(at, result.get("access_token"))
+
+ def test_acquire_token_by_username_password(self):
+ at = "this is an access token"
+ def mock_post(url, headers=None, *args, **kwargs):
+ self.assertEqual("4|301,0|", (headers or {}).get(CLIENT_CURRENT_TELEMETRY))
+ return MinimalResponse(status_code=200, text=json.dumps({"access_token": at}))
+ result = self.app.acquire_token_by_username_password(
+ "username", "password", ["scope"], post=mock_post)
+ self.assertEqual(result[self.app._TOKEN_SOURCE], self.app._TOKEN_SOURCE_IDP)
+ self.assertEqual(at, result.get("access_token"))
+
+
+class TestTelemetryOnConfidentialClientApplication(unittest.TestCase):
+ @classmethod
+ def setUpClass(cls): # Initialization at runtime, not interpret-time
+ cls.app = ConfidentialClientApplication(
+ "client_id", client_credential="secret",
+ authority="https://login.microsoftonline.com/common")
+
+ def test_acquire_token_for_client(self):
+ def mock_post(url, headers=None, *args, **kwargs):
+ self.assertEqual("4|730,2|", (headers or {}).get(CLIENT_CURRENT_TELEMETRY))
+ return MinimalResponse(status_code=200, text=json.dumps({
+ "access_token": "AT 1",
+ "expires_in": 0,
+ }))
+ result = self.app.acquire_token_for_client(["scope"], post=mock_post)
+ self.assertEqual(result[self.app._TOKEN_SOURCE], self.app._TOKEN_SOURCE_IDP)
+ self.assertEqual("AT 1", result.get("access_token"), "Shall get a new token")
+
+ def mock_post(url, headers=None, *args, **kwargs):
+ self.assertEqual("4|730,3|", (headers or {}).get(CLIENT_CURRENT_TELEMETRY))
+ return MinimalResponse(status_code=200, text=json.dumps({
+ "access_token": "AT 2",
+ "expires_in": 3600,
+ "refresh_in": -100, # A hack to make sure it will attempt refresh
+ }))
+ result = self.app.acquire_token_for_client(["scope"], post=mock_post)
+ self.assertEqual(result[self.app._TOKEN_SOURCE], self.app._TOKEN_SOURCE_IDP)
+ self.assertEqual("AT 2", result.get("access_token"), "Shall get a new token")
+
+ def mock_post(url, headers=None, *args, **kwargs):
+ # 1/0 # TODO: Make sure this was called
+ self.assertEqual("4|730,4|", (headers or {}).get(CLIENT_CURRENT_TELEMETRY))
+ return MinimalResponse(status_code=400, text=json.dumps({"error": "foo"}))
+ result = self.app.acquire_token_for_client(["scope"], post=mock_post)
+ self.assertEqual(result[self.app._TOKEN_SOURCE], self.app._TOKEN_SOURCE_CACHE)
+ self.assertEqual("AT 2", result.get("access_token"), "Shall get aging token")
+
+ def test_acquire_token_on_behalf_of(self):
+ at = "this is an access token"
+ def mock_post(url, headers=None, *args, **kwargs):
+ self.assertEqual("4|523,0|", (headers or {}).get(CLIENT_CURRENT_TELEMETRY))
+ return MinimalResponse(status_code=200, text=json.dumps({"access_token": at}))
+ result = self.app.acquire_token_on_behalf_of("assertion", ["s"], post=mock_post)
+ self.assertEqual(result[self.app._TOKEN_SOURCE], self.app._TOKEN_SOURCE_IDP)
+ self.assertEqual(at, result.get("access_token"))
+
+
+class TestClientApplicationWillGroupAccounts(unittest.TestCase):
+ def test_get_accounts(self):
+ client_id = "my_app"
+ scopes = ["scope_1", "scope_2"]
+ environment = "login.microsoftonline.com"
+ uid = "home_oid"
+ utid = "home_tenant_guid"
+ username = "Jane Doe"
+ cache = msal.SerializableTokenCache()
+ for tenant in ["contoso", "fabrikam"]:
+ cache.add({
+ "client_id": client_id,
+ "scope": scopes,
+ "token_endpoint":
+ "https://{}/{}/oauth2/v2.0/token".format(environment, tenant),
+ "response": build_response(
+ uid=uid, utid=utid, access_token="at", refresh_token="rt",
+ id_token=build_id_token(
+ aud=client_id,
+ sub="oid_in_" + tenant,
+ preferred_username=username,
+ ),
+ ),
+ })
+ app = ClientApplication(
+ client_id,
+ authority="https://{}/common".format(environment),
+ token_cache=cache)
+ accounts = app.get_accounts()
+ self.assertEqual(1, len(accounts), "Should return one grouped account")
+ account = accounts[0]
+ self.assertEqual("{}.{}".format(uid, utid), account["home_account_id"])
+ self.assertEqual(environment, account["environment"])
+ self.assertEqual(username, account["username"])
+ self.assertIn("authority_type", account, "Backward compatibility")
+ self.assertIn("local_account_id", account, "Backward compatibility")
+ self.assertIn("realm", account, "Backward compatibility")
+
+
+@unittest.skipUnless(
+ sys.version_info[0] >= 3 and sys.version_info[1] >= 2,
+ "assertWarns() is only available in Python 3.2+")
+class TestClientCredentialGrant(unittest.TestCase):
+ def _test_certain_authority_should_emit_warning(self, authority):
+ app = ConfidentialClientApplication(
+ "client_id", client_credential="secret", authority=authority)
+ def mock_post(url, headers=None, *args, **kwargs):
+ return MinimalResponse(
+ status_code=200, text=json.dumps({"access_token": "an AT"}))
+ with self.assertWarns(DeprecationWarning):
+ app.acquire_token_for_client(["scope"], post=mock_post)
+
+ def test_common_authority_should_emit_warning(self):
+ self._test_certain_authority_should_emit_warning(
+ authority="https://login.microsoftonline.com/common")
+
+ def test_organizations_authority_should_emit_warning(self):
+ self._test_certain_authority_should_emit_warning(
+ authority="https://login.microsoftonline.com/organizations")
+
+
+class TestRemoveTokensForClient(unittest.TestCase):
+ def test_remove_tokens_for_client_should_remove_client_tokens_only(self):
+ at_for_user = "AT for user"
+ cca = msal.ConfidentialClientApplication(
+ "client_id", client_credential="secret",
+ authority="https://login.microsoftonline.com/microsoft.onmicrosoft.com")
+ self.assertEqual(
+ 0, len(cca.token_cache.find(msal.TokenCache.CredentialType.ACCESS_TOKEN)))
+ cca.acquire_token_for_client(
+ ["scope"],
+ post=lambda url, **kwargs: MinimalResponse(
+ status_code=200, text=json.dumps({"access_token": "AT for client"})))
+ self.assertEqual(
+ 1, len(cca.token_cache.find(msal.TokenCache.CredentialType.ACCESS_TOKEN)))
+ cca.acquire_token_by_username_password(
+ "johndoe", "password", ["scope"],
+ post=lambda url, **kwargs: MinimalResponse(
+ status_code=200, text=json.dumps(build_response(
+ access_token=at_for_user, expires_in=3600,
+ uid="uid", utid="utid", # This populates home_account_id
+ ))))
+ self.assertEqual(
+ 2, len(cca.token_cache.find(msal.TokenCache.CredentialType.ACCESS_TOKEN)))
+ cca.remove_tokens_for_client()
+ remaining_tokens = cca.token_cache.find(msal.TokenCache.CredentialType.ACCESS_TOKEN)
+ self.assertEqual(1, len(remaining_tokens))
+ self.assertEqual(at_for_user, remaining_tokens[0].get("secret"))
+
+
+class TestScopeDecoration(unittest.TestCase):
+ def _test_client_id_should_be_a_valid_scope(self, client_id, other_scopes):
+ # B2C needs this https://learn.microsoft.com/en-us/azure/active-directory-b2c/access-tokens#openid-connect-scopes
+ reserved_scope = ['openid', 'profile', 'offline_access']
+ scopes_to_use = [client_id] + other_scopes
+ self.assertEqual(
+ set(ClientApplication(client_id)._decorate_scope(scopes_to_use)),
+ set(scopes_to_use + reserved_scope),
+ "Scope decoration should return input scopes plus reserved scopes")
+
+ def test_client_id_should_be_a_valid_scope(self):
+ self._test_client_id_should_be_a_valid_scope("client_id", [])
+ self._test_client_id_should_be_a_valid_scope("client_id", ["foo"])
+
+
+@patch("sys.platform", new="darwin") # Pretend running on Mac.
+@patch("msal.authority.tenant_discovery", new=Mock(return_value={
+ "authorization_endpoint": "https://contoso.com/placeholder",
+ "token_endpoint": "https://contoso.com/placeholder",
+ }))
+class TestMsalBehaviorWithoutPyMsalRuntimeOrBroker(unittest.TestCase):
+
+ @patch("msal.application._init_broker", new=Mock(side_effect=ImportError(
+ "PyMsalRuntime not installed"
+ )))
+ def test_broker_should_be_disabled_by_default(self):
+ app = msal.PublicClientApplication(
+ "client_id",
+ authority="https://login.microsoftonline.com/common",
+ )
+ self.assertFalse(app._enable_broker)
+
+ @patch("msal.application._init_broker", new=Mock(side_effect=ImportError(
+ "PyMsalRuntime not installed"
+ )))
+ def test_should_error_out_when_opted_in_yet_pymsalruntime_not_installed(self):
+ with self.assertRaises(ImportError):
+ app = msal.PublicClientApplication(
+ "client_id",
+ authority="https://login.microsoftonline.com/common",
+ enable_broker_on_mac=True,
+ )
+
+ @patch("msal.application._init_broker", new=Mock(side_effect=RuntimeError(
+ "PyMsalRuntime raises RuntimeError when broker initialization failed"
+ )))
+ def test_should_fallback_when_pymsalruntime_failed_to_initialize_broker(self):
+ app = msal.PublicClientApplication(
+ "client_id",
+ authority="https://login.microsoftonline.com/common",
+ enable_broker_on_mac=True,
+ )
+ self.assertFalse(app._enable_broker)
+
+
+@patch("sys.platform", new="darwin") # Pretend running on Mac.
+@patch("msal.authority.tenant_discovery", new=Mock(return_value={
+ "authorization_endpoint": "https://contoso.com/placeholder",
+ "token_endpoint": "https://contoso.com/placeholder",
+ }))
+@patch("msal.application._init_broker", new=Mock()) # Pretend pymsalruntime installed and working
+class TestBrokerFallbackWithDifferentAuthorities(unittest.TestCase):
+
+ def test_broker_should_be_disabled_by_default(self):
+ app = msal.PublicClientApplication(
+ "client_id",
+ authority="https://login.microsoftonline.com/common",
+ )
+ self.assertFalse(app._enable_broker)
+
+ def test_broker_should_be_enabled_when_opted_in(self):
+ app = msal.PublicClientApplication(
+ "client_id",
+ authority="https://login.microsoftonline.com/common",
+ enable_broker_on_mac=True,
+ )
+ self.assertTrue(app._enable_broker)
+
+ def test_should_fallback_to_non_broker_when_using_adfs(self):
+ app = msal.PublicClientApplication(
+ "client_id",
+ authority="https://contoso.com/adfs",
+ #instance_discovery=False, # Automatically skipped when detected ADFS
+ enable_broker_on_mac=True,
+ )
+ self.assertFalse(app._enable_broker)
+
+ def test_should_fallback_to_non_broker_when_using_b2c(self):
+ app = msal.PublicClientApplication(
+ "client_id",
+ authority="https://contoso.b2clogin.com/contoso/policy",
+ #instance_discovery=False, # Automatically skipped when detected B2C
+ enable_broker_on_mac=True,
+ )
+ self.assertFalse(app._enable_broker)
+
+ def test_should_use_broker_when_disabling_instance_discovery(self):
+ app = msal.PublicClientApplication(
+ "client_id",
+ authority="https://contoso.com/path",
+ instance_discovery=False, # Need this for a generic authority url
+ enable_broker_on_mac=True,
+ )
+ # TODO: Shall we bypass broker when opted out of instance discovery?
+ self.assertTrue(app._enable_broker) # Current implementation enables broker
+
+ def test_should_fallback_to_non_broker_when_using_oidc_authority(self):
+ app = msal.PublicClientApplication(
+ "client_id",
+ oidc_authority="https://contoso.com/path",
+ enable_broker_on_mac=True,
+ )
+ self.assertFalse(app._enable_broker)
+
diff --git a/tests/test_assertion.py b/tests/test_assertion.py
new file mode 100644
index 00000000..7885afe8
--- /dev/null
+++ b/tests/test_assertion.py
@@ -0,0 +1,15 @@
+import json
+
+from msal.oauth2cli import JwtAssertionCreator
+from msal.oauth2cli.oidc import decode_part
+
+from tests import unittest
+
+
+class AssertionTestCase(unittest.TestCase):
+ def test_extra_claims(self):
+ assertion = JwtAssertionCreator(key=None, algorithm="none").sign_assertion(
+ "audience", "issuer", additional_claims={"client_ip": "1.2.3.4"})
+ payload = json.loads(decode_part(assertion.split(b'.')[1].decode('utf-8')))
+ self.assertEqual("1.2.3.4", payload.get("client_ip"))
+
diff --git a/tests/test_authcode.py b/tests/test_authcode.py
index 4067f32a..329cafd8 100644
--- a/tests/test_authcode.py
+++ b/tests/test_authcode.py
@@ -4,7 +4,7 @@
import requests
-from oauth2cli.authcode import AuthCodeReceiver
+from msal.oauth2cli.authcode import AuthCodeReceiver
class TestAuthCodeReceiver(unittest.TestCase):
diff --git a/tests/test_authority.py b/tests/test_authority.py
new file mode 100644
index 00000000..0d6c790f
--- /dev/null
+++ b/tests/test_authority.py
@@ -0,0 +1,245 @@
+import os
+try:
+ from unittest.mock import patch
+except:
+ from mock import patch
+
+import msal
+from msal.authority import *
+from tests import unittest
+from tests.http_client import MinimalHttpClient
+
+
+@unittest.skipIf(os.getenv("TRAVIS_TAG"), "Skip network io during tagged release")
+class TestAuthority(unittest.TestCase):
+
+ def _test_given_host_and_tenant(self, host, tenant):
+ c = MinimalHttpClient()
+ a = Authority('https://{}/{}'.format(host, tenant), c)
+ self.assertEqual(
+ a.authorization_endpoint,
+ 'https://{}/{}/oauth2/v2.0/authorize'.format(host, tenant))
+ self.assertEqual(
+ a.token_endpoint,
+ 'https://{}/{}/oauth2/v2.0/token'.format(host, tenant))
+ c.close()
+
+ def _test_authority_builder(self, host, tenant):
+ c = MinimalHttpClient()
+ a = Authority(AuthorityBuilder(host, tenant), c)
+ self.assertEqual(
+ a.authorization_endpoint,
+ 'https://{}/{}/oauth2/v2.0/authorize'.format(host, tenant))
+ self.assertEqual(
+ a.token_endpoint,
+ 'https://{}/{}/oauth2/v2.0/token'.format(host, tenant))
+ c.close()
+
+ def test_wellknown_host_and_tenant(self):
+ # Assert all well known authority hosts are using their own "common" tenant
+ for host in WELL_KNOWN_AUTHORITY_HOSTS:
+ if host != AZURE_CHINA: # It is prone to ConnectionError
+ self._test_given_host_and_tenant(host, "common")
+
+ def test_wellknown_host_and_tenant_using_new_authority_builder(self):
+ self._test_authority_builder(AZURE_PUBLIC, "consumers")
+ self._test_authority_builder(AZURE_US_GOVERNMENT, "common")
+ ## AZURE_CHINA is prone to some ConnectionError. We skip it to speed up our tests.
+ # self._test_authority_builder(AZURE_CHINA, "organizations")
+
+ @unittest.skip("As of Jan 2017, the server no longer returns V1 endpoint")
+ def test_lessknown_host_will_return_a_set_of_v1_endpoints(self):
+ # This is an observation for current (2016-10) server-side behavior.
+ # It is probably not a strict API contract. I simply mention it here.
+ less_known = 'login.windows.net' # less.known.host/
+ v1_token_endpoint = 'https://{}/common/oauth2/token'.format(less_known)
+ a = Authority(
+ 'https://{}/common'.format(less_known), MinimalHttpClient())
+ self.assertEqual(a.token_endpoint, v1_token_endpoint)
+ self.assertNotIn('v2.0', a.token_endpoint)
+
+ def test_unknown_host_wont_pass_instance_discovery(self):
+ _assert = (
+ # Was Regexp, added alias Regex in Py 3.2, and Regexp will be gone in Py 3.12
+ getattr(self, "assertRaisesRegex", None) or
+ getattr(self, "assertRaisesRegexp", None))
+ with _assert(ValueError, "invalid_instance"):
+ Authority('https://example.com/tenant_doesnt_matter_in_this_case',
+ MinimalHttpClient())
+
+ def test_invalid_host_skipping_validation_can_be_turned_off(self):
+ try:
+ Authority(
+ 'https://example.com/invalid',
+ MinimalHttpClient(), validate_authority=False)
+ except ValueError as e:
+ if "invalid_instance" in str(e): # Imprecise but good enough
+ self.fail("validate_authority=False should turn off validation")
+ except: # Could be requests...RequestException, json...JSONDecodeError, etc.
+ pass # Those are expected for this unittest case
+
+
+@patch("msal.authority.tenant_discovery", return_value={
+ "authorization_endpoint": "https://contoso.com/placeholder",
+ "token_endpoint": "https://contoso.com/placeholder",
+ })
+class TestCiamAuthority(unittest.TestCase):
+ http_client = MinimalHttpClient()
+
+ def test_path_less_authority_should_work(self, oidc_discovery):
+ Authority('https://contoso.ciamlogin.com', self.http_client)
+ oidc_discovery.assert_called_once_with(
+ "https://contoso.ciamlogin.com/contoso.onmicrosoft.com/v2.0/.well-known/openid-configuration",
+ self.http_client)
+
+ def test_authority_with_path_should_be_used_as_is(self, oidc_discovery):
+ Authority('https://contoso.ciamlogin.com/anything', self.http_client)
+ oidc_discovery.assert_called_once_with(
+ "https://contoso.ciamlogin.com/anything/v2.0/.well-known/openid-configuration",
+ self.http_client)
+
+
+@patch("msal.authority._instance_discovery")
+@patch("msal.authority.tenant_discovery", return_value={
+ "authorization_endpoint": "https://contoso.com/authorize",
+ "token_endpoint": "https://contoso.com/token",
+ })
+class TestOidcAuthority(unittest.TestCase):
+ def test_authority_obj_should_do_oidc_discovery_and_skip_instance_discovery(
+ self, oidc_discovery, instance_discovery):
+ c = MinimalHttpClient()
+ a = Authority(None, c, oidc_authority_url="https://contoso.com/tenant")
+ instance_discovery.assert_not_called()
+ oidc_discovery.assert_called_once_with(
+ "https://contoso.com/tenant/.well-known/openid-configuration", c)
+ self.assertEqual(a.authorization_endpoint, 'https://contoso.com/authorize')
+ self.assertEqual(a.token_endpoint, 'https://contoso.com/token')
+
+ def test_application_obj_should_do_oidc_discovery_and_skip_instance_discovery(
+ self, oidc_discovery, instance_discovery):
+ app = msal.ClientApplication(
+ "id",
+ authority=None,
+ oidc_authority="https://contoso.com/tenant",
+ )
+ instance_discovery.assert_not_called()
+ oidc_discovery.assert_called_once_with(
+ "https://contoso.com/tenant/.well-known/openid-configuration",
+ app.http_client)
+ self.assertEqual(
+ app.authority.authorization_endpoint, 'https://contoso.com/authorize')
+ self.assertEqual(app.authority.token_endpoint, 'https://contoso.com/token')
+
+class TestAuthorityInternalHelperCanonicalize(unittest.TestCase):
+
+ def test_canonicalize_tenant_followed_by_extra_paths(self):
+ _, i, t = canonicalize("https://example.com/tenant/subpath?foo=bar#fragment")
+ self.assertEqual("example.com", i)
+ self.assertEqual("tenant", t)
+
+ def test_canonicalize_tenant_followed_by_extra_query(self):
+ _, i, t = canonicalize("https://example.com/tenant?foo=bar#fragment")
+ self.assertEqual("example.com", i)
+ self.assertEqual("tenant", t)
+
+ def test_canonicalize_tenant_followed_by_extra_fragment(self):
+ _, i, t = canonicalize("https://example.com/tenant#fragment")
+ self.assertEqual("example.com", i)
+ self.assertEqual("tenant", t)
+
+ def test_canonicalize_rejects_non_https(self):
+ with self.assertRaises(ValueError):
+ canonicalize("http://non.https.example.com/tenant")
+
+ def test_canonicalize_rejects_tenantless(self):
+ with self.assertRaises(ValueError):
+ canonicalize("https://no.tenant.example.com")
+
+ def test_canonicalize_rejects_tenantless_host_with_trailing_slash(self):
+ with self.assertRaises(ValueError):
+ canonicalize("https://no.tenant.example.com/")
+
+
+@unittest.skipIf(os.getenv("TRAVIS_TAG"), "Skip network io during tagged release")
+class TestAuthorityInternalHelperUserRealmDiscovery(unittest.TestCase):
+ def test_memorize(self):
+ # We use a real authority so the constructor can finish tenant discovery
+ authority = "https://login.microsoftonline.com/common"
+ self.assertNotIn(authority, Authority._domains_without_user_realm_discovery)
+ a = Authority(authority, MinimalHttpClient(), validate_authority=False)
+
+ try:
+ # We now pretend this authority supports no User Realm Discovery
+ class MockResponse(object):
+ status_code = 404
+ a.user_realm_discovery("john.doe@example.com", response=MockResponse())
+ self.assertIn(
+ "login.microsoftonline.com",
+ Authority._domains_without_user_realm_discovery,
+ "user_realm_discovery() should memorize domains not supporting URD")
+ a.user_realm_discovery("john.doe@example.com",
+ response="This would cause exception if memorization did not work")
+ finally: # MUST NOT let the previous test changes affect other test cases
+ Authority._domains_without_user_realm_discovery = set([])
+
+
+@patch("msal.authority.tenant_discovery", return_value={
+ "authorization_endpoint": "https://contoso.com/placeholder",
+ "token_endpoint": "https://contoso.com/placeholder",
+ })
+@patch("msal.authority._instance_discovery")
+@patch.object(msal.ClientApplication, "_get_instance_metadata", return_value=[])
+class TestMsalBehaviorsWithoutAndWithInstanceDiscoveryBoolean(unittest.TestCase):
+ """Test cases use ClientApplication, which is a base class of both PCA and CCA"""
+
+ def test_by_default_a_known_to_microsoft_authority_should_skip_validation_but_still_use_instance_metadata(
+ self, instance_metadata, known_to_microsoft_validation, _):
+ app = msal.ClientApplication("id", authority="https://login.microsoftonline.com/common")
+ known_to_microsoft_validation.assert_not_called()
+ app.get_accounts() # This could make an instance metadata call for authority aliases
+ instance_metadata.assert_called_once_with()
+
+ def test_validate_authority_boolean_should_skip_validation_and_instance_metadata(
+ self, instance_metadata, known_to_microsoft_validation, _):
+ """Pending deprecation, but kept for backward compatibility, for now"""
+ app = msal.ClientApplication(
+ "id", authority="https://contoso.com/common", validate_authority=False)
+ known_to_microsoft_validation.assert_not_called()
+ app.get_accounts() # This could make an instance metadata call for authority aliases
+ instance_metadata.assert_not_called()
+
+ def test_by_default_adfs_should_skip_validation_and_instance_metadata(
+ self, instance_metadata, known_to_microsoft_validation, _):
+ """Not strictly required, but when/if we already supported it, we better keep it"""
+ app = msal.ClientApplication("id", authority="https://contoso.com/adfs")
+ known_to_microsoft_validation.assert_not_called()
+ app.get_accounts() # This could make an instance metadata call for authority aliases
+ instance_metadata.assert_not_called()
+
+ def test_by_default_b2c_should_skip_validation_and_instance_metadata(
+ self, instance_metadata, known_to_microsoft_validation, _):
+ """Not strictly required, but when/if we already supported it, we better keep it"""
+ app = msal.ClientApplication(
+ "id", authority="https://login.b2clogin.com/contoso/b2c_policy")
+ known_to_microsoft_validation.assert_not_called()
+ app.get_accounts() # This could make an instance metadata call for authority aliases
+ instance_metadata.assert_not_called()
+
+ def test_turning_off_instance_discovery_should_work_for_all_kinds_of_clouds(
+ self, instance_metadata, known_to_microsoft_validation, _):
+ for authority in [
+ "https://login.microsoftonline.com/common", # Known to Microsoft
+ "https://contoso.com/adfs", # ADFS
+ "https://login.b2clogin.com/contoso/b2c_policy", # B2C
+ "https://private.cloud/foo", # Private Cloud
+ ]:
+ self._test_turning_off_instance_discovery_should_skip_authority_validation_and_instance_metadata(
+ authority, instance_metadata, known_to_microsoft_validation)
+
+ def _test_turning_off_instance_discovery_should_skip_authority_validation_and_instance_metadata(
+ self, authority, instance_metadata, known_to_microsoft_validation):
+ app = msal.ClientApplication("id", authority=authority, instance_discovery=False)
+ known_to_microsoft_validation.assert_not_called()
+ app.get_accounts() # This could make an instance metadata call for authority aliases
+ instance_metadata.assert_not_called()
+
diff --git a/tests/test_benchmark.py b/tests/test_benchmark.py
new file mode 100644
index 00000000..9aaeac05
--- /dev/null
+++ b/tests/test_benchmark.py
@@ -0,0 +1,28 @@
+from tests.simulator import ClientCredentialGrantSimulator as CcaTester
+from perf_baseline import Baseline
+
+
+baseline = Baseline(".perf.baseline", threshold=1.5) # Up to 1.5x slower than baseline
+
+# Here come benchmark test cases, powered by pytest-benchmark
+# Func names will become diag names.
+def test_cca_1_tenant_with_10_tokens_per_tenant_and_cache_hit(benchmark):
+ tester = CcaTester(tokens_per_tenant=10, cache_hit=True)
+ baseline.set_or_compare(tester.run)
+ benchmark(tester.run)
+
+def test_cca_many_tenants_with_10_tokens_per_tenant_and_cache_hit(benchmark):
+ tester = CcaTester(number_of_tenants=1000, tokens_per_tenant=10, cache_hit=True)
+ baseline.set_or_compare(tester.run)
+ benchmark(tester.run)
+
+def test_cca_1_tenant_with_10_tokens_per_tenant_and_cache_miss(benchmark):
+ tester = CcaTester(tokens_per_tenant=10, cache_hit=False)
+ baseline.set_or_compare(tester.run)
+ benchmark(tester.run)
+
+def test_cca_many_tenants_with_10_tokens_per_tenant_and_cache_miss(benchmark):
+ tester = CcaTester(number_of_tenants=1000, tokens_per_tenant=10, cache_hit=False)
+ baseline.set_or_compare(tester.run)
+ benchmark(tester.run)
+
diff --git a/tests/test_broker.py b/tests/test_broker.py
new file mode 100644
index 00000000..1b66d0c9
--- /dev/null
+++ b/tests/test_broker.py
@@ -0,0 +1,68 @@
+from tests import unittest
+import logging
+import sys
+
+if not sys.platform.startswith("win"):
+ raise unittest.SkipTest("Currently, our broker supports Windows")
+from msal.broker import ( # Import them after the platform check
+ _signin_silently, _signin_interactively, _acquire_token_silently, RedirectUriError,
+ _signout_silently, _read_account_by_id,
+ )
+
+
+logging.basicConfig(level=logging.DEBUG)
+
+class BrokerTestCase(unittest.TestCase):
+ """These are the unit tests for the thin broker.py layer.
+
+ It currently hardcodes some test apps which might be changed/gone in the future.
+ The existing test_e2e.py is sophisticated to pull test configuration securely from lab.
+ """
+ _client_id = "04f0c124-f2bc-4f59-8241-bf6df9866bbd" # Visual Studio
+ _authority = "https://login.microsoftonline.com/common"
+ _scopes = ["https://graph.microsoft.com/.default"]
+
+ def test_signin_interactive_then_acquire_token_silent_then_signout(self):
+ result = _signin_interactively(self._authority, self._client_id, self._scopes, None)
+ self.assertIsNotNone(result.get("access_token"), result)
+
+ account_id = result["_account_id"]
+ self.assertIsNotNone(_read_account_by_id(account_id, "correlation_id"))
+ result = _acquire_token_silently(
+ self._authority, self._client_id, account_id, self._scopes)
+ self.assertIsNotNone(result.get("access_token"), result)
+
+ signout_error = _signout_silently(self._client_id, account_id)
+ self.assertIsNone(signout_error, msg=signout_error)
+ account = _read_account_by_id(account_id, "correlation_id")
+ self.assertIsNotNone(account, msg="pymsalruntime still has this account")
+ result = _acquire_token_silently(
+ self._authority, self._client_id, account_id, self._scopes)
+ self.assertIn("Status_AccountUnusable", result.get("error_description", ""))
+
+ def test_unconfigured_app_should_raise_exception(self):
+ self.skipTest(
+ "After PyMsalRuntime 0.13.2, "
+ "AADSTS error codes were removed from error_context; "
+ "it is not in telemetry either.")
+ app_without_needed_redirect_uri = "f62c5ae3-bf3a-4af5-afa8-a68b800396e9" # This is the lab app. We repurpose it to be used here
+ with self.assertRaises(RedirectUriError):
+ result = _signin_interactively(
+ self._authority, app_without_needed_redirect_uri, self._scopes, None)
+ print(result)
+ # Note: _acquire_token_silently() would raise same exception,
+ # we skip its test here due to the lack of a valid account_id
+
+ def test_signin_interactively_and_select_account(self):
+ print("An account picker UI will pop up. See whether the auth result matches your account")
+ result = _signin_interactively(
+ self._authority, self._client_id, self._scopes, None, prompt="select_account")
+ self.assertIsNotNone(result.get("access_token"), result)
+ if "access_token" in result:
+ result["access_token"] = "********"
+ import pprint; pprint.pprint(result)
+
+ def test_signin_silently(self):
+ result = _signin_silently(self._authority, self._client_id, self._scopes)
+ self.assertIsNotNone(result.get("access_token"), result)
+
diff --git a/tests/test_ccs.py b/tests/test_ccs.py
new file mode 100644
index 00000000..8b801773
--- /dev/null
+++ b/tests/test_ccs.py
@@ -0,0 +1,73 @@
+import unittest
+try:
+ from unittest.mock import patch, ANY
+except:
+ from mock import patch, ANY
+
+from tests.http_client import MinimalResponse
+from tests.test_token_cache import build_response
+
+import msal
+
+
+class TestCcsRoutingInfoTestCase(unittest.TestCase):
+
+ def test_acquire_token_by_auth_code_flow(self):
+ app = msal.ClientApplication("client_id")
+ state = "foo"
+ flow = app.initiate_auth_code_flow(
+ ["some", "scope"], login_hint="johndoe@contoso.com", state=state)
+ with patch.object(app.http_client, "post", return_value=MinimalResponse(
+ status_code=400, text='{"error": "mock"}')) as mocked_method:
+ app.acquire_token_by_auth_code_flow(flow, {
+ "state": state,
+ "code": "bar",
+ "client_info": # MSAL asks for client_info, so it would be available
+ "eyJ1aWQiOiJhYTkwNTk0OS1hMmI4LTRlMGEtOGFlYS1iMzJlNTNjY2RiNDEiLCJ1dGlkIjoiNzJmOTg4YmYtODZmMS00MWFmLTkxYWItMmQ3Y2QwMTFkYjQ3In0",
+ })
+ self.assertEqual(
+ "Oid:aa905949-a2b8-4e0a-8aea-b32e53ccdb41@72f988bf-86f1-41af-91ab-2d7cd011db47",
+ mocked_method.call_args[1].get("headers", {}).get('X-AnchorMailbox'),
+ "CSS routing info should be derived from client_info")
+
+ # I've manually tested acquire_token_interactive. No need to automate it,
+ # because it and acquire_token_by_auth_code_flow() share same code path.
+
+ def test_acquire_token_silent(self):
+ uid = "foo"
+ utid = "bar"
+ client_id = "my_client_id"
+ scopes = ["some", "scope"]
+ authority_url = "https://login.microsoftonline.com/common"
+ token_cache = msal.TokenCache()
+ token_cache.add({ # Pre-populate the cache
+ "client_id": client_id,
+ "scope": scopes,
+ "token_endpoint": "{}/oauth2/v2.0/token".format(authority_url),
+ "response": build_response(
+ access_token="an expired AT to trigger refresh", expires_in=-99,
+ uid=uid, utid=utid, refresh_token="this is a RT"),
+ }) # The add(...) helper populates correct home_account_id for future searching
+ app = msal.ClientApplication(
+ client_id, authority=authority_url, token_cache=token_cache)
+ with patch.object(app.http_client, "post", return_value=MinimalResponse(
+ status_code=400, text='{"error": "mock"}')) as mocked_method:
+ account = {"home_account_id": "{}.{}".format(uid, utid)}
+ app.acquire_token_silent(["scope"], account)
+ self.assertEqual(
+ "Oid:{}@{}".format( # Server accepts case-insensitive value
+ uid, utid), # It would look like "Oid:foo@bar"
+ mocked_method.call_args[1].get("headers", {}).get('X-AnchorMailbox'),
+ "CSS routing info should be derived from home_account_id")
+
+ def test_acquire_token_by_username_password(self):
+ app = msal.ClientApplication("client_id")
+ username = "johndoe@contoso.com"
+ with patch.object(app.http_client, "post", return_value=MinimalResponse(
+ status_code=400, text='{"error": "mock"}')) as mocked_method:
+ app.acquire_token_by_username_password(username, "password", ["scope"])
+ self.assertEqual(
+ "upn:" + username,
+ mocked_method.call_args[1].get("headers", {}).get('X-AnchorMailbox'),
+ "CSS routing info should be derived from client_info")
+
diff --git a/tests/test_client.py b/tests/test_client.py
index 4cbcc8cf..b180c6b8 100644
--- a/tests/test_client.py
+++ b/tests/test_client.py
@@ -9,9 +9,8 @@
import requests
-from oauth2cli.oidc import Client
-from oauth2cli.authcode import obtain_auth_code, AuthCodeReceiver
-from oauth2cli.assertion import JwtSigner
+from msal.oauth2cli import Client, JwtSigner, AuthCodeReceiver
+from msal.oauth2cli.authcode import obtain_auth_code
from tests import unittest, Oauth2TestCase
from tests.http_client import MinimalHttpClient, MinimalResponse
@@ -80,12 +79,21 @@ def load_conf(filename):
# Since the OAuth2 specs uses snake_case, this test config also uses snake_case
@unittest.skipUnless("client_id" in CONFIG, "client_id missing")
+@unittest.skipUnless(CONFIG.get("openid_configuration"), "openid_configuration missing")
class TestClient(Oauth2TestCase):
@classmethod
def setUpClass(cls):
http_client = MinimalHttpClient()
- if "client_certificate" in CONFIG:
+ if "client_assertion" in CONFIG:
+ cls.client = Client(
+ CONFIG["openid_configuration"],
+ CONFIG['client_id'],
+ http_client=http_client,
+ client_assertion=CONFIG["client_assertion"],
+ client_assertion_type=Client.CLIENT_ASSERTION_TYPE_JWT,
+ )
+ elif "client_certificate" in CONFIG:
private_key_path = CONFIG["client_certificate"]["private_key_path"]
with open(os.path.join(THIS_FOLDER, private_key_path)) as f:
private_key = f.read() # Expecting PEM format
diff --git a/tests/test_cryptography.py b/tests/test_cryptography.py
new file mode 100644
index 00000000..b119e599
--- /dev/null
+++ b/tests/test_cryptography.py
@@ -0,0 +1,63 @@
+import configparser
+import os
+import re
+from unittest import TestCase
+import warnings
+import xml.etree.ElementTree as ET
+
+import requests
+
+from msal.application import (
+ _str2bytes, _load_private_key_from_pem_str, _parse_pfx)
+
+
+latest_cryptography_version = ET.fromstring(
+ requests.get("https://pypi.org/rss/project/cryptography/releases.xml").text
+ ).findall("./channel/item/title")[0].text
+
+
+def get_current_ceiling():
+ parser = configparser.ConfigParser()
+ parser.read("setup.cfg")
+ for line in parser["options"]["install_requires"].splitlines():
+ if line.startswith("cryptography"):
+ match = re.search(r"<(\d+)", line)
+ if match:
+ return int(match.group(1))
+ raise RuntimeError("Unable to find cryptography info from setup.cfg")
+
+
+def sibling(filename):
+ return os.path.join(os.path.dirname(__file__), filename)
+
+
+class CryptographyTestCase(TestCase):
+
+ def test_should_be_run_with_latest_version_of_cryptography(self):
+ import cryptography
+ self.assertEqual(
+ cryptography.__version__, latest_cryptography_version,
+ "We are using cryptography {} but we should test with latest {} instead. "
+ "Run 'pip install -U cryptography'.".format(
+ cryptography.__version__, latest_cryptography_version))
+
+ def test_latest_cryptography_should_support_our_usage_without_warnings(self):
+ passphrase_bytes = _str2bytes("password")
+ with warnings.catch_warnings(record=True) as encountered_warnings:
+ with open(sibling("certificate-with-password.pem")) as f:
+ _load_private_key_from_pem_str(f.read(), passphrase_bytes)
+ pfx = sibling("certificate-with-password.pfx") # Created by:
+ # openssl pkcs12 -export -inkey test/certificate-with-password.pem -in tests/certificate-with-password.pem -out tests/certificate-with-password.pfx
+ _parse_pfx(pfx, passphrase_bytes)
+ self.assertEqual(0, len(encountered_warnings),
+ "Did cryptography deprecate the functions that we used?")
+
+ def test_ceiling_should_be_latest_cryptography_version_plus_three(self):
+ expected_ceiling = int(latest_cryptography_version.split(".")[0]) + 3
+ self.assertEqual(
+ expected_ceiling, get_current_ceiling(),
+ "Test passed with latest cryptography, so we shall bump ceiling to N+3={}, "
+ "based on their latest deprecation policy "
+ "https://cryptography.io/en/latest/api-stability/#deprecation".format(
+ expected_ceiling))
+
diff --git a/tests/test_e2e.py b/tests/test_e2e.py
new file mode 100644
index 00000000..e88e73de
--- /dev/null
+++ b/tests/test_e2e.py
@@ -0,0 +1,1361 @@
+"""If the following ENV VAR were available, many end-to-end test cases would run.
+LAB_OBO_CLIENT_SECRET=...
+LAB_APP_CLIENT_ID=...
+LAB_APP_CLIENT_CERT_PFX_PATH=...
+LAB_OBO_PUBLIC_CLIENT_ID=...
+LAB_OBO_CONFIDENTIAL_CLIENT_ID=...
+"""
+try:
+ from dotenv import load_dotenv # Use this only in local dev machine
+ load_dotenv() # take environment variables from .env.
+except:
+ pass
+import base64
+import logging
+import os
+import json
+import time
+import unittest
+from urllib.parse import urlparse, parse_qs
+import sys
+try:
+ from unittest.mock import patch, ANY
+except:
+ from mock import patch, ANY
+
+import requests
+
+import msal
+from tests.http_client import MinimalHttpClient, MinimalResponse
+from msal.oauth2cli import AuthCodeReceiver
+from msal.oauth2cli.oidc import decode_part
+
+try:
+ import pymsalruntime
+ broker_available = True
+except ImportError:
+ broker_available = False
+logger = logging.getLogger(__name__)
+logging.basicConfig(level=logging.DEBUG if "-v" in sys.argv else logging.INFO)
+
+try:
+ from dotenv import load_dotenv # Use this only in local dev machine
+ load_dotenv() # take environment variables from .env.
+except ImportError:
+ logger.warn("Run pip install -r requirements.txt for optional dependency")
+
+_AZURE_CLI = "04b07795-8ddb-461a-bbee-02f9e1bf7b46"
+
+def _get_app_and_auth_code(
+ client_id,
+ client_secret=None,
+ authority="https://login.microsoftonline.com/common",
+ port=44331,
+ scopes=["https://graph.microsoft.com/.default"], # Microsoft Graph
+ **kwargs):
+ from msal.oauth2cli.authcode import obtain_auth_code
+ if client_secret:
+ app = msal.ConfidentialClientApplication(
+ client_id,
+ client_credential=client_secret,
+ authority=authority, http_client=MinimalHttpClient())
+ else:
+ app = msal.PublicClientApplication(
+ client_id, authority=authority, http_client=MinimalHttpClient())
+ redirect_uri = "http://localhost:%d" % port
+ ac = obtain_auth_code(port, auth_uri=app.get_authorization_request_url(
+ scopes, redirect_uri=redirect_uri, **kwargs))
+ assert ac is not None
+ return (app, ac, redirect_uri)
+
+def _render(url, description=None):
+ # Render a url in html if description is available, otherwise return url as-is
+ return "{description}".format(
+ url=url, description=description) if description else url
+
+
+def _get_hint(html_mode=None, username=None, lab_name=None, username_uri=None):
+ return "Sign in with {user} whose password is available from {lab}".format(
+ user=("{}".format(username) if html_mode else username)
+ if username
+ else "the upn from {}".format(_render(
+ username_uri, description="here" if html_mode else None)),
+ lab=_render(
+ "https://aka.ms/GetLabSecret?Secret=" + (lab_name or "msidlabXYZ"),
+ description="this password api" if html_mode else None,
+ ),
+ )
+
+
+@unittest.skipIf(os.getenv("TRAVIS_TAG"), "Skip e2e tests during tagged release")
+class E2eTestCase(unittest.TestCase):
+
+ def assertLoosely(self, response, assertion=None,
+ skippable_errors=("invalid_grant", "interaction_required")):
+ if response.get("error") in skippable_errors:
+ logger.debug("Response = %s", response)
+ # Some of these errors are configuration issues, not library issues
+ raise unittest.SkipTest(response.get("error_description"))
+ else:
+ if assertion is None:
+ assertion = lambda: self.assertIn(
+ "access_token", response,
+ "{error}: {error_description}".format(
+ # Do explicit response.get(...) rather than **response
+ error=response.get("error"),
+ error_description=response.get("error_description")))
+ assertion()
+
+ def assertCacheWorksForUser(
+ self, result_from_wire, scope, username=None, data=None, auth_scheme=None):
+ logger.debug(
+ "%s: cache = %s, id_token_claims = %s",
+ self.id(),
+ json.dumps(self.app.token_cache._cache, indent=4),
+ json.dumps(result_from_wire.get("id_token_claims"), indent=4),
+ )
+ # You can filter by predefined username, or let end user to choose one
+ accounts = self.app.get_accounts(username=username)
+ self.assertNotEqual(0, len(accounts))
+ account = accounts[0]
+ if ("scope" not in result_from_wire # This is the usual case
+ or # Authority server could return different set of scopes
+ set(scope) <= set(result_from_wire["scope"].split(" "))
+ ):
+ # Going to test acquire_token_silent(...) to locate an AT from cache
+ silent_result = self.app.acquire_token_silent(
+ scope, account=account, data=data or {}, auth_scheme=auth_scheme)
+ self.assertIsNotNone(silent_result)
+ self.assertIsNone(
+ silent_result.get("refresh_token"), "acquire_token_silent() should return no RT")
+ if auth_scheme:
+ self.assertNotEqual(
+ self.app._TOKEN_SOURCE_CACHE, silent_result[self.app._TOKEN_SOURCE])
+ else:
+ self.assertEqual(
+ self.app._TOKEN_SOURCE_CACHE, silent_result[self.app._TOKEN_SOURCE])
+
+ if "refresh_token" in result_from_wire:
+ assert auth_scheme is None
+ # Going to test acquire_token_silent(...) to obtain an AT by a RT from cache
+ self.app.token_cache._cache["AccessToken"] = {} # A hacky way to clear ATs
+ silent_result = self.app.acquire_token_silent(
+ scope, account=account, data=data or {})
+ self.assertIsNotNone(silent_result,
+ "We should get a result from acquire_token_silent(...) call")
+ self.assertEqual(
+ # We used to assert it this way:
+ # result_from_wire['access_token'] != silent_result['access_token']
+ # but ROPC in B2C tends to return the same AT we obtained seconds ago.
+ # Now looking back, "refresh_token grant would return a brand new AT"
+ # was just an empirical observation but never a commitment in specs,
+ # so we adjust our way to assert here.
+ self.app._TOKEN_SOURCE_IDP, silent_result[self.app._TOKEN_SOURCE])
+
+ def assertCacheWorksForApp(self, result_from_wire, scope):
+ logger.debug(
+ "%s: cache = %s, id_token_claims = %s",
+ self.id(),
+ json.dumps(self.app.token_cache._cache, indent=4),
+ json.dumps(result_from_wire.get("id_token_claims"), indent=4),
+ )
+ self.assertIsNone(
+ self.app.acquire_token_silent(scope, account=None),
+ "acquire_token_silent(..., account=None) shall always return None")
+ # Going to test acquire_token_for_client(...) to locate an AT from cache
+ silent_result = self.app.acquire_token_for_client(scope)
+ self.assertIsNotNone(silent_result)
+ self.assertEqual(self.app._TOKEN_SOURCE_CACHE, silent_result[self.app._TOKEN_SOURCE])
+
+ @classmethod
+ def _build_app(cls,
+ client_id,
+ client_credential=None,
+ authority="https://login.microsoftonline.com/common",
+ oidc_authority=None,
+ scopes=["https://graph.microsoft.com/.default"], # Microsoft Graph
+ http_client=None,
+ azure_region=None,
+ **kwargs):
+ if client_credential:
+ return msal.ConfidentialClientApplication(
+ client_id,
+ client_credential=client_credential,
+ authority=authority,
+ oidc_authority=oidc_authority,
+ azure_region=azure_region,
+ http_client=http_client or MinimalHttpClient(),
+ )
+ else:
+ # Reuse same test cases, by run them with and without broker
+ try:
+ import pymsalruntime
+ broker_available = True
+ except ImportError:
+ broker_available = False
+ return msal.PublicClientApplication(
+ client_id,
+ authority=authority,
+ oidc_authority=oidc_authority,
+ http_client=http_client or MinimalHttpClient(),
+ enable_broker_on_windows=broker_available,
+ enable_broker_on_mac=broker_available,
+ )
+
+ def _test_username_password(self,
+ authority=None, client_id=None, username=None, password=None, scope=None,
+ oidc_authority=None,
+ client_secret=None, # Since MSAL 1.11, confidential client has ROPC too
+ azure_region=None,
+ http_client=None,
+ auth_scheme=None,
+ **ignored):
+ assert client_id and username and password and scope and (
+ authority or oidc_authority)
+ self.app = self._build_app(
+ client_id, authority=authority, oidc_authority=oidc_authority,
+ http_client=http_client,
+ azure_region=azure_region, # Regional endpoint does not support ROPC.
+ # Here we just use it to test a regional app won't break ROPC.
+ client_credential=client_secret)
+ self.assertEqual(
+ self.app.get_accounts(username=username), [], "Cache starts empty")
+ result = self.app.acquire_token_by_username_password(
+ username, password, scopes=scope, auth_scheme=auth_scheme)
+ self.assertLoosely(result)
+ self.assertCacheWorksForUser(
+ result, scope,
+ username=username, # Our implementation works even when "profile" scope was not requested, or when profile claims is unavailable in B2C
+ auth_scheme=auth_scheme,
+ )
+ return result
+
+ @unittest.skipIf(
+ os.getenv("TRAVIS"), # It is set when running on TravisCI or Github Actions
+ "Although it is doable, we still choose to skip device flow to save time")
+ def _test_device_flow(
+ self,
+ *,
+ client_id=None, authority=None, oidc_authority=None, scope=None,
+ **ignored
+ ):
+ assert client_id and scope and (authority or oidc_authority)
+ self.app = self._build_app(
+ client_id, authority=authority, oidc_authority=oidc_authority)
+ flow = self.app.initiate_device_flow(scopes=scope)
+ assert "user_code" in flow, "DF does not seem to be provisioned: %s".format(
+ json.dumps(flow, indent=4))
+ logger.info(flow["message"])
+
+ duration = 60
+ logger.info("We will wait up to %d seconds for you to sign in" % duration)
+ flow["expires_at"] = min( # Shorten the time for quick test
+ flow["expires_at"], time.time() + duration)
+ result = self.app.acquire_token_by_device_flow(flow)
+ self.assertLoosely( # It will skip this test if there is no user interaction
+ result,
+ assertion=lambda: self.assertIn('access_token', result),
+ skippable_errors=self.app.client.DEVICE_FLOW_RETRIABLE_ERRORS)
+ if "access_token" not in result:
+ self.skipTest("End user did not complete Device Flow in time")
+ self.assertCacheWorksForUser(result, scope, username=None)
+ result["access_token"] = result["refresh_token"] = "************"
+ logger.info(
+ "%s obtained tokens: %s", self.id(), json.dumps(result, indent=4))
+
+ @unittest.skipIf(os.getenv("TRAVIS"), "Browser automation is not yet implemented")
+ def _test_acquire_token_interactive(
+ self, *, client_id=None, authority=None, scope=None, port=None,
+ oidc_authority=None,
+ username=None, lab_name=None,
+ username_uri="", # Unnecessary if you provided username and lab_name
+ data=None, # Needed by ssh-cert feature
+ prompt=None,
+ enable_msa_passthrough=None,
+ auth_scheme=None,
+ **ignored):
+ assert client_id and scope and (authority or oidc_authority)
+ self.app = self._build_app(
+ client_id, authority=authority, oidc_authority=oidc_authority)
+ logger.info(_get_hint( # Useful when testing broker which shows no welcome_template
+ username=username, lab_name=lab_name, username_uri=username_uri))
+ result = self.app.acquire_token_interactive(
+ scope,
+ login_hint=username,
+ prompt=prompt,
+ timeout=120,
+ port=port,
+ parent_window_handle=self.app.CONSOLE_WINDOW_HANDLE, # This test app is a console app
+ enable_msa_passthrough=enable_msa_passthrough, # Needed when testing MSA-PT app
+ welcome_template= # This is an undocumented feature for testing
+ """
+
+
+* There are also daemon apps, who acquire tokens representing themselves, not a user.
+
+ .. raw:: html
+
+
+
+ 
+
+
+* There are other less common samples, such for ADAL-to-MSAL migration,
+ `available inside the project code base
+