Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CryptoJwt - Fix detection of firebase/php-jwt APIs #29345

Merged
merged 1 commit into from
Feb 9, 2024

Conversation

totten
Copy link
Member

@totten totten commented Feb 8, 2024

Overview

5.70's #28971 introduced a different check for detecting firebase/php-jwt APIs. It distinguishes Firbase JWT v5.x from v6.0 -- but then it misinterprets v6.6+ and crashes.

(ping @seamuslee001 @mattwire)

Before

If you have firebase/php-jwt v6.6+, then it chooses the wrong behavior and gives it the v5.x-style call. This leads to errors like:

Error: Cannot pass parameter 3 by reference in Civi\Crypto\CryptoJwt->decode() (line 92 of /Users/totten/bknix/build/build-0/vendor/civicrm/civicrm-core/Civi/Crypto/CryptoJwt.php)

#0 /Users/totten/bknix/build/build-0/vendor/civicrm/civicrm-core/ext/authx/Civi/Authx/CheckCredential.php(96): Civi\Crypto\CryptoJwt->decode('')
#1 [internal function]: Civi\Authx\CheckCredential->bearerJwt(Object(Civi\Authx\CheckCredentialEvent), 'civi.authx.chec...', Object(Civi\Core\UnoptimizedEventDispatcher))

After

That works.

Technical Details

The reason why the test from 28971 doesn't work is that the method signature has been moving around:

Copy link

civibot bot commented Feb 8, 2024

🤖 Thank you for contributing to CiviCRM! ❤️ We will need to test and review this PR. 👷

Introduction for new contributors...
  • If this is your first PR, an admin will greenlight automated testing with the command ok to test or add to whitelist.
  • A series of tests will automatically run. You can see the results at the bottom of this page (if there are any problems, it will include a link to see what went wrong).
  • A demo site will be built where anyone can try out a version of CiviCRM that includes your changes.
  • If this process needs to be repeated, an admin will issue the command test this please to rerun tests and build a new demo site.
  • Before this PR can be merged, it needs to be reviewed. Please keep in mind that reviewers are volunteers, and their response time can vary from a few hours to a few weeks depending on their availability and their knowledge of this particular part of CiviCRM.
  • A great way to speed up this process is to "trade reviews" with someone - find an open PR that you feel able to review, and leave a comment like "I'm reviewing this now, could you please review mine?" (include a link to yours). You don't have to wait for a response to get started (and you don't have to stop at one!) the more you review, the faster this process goes for everyone 😄
  • To ensure that you are credited properly in the final release notes, please add yourself to contributor-key.yml
  • For more information about contributing, see CONTRIBUTING.md.
Quick links for reviewers...

➡️ Online demo of this PR 🔗

@civibot civibot bot added the 5.70 label Feb 8, 2024
@totten
Copy link
Member Author

totten commented Feb 8, 2024

For comparison, kicked off an E2E test-run of the PR with drupal9-clean: https://test.civicrm.org/job/CiviCRM-Manual-Test/120/

@totten
Copy link
Member Author

totten commented Feb 9, 2024

@seamuslee001 Looks like this passed on drupal-clean and drupal9-clean. (The failure in testLocalizedData is pre-existing/unrelated.)

@totten totten merged commit 853b98e into civicrm:5.70 Feb 9, 2024
3 checks passed
@totten totten deleted the 5.70-jwt branch February 9, 2024 04:02
@mattwire
Copy link
Contributor

mattwire commented Feb 9, 2024

Thankyou @totten!

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

Successfully merging this pull request may close these issues.

2 participants