https://github.com/thamtech/yii2-jws
https://github.com/thamtech/yii2-jws
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/thamtech/yii2-jws
- Owner: thamtech
- License: other
- Created: 2015-10-06T21:21:10.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2020-12-09T19:59:15.000Z (over 5 years ago)
- Last Synced: 2025-09-23T13:07:35.777Z (9 months ago)
- Language: PHP
- Size: 11.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
yii2-jws
========
An extension to manage signed JWS tokens
This library interfaces with
[namshi/jose](https://github.com/namshi/jose) to generate signed
[JWS](https://tools.ietf.org/html/rfc7515) tokens.
For license information check the [LICENSE](LICENSE.md)-file.
Installation
------------
The preferred way to install this extensions is through [composer](https://getcomposer.org/download/).
Either run
```
php composer.phar require --prefer-dist thamtech/yii2-jws
```
or add
```
"thamtech/yii2-jws": "*"
```
to the `require` section of your `composer.json` file.
Integration
-----------
1. [Generate a kepair using OpenSSL](https://en.wikibooks.org/wiki/Cryptography/Generate_a_keypair_using_OpenSSL)
and store the keys in public.pem and private.pem.
2. Add the JwsManager application component in your site configuration:
```php
return [
'components' => [
'jwsManager' => [
'class' => 'thamtech\jws\components\JwsManager',
'pubkey' => '@app/config/keys/jws/public.pem',
'pvtkey' => '@app/config/keys/jws/private.pem',
// The settings below are optional. Defaults will be used if not set here.
//'encoder' => 'Namshi\JOSE\Base64\Base64UrlSafeEncoder',
//'exp' => '1 hour',
//'alg' => 'RS256',
//'jwsClass' => 'Namshi\JOSE\SimpleJWS',
],
]
]
```
Usage
-----
Generate a new token:
```php
$payload = [
"user_id": 23,
"foo": "bar",
];
$tokenString = Yii::$app->jwsManager->newToken($payload);
```
Verify that this string is a token that we signed:
```php
$token = Yii::$app->jwsManager->load($tokenString);
$result = Yii::$app->jwsManager->verify($token);
```
Verify that this string is a token that we signed AND (if it is an instance
of `\Namshi\JOSE\SimpleJWS` wih an expiration) that it is not expired:
```php
$token = Yii::$app->jwsManager->load($tokenString);
$result = Yii::$app->jwsManager->isValid($token);
```
See Also
--------
* [cranetm/yii2-json-rpc-2.0](https://github.com/cranetm/yii2-json-rpc-2.0) - Yii 2
extension that helps turn your Controllers into JSON RPC 2.0 APIs.
* [namshi/jose](https://github.com/namshi/jose) - PHP implementation of the
JWS (JSON Web Signature) specification.
* [JSON Web Token (JWT)](https://tools.ietf.org/html/rfc7519) - JWT specifications
* [JSON Web Signature (JWS)](https://tools.ietf.org/html/rfc7515) - JWS specifications
* [thamtech/yii2-jsonrpc-jwsauth](https://github.com/thamtech/yii2-jsonrpc-jwsauth)