add support for proxy connections (#12)

* add support for proxy connections

Author: christoph2497

library/Servicenowimport/Api/Servicenow.php

@@ -31,6 +31,7 @@ public function __construct(string $baseUri, bool $tlsVerify = true, int $timeou
         ];
 
         $method = $auth['method'] ?? 'UNKNOWN';
+        $proxyType = $auth['proxy_type'] ?? 'UNKNOWN';
 
         try {
             if ($method === 'BASIC') {
@@ -44,6 +45,26 @@ public function __construct(string $baseUri, bool $tlsVerify = true, int $timeou
             throw new RuntimeException(sprintf("Failed to set authentication method %s", $e->getMessage()));
         }
 
+        try {
+            $proxyAddress = parse_url($auth['proxy_address']);
+            $proxyHost = $proxyAddress['host'];
+            $proxyScheme = 'https';
+            $proxyPort = 443;
+
+            if ($proxyType === 'HTTP') {
+                $proxyScheme = $proxyAddress['scheme'] ?? 'https';
+                $defaultPort = $proxyScheme === 'http' ? 80 : 443;
+                $proxyPort = $proxyAddress['port'] ?? $defaultPort;
+            } elseif ($proxyType === 'SOCKS5') {
+                $proxyScheme = 'socks5';
+                $proxyPort = $proxyAddress['port'] ?? 1028;
+            }
+
+            $c['proxy'] = sprintf('%s://%s:%s@%s:%d', $proxyScheme, $auth['proxy_user'], $auth['proxy_password'], $proxyHost, $proxyPort);
+        } catch (\Exception $e) {
+            throw new RuntimeException(sprintf("Failed to set proxy method %s", $e->getMessage()));
+        }
+
         $this->client = new Client($c);
     }
 

library/Servicenowimport/ProvidedHook/Director/ImportSource.php

@@ -135,6 +135,8 @@ public static function addSettingsFormFields(QuickForm $form)
                     . 'https://www.servicenow.com/docs/bundle/yokohama-platform-user-interface/page/use/using-lists/concept/c_EncodedQueryStrings.html',
             ]
         );
+
+        static::addProxy($form);
     }
 
     /**
@@ -201,6 +203,10 @@ private function getRecordsFromTable(): array
             'token' => $this->getSetting('servicenow_token'),
             'username' => $this->getSetting('servicenow_username'),
             'password' => $this->getSetting('servicenow_password'),
+            'proxy_type' => $this->getSetting('proxy_type'),
+            'proxy_address' => $this->getSetting('proxy'),
+            'proxy_user' => $this->getSetting('proxy_user'),
+            'proxy_password' => $this->getSetting('proxy_pass'),
         ];
 
         $client = new Servicenow(
@@ -220,6 +226,50 @@ private function getRecordsFromTable(): array
             ]
         );
 
+
+
         return json_decode($result)->result;
     }
+
+    protected static function addProxy(QuickForm $form)
+    {
+        $form->addElement('select', 'proxy_type', [
+            'label' => $form->translate('Proxy'),
+            'description' => $form->translate(
+                'In case your API is only reachable through a proxy, please'
+                . ' choose it\'s protocol right here'
+            ),
+            'multiOptions' => $form->optionalEnum([
+                'HTTP'   => $form->translate('HTTP proxy'),
+                'SOCKS5' => $form->translate('SOCKS5 proxy'),
+            ]),
+            'class' => 'autosubmit'
+        ]);
+
+        $proxyType = $form->getSentOrObjectSetting('proxy_type');
+
+        if ($proxyType) {
+            $form->addElement('text', 'proxy', [
+                'label' => $form->translate('Proxy Address'),
+                'description' => $form->translate(
+                    'Hostname, IP or <host>:<port>'
+                ),
+                'required' => true,
+            ]);
+            if ($proxyType === 'HTTP') {
+                $form->addElement('text', 'proxy_user', [
+                    'label'       => $form->translate('Proxy Username'),
+                    'description' => $form->translate(
+                        'In case your proxy requires authentication, please'
+                        . ' configure this here'
+                    ),
+                ]);
+
+                $form->addElement('storedPassword', 'proxy_pass', [
+                    'label'    => $form->translate('Proxy Password'),
+                    'required' => strlen((string) $form->getSentOrObjectSetting('proxy_user')) > 0
+                ]);
+            }
+        }
+    }
 }

module.info

@@ -1,6 +1,6 @@
 Name: ServiceNow Director Import
 Module: servicenowimport
-Version: 0.2.0
+Version: 0.3.0
 Depends: director (>=1.10.4)
 Description: Director Import Source for ServiceNow
  This module fetches data from the ServiceNow API for the Icinga Director import.