diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml new file mode 100644 index 00000000..9d2f19f0 --- /dev/null +++ b/.github/workflows/codeql-analysis.yml @@ -0,0 +1,71 @@ +# For most projects, this workflow file will not need changing; you simply need +# to commit it to your repository. +# +# You may wish to alter this file to override the set of languages analyzed, +# or to provide custom queries or build logic. +# +# ******** NOTE ******** +# We have attempted to detect the languages in your repository. Please check +# the `language` matrix defined below to confirm you have the correct set of +# supported CodeQL languages. +# +name: "CodeQL" + +on: + push: + branches: [ master ] + pull_request: + # The branches below must be a subset of the branches above + branches: [ master ] + schedule: + - cron: '0 0 * * *' + +jobs: + analyze: + name: Analyze + runs-on: ubuntu-latest + permissions: + actions: read + contents: read + security-events: write + + strategy: + fail-fast: false + matrix: + language: [ 'python' ] + # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ] + # Learn more: + # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed + + steps: + - name: Checkout repository + uses: actions/checkout@v2 + + # Initializes the CodeQL tools for scanning. + - name: Initialize CodeQL + uses: github/codeql-action/init@v1 + with: + languages: ${{ matrix.language }} + # If you wish to specify custom queries, you can do so here or in a config file. + # By default, queries listed here will override any specified in a config file. + # Prefix the list here with "+" to use these queries and those in the config file. + queries: security-extended # queries: ./path/to/local/query, your-org/your-repo/queries@main + + # Autobuild attempts to build any compiled languages (C/C++, C#, or Java). + # If this step fails, then you should remove it and run the build manually (see below) + # - name: Autobuild + # uses: github/codeql-action/autobuild@v1 + + # â„šī¸ Command-line programs to run using the OS shell. + # 📚 https://git.io/JvXDl + + # âœī¸ If the Autobuild fails above, remove it and uncomment the following three lines + # and modify them (or add more) to build your code if your project + # uses a compiled language + + #- run: | + # make bootstrap + # make release + + - name: Perform CodeQL Analysis + uses: github/codeql-action/analyze@v1 diff --git a/rest_framework_jwt/settings.py b/rest_framework_jwt/settings.py index e47320bb..ab4d57c5 100644 --- a/rest_framework_jwt/settings.py +++ b/rest_framework_jwt/settings.py @@ -1,6 +1,8 @@ import datetime from django.conf import settings +from django.core.signals import setting_changed + from rest_framework.settings import APISettings @@ -25,6 +27,9 @@ 'JWT_PUBLIC_KEY': None, + 'JWT_PUBLIC_KEY_USING_HEADER_HANDLER': + None, + 'JWT_PAYLOAD_GET_USERNAME_HANDLER': 'rest_framework_jwt.utils.jwt_get_username_from_payload_handler', @@ -53,10 +58,31 @@ 'JWT_ENCODE_HANDLER', 'JWT_DECODE_HANDLER', 'JWT_PAYLOAD_HANDLER', + 'JWT_PUBLIC_KEY_USING_HEADER_HANDLER', 'JWT_PAYLOAD_GET_USER_ID_HANDLER', 'JWT_PAYLOAD_GET_USERNAME_HANDLER', 'JWT_RESPONSE_PAYLOAD_HANDLER', 'JWT_GET_USER_SECRET_KEY', ) -api_settings = APISettings(USER_SETTINGS, DEFAULTS, IMPORT_STRINGS) +class JWTAPISettings(APISettings): + # we need to override the `user_settings` as calling reload would otherwise load the + # `settings.REST_FRAMEWORK` into the JWT settings! + + @property + def user_settings(self): + if not hasattr(self, '_user_settings'): + self._user_settings = getattr(settings, 'JWT_AUTH', {}) + return self._user_settings + + +api_settings = JWTAPISettings(USER_SETTINGS, DEFAULTS, IMPORT_STRINGS) + + +def reload_api_settings(*args, **kwargs): + setting = kwargs['setting'] + if setting == 'JWT_AUTH': + api_settings.reload() + + +setting_changed.connect(reload_api_settings) diff --git a/rest_framework_jwt/utils.py b/rest_framework_jwt/utils.py index c72197bc..f6b8b8da 100644 --- a/rest_framework_jwt/utils.py +++ b/rest_framework_jwt/utils.py @@ -102,10 +102,14 @@ def jwt_decode_handler(token): } # get user from token, BEFORE verification, to get user secret key unverified_payload = jwt.decode(token, None, False) + unverified_header = jwt.get_unverified_header(token) secret_key = jwt_get_secret_key(unverified_payload) + public_key = None + if api_settings.JWT_PUBLIC_KEY_USING_HEADER_HANDLER: + public_key = api_settings.JWT_PUBLIC_KEY_USING_HEADER_HANDLER(unverified_header) return jwt.decode( token, - api_settings.JWT_PUBLIC_KEY or secret_key, + public_key or api_settings.JWT_PUBLIC_KEY or secret_key, api_settings.JWT_VERIFY, options=options, leeway=api_settings.JWT_LEEWAY, diff --git a/setup.py b/setup.py index ead3ee05..89645741 100644 --- a/setup.py +++ b/setup.py @@ -27,7 +27,7 @@ def get_version(package): author_email = 'jpadilla@getblimp.com' license = 'MIT' install_requires = [ - 'PyJWT>=1.5.2,<2.0.0', + 'PyJWT>=1.5.2', ]