-
Notifications
You must be signed in to change notification settings - Fork 36
Expand file tree
/
Copy pathcheckpoint.py
More file actions
1889 lines (1697 loc) · 68.3 KB
/
checkpoint.py
File metadata and controls
1889 lines (1697 loc) · 68.3 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
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
# This code is part of Ansible, but is an independent component.
# This particular file snippet, and this file snippet only, is BSD licensed.
# Modules you write using this snippet, which is embedded dynamically by Ansible
# still belong to the author of the module, and may assign their own license
# to the complete work.
#
# (c) 2022 Red Hat Inc.
#
# Redistribution and use in source and binary forms, with or without modification,
# are permitted provided that the following conditions are met:
#
# * Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
# * Redistributions in binary form must reproduce the above copyright notice,
# this list of conditions and the following disclaimer in the documentation
# and/or other materials provided with the distribution.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
# IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
# USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#
from __future__ import absolute_import, division, print_function
__metaclass__ = type
import time
from ansible.module_utils.six import iteritems
from ansible.module_utils.connection import ConnectionError
from ansible.module_utils.connection import Connection
from ansible_collections.ansible.netcommon.plugins.module_utils.network.common import (
utils,
)
BASE_HEADERS = {
"Content-Type": "application/json",
"User-Agent": "Ansible",
}
checkpoint_argument_spec_for_action_module = dict(
auto_publish_session=dict(type="bool", default=False),
wait_for_task_timeout=dict(type="int", default=30),
version=dict(type="str"),
)
checkpoint_argument_spec_for_objects = dict(
auto_publish_session=dict(type="bool", default=False),
wait_for_task=dict(type="bool", default=True),
wait_for_task_timeout=dict(type="int", default=30),
state=dict(type="str", choices=["present", "absent"], default="present"),
version=dict(type="str"),
)
checkpoint_argument_spec_for_facts = dict(version=dict(type="str"))
checkpoint_argument_spec_for_commands = dict(
wait_for_task=dict(type="bool", default=True),
wait_for_task_timeout=dict(type="int", default=30),
version=dict(type="str"),
auto_publish_session=dict(type="bool", default=False),
)
delete_params = [
"name",
"uid",
"layer",
"exception-group-name",
"rule-name",
"package",
"ignore-errors",
"ignore-warnings",
"gateway-uid",
"url"
]
remove_from_set_payload = {
"lsm-cluster": [
"security-profile",
"name-prefix",
"name-suffix",
"main-ip-address",
],
"md-permissions-profile": ["permission-level"],
"access-section": ["position"],
"nat-section": ["position"],
"https-section": ["position"],
"mobile-access-section": ["position"],
"mobile-access-profile-section": ["position"],
}
remove_from_add_payload = {"lsm-cluster": ["name"]}
def _fail_json(msg):
"""Replace the AnsibleModule fail_json here
:param msg: The message for the failure
:type msg: str
"""
raise Exception(msg)
def map_params_to_obj(module_params, key_transform):
"""The fn to convert the api returned params to module params
:param module_params: Module params
:param key_transform: Dict with module equivalent API params
:rtype: A dict
:returns: dict with module prams transformed having API expected params
"""
obj = {}
for k, v in iteritems(key_transform):
if k in module_params and (
module_params.get(k)
or module_params.get(k) == 0
or module_params.get(k) is False
):
val = module_params.pop(k)
if isinstance(val, list):
temp = []
for each in val:
if isinstance(each, dict):
temp.append(map_params_to_obj(each, key_transform))
if temp:
val = temp
if isinstance(val, dict):
temp_child = {}
for each_k, each_v in iteritems(val):
if "_" in each_k:
temp_param = "-".join(each_k.split("_"))
if isinstance(each_v, dict):
temp_dict = map_params_to_obj(
each_v, key_transform
)
each_v = temp_dict
temp_child.update({temp_param: each_v})
else:
temp_child.update({each_k: each_v})
obj[v] = temp_child
else:
obj[v] = val
if module_params:
obj.update(module_params)
return obj
def map_obj_to_params(module_return_params, key_transform, return_param):
"""The fn to convert the api returned params to module params
:param module_return_params: API returned response params
:param key_transform: Module params
:rtype: A dict
:returns: dict with api returned value to module param value
"""
temp = {}
if module_return_params.get(return_param):
temp[return_param] = []
for each in module_return_params[return_param]:
api_temp = {}
for k, v in iteritems(key_transform):
if v in each and (
each.get(v) or each.get(v) == 0 or each.get(v) is False
):
api_temp[k] = each.pop(v)
if each:
api_temp.update(each)
temp[return_param].append(api_temp)
else:
for k, v in iteritems(key_transform):
if v in module_return_params and (
module_return_params.get(v)
or module_return_params.get(v) == 0
or module_return_params.get(v) is False
):
if isinstance(module_return_params[v], dict):
temp_child = {}
for each_k, each_v in iteritems(module_return_params[v]):
if "-" in each_k:
temp_param = "_".join(each_k.split("-"))
if temp_param in key_transform:
temp_child.update({temp_param: each_v})
else:
temp_child.update({each_k: each_v})
temp[k] = temp_child
module_return_params.pop(v)
else:
temp[k] = module_return_params.pop(v)
if module_return_params:
temp.update(module_return_params)
return temp
def verify_want_have_diff(want, have, remove_key_from_diff):
for each in remove_key_from_diff:
if each in want:
del want[each]
diff = utils.dict_diff(have, want)
return diff
def remove_unwanted_key(payload, remove_keys):
for each in remove_keys:
if each in payload:
del payload[each]
return payload
def sync_show_params_with_add_params(search_result, key_transform):
temp = {}
remove_keys = ["type", "meta-info"]
for k, v in iteritems(search_result):
if k in remove_keys:
continue
if isinstance(v, dict):
if v.get("name"):
temp.update({k: v["name"]})
else:
temp_child = {}
for each_k, each_v in iteritems(v):
if isinstance(each_v, dict):
if each_v.get("name"):
temp_child.update({each_k: each_v["name"]})
else:
temp_child.update({each_k: each_v})
temp.update({k: temp_child})
elif isinstance(v, list):
temp[k] = []
for each in v:
if each.get("name"):
temp[k].append(each["name"])
else:
temp.update(each)
else:
temp.update({k: v})
temp = map_obj_to_params(temp, key_transform, "")
return temp
# parse failure message with code and response
def parse_fail_message(code, response):
return "Checkpoint device returned error {0} with message {1}".format(
code, response
)
# send the request to checkpoint
def send_request(connection, version, url, payload=None):
code, response = connection.send_request(
"/web_api/" + version + url, payload
)
return code, response
# get the payload from the user parameters
def is_checkpoint_param(parameter):
if (
parameter == "auto_publish_session"
or parameter == "state"
or parameter == "wait_for_task"
or parameter == "wait_for_task_timeout"
or parameter == "version"
):
return False
return True
def contains_show_identifier_param(payload):
identifier_params = ["name", "uid", "assigned-domain", "task-id", "signature", "url"]
for param in identifier_params:
if payload.get(param) is not None:
return True
return False
# build the payload from the parameters which has value (not None), and they are parameter of checkpoint API as well
def get_payload_from_parameters(params):
payload = {}
for parameter in params:
parameter_value = params[parameter]
if parameter_value is not None and is_checkpoint_param(parameter):
if isinstance(parameter_value, dict):
payload[
parameter.replace("_", "-")
] = get_payload_from_parameters(parameter_value)
elif (
isinstance(parameter_value, list)
and len(parameter_value) != 0
and isinstance(parameter_value[0], dict)
):
payload_list = []
for element_dict in parameter_value:
payload_list.append(
get_payload_from_parameters(element_dict)
)
payload[parameter.replace("_", "-")] = payload_list
else:
# special handle for this param in order to avoid two params called "version"
if (
parameter == "gateway_version"
or parameter == "cluster_version"
or parameter == "server_version"
or parameter == "check_point_host_version"
or parameter == "target_version"
or parameter == "vsx_version"
):
parameter = "version"
# message & syslog_facility are internally used by Ansible, so need to avoid param duplicity
elif parameter == "login_message":
parameter = "message"
payload[parameter.replace("_", "-")] = parameter_value
return payload
# wait for task
def wait_for_task(module, version, connection, task_id):
task_id_payload = {"task-id": task_id, "details-level": "full"}
task_complete = False
minutes_until_timeout = 30
if (
module.params["wait_for_task_timeout"] is not None
and module.params["wait_for_task_timeout"] >= 0
):
minutes_until_timeout = module.params["wait_for_task_timeout"]
max_num_iterations = minutes_until_timeout * 30
current_iteration = 0
# As long as there is a task in progress
while not task_complete and current_iteration < max_num_iterations:
current_iteration += 1
# Check the status of the task
code, response = send_request(
connection, version, "show-task", task_id_payload
)
attempts_counter = 0
while code != 200:
if attempts_counter < 5:
attempts_counter += 1
time.sleep(2)
code, response = send_request(
connection, version, "show-task", task_id_payload
)
else:
response["message"] = (
"ERROR: Failed to handle asynchronous tasks as synchronous, tasks result is"
" undefined. " + response["message"]
)
module.fail_json(msg=parse_fail_message(code, response))
# Count the number of tasks that are not in-progress
completed_tasks = 0
for task in response["tasks"]:
if task["status"] == "failed":
(
status_description,
comments,
) = get_status_description_and_comments(task)
if comments and status_description:
module.fail_json(
msg="Task {0} with task id {1} failed. Message: {2} with description: {3} - "
"Look at the logs for more details ".format(
task["task-name"],
task["task-id"],
comments,
status_description,
)
)
elif comments:
module.fail_json(
msg="Task {0} with task id {1} failed. Message: {2} - Look at the logs for more details ".format(
task["task-name"], task["task-id"], comments
)
)
elif status_description:
module.fail_json(
msg="Task {0} with task id {1} failed. Message: {2} - Look at the logs for more "
"details ".format(
task["task-name"],
task["task-id"],
status_description,
)
)
else:
module.fail_json(
msg="Task {0} with task id {1} failed. Look at the logs for more details".format(
task["task-name"], task["task-id"]
)
)
if task["status"] == "in progress":
break
completed_tasks += 1
# Are we done? check if all tasks are completed
if completed_tasks == len(response["tasks"]) and completed_tasks != 0:
task_complete = True
else:
time.sleep(2) # Wait for two seconds
if not task_complete:
module.fail_json(
msg="ERROR: Timeout. Task-id: {0}.".format(
task_id_payload["task-id"]
)
)
else:
return response
# Getting a status description and comments of task failure details
def get_status_description_and_comments(task):
status_description = None
comments = None
if "comments" in task and task["comments"]:
comments = task["comments"]
if "task-details" in task and task["task-details"]:
task_details = task["task-details"][0]
if "statusDescription" in task_details:
status_description = task_details["statusDescription"]
return status_description, comments
# if failed occurred, in some cases we want to discard changes before exiting. We also notify the user about the `discard`
def discard_and_fail(module, code, response, connection, version):
discard_code, discard_response = send_request(
connection, version, "discard"
)
if discard_code != 200:
try:
module.fail_json(
msg=parse_fail_message(code, response)
+ " Failed to discard session {0}"
" with error {1} with message {2}".format(
connection.get_session_uid(),
discard_code,
discard_response,
)
)
except Exception:
# Read-only mode without UID
module.fail_json(
msg=parse_fail_message(code, response)
+ " Failed to discard session"
" with error {0} with message {1}".format(
discard_code, discard_response
)
)
module.fail_json(
msg=parse_fail_message(code, response)
+ " Unpublished changes were discarded"
)
# handle publish command, and wait for it to end if the user asked so
def handle_publish(module, connection, version):
if (
"auto_publish_session" in module.params
and module.params["auto_publish_session"]
):
publish_code, publish_response = send_request(
connection, version, "publish"
)
if publish_code != 200:
discard_and_fail(
module, publish_code, publish_response, connection, version
)
if module.params["wait_for_task"]:
wait_for_task(
module, version, connection, publish_response["task-id"]
)
# if user insert a specific version, we add it to the url
def get_version(module):
return (
("v" + module.params["version"] + "/")
if module.params.get("version")
else ""
)
# if code is 400 (bad request) or 500 (internal error) - fail
def handle_equals_failure(module, equals_code, equals_response):
if equals_code == 400 or equals_code == 500:
module.fail_json(msg=parse_fail_message(equals_code, equals_response))
if (
equals_code == 404
and equals_response["code"] == "generic_err_command_not_found"
):
module.fail_json(
msg="Relevant hotfix is not installed on Check Point server. See sk114661 on Check Point Support Center."
)
# handle call
def handle_call(
connection,
version,
call,
payload,
module,
to_publish,
to_discard_on_failure,
):
code, response = send_request(connection, version, call, payload)
if code != 200:
if to_discard_on_failure:
discard_and_fail(module, code, response, connection, version)
else:
module.fail_json(msg=parse_fail_message(code, response))
else:
if "wait_for_task" in module.params and module.params["wait_for_task"]:
if "task-id" in response:
response = wait_for_task(
module, version, connection, response["task-id"]
)
elif "tasks" in response:
for task in response["tasks"]:
if "task-id" in task:
task_id = task["task-id"]
response[task_id] = wait_for_task(
module, version, connection, task["task-id"]
)
del response["tasks"]
if to_publish:
handle_publish(module, connection, version)
return response
# handle a command
def api_command(module, command):
payload = get_payload_from_parameters(module.params)
connection = Connection(module._socket_path)
version = get_version(module)
code, response = send_request(connection, version, command, payload)
result = {"changed": True}
if command.startswith("show"):
result['changed'] = False
if code == 200:
if module.params["wait_for_task"]:
if "task-id" in response:
response = wait_for_task(
module, version, connection, response["task-id"]
)
elif "tasks" in response:
for task in response["tasks"]:
if "task-id" in task:
task_id = task["task-id"]
response[task_id] = wait_for_task(
module, version, connection, task["task-id"]
)
del response["tasks"]
result[command] = response
handle_publish(module, connection, version)
else:
if command.startswith("show"):
module.fail_json(msg=parse_fail_message(code, response))
else:
discard_and_fail(module, code, response, connection, version)
return result
# handle api call facts
def api_call_facts(module, api_call_object, api_call_object_plural_version):
payload = get_payload_from_parameters(module.params)
connection = Connection(module._socket_path)
version = get_version(module)
# if there isn't an identifier param, the API command will be in plural version (e.g. show-hosts instead of show-host)
if not contains_show_identifier_param(payload):
api_call_object = api_call_object_plural_version
response = handle_call(
connection,
version,
"show-" + api_call_object,
payload,
module,
False,
False,
)
result = {api_call_object.replace("-", "_"): response}
return result
# handle delete
def handle_delete(
equals_code,
payload,
delete_params,
connection,
version,
api_call_object,
module,
result,
):
# else equals_code is 404 and no need to delete because he doesn't exist
if equals_code == 200:
payload_for_delete = extract_payload_with_some_params(
payload, delete_params
)
response = handle_call(
connection,
version,
"delete-" + api_call_object,
payload_for_delete,
module,
True,
True,
)
result["changed"] = True
# handle the call and set the result with 'changed' and the response
def handle_call_and_set_result(
connection, version, call, payload, module, result
):
response = handle_call(
connection, version, call, payload, module, True, True
)
result["changed"] = True
result[call] = response
# handle api call
def api_call(module, api_call_object):
payload = get_payload_from_parameters(module.params)
connection = Connection(module._socket_path)
version = get_version(module)
result = {"changed": False}
if module.check_mode:
return result
payload_for_equals = {"type": api_call_object, "params": payload}
equals_code, equals_response = send_request(
connection, version, "equals", payload_for_equals
)
result["checkpoint_session_uid"] = connection.get_session_uid()
handle_equals_failure(module, equals_code, equals_response)
if module.params["state"] == "present":
if equals_code == 200:
# else objects are equals and there is no need for set request
if not equals_response["equals"]:
build_payload(
api_call_object, payload, remove_from_set_payload
)
handle_call_and_set_result(
connection,
version,
"set-" + api_call_object,
payload,
module,
result,
)
elif equals_code == 404:
build_payload(api_call_object, payload, remove_from_add_payload)
handle_call_and_set_result(
connection,
version,
"add-" + api_call_object,
payload,
module,
result,
)
elif module.params["state"] == "absent":
handle_delete(
equals_code,
payload,
delete_params,
connection,
version,
api_call_object,
module,
result,
)
return result
# returns a generator of the entire rulebase. show_rulebase_identifier_payload can be either package or layer
def get_rulebase_generator(
connection, version, show_rulebase_identifier_payload, show_rulebase_command, rules_amount
):
offset = 0
limit = 100
while True:
payload_for_show_rulebase = {
"limit": limit,
"offset": offset,
}
payload_for_show_rulebase.update(show_rulebase_identifier_payload)
# in case there are empty sections after the last rule, we need them to appear in the reply and the limit might
# cut them out
if offset + limit >= rules_amount:
del payload_for_show_rulebase["limit"]
code, response = send_request(
connection,
version,
show_rulebase_command,
payload_for_show_rulebase,
)
offset = response["to"]
total = response["total"]
rulebase = response["rulebase"]
yield rulebase
if total <= offset:
return
# get 'to' or 'from' of given section
def get_edge_position_in_section(
connection, version, identifier, section_name, edge
):
code, response = send_request(
connection,
version,
"show-layer-structure",
{"name": identifier, "details-level": "uid"},
)
if 'code' in response and response["code"] == "generic_err_command_not_found":
raise ValueError(
"The use of the relative_position field with a section as its value is available only for"
" version 1.7.1 with JHF take 42 and above"
)
sections_in_layer = response["root-section"]["children"]
for section in sections_in_layer:
if section["name"] == section_name:
return int(section[edge + "-rule"])
return None
# return the total amount of rules in the rulebase of the given layer
def get_rules_amount(connection, version, show_rulebase_payload, show_rulebase_command):
payload = {"limit": 0}
payload.update(show_rulebase_payload)
code, response = send_request(
connection,
version,
show_rulebase_command,
payload,
)
return int(response["total"])
def keep_searching_rulebase(
position, current_section, relative_position, relative_position_is_section
):
position_not_found = position is None
if relative_position_is_section and "above" not in relative_position:
# if 'above' in relative_position then get_number_and_section_from_relative_position returns the previous section
# so there isn't a need to further search for the relative section
relative_section = list(relative_position.values())[0]
return position_not_found or current_section != relative_section
# if relative position is a rule then get_number_and_section_from_relative_position has already entered the section
# (if exists) that the relative rule is in
return position_not_found
def relative_position_is_section(
connection, version, api_call_object, layer_or_package_payload, relative_position
):
if "top" in relative_position or "bottom" in relative_position:
return True
show_section_command = "show-access-section" if 'access' in api_call_object else "show-nat-section"
relative_position_value = list(relative_position.values())[0]
payload = {"name": relative_position_value}
payload.update(layer_or_package_payload)
code, response = send_request(
connection,
version,
show_section_command,
payload,
)
if code == 200:
return True
return False
def get_number_and_section_from_relative_position(
payload,
connection,
version,
rulebase,
above_relative_position,
pos_before_relative_empty_section,
api_call_object,
prev_section=None,
current_section=None,
):
section_name = current_section
position = None
for rules in rulebase:
if "rulebase" in rules:
# cases relevant for relative-position=section
if (
"above" in payload["position"]
and rules["name"] == payload["position"]["above"]
):
if len(rules["rulebase"]) == 0:
position = (
pos_before_relative_empty_section
if above_relative_position
else pos_before_relative_empty_section + 1
)
else:
# if the entire section isn't present in rulebase, the 'from' value of the section might not be
# the first position in the section, which is why we use get_edge_position_in_section
from_value = get_edge_position_in_section(
connection,
version,
list(get_relevant_layer_or_package_identifier(api_call_object, payload).values())[0],
rules["name"],
"from",
)
if from_value is not None: # section exists in rulebase
position = (
max(from_value - 1, 1)
if above_relative_position
else from_value
)
return (
position,
section_name,
above_relative_position,
pos_before_relative_empty_section,
prev_section,
)
# we update this only after the 'above' case since the section that should be returned in that case isn't
# the one we are currently iterating over (but the one beforehand)
prev_section = section_name
section_name = rules["name"]
if (
"bottom" in payload["position"]
and rules["name"] == payload["position"]["bottom"]
):
if len(rules["rulebase"]) == 0:
position = (
pos_before_relative_empty_section
if above_relative_position
else pos_before_relative_empty_section + 1
)
else:
# if the entire section isn't present in rulebase, the 'to' value of the section might not be the
# last position in the section, which is why we use get_edge_position_in_section
to_value = get_edge_position_in_section(
connection,
version,
list(get_relevant_layer_or_package_identifier(api_call_object, payload).values())[0],
section_name,
"to",
)
if to_value is not None and to_value == int(
rules["to"]
): # meaning the entire section is present in rulebase
# is the rule already at the bottom of the section. Can infer this only if the entire section is
# present in rulebase
is_bottom = (
rules["rulebase"][-1]["name"] == payload["name"]
)
position = (
to_value
if (above_relative_position or is_bottom)
else to_value + 1
)
# else: need to keep searching the rulebase, so position=None is returned
return (
position,
section_name,
above_relative_position,
pos_before_relative_empty_section,
prev_section,
)
# setting a rule 'below' a section is equivalent to setting the rule at the top of that section
if (
"below" in payload["position"]
and section_name == payload["position"]["below"]
) or (
"top" in payload["position"]
and section_name == payload["position"]["top"]
):
if len(rules["rulebase"]) == 0:
position = (
pos_before_relative_empty_section
if above_relative_position
else pos_before_relative_empty_section + 1
)
else:
# is the rule already at the top of the section
is_top = rules["rulebase"][0]["name"] == payload["name"]
position = (
max(int(rules["from"]) - 1, 1)
if (above_relative_position or not is_top)
else int(rules["from"])
)
return (
position,
section_name,
above_relative_position,
pos_before_relative_empty_section,
prev_section,
)
if len(rules["rulebase"]) != 0:
# if search_entire_rulebase=True: even if rules['rulebase'] is cut (due to query limit) this will
# eventually be updated to the correct value in further calls
pos_before_relative_empty_section = int(rules["to"])
rules = rules["rulebase"]
for rule in rules:
if payload["name"] == rule["name"]:
above_relative_position = True
# cases relevant for relative-position=rule
if (
"below" in payload["position"]
and rule["name"] == payload["position"]["below"]
):
position = (
int(rule["rule-number"])
if above_relative_position
else int(rule["rule-number"]) + 1
)
return (
position,
section_name,
above_relative_position,
pos_before_relative_empty_section,
prev_section,
)
elif (
"above" in payload["position"]
and rule["name"] == payload["position"]["above"]
):
position = (
max(int(rule["rule-number"]) - 1, 1)
if above_relative_position
else int(rule["rule-number"])
)
return (
position,
section_name,
above_relative_position,
pos_before_relative_empty_section,
prev_section,
)
else: # cases relevant for relative-position=rule
if payload["name"] == rules["name"]:
above_relative_position = True
if (
"below" in payload["position"]
and rules["name"] == payload["position"]["below"]
):
position = (
int(rules["rule-number"])
if above_relative_position
else int(rules["rule-number"]) + 1
)
return (
position,
section_name,
above_relative_position,
pos_before_relative_empty_section,
prev_section,
)
elif (
"above" in payload["position"]
and rules["name"] == payload["position"]["above"]
):
position = (
max(int(rules["rule-number"]) - 1, 1)
if above_relative_position
else int(rules["rule-number"])
)
return (
position,
section_name,
above_relative_position,
pos_before_relative_empty_section,
prev_section,
)