ServerGuard.php
10.5 KB
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
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
<?php
/*
* This file is part of the overtrue/wechat.
*
* (c) overtrue <i@overtrue.me>
*
* This source file is subject to the MIT license that is bundled
* with this source code in the file LICENSE.
*/
namespace EasyWeChat\Kernel;
use EasyWeChat\Kernel\Contracts\MessageInterface;
use EasyWeChat\Kernel\Exceptions\BadRequestException;
use EasyWeChat\Kernel\Exceptions\InvalidArgumentException;
use EasyWeChat\Kernel\Messages\Message;
use EasyWeChat\Kernel\Messages\News;
use EasyWeChat\Kernel\Messages\NewsItem;
use EasyWeChat\Kernel\Messages\Raw as RawMessage;
use EasyWeChat\Kernel\Messages\Text;
use EasyWeChat\Kernel\Support\XML;
use EasyWeChat\Kernel\Traits\Observable;
use EasyWeChat\Kernel\Traits\ResponseCastable;
use Symfony\Component\HttpFoundation\Response;
/**
* Class ServerGuard.
*
* 1. url 里的 signature 只是将 token+nonce+timestamp 得到的签名,只是用于验证当前请求的,在公众号环境下一直有
* 2. 企业号消息发送时是没有的,因为固定为完全模式,所以 url 里不会存在 signature, 只有 msg_signature 用于解密消息的
*
* @author overtrue <i@overtrue.me>
*/
class ServerGuard
{
use Observable;
use ResponseCastable;
/**
* @var bool
*/
protected $alwaysValidate = false;
/**
* Empty string.
*/
const SUCCESS_EMPTY_RESPONSE = 'success';
/**
* @var array
*/
const MESSAGE_TYPE_MAPPING = [
'text' => Message::TEXT,
'image' => Message::IMAGE,
'voice' => Message::VOICE,
'video' => Message::VIDEO,
'shortvideo' => Message::SHORT_VIDEO,
'location' => Message::LOCATION,
'link' => Message::LINK,
'device_event' => Message::DEVICE_EVENT,
'device_text' => Message::DEVICE_TEXT,
'event' => Message::EVENT,
'file' => Message::FILE,
'miniprogrampage' => Message::MINIPROGRAM_PAGE,
];
/**
* @var \EasyWeChat\Kernel\ServiceContainer
*/
protected $app;
/**
* Constructor.
*
* @codeCoverageIgnore
*
* @param \EasyWeChat\Kernel\ServiceContainer $app
*/
public function __construct(ServiceContainer $app)
{
$this->app = $app;
foreach ($this->app->extension->observers() as $observer) {
call_user_func_array([$this, 'push'], $observer);
}
}
/**
* Handle and return response.
*
* @return Response
*
* @throws BadRequestException
* @throws \EasyWeChat\Kernel\Exceptions\InvalidArgumentException
* @throws \EasyWeChat\Kernel\Exceptions\InvalidConfigException
*/
public function serve(): Response
{
$this->app['logger']->debug('Request received:', [
'method' => $this->app['request']->getMethod(),
'uri' => $this->app['request']->getUri(),
'content-type' => $this->app['request']->getContentType(),
'content' => $this->app['request']->getContent(),
]);
$response = $this->validate()->resolve();
$this->app['logger']->debug('Server response created:', ['content' => $response->getContent()]);
return $response;
}
/**
* @return $this
*
* @throws \EasyWeChat\Kernel\Exceptions\BadRequestException
*/
public function validate()
{
if (!$this->alwaysValidate && !$this->isSafeMode()) {
return $this;
}
if ($this->app['request']->get('signature') !== $this->signature([
$this->getToken(),
$this->app['request']->get('timestamp'),
$this->app['request']->get('nonce'),
])) {
throw new BadRequestException('Invalid request signature.', 400);
}
return $this;
}
/**
* Force validate request.
*
* @return $this
*/
public function forceValidate()
{
$this->alwaysValidate = true;
return $this;
}
/**
* Get request message.
*
* @return array|\EasyWeChat\Kernel\Support\Collection|object|string
*
* @throws BadRequestException
* @throws \EasyWeChat\Kernel\Exceptions\InvalidArgumentException
* @throws \EasyWeChat\Kernel\Exceptions\InvalidConfigException
*/
public function getMessage()
{
$message = $this->parseMessage($this->app['request']->getContent(false));
if (!is_array($message) || empty($message)) {
throw new BadRequestException('No message received.');
}
if ($this->isSafeMode() && !empty($message['Encrypt'])) {
$message = $this->decryptMessage($message);
// Handle JSON format.
$dataSet = json_decode($message, true);
if ($dataSet && (JSON_ERROR_NONE === json_last_error())) {
return $dataSet;
}
$message = XML::parse($message);
}
return $this->detectAndCastResponseToType($message, $this->app->config->get('response_type'));
}
/**
* Resolve server request and return the response.
*
* @return \Symfony\Component\HttpFoundation\Response
*
* @throws \EasyWeChat\Kernel\Exceptions\BadRequestException
* @throws \EasyWeChat\Kernel\Exceptions\InvalidArgumentException
* @throws \EasyWeChat\Kernel\Exceptions\InvalidConfigException
*/
protected function resolve(): Response
{
$result = $this->handleRequest();
if ($this->shouldReturnRawResponse()) {
$response = new Response($result['response']);
} else {
$response = new Response(
$this->buildResponse($result['to'], $result['from'], $result['response']),
200,
['Content-Type' => 'application/xml']
);
}
$this->app->events->dispatch(new Events\ServerGuardResponseCreated($response));
return $response;
}
/**
* @return string|null
*/
protected function getToken()
{
return $this->app['config']['token'];
}
/**
* @param string $to
* @param string $from
* @param \EasyWeChat\Kernel\Contracts\MessageInterface|string|int $message
*
* @return string
*
* @throws \EasyWeChat\Kernel\Exceptions\InvalidArgumentException
*/
public function buildResponse(string $to, string $from, $message)
{
if (empty($message) || self::SUCCESS_EMPTY_RESPONSE === $message) {
return self::SUCCESS_EMPTY_RESPONSE;
}
if ($message instanceof RawMessage) {
return $message->get('content', self::SUCCESS_EMPTY_RESPONSE);
}
if (is_string($message) || is_numeric($message)) {
$message = new Text((string) $message);
}
if (is_array($message) && reset($message) instanceof NewsItem) {
$message = new News($message);
}
if (!($message instanceof Message)) {
throw new InvalidArgumentException(sprintf('Invalid Messages type "%s".', gettype($message)));
}
return $this->buildReply($to, $from, $message);
}
/**
* Handle request.
*
* @return array
*
* @throws \EasyWeChat\Kernel\Exceptions\BadRequestException
* @throws \EasyWeChat\Kernel\Exceptions\InvalidArgumentException
* @throws \EasyWeChat\Kernel\Exceptions\InvalidConfigException
*/
protected function handleRequest(): array
{
$castedMessage = $this->getMessage();
$messageArray = $this->detectAndCastResponseToType($castedMessage, 'array');
$response = $this->dispatch(self::MESSAGE_TYPE_MAPPING[$messageArray['MsgType'] ?? $messageArray['msg_type'] ?? 'text'], $castedMessage);
return [
'to' => $messageArray['FromUserName'] ?? '',
'from' => $messageArray['ToUserName'] ?? '',
'response' => $response,
];
}
/**
* Build reply XML.
*
* @param string $to
* @param string $from
* @param \EasyWeChat\Kernel\Contracts\MessageInterface $message
*
* @return string
*/
protected function buildReply(string $to, string $from, MessageInterface $message): string
{
$prepends = [
'ToUserName' => $to,
'FromUserName' => $from,
'CreateTime' => time(),
'MsgType' => $message->getType(),
];
$response = $message->transformToXml($prepends);
if ($this->isSafeMode()) {
$this->app['logger']->debug('Messages safe mode is enabled.');
$response = $this->app['encryptor']->encrypt($response);
}
return $response;
}
/**
* @param array $params
*
* @return string
*/
protected function signature(array $params)
{
sort($params, SORT_STRING);
return sha1(implode($params));
}
/**
* Parse message array from raw php input.
*
* @param string $content
*
* @return array
*
* @throws \EasyWeChat\Kernel\Exceptions\BadRequestException
*/
protected function parseMessage($content)
{
try {
if (0 === stripos($content, '<')) {
$content = XML::parse($content);
} else {
// Handle JSON format.
$dataSet = json_decode($content, true);
if ($dataSet && (JSON_ERROR_NONE === json_last_error())) {
$content = $dataSet;
}
}
return (array) $content;
} catch (\Exception $e) {
throw new BadRequestException(sprintf('Invalid message content:(%s) %s', $e->getCode(), $e->getMessage()), $e->getCode());
}
}
/**
* Check the request message safe mode.
*
* @return bool
*/
protected function isSafeMode(): bool
{
return $this->app['request']->get('signature') && 'aes' === $this->app['request']->get('encrypt_type');
}
/**
* @return bool
*/
protected function shouldReturnRawResponse(): bool
{
return false;
}
/**
* @param array $message
*
* @return mixed
*/
protected function decryptMessage(array $message)
{
return $message = $this->app['encryptor']->decrypt(
$message['Encrypt'],
$this->app['request']->get('msg_signature'),
$this->app['request']->get('nonce'),
$this->app['request']->get('timestamp')
);
}
}