Skip to content

Various fixes #28

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
martialblog merged 3 commits into from
Nov 13, 2026
Merged

Various fixes #28

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
80790d6
Move proxy configuration into a method
martialblog Nov 13, 2026
3f5de95
Move HTTP client to own method
martialblog Nov 13, 2026
5d8c399
Remove unused imports
martialblog Nov 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
138 changes: 88 additions & 50 deletions library/Servicenowimport/Api/Servicenow.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,9 @@
*/
class Servicenow
{
protected $client = null;
// Configuration for the HTTP client
protected array $baseOptions = [];
protected array $authOptions = [];

// $auth = [
// 'method' => 'BASIC',
Expand All @@ -22,18 +24,53 @@ class Servicenow
// ];
public function __construct(string $baseUri, bool $tlsVerify = true, int $timeout = 10, array $auth = [])
{
$c = [
$this->baseOptions = [
'base_uri' => $baseUri,
'timeout' => $timeout,
'verify' => $tlsVerify,
'headers' => [
'Accept' => 'application/json',
'Content-Type' => 'application/json',
],
];

$this->authOptions = $auth;

$proxy = $this->buildProxyUrl($auth);

if ($proxy !== null) {
$this->baseOptions['proxy'] = $proxy;
}
}

/**
* @param string $endpoint
* @param array $params
* @param string $method
* @return mixed
* @throws \GuzzleHttp\Exception\GuzzleException
*/
public function request(string $endpoint, array $params = [], string $method = "GET")
{
$client = $this->getClient();

try {
$response = $client->request($method, $endpoint, $params);
return $response->getBody()->getContents();
} catch (\Exception $e) {
throw new RuntimeException(sprintf("Request failed: %s", $e->getMessage()));
}
}

/**
* getClient returns a configured HTTP client for requests
*/
private function getClient(): Client
{
$c = $this->baseOptions;
$c['headers'] = [
'Accept' => 'application/json',
'Content-Type' => 'application/json',
];

$auth = $this->authOptions;
$method = $auth['method'] ?? 'UNKNOWN';
$proxyType = $auth['proxy_type'] ?? '';

try {
if ($method === 'BASIC') {
Expand All @@ -46,68 +83,69 @@ public function __construct(string $baseUri, bool $tlsVerify = true, int $timeou

if ($method === 'OAUTH') {
// Note: We currently don't store the token between requests
$accessToken = $this->fetchAccessToken($baseUri, $auth);
$accessToken = $this->fetchAccessToken($auth);
$c['headers']['Authorization'] = 'Bearer ' . $accessToken;
}
} catch (\Exception $e) {
throw new RuntimeException(sprintf("Failed to set authentication method %s", $e->getMessage()));
}

if ($proxyType === 'HTTP' || $proxyType === 'SOCKS5') {
try {
$rawProxy = $auth['proxy_address'];
// Support input with and without schema prefix
$proxyAddress = parse_url(strpos($rawProxy, '://') === false ? 'https://' . $rawProxy : $rawProxy);

if (! is_array($proxyAddress) || empty($proxyAddress['host'])) {
throw new RuntimeException(sprintf('invalid proxy address "%s"', $rawProxy));
}

$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);
return new Client($c);
}

/**
* @param string $endpoint
* @param array $params
* @param string $method
* @return mixed
* @throws \GuzzleHttp\Exception\GuzzleException
* buildProxyUrl returns a proxy URL or null if no proxy is configured.
*/
public function request(string $endpoint, array $params = [], string $method = "GET")
private function buildProxyUrl(array $auth): ?string
{
$proxyType = $auth['proxy_type'] ?? '';

if ($proxyType !== 'HTTP' && $proxyType !== 'SOCKS5') {
return null;
}

try {
$response = $this->client->request($method, $endpoint, $params);
return $response->getBody()->getContents();
$rawProxy = (string) ($auth['proxy_address'] ?? '');
// Support input with and without schema prefix
$proxyAddress = parse_url(strpos($rawProxy, '://') === false ? 'https://' . $rawProxy : $rawProxy);

if (! is_array($proxyAddress) || empty($proxyAddress['host'])) {
throw new RuntimeException(sprintf('invalid proxy address "%s"', $rawProxy));
}

$proxyHost = $proxyAddress['host'];

if ($proxyType === 'HTTP') {
$proxyScheme = $proxyAddress['scheme'] ?? 'https';
$defaultPort = $proxyScheme === 'http' ? 80 : 443;
$proxyPort = $proxyAddress['port'] ?? $defaultPort;
} else {
// socks5h: let the proxy resolve DNS names
$proxyScheme = 'socks5h';
$proxyPort = $proxyAddress['port'] ?? 1080;
}

// Only add credentials if a user is set, and URL-encode them so special characters wont break the proxy URL
$userinfo = '';
if (isset($auth['proxy_user']) && $auth['proxy_user'] !== '') {
$userinfo = rawurlencode((string) $auth['proxy_user'])
. ':' . rawurlencode((string) ($auth['proxy_password'] ?? ''))
. '@';
}

return sprintf('%s://%s%s:%d', $proxyScheme, $userinfo, $proxyHost, $proxyPort);
} catch (\Exception $e) {
throw new RuntimeException(sprintf("Request failed: %s", $e->getMessage()));
throw new RuntimeException(sprintf("Failed to set proxy method %s", $e->getMessage()));
}
}

/**
* fetchAccessToken gets a new access token from the authorization server.
*/
private function fetchAccessToken(string $baseUri, array $oauthConfig): string
private function fetchAccessToken(array $oauthConfig): string
{
$c = new Client(['base_uri' => $baseUri]);
// HTTP Client with common options
$c = new Client($this->baseOptions);

$params = [
'grant_type' => 'client_credentials',
Expand All @@ -130,6 +168,6 @@ private function fetchAccessToken(string $baseUri, array $oauthConfig): string
return $data['access_token'];
}

throw new RuntimeException(sprintf("No access token in response", $data));
throw new RuntimeException('No access token in response');
}
}
8 changes: 4 additions & 4 deletions library/Servicenowimport/ProvidedHook/Director/ImportSource.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@
use Icinga\Module\Director\Web\Form\QuickForm;
use Icinga\Util\Json;

use GuzzleHttp\Exception\GuzzleException;

class ImportSource extends ImportSourceHook
{
private ?array $objectCache = null;
Expand Down Expand Up @@ -223,7 +221,7 @@ public function fetchData(): array
private function getRecordsFromTable(): array
{
$columns = null;
$query = null;
$query = '';

// Get requested columns
if ($this->getSetting('servicenow_columns') !== "") {
Expand All @@ -243,7 +241,7 @@ private function getRecordsFromTable(): array
'token' => $this->getSetting('servicenow_token'),
'username' => $this->getSetting('servicenow_username'),
'password' => $this->getSetting('servicenow_password'),
'token_url' => $this->getSetting('servicenow_oauth_token_url'),
'token_url' => $this->getSetting('servicenow_oauth_token_url'), // TODO: Currently no form input for this
'client_id' => $this->getSetting('servicenow_oauth_client_id'),
'client_secret' => $this->getSetting('servicenow_oauth_client_secret'),
'scope' => $this->getSetting('servicenow_oauth_scope'),
Expand All @@ -260,10 +258,12 @@ private function getRecordsFromTable(): array
$auth
);

// TODO: Maybe use pagination here
$resp = $client->request(
$endpoint,
[
'query' => [
// Since we not only want the sys_ids but also the actual values
'sysparm_display_value' => 'true',
'sysparm_fields' => $columns,
'sysparm_query' => rawurldecode($query),
Expand Down