1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
|
<?php
declare(strict_types=1);
/*
* The MIT License (MIT)
*
* Copyright (c) 2014-2018 Spomky-Labs
*
* This software may be modified and distributed under the terms
* of the MIT license. See the LICENSE file for details.
*/
namespace Jose\Component\Signature;
class Signature
{
/**
* @var string|null
*/
private $encodedProtectedHeader;
/**
* @var array
*/
private $protectedHeader;
/**
* @var array
*/
private $header;
/**
* @var string
*/
private $signature;
/**
* Signature constructor.
*/
private function __construct(string $signature, array $protectedHeader, ?string $encodedProtectedHeader, array $header)
{
$this->protectedHeader = null === $encodedProtectedHeader ? [] : $protectedHeader;
$this->encodedProtectedHeader = $encodedProtectedHeader;
$this->signature = $signature;
$this->header = $header;
}
/**
* Creates a new signature.
*
* @internal
*
* @return Signature
*/
public static function create(string $signature, array $protectedHeader, ?string $encodedProtectedHeader, array $header = []): self
{
return new self($signature, $protectedHeader, $encodedProtectedHeader, $header);
}
/**
* The protected header associated with the signature.
*/
public function getProtectedHeader(): array
{
return $this->protectedHeader;
}
/**
* The unprotected header associated with the signature.
*/
public function getHeader(): array
{
return $this->header;
}
/**
* The protected header associated with the signature.
*/
public function getEncodedProtectedHeader(): ?string
{
return $this->encodedProtectedHeader;
}
/**
* Returns the value of the protected header of the specified key.
*
* @param string $key The key
*
* @return mixed|null Header value
*/
public function getProtectedHeaderParameter(string $key)
{
if ($this->hasProtectedHeaderParameter($key)) {
return $this->getProtectedHeader()[$key];
}
throw new \InvalidArgumentException(\sprintf('The protected header "%s" does not exist', $key));
}
/**
* Returns true if the protected header has the given parameter.
*
* @param string $key The key
*/
public function hasProtectedHeaderParameter(string $key): bool
{
return \array_key_exists($key, $this->getProtectedHeader());
}
/**
* Returns the value of the unprotected header of the specified key.
*
* @param string $key The key
*
* @return mixed|null Header value
*/
public function getHeaderParameter(string $key)
{
if ($this->hasHeaderParameter($key)) {
return $this->header[$key];
}
throw new \InvalidArgumentException(\sprintf('The header "%s" does not exist', $key));
}
/**
* Returns true if the unprotected header has the given parameter.
*
* @param string $key The key
*/
public function hasHeaderParameter(string $key): bool
{
return \array_key_exists($key, $this->header);
}
/**
* Returns the value of the signature.
*/
public function getSignature(): string
{
return $this->signature;
}
}
|
