https://github.com/damax-solutions/api-auth-bundle

Authentication via api key or JWT.
https://github.com/damax-solutions/api-auth-bundle

api bundle jwt php symfony symfony-bundle

Last synced: 6 months ago
JSON representation

Authentication via api key or JWT.

• Host: GitHub
• URL: https://github.com/damax-solutions/api-auth-bundle
• Owner: damax-solutions
• Created: 2018-03-13T14:25:20.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2021-09-21T12:48:25.000Z (over 4 years ago)
• Last Synced: 2024-11-17T13:49:40.613Z (over 1 year ago)
• Topics: api, bundle, jwt, php, symfony, symfony-bundle
• Language: PHP
• Homepage:
• Size: 188 KB
• Stars: 5
• Watchers: 2
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Security: Security/AbstractAuthenticator.php

Awesome Lists containing this project

README

          
# DamaxApiAuthBundle

[![Build Status](https://travis-ci.org/damax-solutions/api-auth-bundle.svg?branch=master)](https://travis-ci.org/damax-solutions/api-auth-bundle) [![Coverage Status](https://coveralls.io/repos/damax-solutions/api-auth-bundle/badge.svg?branch=master&service=github)](https://coveralls.io/github/damax-solutions/api-auth-bundle?branch=master) [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/damax-solutions/api-auth-bundle/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/damax-solutions/api-auth-bundle/?branch=master)

API key or [JWT](https://jwt.io/) 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](Security/ApiKey/ApiKeyUserProvider.php) 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](Resources/doc/installation.md)

- [Api key usage](Resources/doc/api-key.md)

- [Basic JWT usage](Resources/doc/jwt-basic.md)

- [Advanced JWT usage](Resources/doc/jwt-advanced.md)

## Contribute

Install dependencies and run tests:

```bash

$ make

```