jonny/jonnybarnes.uk
1
0
Fork 0
Code Issues 5 Pull requests Projects Releases 5 Packages Wiki Activity Actions

Merge pull request #218 from jonnybarnes/php8

Browse source 
Initial php8 work
This commit is contained in:
Jonny Barnes 2020-12-31 14:30:14 +00:00 • committed by GitHub
commit 2fbb1f60c8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
15 changed files with 861 additions and 760 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
.github/workflows/run-tests.yml vendored
View file

@ -28,14 +28,11 @@ jobs:
key: ${{ runner.os }}-${{ hashFiles('**/package.json') }}
- name: Install npm dependencies
run: npm install
- name: Install ImageMagick
run: sudo apt install imagemagick
- name: Setup PHP with pecl extension
uses: shivammathur/setup-php@v2
with:
php-version: '7.4'
tools: pecl, phpcs
extensions: imagick
php-version: '8.0'
tools: phpcs
- name: Copy .env
run: php -r "file_exists('.env') || copy('.env.github', '.env');"
- name: Install dependencies

13
app/Exceptions/InvalidTokenException.php
View file

@ -1,13 +0,0 @@
<?php
namespace App\Exceptions;
use Exception;
class InvalidTokenException extends Exception
{
public function __construct($message, $code = 0, Exception $previous = null)
{
parent::__construct($message, $code, $previous);
}
}

26
app/Http/Controllers/MicropubController.php
View file

@ -4,12 +4,13 @@ declare(strict_types=1);
namespace App\Http\Controllers;
use App\Exceptions\InvalidTokenException;
use App\Http\Responses\MicropubResponses;
use App\Models\Place;
use App\Services\Micropub\{HCardService, HEntryService, UpdateService};
use App\Services\TokenService;
use Illuminate\Http\JsonResponse;
use Lcobucci\JWT\Token\InvalidTokenStructure;
use Lcobucci\JWT\Validation\RequiredConstraintsViolated;
use Monolog\Handler\StreamHandler;
use Monolog\Logger;
@ -37,19 +38,18 @@ class MicropubController extends Controller
* then passes over the info to the relevant Service class.
*
* @return JsonResponse
* @throws InvalidTokenException
*/
public function post(): JsonResponse
{
try {
$tokenData = $this->tokenService->validateToken(request()->input('access_token'));
} catch (InvalidTokenException $e) {
} catch (RequiredConstraintsViolated | InvalidTokenStructure $exception) {
$micropubResponses = new MicropubResponses();
return $micropubResponses->invalidTokenResponse();
}
if ($tokenData->hasClaim('scope') === false) {
if ($tokenData->claims()->has('scope') === false) {
$micropubResponses = new MicropubResponses();
return $micropubResponses->tokenHasNoScopeResponse();
@ -58,7 +58,7 @@ class MicropubController extends Controller
$this->logMicropubRequest(request()->all());
if ((request()->input('h') == 'entry') || (request()->input('type.0') == 'h-entry')) {
if (stristr($tokenData->getClaim('scope'), 'create') === false) {
if (stristr($tokenData->claims()->get('scope'), 'create') === false) {
$micropubResponses = new MicropubResponses();
return $micropubResponses->insufficientScopeResponse();
@ -72,7 +72,7 @@ class MicropubController extends Controller
}
if (request()->input('h') == 'card' || request()->input('type.0') == 'h-card') {
if (stristr($tokenData->getClaim('scope'), 'create') === false) {
if (stristr($tokenData->claims()->get('scope'), 'create') === false) {
$micropubResponses = new MicropubResponses();
return $micropubResponses->insufficientScopeResponse();
@ -86,7 +86,7 @@ class MicropubController extends Controller
}
if (request()->input('action') == 'update') {
if (stristr($tokenData->getClaim('scope'), 'update') === false) {
if (stristr($tokenData->claims()->get('scope'), 'update') === false) {
$micropubResponses = new MicropubResponses();
return $micropubResponses->insufficientScopeResponse();
@ -115,7 +115,7 @@ class MicropubController extends Controller
{
try {
$tokenData = $this->tokenService->validateToken(request()->input('access_token'));
} catch (InvalidTokenException $e) {
} catch (RequiredConstraintsViolated | InvalidTokenStructure $exception) {
$micropubResponses = new MicropubResponses();
return $micropubResponses->invalidTokenResponse();
@ -156,9 +156,9 @@ class MicropubController extends Controller
return response()->json([
'response' => 'token',
'token' => [
'me' => $tokenData->getClaim('me'),
'scope' => $tokenData->getClaim('scope'),
'client_id' => $tokenData->getClaim('client_id'),
'me' => $tokenData->claims()->get('me'),
'scope' => $tokenData->claims()->get('scope'),
'client_id' => $tokenData->claims()->get('client_id'),
],
]);
}
@ -167,13 +167,13 @@ class MicropubController extends Controller
* Determine the client id from the access token sent with the request.
*
* @return string
* @throws InvalidTokenException
* @throws RequiredConstraintsViolated
*/
private function getClientId(): string
{
return resolve(TokenService::class)
->validateToken(request()->input('access_token'))
->getClaim('client_id');
->claims()->get('client_id');
}
/**

15
app/Http/Controllers/MicropubMediaController.php
View file

@ -4,7 +4,6 @@ declare(strict_types=1);
namespace App\Http\Controllers;
use App\Exceptions\InvalidTokenException;
use App\Http\Responses\MicropubResponses;
use App\Jobs\ProcessMedia;
use App\Models\Media;
@ -21,6 +20,8 @@ use Illuminate\Support\Facades\Storage;
use Illuminate\Support\Str;
use Intervention\Image\Exception\NotReadableException;
use Intervention\Image\ImageManager;
use Lcobucci\JWT\Token\InvalidTokenStructure;
use Lcobucci\JWT\Validation\RequiredConstraintsViolated;
use Ramsey\Uuid\Uuid;
class MicropubMediaController extends Controller
@ -36,19 +37,19 @@ class MicropubMediaController extends Controller
{
try {
$tokenData = $this->tokenService->validateToken(request()->input('access_token'));
} catch (InvalidTokenException $e) {
} catch (RequiredConstraintsViolated | InvalidTokenStructure $exception) {
$micropubResponses = new MicropubResponses();
return $micropubResponses->invalidTokenResponse();
}
if ($tokenData->hasClaim('scope') === false) {
if ($tokenData->claims()->has('scope') === false) {
$micropubResponses = new MicropubResponses();
return $micropubResponses->tokenHasNoScopeResponse();
}
if (Str::contains($tokenData->getClaim('scope'), 'create') === false) {
if (Str::contains($tokenData->claims()->get('scope'), 'create') === false) {
$micropubResponses = new MicropubResponses();
return $micropubResponses->insufficientScopeResponse();
@ -103,19 +104,19 @@ class MicropubMediaController extends Controller
{
try {
$tokenData = $this->tokenService->validateToken(request()->input('access_token'));
} catch (InvalidTokenException $e) {
} catch (RequiredConstraintsViolated | InvalidTokenStructure $exception) {
$micropubResponses = new MicropubResponses();
return $micropubResponses->invalidTokenResponse();
}
if ($tokenData->hasClaim('scope') === false) {
if ($tokenData->claims()->has('scope') === false) {
$micropubResponses = new MicropubResponses();
return $micropubResponses->tokenHasNoScopeResponse();
}
if (Str::contains($tokenData->getClaim('scope'), 'create') === false) {
if (Str::contains($tokenData->claims()->get('scope'), 'create') === false) {
$micropubResponses = new MicropubResponses();
return $micropubResponses->insufficientScopeResponse();

22
app/Http/Controllers/SessionStoreController.php
View file

@ -1,22 +0,0 @@
<?php
declare(strict_types=1);
namespace App\Http\Controllers;
class SessionStoreController extends Controller
{
/**
* Save the selected colour scheme in the session.
*
* @return string[]
*/
public function saveColour(): array
{
$css = request()->input('css');
session(['css' => $css]);
return ['status' => 'ok'];
}
}

15
app/Providers/AppServiceProvider.php
View file

@ -11,6 +11,10 @@ use Illuminate\Support\Collection;
use Illuminate\Support\ServiceProvider;
use Illuminate\Support\Str;
use Laravel\Dusk\DuskServiceProvider;
use Lcobucci\JWT\Configuration;
use Lcobucci\JWT\Signer\Hmac\Sha256;
use Lcobucci\JWT\Signer\Key\InMemory;
use Lcobucci\JWT\Validation\Constraint\SignedWith;
class AppServiceProvider extends ServiceProvider
{
@ -73,6 +77,17 @@ class AppServiceProvider extends ServiceProvider
]
);
});
// Configure JWT builder
$this->app->bind('Lcobucci\JWT\Configuration', function () {
$key = InMemory::plainText('testing');
$config = Configuration::forSymmetricSigner(new Sha256(), $key);
$config->setValidationConstraints(new SignedWith(new Sha256(), $key));
return $config;
});
}
/**

41
app/Services/TokenService.php
View file

@ -4,10 +4,9 @@ declare(strict_types=1);
namespace App\Services;
use App\Exceptions\InvalidTokenException;
use App\Jobs\AddClientToDatabase;
use Lcobucci\JWT\Signer\Hmac\Sha256;
use Lcobucci\JWT\{Builder, Parser, Token};
use DateTimeImmutable;
use Lcobucci\JWT\{Configuration, Token};
class TokenService
{
@ -19,17 +18,19 @@ class TokenService
*/
public function getNewToken(array $data): string
{
$signer = new Sha256();
$token = (new Builder())->set('me', $data['me'])
->set('client_id', $data['client_id'])
->set('scope', $data['scope'])
->set('date_issued', time())
->set('nonce', bin2hex(random_bytes(8)))
->sign($signer, config('app.key'))
->getToken();
$config = resolve(Configuration::class);
$token = $config->builder()
->issuedAt(new DateTimeImmutable())
->withClaim('client_id', $data['client_id'])
->withClaim('me', $data['me'])
->withClaim('scope', $data['scope'])
->withClaim('nonce', bin2hex(random_bytes(8)))
->getToken($config->signer(), $config->signingKey());
dispatch(new AddClientToDatabase($data['client_id']));
return (string) $token;
return $token->toString();
}
/**
@ -40,15 +41,13 @@ class TokenService
*/
public function validateToken(string $bearerToken): Token
{
$signer = new Sha256();
try {
$token = (new Parser())->parse((string) $bearerToken);
} catch (\InvalidArgumentException $e) {
throw new InvalidTokenException('Token could not be parsed');
}
if (! $token->verify($signer, config('app.key'))) {
throw new InvalidTokenException('Token failed validation');
}
$config = resolve('Lcobucci\JWT\Configuration');
$token = $config->parser()->parse($bearerToken);
$constraints = $config->validationConstraints();
$config->validator()->assert($token, ...$constraints);
return $token;
}

17
composer.json
View file

@ -9,7 +9,7 @@
],
"license": "CC0-1.0",
"require": {
"php": "^7.4",
"php": "^7.4|^8.0",
"ext-intl": "*",
"ext-json": "*",
"ext-dom": "*",
@ -17,7 +17,7 @@
"fideloper/proxy": "~4.0",
"fruitcake/laravel-cors": "^2.0",
"guzzlehttp/guzzle": "^7.0.1",
"indieauth/client": "~0.1",
"indieauth/client": "^1.1",
"intervention/image": "^2.4",
"jonnybarnes/indieweb": "~0.2",
"jonnybarnes/webmentions-parser": "~0.5",
@ -27,11 +27,11 @@
"laravel/scout": "^8.0",
"laravel/telescope": "^4.0",
"laravel/tinker": "^2.0",
"lcobucci/jwt": "^3.1",
"lcobucci/jwt": "^4.0",
"league/commonmark": "^1.0",
"league/flysystem-aws-s3-v3": "^1.0",
"mf2/mf2": "~0.3",
"pmatseykanets/laravel-scout-postgres": "^7.0",
"pmatseykanets/laravel-scout-postgres": "dev-php8",
"predis/predis": "~1.0",
"sensiolabs/security-checker": "^6.0",
"spatie/browsershot": "~3.0",
@ -43,10 +43,11 @@
"barryvdh/laravel-ide-helper": "^2.6",
"beyondcode/laravel-dump-server": "^1.0",
"facade/ignition": "^2.3.6",
"fzaninotto/faker": "^1.9.1",
"fakerphp/faker": "^1.9.2",
"laravel/dusk": "^6.0",
"mockery/mockery": "^1.0",
"nunomaduro/collision": "^5.0",
"phpunit/php-code-coverage": "^9.2",
"phpunit/phpunit": "^9.0",
"vimeo/psalm": "^4.0"
},
@ -91,5 +92,11 @@
"test": [
"vendor/bin/phpunit --stop-on-failure"
]
},
"repositories": [
{
"type": "vcs",
"url": "https://github.com/jonnybarnes/laravel-scout-postgres"
}
]
}

1348
composer.lock generated
View file

File diff suppressed because it is too large Load diff

2
config/image.php
View file

@ -15,6 +15,6 @@ return [
|
*/
'driver' => 'imagick',
'driver' => 'gd',
];

2
database/seeders/ArticlesTableSeeder.php
View file

@ -16,7 +16,7 @@ class ArticlesTableSeeder extends Seeder
*/
public function run()
{
$now = Carbon::now()->subMonth();
$now = Carbon::now()->subMonth()->subDays(5);
$articleFirst = Article::create([
'title' => 'My New Blog',
'main' => 'This is *my* new blog. It uses `Markdown`.',

14
phpunit.xml
View file

@ -19,11 +19,6 @@
<directory suffix="Test.php">./tests/Feature</directory>
</testsuite>
</testsuites>
<filter>
<whitelist processUncoveredFilesFromWhitelist="true">
<directory suffix=".php">./app</directory>
</whitelist>
</filter>
<php>
<env name="APP_ENV" value="testing"/>
<env name="BCRYPT_ROUNDS" value="4"/>
@ -32,5 +27,14 @@
<env name="QUEUE_CONNECTION" value="sync"/>
<env name="SESSION_DRIVER" value="array"/>
<env name="TELESCOPE_ENABLED" value="false"/>
<ini name="memory_limit" value="512M"/>
</php>
<coverage pathCoverage="true" includeUncoveredFiles="true" processUncoveredFiles="true">
<include>
<directory suffix=".php">./app</directory>
</include>
<report>
<html outputDirectory="./public/coverage"/>
</report>
</coverage>
</phpunit>

7
tests/Feature/MicropubControllerTest.php
View file

@ -5,19 +5,16 @@ namespace Tests\Feature;
use Carbon\Carbon;
use Tests\TestCase;
use Tests\TestToken;
use App\Jobs\ProcessMedia;
use App\Jobs\SendWebMentions;
use App\Models\{Media, Place};
use Illuminate\Http\UploadedFile;
use App\Jobs\SyndicateNoteToTwitter;
use Illuminate\Support\Facades\Queue;
use Illuminate\Support\Facades\Storage;
use MStaack\LaravelPostgis\Geometries\Point;
use Illuminate\Foundation\Testing\DatabaseTransactions;
class MicropubControllerTest extends TestCase
{
use DatabaseTransactions, TestToken;
use DatabaseTransactions;
use TestToken;
/**
* Test a GET request for the micropub endpoint without a token gives a

37
tests/Feature/TokenServiceTest.php
View file

@ -2,11 +2,12 @@
namespace Tests\Feature;
use DateTimeImmutable;
use Lcobucci\JWT\Configuration;
use Lcobucci\JWT\Signer\Key\InMemory;
use Lcobucci\JWT\Validation\RequiredConstraintsViolated;
use Tests\TestCase;
use Lcobucci\JWT\Builder;
use App\Services\TokenService;
use Lcobucci\JWT\Signer\Hmac\Sha256;
use App\Exceptions\InvalidTokenException;
class TokenServiceTest extends TestCase
{
@ -27,33 +28,35 @@ class TokenServiceTest extends TestCase
$token = $tokenService->getNewToken($data);
$valid = $tokenService->validateToken($token);
$validData = [
'me' => $valid->getClaim('me'),
'client_id' => $valid->getClaim('client_id'),
'scope' => $valid->getClaim('scope')
'me' => $valid->claims()->get('me'),
'client_id' => $valid->claims()->get('client_id'),
'scope' => $valid->claims()->get('scope')
];
$this->assertSame($data, $validData);
}
public function test_token_with_different_signing_key_throws_exception()
{
$this->expectException(InvalidTokenException::class);
$this->expectExceptionMessage('Token failed validation');
$this->expectException(RequiredConstraintsViolated::class);
$data = [
'me' => 'https://example.org',
'client_id' => 'https://quill.p3k.io',
'scope' => 'post'
];
$signer = new Sha256();
$token = (new Builder())->set('me', $data['me'])
->set('client_id', $data['client_id'])
->set('scope', $data['scope'])
->set('date_issued', time())
->set('nonce', bin2hex(random_bytes(8)))
->sign($signer, 'r4ndomk3y')
->getToken();
$config = resolve(Configuration::class);
$token = $config->builder()
->issuedAt(new DateTimeImmutable())
->withClaim('client_id', $data['client_id'])
->withClaim('me', $data['me'])
->withClaim('scope', $data['scope'])
->withClaim('nonce', bin2hex(random_bytes(8)))
->getToken($config->signer(), InMemory::plainText('r4andomk3y'))
->toString();
$service = new TokenService();
$token = $service->validateToken($token);
$service->validateToken($token);
}
}

53
tests/TestToken.php
View file

@ -2,50 +2,47 @@
namespace Tests;
use Lcobucci\JWT\Builder;
use Lcobucci\JWT\Signer\Hmac\Sha256;
use DateTimeImmutable;
use Lcobucci\JWT\Configuration;
trait TestToken
{
public function getToken()
{
$signer = new Sha256();
$token = (new Builder())
->set('client_id', 'https://quill.p3k.io')
->set('me', 'https://jonnybarnes.localhost')
->set('scope', 'create update')
->set('issued_at', time())
->sign($signer, env('APP_KEY'))
->getToken();
$config = $this->app->make(Configuration::class);
return $token;
return $config->builder()
->issuedAt(new DateTimeImmutable())
->withClaim('client_id', 'https://quill.p3k.io')
->withClaim('me', 'https://jonnybarnes.localhost')
->withClaim('scope', 'create update')
->getToken($config->signer(), $config->signingKey())
->toString();
}
public function getTokenWithIncorrectScope()
{
$signer = new Sha256();
$token = (new Builder())
->set('client_id', 'https://quill.p3k.io')
->set('me', 'https://jonnybarnes.localhost')
->set('scope', 'view') //error here
->set('issued_at', time())
->sign($signer, env('APP_KEY'))
->getToken();
$config = $this->app->make(Configuration::class);
return $token;
return $config->builder()
->issuedAt(new DateTimeImmutable())
->withClaim('client_id', 'https://quill.p3k.io')
->withClaim('me', 'https://jonnybarnes.localhost')
->withClaim('scope', 'view')
->getToken($config->signer(), $config->signingKey())
->toString();
}
public function getTokenWithNoScope()
{
$signer = new Sha256();
$token = (new Builder())
->set('client_id', 'https://quill.p3k.io')
->set('me', 'https://jonnybarnes.localhost')
->set('issued_at', time())
->sign($signer, env('APP_KEY'))
->getToken();
$config = $this->app->make(Configuration::class);
return $token;
return $config->builder()
->issuedAt(new DateTimeImmutable())
->withClaim('client_id', 'https://quill.p3k.io')
->withClaim('me', 'https://jonnybarnes.localhost')
->getToken($config->signer(), $config->signingKey())
->toString();
}
public function getInvalidToken()