Версія 19.4 додана 2024/05/16 11:20 автором Ashterix
Показати останніх авторів
1 {{box cssClass="floatinginfobox" title="**Зміст**"}}
2 {{toc/}}
3 {{/box}}
4
5 (% class="wikigeneratedid" %)
6 Всі налаштування бандла знаходяться в файлі {{code language="none"}}config/packages/ufo_json_rpc.yaml{{/code}}.
7
8 (% class="wikigeneratedid" %)
9 Є можливість налаштувати параметри захисту API та деякі параметри формату даних, що віддається при запиті документації.
10
11 = Блок {{code language="none"}}security{{/code}} =
12
13 Наразі єдиним механізмом захисту доступу до вашого API є встановлення перевірки ключа доступу (api_token).
14
15 == Параметр {{code language="none"}}protected_methods{{/code}} ==
16
17 (% class="wikigeneratedid" %)
18 Цей параметр приймає масив назв http методів, які мають бути захищені.
19
20 (% class="wikigeneratedid" %)
21 За замовченням ввімкнут захист лише для методу POST. Ви можете:
22
23 * вказати пустий масив {{code language="none"}}[]{{/code}} щоб зробити API повністю відкритим
24
25 {{code language="yaml" layout="LINENUMBERS" title="config/packages/ufo_json_rpc.yaml"}}
26 ufo_json_rpc:
27 security:
28 protected_methods: []
29 {{/code}}
30
31 * вказати додатково захист для методу GET, що зробить запит документації недоступним без токену в заголовках запиту
32
33 {{code language="yaml" layout="LINENUMBERS" title="config/packages/ufo_json_rpc.yaml"}}
34 ufo_json_rpc:
35 security:
36 protected_methods: ['GET', 'POST']
37 {{/code}}
38
39 (% id="cke_bm_164641S" style="display:none" %) (%%)Якщо ви захищаєте ваш API через {{code language="none"}}protected_methods{{/code}}, вам необхідно налаштувати токени, по яким буде відкритий доступ.
40
41 Перш за все, треба визначитися з назвою токену.
42
43 == Параметр {{code language="none"}}token_key_in_header{{/code}} ==
44
45 Компонент {{code language="none"}}RpcSecurity{{/code}} буде шукати в заголовках запиту специфічний ключ, який ви можете встановити в налаштуваннях пакету, значення за замовченням {{code language="none"}}token_key_in_header: 'Ufo-RPC-Token'{{/code}}, ви можете встановити будь-яке інше значення яке відповідає наступним вимогам.
46
47 {{spoiler title=" Вимоги до формування заголовків протоколу HTTP"}}
48 Вимоги до назв заголовків HTTP не є строго регульованими щодо капіталізації, оскільки HTTP заголовки нечутливі до регістру. Однак, існують деякі загальні практики і стандарти, які зазвичай дотримуються для кращої читабельності та узгодженості:
49
50 - Капіталізація: Зазвичай назви HTTP заголовків пишуться з використанням CamelCase, де кожне слово починається з великої літери, наприклад, Content-Type, User-Agent, Accept-Encoding. Це не впливає на технічну обробку заголовків, але робить їх легше читати.
51 - Унікальність: Кожен заголовок повинен мати унікальну назву у контексті одного HTTP запиту або відповіді. Не можна використовувати однакові назви для різних заголовків у тому самому запиті чи відповіді.
52 - Спеціальні заголовки: Існують заголовки, які використовуються специфічно для контролю поведінки кешування (Cache-Control), безпеки (Strict-Transport-Security), аутентифікації (Authorization), тощо.
53 - Норми RFC: Вимоги до заголовків регулюються документами RFC, які визначають стандарти для протоколів Інтернету. Наприклад, загальні заголовки і їхнє використання описані в RFC 7231.
54 {{/spoiler}}
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69 == Параметр {{code language="none"}}clients_tokens{{/code}} ==
70
71 Тепер слід вказати масив клієнтськіх токенів, які будуть мати доступ до API.
72
73 Тут є певна варіативність.
74
75 === Токени в параметрах ===
76
77 (% class="box errormessage" %)
78 (((
79 **НЕ РЕКОМЕНДОВАНО!!!**
80 \\Цей підхід допускається лише для локального тестування API
81 )))
82
83 Є можливість прописати токени хардкодом прямо в файлі налаштувань.
84
85 Це погано з позиції безпеки, якщо код зберігається в публічному репозиторію, то до цього токену буде мати доступ кожен.
86
87 {{code language="yaml" layout="LINENUMBERS" title="config/packages/ufo_json_rpc.yaml"}}
88 ufo_json_rpc:
89 security:
90 protected_methods: ['GET', 'POST']
91 token_key_in_header: 'Ufo-RPC-Token'
92 clients_tokens:
93 - 'ClientTokenExample' # hardcoded token example. Importantly!!! Replace or delete it!
94
95 {{/code}}
96
97 === Токени в змінних оточення ===
98
99 Це найбільш доцільний механізм у разі, якщо ви розробляєте сервіс для розподіленого бекенду, що написаний на SOA (Сервіс-Орієнтована Архітектура). Зазвичай, в такому випадку, вам треба відкрити доступ до апі одному або обмеженій кількості клієнтських додатків і оновлення ключів не буде відбуватися занадто часто.
100
101 В такому випадку можна прописати токени в змінних оточення (файл {{code language="none"}}.env.local{{/code}} під час локальної розробки). Цей механізм достатньо безпечний з боку збереження доступів.
102
103 (((
104 {{code language="ini" layout="LINENUMBERS" title=".env.local"}}
105 TOKEN_FOR_APP_1=9363074966579432364f8b73b3318f71
106 TOKEN_FOR_APP_2=456fg87g8h98jmnb8675r4445n8up365
107 {{/code}}
108
109 {{code language="yaml" layout="LINENUMBERS" title="config/packages/ufo_json_rpc.yaml"}}
110 ufo_json_rpc:
111 security:
112 protected_methods: ['GET', 'POST']
113 token_key_in_header: 'Ufo-RPC-Token'
114 clients_tokens:
115 - '%env(resolve:TOKEN_FOR_APP_1)%' # token example from .env.local
116 - '%env(resolve:TOKEN_FOR_APP_2)%' # token example from .env.local
117 {{/code}}
118 )))
119
120 === Токени для користувача ===
121
122 Припускаю, що у вас може виникнути потреба зробити персональні ключі для користувачів вашого додатку, можливо ви захочете впровадити ліміти або інші обмеження.
123 В такому випадку вам не потрібно вказувати перелік токенів в конфігах, ви можете зберігати їх в базі даних або іншому місці згідно вашій бізнес-логіки. Єдина вимога, у вас має бути сервіс, який вміє перевіряти чи існує наданий токен.
124
125 Для того, щоб JsonRpcServer міг використовувати вашу логіку, доведеться реалізувати власний клас, що реалізує інтерфейс {{code language="none"}}Ufo\JsonRpcBundle\Security\Interfaces\ITokenValidator{{/code}}
126
127 {{code language="php" layout="LINENUMBERS" title="==== Приклад власного валідатора токенів ===="}}
128 <?php
129
130 namespace App\Services\RpcSecurity;
131
132 use App\Services\UserService;
133 use Symfony\Component\Security\Core\Exception\UserNotFoundException;
134 use Ufo\JsonRpcBundle\Security\Interfaces\ITokenValidator;
135 use Ufo\RpcError\RpcInvalidTokenException;
136
137 class UserTokenValidator implements ITokenValidator
138 {
139
140 public function __construct(protected UserService $userService) {}
141
142 public function isValid(string $token): true
143 {
144 try {
145 $this->userService->getUserByToken($token);
146 return true;
147 } catch (UserNotFoundException $e) {
148 throw new RpcInvalidTokenException(previous: $e);
149 }
150 }
151 }
152 {{/code}}
153
154 (% class="box warningmessage" %)
155 (((
156 **ВАЖЛИВО!!!**
157 Метод {{code language="none"}}isValid{{/code}} має повертати {{code language="none"}}true{{/code}} якщо токен існує і валідний, або викидати {{code language="none"}}Ufo\RpcError\RpcInvalidTokenException{{/code}} в іншому разі.
158 )))
159
160 Після цього вам потрібно в файлі {{code language="none"}}config/services.yaml{{/code}} прописати що класи, що мають залежність від інтерфейса {{code language="none"}}ITokenValidator{{/code}} мають приймати ваш новий клас.
161
162 {{code language="yaml" layout="LINENUMBERS" title="config/services.yaml"}}
163 parameters:
164 # some parameters list
165 # ...
166
167 services:
168 # some services list
169 # ...
170
171 Ufo\JsonRpcBundle\Security\Interfaces\ITokenValidator:
172 class: App\Services\RpcSecurity\UserTokenValidator
173 {{/code}}
174
175 = (% id="cke_bm_29916S" style="display:none" %) (%%)Блок {{code language="none"}}async{{/code}} =
176
177 Цей блок для налаштування [[асинхронного транспорту>>doc:.functionality.async.WebHome]].
178
179 Додайте параметр {{code language="none"}}rpc_async{{/code}} який містить рядок у форматі DSN. Цей рядок є конфігурацією [[Symfony Messenger>>https://symfony.com/doc/current/messenger.html]], він вказує на асинхронний транспорт по якому RPC Server буде очікувати вхідні запити якщо у вас запущений консюмер ({{code language="none"}}php bin/console messenger:consume rpc_async{{/code}}). Для більш детального розуміння цього процесу читайте документацію [[Symfony Messenge>>https://symfony.com/doc/current/messenger.html]].
180
181 {{code language="yaml" layout="LINENUMBERS" title="config/packages/ufo_json_rpc.yaml"}}
182 ufo_json_rpc:
183 async:
184 rpc_async: '%env(resolve:RPC_TRANSPORT_DSN)%'
185
186 {{/code}}
187
188 = Блок {{code language="none"}}docs{{/code}} =
189
190 Це блок який налаштовує генерацію документації коли ви робите GET запит на RPC Server
191
192 == Секція {{code language="none"}}response{{/code}} ==
193
194 Містить налаштування, що відповідають за вміст відповіді.
195
196 === Параметр {{code language="none"}}key_for_methods{{/code}} ===
197
198 Цей параметр дозволяє вказати назву ключа у відповіді в якій буде віддаватися масив доступних сервісів.
199
200 Значення за замовченням {{code language="none"}}methods{{/code}}. Може мати будь-яке значення типу рядок.
201
202 {{code language="yaml" layout="LINENUMBERS" title="config/packages/ufo_json_rpc.yaml"}}
203 ufo_json_rpc:
204 docs:
205 key_for_methods: methods
206 {{/code}}
207
208 {{code language="yaml" layout="LINENUMBERS" title="config/packages/ufo_json_rpc.yaml"}}
209 ufo_json_rpc:
210 docs:
211 key_for_methods: services
212 {{/code}}
213
214 {{code language="yaml" layout="LINENUMBERS" title="config/packages/ufo_json_rpc.yaml"}}
215 ufo_json_rpc:
216 docs:
217 key_for_methods: some_custom_key
218 {{/code}}
219
220 === (% id="cke_bm_617119S" style="display:none" %) (%%)Параметр {{code language="none"}}async_dsn_info{{/code}} ===
221
222 Відповідає за відображення в документації інформації про асинхронний транспорт.
223
224 {{code language="yaml" layout="LINENUMBERS" title="config/packages/ufo_json_rpc.yaml"}}
225 ufo_json_rpc:
226 async_dsn_info: true # or false
227 {{/code}}
228
229 ==== **Приклад документації ** ====
230
231 {{code language="json" layout="LINENUMBERS" title="GET: /api"}}
232 {
233 "envelope": "JSON-RPC-2.0/UFO-RPC-6",
234 "contentType": "application/json",
235 "description": "",
236 "transport": {
237 "sync": {
238 "scheme": "http",
239 "host": "example.com",
240 "path": "/api",
241 "method": "POST"
242 },
243 "async": {
244 "scheme": "amqp",
245 "user": "{user}",
246 "pass": "{pass}",
247 "host": "async_rabbit",
248 "port": 5672,
249 "path": "/%2f/json-rpc"
250 }
251 },
252 "methods": {
253 ...
254 }
255 }
256 {{/code}}
257
258
259
260 {{info}}
261 Не переймайтеся щодо безпеки ваших авторизаційних даних. що містяться в DSN.
262
263 Документатор побудований таким чином, що перед виводом інформації про DSN він видаляє дані про користувача і його пароль, а також інші секретні дані, як то токени, секретні ключі, тощо.
264
265 Шаблон, по якому відбувається захист {{code language="none"}}/([\w\d_]*(?:secret|access|token|key)[_\w]*)=((?:\w|\d)+(?=&?))/{{/code}}.
266
267 Приклад:
268
269 {{code language="json" layout="LINENUMBERS" title="RPC_TRANSPORT_DSN=https://sqs.eu-west-3.amazonaws.com/123456789012/messages?access_key=AKIAIOSFODNN7EXAMPLE&secret_key=j17M97ffSVoKI0briFoo9a"}}
270 {
271 "async": {
272 "scheme": "https",
273 "host": "sqs.eu-west-3.amazonaws.com",
274 "path": "/123456789012/messages",
275 "query": "access_key={access_key}&secret_key={secret_key}"
276 }
277 }
278 {{/code}}
279 {{/info}}
280
281 === Параметр {{code language="none"}}validations{{/code}} ===
282
283 Відповідає за відображення в документації методів додаткових блоків, що вказують на вимоги до валідації даних.
284
285 Наразі цей блок має два можливих налаштування:
286
287 * {{code language="none"}}json_schema: <bool>{{/code}}
288 * {{code language="none"}}symfony_asserts: <bool>{{/code}}
289
290 У всіх опцій в цьому параметрі значення за замовченням {{code language="none"}}false{{/code}}, тобто ці блоки не будуть відображатися в документації.
291 Якщо ви потребуєте якийсь з цих блоків інформації при запиті документації, то встановіть значення в {{code language="none"}}true{{/code}}.
292
293 {{code language="yaml" layout="LINENUMBERS" title="config/packages/ufo_json_rpc.yaml"}}
294 ufo_json_rpc:
295 docs:
296 json_schema: true
297 symfony_asserts: true
298 {{/code}}
299
300 ==== **Приклад документації ** ====
301
302 (% class="box infomessage" %)
303 (((
304 В цьому прикладі я видалив вміст обʼєктів symfony_assertions для спрощення прикладу.
305 Детальніше про валідацію методів дивись сторінку **[[Валідація процедур>>doc:.add_rpc_service.assertions.WebHome]]**
306 )))
307
308 {{code language="json" layout="LINENUMBERS" title="GET: /api"}}
309 {
310 "envelope": "JSON-RPC-2.0/UFO-RPC-6",
311 "contentType": "application/json",
312 "description": "",
313 "transport": {
314 "sync": {
315 "scheme": "https",
316 "host": "example.com",
317 "path": "/api",
318 "method": "POST"
319 }
320 },
321 "methods": {
322 "getUserNameByUuid": {
323 "name": "getUserNameByUuid",
324 "description": "Get username by id",
325 "parameters": {
326 "userId": {
327 "type": "string",
328 "name": "userId",
329 "description": "User id in uuid format",
330 "optional": false
331 }
332 },
333 "returns": "string",
334 "responseFormat": "string",
335 "json_schema": {
336 "$schema": "http://json-schema.org/draft-07/schema#",
337 "type": "object",
338 "properties": {
339 "userId": {
340 "type": "string"
341 }
342 },
343 "required": [
344 "userId"
345 ]
346 },
347 "symfony_assertions": {
348 "userId": [
349 {
350 "class": "Symfony\\Component\\Validator\\Constraints\\Uuid",
351 "context": {}
352 }
353 ]
354 }
355 },
356 "sendEmail": {
357 "name": "sendEmail",
358 "description": "Send mail",
359 "parameters": {
360 "email": {
361 "type": "string",
362 "name": "email",
363 "description": "",
364 "optional": false
365 },
366 "subject": {
367 "type": "string",
368 "name": "subject",
369 "description": "",
370 "optional": false
371 },
372 "text": {
373 "type": "string",
374 "name": "text",
375 "description": "",
376 "optional": false
377 }
378 },
379 "returns": "boolean",
380 "responseFormat": "boolean",
381 "json_schema": {
382 "$schema": "http://json-schema.org/draft-07/schema#",
383 "type": "object",
384 "properties": {
385 "email": {
386 "type": "string",
387 "format": "email"
388 },
389 "subject": {
390 "type": "string",
391 "minLength": 1,
392 "maxLength": 100
393 },
394 "text": {
395 "type": "string",
396 "minLength": 10
397 }
398 },
399 "required": [
400 "email",
401 "subject",
402 "text"
403 ]
404 },
405 "symfony_assertions": {
406 "email": [
407 {
408 "class": "Symfony\\Component\\Validator\\Constraints\\Email",
409 "context": {}
410 }
411 ],
412 "subject": [
413 {
414 "class": "Symfony\\Component\\Validator\\Constraints\\NotBlank",
415 "context": {}
416 },
417 {
418 "class": "Symfony\\Component\\Validator\\Constraints\\Length",
419 "context": {}
420 }
421 ],
422 "text": [
423 {
424 "class": "Symfony\\Component\\Validator\\Constraints\\NotBlank",
425 "context": {}
426 },
427 {
428 "class": "Symfony\\Component\\Validator\\Constraints\\Length",
429 "context": {}
430 }
431 ]
432 }
433 }
434 }
435 }
436 {{/code}}