eonx-com/easy-api-token

Make your API accept multiple authentication strategies in a convenient way (Basic, ApiKey, JWT, ...)

6.3.0 2024-11-01 09:19 UTC

Requires

• php: ^8.2
• ext-openssl: *
• eonx-com/easy-utils: ^6.3
• nette/utils: ^4.0
• psr/log: ^3.0
• symfony/dependency-injection: ^7.0
• symfony/http-foundation: ^7.0
• symfony/http-kernel: ^7.0
• symfony/security-bundle: ^7.0
• symfony/security-http: ^7.0
• symfony/service-contracts: ^3.5

Requires (Dev)

• auth0/auth0-php: ^8.6
• firebase/php-jwt: ^6.5
• laravel/lumen-framework: ^11.0
• nyholm/psr7: ^1.8
• paragonie/random_compat: ^2.0
• phpseclib/phpseclib: ^3.0.36
• phpunit/phpunit: ^10.2
• psr-discovery/discovery: ^1.0.2
• symfony/cache: ^7.0
• symfony/http-client: ^7.0

Suggests

• auth0/auth0-php: To use the Auth0 JWT driver to decode/encode tokens
• firebase/php-jwt: To use the Auth0, Amazon Cognito, or Firebase JWT driver to decode/encode tokens
• illuminate/contracts: To use this package with Laravel/Lumen
• illuminate/support: To use this package with Laravel/Lumen
• phpseclib/phpseclib: To use the Amazon Cognito JWT driver to decode/encode tokens
• symfony/cache: To use the Amazon Cognito JWT driver to decode/encode tokens
• symfony/http-client: To use the Amazon Cognito JWT driver to decode/encode tokens

MIT

README

---eonx_docs--- title: Introduction weight: 0 ---eonx_docs---

It is common to restrict access to the endpoints of an API by implementing an authentication mechanism. To do so, you have a lot of available solutions: Basic Auth, API keys, JWTs, etc. Which one to pick? There is no magic solution, and you should make your decision based on the specific problem you're trying to solve.

This package will decode the incoming HTTP Request to extract the "ApiToken" as a PHP object that your application can then use. It comes with built-in decoders for:

• Basic Auth
• API keys
• JWTs (Amazon Cognito, Auth0, Firebase)

So you can start supporting each of those strategies with no effort. It also provides a "chain" decoder allowing you to support multiple ApiToken strategies for the same API endpoint.

Each ApiToken implements a common interface allowing you to use them as parameters regardless of the ApiToken strategy used, also each ApiToken has its own specific PHP class allowing you to implement business logic based on the ApiToken strategy used.

Require package (Composer)

The recommended way to install this package is to use Composer:

$ composer require eonx-com/easy-api-token