|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
namespace UMA\Psr\Http\Message\HMAC; |
|
4
|
|
|
|
|
5
|
|
|
final class Specification |
|
6
|
|
|
{ |
|
7
|
|
|
/** |
|
8
|
|
|
* Name of the HTTP header that will hold the authentication |
|
9
|
|
|
* credentials (i.e. the HMAC signature). Must conform to RFC7235. |
|
10
|
|
|
* |
|
11
|
|
|
* @see http://tools.ietf.org/html/rfc7235#section-4.2 |
|
12
|
|
|
*/ |
|
13
|
|
|
const AUTH_HEADER = 'Authorization'; |
|
14
|
|
|
|
|
15
|
|
|
/** |
|
16
|
|
|
* Authentication credentials prefix. Its purpose is telling the |
|
17
|
|
|
* message receiver which kind of data the authentication header is holding. |
|
18
|
|
|
* |
|
19
|
|
|
* @example Authorization: HMAC-SHA256 y0SLRAxCrIrQhPyKh5XJj1t4AjWcMF6r1X7Nsg4kiJY= |
|
20
|
|
|
*/ |
|
21
|
|
|
const AUTH_PREFIX = 'HMAC-SHA256'; |
|
22
|
|
|
|
|
23
|
|
|
/** |
|
24
|
|
|
* Hash algorithm used in conjunction with the HMAC function. |
|
25
|
|
|
*/ |
|
26
|
|
|
const HASH_ALGORITHM = 'sha256'; |
|
27
|
|
|
|
|
28
|
|
|
/** |
|
29
|
|
|
* Name of the HTTP header that holds the list of signed headers. |
|
30
|
|
|
* |
|
31
|
|
|
* When verifying the authenticity on an HTTP message, any header |
|
32
|
|
|
* not included in that list must be stripped from the message |
|
33
|
|
|
* before attempting to serialize it. |
|
34
|
|
|
* |
|
35
|
|
|
* An HTTP message without the Signed-Headers header cannot |
|
36
|
|
|
* pass the HMAC verification. |
|
37
|
|
|
* |
|
38
|
|
|
* An HTTP message with a Signed-Headers header that is not covered |
|
39
|
|
|
* by the HMAC signature will neither pass the HMAC verification. |
|
40
|
|
|
* |
|
41
|
|
|
* The list itself consists of an alphanumerically sorted sequence of header names |
|
42
|
|
|
* concatenated by commas. A valid Signed-Headers header must include its own |
|
43
|
|
|
* header name, so at the very least it will be the only header in the list. |
|
44
|
|
|
* |
|
45
|
|
|
* As per RFC 7230 Section 3.2 commas are not legal characters in a header name, |
|
46
|
|
|
* hence there cannot be any ambiguity when parsing the header value. |
|
47
|
|
|
* |
|
48
|
|
|
* @example Signed-Headers: Api-Key,Content-Type,Host,Signed-Headers |
|
49
|
|
|
* @example Signed-Headers: Signed-Headers |
|
50
|
|
|
*/ |
|
51
|
|
|
const SIGN_HEADER = 'Signed-Headers'; |
|
52
|
|
|
} |
|
53
|
|
|
|