-
Notifications
You must be signed in to change notification settings - Fork 0
/
Policy.php
247 lines (212 loc) · 6.97 KB
/
Policy.php
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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
<?php
namespace EvesAddiction\Filestack;
class Policy {
const ALLOWED_KEYS = [
'call', 'container', 'expiry', 'handle',
'maxSize', 'minSize', 'path', 'url'
];
const VALID_CALLS = [
'convert', 'exif', 'pick', 'read', 'remove',
'stat', 'store', 'write', 'writeUrl',
];
protected $call;
protected $container;
protected $expiry;
protected $handle;
protected $maxSize;
protected $minSize;
protected $path;
protected $url;
protected $_policy;
protected $_base64;
protected $_secret;
protected $_signature;
/**
* Represents a filepicker Policy for access and request signing
*
* @param array $policyData
*/
public function __construct(array $policyData) {
foreach ($policyData as $option => $value) {
if ($option == 'expiry') {
$value = static::makeDateTimeImmutable($value);
}
$validOption = static::validateOption($option, $value, $exception);
if ($validOption === true) {
$this->{$option} = $value;
} elseif ($exception instanceof PolicyException) {
throw $exception;
} else {
throw new \RuntimeException('Unknown validation error');
}
}
$this->_policy = $policyData;
}
/**
* Get the base64-ed policy string (used in signing)
*
* @return string The base64 representation of the policy
*/
public function getBase64() {
if (!isset($this->_base64)) {
$this->_base64 = static::makeBase64(json_encode($this->_policy));
}
return $this->_base64;
}
/**
* Generate/get the HMAC signature for use in signed Filepicker requests
*
* @return string The signature
*/
public function getSignature($secret) {
$this->_secret = $secret;
if (!isset($this->_signature)) {
$this->_signature = static::makeSignature($this->getBase64(), $this->_secret);
}
return $this->_signature;
}
public function getExpiry() {
return $this->expiry;
}
/**
* Get the \DateInterval from $now when the Policy expires
*
* @param \DateTimeInterface $now Optional datetime to compare against. Defaults to current date and time (using new \DateTimeImmutable())
*
* @return \DateInterval The interval from $now when the policy will expire
*/
public function getExpiryInterval(\DateTimeInterface $now = null) {
if (is_null($now)) {
$now = new \DateTimeImmutable();
}
return $now->diff($this->expiry);
}
/**
* Whether the Policy is expired as of $now
*
* @param \DateTimeInterface $now Datetime to compare against
* @return boolean Is it expired $now?
*/
public function isExpired(\DateTimeInterface $now = null) {
if (is_null($now)) {
$now = new \DateTimeImmutable();
}
return $now >= $this->expiry;
}
/**
* Create a new Policy from this one with expiry of $time_or_interval
*
* @param \DateTimeInterface|\DateInterval $time_or_interval Datetime (or DateInterval from $now) at which the new policy will expire
* @param \DateTimeInterface $now Optional base time for computing expiry if $time_or_interval is an interval. Defaults to now
*
* @return EvesAddiction\Filestack\Policy The new Policy
*/
public function renew($time_or_interval, $now = null) {
if (is_null($now)) {
$now = new DateTimeImmutable();
}
if ($time_or_interval instanceof \DateTimeInterface) {
$expiry = $time_or_interval;
} elseif ($time_or_interval instanceof \DateInterval) {
$expiry = $now->add($time_or_interval);
} else {
throw new \InvalidArgumentException('Need some sort of date-y, time-y object');
}
if (!isset($this->_secret)) {
throw new PolicyException("This policy hasn't been signed yet, so it can't be renewed!");
}
return new Policy($this->call, $expiry, $this->_path, $this->_secret);
}
public function signUrl($url) {}
// Static Methods
/**
* Make the base64 digest for a Policy or an array representing $policy->_policy
*
* @param Policy|array $policy ¯\_(ツ)_/¯
*
* @return string The base64 digest of the policy, for use in signing
*/
public static function makeBase64($policy) {
if ($policy instanceof Policy) {
$policy = $policy->_policy;
}
return str_replace(array('+', '/'), array('-', '_'), base64_encode($policy));
}
/**
* Sign a policy
*
* @param Policy|array $policy
* @param string|null $secret
*
* @return void
*/
public static function makeSignature($policy, $secret) {
if ($policy instanceof Policy) {
$base64 = $policy->getBase64();
} elseif (is_array($policy)) {
$base64 = static::makeBase64($policy);
} else {
$base64 = $policy;
}
return hash_hmac('sha256', $base64, $secret);
}
public static function validateOption($option, $value, &$exception = null) {
$exception = null; // in case a non-null value gets passed in
if (!in_array($option, static::ALLOWED_KEYS)) {
$exception = new PolicyException(sprintf('Invalid security policy option: "%s" is not one of %s', $option, implode(', ', static::ALLOWED_KEYS)));
return false;
}
switch ($option) {
case 'call':
if (!is_array($value)) {
$exception = new PolicyException('Invalid security policy allowed calls: "call" option must be an array');
} else {
$invalid_calls = array_diff((array) $value, static::VALID_CALLS);
if (count($invalid_calls)) {
$exception = new PolicyException(sprintf('Invalid security policy allowed calls: %s', implode(', ', $invalid_calls)));
}
}
break;
case 'expiry':
if ($value instanceof \DateTimeInterface) {} else {
$exception = new PolicyException('Invalid security policy expiry: must be \DateTimeInterface or date_parse()-able string');
}
break;
}
return is_null($exception) ? true : false;
}
/**
* Tries to create a \DateTimeImmutable from a given input
*
* @param mixed $maybeDate Something that might be a date
*
* @throws PolicyException
*
* @return \DateTimeImmutable
*/
public static function makeDateTimeImmutable($maybeDate) {
switch (true) {
case $maybeDate instanceof \DateTimeImmutable:
$result = $maybeDate;
break;
case $maybeDate instanceof \DateTime:
$result = \DateTimeImmutable::createFromMutable($maybeDate);
break;
case is_numeric($maybeDate) && $maybeDate >= 0:
$result = new \DateTimeImmutable(sprintf('@%d', $maybeDate));
break;
default:
try {
$result = new \DateTimeImmutable($maybeDate);
} catch (\Exception $e) {
// The DateTime and DateTimeImmutable unhelpfully throw generic \Exception-s
throw new PolicyException($e->getMessage(), $e->getCode(), $e);
}
break;
}
if (!isset($result)) {
throw new PolicyException("Unknown issue parsing datetime");
}
return $result;
}
}