rfy/jwt

Last activity 23 Oct 2021 1 3 160
composer require rfy/jwt

A JWT authentication provider based on Firebase JWT package

RFY.JWT

Code Climate Test Coverage Build Status

This package is meant to make a TOKEN authentication possible for any request authentication attempt.

The possible responses are:

  • AuthenticationSuccessfull which returns the authentication JWT token
  • AuthenticationFailure which returns a message with the corresponding error code

Getting started

To start using this package you will need to follow the following steps:

Include this package into your Neos Flow application by running:

composer require rfy/jwt

Add the below YAML to the projects Configuration/Routes.yaml:

-
  name: 'Token'
  uriPattern: '<TokenSubroutes>'
  defaults:
    '@format': 'json'
  subRoutes:
    TokenSubroutes:
      package: RFY.JWT

By default the security features are enabled in this package by these settings:

Neos:
  Flow:
    security:
      authentication:
        providers:
          'BackendProvider':
            provider: 'RFY\JWT\Security\Authentication\Provider\PersistedApiTokenProvider'
            token: 'RFY\JWT\Security\Authentication\Token\ApiToken'
            entryPoint: 'HttpBasic'

You of course overwrite these settings based on your wishes.

References:

This implementation requires the Firebase JWT package.

Authors:

Author: Sebastiaan van Parijs (svparijs@rfy.io)

Feedback & Reviews:

Reviewer: Bastian Waidelich

License

The MIT License (MIT). Please see License File for more information.

The content of the readme is provided by Github