add: support origin URL in agent installer instructions

agent_controller/agent_controller.c

@@ -1971,24 +1971,32 @@ agent_controller_get_scan_id (const gchar *body)
 /**
  * @brief Retrieves installer instructions for agents.
  *
- * @param[in] conn Active connector to the Agent Controller
- * @param[in] lang_type Language type for the instructions
+ * @param[in] conn Active connector to the Agent Controller.
+ * @param[in] lang_type Language type for the instructions.
+ * @param[in] origin_url Origin URL included in the installer instructions.
+ *                       May be NULL or empty.
  *
  * @return Newly allocated installer instruction struct on success, NULL on
  *         failure. Caller must free with
- * agent_controller_installer_instruction_free().
+ *         agent_controller_installer_instruction_free().
  */
 agent_controller_installer_instruction_t
 agent_controller_get_installer_instruction (agent_controller_connector_t conn,
-                                            instructions_lang_type_t lang_type)
+                                            instructions_lang_type_t lang_type,
+                                            const gchar *origin_url)
 {
+  gvm_http_headers_t *headers;
+  gvm_http_response_t *response;
+  agent_controller_installer_instruction_t instr;
+  gchar *path;
+
   if (!conn)
     {
       g_warning ("%s: Connector is NULL", __func__);
       return NULL;
     }
 
-  gvm_http_headers_t *headers = init_custom_header (conn->apikey, FALSE);
+  headers = init_custom_header (conn->apikey, FALSE);
   if (!headers)
     return NULL;
 
@@ -1998,11 +2006,42 @@ agent_controller_get_installer_instruction (agent_controller_connector_t conn,
       return NULL;
     }
 
-  gchar *path = g_strdup_printf (
-    "/agent-control/public/v2/api/installers/instructions?lang=%s",
-    instructions_lang_type_to_str (lang_type));
+  if (origin_url && *origin_url)
+    {
+      gchar *escaped_origin_url;
 
-  gvm_http_response_t *response =
+      /*
+       * Pass origin_url so the Agent Controller can include the correct server
+       * address in the generated executable installation command.
+       */
+      escaped_origin_url = g_uri_escape_string (origin_url, NULL, FALSE);
+      if (!escaped_origin_url)
+        {
+          gvm_http_headers_free (headers);
+          return NULL;
+        }
+
+      path = g_strdup_printf (
+        "/agent-control/public/v2/api/installers/instructions"
+        "?lang=%s&origin_url=%s",
+        instructions_lang_type_to_str (lang_type), escaped_origin_url);
+
+      g_free (escaped_origin_url);
+    }
+  else
+    {
+      path = g_strdup_printf (
+        "/agent-control/public/v2/api/installers/instructions?lang=%s",
+        instructions_lang_type_to_str (lang_type));
+    }
+
+  if (!path)
+    {
+      gvm_http_headers_free (headers);
+      return NULL;
+    }
+
+  response =
     agent_controller_send_request_with_headers (conn, GET, path, NULL, headers);
 
   gvm_http_headers_free (headers);
@@ -2022,9 +2061,7 @@ agent_controller_get_installer_instruction (agent_controller_connector_t conn,
       return NULL;
     }
 
-  agent_controller_installer_instruction_t instr =
-    agent_controller_installer_instruction_new ();
-
+  instr = agent_controller_installer_instruction_new ();
   if (!instr)
     {
       gvm_http_response_free (response);
@@ -2035,6 +2072,7 @@ agent_controller_get_installer_instruction (agent_controller_connector_t conn,
   instr->instruction = response->data ? g_strdup (response->data) : NULL;
 
   gvm_http_response_free (response);
+
   return instr;
 }
 

agent_controller/agent_controller.h

@@ -359,7 +359,8 @@ agent_controller_parse_scan_agent_config_string (const gchar *);
 
 agent_controller_installer_instruction_t
 agent_controller_get_installer_instruction (agent_controller_connector_t conn,
-                                            instructions_lang_type_t lang_type);
+                                            instructions_lang_type_t lang_type,
+                                            const gchar *origin_url);
 
 agent_controller_support_bundle_t
 agent_controller_download_support_bundle (agent_controller_connector_t conn,

agent_controller/agent_controller_tests.c

@@ -3466,7 +3466,7 @@ Ensure (agent_controller,
   mock_response_data = g_strdup ("{\"instruction\":\"install agent\"}");
 
   agent_controller_installer_instruction_t instr =
-    agent_controller_get_installer_instruction (conn, EN);
+    agent_controller_get_installer_instruction (conn, EN, NULL);
 
   assert_that (instr, is_not_null);
   assert_that (instr->lang_type, is_equal_to (EN));
@@ -3498,7 +3498,7 @@ Ensure (agent_controller,
   mock_response_data = g_strdup ("{\"instruction\":\"agent installieren\"}");
 
   agent_controller_installer_instruction_t instr =
-    agent_controller_get_installer_instruction (conn, DE);
+    agent_controller_get_installer_instruction (conn, DE, NULL);
 
   assert_that (instr, is_not_null);
   assert_that (instr->lang_type, is_equal_to (DE));
@@ -3513,6 +3513,53 @@ Ensure (agent_controller,
   agent_controller_connector_free (conn);
 }
 
+Ensure (agent_controller, get_installer_instruction_includes_encoded_origin_url)
+{
+  agent_controller_connector_t conn = make_conn ();
+
+  mock_http_status = 200;
+  mock_response_data = g_strdup ("{\"instruction\":\"install agent\"}");
+
+  agent_controller_installer_instruction_t instr =
+    agent_controller_get_installer_instruction (
+      conn, EN, "https://example.com:8443/gsa/path?foo=bar&value=one two");
+
+  assert_that (instr, is_not_null);
+  assert_that (instr->lang_type, is_equal_to (EN));
+  assert_that (instr->instruction,
+               is_equal_to_string ("{\"instruction\":\"install agent\"}"));
+
+  assert_that (last_sent_url,
+               is_equal_to_string (
+                 "http://localhost:8081/agent-control/public/"
+                 "v2/api/installers/instructions?lang=en"
+                 "&origin_url=https%3A%2F%2Fexample.com%3A8443%2Fgsa%2Fpath"
+                 "%3Ffoo%3Dbar%26value%3Done%20two"));
+
+  agent_controller_installer_instruction_free (instr);
+  agent_controller_connector_free (conn);
+}
+
+Ensure (agent_controller, get_installer_instruction_omits_empty_origin_url)
+{
+  agent_controller_connector_t conn = make_conn ();
+
+  mock_http_status = 200;
+  mock_response_data = g_strdup ("{\"instruction\":\"install agent\"}");
+
+  agent_controller_installer_instruction_t instr =
+    agent_controller_get_installer_instruction (conn, EN, "");
+
+  assert_that (instr, is_not_null);
+
+  assert_that (last_sent_url,
+               is_equal_to_string ("http://localhost:8081/agent-control/public/"
+                                   "v2/api/installers/instructions?lang=en"));
+
+  agent_controller_installer_instruction_free (instr);
+  agent_controller_connector_free (conn);
+}
+
 Ensure (agent_controller,
         get_installer_instruction_returns_null_when_request_fails)
 {
@@ -3522,7 +3569,7 @@ Ensure (agent_controller,
   g_clear_pointer (&mock_response_data, g_free);
 
   agent_controller_installer_instruction_t instr =
-    agent_controller_get_installer_instruction (conn, EN);
+    agent_controller_get_installer_instruction (conn, EN, NULL);
 
   assert_that (instr, is_null);
   assert_that (last_sent_url,
@@ -3532,6 +3579,28 @@ Ensure (agent_controller,
   agent_controller_connector_free (conn);
 }
 
+Ensure (agent_controller,
+        get_installer_instruction_returns_null_when_request_with_origin_fails)
+{
+  agent_controller_connector_t conn = make_conn ();
+
+  mock_http_status = 500;
+  g_clear_pointer (&mock_response_data, g_free);
+
+  agent_controller_installer_instruction_t instr =
+    agent_controller_get_installer_instruction (conn, DE,
+                                                "https://example.com");
+
+  assert_that (instr, is_null);
+
+  assert_that (last_sent_url,
+               is_equal_to_string ("http://localhost:8081/agent-control/public/"
+                                   "v2/api/installers/instructions?lang=de"
+                                   "&origin_url=https%3A%2F%2Fexample.com"));
+
+  agent_controller_connector_free (conn);
+}
+
 Ensure (agent_controller, content_disposition_filename_extracts_filename)
 {
   const gchar *header =
@@ -4212,6 +4281,13 @@ main (int argc, char **argv)
   add_test_with_context (
     suite, agent_controller,
     get_installer_instruction_returns_null_when_request_fails);
+  add_test_with_context (suite, agent_controller,
+                         get_installer_instruction_includes_encoded_origin_url);
+  add_test_with_context (suite, agent_controller,
+                         get_installer_instruction_omits_empty_origin_url);
+  add_test_with_context (
+    suite, agent_controller,
+    get_installer_instruction_returns_null_when_request_with_origin_fails);
 
   add_test_with_context (suite, agent_controller,
                          content_disposition_filename_extracts_filename);