Release 1.3.0

* Add the setting icon

* Add support for custom parameters

* Ignore auto generated files

* Update README.md

.github/workflows/publish.yml

@@ -11,7 +11,7 @@ jobs:
       - name: Install Qt
         uses: jurplel/install-qt-action@v2
         with:
-          version: '5.15.2'
+          version: 5.15.2
           modules: 'qtwebengine qtwebsockets'
 
       # Checkout repository and submodules
@@ -24,7 +24,6 @@ jobs:
           qmake CONFIG+=release
           make
 
-
   aur-publish:
     needs:
       - build
@@ -33,6 +32,8 @@ jobs:
 
     steps:
       - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
       
       - name: Get latest version
         id: get-version
@@ -42,14 +43,14 @@ jobs:
       - name: Get the sha256sum
         id: get-sha256sum
         run: |
-          echo ::set-output name=SHA::$(curl -L https://github.com/yuezk/GlobalProtect-openconnect/archive/refs/tags/v${{ steps.get-version.outputs.VERSION }}.tar.gz | sha256sum)
+          echo ::set-output name=SHA::$(curl -L https://github.com/yuezk/GlobalProtect-openconnect/archive/refs/tags/v${{ steps.get-version.outputs.VERSION }}.tar.gz | sha256sum | cut -f1 -d" ")
       
       - name: Generate PKGBUILD
         run: |
           sed "s/{PKG_VERSION}/${{ steps.get-version.outputs.VERSION }}/g;s/{SOURCE_SHA}/${{ steps.get-sha256sum.outputs.SHA }}/g" PKGBUILD.template > PKGBUILD
       
       - name: Publish AUR package
-        uses: KSXGitHub/github-actions-deploy-aur@v2.2.3
+        uses: KSXGitHub/github-actions-deploy-aur@v2.2.4
         with:
           pkgname: globalprotect-openconnect
           pkgbuild: ./PKGBUILD

.gitignore

@@ -6,6 +6,8 @@ gpservice
 *_adaptor.cpp
 *_adaptor.h
 
+gpservice_interface.*
+
 # C++ objects and libs
 *.slo
 *.lo

GPClient/GPClient.pro

@@ -35,7 +35,8 @@ SOURCES += \
     portalconfigresponse.cpp \
     preloginresponse.cpp \
     samlloginwindow.cpp \
-    gpclient.cpp
+    gpclient.cpp \
+    settingsdialog.cpp
 
 HEADERS += \
     cdpcommand.h \
@@ -50,11 +51,13 @@ HEADERS += \
     portalconfigresponse.h \
     preloginresponse.h \
     samlloginwindow.h \
-    gpclient.h
+    gpclient.h \
+    settingsdialog.h
 
 FORMS += \
     gpclient.ui \
-    normalloginwindow.ui
+    normalloginwindow.ui \
+    settingsdialog.ui
 
 DBUS_INTERFACES += ../GPService/gpservice.xml
 

GPClient/gatewayauthenticator.cpp

@@ -44,8 +44,9 @@ void GatewayAuthenticator::login(const LoginParams &params)
 void GatewayAuthenticator::onLoginFinished()
 {
     QNetworkReply *reply = qobject_cast<QNetworkReply*>(sender());
+    QByteArray response;
 
-    if (reply->error()) {
+    if (reply->error() || (response = reply->readAll()).contains("Authentication failure")) {
         PLOGE << QString("Failed to login the gateway at %1, %2").arg(loginUrl).arg(reply->errorString());
 
         if (normalLoginWindow) {
@@ -61,7 +62,7 @@ void GatewayAuthenticator::onLoginFinished()
         normalLoginWindow->close();
     }
 
-    const QUrlQuery params = gpclient::helper::parseGatewayResponse(reply->readAll());
+    const QUrlQuery params = gpclient::helper::parseGatewayResponse(response);
     emit success(params.toString());
 }
 

GPClient/gpclient.cpp

@@ -3,6 +3,7 @@
 #include "ui_gpclient.h"
 #include "portalauthenticator.h"
 #include "gatewayauthenticator.h"
+#include "settingsdialog.h"
 
 #include <plog/Log.h>
 #include <QIcon>
@@ -12,12 +13,16 @@ using namespace gpclient::helper;
 GPClient::GPClient(QWidget *parent)
     : QMainWindow(parent)
     , ui(new Ui::GPClient)
+    , settingsDialog(new SettingsDialog(this))
 {
     ui->setupUi(this);
+
     setWindowTitle("GlobalProtect");
     setFixedSize(width(), height());
     gpclient::helper::moveCenter(this);
 
+    setupSettings();
+
     // Restore portal from the previous settings
     ui->portalInput->setText(settings::get("portal", "").toString());
 
@@ -36,6 +41,37 @@ GPClient::~GPClient()
 {
     delete ui;
     delete vpn;
+    delete settingsDialog;
+    delete settingsButton;
+}
+
+void GPClient::setupSettings()
+{
+    settingsButton = new QPushButton(this);
+    settingsButton->setIcon(QIcon(":/images/settings_icon.svg"));
+    settingsButton->setFixedSize(QSize(28, 28));
+
+    QRect rect = this->geometry();
+    settingsButton->setGeometry(
+                rect.width() - settingsButton->width() - 15,
+                15,
+                settingsButton->geometry().width(),
+                settingsButton->geometry().height()
+                );
+
+    connect(settingsButton, &QPushButton::clicked, this, &GPClient::onSettingsButtonClicked);
+    connect(settingsDialog, &QDialog::accepted, this, &GPClient::onSettingsAccepted);
+}
+
+void GPClient::onSettingsButtonClicked()
+{
+    settingsDialog->setExtraArgs(settings::get("extraArgs", "").toString());
+    settingsDialog->show();
+}
+
+void GPClient::onSettingsAccepted()
+{
+    settings::save("extraArgs", settingsDialog->extraArgs());
 }
 
 void GPClient::on_connectButton_clicked()
@@ -330,7 +366,7 @@ void GPClient::onGatewaySuccess(const QString &authCookie)
     PLOGI << "Gateway login succeeded, got the cookie " << authCookie;
 
     isQuickConnect = false;
-    vpn->connect(currentGateway().address(), portalConfig.username(), authCookie);
+    vpn->connect(currentGateway().address(), portalConfig.username(), authCookie, settings::get("extraArgs", "").toString());
     ui->statusLabel->setText("Connecting...");
     updateConnectionStatus(VpnStatus::pending);
 }

GPClient/gpclient.h

@@ -3,10 +3,12 @@
 
 #include "gpservice_interface.h"
 #include "portalconfigresponse.h"
+#include "settingsdialog.h"
 
 #include <QMainWindow>
 #include <QSystemTrayIcon>
 #include <QMenu>
+#include <QPushButton>
 
 QT_BEGIN_NAMESPACE
 namespace Ui { class GPClient; }
@@ -23,6 +25,9 @@ public:
     void activate();
 
 private slots:
+    void onSettingsButtonClicked();
+    void onSettingsAccepted();
+
     void on_connectButton_clicked();
     void on_portalInput_returnPressed();
     void on_portalInput_editingFinished();
@@ -62,10 +67,15 @@ private:
     QAction *clearAction;
     QAction *quitAction;
 
+    SettingsDialog *settingsDialog;
+    QPushButton *settingsButton;
+
     bool isQuickConnect { false };
     bool isSwitchingGateway { false };
     PortalConfigResponse portalConfig;
 
+    void setupSettings();
+
     void initSystemTrayIcon();
     void initVpnStatus();
     void populateGatewayMenu();

GPClient/gpclient.ui

@@ -7,7 +7,7 @@
     <x>0</x>
     <y>0</y>
     <width>260</width>
-    <height>338</height>
+    <height>362</height>
    </rect>
   </property>
   <property name="windowTitle">
@@ -36,7 +36,7 @@
    <property name="layoutDirection">
     <enum>Qt::LeftToRight</enum>
    </property>
-   <layout class="QVBoxLayout" name="verticalLayout_3" stretch="1,0">
+   <layout class="QVBoxLayout" name="verticalLayout_3" stretch="1,0,0">
     <property name="leftMargin">
      <number>15</number>
     </property>
@@ -123,6 +123,16 @@
       </item>
      </layout>
     </item>
+    <item>
+     <widget class="QLabel" name="label">
+      <property name="text">
+       <string>&lt;html&gt;&lt;head/&gt;&lt;body&gt;&lt;p align=&quot;center&quot;&gt;&lt;a href=&quot;https://bit.ly/3g5DHqy&quot;&gt;&lt;span style=&quot; text-decoration: underline; color:#4c6b8a;&quot;&gt;Report a bug&lt;/span&gt;&lt;/a&gt; / &lt;a href=&quot;https://bit.ly/3jQYfEi&quot;&gt;&lt;span style=&quot; text-decoration: underline; color:#4c6b8a;&quot;&gt;Buy me a coffee&lt;/span&gt;&lt;/a&gt;&lt;/p&gt;&lt;/body&gt;&lt;/html&gt;</string>
+      </property>
+      <property name="openExternalLinks">
+       <bool>true</bool>
+      </property>
+     </widget>
+    </item>
    </layout>
   </widget>
  </widget>

GPClient/main.cpp

@@ -6,7 +6,7 @@
 #include <plog/Log.h>
 #include <plog/Appenders/ColorConsoleAppender.h>
 
-static const QString version = "v1.2.8";
+static const QString version = "v1.3.0";
 
 int main(int argc, char *argv[])
 {

GPClient/resources.qrc

@@ -6,5 +6,6 @@
         <file>not_connected.png</file>
         <file>radio_unselected.png</file>
         <file>radio_selected.png</file>
+        <file>settings_icon.svg</file>
     </qresource>
 </RCC>

GPClient/settings_icon.svg

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- Generator: Adobe Illustrator 23.0.3, SVG Export Plug-In . SVG Version: 6.00 Build 0)  -->
+<svg version="1.1" id="Icons" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
+	 viewBox="0 0 32 32" style="enable-background:new 0 0 32 32;" xml:space="preserve">
+<g>
+	<path d="M16.5,19.9C16.5,19.9,16.5,19.9,16.5,19.9l3.1-3.1c0,0,0,0,0,0l2.3-2.3c2.2,0.6,4.5,0,6.2-1.6c1.8-1.8,2.3-4.4,1.4-6.8
+		c-0.1-0.3-0.4-0.5-0.7-0.6c-0.3-0.1-0.7,0-0.9,0.3L25.6,8l-1.3-0.3L24,6.4l2.2-2.2c0.2-0.2,0.3-0.6,0.3-0.9
+		c-0.1-0.3-0.3-0.6-0.6-0.7c-2.3-0.9-5-0.4-6.8,1.4c-1.6,1.6-2.2,4-1.6,6.2l-1.6,1.6l-2.6-2.6L11,5.3c-0.1-0.1-0.2-0.3-0.3-0.3
+		L6.8,2.7C6.4,2.4,5.9,2.5,5.5,2.8L2.5,5.9C2.1,6.2,2.1,6.7,2.3,7.1L4.6,11c0.1,0.1,0.2,0.3,0.3,0.3l3.7,2.2l2.6,2.6l-1.2,1.2
+		c-2.2-0.6-4.5,0-6.2,1.6c-1.8,1.8-2.3,4.4-1.4,6.8c0.1,0.3,0.4,0.5,0.7,0.6c0.3,0.1,0.7,0,0.9-0.3L6.4,24l1.3,0.3L8,25.6l-2.2,2.2
+		c-0.2,0.2-0.3,0.6-0.3,0.9c0.1,0.3,0.3,0.6,0.6,0.7c0.8,0.3,1.5,0.4,2.3,0.4c1.6,0,3.3-0.6,4.5-1.9c1.6-1.6,2.2-4,1.6-6.2
+		L16.5,19.9z"/>
+	<path d="M22.5,16.8l-6,6l6.1,6.1c0.8,0.8,1.9,1.3,3,1.3s2.2-0.4,3-1.3c0.8-0.8,1.3-1.9,1.3-3c0-1.1-0.4-2.2-1.3-3L22.5,16.8z"/>
+</g>
+</svg>

GPClient/settingsdialog.cpp

@@ -0,0 +1,26 @@
+#include "settingsdialog.h"
+#include "ui_settingsdialog.h"
+
+SettingsDialog::SettingsDialog(QWidget *parent) :
+    QDialog(parent),
+    ui(new Ui::SettingsDialog)
+{
+    ui->setupUi(this);
+
+    ui->extraArgsInput->setPlaceholderText("e.g. --name=value");
+}
+
+SettingsDialog::~SettingsDialog()
+{
+    delete ui;
+}
+
+void SettingsDialog::setExtraArgs(QString args)
+{
+    ui->extraArgsInput->setPlainText(args);
+}
+
+QString SettingsDialog::extraArgs()
+{
+    return ui->extraArgsInput->toPlainText().trimmed();
+}

GPClient/settingsdialog.h

@@ -0,0 +1,25 @@
+#ifndef SETTINGSDIALOG_H
+#define SETTINGSDIALOG_H
+
+#include <QDialog>
+
+namespace Ui {
+class SettingsDialog;
+}
+
+class SettingsDialog : public QDialog
+{
+    Q_OBJECT
+
+public:
+    explicit SettingsDialog(QWidget *parent = nullptr);
+    ~SettingsDialog();
+
+    void setExtraArgs(QString);
+    QString extraArgs();
+
+private:
+    Ui::SettingsDialog *ui;
+};
+
+#endif // SETTINGSDIALOG_H

GPClient/settingsdialog.ui

@@ -0,0 +1,86 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ui version="4.0">
+ <class>SettingsDialog</class>
+ <widget class="QDialog" name="SettingsDialog">
+  <property name="geometry">
+   <rect>
+    <x>0</x>
+    <y>0</y>
+    <width>470</width>
+    <height>183</height>
+   </rect>
+  </property>
+  <property name="sizePolicy">
+   <sizepolicy hsizetype="Preferred" vsizetype="Preferred">
+    <horstretch>0</horstretch>
+    <verstretch>0</verstretch>
+   </sizepolicy>
+  </property>
+  <property name="windowTitle">
+   <string>Settings</string>
+  </property>
+  <property name="windowIcon">
+   <iconset resource="resources.qrc">
+    <normaloff>:/images/connected.png</normaloff>:/images/connected.png</iconset>
+  </property>
+  <layout class="QVBoxLayout" name="verticalLayout">
+   <item>
+    <widget class="QLabel" name="label">
+     <property name="text">
+      <string>Custom Parameters:</string>
+     </property>
+    </widget>
+   </item>
+   <item>
+    <widget class="QPlainTextEdit" name="extraArgsInput"/>
+   </item>
+   <item>
+    <widget class="QDialogButtonBox" name="buttonBox">
+     <property name="orientation">
+      <enum>Qt::Horizontal</enum>
+     </property>
+     <property name="standardButtons">
+      <set>QDialogButtonBox::Cancel|QDialogButtonBox::Ok</set>
+     </property>
+    </widget>
+   </item>
+  </layout>
+ </widget>
+ <resources>
+  <include location="resources.qrc"/>
+ </resources>
+ <connections>
+  <connection>
+   <sender>buttonBox</sender>
+   <signal>accepted()</signal>
+   <receiver>SettingsDialog</receiver>
+   <slot>accept()</slot>
+   <hints>
+    <hint type="sourcelabel">
+     <x>248</x>
+     <y>254</y>
+    </hint>
+    <hint type="destinationlabel">
+     <x>157</x>
+     <y>274</y>
+    </hint>
+   </hints>
+  </connection>
+  <connection>
+   <sender>buttonBox</sender>
+   <signal>rejected()</signal>
+   <receiver>SettingsDialog</receiver>
+   <slot>reject()</slot>
+   <hints>
+    <hint type="sourcelabel">
+     <x>316</x>
+     <y>260</y>
+    </hint>
+    <hint type="destinationlabel">
+     <x>286</x>
+     <y>274</y>
+    </hint>
+   </hints>
+  </connection>
+ </connections>
+</ui>

GPService/gpservice.cpp

@@ -49,7 +49,7 @@ void GPService::quit()
     }
 }
 
-void GPService::connect(QString server, QString username, QString passwd)
+void GPService::connect(QString server, QString username, QString passwd, QString extraArgs)
 {
     if (vpnStatus != GPService::VpnNotConnected) {
         log("VPN status is: " + QVariant::fromValue(vpnStatus).toString());
@@ -65,10 +65,13 @@ void GPService::connect(QString server, QString username, QString passwd)
     QStringList args;
     args << QCoreApplication::arguments().mid(1)
      << "--protocol=gp"
+     << QProcess::splitCommand(extraArgs)
      << "-u" << username
      << "-C" << passwd
      << server;
 
+    log("Start process with arugments: " + args.join(" "));
+
     openconnect->start(bin, args);
 }
 

GPService/gpservice.h

@@ -34,7 +34,7 @@ signals:
     void logAvailable(QString log);
 
 public slots:
-    void connect(QString server, QString username, QString passwd);
+    void connect(QString server, QString username, QString passwd, QString extraArgs);
     void disconnect();
     int status();
     void quit();

GPService/gpservice.xml

@@ -12,6 +12,7 @@
       <arg name="server" type="s" direction="in"/>
       <arg name="username" type="s" direction="in"/>
       <arg name="passwd" type="s" direction="in"/>
+      <arg name="extraArgs" type="s" direction="in"/>
     </method>
     <method name="disconnect">
     </method>

PKGBUILD.template

@@ -5,7 +5,7 @@ _gitname=GlobalProtect-openconnect
 pkgver={PKG_VERSION}
 pkgrel=1
 pkgdesc="A GlobalProtect VPN client (GUI) for Linux based on Openconnect and built with Qt5, supports SAML auth mode."
-arch=(x86_64)
+arch=(x86_64 aarch64)
 url="https://github.com/yuezk/${_gitname}"
 license=('GPL3')
 depends=('openconnect>=8.0.0' qt5-base qt5-webengine qt5-websockets)

README.md

@@ -12,6 +12,13 @@ A GlobalProtect VPN client (GUI) for Linux based on Openconnect and built with Q
 - Supports automatically selecting the preferred gateway from the multiple gateways.
 - Supports switching gateway from the system tray menu manually.
 
+## Passing the Custom Parameters to `OpenConnect` CLI
+
+Custom parameters can be appended to the `OpenConnect` CLI with the following settings.
+<p align="center">
+ <img src="https://user-images.githubusercontent.com/3297602/129464304-94eb8a2b-1c4a-47e1-b931-4422fff6eb81.png" />
+<p>
+  
 ## Prerequisites
 
 - Openconnect v8.x
@@ -20,12 +27,27 @@ A GlobalProtect VPN client (GUI) for Linux based on Openconnect and built with Q
 ### Ubuntu
 1. Install openconnect v8.x
 
+    ```sh
+    sudo apt install openconnect
+    openconnect --version
+    ```
+
    For Ubuntu 18.04 you might need to [build the latest openconnect from source code](https://gist.github.com/yuezk/ab9a4b87a9fa0182bdb2df41fab5f613).
    
 2. Install the Qt dependencies
+
+    For Ubuntu 20, this should work.
+    
     ```sh
-    sudo apt install qt5-default libqt5websockets5-dev qtwebengine5-dev qttools5-dev
+    sudo apt install qtbase5-dev libqt5websockets5-dev qtwebengine5-dev qttools5-dev debhelper
     ```
+    
+    For Ubuntu 21, you need to install the base pieces separately as QT5 is the default.
+    
+    ```sh
+    sudo apt install qtbase5-dev qtchooser qt5-qmake qtbase5-dev-tools libqt5websockets5-dev qtwebengine5-dev qttools5-dev debhelper
+    ```
+    
 ### OpenSUSE
 Install the Qt dependencies
 
@@ -33,6 +55,13 @@ Install the Qt dependencies
 sudo zypper install libqt5-qtbase-devel libqt5-qtwebsockets-devel libqt5-qtwebengine-devel
 ```
 
+### Fedora
+Install the Qt dependencies:
+
+```sh
+sudo dnf install qt5-qtbase-devel qt5-qttools-devel qt5-qtwebengine qt5-qtwebsockets-devel qt5-qtwebengine-devel
+```
+
 ## Install
 
 ### Install from AUR (Arch/Manjaro)
@@ -76,15 +105,28 @@ Relatively manual process for now:
   git-archive-all --force-submodules --prefix=globalprotect-openconnect-1.3.0/ ../globalprotect-openconnect_1.3.0.orig.tar.gz
   ```
 
-* Finally extract the source tree and build the debian package.
+* Finally extract the source tree, build the debian package, and install it.
 
   ```
   cd ..
   tar -xzvf globalprotect-openconnect_1.3.0.orig.tar.gz
   cd globalprotect-openconnect-1.3.0
   fakeroot dpkg-buildpackage -uc -us -sa 2>&1 | tee ../build.log
+  sudo dpkg -i globalprotect-openconnect_1.3.0-1ppa1_amd64.deb
   ```
 
+### NixOS
+  In `configuration.nix`:
+
+  ```
+  services.globalprotect = {
+    enable = true;
+    # if you need a Host Integrity Protection report
+    csdWrapper = "${pkgs.openconnect}/libexec/openconnect/hipreport.sh";
+  };
+  
+  environment.systemPackages = [ globalprotect-openconnect ];
+  ```
   
 
 ## [License](./LICENSE)

debian/control

@@ -2,7 +2,7 @@ Source: globalprotect-openconnect
 Section: net
 Priority: optional
 Maintainer: Kevin Yue <k3vinyue@gmail.com>
-Build-Depends: debhelper (>=11~), qt5-default (>=5.9), qttools5-dev (>=5.9), libqt5websockets5-dev (>=5.9), qtwebengine5-dev (>=5.9)
+Build-Depends: debhelper (>=11~), qtbase5-dev, qttools5-dev (>=5.9), libqt5websockets5-dev (>=5.9), qtwebengine5-dev (>=5.9)
 Standards-Version: 4.1.4
 Homepage: https://github.com/yuezk/GlobalProtect-openconnect