Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
HergenD committed Jul 8, 2020
0 parents commit 2e78474
Show file tree
Hide file tree
Showing 13 changed files with 477 additions and 0 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
/vendor
1 change: 1 addition & 0 deletions .styleci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
preset: laravel
8 changes: 8 additions & 0 deletions changelog.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Changelog

All notable changes to `jwtfusionauth` will be documented in this file.

## Version 1.0

### Added
- Everything
45 changes: 45 additions & 0 deletions composer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
{
"name": "werk365/jwtfusionauth",
"description": ":package_description",
"license": "MIT",
"authors": [
{
"name": "Hergen Dillema",
"email": "[email protected]",
"homepage": "https://365werk/nl"
}
],
"homepage": "https://github.com/365werk/jwtfusionauth",
"keywords": ["Laravel", "jwtfusionauth"],
"require": {
"illuminate/support": "~5|~6|~7",
"firebase/php-jwt": "^5.2",
"phpseclib/phpseclib": "^2.0"
},
"require-dev": {
"phpunit/phpunit": "^8.0",
"mockery/mockery": "^1.1",
"orchestra/testbench": "~3|~4",
"sempro/phpunit-pretty-print": "^1.0"
},
"autoload": {
"psr-4": {
"werk365\\jwtfusionauth\\": "src/"
}
},
"autoload-dev": {
"psr-4": {
"werk365\\jwtfusionauth\\Tests\\": "tests"
}
},
"extra": {
"laravel": {
"providers": [
"werk365\\jwtfusionauth\\jwtfusionauthServiceProvider"
],
"aliases": {
"jwtfusionauth": "werk365\\jwtfusionauth\\Facades\\jwtfusionauth"
}
}
}
}
20 changes: 20 additions & 0 deletions config/jwtfusionauth.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
<?php

return [
'jwkUri' => env('JWKS_URL', 'http://localhost:9011/.well-known/jwks.json'),
'pemUri' => env('PEM_URL', 'http://localhost:9011/api/jwt/public-key'),

// Configure to use PEM endpoint (default) or JWK
'useJwk' => env('USE_JWK', true),

// Column name in the users table where uuid should be stored. Defaults to id but can be another column like 'uuid'
'userId' => env('FA_USR_ID', 'id'),

'autoCreateUser' => env('FA_CREATE_USR', true),

// This uses spatie's permissions package to give users the fusionauth roles.
// To use this, installing the permissions package is required
'usePermissions' => env('FA_USE_PERM', true),
// Creates a role if not found in database
'autoCreateRoles' => env('FA_CREATE_ROLES', true)
];
27 changes: 27 additions & 0 deletions contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Contributing

Contributions are welcome and will be fully credited.

