# ============LICENSE_START===============================================
-# Copyright (C) 2020 Nordix Foundation. All rights reserved.
+# Copyright (C) 2021-2023 Nordix Foundation. All rights reserved.
+# Copyright (C) 2023 OpenInfra Foundation Europe. All rights reserved.
# ========================================================================
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# ============LICENSE_END=================================================
#
-import connexion
import json
import sys
import os
import requests
+from connexion.resolver import RelativeResolver
from pathlib import Path
-from flask import Flask, escape, request, Response
-from jsonschema import validate
-from var_declaration import policy_instances, policy_types, policy_status, policy_fingerprint, forced_settings, hosts_set
-from maincommon import *
+from flask import request, Response, jsonify
+from var_declaration import policy_instances, policy_types, policy_status, callbacks, policy_fingerprint, forced_settings, hosts_set, app, data_delivery
+from models.enforceStatus import EnforceStatus
+from maincommon import check_apipath, get_supported_interfaces_response
+from time import sleep
+# Constants
+TEXT_PLAIN = 'text/plain'
+APPL_JSON = 'application/json'
+
check_apipath()
-app = connexion.FlaskApp(__name__, specification_dir=apipath)
+# app is created in var_declarations
-#Check alive function
+# Check alive function
@app.route('/', methods=['GET'])
def test():
+ return Response("OK", 200, mimetype=TEXT_PLAIN)
- return Response("OK", 200, mimetype='text/plain')
+@app.route('/ip', methods=['GET'])
+def get_ip():
+ if request.environ.get('HTTP_X_FORWARDED_FOR') is None:
+ return jsonify({'ip': request.environ['REMOTE_ADDR']}), 200
+ else:
+ return jsonify({'ip': request.environ['HTTP_X_FORWARDED_FOR']}), 200
#Return the current and all supported yamls for the this container
@app.route('/container_interfaces', methods=['GET'])
def container_interfaces():
-
return get_supported_interfaces_response()
#Delete all created instances and status
@app.route('/deleteinstances', methods=['POST'])
def deleteinstances():
-
for i in policy_instances.keys():
policy_instances[i]={}
policy_status.clear()
+ callbacks.clear()
forced_settings.clear()
forced_settings['code']=None
forced_settings['delay']=None
policy_fingerprint.clear()
- return Response("All policy instances deleted", 200, mimetype='text/plain')
+ return Response("All policy instances deleted", 200, mimetype=TEXT_PLAIN)
#Delete all - all reset
@app.route('/deleteall', methods=['POST'])
def deleteall():
-
policy_instances.clear()
policy_types.clear()
policy_status.clear()
+ callbacks.clear()
forced_settings['code']=None
forced_settings['delay']=None
policy_fingerprint.clear()
- return Response("All policy instances and types deleted", 200, mimetype='text/plain')
+ data_delivery.clear()
+ return Response("All policy instances and types deleted", 200, mimetype=TEXT_PLAIN)
#Load a policy type
@app.route('/policytype', methods=['PUT'])
def policytype():
- policyTypeId=request.args.get('id')
- if (policyTypeId is None):
- return Response('Parameter <id> missing in request', status=400, mimetype='text/plain')
+ policy_type_id=request.args.get('id')
+ if (policy_type_id is None):
+ return Response('Parameter <id> missing in request', status=400, mimetype=TEXT_PLAIN)
try:
- val=int(policyTypeId)
- except:
- return Response("The policy type id is not an int", 400, mimetype='text/plain')
+ int(policy_type_id)
+ except Exception:
+ return Response("The policy type id is not an int", 400, mimetype=TEXT_PLAIN)
try:
data = request.data
data = json.loads(data)
- except:
- return Response("The policy type is corrupt or missing", 400, mimetype='text/plain')
+ except Exception:
+ return Response("The policy type is corrupt or missing", 400, mimetype=TEXT_PLAIN)
if ('name' not in data.keys() or 'description' not in data.keys() or 'policy_type_id' not in data.keys() or'create_schema' not in data.keys()):
- return Response("The policy type missing atributes", 400, mimetype='text/plain')
+ return Response("The policy type missing atributes", 400, mimetype=TEXT_PLAIN)
retcode=201
- if (policyTypeId in policy_types.keys()):
+ if (policy_type_id in policy_types.keys()):
retcode=200
- if (len(policy_instances[policyTypeId]) > 0):
- return Response("The policy type already exists and instances exists", 400, mimetype='text/plain')
+ if (len(policy_instances[policy_type_id]) > 0):
+ return Response("The policy type already exists and instances exists", 400, mimetype=TEXT_PLAIN)
- policy_types[policyTypeId]=data
- policy_instances[policyTypeId]={}
- return Response("Policy type " + policyTypeId + " is OK.", retcode, mimetype='text/plain')
+ policy_types[policy_type_id]=data
+ policy_instances[policy_type_id]={}
+ return Response("Policy type " + policy_type_id + " is OK.", retcode, mimetype=TEXT_PLAIN)
#Delete a policy type
@app.route('/policytype', methods=['DELETE'])
def del_policytype():
- policyTypeId=request.args.get('id')
- if (policyTypeId is None):
- return Response('Parameter <id> missing in request', status=400, mimetype='text/plain')
+ policy_type_id=request.args.get('id')
+ if (policy_type_id is None):
+ return Response('Parameter <id> missing in request', status=400, mimetype=TEXT_PLAIN)
try:
- val=int(policyTypeId)
- except:
- return Response("The policy type id is not an int", 400, mimetype='text/plain')
+ int(policy_type_id)
+ except Exception:
+ return Response("The policy type id is not an int", 400, mimetype=TEXT_PLAIN)
- if (policyTypeId in policy_types.keys()):
- if (len(policy_instances[policyTypeId]) > 0):
- return Response("The policy type already exists and instances exists", 400, mimetype='text/plain')
+ if (policy_type_id in policy_types.keys()):
+ if (len(policy_instances[policy_type_id]) > 0):
+ return Response("The policy type already exists and instances exists", 400, mimetype=TEXT_PLAIN)
- del policy_types[policyTypeId]
- del policy_instances[policyTypeId]
- return Response("Policy type " + policyTypeId + " is OK.", 204, mimetype='text/plain')
+ del policy_types[policy_type_id]
+ del policy_instances[policy_type_id]
+ return Response("Policy type " + policy_type_id + " is OK.", 204, mimetype=TEXT_PLAIN)
- return Response("Policy type " + policyTypeId + " not found.", 204, mimetype='text/plain')
+ return Response("Policy type " + policy_type_id + " not found.", 204, mimetype=TEXT_PLAIN)
# Get all policy type ids
@app.route('/policytypes', methods=['GET'])
def get_policytype_ids():
-
return (json.dumps(list(policy_instances.keys())), 200)
#Set force response for one A1 response
try:
forced_settings['code']=int(request.args.get('code'))
- except:
+ except Exception:
forced_settings['code']=None
- return Response("Force response code: " + str(forced_settings['code']) + " set for one single A1 response", 200, mimetype='text/plain')
+ return Response("Force response code: " + str(forced_settings['code']) + " set for one single A1 response", 200, mimetype=TEXT_PLAIN)
#Set force delay response, in seconds, for all A1 responses
#/froceesponse?delay=<seconds>
try:
forced_settings['delay']=int(request.args.get('delay'))
- except:
+ except Exception:
forced_settings['delay']=None
- return Response("Force delay: " + str(forced_settings['delay']) + " sec set for all A1 responses", 200, mimetype='text/plain')
+ return Response("Force delay: " + str(forced_settings['delay']) + " sec set for all A1 responses", 200, mimetype=TEXT_PLAIN)
-#Set status and reason
-#/status?policyid=<policyid>&status=<status>[&deleted=<boolean>][&created_at=<timestamp>]
+# Set status and reason
+#/status?policyid=<policyid>&status=<status>[&reason=<reason>]
@app.route('/status', methods=['PUT'])
def setstatus():
- policyId=request.args.get('policyid')
- if (policyId is None):
- return Response('Parameter <policyid> missing in request', status=400, mimetype='text/plain')
+ policy_id=request.args.get('policyid')
+ if (policy_id is None):
+ return Response('Parameter <policyid> missing in request', status=400, mimetype=TEXT_PLAIN)
+ if policy_id not in policy_status.keys():
+ return Response('Policyid: '+policy_id+' not found.', status=404, mimetype=TEXT_PLAIN)
- if policyId not in policy_status.keys():
- return Response('Policyid: '+policyId+' not found.', status=404, mimetype='text/plain')
status=request.args.get('status')
if (status is None):
- return Response('Parameter <status> missing in request', status=400, mimetype='text/plain')
- policy_status[policyId]["instance_status"]=status
- msg = "Status set to "+status
- deleted_policy=request.args.get('deleted')
- if (deleted_policy is not None):
- policy_status[policyId]["has_been_deleted"]=deleted_policy
- msg = msg + " and has_been_deleted set to "+deleted_policy
- created_at = request.args.get('created_at')
- if (created_at is not None):
- policy_status[policyId]["created_at"]=created_at
- msg = msg + " and created_at set to "+created_at
- msg=msg + " for policy: " + policyId
- return Response(msg, 200, mimetype='text/plain')
-
-
-#Metrics function
-#Get a named counter
+ return Response('Parameter <status> missing in request', status=400, mimetype=TEXT_PLAIN)
+
+ enforceStatus = EnforceStatus()
+ try:
+ enforceStatus.enforce_status = status
+ msg = "Status set to " + status
+
+ reason = request.args.get('reason')
+ if (reason is not None):
+ enforceStatus.enforce_reason = reason
+ msg = msg + " and " + reason
+
+ policy_status[policy_id] = enforceStatus.to_dict()
+ msg = msg + " for policy: " + policy_id
+ except ValueError as error:
+ return Response(str(error), status=400, mimetype=TEXT_PLAIN)
+
+ return Response(msg, 200, mimetype=TEXT_PLAIN)
+
+# Metrics function
+# Get a named counter
@app.route('/counter/<string:countername>', methods=['GET'])
-def getCounter(countername):
+def getcounter(countername):
if (countername == "num_instances"):
- return Response(str(len(policy_fingerprint)), 200, mimetype='text/plain')
+ return Response(str(len(policy_fingerprint)), 200, mimetype=TEXT_PLAIN)
elif (countername == "num_types"):
- return Response(str(len(policy_instances)),200, mimetype='text/plain')
+ return Response(str(len(policy_instances)),200, mimetype=TEXT_PLAIN)
elif (countername == "interface"):
p=Path(os.getcwd())
pp=p.parts
- return Response(str(pp[len(pp)-1]),200, mimetype='text/plain')
+ return Response(str(pp[len(pp)-1]),200, mimetype=TEXT_PLAIN)
elif (countername == "remote_hosts"):
hosts=",".join(hosts_set)
return str(hosts),200
+ elif (countername == "datadelivery"):
+ data_delivery_counter = str(len(data_delivery))
+ return Response(data_delivery_counter,200, mimetype=TEXT_PLAIN)
else:
- return Response("Counter name: "+countername+" not found.",404, mimetype='text/plain')
+ return Response("Counter name: "+countername+" not found.",404, mimetype=TEXT_PLAIN)
-port_number = 8085
-if len(sys.argv) >= 2:
+port_number = 2222
+if len(sys.argv) >= 2 :
if isinstance(sys.argv[1], int):
port_number = sys.argv[1]
-port_number_secure=8185
-app.add_api('openapi.yaml')
-context=get_security_context()
-if (context == None):
- print("Start on non-secure port: "+str(port_number))
- app.run(port=port_number, host="::")
-else:
- print("Start on secure port: "+str(port_number_secure))
- app.run(port=port_number_secure, host="::", ssl_context=context)
\ No newline at end of file
+# Send status
+# /sendstatus?policyid=<policyid>
+@app.route('/sendstatus', methods=['POST'])
+def sendstatus():
+ policyid = request.args.get('policyid')
+ if policyid is None:
+ return Response('Parameter <policyid> missing in request', status=400, mimetype=TEXT_PLAIN)
+ if policyid not in policy_status.keys():
+ return Response('Policyid: '+policyid+' not found.', status=404, mimetype=TEXT_PLAIN)
+
+ ps = policy_status[ policyid ]
+ cb_url = callbacks[ policyid ]
+
+ try:
+ resp = requests.post(cb_url, json = json.dumps(ps), headers = { "Content-Type": APPL_JSON, "Accept": "*/*" })
+ resp.raise_for_status()
+ if (resp.status_code >= 200 and resp.status_code <= 300):
+ return Response("OK", resp.status_code, mimetype = TEXT_PLAIN)
+ return Response('Post status failed', status = resp.status_code, mimetype = TEXT_PLAIN)
+
+ except requests.ConnectionError as error:
+ return Response('Post status failed with Connection Error, could not send to ' + str(cb_url), status = 502, mimetype = TEXT_PLAIN)
+ except requests.Timeout as error:
+ return Response('Post status failed with Timeout, could not send to ' + str(cb_url), status = 504, mimetype = TEXT_PLAIN)
+ except requests.HTTPError as error:
+ return Response('Post status failed with HTTP Error, could not send to ' + str(cb_url), status = 502, mimetype = TEXT_PLAIN)
+ except requests.RequestException as error:
+ return Response('Post status failed with RequestException, could not send to ' + str(cb_url), status = 500, mimetype = TEXT_PLAIN)
+
+# Receive status (only for testing callbacks)
+# /statustest
+@app.route('/statustest', methods=['POST', 'PUT'])
+def statustest():
+ try:
+ data = request.data
+ data = json.loads(data)
+ except Exception:
+ return Response("The status data is corrupt or missing.", 400, mimetype=TEXT_PLAIN)
+
+ return Response("OK", 201, mimetype=TEXT_PLAIN)
+
+app.add_api('openapi.yaml', resolver=RelativeResolver('controllers.a1_mediator_controller'))
+
+if __name__ == '__main__':
+ app.run(port=port_number, host="127.0.0.1")
\ No newline at end of file
Code Review / sim / a1-interface.git / blobdiff