[NetworkManager-openconnect] Add User Agent to Openconnect VPN for NetworkManager

[David Woodhouse <dwmw2 src gnome org>]

commit b5e154c06fd9013a925f85c2aa38d88e4ee53db0
Author: Debasish Patra <patradebasish1987 gmail com>
Date:   Sat Aug 29 17:58:16 2020 -0400

    Add User Agent to Openconnect VPN for NetworkManager

 auth-dialog/main.c                        |  3 +-
 properties/nm-openconnect-dialog.ui       | 73 ++++++++++++++++++++++++-------
 properties/nm-openconnect-editor-plugin.c |  5 +++
 properties/nm-openconnect-editor.c        | 15 +++++++
 shared/nm-service-defines.h               |  1 +
 5 files changed, 79 insertions(+), 18 deletions(-)
---
diff --git a/auth-dialog/main.c b/auth-dialog/main.c
index 99cab7c..305b568 100644
--- a/auth-dialog/main.c
+++ b/auth-dialog/main.c
@@ -1853,6 +1853,7 @@ static void build_main_dialog(auth_ui_data *ui_data)
 
 static auth_ui_data *init_ui_data (char *vpn_name, GHashTable *options, GHashTable *secrets, char *vpn_uuid)
 {
+       char *vpn_useragent = g_hash_table_lookup(options, "useragent");
        auth_ui_data *ui_data;
 
        ui_data = g_slice_new0(auth_ui_data);
@@ -1883,7 +1884,7 @@ static auth_ui_data *init_ui_data (char *vpn_name, GHashTable *options, GHashTab
        g_unix_set_fd_nonblocking(ui_data->cancel_pipes[0], TRUE, NULL);
        g_unix_set_fd_nonblocking(ui_data->cancel_pipes[1], TRUE, NULL);
 
-       ui_data->vpninfo = (void *)openconnect_vpninfo_new("OpenConnect VPN Agent (NetworkManager)",
+       ui_data->vpninfo = (void *)openconnect_vpninfo_new(vpn_useragent ?: "OpenConnect VPN Agent 
(NetworkManager)",
                                                           validate_peer_cert, write_new_config,
                                                           nm_process_auth_form, write_progress,
                                                           ui_data);
diff --git a/properties/nm-openconnect-dialog.ui b/properties/nm-openconnect-dialog.ui
index 43beb44..f32afcd 100644
--- a/properties/nm-openconnect-dialog.ui
+++ b/properties/nm-openconnect-dialog.ui
@@ -105,6 +105,45 @@
         <property name="top_attach">2</property>
       </packing>
     </child>
+    <child>
+      <object class="GtkLabel" id="useragent_label">
+        <property name="visible">True</property>
+        <property name="label" translatable="yes">_User Agent:</property>
+        <property name="use_underline">True</property>
+        <property name="use_markup">False</property>
+        <property name="justify">GTK_JUSTIFY_LEFT</property>
+        <property name="wrap">False</property>
+        <property name="selectable">False</property>
+        <property name="xalign">1</property>
+        <property name="yalign">0.5</property>
+        <property name="mnemonic_widget">user_agent_entry</property>
+        <property name="ellipsize">PANGO_ELLIPSIZE_NONE</property>
+        <property name="width_chars">-1</property>
+        <property name="single_line_mode">False</property>
+      </object>
+      <packing>
+        <property name="left_attach">0</property>
+        <property name="top_attach">3</property>
+      </packing>
+    </child>
+     <child>
+      <object class="GtkEntry" id="user_agent_entry">
+        <property name="visible">True</property>
+        <property name="can_focus">True</property>
+        <property name="editable">True</property>
+        <property name="visibility">True</property>
+        <property name="max_length">0</property>
+        <property name="text"/>
+        <property name="has_frame">True</property>
+        <property name="invisible_char">&#x2022;</property>
+        <property name="activates_default">False</property>
+        <property name="hexpand">True</property>
+      </object>
+      <packing>
+        <property name="left_attach">1</property>
+        <property name="top_attach">3</property>
+      </packing>
+    </child>
     <child>
       <object class="NmaCertChooser" id="ca_chooser">
         <property name="flags">13</property>
@@ -114,7 +153,7 @@
       </object>
       <packing>
         <property name="left-attach">0</property>
-        <property name="top-attach">3</property>
+        <property name="top-attach">4</property>
         <property name="width">2</property>
       </packing>
     </child>
@@ -136,7 +175,7 @@
       </object>
       <packing>
         <property name="left_attach">0</property>
-        <property name="top_attach">4</property>
+        <property name="top_attach">5</property>
       </packing>
     </child>
     <child>
@@ -154,7 +193,7 @@
       </object>
       <packing>
         <property name="left_attach">1</property>
-        <property name="top_attach">4</property>
+        <property name="top_attach">5</property>
       </packing>
     </child>
     <child>
@@ -170,7 +209,7 @@
       </object>
       <packing>
         <property name="left_attach">0</property>
-        <property name="top_attach">5</property>
+        <property name="top_attach">6</property>
         <property name="width">2</property>
       </packing>
     </child>
@@ -192,7 +231,7 @@
       </object>
       <packing>
         <property name="left_attach">0</property>
-        <property name="top_attach">6</property>
+        <property name="top_attach">7</property>
       </packing>
     </child>
     <child>
@@ -210,7 +249,7 @@
       </object>
       <packing>
         <property name="left_attach">1</property>
-        <property name="top_attach">6</property>
+        <property name="top_attach">7</property>
       </packing>
     </child>
     <child>
@@ -232,7 +271,7 @@
       </object>
       <packing>
         <property name="left_attach">0</property>
-        <property name="top_attach">7</property>
+        <property name="top_attach">8</property>
       </packing>
     </child>
     <child>
@@ -250,7 +289,7 @@
       </object>
       <packing>
         <property name="left_attach">1</property>
-        <property name="top_attach">7</property>
+        <property name="top_attach">8</property>
       </packing>
     </child>
     <child>
@@ -273,7 +312,7 @@
       </object>
       <packing>
         <property name="left_attach">0</property>
-        <property name="top_attach">8</property>
+        <property name="top_attach">9</property>
         <property name="width">2</property>
       </packing>
     </child>
@@ -286,7 +325,7 @@
       </object>
       <packing>
         <property name="left-attach">0</property>
-        <property name="top-attach">9</property>
+        <property name="top-attach">10</property>
         <property name="width">2</property>
       </packing>
     </child>
@@ -303,7 +342,7 @@
       </object>
       <packing>
         <property name="left_attach">0</property>
-        <property name="top_attach">11</property>
+        <property name="top_attach">12</property>
         <property name="width">2</property>
       </packing>
     </child>
@@ -320,7 +359,7 @@
       </object>
       <packing>
         <property name="left_attach">0</property>
-        <property name="top_attach">12</property>
+        <property name="top_attach">13</property>
         <property name="width">2</property>
       </packing>
     </child>
@@ -344,7 +383,7 @@
       </object>
       <packing>
           <property name="left_attach">0</property>
-          <property name="top_attach">13</property>
+          <property name="top_attach">14</property>
           <property name="width">2</property>
       </packing>
     </child>
@@ -366,7 +405,7 @@
       </object>
       <packing>
         <property name="left_attach">0</property>
-        <property name="top_attach">14</property>
+        <property name="top_attach">15</property>
       </packing>
     </child>
     <child>
@@ -384,7 +423,7 @@
       </object>
       <packing>
         <property name="left_attach">1</property>
-        <property name="top_attach">14</property>
+        <property name="top_attach">15</property>
       </packing>
     </child>
     <child>
@@ -406,7 +445,7 @@
       </object>
       <packing>
         <property name="left_attach">0</property>
-        <property name="top_attach">15</property>
+        <property name="top_attach">16</property>
       </packing>
     </child>
     <child>
@@ -420,7 +459,7 @@
       </object>
       <packing>
         <property name="left-attach">0</property>
-        <property name="top-attach">16</property>
+        <property name="top-attach">17</property>
         <property name="width">2</property>
       </packing>
     </child>
diff --git a/properties/nm-openconnect-editor-plugin.c b/properties/nm-openconnect-editor-plugin.c
index 90dd5af..3f3c7c5 100644
--- a/properties/nm-openconnect-editor-plugin.c
+++ b/properties/nm-openconnect-editor-plugin.c
@@ -229,6 +229,11 @@ import (NMVpnEditorPlugin *iface, const char *path, GError **error)
        if (buf)
                nm_setting_vpn_add_data_item (s_vpn, NM_OPENCONNECT_KEY_PROXY, buf);
 
+       /* UserAgent */
+       buf = g_key_file_get_string (keyfile, "openconnect", "UserAgent", NULL);
+       if (buf)
+               nm_setting_vpn_add_data_item (s_vpn, NM_OPENCONNECT_KEY_USERAGENT, buf);
+
        /* Cisco Secure Desktop */
        bval = g_key_file_get_boolean (keyfile, "openconnect", "CSDEnable", NULL);
        if (bval)
diff --git a/properties/nm-openconnect-editor.c b/properties/nm-openconnect-editor.c
index de0c27a..813ff4c 100644
--- a/properties/nm-openconnect-editor.c
+++ b/properties/nm-openconnect-editor.c
@@ -344,6 +344,16 @@ init_editor_plugin (OpenconnectEditor *self, NMConnection *connection, GError **
        }
        g_signal_connect (G_OBJECT (widget), "changed", G_CALLBACK (stuff_changed_cb), self);
 
+       widget = GTK_WIDGET (gtk_builder_get_object (priv->builder, "user_agent_entry"));
+       g_return_val_if_fail (widget, FALSE);
+
+       if (s_vpn) {
+               value = nm_setting_vpn_get_data_item (s_vpn, NM_OPENCONNECT_KEY_USERAGENT);
+               if (value)
+                       gtk_entry_set_text (GTK_ENTRY (widget), value);
+       }
+       g_signal_connect (G_OBJECT (widget), "changed", G_CALLBACK (stuff_changed_cb), self);
+
        widget = GTK_WIDGET (gtk_builder_get_object (priv->builder, "fsid_button"));
        g_return_val_if_fail (widget, FALSE);
 
@@ -460,6 +470,11 @@ update_connection (NMVpnEditor *iface,
        if (str && strlen (str))
                nm_setting_vpn_add_data_item (s_vpn, NM_OPENCONNECT_KEY_PROXY, str);
 
+       widget = GTK_WIDGET (gtk_builder_get_object (priv->builder, "user_agent_entry"));
+       str = (char *) gtk_entry_get_text (GTK_ENTRY (widget));
+       if (str && strlen (str))
+               nm_setting_vpn_add_data_item (s_vpn, NM_OPENCONNECT_KEY_USERAGENT, str);
+
        widget = GTK_WIDGET (gtk_builder_get_object (priv->builder, "fsid_button"));
        str = gtk_check_button_get_active (GTK_CHECK_BUTTON (widget))?"yes":"no";
        nm_setting_vpn_add_data_item (s_vpn, NM_OPENCONNECT_KEY_PEM_PASSPHRASE_FSID, str);
diff --git a/shared/nm-service-defines.h b/shared/nm-service-defines.h
index 4e7d481..21e1ce4 100644
--- a/shared/nm-service-defines.h
+++ b/shared/nm-service-defines.h
@@ -46,6 +46,7 @@
 #define NM_OPENCONNECT_KEY_PROTOCOL "protocol"
 #define NM_OPENCONNECT_KEY_PROXY "proxy"
 #define NM_OPENCONNECT_KEY_CSD_ENABLE "enable_csd_trojan"
+#define NM_OPENCONNECT_KEY_USERAGENT "useragent"
 #define NM_OPENCONNECT_KEY_CSD_WRAPPER "csd_wrapper"
 #define NM_OPENCONNECT_KEY_TOKEN_MODE "stoken_source"
 #define NM_OPENCONNECT_KEY_TOKEN_SECRET "stoken_string"