liyu/signature

Laravel signature

Use HMAC or RSA to sign data for Laravel and lumen;, _(*1)

, _(*2)

Install

For Laravel < 5.5, please use the tag 0.2.10, _(*3)

laravel

composer require liyu/signature, _(*4)

lumen

• bootstrap/app.php, _(*5)

  $app->register(Liyu\Signature\Facade\Signature::class);

config

• you can use these in your ENV, _(*6)

  // default driver
  SIGNATURE_DRIVER
  
  // hmac algo and key
  SIGNATURE_HMAC_ALGO (default sha256)
  SIGNATURE_HMAC_KEY (default null)
  
  // rsa algo, public_key, private_key
  SIGNATURE_RSA_ALGO (default sha256)
  SIGNATURE_RSA_PUBLIC_KEY
  SIGNATURE_RSA_PRIVATE_KEY

• if you want to use config, _(*7)

  laravel
  php artisan vendor:publish
  
  lumen
  copy vendor/liyu/signature/src/config/config.php config/signature.php

Usage

sign, _(*8)

$signature = Signature::sign('foobar');

$signature = Signature::setKey('foobar')->sign(['foo'=>'bar']);

$signature = Signature::signer('hmac')
    ->setAlgo('sha256')
    ->setKey('foobar')
    ->sign(['foo'=>'bar']);

$signature = Signature::signer('rsa')
    ->setPrivateKey('./private.pem')
    ->sign(['foo'=>'bar']);

verify, _(*9)

// true or false

Signature::verify($signature, 'foobar');

Signature::setKey('foobar')->verify($signature, ['foo'=>'bar']);

Signature::signer('hmac')
    ->setAlgo('sha256')
    ->setKey('foobar')
    ->verify($sign, ['foo'=>'bar']);

Signature::signer('rsa')
    ->setPublicKey('./public.pem')
    ->verify($signature, ['foo'=>'bar']);

Sign Steps

• convert array data, _(*10)

  // origin
  $data = [
      'z' => 1,
      'a' => [
          'c' => 'c',
          'b' => 'b',
          'a' => [
              'b' => 'b',
              'a' => 'a'
          ]
      ],
  ];
  
  // ksort and convert to string
  $data = [
      'a' => [
          'a' => [
              'a' => 'a'
              'b' => 'b',
          ]
          'b' => 'b',
          'c' => 'c',
      ],
      'z' => '1',
  ];
  
  // json_encode
  {"a":{"a":{"a":"a","b":"b"},"b":"b","c":"c"},"z":"1"}

• sign string。, _(*11)

  hmac  => hmac($algo, $convertData, $key);
  // outputs lowercase hexits
  
  rsa => base64_encode(openssl_sign_string);

License

MIT LICENSE, _(*12)