2017 © Pedro Peláez
 

library caparica

secure your REST api with signed requests

image

francodacosta/caparica

secure your REST api with signed requests

  • Saturday, October 4, 2014
  • by francodacosta
  • Repository
  • 1 Watchers
  • 3 Stars
  • 7,274 Installations
  • PHP
  • 2 Dependents
  • 0 Suggesters
  • 1 Forks
  • 1 Open issues
  • 10 Versions
  • 6 % Grown

The README.md

Caparica Build Status Total Downloads Latest Stable Version

Php library to validate and create signed requests, (*1)

this is a low level library, you might want to check * Caparica Bundle a symfony2 bundle * Caparica Guzzle a Guzzle plugin to automatically sign requests for you, (*2)

Installation

composer.phar require francodacosta/caparica

Documentation

Please be sure to read the documentation, make sure you understand the client and server parts of Caparica., (*3)

The latest documentation can be found on the docs folder, (*4)

Sign a request (client side) 

use Caparica\Crypto\RequestSigner;

$signer = new RequestSigner();
$password = "12345678901234567890";
$params = array (
    'a' => 'bcd',
    'c' => '123',
    'b' => 'ewq',
    'X-CAPARICA-TIMESTAMP' => date('U')
);

$signature = $signer->sign($params, $password);

Validate a request (server side) 

use Caparica\Security\RequestValidator;
use Caparica\Client\BasicClient;

$client = new BasicClient;

$requestValidator = new RequestValidator(new RequestSigner);

// this values come from the request the client made
// use whatever methods your framework has to access http requests
$requestParams = array(
   'X-CAPARICA-DATE' => "12345676743",
    'a'               => 'bcd',
    'c'               => '123',
    'b'               => 'ewq',
);

// the signature comes from the request, we will use it to compare with the server
// generated one, if they match we know the request is valid
$requestSignature = '0c6513e432bb25d8be659a99ca240a64f60dee875e04d557341a677bfe08a1bf';


$isValid = $requestValidator->validate($client, $requestSignature, $requestParams);

The Versions

04/10 2014

dev-master

9999999-dev https://github.com/francodacosta/caparica

secure your REST api with signed requests

  Sources   Download

MIT

The Requires

  • php >=5.3.0

 

The Development Requires

by Nuno Costa

api rest hmac secure

04/10 2014

1.0

1.0.0.0 https://github.com/francodacosta/caparica

secure your REST api with signed requests

  Sources   Download

MIT

The Requires

  • php >=5.3.0

 

The Development Requires

by Nuno Costa

api rest hmac secure

18/09 2014

0.0.8

0.0.8.0 https://github.com/francodacosta/caparica

secure your REST api with signed requests

  Sources   Download

MIT

The Requires

 

The Development Requires

by Nuno Costa

api rest hmac secure

20/12 2013

0.0.7

0.0.7.0

secure your REST api with signed requests

  Sources   Download

MIT

The Requires

 

The Development Requires

by Nuno Costa

api rest hmac secure

16/12 2013

0.0.6p1

0.0.6.0-patch1

secure your REST api with signed requests

  Sources   Download

MIT

The Requires

 

The Development Requires

by Nuno Costa

api rest hmac secure

16/12 2013

0.0.6

0.0.6.0

secure your REST api with signed requests

  Sources   Download

MIT

The Requires

 

The Development Requires

by Nuno Costa

api rest hmac secure

16/12 2013

0.0.5

0.0.5.0

secure your REST api with signed requests

  Sources   Download

MIT

The Requires

 

by Nuno Costa

api rest hmac secure

16/12 2013

0.0.4

0.0.4.0

secure your REST api with signed requests

  Sources   Download

MIT

The Requires

 

by Nuno Costa

api rest hmac secure

12/12 2013

0.0.2

0.0.2.0

secure your REST api with signed requests

  Sources   Download

MIT

The Requires

 

by Nuno Costa

api rest hmac secure

12/12 2013

0.0.1

0.0.1.0

secure your REST api with signed requests

  Sources   Download

MIT

The Requires

 

by Nuno Costa

api rest hmac secure