-
Notifications
You must be signed in to change notification settings - Fork 0
/
policy_schema.json
3062 lines (3062 loc) · 179 KB
/
policy_schema.json
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
376
377
378
379
380
381
382
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
417
418
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
453
454
455
456
457
458
459
460
461
462
463
464
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
504
505
506
507
508
509
510
511
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
549
550
551
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
586
587
588
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
623
624
625
626
627
628
629
630
631
632
633
634
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
676
677
678
679
680
681
682
683
684
685
686
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
730
731
732
733
734
735
736
737
738
739
740
741
742
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
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
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
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
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
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
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
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
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
{
"$id": "schema.policy.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"link": {
"properties": {
"link": {
"format": "uri",
"type": "string"
}
},
"required": [
"link"
],
"type": "object"
},
"reference": {
"properties": {
"$ref": {
"format": "uri",
"type": "string"
}
},
"required": [
"$ref"
],
"type": "object"
}
},
"properties": {
"policy": {
"properties": {
"applicationLanguage": {
"description": "The character encoding for the application. The character encoding determines how the policy processes the character sets. The default is utf-8.",
"enum": [
"big5",
"euc-jp",
"euc-kr",
"gb18030",
"gb2312",
"gbk",
"iso-8859-1",
"iso-8859-10",
"iso-8859-13",
"iso-8859-15",
"iso-8859-16",
"iso-8859-2",
"iso-8859-3",
"iso-8859-4",
"iso-8859-5",
"iso-8859-6",
"iso-8859-7",
"iso-8859-8",
"iso-8859-9",
"koi8-r",
"shift_jis",
"utf-8",
"windows-1250",
"windows-1251",
"windows-1252",
"windows-1253",
"windows-1255",
"windows-1256",
"windows-1257",
"windows-874"
],
"type": "string"
},
"blocking-settings": {
"description": "This section defines policy block/alarm behaviors.",
"properties": {
"evasions": {
"oneOf": [
{
"items": {
"description": "This section defines behavior of 'Evasion technique detected' (VIOL_EVASION) violation sub-violations.\nUser can control which sub-violations are enabled (alarmed/blocked).\nBehavior of sub-violations depends on the block/alarm settings of 'Evasion technique detected' violation,\ndefined in /policy/blocking-settings/violations section:\n - If both alarm and block are disabled - enable flag becomes irrelevant, since there will be no block/alarm for all sub-violations",
"properties": {
"description": {
"description": "Human-readable name of sub-violation.",
"enum": [
"%u decoding",
"Apache whitespace",
"Bad unescape",
"Bare byte decoding",
"Directory traversals",
"IIS Unicode codepoints",
"IIS backslashes",
"Multiple decoding"
],
"type": "string"
},
"enabled": {
"description": "Defines if sub-violation is enforced - alarmed or blocked, according to the 'Evasion technique detected' (VIOL_EVASION) violation blocking settings.",
"type": "boolean"
},
"maxDecodingPasses": {
"description": "Defines how many times the system decodes URI and parameter values before the request is considered an evasion.\nRelevant only for the 'Multiple decoding' sub-violation.",
"maximum": 5,
"minimum": 2,
"type": "integer"
}
},
"required": [
"description"
],
"type": "object"
},
"type": "array"
},
{
"$ref": "#/definitions/reference"
}
]
},
"http-protocols": {
"oneOf": [
{
"items": {
"description": "This section defines behavior of 'HTTP protocol compliance failed' (VIOL_HTTP_PROTOCOL) violation sub-violations.\nUser can control which sub-violations are enabled (alarmed/blocked).\nBehavior of sub-violations depends on the block/alarm settings of 'HTTP protocol compliance failed' violation,\n - If both alarm and block are disabled - enable flag becomes irrelevant, since there will be no block/alarm for all sub-violations",
"properties": {
"description": {
"description": "Human-readable name of sub-violation",
"enum": [
"POST request with Content-Length: 0",
"Multiple host headers",
"Host header contains IP address",
"Null in request",
"Header name with no header value",
"Chunked request with Content-Length header",
"Check maximum number of parameters",
"Check maximum number of headers",
"Body in GET or HEAD requests",
"Bad multipart/form-data request parsing",
"Bad multipart parameters parsing",
"Unescaped space in URL",
"High ASCII characters in headers"
],
"type": "string"
},
"enabled": {
"description": "Defines if sub-violation is enforced - alarmed or blocked, according to the 'HTTP protocol compliance failed' (VIOL_HTTP_PROTOCOL) violation blocking settings",
"type": "boolean"
},
"maxHeaders": {
"description": "Defines maximum allowed number of headers in request.\nRelevant only for the 'Check maximum number of headers' sub-violation",
"maximum": 150,
"minimum": 1,
"type": "integer"
},
"maxParams": {
"description": "Defines maximum allowed number of parameters in request.\nRelevant only for the 'Check maximum number of parameters' sub-violation",
"maximum": 5000,
"minimum": 1,
"type": "integer"
}
},
"required": [
"description"
],
"type": "object"
},
"type": "array"
},
{
"$ref": "#/definitions/reference"
}
]
},
"violations": {
"oneOf": [
{
"items": {
"properties": {
"alarm": {
"type": "boolean"
},
"block": {
"type": "boolean"
},
"description": {
"type": "string"
},
"name": {
"enum": [
"VIOL_ASM_COOKIE_MODIFIED",
"VIOL_BLACKLISTED_IP",
"VIOL_COOKIE_EXPIRED",
"VIOL_COOKIE_LENGTH",
"VIOL_COOKIE_MALFORMED",
"VIOL_COOKIE_MODIFIED",
"VIOL_CSRF",
"VIOL_DATA_GUARD",
"VIOL_ENCODING",
"VIOL_EVASION",
"VIOL_FILETYPE",
"VIOL_FILE_UPLOAD",
"VIOL_FILE_UPLOAD_IN_BODY",
"VIOL_GRPC_FORMAT",
"VIOL_GRPC_MALFORMED",
"VIOL_GRPC_METHOD",
"VIOL_HEADER_LENGTH",
"VIOL_HEADER_METACHAR",
"VIOL_HEADER_REPEATED",
"VIOL_HTTP_PROTOCOL",
"VIOL_HTTP_RESPONSE_STATUS",
"VIOL_JSON_FORMAT",
"VIOL_JSON_MALFORMED",
"VIOL_JSON_SCHEMA",
"VIOL_MANDATORY_HEADER",
"VIOL_MANDATORY_PARAMETER",
"VIOL_MANDATORY_REQUEST_BODY",
"VIOL_METHOD",
"VIOL_PARAMETER",
"VIOL_PARAMETER_ARRAY_VALUE",
"VIOL_PARAMETER_DATA_TYPE",
"VIOL_PARAMETER_EMPTY_VALUE",
"VIOL_PARAMETER_LOCATION",
"VIOL_PARAMETER_MULTIPART_NULL_VALUE",
"VIOL_PARAMETER_NAME_METACHAR",
"VIOL_PARAMETER_NUMERIC_VALUE",
"VIOL_PARAMETER_REPEATED",
"VIOL_PARAMETER_STATIC_VALUE",
"VIOL_PARAMETER_VALUE_BASE64",
"VIOL_PARAMETER_VALUE_LENGTH",
"VIOL_PARAMETER_VALUE_METACHAR",
"VIOL_PARAMETER_VALUE_REGEXP",
"VIOL_POST_DATA_LENGTH",
"VIOL_QUERY_STRING_LENGTH",
"VIOL_RATING_THREAT",
"VIOL_RATING_NEED_EXAMINATION",
"VIOL_REQUEST_MAX_LENGTH",
"VIOL_REQUEST_LENGTH",
"VIOL_THREAT_CAMPAIGN",
"VIOL_URL",
"VIOL_URL_CONTENT_TYPE",
"VIOL_URL_LENGTH",
"VIOL_URL_METACHAR",
"VIOL_XML_FORMAT",
"VIOL_XML_MALFORMED"
],
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
{
"$ref": "#/definitions/reference"
}
]
}
},
"type": "object"
},
"bot-defense": {
"description": "This section defines the properties of the bot defense feature.",
"properties": {
"mitigations": {
"description": "This section defines the mitigation to each class or signature.",
"properties": {
"anomalies": {
"oneOf": [
{
"items": {
"properties": {
"$action": {
"enum": [
"delete"
],
"type": "string"
},
"action": {
"enum": [
"alarm",
"block",
"default",
"detect",
"ignore"
],
"type": "string"
},
"name": {
"type": "string"
},
"scoreThreshold": {
"oneOf": [
{
"maximum": 150,
"minimum": 0,
"type": "integer"
},
{
"enum": [
"default"
],
"type": "string"
}
]
}
},
"type": "object"
},
"type": "array"
},
{
"$ref": "#/definitions/reference"
}
]
},
"browsers": {
"oneOf": [
{
"items": {
"properties": {
"$action": {
"enum": [
"delete"
],
"type": "string"
},
"action": {
"enum": [
"alarm",
"block",
"detect"
],
"type": "string"
},
"maxVersion": {
"maximum": 2147483647,
"minimum": 0,
"type": "integer"
},
"minVersion": {
"maximum": 2147483647,
"minimum": 0,
"type": "integer"
},
"name": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
{
"$ref": "#/definitions/reference"
}
]
},
"classes": {
"oneOf": [
{
"items": {
"description": "List of classes and their actions.",
"properties": {
"action": {
"description": "The action we set for this class.\n\n- **ignore**: The system will not detect or report bots from this class.\n- **detect**: The system will detect and report the bot, but violation won't be reported.\n- **alarm**: The system will detect and report requests made by bots from this class as illegal, but will not block them.\n- **block**: The system will detect and report requests made by bots from this class as illegal, and block them.",
"enum": [
"alarm",
"block",
"detect",
"ignore"
],
"type": "string"
},
"name": {
"description": "The class we set the action to.",
"enum": [
"browser",
"malicious-bot",
"suspicious-browser",
"trusted-bot",
"unknown",
"untrusted-bot"
],
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
{
"$ref": "#/definitions/reference"
}
]
},
"signatures": {
"oneOf": [
{
"items": {
"description": "List of signatures and their actions.\nIf a signature is not in the list - its action will be taken according to the class it belongs to.",
"properties": {
"$action": {
"enum": [
"delete"
],
"type": "string"
},
"action": {
"description": "The action we set for this signature.\n\n- **ignore**: The system will not detect or report this signature.\n- **detect**: The system will detect and report the signature, but violation won't be reported.\n- **alarm**: The system will detect and report requests made by those specific bots as illegal, but will not block them.\n- **block**: The system will detect and report requests made by those specific bots as illegal, and will block them.",
"enum": [
"alarm",
"block",
"detect",
"ignore"
],
"type": "string"
},
"name": {
"description": "The name of the signature we want to change action for.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
{
"$ref": "#/definitions/reference"
}
]
}
},
"type": "object"
},
"settings": {
"oneOf": [
{
"description": "This section contains all bot defense settings.",
"properties": {
"isEnabled": {
"description": "If *true* the system detects bots.",
"type": "boolean"
}
},
"type": "object"
},
{
"$ref": "#/definitions/reference"
}
]
}
},
"type": "object"
},
"browser-definitions": {
"oneOf": [
{
"items": {
"properties": {
"$action": {
"enum": [
"delete"
],
"type": "string"
},
"isUserDefined": {
"type": "boolean"
},
"matchRegex": {
"type": "string"
},
"matchString": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
{
"$ref": "#/definitions/reference"
}
]
},
"caseInsensitive": {
"description": "Specifies whether the security policy treats microservice URLs, file types, URLs, and parameters as case sensitive or not. When this setting is enabled, the system stores these security policy elements in lowercase in the security policy configuration.",
"type": "boolean"
},
"character-sets": {
"oneOf": [
{
"items": {
"properties": {
"characterSet": {
"items": {
"properties": {
"isAllowed": {
"type": "boolean"
},
"metachar": {
"type": "string"
}
},
"required": [
"metachar"
],
"type": "object"
},
"type": "array"
},
"characterSetType": {
"enum": [
"header",
"url",
"parameter-name",
"parameter-value",
"xml-content",
"json-content"
],
"type": "string"
}
},
"required": [
"characterSetType"
],
"type": "object"
},
"type": "array"
},
{
"$ref": "#/definitions/reference"
}
]
},
"cookie-settings": {
"oneOf": [
{
"description": "The maximum length of a cookie header name and value that the system processes. The system calculates and enforces a cookie header length based on the sum of the length of the cookie header name and value.",
"properties": {
"maximumCookieHeaderLength": {
"description": "Maximum Cookie Header Length must be greater than 0 and less than 65536 bytes (64K). Note: if 0 or *any* are set, then no restriction on the cookie header length is applied.",
"oneOf": [
{
"maximum": 65536,
"minimum": 1,
"type": "integer"
},
{
"enum": [
"any"
],
"type": "string"
}
]
}
},
"type": "object"
},
{
"$ref": "#/definitions/reference"
}
]
},
"cookies": {
"oneOf": [
{
"items": {
"description": "This section defines Cookie entities for your policy.\nYou can specify the cookies that you want to allow, and the ones you want to enforce in a security policy:\n\n- **Allowed cookies**: The system allows these cookies and clients can change them.\n- **Enforced cookies**: The system enforces the cookies in the list (not allowing clients to change them) and allows clients to change all others.",
"properties": {
"$action": {
"enum": [
"delete"
],
"type": "string"
},
"accessibleOnlyThroughTheHttpProtocol": {
"description": "Specifies, when true, that the system adds the HttpOnly attribute to the domain cookie's response header.\nThis is done to expose the cookie to only HTTP and HTTPS entities.\nThis prevents the cookie from being modified, or intercepted even if it is not modified,\nby unwanted third parties that run scripts on the web page.\n\n**Notes**:\n- The system does not validate that the cookie has not been modified or intercepted.\n- The feature covers all security policy cookies, both enforced and allowed, explicit and wildcard.",
"type": "boolean"
},
"attackSignaturesCheck": {
"description": "Specifies, when true, that you want attack signatures and threat campaigns to be detected on this cookie\nand possibly override the security policy settings of an attack signature or threat campaign specifically for this cookie.\nAfter you enable this setting, the system displays a list of attack signatures and threat campaigns.",
"type": "boolean"
},
"decodeValueAsBase64": {
"description": "Specifies whether the the system should detect or require values to be Base64 encoded:\n\n - **disabled**: the value will not be decoded as Base64 content.\n - **enabled**: the value will be checked whether it can be decoded as Base64 and, if so, security checks will be performed on the decoded value.\n - **required**: the value must be decoded as Base64, and security checks will be performed on the decoded value.\n\n **Note**: This setting is only relevant if the Cookie Enforcement Type is set to Allowed.",
"enum": [
"disabled",
"enabled",
"required"
],
"type": "string"
},
"enforcementType": {
"description": "Specifies how the system treats this cookie.\n\n- **enforced**: Specifies that according to the security policy, this cookie may not be changed by the client.\n- **allowed**: Specifies that according to the security policy, this cookie may be changed by the client. The system ignores this cookie.",
"enum": [
"allow",
"enforce"
],
"type": "string"
},
"insertSameSiteAttribute": {
"description": "The introduction of the SameSite http attribute (defined in [RFC6265bis](https://tools.ietf.org/html/draft-ietf-httpbis-cookie-same-site-00))\nallows you to declare if your cookie should be restricted to a first-party or same-site context.\nIntroducing the SameSite attribute on a cookie provides three different ways of controlling same-site vs. cross-site cookie sending:\n\n- **strict**: Cookie will only be sent in a first-party context. In user terms, the cookie will only be sent if the site for the cookie matches the site currently shown in the browser's URL bar.\n- **lax**: Cookies will be sent with top level navigation\n- **none-value**: Cookies will be sent in a third-party context.",
"enum": [
"lax",
"none",
"none-value",
"strict"
],
"type": "string"
},
"name": {
"description": "Specifies the cookie name as appearing in the http cookie header.\nThe cookie name length is limited to 500 characters.\n\nNames can be one of the following according to the *type* attribute:\n\n- **explicit**: Specifies that the cookie has a specific name and is not a wildcard entity. Type the name of a cookie exactly as you expect it to appear in the request.\n- **wildcard**: Specifies that any cookie that matches the listed wildcard expression should be treated according to the wildcard attributes. Type a wildcard expression that matches the expected cookie. For example, the wildcard expression cookie_12* of type Enforced specifies that the security policy should not allow modified domain cookies for all cookies which match cookie_12*.\n\nThe syntax for wildcard entities is based on shell-style wildcard characters.\nThe list below describes the wildcard characters that you can use so that the entity name can match multiple objects.\n\n- *****: Matches all characters\n- **?**: Matches any single character\n- **[abcde]**: Matches exactly one of the characters listed\n- **[!abcde]**: Matches any character not listed\n- **[a-e]**: Matches exactly one character in the range\n- **[!a-e]**: Matches any character not in the range\n\n**Note**: Wildcards do not match regular expressions. Do not use a regular expression as a wildcard.",
"type": "string"
},
"securedOverHttpsConnection": {
"description": "Specifies, when true, that the system adds the Secure attribute to the domain cookie's response header.\nThis is done to ensure that the cookies are returned to the server only over SSL (by using the HTTPS protocol).\nThis prevents the cookie from being intercepted, but does not guarantee its integrity.\n\n**Notes**:\n- The system does not validate that the cookie was received over SSL.\n- The feature covers all security policy cookies, both enforced and allowed, explicit and wildcard.",
"type": "boolean"
},
"type": {
"description": "Determines the type of the **name** attribute.\nOnly when setting the type to wildcard will the special wildcard characters in the name be interpreted as such.",
"enum": [
"explicit",
"wildcard"
],
"type": "string"
},
"wildcardOrder": {
"description": "Specifies the order index for wildcard cookies matching.\nWildcard cookies with lower wildcard order will get checked for a match prior to cookies with higher wildcard order.",
"type": "integer"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
{
"$ref": "#/definitions/reference"
}
]
},
"csrf-protection": {
"oneOf": [
{
"properties": {
"enabled": {
"type": "boolean"
},
"expirationTimeInSeconds": {
"oneOf": [
{
"type": "integer"
},
{
"enum": [
"disabled"
],
"type": "string"
}
]
},
"sslOnly": {
"type": "boolean"
}
},
"type": "object"
},
{
"$ref": "#/definitions/reference"
}
]
},
"csrf-urls": {
"oneOf": [
{
"items": {
"properties": {
"$action": {
"enum": [
"delete"
],
"type": "string"
},
"enforcementAction": {
"enum": [
"none",
"verify-origin"
],
"type": "string"
},
"method": {
"enum": [
"GET",
"POST",
"any"
],
"type": "string"
},
"url": {
"type": "string"
},
"wildcardOrder": {
"type": "integer"
}
},
"required": [
"url"
],
"type": "object"
},
"type": "array"
},
{
"$ref": "#/definitions/reference"
}
]
},
"data-guard": {
"oneOf": [
{
"description": "Data Guard feature can prevent responses from exposing sensitive information by masking the data.",
"properties": {
"creditCardNumbers": {
"description": "If *true* the system considers credit card numbers as sensitive data.",
"type": "boolean"
},
"enabled": {
"description": "If *true* the system protects sensitive data.",
"type": "boolean"
},
"enforcementMode": {
"description": "Specifies the URLs for which the system enforces data guard protection.\n\n- **ignore-urls-in-list**: Specifies that the system enforces data guard protection for all URLs except for those URLs in the Enforcement Mode list.\n- **enforce-urls-in-list**: Specifies that the system enforces data guard protection only for those URLs in the Enforcement Mode list",
"enum": [
"enforce-urls-in-list",
"ignore-urls-in-list"
],
"type": "string"
},
"enforcementUrls": {
"description": "List of URLS to be enforced based on enforcement mode of data guard protection.",
"items": {
"type": "string"
},
"type": "array"
},
"maskData": {
"description": "If *true* the system intercepts the returned responses to mask sensitive data.",
"type": "boolean"
},
"usSocialSecurityNumbers": {
"description": "If *true* the system considers U.S Social Security numbers as sensitive data.",
"type": "boolean"
}
},
"type": "object"
},
{
"$ref": "#/definitions/reference"
}
]
},
"description": {
"description": "Specifies the description of the policy.",
"type": "string"
},
"enablePassiveMode": {
"description": "In Passive Mode traffic is analyzed, but is not modified in any way.",
"type": "boolean"
},
"enforcementMode": {
"description": "How the system processes a request that triggers a security policy violation.\n- **Blocking:** When the enforcement mode is set to blocking, traffic is blocked if it causes a violation (configured for blocking).\n- **Transparent:** When the enforcement mode is set to transparent, traffic is not blocked even if a violation is triggered.",
"enum": [
"blocking",
"transparent"
],
"type": "string"
},
"enforcer-settings": {
"oneOf": [
{
"description": "This section contains all enforcer settings.",
"properties": {
"enforcerStateCookies": {
"description": "This section defines the properties of the enforcer state cookies.",
"properties": {
"httpOnlyAttribute": {
"description": "Specifies, when true, that the system adds the state cookie HttpOnly attribute.",
"type": "boolean"
},
"sameSiteAttribute": {
"description": "The value for the state cookie SameSite attribute:\n\n- **none**: The SameSite attribute is never added to the state cookie.\n- **strict**: Cookie will only be sent in a first-party context. In user terms, the cookie will only be sent if the site for the cookie matches the site currently shown in the browser's URL bar.\n- **lax**: Cookies will be sent with top level navigation\n- **none-value**: Cookies will be sent in a third-party context.",
"enum": [
"lax",
"none",
"none-value",
"strict"
],
"type": "string"
},
"secureAttribute": {
"description": "The value for the state cookie Secure attribute:\n\n- **always**: Always add the Secure attribute to the state cookie.\n- **never**: The Secure attribute is never added to the state cookie.",
"enum": [
"always",
"never"
],
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
{
"$ref": "#/definitions/reference"
}
]
},
"filetypes": {
"oneOf": [
{
"items": {
"description": "File types are categorization of the URLs in the request by the extension appearing past the last dot at the end of the URL. For example, the file type of /index.php\nis \"php\". Other well known file types are html, aspx, png, jpeg and many more. A special case is the \"empty\" file type called \"no-ext\" meaning, no extension in which the URL has no dot at its last segment as in /foo_no_dot\n\nFile types usually imply the expected content type in the response. For example, html and php return HTML content, while jpeg, png and gif return images, each in its respective format. File types also imply the server technology deployed for rendering the page. For example, php (PHP), aspx (ASP) and many others.\n\nThe security policy uses file types for several purposes:\n1. Ability to define which file types are allowed and which are disallowed. By including the pure wildcard \"\\*\" file type and a list of disallowed file types you have a file type denylist.\nBy having a list of explicit file type *without* the pure wildcard \"\\*\" you have a file type allowlist.\n2. Each file type implies maximum *length restrictions* for the requests of that file type. The checked lengths are per the URL, Query String, total request length, and payload (POST data).\n3. Each file type determines whether to detect *response signatures* for requests of that file type. Typically, one would never check signatures for image file types.",
"properties": {
"$action": {
"enum": [
"delete"
],
"type": "string"
},
"allowed": {
"description": "Determines whether the file type is allowed or disallowed. In either of these cases the VIOL_FILETYPE violation is issued (if enabled) for an incoming request-\n1. No allowed file type matched the file type of the request.\n2. The file type of the request matched a disallowed file type.",
"type": "boolean"
},
"checkPostDataLength": {
"description": "Determines whether to enforce maximum length restriction for the body, a.k.a. \"POST data\" part of the requests that match the respective file type. The maximum length is determined by *postDataLength* attribute.\nAlthough named \"POST data\", this applies to any content type and not restricted to POST requests, e.g. PUT requests are also checked.\nThis attribute is relevant only to *allowed* file types.",
"type": "boolean"
},
"checkQueryStringLength": {
"description": "Determines whether to enforce maximum length restriction for the query string of the requests that match the respective file type. The maximum length is determined by *queryStringLength* attribute.\nThis attribute is relevant only to *allowed* file types.",
"type": "boolean"
},
"checkRequestLength": {
"description": "Determines whether to enforce maximum length restriction for the total length of requests that match the respective file type. The maximum length is determined by *requestLength* attribute.\nThis attribute is relevant only to *allowed* file types.",
"type": "boolean"
},
"checkUrlLength": {
"description": "Determines whether to enforce maximum length restriction for the URL of the requests that match the respective file type. The URL does *not* include the query string, past the &. The maximum length is determined by *urlLength* attribute.\nThis attribute is relevant only to *allowed* file types.",
"type": "boolean"
},
"name": {
"description": "Specifies the file type name as appearing in the URL extension. Names can be one of the following according to the *type* attribute:\n\n- **Explicit** - Specifies that the name is the literal file extension to which the file type refers. The *type* attribute has to be \"explicit\".\n- **No Extension** - Specifies the empty file type, lacking file extension. For this the reserved string **no_ext** should be used. The *type* attribute has to be \"explicit\".\n- **Wildcard** - Specifies that any file extension that matches the wildcard expression is matched to this file type in the policy. The *type* attribute has to be \"wildcard\".\n\nThe syntax for wildcard entities is based on shell-style wildcard characters. The list below describes the wildcard characters that you can use so that the entity name can match multiple objects.\n\n- *****: Matches all characters\n- **?**: Matches any single character\n- **[abcde]**: Matches exactly one of the characters listed\n- **[!abcde]**: Matches any character not listed\n- **[a-e]**: Matches exactly one character in the range\n- **[!a-e]**: Matches any character not in the range\n\n**Note**: Wildcards do not match regular expressions. Do not use a regular expression as a wildcard.",
"type": "string"
},
"postDataLength": {
"description": "The maximum length in bytes of the body (POST data) of the request matching the file type. Enforced only if checkPostDataLength is set to *true*.\nIf the value is exceeded then VIOL_POST_DATA_LENGTH violation is issued.\nThis attribute is relevant only to *allowed* file types.",
"minimum": 0,
"type": "integer"
},
"queryStringLength": {
"description": "The maximum length in bytes of the query string of the request matching the file type. Enforced only if checkQueryStringLength is set to *true*.\nIf the value is exceeded then VIOL_QUERY_STRING_LENGTH violation is issued.\nThis attribute is relevant only to *allowed* file types.",
"minimum": 0,
"type": "integer"
},
"requestLength": {
"description": "The maximum total length in bytes of the request matching the file type. Enforced only if checkRequestLength is set to *true*.\nIf the value is exceeded then VIOL_REQUEST_LENGTH violation is issued.\nThis attribute is relevant only to *allowed* file types.",
"minimum": 0,
"type": "integer"
},
"responseCheck": {
"description": "Determines whether the responses to requests that match the respective file types are inspected for attack signature detection.\nThis attribute is relevant only to *allowed* file types.",
"type": "boolean"
},
"type": {
"description": "Determines the type of the **name** attribute. Only when setting the type to wildcard will the special wildcard characters in the name be interpreted as such.",
"enum": [
"explicit",
"wildcard"
],
"type": "string"
},
"urlLength": {
"description": "The maximum length in bytes of the URL of the request matching the file type, excluding the query string. Enforced only if checkUrlLength is set to *true*.\nIf the value is exceeded then VIOL_URL_LENGTH violation is issued.\nThis attribute is relevant only to *allowed* file types.",
"minimum": 0,
"type": "integer"
},
"wildcardOrder": {
"type": "integer"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
{
"$ref": "#/definitions/reference"
}
]
},
"fullPath": {
"description": "The full name of the policy including partition.",
"type": "string"
},
"general": {
"oneOf": [
{
"description": "This section includes several advanced policy configuration settings.",
"properties": {
"allowedResponseCodes": {
"description": "You can specify which responses a security policy permits.\nBy default, the system accepts all response codes from 100 to 399 as valid responses.\nResponse codes from 400 to 599 are considered invalid unless added to the Allowed Response Status Codes list.\nBy default, 400, 401, 404, 407, 417, and 503 are on the list as allowed HTTP response status codes.",
"items": {
"type": "integer"
},
"type": "array"
},
"customXffHeaders": {
"description": "If you require the system to trust a server further than one hop toward the client (the last proxy traversed), you can use the Custom XFF Headers setting to define a specific header that is inserted closer to, or at the client, that the system will trust.\nAdditionally, if you require the system to trust a proxy server that uses a different header name than the X-Forwarded-For header name, you can add the desired header name to the Custom XFF Headers setting.\nWhen adding a custom header, the X-Forwarded-For header is not trusted anymore. In case the X-Forwarded-For header is to be trusted along with other headers, you must add it to the custom headers list.",
"items": {
"type": "string"
},
"type": "array"
},
"maskCreditCardNumbersInRequest": {
"description": "When enabled, the security policy masks credit card numbers that appear in any part of requests. The system does not mask the information in the actual requests, but rather in various logs:\n* Credit card numbers appearing in entity names are masked in the requests of the Requests log.\n* Credit card numbers appearing in entity values are masked wherever requests can be viewed: the Requests log, and violation details within that log.\nThis setting is enabled by default, and exists in addition to masking parameters defined as containing sensitive information.",
"type": "boolean"
},
"trustXff": {
"description": "When enabled, the system has confidence in an XFF (X-Forwarded-For) header in the request. When disabled, that the system does not have confidence in an XFF header in the request. The default setting is disabled.\n\nSelect this option if the system is deployed behind an internal or other trusted proxy. Then, the system uses the IP address that initiated the connection to the proxy instead of the internal proxy's IP address.\n\nLeave this option disabled if you think the HTTP header may be spoofed, or crafted, by a malicious client. With this setting disabled, if the system is deployed behind an internal proxy, the system uses the internal proxy's IP address instead of the client's IP address.",
"type": "boolean"
}
},
"type": "object"
},
{
"$ref": "#/definitions/reference"
}
]
},
"grpc-profiles": {
"oneOf": [
{
"items": {
"properties": {
"$action": {
"enum": [
"delete"
],
"type": "string"
},
"associateUrls": {
"type": "boolean"
},
"attackSignaturesCheck": {
"type": "boolean"
},
"decodeStringValuesAsBase64": {
"enum": [
"disabled",
"enabled"
],
"type": "string"
},
"defenseAttributes": {
"properties": {
"allowUnknownFields": {
"type": "boolean"
},
"maximumDataLength": {
"oneOf": [
{
"maximum": 2147483647,
"minimum": 0,
"type": "integer"
},
{
"enum": [
"any"
],
"type": "string"
}
]
}
},
"type": "object"
},
"description": {
"type": "string"
},