Contributions are accepted via Pull Requests on [Github](https://github.com/werk365/jwtfusionauth).

# Things you could do
If you want to contribute but do not know where to start, this list provides some starting points.
- Add license text
- Remove rewriteRules.php
- Set up TravisCI, StyleCI, ScrutinizerCI
- Write a comprehensive ReadMe

## Pull Requests

- **Add tests!** - Your patch won't be accepted if it doesn't have tests.

- **Document any change in behaviour** - Make sure the `readme.md` and any other relevant documentation are kept up-to-date.

- **Consider our release cycle** - We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option.

- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.

- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](http://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.


**Happy coding**!
33 changes: 33 additions & 0 deletions database/migrations/create_jwks_table.php.stub
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
<?php

use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;

class CreateJwksTable extends Migration
{
/**
* Run the migrations.
*
* @return void
*/
public function up()
{
Schema::create('jwks', function (Blueprint $table) {
$table->id();
$table->string('kid');
$table->text('key');
$table->timestamps();
});
}

/**
* Reverse the migrations.
*
* @return void
*/
public function down()
{
Schema::dropIfExists('jwks');
}
}
9 changes: 9 additions & 0 deletions license.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# MIT

Copyright (c) Hergen Dillema <[email protected]>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
22 changes: 22 additions & 0 deletions phpunit.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
<?xml version="1.0" encoding="UTF-8"?>
<phpunit bootstrap="vendor/autoload.php"
backupGlobals="false"
backupStaticAttributes="false"
colors="true"
verbose="true"
convertErrorsToExceptions="true"
convertNoticesToExceptions="true"
convertWarningsToExceptions="true"
processIsolation="false"
stopOnFailure="false">
<testsuites>
<testsuite name="Package">
<directory suffix=".php">./tests/</directory>
</testsuite>
</testsuites>
<filter>
<whitelist>
<directory>src/</directory>
</whitelist>
</filter>
</phpunit>
57 changes: 57 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
# jwtfusionauth

[![Latest Version on Packagist][ico-version]][link-packagist]
[![Total Downloads][ico-downloads]][link-downloads]
[![Build Status][ico-travis]][link-travis]
[![StyleCI][ico-styleci]][link-styleci]

This is where your description should go. Take a look at [contributing.md](contributing.md) to see a to do list.

## Installation

Via Composer

``` bash
$ composer require werk365/jwtfusionauth
```

## Usage

## Change log

Please see the [changelog](changelog.md) for more information on what has changed recently.

## Testing

``` bash
$ composer test
```

## Contributing

Please see [contributing.md](contributing.md) for details and a todolist.

## Security

If you discover any security related issues, please email author email instead of using the issue tracker.

## Credits

- [author name][link-author]
- [All Contributors][link-contributors]

## License

license. Please see the [license file](license.md) for more information.

[ico-version]: https://img.shields.io/packagist/v/werk365/jwtfusionauth.svg?style=flat-square
[ico-downloads]: https://img.shields.io/packagist/dt/werk365/jwtfusionauth.svg?style=flat-square
[ico-travis]: https://img.shields.io/travis/werk365/jwtfusionauth/master.svg?style=flat-square
[ico-styleci]: https://styleci.io/repos/12345678/shield

[link-packagist]: https://packagist.org/packages/werk365/jwtfusionauth
[link-downloads]: https://packagist.org/packages/werk365/jwtfusionauth
[link-travis]: https://travis-ci.org/werk365/jwtfusionauth
[link-styleci]: https://styleci.io/repos/12345678
[link-author]: https://github.com/werk365
[link-contributors]: ../../contributors
18 changes: 18 additions & 0 deletions src/Facades/jwtfusionauth.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<?php

namespace werk365\jwtfusionauth\Facades;

use Illuminate\Support\Facades\Facade;

class jwtfusionauth extends Facade
{
/**
* Get the registered name of the component.
*
* @return string
*/
protected static function getFacadeAccessor()
{
return 'jwtfusionauth';
}
}
130 changes: 130 additions & 0 deletions src/jwtfusionauth.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,130 @@
<?php

namespace werk365\jwtfusionauth;

use App\jwk;
use App\User;
use Firebase\JWT\JWT;
use phpseclib\Crypt\RSA;
use phpseclib\Math\BigInteger;
use Spatie\Permission\Models\Role;

class jwtfusionauth
{
private static function getKid(string $jwt) {
$tks = explode('.', $jwt);
if (count($tks) === 3) {
$header = JWT::jsonDecode(JWT::urlsafeB64Decode($tks[0]));
if (isset($header->kid)) {
return $header->kid;
}
}
return null;
}

private static function jwkToPem(object $jwk)
{
if (isset($jwk->e) && isset($jwk->n)) {
$rsa = new RSA();
$rsa->loadKey([
'e' => new BigInteger(JWT::urlsafeB64Decode($jwk->e), 256),
'n' => new BigInteger(JWT::urlsafeB64Decode($jwk->n), 256)
]);
return $rsa->getPublicKey();
}
return null;
}

private static function getPublicKey(string $kid, string $uri) {
$jwksUrl = sprintf($uri);
$ch = curl_init($jwksUrl);
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_TIMEOUT => 3,
]);
$json = curl_exec($ch);
if ($json) {
$jwks = json_decode($json, false);
if ($jwks && isset($jwks->keys) && is_array($jwks->keys)) {
foreach ($jwks->keys as $jwk) {
if ($jwk->kid === $kid) {
return self::jwkToPem($jwk);
}
}
}
}
return null;
}

private static function getPem(string $kid, string $uri) {
$pemUrl = sprintf($uri);
$ch = curl_init($pemUrl);
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_TIMEOUT => 3,
]);
$json = curl_exec($ch);
if ($json) {
$pems = json_decode($json, false);
if ($pems && isset($pems->publicKeys) && is_object($pems->publicKeys)) {
foreach ($pems->publicKeys as $key=>$pem) {
if ($key === $kid) {
return $pem;
}
}
}
}
return null;
}

private static function verifyToken(string $jwt, string $uri, bool $jwk = false)
{
$publicKey = null;
$kid = self::getKid($jwt);
if ($kid) {
$row = jwk::where('kid', $kid)->orderBy('created_at', 'desc')->first();
if (false) {
$publicKey = $row->key;
}
else {
if($jwk){
$publicKey = self::getPublicKey($kid, $uri);
} else {
$publicKey = self::getPem($kid, $uri);
}
$row = jwk::create(['kid' => $kid, 'key' => $publicKey]);
}
}

if ($publicKey) {
return JWT::decode($jwt, $publicKey, array('RS256'));
}
return null;
}

public static function authUser(object $request)
{
$jwt = $request->bearerToken();
$uri = config('jwtfusionauth.useJwk')?config('jwtfusionauth.jwkUri'):config('jwtfusionauth.pemUri');
$claims = self::verifyToken($jwt, $uri, config('jwtfusionauth.useJwk'));
if(config('jwtfusionauth.autoCreateUser')){
$user = User::firstOrNew([config('jwtfusionauth.userId') => $claims->sub]);
$user[config('jwtfusionauth.userId')] = $claims->sub;
$user->save();
} else {
$user = User::where(config('jwtfusionauth.userId'), '=' , $claims->sub)->firstOrFail();
}
if(config('jwtfusionauth.usePermissions')){
if(config('jwtfusionauth.autoCreateRoles')){
foreach($claims->roles as $role){
$db_role = Role::where('name', $role)->first();
if(!$db_role){
Role::create(['name' => $role]);
}
}
}
$user->assignRole($claims->roles);
}
return $user;
}
}
Loading

0 comments on commit 2e78474

Please sign in to comment.