Newer
Older
# Test Plan for CAPIF Api Security Service
At this documentation you will have all information and related files and examples of test plan for this API.
## Test Case 1: Create a security context for an API invoker
**Test ID**: ***capif_security_api-1***
**Description**:
This test case will check that an API Invoker can create a Security context
**Pre-Conditions**:
* API Invoker is pre-authorised (has valid apiInvokerID from CAPIF Authority)
**Information of Test**:
1. Perform [Invoker Onboarding]
2. Create Security Context for this Invoker
Jorge Moratinos
committed
* Send **PUT** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}**
Jorge Moratinos
committed
* Use **Invoker Certificate**
**Execution Steps**:
1. Register and onboard Invoker at CCF
2. Store signed Certificate
3. Create Security Context
**Expected Result**:
1. Create security context:
1. **201 Created** response.
2. body returned must accomplish **ServiceSecurity** data structure.
Jorge Moratinos
committed
3. Location Header must contain the new resource URL **{apiRoot}/capif-security/v1/trustedInvokers/{apiInvokerId}**
## Test Case 2: Create a security context for an API invoker with Provider role
**Test ID**:: ***capif_security_api-2***
**Description**:
This test case will check that an Provider cannot create a Security context with valid apiInvokerId.
**Pre-Conditions**:
* API Invoker is pre-authorised (has valid apiInvokerID), but user that create Security Context with Provider role
**Information of Test**:
1. Perform [Provider Registration] and [Invoker Onboarding]
2. Create Security Context for this Invoker but using Provider certificate.
Jorge Moratinos
committed
* Send **PUT** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}**
Jorge Moratinos
committed
* Using **AEF Certificate**
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
**Execution Steps**:
1. Register and onboard Invoker at CCF
2. Register Provider at CCF
3. Create Security Context using Provider certificate
**Expected Result**:
1. Create security context using Provider certificate:
1. **401 Unauthorized** response.
2. body returned must accomplish **ProblemDetails** data structure, with:
* status **401**
* title with message "Unauthorized"
* detail with message "Role not authorized for this API route".
* cause with message "User role must be invoker".
2. No context stored at DB
## Test Case 3: Create a security context for an API invoker with Provider entity role and invalid apiInvokerId
**Test ID**:: ***capif_security_api-3***
**Description**:
This test case will check that an Provider cannot create a Security context with invalid apiInvokerID.
**Pre-Conditions**:
* API Invoker is pre-authorised (has valid apiInvokerID), but user that create Security Context with Provider role
**Information of Test**:
1. Perform [Provider Registration]
2. Create Security Context for this not valid apiInvokerId and using Provider certificate.
Jorge Moratinos
committed
* Send **PUT** **https://{CAPIF_HOSTNAME}/trustedInvokers/{API_INVOKER_NOT_VALID}**
Jorge Moratinos
committed
* Using **AEF Certificate**
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
**Execution Steps**:
1. Register Provider at CCF
2. Create Security Context using Provider certificate
**Expected Result**:
1. Create security context using Provider certificate:
1. **401 Unauthorized** response.
2. body returned must accomplish **ProblemDetails** data structure, with:
* status **401**
* title with message "Unauthorized"
* detail with message "Role not authorized for this API route".
* cause with message "User role must be invoker".
2. No context stored at DB
## Test Case 4: Create a security context for an API invoker with Invoker entity role and invalid apiInvokerId
**Test ID**:: ***capif_security_api-4***
**Description**:
This test case will check that an Invoker cannot create a Security context with valid apiInvokerId.
**Pre-Conditions**:
* API Invoker is pre-authorised (has valid apiInvokerID), but user that create Security Context with invalid apiInvokerId
**Information of Test**:
1. Perform [Invoker Onboarding]
2. Create Security Context for this Invoker:
Jorge Moratinos
committed
* Send **PUT** **https://{CAPIF_HOSTNAME}/trustedInvokers/{API_INVOKER_NOT_VALID}**
Jorge Moratinos
committed
* Use **Invoker Certificate**
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
**Execution Steps**:
1. Register and onboard Invoker at CCF
2. Create Security Context using Provider certificate
**Expected Result**:
1. Create security context using Provider certificate:
1. **404 Not Found** response.
2. body returned must accomplish **ProblemDetails** data structure, with:
* status **404**
* title with message "Not Found"
* detail with message "Invoker not found".
* cause with message "API Invoker not exists or invalid ID".
2. No context stored at DB
## Test Case 5: Retrieve the Security Context of an API Invoker
**Test ID**:: ***capif_security_api-5***
**Description**:
This test case will check that an provider can retrieve the Security context of an API Invoker
**Pre-Conditions**:
* Provider is pre-authorised (has valid apfId from CAPIF Authority) and API Invoker has created a valid Security Context
**Information of Test**:
1. Perform [Provider Registration] and [Invoker Onboarding]
2. Create Security Context for this Invoker.
Jorge Moratinos
committed
* Send **PUT** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}**
Jorge Moratinos
committed
* Using **Invoker Certificate**
3. Retrieve Security Context of Invoker by Provider:
Jorge Moratinos
committed
* Send **GET** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}**
* Using **AEF Certificate**
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
**Execution Steps**:
1. Register and onboard Invoker at CCF
2. Register Provider at CCF
3. Create Security Context using Provider certificate
4. Retrieve Security Context by Provider
**Expected Result**:
1. Retrieve security context:
1. **200 OK** response.
2. body returned must accomplish **ServiceSecurity** data structure.
## Test Case 6: Retrieve the Security Context of an API Invoker with invalid apiInvokerID
**Test ID**:: ***capif_security_api-6***
**Description**:
This test case will check that an provider can retrieve the Security context of an API Invoker
**Pre-Conditions**:
* Provider is pre-authorised (has valid apfId from CAPIF Authority) and API Invoker has created a valid Security Context
**Information of Test**:
1. Perform [Provider Registration]
2. Retrieve Security Context of invalid Invoker by Provider:
Jorge Moratinos
committed
* Send **GET** **https://{CAPIF_HOSTNAME}/trustedInvokers/{API_INVOKER_NOT_VALID}**
* Using **AEF Certificate**.
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
**Execution Steps**:
2. Register Provider at CCF
3. Create Security Context using Provider certificate
4. Retrieve Security Context by Provider of invalid invoker
**Expected Result**:
1. Retrieve security context:
1. **404 Not Found** response.
2. body returned must accomplish **ProblemDetails** data structure, with:
* status **404**
* title with message "Not Found"
* detail with message "Invoker not found".
* cause with message "API Invoker not exists or invalid ID".
## Test Case 7: Retrieve the Security Context of an API Invoker with invalid apfId
**Test ID**:: ***capif_security_api-7***
**Description**:
This test case will check that an Provider cannot retrieve the Security context of an API Invoker without valid apfId
**Pre-Conditions**:
* API Exposure Function is not pre-authorised (has invalid apfId)
**Information of Test**:
1. Perform [Provider Registration] and [Invoker Onboarding]
2. Create Security Context for this Invoker
Jorge Moratinos
committed
* Send **PUT** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}**
Jorge Moratinos
committed
* Using **Invoker Certificate**
3. Retrieve Security Context as Invoker role:
Jorge Moratinos
committed
* Send **GET** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}**
* Using **Invoker Certificate**
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
**Execution Steps**:
1. Register and onboard Invoker at CCF
2. Store signed Certificate
3. Create Security Context
4. Retrieve Security Context as Provider.
**Expected Result**:
1. Create security context:
1. **401 Unauthorized** response.
2. body returned must accomplish **ProblemDetails** data structure, with:
* status **401**
* title with message "Unauthorized"
* detail with message "Role not authorized for this API route".
* cause with message "User role must be aef".
## Test Case 8: Delete the Security Context of an API Invoker
**Test ID**:: ***capif_security_api-8***
**Description**:
This test case will check that an Provider can delete a Security context
**Pre-Conditions**:
* Provider is pre-authorised (has valid apfId from CAPIF Authority) and API Invoker has created a valid Security Context
**Information of Test**:
1. Perform [Provider Registration] and [Invoker Onboarding]
2. Create Security Context for this Invoker but using Provider certificate.
Jorge Moratinos
committed
* Send **PUT** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}**
Jorge Moratinos
committed
* Using **AEF Certificate**
3. Delete Security Context of Invoker by Provider:
Jorge Moratinos
committed
* Send **DELETE** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}**
* Use **AEF Certificate**
4. Retrieve Security Context of Invoker by Provider:
Jorge Moratinos
committed
* Send **GET** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}**
* Using **AEF Certificate**
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
**Execution Steps**:
1. Register and onboard Invoker at CCF
2. Register Provider at CCF
3. Create Security Context using Provider certificate
4. Delete Security Context by Provider
**Expected Result**:
1. Delete security context:
1. **204 No Content** response.
2. Retrieve security context:
1. **404 Not Found** response.
2. body returned must accomplish **ProblemDetails** data structure, with:
* status **404**
* title with message "Not Found"
* detail with message "Security context not found".
* cause with message "API Invoker not exists or invalid ID".
## Test Case 9: Delete the Security Context of an API Invoker with Invoker entity role
**Test ID**:: ***capif_security_api-9***
**Description**:
This test case will check that an Invoker cannot delete a Security context
**Pre-Conditions**:
* Provider is pre-authorised (has valid apfId from CAPIF Authority) and API Invoker has created a valid Security Context
**Information of Test**:
1. Perform [Provider Registration] and [Invoker Onboarding]
2. Create Security Context for this Invoker:
Jorge Moratinos
committed
* Send **PUT** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}**
Jorge Moratinos
committed
* Using **Invoker Certificate**
3. Delete Security Context of Invoker:
Jorge Moratinos
committed
* Send **DELETE** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}**
* Use **Invoker Certificate**
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
376
377
378
379
380
**Execution Steps**:
1. Register Provider at CCF
2. Create Security Context using Provider certificate
3. Delete Security Context by Invoker
**Expected Result**:
1. Delete security context:
1. **401 Unauthorized** response.
2. body returned must accomplish **ProblemDetails** data structure, with:
* status **401**
* title with message "Unauthorized"
* detail with message "Role not authorized for this API route".
* cause with message "User role must be aef".
## Test Case 10: Delete the Security Context of an API Invoker with Invoker entity role and invalid apiInvokerID
**Test ID**:: ***capif_security_api-10***
**Description**:
This test case will check that an Invoker cannot delete a Security context with invalid
**Pre-Conditions**:
* Invoker is pre-authorised.
**Information of Test**:
1. Perform [Invoker Onboarding]
2. Delete Security Context of Invoker:
Jorge Moratinos
committed
* Send **DELETE** **https://{CAPIF_HOSTNAME}/trustedInvokers/{API_INVOKER_NOT_VALID}**
* Use **Invoker Certificate**
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
**Execution Steps**:
1. Register Provider at CCF
2. Delete Security Context by invoker
**Expected Result**:
1. Delete security context:
1. **401 Unauthorized** response.
2. body returned must accomplish **ProblemDetails** data structure, with:
* status **401**
* title with message "Unauthorized"
* detail with message "Role not authorized for this API route".
* cause with message "User role must be aef".
## Test Case 11: Delete the Security Context of an API Invoker with invalid apiInvokerID
**Test ID**:: ***capif_security_api-11***
**Description**:
This test case will check that an Provider cannot delete a Security context of invalid apiInvokerId
**Pre-Conditions**:
* Provider is pre-authorised (has valid apfId from CAPIF Authority).
**Information of Test**:
1. Perform [Provider Registration]
2. Delete Security Context of Invoker by Provider:
Jorge Moratinos
committed
* Send **DELETE** **https://{CAPIF_HOSTNAME}/trustedInvokers/{API_INVOKER_NOT_VALID}**
* Use **AEF Certificate**
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
**Execution Steps**:
1. Register Provider at CCF
2. Delete Security Context by provider
**Expected Result**:
1. Retrieve security context:
1. **404 Not Found** response.
2. body returned must accomplish **ProblemDetails** data structure, with:
* status **404**
* title with message "Not Found"
* detail with message "Invoker not found".
* cause with message "API Invoker not exists or invalid ID".
## Test Case 12: Update the Security Context of an API Invoker
**Test ID**:: ***capif_security_api-12***
**Description**:
This test case will check that an API Invoker can update a Security context
**Pre-Conditions**:
* API Invoker is pre-authorised (has valid apiInvokerID from CAPIF Authority) and Provider is also authorized
**Information of Test**:
1. Perform [Provider Registration] and [Invoker Onboarding]
2. Create Security Context for this Invoker:
Jorge Moratinos
committed
* Send **PUT** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}**
Jorge Moratinos
committed
* Using **Invoker Certificate**.
3. Update Security Context of Invoker:
Jorge Moratinos
committed
* Send **POST** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}/update**
* body [service security body] but with notification destination modified to **http://robot.testing2**
* Using **Invoker Certificate**.
4. Retrieve Security Context of Invoker by Provider:
Jorge Moratinos
committed
* Send **GET** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}**
* Using **AEF Certificate**.
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
**Execution Steps**:
1. Register and onboard Invoker at CCF
2. Register Provider at CCF
3. Create Security Context By Invoker
4. Update Security Context By Invoker
5. Retrieve Security Context By Provider
**Expected Result**:
1. Update security context:
1. **200 OK** response.
2. body returned must accomplish **ServiceSecurity** data structure.
2. Retrieve security context:
1. **200 OK** response.
2. body returned must accomplish **ServiceSecurity** data structure.
1. Check is this returned object match with modified one.
## Test Case 13: Update the Security Context of an API Invoker with Provider entity role
**Test ID**:: ***capif_security_api-13***
**Description**:
This test case will check that an Provider cannot update a Security context
**Pre-Conditions**:
* API Invoker is pre-authorised (has valid apiInvokerID from CAPIF Authority) and Provider is also authorized.
* Invoker has created the Security Context previously.
**Information of Test**:
1. Perform [Provider Registration] and [Invoker Onboarding]
2. Create Security Context for this Invoker:
Jorge Moratinos
committed
* Send **PUT** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}**
Jorge Moratinos
committed
* Using **Invoker Certificate**.
3. Update Security Context of Invoker by Provider:
Jorge Moratinos
committed
* Send **POST** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}/update**
* body [service security body] but with notification destination modified to **http://robot.testing2**
* Using **AEF Certificate**
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
**Execution Steps**:
1. Register and onboard Invoker at CCF
2. Register Provider at CCF
3. Create Security Context
4. Update Security Context as Provider
**Expected Result**:
1. Update security context:
1. **401 Unauthorized** response.
2. body returned must accomplish **ProblemDetails** data structure, with:
* status **401**
* title with message "Unauthorized"
* detail with message "Role not authorized for this API route".
* cause with message "User role must be invoker".
## Test Case 14: Update the Security Context of an API Invoker with AEF entity role and invalid apiInvokerId
**Test ID**:: ***capif_security_api-14***
**Description**:
This test case will check that an Provider cannot update a Security context of invalid apiInvokerId
**Pre-Conditions**:
* API Invoker is pre-authorised (has valid apiInvokerID from CAPIF Authority) and Provider is also authorized.
* Invoker has created the Security Context previously.
**Information of Test**:
1. Perform [Provider Registration]
2. Update Security Context of Invoker by Provider:
Jorge Moratinos
committed
* Send **POST** **https://{CAPIF_HOSTNAME}/trustedInvokers/{API_INVOKER_NOT_VALID}/update**
Jorge Moratinos
committed
* Using **AEF Certificate**
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
**Execution Steps**:
1. Register Provider at CCF
2. Update Security Context as Provider
**Expected Result**:
1. Update security context:
1. **401 Unauthorized** response.
2. body returned must accomplish **ProblemDetails** data structure, with:
* status **401**
* title with message "Unauthorized"
* detail with message "Role not authorized for this API route".
* cause with message "User role must be invoker".
## Test Case 15: Update the Security Context of an API Invoker with invalid apiInvokerID
**Test ID**:: ***capif_security_api-15***
**Description**:
This test case will check that an API Invoker cannot update a Security context not valid apiInvokerId
**Pre-Conditions**:
* API Invoker is pre-authorised (has valid apiInvokerID from CAPIF Authority)
**Information of Test**:
1. Perform [Provider Registration] and [Invoker Onboarding]
2. Update Security Context of Invoker:
Jorge Moratinos
committed
* Send **POST** **https://{CAPIF_HOSTNAME}/trustedInvokers/{API_INVOKER_NOT_VALID}/update**
Jorge Moratinos
committed
* Using **Invoker Certificate**.
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
**Execution Steps**:
1. Register and onboard Invoker at CCF
2. Update Security Context
**Expected Result**:
1. Retrieve security context:
1. **404 Not Found** response.
2. body returned must accomplish **ProblemDetails** data structure, with:
* status **404**
* title with message "Not Found"
* detail with message "Invoker not found".
* cause with message "API Invoker not exists or invalid ID".
## Test Case 16: Revoke the authorization of the API invoker for APIs.
**Test ID**:: ***capif_security_api-16***
**Description**:
This test case will check that a Provider can revoke the authorization for APIs
**Pre-Conditions**:
* API Invoker is pre-authorised (has valid apiInvokerID from CAPIF Authority) and Provider is also authorized
**Information of Test**:
1. Perform [Provider Registration] and [Invoker Onboarding]
2. Create Security Context By Invoker:
Jorge Moratinos
committed
* Send **PUT** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}**
Jorge Moratinos
committed
* Using **Invoker Certificate**
3. Revoke Authorization by Provider:
Jorge Moratinos
committed
* Send **POST** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}/delete**
Jorge Moratinos
committed
* Using **AEF Certificate**.
4. Retrieve Security Context by Provider:
Jorge Moratinos
committed
* Send **GET** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}**
* Using **AEF Certificate**.
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
**Execution Steps**:
1. Register and onboard Invoker at CCF
2. Register Provider at CCF
3. Create Security Context by Invoker
4. Revoke Security Context by Provider
5. Retrieve Security Context by Provider
**Expected Result**:
1. Revoke Authorization:
1. **204 No Content** response.
2. Retrieve security context:
1. **404 Not Found** response.
2. body returned must accomplish **ProblemDetails** data structure, with:
* status **404**
* title with message "Not Found"
* detail with message "Security context not found".
* cause with message "API Invoker has no security context".
## Test Case 17: Revoke the authorization of the API invoker for APIs without valid apfID.
**Test ID**:: ***capif_security_api-17***
**Description**:
This test case will check that an Invoker can't revoke the authorization for APIs
**Pre-Conditions**:
* API Invoker is pre-authorised (has valid apiInvokerID from CAPIF Authority) and Provider is also authorized
**Information of Test**:
1. Perform [Provider Registration] and [Invoker Onboarding]
2. Create Security Context for this Invoker:
Jorge Moratinos
committed
* Send **PUT** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}**
Jorge Moratinos
committed
* Using **Invoker Certificate**.
3. Revoke Authorization by invoker:
Jorge Moratinos
committed
* Send **POST** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}/delete**
Jorge Moratinos
committed
* Using **Invoker Certificate**
4. Retrieve Security Context of Invoker by Provider:
Jorge Moratinos
committed
* Send **GET** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}**
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
* Using Provider Certificate
**Execution Steps**:
1. Register and onboard Invoker at CCF
2. Register Provider at CCF
3. Create Security Context
4. Revoke Security Context by invoker
5. Retrieve Security Context
**Expected Result**:
1. Revoke Security Context by invoker:
1. **401 Unauthorized** response.
2. body returned must accomplish **ProblemDetails** data structure, with:
* status **401**
* title with message "Unauthorized"
* detail with message "Role not authorized for this API route".
* cause with message "User role must be provider".
3. Retrieve security context:
1. **200 OK** response.
2. body returned must accomplish **ServiceSecurity** data structure.
1. Check is this returned object match with created one.
## Test Case 18: Revoke the authorization of the API invoker for APIs with invalid apiInvokerId.
**Test ID**:: ***capif_security_api-18***
**Description**:
This test case will check that an API Exposure Function cannot revoke the authorization for APIs for invalid apiInvokerId
**Pre-Conditions**:
* API Invoker is pre-authorised (has valid apiInvokerID from CAPIF Authority) and Provider is also authorized
**Information of Test**:
1. Perform [Provider Registration] and [Invoker Onboarding]
2. Create Security Context for this Invoker:
Jorge Moratinos
committed
* Send **PUT** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}**
Jorge Moratinos
committed
* Using **Invoker Certificate**.
3. Revoke Authorization by Provider:
Jorge Moratinos
committed
* Send **POST** **https://{CAPIF_HOSTNAME}/trustedInvokers/{API_INVOKER_NOT_VALID}/delete**
Jorge Moratinos
committed
* Using **AEF Certificate**.
4. Retrieve Security Context of Invoker by Provider:
Jorge Moratinos
committed
* Send **GET** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}?authenticationInfo=true&authorizationInfo=true**
* This request will ask with parameter to retrieve authenticationInfo and authorizationInfo
Jorge Moratinos
committed
* Using **AEF Certificate**.
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
**Execution Steps**:
1. Register and onboard Invoker at CCF
2. Register Provider at CCF
3. Create Security Context
4. Revoke Security Context by Provider
5. Retrieve Security Context
**Expected Result**:
1. Revoke Security Context by invoker:
1. **404 Not Found** response.
2. body returned must accomplish **ProblemDetails** data structure, with:
* status **404**
* title with message "Not Found"
* detail with message "Invoker not found".
* cause with message "API Invoker not exists or invalid ID".
3. Retrieve security context:
1. **200 OK** response.
2. body returned must accomplish **ServiceSecurity** data structure.
1. Check is this return one object that match with created one.
## Test Case 19: Retrieve access token
**Test ID**:: ***capif_security_api-19***
**Description**:
This test case will check that an API Invoker can retrieve a security access token OAuth 2.0.
**Pre-Conditions**:
* API Invoker is pre-authorised (has valid apiInvokerId)
* Service API of Provider is published
**Information of Test**:
1. Perform [Provider Registration] and [Invoker Onboarding]
2. Publish Service API at CCF:
Jorge Moratinos
committed
* Send **POST** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis**
* body [service api description] with apiName **service_1**
* Use **APF Certificate**
3. Request Discover Published APIs not filtered:
Jorge Moratinos
committed
* Send **GET** to ccf_discover_url **https://{CAPIF_HOSTNAME}/service-apis/v1/allServiceAPIs?api-invoker-id={apiInvokerId}**
Jorge Moratinos
committed
* Using **Invoker Certificate**
4. Create Security Context for this Invoker
Jorge Moratinos
committed
* Send **PUT** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}**
Jorge Moratinos
committed
* Using **Invoker Certificate**.
* Create Security Information Body with one **securityInfo** for each aef present at each serviceAPIDescription present at Discover.
5. Request Access Token by invoker:
Jorge Moratinos
committed
* Sent POST **https://{CAPIF_HOSTNAME}/securities/{securityId}/token**:
* body [access token req body] and example [example]
* ***securityId*** is apiInvokerId.
* ***grant_type=client_credentials***.
* Create Scope properly for request: ***3gpp#{aef_id}:{api_name}***
Jorge Moratinos
committed
* Using **Invoker Certificate**.
Jorge Moratinos
committed
1. Register Provider at CCF, store certificates and Publish Service API **service_1** at CCF
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
2. Register and onboard Invoker at CCF
3. Discover Service APIs by Invoker.
4. Create Security Context According to Service APIs discovered.
5. Request Access Token
**Expected Result**:
1. Response to Request of Access Token:
1. **200 OK**
2. body must follow **AccessTokenRsp** with:
1. access_token present
2. token_type=Bearer
## Test Case 20: Retrieve access token by Provider
**Test ID**:: ***capif_security_api-20***
**Description**:
This test case will check that an API Exposure Function cannot revoke the authorization for APIs for invalid apiInvokerId
**Pre-Conditions**:
* API Invoker is pre-authorised (has valid apiInvokerID from CAPIF Authority) and Provider is also authorized
**Information of Test**:
1. Perform [Provider Registration] and [Invoker Onboarding]
2. Publish Service API at CCF:
Jorge Moratinos
committed
* Send **POST** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis**
* body [service api description] with apiName **service_1**
* Use **APF Certificate**
3. Request Discover Published APIs not filtered:
Jorge Moratinos
committed
* Send **GET** to ccf_discover_url **https://{CAPIF_HOSTNAME}/service-apis/v1/allServiceAPIs?api-invoker-id={apiInvokerId}**
Jorge Moratinos
committed
* Using **Invoker Certificate**
4. Create Security Context for this Invoker
Jorge Moratinos
committed
* Send **PUT** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}**
Jorge Moratinos
committed
* Using **Invoker Certificate**.
* Create Security Information Body with one **securityInfo** for each aef present at each serviceAPIDescription present at Discover.
5. Request Access Token by provider:
Jorge Moratinos
committed
* Sent POST **https://{CAPIF_HOSTNAME}/securities/{securityId}/token**:
* body [access token req body]
* ***securityId*** is apiInvokerId
* ***grant_type=client_credentials***
Jorge Moratinos
committed
* Using **AEF Certificate**
Jorge Moratinos
committed
1. Register Provider at CCF, store certificates and Publish Service API **service_1** at CCF
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
2. Register and onboard Invoker at CCF
3. Discover Service APIs by Invoker.
4. Create Security Context According to Service APIs discovered.
5. Request Access Token by Provider
**Expected Result**:
1. Response to Request of Access Token:
1. **401 Unauthorized** response.
2. body returned must accomplish **AccessTokenErr** data structure, with:
* error unauthorized_client
* error_description=Role not authorized for this API route
## Test Case 21: Retrieve access token by Provider with invalid apiInvokerId
**Test ID**:: ***capif_security_api-21***
**Description**:
This test case will check that an API Exposure Function cannot retrieve a security access token without valid apiInvokerId
**Pre-Conditions**:
* API Invoker is pre-authorised and Provider is also authorized
**Information of Test**:
1. Perform [Provider Registration] and [Invoker Onboarding]
2. Publish Service API at CCF:
Jorge Moratinos
committed
* Send **POST** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis**
* body [service api description] with apiName **service_1**
* Use **APF Certificate**
3. Request Discover Published APIs not filtered:
Jorge Moratinos
committed
* Send **GET** to ccf_discover_url **https://{CAPIF_HOSTNAME}/service-apis/v1/allServiceAPIs?api-invoker-id={apiInvokerId}**
Jorge Moratinos
committed
* Using **Invoker Certificate**
4. Create Security Context for this Invoker
Jorge Moratinos
committed
* Send **PUT** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}**
Jorge Moratinos
committed
* Using **Invoker Certificate**.
* Create Security Information Body with one **securityInfo** for each aef present at each serviceAPIDescription present at Discover.
5. Request Access Token by provider:
Jorge Moratinos
committed
* Sent POST **https://{CAPIF_HOSTNAME}/securities/{API_INVOKER_NOT_VALID}/token**.
* body [access token req body]
* ***securityId*** is apiInvokerId
* ***grant_type=client_credentials***
Jorge Moratinos
committed
* Using **AEF Certificate**
Jorge Moratinos
committed
1. Register Provider at CCF, store certificates and Publish Service API **service_1** at CCF
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
2. Register and onboard Invoker at CCF
3. Discover Service APIs by Invoker.
4. Create Security Context According to Service APIs discovered.
5. Request Access Token by Provider
**Expected Result**:
1. Response to Request of Access Token:
1. **401 Unauthorized** response.
2. body returned must accomplish **AccessTokenErr** data structure, with:
* error unauthorized_client
* error_description=Role not authorized for this API route
## Test Case 22: Retrieve access token with invalid apiInvokerId
**Test ID**:: ***capif_security_api-22***
**Description**:
This test case will check that an API Invoker can't retrieve a security access token without valid apiInvokerId
**Pre-Conditions**:
* API Invoker is pre-authorised (has valid apiInvokerId)
**Information of Test**:
1. Perform [Provider Registration] and [Invoker Onboarding]
2. Publish Service API at CCF:
Jorge Moratinos
committed
* Send **POST** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis**
* body [service api description] with apiName **service_1**
* Use **APF Certificate**
3. Request Discover Published APIs not filtered:
Jorge Moratinos
committed
* Send **GET** to ccf_discover_url **https://{CAPIF_HOSTNAME}/service-apis/v1/allServiceAPIs?api-invoker-id={apiInvokerId}**
Jorge Moratinos
committed
* Using **Invoker Certificate**
4. Create Security Context for this Invoker
Jorge Moratinos
committed
* Send **PUT** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}**
Jorge Moratinos
committed
* Using **Invoker Certificate**.
* Create Security Information Body with one **securityInfo** for each aef present at each serviceAPIDescription present at Discover.
5. Request Access Token by invoker:
Jorge Moratinos
committed
* Sent POST **https://{CAPIF_HOSTNAME}/securities/{API_INVOKER_NOT_VALID}/token**.
* body [access token req body]
* ***securityId*** is apiInvokerId
* ***grant_type=client_credentials***
Jorge Moratinos
committed
* Using **Invoker Certificate**
Jorge Moratinos
committed
1. Register Provider at CCF, store certificates and Publish Service API **service_1** at CCF
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
2. Register and onboard Invoker at CCF
3. Discover Service APIs by Invoker.
4. Create Security Context According to Service APIs discovered.
5. Request Access Token by Invoker
**Expected Result**:
1. Response to Request of Access Token:
1. **404 Not Found** response.
2. body returned must accomplish **ProblemDetails29571** data structure, with:
* status 404
* title Not Found
* detail Security context not found
* cause API Invoker has no security context
**NOTE: ProblemDetails29571 is the definition present for this request at swagger of ProblemDetails, and this is different from definition of ProblemDetails across other CAPIF Services**
## Test Case 23: Retrieve access token with invalid client_id
**Test ID**:: ***capif_security_api-23***
**Description**:
This test case will check that an API Exposure Function cannot retrieve a security access token without valid client_id at body
**Pre-Conditions**: