README

Help me out for a couple of 🍻!

⚠️⚠️⚠️

We highly recommend you to use the new JWT Framework project instead of this bundle.

• Active support of this bundle is provided until end of 2018.
• Security support will be provided from 2019 and up to end of 2020.

A migration guide will be/is available in the documentation of the new project.

⚠️⚠️⚠️

This Symfony bundle provides services to create, load, verify or decrypt JWT. It uses spomky-Labs/jose to ease encryption/decryption and signature/verification of JWS and JWE.

The Release Process

The release process is described here.

Prerequisites

This library needs at least:

• 
• Symfony 2.7+ or Symfony 3.0+

Continuous Integration

It has been successfully tested using PHP 5.6, PHP 7 and HHVM.

We also track bugs and code quality using Scrutinizer-CI and Sensio Insight.

Coding Standards are verified by StyleCI.

Code coverage is not performed. We rely on tests performed on the library and we only have implemented Behavior driven development (BDD) to test this bundle.

Installation

The preferred way to install this library is to rely on Composer:

composer require spomky-labs/jose-bundle

Then, add the bundle into your kernel:

<?php

use Symfony\Component\HttpKernel\Kernel;

class AppKernel extends Kernel
{
    public function registerBundles()
    {
        $bundles = [
            ...
            new SpomkyLabs\JoseBundle\SpomkyLabsJoseBundle(),
        ];

        return $bundles;
    }
}

Configuration

This bundle needs to be configured. Please see this page to know how to configure it.

How to use

Have a look at this page to know hot to configure and use this bundle.

Bundle Integration

This bundle provides a Configuration Helper. This helper provides an easy way to create all services through the configuration of another bundle.

Please read this page to know how to easily configure the bundle from another bundle.

Contributing

Requests for new features, bug fixed and all other ideas to make this library useful are welcome. The best contribution you could provide is by fixing the opened issues where help is wanted

Please make sure to follow these best practices.

Licence

This software is release under MIT licence.