damax/api-auth-bundle

Authentication via api key or JWT.

v2.1.0 2019-02-17 15:23 UTC

Requires

• php: ^7.1
• symfony/security-bundle: ^3.4|^4.0

Requires (Dev)

• doctrine/dbal: ^2.7
• friendsofphp/php-cs-fixer: ^2.14
• lcobucci/jwt: 4.*@dev
• matthiasnoback/symfony-dependency-injection-test: ^3.0
• nelmio/api-doc-bundle: ^3.3
• php-coveralls/php-coveralls: ^2.0
• predis/predis: ^1.1
• symfony/framework-bundle: ^4.1
• symfony/phpunit-bridge: ^4.0

MIT

README

API key or JWT authentication for Symfony application.

Features

Api keys

• Store keys in Redis, database or right in config.
• Search in multiple storage types until found.
• Use console commands to add, remove or lookup existing keys.
• Define TTL for each key i.e. grant temporary access to your API.
• Configure the chain of key extractors from cookie, query string or header.
• Finally, implement your own ApiKeyUserProvider for custom solution.

JWT

• Symmetric signing support for quick setup i.e. SSH keys are not required.
• Add and validate all registered claims.
• Extend payload with any public or custom claim.
• Refresh token functionality.
• Customize success or error responses.

Documentation

Topics:

• Installation
• Api key usage
• Basic JWT usage
• Advanced JWT usage

Contribute

Install dependencies and run tests:

$ make