From 014f8aabbdfce1dbdc01135bd97bf2ac35349443 Mon Sep 17 00:00:00 2001
From: Kirill Pahnev <kirill.pahnev@gmail.com>
Date: Mon, 29 Jun 2020 16:31:20 +0300
Subject: [PATCH] Make IV_UI_VER flag overridable

---
 .../Sources/Core/CoreConfiguration.swift      |  2 ++
 .../OpenVPNTunnelProvider+Configuration.swift | 26 +++++++++++++++----
 .../AppExtension/OpenVPNTunnelProvider.swift  |  3 +++
 .../OpenVPN/CoreConfiguration+OpenVPN.swift   |  3 ++-
 4 files changed, 28 insertions(+), 6 deletions(-)

diff --git a/TunnelKit/Sources/Core/CoreConfiguration.swift b/TunnelKit/Sources/Core/CoreConfiguration.swift
index 012d8c6..3cb9371 100644
--- a/TunnelKit/Sources/Core/CoreConfiguration.swift
+++ b/TunnelKit/Sources/Core/CoreConfiguration.swift
@@ -56,6 +56,8 @@ class CoreConfiguration {
 
     // configurable
     static var masksPrivateData = true
+
+    static var versionIdentifier: String?
     
     static let logsSensitiveData = false
 }
diff --git a/TunnelKit/Sources/Protocols/OpenVPN/AppExtension/OpenVPNTunnelProvider+Configuration.swift b/TunnelKit/Sources/Protocols/OpenVPN/AppExtension/OpenVPNTunnelProvider+Configuration.swift
index 397e8ab..f6c1c8f 100644
--- a/TunnelKit/Sources/Protocols/OpenVPN/AppExtension/OpenVPNTunnelProvider+Configuration.swift
+++ b/TunnelKit/Sources/Protocols/OpenVPN/AppExtension/OpenVPNTunnelProvider+Configuration.swift
@@ -55,7 +55,8 @@ extension OpenVPNTunnelProvider {
             mtu: 1250,
             shouldDebug: false,
             debugLogFormat: nil,
-            masksPrivateData: true
+            masksPrivateData: true,
+            versionIdentifier: nil
         )
         
         /// The session configuration.
