Download the PHP package ampersa/json-signer without Composer
On this page you can find all versions of the php package ampersa/json-signer. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download ampersa/json-signer
More information about ampersa/json-signer
Files in ampersa/json-signer
Package json-signer
Short Description Validate JSON strings with a signed hash
License MIT
Informations about the package json-signer
JSON Signer and Validator
Signs JSON strings with a signed hash and validates signed strings.
Version 1.3
Installation
Installation is via composer:
Usage
To sign a JSON string, pass the signing key to the new Signer and call sign() passing the JSON string:
Alternatively, to return the signature and leave the JSON string intact, call signature() with the JSON string:
To validate a signed JSON string, call verify() passing the signed JSON string:
Validating a signature separately is as simple as passing the signature as the second argument to verify():
Signers
2 Signer classes are included:
- AppendSigner
- PackageSigner
The Signer defaults to AppendSigner, appending the signature key to the JSON object.
PackageSigner packages the original JSON object and signature key into a new parent object, i.e:
Be sure to use the correct Signer class for both signing and verifying
Signer classes may also be accessed directly:
Config
Signature Key
Set the key used to hold to signature in the signed string. This can be used to avoid collisions with existing keys.
If sign() is called on a string which already contains the signature key, an Exception will be thrown
Hash Algorithm
The signer defaults to using SHA256 as the signing algorithm. This can be changed, either via the second construct argument, or via setAlgorithm():
Package Key
When utilising the PackageSigner class, you may set the key used to hold to original JSON package in the signed string: