brandembassy/hmac-request-signature

This package's canonical repository appears to be gone and the package has been frozen as a result. Email us for help if needed.

2.0 2023-09-07 21:16 UTC

Requires

• guzzlehttp/guzzle: ^7.5

Requires (Dev)

• brandembassy/coding-standard: ^10.0
• phpunit/phpunit: ^9.6
• roave/security-advisories: dev-latest

proprietary

README

This small library will allow you to sign http reuqests for future verification. This is typically used as optional security in webhook consuming apps

Installation

composer require brandembassy/hmac-request-signature

Usage

Signed requests contains HTTP headers X-Request-Signature: Signature itself (base64) X-Signature-Algorithm: Algorithm used to calc signature (default: sha256)

How to sign your requests

You need to use RequestSignerMiddleware in guzzle client handlers stack, you can use SignedRequestsClientFactory::create('{{yourSecretKey}}'). This middleware will calc signature from request payload and secret key and provide it in request header X-Request-Signature.

How to validate request signature

Just use SignedRequestValidator::validateSignature where exception is thrown in case signature validation failed