Code Monkey home page Code Monkey logo

lexik-jose-bridge's Introduction

Jose Bridge for the LexikJWTAuthenticationBundle

Build Status Scrutinizer Code Quality

SensioLabsInsight

Latest Stable Version Total Downloads Latest Unstable Version License

This Symfony Bundle provides a JWT Encoder for the LexikJWTAuthenticationBundle that uses the web-token/jwt-framework as JWT Creator/Loader.

The Release Process

The release process is described here.

Prerequisites

This library needs at least:

  • PHP 7.2+
  • Symfony 4.3+.

Continuous Integration

It has been successfully tested using PHP 7.2 and PHP 7.3.

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

Coding Standards are verified by StyleCI.

Code coverage is not performed, but Behavior driven development (BDD) is used to test this bundle.

Installation

Symfony Flex

The preferred way to install this bundle is to rely on Symfony Flex:

composer req "spomky-labs/lexik-jose-bridge:^3.0"

Manual Installation

If you do not use Symfony Flex, then use Composer and install the bundle manually.

composer require spomky-labs/lexik-jose-bridge

Then, add this bundle and the web-token/jwt-framework bundles into your kernel:

<?php

use Symfony\Component\Config\Loader\LoaderInterface;
use Symfony\Component\HttpKernel\Kernel;

class AppKernel extends Kernel
{
    public function registerBundles()
    {
        $bundles = [
            ...
            new Jose\Bundle\JoseFramework\JoseFrameworkBundle(),
            new SpomkyLabs\LexikJoseBundle\SpomkyLabsLexikJoseBundle(),
        ];

        return $bundles;
    }
}

Signature/Encryption Algorithms

This bundle only installs the RSA based signature algorithms (RS256, RS384 and RS512). If you need other signature algorithms (e.g EC based, HMAC) or if you want to use the encryption feature, you must install the corresponding packages:

  • Signature Algorithms
    • All: composer require web-token/signature-pack
    • HMAC: composer require jwt-signature-algorithm-hmac
    • ECDSA: composer require jwt-signature-algorithm-ecdsa
    • EdDSA: composer require jwt-signature-algorithm-eddsa
    • None: composer require jwt-signature-algorithm-none (not recommended)
    • Experimental: composer require jwt-signature-algorithm-experimental (not recommended)
  • Encryption Algorithms
    • All: composer require web-token/encryption-pack
    • Key Encryption:
      • ECDH-ES: composer require web-token/jwt-encryption-algorithm-ecdh-es
      • AES Key Wrapping: composer require web-token/jwt-encryption-algorithm-aeskw
      • RSA: composer require web-token/jwt-encryption-algorithm-rsa
      • AES GCM Key Wrapping: composer require web-token/jwt-encryption-algorithm-aesgcmkw
      • Direct: composer require web-token/jwt-encryption-algorithm-dir (not recommended)
      • PBES 2: composer require web-token/jwt-encryption-algorithm-pbes2 (not recommended)
    • Content Encryption:
      • AES GCM: composer require web-token/jwt-encryption-algorithm-aesgcm
      • AES CBC: composer require web-token/jwt-encryption-algorithm-aescbc
    • Experimental: composer require web-token/jwt-encryption-algorithm-experimental (not recommended)

Configuration

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

How to use

There is nothing to do. Just use your application as usual.

Support

I bring solutions to your problems and answer your questions.

If you really love that project and the work I have done or if you want I prioritize your issues, then you can help me out for a couple of ๐Ÿป or more!

Become a Patreon

Contributing

Requests for new features, bug fixes and all other ideas to make this library useful are welcome. Please follow these best practices.

Licence

This software is release under MIT licence.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.