refactor naming of endpoints (#34)

Author: enriquetomasmb

nebula/addons/reporter.py

@@ -54,7 +54,7 @@ def __init__(self, config, trainer, cm: "CommunicationsManager"):
         self.frequency = self.config.participant["reporter_args"]["report_frequency"]
         self.grace_time = self.config.participant["reporter_args"]["grace_time_reporter"]
         self.data_queue = asyncio.Queue()
-        self.url = f"http://{self.config.participant['scenario_args']['controller']}/nebula/dashboard/{self.config.participant['scenario_args']['name']}/node/update"
+        self.url = f"http://{self.config.participant['scenario_args']['controller']}/platform/dashboard/{self.config.participant['scenario_args']['name']}/node/update"
         self.counter = 0
 
         self.first_net_metrics = True
@@ -157,7 +157,7 @@ async def report_scenario_finished(self):
               might be temporarily overloaded.
             - Logs exceptions if the connection attempt to the controller fails.
         """
-        url = f"http://{self.config.participant['scenario_args']['controller']}/nebula/dashboard/{self.config.participant['scenario_args']['name']}/node/done"
+        url = f"http://{self.config.participant['scenario_args']['controller']}/platform/dashboard/{self.config.participant['scenario_args']['name']}/node/done"
         data = json.dumps({"idx": self.config.participant["device_args"]["idx"]})
         headers = {
             "Content-Type": "application/json",

nebula/addons/waf/default.conf

@@ -15,27 +15,27 @@ server {
     set $upstream http://nebula_nebula-frontend; # Change this
     set $always_redirect off;
     modsecurity on;
-    location /nebula {
+    location /platform {
         client_max_body_size 0;
 
         if ($always_redirect = on) {
             return 301 https://$host$request_uri;
         }
 
         modsecurity_rules '
-            SecRule REQUEST_URI "@beginsWith /nebula/socket.io/" "id:4200000,phase:1,allow,nolog"
+            SecRule REQUEST_URI "@beginsWith /platform/socket.io/" "id:4200000,phase:1,allow,nolog"
         ';
 
         modsecurity_rules '
-            SecRule REQUEST_URI "@beginsWith /nebula/ws/" "id:4200001,phase:1,allow,nolog"
+            SecRule REQUEST_URI "@beginsWith /platform/ws/" "id:4200001,phase:1,allow,nolog"
         ';
 
         modsecurity_rules '
-            SecRule REQUEST_URI "@beginsWith /nebula/dashboard/deployment/run" "id:4200005,phase:1,nolog,pass,ctl:ruleRemoveById=200007"
+            SecRule REQUEST_URI "@beginsWith /platform/dashboard/deployment/run" "id:4200005,phase:1,nolog,pass,ctl:ruleRemoveById=200007"
         ';
 
         modsecurity_rules '
-            SecRule REQUEST_URI "@beginsWith /nebula/dashboard/deployment/run" "id:4200006,phase:2,nolog,pass,ctl:ruleRemoveById=200002"
+            SecRule REQUEST_URI "@beginsWith /platform/dashboard/deployment/run" "id:4200006,phase:2,nolog,pass,ctl:ruleRemoveById=200002"
         ';
 
         # modsecurity_rules "

nebula/core/network/communications.py

@@ -40,8 +40,8 @@ def __init__(self, engine: "Engine"):
         self.config = engine.get_config()
         self.id = str(self.config.participant["device_args"]["idx"])
 
-        self.register_endpoint = f"http://{self.config.participant['scenario_args']['controller']}/nebula/dashboard/{self.config.participant['scenario_args']['name']}/node/register"
-        self.wait_endpoint = f"http://{self.config.participant['scenario_args']['controller']}/nebula/dashboard/{self.config.participant['scenario_args']['name']}/node/wait"
+        self.register_endpoint = f"http://{self.config.participant['scenario_args']['controller']}/platform/dashboard/{self.config.participant['scenario_args']['name']}/node/register"
+        self.wait_endpoint = f"http://{self.config.participant['scenario_args']['controller']}/platform/dashboard/{self.config.participant['scenario_args']['name']}/node/wait"
 
         self._connections = {}
         self.connections_lock = Locker(name="connections_lock", async_lock=True)

nebula/frontend/app.py

@@ -99,7 +99,7 @@ <h3>Manage Existing Accounts</h3>
         var role = $(this).data('user-role');
         $('#user-modal-title').text('Update Account');
         $('#user-modal-content').html(
-            '<form action="/nebula/user/update" method="POST">' +
+            '<form action="/platform/user/update" method="POST">' +
             '<div class="form-group">' +
             '<label>Username:</label>' +
             '<p>' + user + '</p>' +

nebula/frontend/templates/admin.html

@@ -246,7 +246,7 @@ <h3>Scenarios in the database</h3>
 
 <!-- <script>
     setInterval(function () {
-        fetch('/nebula/api/dashboard/runningscenario')
+        fetch('/platform/api/dashboard/runningscenario')
             .then(response => response.json())
             .then(data => {
                 if (data.name) {
@@ -266,7 +266,7 @@ <h3>Scenarios in the database</h3>
         $('#confirm-modal #confirm-modal-body').html('Are you sure you want to relaunch the scenario ' + scenario_title + '?');
 
         $('#confirm-modal #yes-button').off('click').on('click', function () {
-            const response = fetch('/nebula/dashboard/' + scenario_name + '/relaunch', {
+            const response = fetch('/platform/dashboard/' + scenario_name + '/relaunch', {
                 method: 'GET'
             })
                 .then(response => {
@@ -294,7 +294,7 @@ <h3>Scenarios in the database</h3>
         $('#confirm-modal #confirm-modal-body').html('Are you sure you want to remove the scenario ' + scenario_name + '?<br><br><p class="badge text-bg-danger">Warning: you will remove the scenario from the database</p>');
 
         $('#confirm-modal #yes-button').off('click').on('click', function () {
-            const response = fetch('/nebula/dashboard/' + scenario_name + '/remove', {
+            const response = fetch('/platform/dashboard/' + scenario_name + '/remove', {
                 method: 'GET'
             })
                 .then(response => {
@@ -341,7 +341,7 @@ <h3>Scenarios in the database</h3>
 
         if (notesRow.style.display === 'none') {
             try {
-                const response = await fetch('/nebula/dashboard/' + scenarioName + '/notes');
+                const response = await fetch('/platform/dashboard/' + scenarioName + '/notes');
                 const data = await response.json();
                 console.log(data);
 
@@ -366,7 +366,7 @@ <h3>Scenarios in the database</h3>
 
         if (configRow.style.display === 'none') {
             try {
-                const response = await fetch(`/nebula/dashboard/${scenarioName}/config`);
+                const response = await fetch(`/platform/dashboard/${scenarioName}/config`);
                 const data = await response.json();
 
                 if (data.status === 'success') {
@@ -386,7 +386,7 @@ <h3>Scenarios in the database</h3>
     async function saveNotes(scenarioName) {
         const notesText = document.getElementById('notes-text-' + scenarioName).value;
 
-        const response = await fetch('/nebula/dashboard/' + scenarioName + '/save_note', {
+        const response = await fetch('/platform/dashboard/' + scenarioName + '/save_note', {
             method: 'POST',
             headers: {
                 'Content-Type': 'application/json',

nebula/frontend/templates/dashboard.html

@@ -2130,7 +2130,7 @@ <h5 class="step-title">Schema of deployment</h5>
     <script>
         // Send configuration to the server for deployment
 
-        // When click "run-btn" button, create a POST request to /nebula/dashboard/deployment/run with JSON data
+        // When click "run-btn" button, create a POST request to /platform/dashboard/deployment/run with JSON data
         document.getElementById("run-btn").addEventListener("click", function () {
 
             // Show the modal
@@ -2166,7 +2166,7 @@ <h5 class="step-title">Schema of deployment</h5>
                     document.querySelector(".overlay").style.display = "block";
                     document.getElementById("spinner").style.display = "block";
 
-                    fetch("/nebula/dashboard/deployment/run", {
+                    fetch("/platform/dashboard/deployment/run", {
                         method: "POST",
                         headers: {
                             'Content-Type': 'application/json'
@@ -2603,7 +2603,7 @@ <h5 class="step-title">Schema of deployment</h5>
             let textAreas = "";
             for (let i = 0; i < numberOfNodes; i++) {
                 textAreas += `<h4>Participant ${i}</h4>`;
-                let response = await fetch(`/nebula/dashboard/deployment/participant/file`);
+                let response = await fetch(`/platform/dashboard/deployment/participant/file`);
                 let json = await response.json();
                 textAreas += `<textarea class="form-control" rows="10" cols="50" style="width:100%;" name="participant${i}">${JSON.stringify(json, null, 4)}</textarea>`;
                 // textAreas += `<textarea class="form-control" rows="10" cols="50" name="scenario" id="scenario" style="width:100%;"></textarea>`;

nebula/frontend/templates/deployment.html

@@ -112,7 +112,7 @@
         var host = window.location.hostname;
         var port = window.location.port ? ':' + window.location.port : '';
         var protocol = window.location.protocol === 'https:' ? 'wss:' : 'ws:';
-        var socket = new WebSocket(protocol + '//' + host + port + '/nebula/ws/' + client_id);
+        var socket = new WebSocket(protocol + '//' + host + port + '/platform/ws/' + client_id);
     </script>
 </head>
 
@@ -121,7 +121,7 @@
         <div class="container d-flex align-items-center justify-content-between">
 
             <h1 class="logo">
-                <a href="/nebula" style="white-space: nowrap;">
+                <a href="/platform" style="white-space: nowrap;">
                     <img src="{{ url_for('static', path='images/nebula-icon-white.svg') }}" alt="Nebula Icon"
                         style="height: 50px; margin-right: 5px;">
                     NEBULA
@@ -131,7 +131,7 @@ <h1 class="logo">
             <nav id="navbar" class="navbar">
                 <ul>
                     <li><a class="nav-link scrollto {% if request.path == '/' %}active{% endif %}"
-                            href="/nebula">Home</a>
+                            href="/platform">Home</a>
                     </li>
                     <li><a class="nav-link scrollto" href="https://github.com/CyberDataLab/nebula">Source Code</a>
                     </li>
@@ -149,7 +149,7 @@ <h1 class="logo">
                         <a class="nav-link dropdown-toggle" href="#" id="navbarLoginDropdown">Login</a>
                         <ul>
                             <li>
-                                <form id="login-form" action="/nebula/login" method="post" class="px-4 py-3">
+                                <form id="login-form" action="/platform/login" method="post" class="px-4 py-3">
                                     <div class="mb-3">
                                         <label for="dropdownLoginFormUsername">Username</label>
                                         <input type="text" name="user" class="form-control"
@@ -226,15 +226,15 @@ <h1 class="logo">
 
                 const formData = new FormData(loginForm);
 
-                fetch("/nebula/login", {
+                fetch("/platform/login", {
                     method: "POST",
                     body: formData,
                 })
                     .then((response) => {
                         if (!response.ok) {
                             showAlert('danger', 'Invalid credentials');
                         } else {
-                            window.location.replace("/nebula");
+                            window.location.replace("/platform");
                         }
                     })
                     .catch((error) => {

nebula/frontend/templates/layout.html

@@ -86,29 +86,29 @@ <h3>Nodes in the database</h3>
                                         {% if hash %}
                                         <li>
                                             <a class="dropdown-item"
-                                                href="/nebula/dashboard/{{ scenario_name }}/node/{{ hash }}/metrics">
+                                                href="/platform/dashboard/{{ scenario_name }}/node/{{ hash }}/metrics">
                                                 <i class="fa fa-bar-chart"></i>
                                                 Real-time metrics
                                             </a>
                                         </li>
                                         {% endif %}
                                         <li>
                                             <a class="dropdown-item download"
-                                                href="/nebula/dashboard/{{ scenario_name }}/node/{{ idx }}/infolog">
+                                                href="/platform/dashboard/{{ scenario_name }}/node/{{ idx }}/infolog">
                                                 <i class="fa fa-download"></i>
                                                 Download INFO logs
                                             </a>
                                         </li>
                                         <li>
                                             <a class="dropdown-item download"
-                                                href="/nebula/dashboard/{{ scenario_name }}/node/{{ idx }}/debuglog">
+                                                href="/platform/dashboard/{{ scenario_name }}/node/{{ idx }}/debuglog">
                                                 <i class="fa fa-download"></i>
                                                 Download DEBUG logs
                                             </a>
                                         </li>
                                         <li>
                                             <a class="dropdown-item download"
-                                                href="/nebula/dashboard/{{ scenario_name }}/node/{{ idx }}/errorlog">
+                                                href="/platform/dashboard/{{ scenario_name }}/node/{{ idx }}/errorlog">
                                                 <i class="fa fa-download"></i>
                                                 Download ERROR logs
                                             </a>
@@ -347,14 +347,14 @@ <h3>Topology</h3>
     var droneLines = {};
 
     var droneIcon = L.icon({
-        iconUrl: '/nebula/static/images/drone.svg',
+        iconUrl: '/platform/static/images/drone.svg',
         iconSize: [38, 38], // Icon size
         iconAnchor: [19, 19], // Icon point that will correspond to the marker coordinate
         popupAnchor: [0, -19] // Where the popup will be displayed in relation to the icon
     });
 
     var droneIconOffline = L.icon({
-        iconUrl: '/nebula/static/images/drone_offline.svg',
+        iconUrl: '/platform/static/images/drone_offline.svg',
         iconSize: [38, 38], // Icon size
         iconAnchor: [19, 19], // Icon point that will correspond to the marker coordinate
         popupAnchor: [0, -19] // Where the popup will be displayed in relation to the icon
@@ -504,7 +504,7 @@ <h3>Topology</h3>
     var scenario_name = document.getElementById('scenario_name').innerHTML;
 
     // Get the table
-    fetch('/nebula/api/dashboard/' + scenario_name + '/monitor')
+    fetch('/platform/api/dashboard/' + scenario_name + '/monitor')
         .then(function (response) {
             if (!response.ok) {
                 showAlert("danger", "Error: " + response.status + " " + response.statusText);
@@ -681,8 +681,8 @@ <h3>Topology</h3>
             node_row.appendChild(status);
         }
         status.innerHTML = nodeData.status ? '<span class="badge text-bg-success">Online</span>' : '<span class="badge text-bg-danger">Offline</span>';
-        // Request /nebula/api/dashboard/{{ scenario_name }}/monitor to get only the status of the node
-        fetch('/nebula/api/dashboard/' + nodeData.scenario_name + '/monitor')
+        // Request /platform/api/dashboard/{{ scenario_name }}/monitor to get only the status of the node
+        fetch('/platform/api/dashboard/' + nodeData.scenario_name + '/monitor')
             .then(function (response) {
                 if (!response.ok) {
                     showAlert("danger", "Error: " + response.status + " " + response.statusText);