1 # ============LICENSE_START===============================================
2 # Copyright (C) 2021 Nordix Foundation. All rights reserved.
3 # ========================================================================
4 # Licensed under the Apache License, Version 2.0 (the "License");
5 # you may not use this file except in compliance with the License.
6 # You may obtain a copy of the License at
8 # http://www.apache.org/licenses/LICENSE-2.0
10 # Unless required by applicable law or agreed to in writing, software
11 # distributed under the License is distributed on an "AS IS" BASIS,
12 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 # See the License for the specific language governing permissions and
14 # limitations under the License.
15 # ============LICENSE_END=================================================
25 from connexion import NoContent
26 from flask import Flask, request, Response
27 from var_declaration import policy_instances, policy_status, callbacks, forced_settings, policy_fingerprint, hosts_set
28 from utils import calcFingerprint
29 from maincommon import check_apipath, apipath, get_supported_interfaces_response, extract_host_name, is_duplicate_check
32 APPL_JSON='application/json'
33 APPL_PROB_JSON='application/problem+json'
35 # API Function: Get all policy ids
36 def get_all_policy_identities():
38 extract_host_name(hosts_set, request)
40 if ((r := check_modified_response()) is not None):
43 res = list(policy_instances.keys())
44 return Response(json.dumps(res), 200, mimetype=APPL_JSON)
46 # API Function: Create or update a policy
47 def put_policy(policyId):
49 extract_host_name(hosts_set, request)
51 if ((r := check_modified_response()) is not None):
56 data = json.loads(data)
58 pjson=create_problem_json(None, "The policy is corrupt or missing.", 400, None, policyId)
59 return Response(json.dumps(pjson), 400, mimetype=APPL_PROB_JSON)
63 if policyId in policy_instances.keys():
65 if (is_duplicate_check()):
66 fp_previous=calcFingerprint(policy_instances[policyId])
70 if (is_duplicate_check()):
71 fp=calcFingerprint(data)
75 if (fp in policy_fingerprint.keys()):
76 p_id=policy_fingerprint[fp]
77 if (p_id != policyId):
78 pjson=create_problem_json(None, "The policy json already exists.", 400, None, policyId)
79 return Response(json.dumps(pjson), 400, mimetype=APPL_PROB_JSON)
81 if (fp_previous is not None):
82 del policy_fingerprint[fp_previous]
84 policy_fingerprint[fp]=policyId
86 noti=request.args.get('notificationDestination')
87 callbacks[policyId]=noti
89 policy_instances[policyId]=data
91 ps["enforceStatus"] = "UNDEFINED"
92 policy_status[policyId]=ps
95 return Response(json.dumps(data), 200, mimetype=APPL_JSON)
98 headers['Location']='/A1-P/v1/policies/' + policyId
99 return Response(json.dumps(data), 201, headers=headers, mimetype=APPL_JSON)
101 # API Function: Get a policy
102 def get_policy(policyId):
104 extract_host_name(hosts_set, request)
106 if ((r := check_modified_response()) is not None):
109 if policyId in policy_instances.keys():
110 return Response(json.dumps(policy_instances[policyId]), 200, mimetype=APPL_JSON)
112 pjson=create_problem_json(None, "The requested policy does not exist.", 404, None, policyId)
113 return Response(json.dumps(pjson), 404, mimetype=APPL_PROB_JSON)
115 # API Function: Delete a policy
116 def delete_policy(policyId):
118 extract_host_name(hosts_set, request)
120 if ((r := check_modified_response()) is not None):
123 if policyId in policy_instances.keys():
124 if (is_duplicate_check()):
125 fp_previous=calcFingerprint(policy_instances[policyId])
129 policy_fingerprint.pop(fp_previous)
130 policy_instances.pop(policyId)
131 policy_status.pop(policyId)
132 callbacks.pop(policyId)
133 return Response('', 204, mimetype=APPL_JSON)
135 pjson=create_problem_json(None, "The policy identity does not exist.", 404, "No policy instance has been deleted.", policyId)
136 return Response(json.dumps(pjson), 404, mimetype=APPL_PROB_JSON)
138 # API Function: Get status for a policy
139 def get_policy_status(policyId):
141 extract_host_name(hosts_set, request)
143 if ((r := check_modified_response()) is not None):
146 if policyId in policy_instances.keys():
147 return Response(json.dumps(policy_status[policyId]), status=200, mimetype=APPL_JSON)
149 pjson=create_problem_json(None, "The policy identity does not exist.", 404, "There is no existing policy instance with the identity: " + policyId, policyId)
150 return Response(json.dumps(pjson), 404, mimetype=APPL_PROB_JSON)
152 # Helper: Create a response object if forced http response code is set
153 def get_forced_response():
154 if (forced_settings['code'] is not None):
155 pjson=create_error_response(forced_settings['code'])
156 forced_settings['code']=None
157 return Response(json.dumps(pjson), pjson['status'], mimetype=APPL_PROB_JSON)
160 # Helper: Delay if delayed response code is set
162 if (forced_settings['delay'] is not None):
164 val=int(forced_settings['delay'])
169 # Helper: Check if response shall be delayed or a forced response shall be sent
170 def check_modified_response():
172 return get_forced_response()
174 # Helper: Create a problem json object
175 def create_problem_json(type_of, title, status, detail, instance):
178 if type_of is not None:
179 error["type"] = type_of
180 if title is not None:
181 error["title"] = title
182 if status is not None:
183 error["status"] = status
184 if detail is not None:
185 error["detail"] = detail
186 if instance is not None:
187 error["instance"] = instance
190 # Helper: Create a problem json based on a generic http response code
191 def create_error_response(code):
194 return(create_problem_json(None, "Bad request", 400, "Object in payload not properly formulated or not related to the method", None))
196 return(create_problem_json(None, "Not found", 404, "No resource found at the URI", None))
198 return(create_problem_json(None, "Method not allowed", 405, "Method not allowed for the URI", None))
200 return(create_problem_json(None, "Conflict", 409, "Request could not be processed in the current state of the resource", None))
202 return(create_problem_json(None, "Too many requests", 429, "Too many requests have been sent in a given amount of time", None))
204 return(create_problem_json(None, "Insufficient storage", 507, "The method could not be performed on the resource because the provider is unable to store the representation needed to successfully complete the request", None))
206 return(create_problem_json(None, "Service unavailable", 503, "The provider is currently unable to handle the request due to a temporary overload", None))
208 return(create_problem_json(None, "Unknown", code, "Not implemented response code", None))