From a869a3ac9c8edd4cdb1ad1de68dbdca1af44fe4e Mon Sep 17 00:00:00 2001
From: "Philip J. Turmel" <philip@turmel.org>
Date: Sat, 21 Oct 2023 15:23:59 -0400
Subject: [PATCH] Add User Agent Override to SAML Authentication

Adds "samlUserAgent" key to settings dialog.  If left blank, prior
behavior is unchanged.

If provided, the WebView Profile is adjusted with ::setHttpUserAgent()
before opening the portal's SAML page.
---
 GPClient/gpclient.cpp        |  2 ++
 GPClient/gphelper.h          |  2 +-
 GPClient/samlloginwindow.cpp |  6 ++++++
 GPClient/settingsdialog.cpp  |  8 ++++++++
 GPClient/settingsdialog.h    |  3 +++
 GPClient/settingsdialog.ui   | 24 +++++++++++++++++-------
 6 files changed, 37 insertions(+), 8 deletions(-)

diff --git a/GPClient/gpclient.cpp b/GPClient/gpclient.cpp
index 6137eff..486aaeb 100644
--- a/GPClient/gpclient.cpp
+++ b/GPClient/gpclient.cpp
@@ -62,6 +62,7 @@ void GPClient::onSettingsButtonClicked()
 {
     settingsDialog->setClientos(settings::get("clientos", "Linux").toString());
     settingsDialog->setOsVersion(settings::get("os-version", QSysInfo::prettyProductName()).toString());
+    settingsDialog->setSamlUserAgent(settings::get("samlUserAgent", "").toString());
     settingsDialog->show();
 }
 
@@ -69,6 +70,7 @@ void GPClient::onSettingsAccepted()
 {
     settings::save("clientos", settingsDialog->clientos());
     settings::save("os-version", settingsDialog->osVersion());
+    settings::save("samlUserAgent", settingsDialog->samlUserAgent());
 }
 
 void GPClient::on_connectButton_clicked()
diff --git a/GPClient/gphelper.h b/GPClient/gphelper.h
index 634f82e..2efdfbb 100644
--- a/GPClient/gphelper.h
+++ b/GPClient/gphelper.h
@@ -31,7 +31,7 @@ namespace gpclient {
         namespace settings {
 
             extern QSettings *_settings;
-            static const QStringList reservedKeys {"extraArgs", "clientos"};
+            static const QStringList reservedKeys {"extraArgs", "clientos", "samlUserAgent"};
 
             QVariant get(const QString &key, const QVariant &defaultValue = QVariant());
             QStringList get_all(const QString &key, const QVariant &defaultValue = QVariant());
diff --git a/GPClient/samlloginwindow.cpp b/GPClient/samlloginwindow.cpp
index d7b8d16..b42a00d 100644
--- a/GPClient/samlloginwindow.cpp
+++ b/GPClient/samlloginwindow.cpp
@@ -4,8 +4,11 @@
 #include <QWebEngineCookieStore>
 #include <plog/Log.h>
 
+#include "gphelper.h"
 #include "samlloginwindow.h"
 
+using namespace gpclient::helper;
+
 SAMLLoginWindow::SAMLLoginWindow(QWidget *parent)
     : QDialog(parent)
     , webView(new EnhancedWebView(this))
@@ -42,6 +45,9 @@ void SAMLLoginWindow::closeEvent(QCloseEvent *event)
 void SAMLLoginWindow::login(const QString samlMethod, const QString samlRequest, const QString preloginUrl)
 {
     webView->page()->profile()->cookieStore()->deleteSessionCookies();
+    const QString&  ua = settings::get("samlUserAgent", "").toString();
+    if (!ua.isEmpty())
+        webView->page()->profile()->setHttpUserAgent(ua);
 
     if (samlMethod == "POST") {
         webView->setHtml(samlRequest, preloginUrl);
diff --git a/GPClient/settingsdialog.cpp b/GPClient/settingsdialog.cpp
index 51e230f..eca8a09 100644
--- a/GPClient/settingsdialog.cpp
+++ b/GPClient/settingsdialog.cpp
@@ -40,3 +40,11 @@ void SettingsDialog::setOsVersion(QString osVersion) {
 QString SettingsDialog::osVersion() {
     return ui->osVersionInput->text();
 }
+
+void SettingsDialog::setSamlUserAgent(QString samlUserAgent) {
+    ui->samlUserAgentInput->setText(samlUserAgent);
+}
+
+QString SettingsDialog::samlUserAgent() {
+    return ui->samlUserAgentInput->text();
+}
\ No newline at end of file
diff --git a/GPClient/settingsdialog.h b/GPClient/settingsdialog.h
index ab2a607..4bc45af 100644
--- a/GPClient/settingsdialog.h
+++ b/GPClient/settingsdialog.h
@@ -24,6 +24,9 @@ public:
     void setOsVersion(QString osVersion);
     QString osVersion();
 
+    void setSamlUserAgent(QString samlUserAgent);
+    QString samlUserAgent();
+
 private:
     Ui::SettingsDialog *ui;
 };
diff --git a/GPClient/settingsdialog.ui b/GPClient/settingsdialog.ui
index ba27742..1246700 100644
--- a/GPClient/settingsdialog.ui
+++ b/GPClient/settingsdialog.ui
@@ -7,7 +7,7 @@
     <x>0</x>
     <y>0</y>
     <width>488</width>
-    <height>220</height>
+    <height>328</height>
    </rect>
   </property>
   <property name="sizePolicy">
@@ -55,7 +55,17 @@
      </property>
     </widget>
    </item>
-   <item row="3" column="1">
+   <item row="2" column="0">
+    <widget class="QLabel" name="label_3">
+     <property name="text">
+      <string>os-version:</string>
+     </property>
+    </widget>
+   </item>
+   <item row="2" column="1">
+    <widget class="QLineEdit" name="osVersionInput"/>
+   </item>
+   <item row="4" column="1">
     <widget class="QDialogButtonBox" name="buttonBox">
      <property name="orientation">
       <enum>Qt::Horizontal</enum>
@@ -65,13 +75,13 @@
      </property>
     </widget>
    </item>
-   <item row="2" column="1">
-    <widget class="QLineEdit" name="osVersionInput"/>
+   <item row="3" column="1">
+    <widget class="QLineEdit" name="samlUserAgentInput"/>
    </item>
-   <item row="2" column="0">
-    <widget class="QLabel" name="label_3">
+   <item row="3" column="0">
+    <widget class="QLabel" name="label_4">
      <property name="text">
-      <string>os-version:</string>
+      <string>saml-user-agent:</string>
      </property>
     </widget>
    </item>