Download the PHP package antavo/escher-php without Composer
On this page you can find all versions of the php package antavo/escher-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package escher-php
EscherPHP - HTTP request signing lib
Escher helps you creating secure HTTP requests (for APIs) by signing HTTP(s) requests. It's both a server side and client side implementation. The status is work in progress.
The algorithm is based on Amazon's AWS Signature Version 4, but we have generalized and extended it.
More details will be available at our documentation site.
Signing a request
Escher works by calculating a cryptographic signature of your request, and adding it (and other authentication information) to said request. Usually you will want to add the authentication information to the request by appending extra headers to it. Let's say you want to send a signed POST request to http://example.com/ using the Guzzle\Http library:
Presigning an URL
In some cases you may want to send authenticated requests from a context where you cannot modify the request headers, e.g. when embedding an API generated iframe. You can however generate a presigned URL, where the authentication information is added to the query string.
Validating a request
You can validate a request signed by the methods described above. For that you will need a database of the access keys and secrets of your clients. Escher accepts any kind of object as a key database that implements the ArrayAccess interface. (It also accepts plain arrays, however it is not recommended to use a php array for a database of API secrets - it's just there to ease testing)
Exceptions
Code pattern | Exception type |
---|---|
1xxx | Missing exceptions |
2xxx | Invalid format exceptions |
3xxx | Argument invalid exceptions |
4xxx | Not signed exceptions |
5xxx | Expired exception |
6xxx | Signature exceptions |
Code | Message |
---|---|
1001 | Escher authentication is missing |
1100 | The {PARAM} header is missing |
1101 | Query key: {PARAM} is missing |
1102 | The host header is missing |
2001 | Date header is invalid, the expected format is Wed, 04 Nov 2015 09:20:22 GMT |
2002 | Auth header format is invalid |
2003 | Invalid {PARAM} query key format |
2004 | Date header is invalid, the expected format is 20151104T092022Z |
3001 | Invalid Escher key |
3002 | Hash algorithm is invalid. Only SHA256 and SHA512 are allowed |
3003 | Credential scope is invalid |
3004 | Date in the authorization header is invalid. It must be the same as the date header |
4001 | The host header is not signed |
4002 | The {PARAM} header is not signed |
5001 | The request date is not within the accepted time range |
6001 | The signatures do not match |
Configuration
TBA