swop/github-webhook-middleware

PSR-7 style & PSR-15 compatible middleware which will verify if the incoming GitHub web hook request is correctly signed.

Tuesday, November 22, 2016
by Swop
Repository
1 Watchers
0 Stars
35 Installations

PHP
2 Dependents
0 Suggesters
0 Forks
0 Open issues
3 Versions
0 % Grown

Github WebHook PSR-7 / PSR-15 middleware

, _(*1)

This library offers a PSR-7 style & PSR-15 middleware which will verify if the incoming GitHub web hook request is correctly signed., _(*2)

The provided PSR-7 request will have its X-Hub-Signature header checked in order to see if the request was originally performed by GitHub using the correct secret to sign the request., _(*3)

If the request signature validation fails, a 401 JSON response will be send back., _(*4)

Installation

The recommended way to install this library is through Composer:, _(*5)

composer require "swop/github-webhook-middleware"

Usage

Ex: PSR-7 style middleware using Zend Diactoros Server

```php <?php, _(*6)

use Psr\Http\Message\RequestInterface; use Psr\Http\Message\ResponseInterface;, _(*7)

use Swop\GitHubWebHook\Security\SignatureValidator; use Swop\GitHubWebHookMiddleware\GithubWebHook;, _(*8)

$request = \Zend\Diactoros\ServerRequestFactory::fromGlobals();, _(*9)

$middleware = new GithubWebHook(new SignatureValidator(), 'my_secret');, _(*10)

$next = function (RequestInterface $request, ResponseInterface $response) { // The security has been check. // Do some stuff with the web hook... return new \Zend\Diactoros\Response\JsonResponse(['status' => 'ok']); };, _(*11)

$server = \Zend\Diactoros\Server::createServerFromRequest($middleware, $request);, _(*12)

$server->listen($next);, _(*13)


### Ex: PSR-15 middleware using Zend Stratigility

````php
<?php

use Psr\Http\Message\RequestInterface;
use Psr\Http\Message\ResponseInterface;

use Zend\Stratigility\MiddlewarePipe;
use Zend\Stratigility\NoopFinalHandler;

use Zend\Diactoros\Server;
use Zend\Diactoros\Response\JsonResponse;

use Swop\GitHubWebHook\Security\SignatureValidator;
use Swop\GitHubWebHookMiddleware\GithubWebHook;

$app = (new MiddlewarePipe())
    ->pipe(new GithubWebHook(new SignatureValidator(), 'my_secret'))
    ->pipe('/', function (RequestInterface $request, ResponseInterface $response) {
        // The security has been check.
        // Do some stuff with the web hook...
        return new JsonResponse(['status' => 'OK']);
    });

$request = \Zend\Diactoros\ServerRequestFactory::fromGlobals();

Server::createServerFromRequest($app, $request)
    ->listen(new NoopFinalHandler())
;