@@ -71,7 +72,10 @@ extension OpenVPNTunnelProvider {
         
         /// The MTU of the link.
         public var mtu: Int
-        
+
+        /// Optional version identifier about the client pushed to server in peer-info as `IV_UI_VER`.
+        public var versionIdentifier: String?
+
         // MARK: Debugging
         
         /// Enables debugging.
@@ -98,6 +102,7 @@ extension OpenVPNTunnelProvider {
             shouldDebug = ConfigurationBuilder.defaults.shouldDebug
             debugLogFormat = ConfigurationBuilder.defaults.debugLogFormat
             masksPrivateData = ConfigurationBuilder.defaults.masksPrivateData
+            versionIdentifier = ConfigurationBuilder.defaults.versionIdentifier
         }
         
         fileprivate init(providerConfiguration: [String: Any]) throws {
@@ -112,6 +117,7 @@ extension OpenVPNTunnelProvider {
                 debugLogFormat = providerConfiguration[S.debugLogFormat] as? String
             }
             masksPrivateData = providerConfiguration[S.masksPrivateData] as? Bool ?? ConfigurationBuilder.defaults.masksPrivateData
+            versionIdentifier = providerConfiguration[S.versionIdentifier] as? String ?? ConfigurationBuilder.defaults.versionIdentifier
 
             guard !prefersResolvedAddresses || !(resolvedAddresses?.isEmpty ?? true) else {
                 throw ProviderConfigurationError.parameter(name: "protocolConfiguration.providerConfiguration[\(S.prefersResolvedAddresses)] is true but no [\(S.resolvedAddresses)]")
@@ -131,7 +137,8 @@ extension OpenVPNTunnelProvider {
                 mtu: mtu,
                 shouldDebug: shouldDebug,
                 debugLogFormat: shouldDebug ? debugLogFormat : nil,
-                masksPrivateData: masksPrivateData
+                masksPrivateData: masksPrivateData,
+                versionIdentifier: versionIdentifier
             )
         }
     }
@@ -140,7 +147,9 @@ extension OpenVPNTunnelProvider {
     public struct Configuration: Codable {
         struct Keys {
             static let appGroup = "AppGroup"
-            
+
+            static let versionIdentifier = "VersionIdentifier"
+
             // MARK: SessionConfiguration
 
             static let cipherAlgorithm = "CipherAlgorithm"
@@ -230,7 +239,10 @@ extension OpenVPNTunnelProvider {
         
         /// - Seealso: `OpenVPNTunnelProvider.ConfigurationBuilder.masksPrivateData`
         public let masksPrivateData: Bool?
-        
+
+        /// - Seealso: `OpenVPNTunnelProvider.ConfigurationBuilder.versionIdentifier`
+        public let versionIdentifier: String?
+
         // MARK: Shortcuts
 
         static let debugLogFilename = "debug.log"
@@ -368,6 +380,9 @@ extension OpenVPNTunnelProvider {
             if let masksPrivateData = masksPrivateData {
                 dict[S.masksPrivateData] = masksPrivateData
             }
+            if let versionIdentifier = versionIdentifier {
+                dict[S.versionIdentifier] = versionIdentifier
+            }
             return dict
         }
         
@@ -429,6 +444,7 @@ extension OpenVPNTunnelProvider.Configuration {
         builder.shouldDebug = shouldDebug
         builder.debugLogFormat = debugLogFormat
         builder.masksPrivateData = masksPrivateData
+        builder.versionIdentifier = versionIdentifier
         return builder
     }
 }
diff --git a/TunnelKit/Sources/Protocols/OpenVPN/AppExtension/OpenVPNTunnelProvider.swift b/TunnelKit/Sources/Protocols/OpenVPN/AppExtension/OpenVPNTunnelProvider.swift
index db3dbbd..c39f4e8 100644
--- a/TunnelKit/Sources/Protocols/OpenVPN/AppExtension/OpenVPNTunnelProvider.swift
+++ b/TunnelKit/Sources/Protocols/OpenVPN/AppExtension/OpenVPNTunnelProvider.swift
@@ -203,6 +203,9 @@ open class OpenVPNTunnelProvider: NEPacketTunnelProvider {
         if let masksPrivateData = cfg.masksPrivateData {
             CoreConfiguration.masksPrivateData = masksPrivateData
         }
+        if let versionIdentifier = cfg.versionIdentifier {
+            CoreConfiguration.versionIdentifier = versionIdentifier
+        }
 
         // optional credentials
         let credentials: OpenVPN.Credentials?
diff --git a/TunnelKit/Sources/Protocols/OpenVPN/CoreConfiguration+OpenVPN.swift b/TunnelKit/Sources/Protocols/OpenVPN/CoreConfiguration+OpenVPN.swift
index 2c30823..0c73c06 100644
--- a/TunnelKit/Sources/Protocols/OpenVPN/CoreConfiguration+OpenVPN.swift
+++ b/TunnelKit/Sources/Protocols/OpenVPN/CoreConfiguration+OpenVPN.swift
@@ -70,10 +70,11 @@ extension CoreConfiguration {
             #else
             platform = "mac"
             #endif
+            let uiVersion = versionIdentifier ?? "\(identifier) \(version)"
             var info = [
                 "IV_VER=2.4",
                 "IV_PLAT=\(platform)",
-                "IV_UI_VER=\(identifier) \(version)",
+                "IV_UI_VER=\(uiVersion)",
                 "IV_PROTO=2",
                 "IV_NCP=2",
                 "IV_SSL=\(CryptoBox.version())",