flownative/token-authentication

General purpose token authentication.

2.3.2 2024-10-24 11:22 UTC

Requires

• ext-json: *
• neos/flow: ^5.0 || ^6.0 || ^7.0 || ^8.0

MIT

• Christian Müller

README

This package provides token based authentication for Neos Flow projects. It allows both sessionless and session-based authentication to be used.

Installation

Run:

composer require flownative/token-authentication

Usage

Run:

./flow hashtoken:createhashtoken --roleNames Neos.Neos:Editor

Provide the token in your requests

• as request argument _authenticationHashToken=<myToken> or
• as Authorization header with the value Bearer <myToken>.

Configuration

The configuration is done as usual in the Configuration/Settings.yaml file.

Neos:
  Flow:
    security:
      authentication:
        providers:
          'Acme.Com:TokenAuthenticator':
            provider: Flownative\TokenAuthentication\Security\HashTokenProvider
            requestPatterns:
              'Acme.Com:Controllers':
                pattern: ControllerObjectName
                patternOptions:
                  controllerObjectNamePattern: 'Acme\Com\Controller\.*'

By default the package uses a sessionless token. If you want to use a session-based token, set the token option in the provider configuration:

providers:
  'Acme.Com:TokenAuthenticator':
    provider: Flownative\TokenAuthentication\Security\HashTokenProvider
    token: Flownative\TokenAuthentication\Security\SessionStartingHashToken