Skip to content

Commit 36413e4

Browse files
Merge pull request #54 from minvws/add-suggestions
Add recommendation to enable the GMP or BCMath PHP extension
2 parents 2297861 + 3c3de27 commit 36413e4

File tree

2 files changed

+9
-0
lines changed

2 files changed

+9
-0
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ Before using the OpenID Connect package for Laravel, ensure that your developmen
77
- PHP 8.1 or higher: The package requires at least PHP version 8.1. Make sure you have PHP installed and configured properly on your system.
88
- Laravel: The package is designed to work with Laravel, so you should have a Laravel application set up and running.
99
- Composer: Composer is a dependency manager for PHP. You will need Composer installed to install and manage the package and its dependencies.
10+
- **Recommended:** For optimal cryptographic performance (especially for RSA operations), it is highly recommended to enable the [GMP](https://www.php.net/manual/en/book.gmp.php) or [BCMath](https://www.php.net/manual/en/book.bc.php) PHP extensions. These extensions significantly improve the speed of cryptographic operations used by the underlying JWT library.
1011

1112
If your environment meets these requirements, you can proceed with the installation and configuration of the OpenID Connect package.
1213

@@ -75,6 +76,10 @@ Make sure to implement the `LoginResponseHandlerInterface` in your custom respon
7576
### Disable TLS Certificate Verification
7677
By default, the package verifies the TLS certificate when making requests to the issuer. If you want to disable TLS certificate verification, you can set the `OIDC_TLS_VERIFY` variable to false in your environment configuration.
7778

79+
### Having Issues?
80+
81+
If you are experiencing timeout issues, please check that the [GMP](https://www.php.net/manual/en/book.gmp.php) or [BCMath](https://www.php.net/manual/en/book.bc.php) PHP extension is installed and enabled. These extensions are recommended for optimal performance, especially for RSA operations, and can significantly speed up cryptographic operations used by the underlying JWT library.
82+
7883
## Contributing
7984
If you encounter any issues or have suggestions for improvements, please feel free to open an issue or submit a pull request on the GitHub repository of this package.
8085

composer.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,10 @@
4545
"slevomat/coding-standard": "^8.14",
4646
"ext-openssl": "*"
4747
},
48+
"suggest": {
49+
"ext-gmp": "Enabling GMP is highly recommended for faster cryptographic operations (especially RSA).",
50+
"ext-bcmath": "Enabling BCMath is highly recommended for faster cryptographic operations (especially RSA) as an alternative to GMP."
51+
},
4852
"scripts": {
4953
"test": [
5054
"vendor/bin/phpunit",

0 commit comments

Comments
 (0)