Skip to content

rwx-zwx-awx/jose-service

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

36 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

PHP JOSE Service

Scrutinizer Code Quality Code Coverage Build Status HHVM Status

SensioLabsInsight

Latest Stable Version Total Downloads Latest Unstable Version License

StyleCI

This project 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

  • PHP 5.4.

Depending on algorithms you want to use, please consider the following optional requirements:

  • Elliptic Curves based algorithms (ESxxx signatures, ECDHES encryptions):
  • RSA based algorithms (RSxxx or PSxxx signatures, RSA1_5, RSA_OAEP, RSA_OAEP-256...):
    • phpseclib/phpseclib (v2.0.x).
  • Password Based Key Derivation Function 2 (PBKDF2) based algorithms (PBES2-*):
  • Key Wrapped based algorithms (A128KW, PBES2-HS256+A128KW...):
  • AES based algorithms (excluding AES-GCM):
    • OpenSSL library for AES algorithms.
    • or MCrypt library for AES algorithms.
    • or phpseclib/phpseclib (v2.0.x).
  • AES-GCM based algorithms:
    • PHP Crypto Extension for AES GCM algorithms (not available on PHP 7 and HHVM).

It has been successfully tested using PHP 5.4 to PHP 5.6.

Tests with PHP 7 and HHVM are incomplete because of some optional dependencies not available on these platforms.

Installation

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

composer require spomky-labs/jose-service

How to use

Your classes are ready to use? Have a look at How to use to create or load your first JWT objects.

Contributing

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

Licence

This software is release under MIT licence.