Feature Requests: Add Proxy Server support

Also re-arranges web content by using old content from lib/web into lib/webserver, while new lib/web contains the proxy configuration.
Fixes #19

Author: LordHepipud

doc/06-Framework-Usage.md

@@ -5,6 +5,7 @@ The Icinga PowerShell Framework ships with a bunch of Cmdlets for monitoring, me
 ## Framework Management
 
 * [Automated Framework and Component deployment](frameworkusage/01-Automated-Framework-and-Component-Deployment.md)
+* [Enable Proxy Server](frameworkusage/02-Enable-Proxy-Server.md)
 
 ## Icinga Agent Management
 

doc/31-Changelog.md

@@ -13,6 +13,7 @@ Released closed milestones can be found on [GitHub](https://github.com/Icinga/ic
 
 ### Enhancements
 
+* [#19](https://github.com/Icinga/icinga-powershell-framework/issues/19) Add support for proxy servers for web calls and re-arranges content from lib/web to lib/webserver and uses lib/web for new proxy/web calls
 * [#136](https://github.com/Icinga/icinga-powershell-framework/pull/136) Adds support to ignore empty check packages and return `Ok` instead of `Unknown` if `-IgnoreEmptyPackage` is set on `New-IcingaCheckPackage`
 * [#137](https://github.com/Icinga/icinga-powershell-framework/issues/137) Adds Cmdlet to compare a DateTime object with the current DateTime and return the offset as Integer in seconds
 * [#139](https://github.com/Icinga/icinga-powershell-framework/pull/139) Add Cmdlet `Start-IcingaShellAsUser` to open an Icinga Shell as different user for testing

doc/frameworkusage/02-Enable-Proxy-Server.md

@@ -0,0 +1,23 @@
+# Enable Proxy Server
+
+With Icinga PowerShell Framework v1.3.0 we added support for using Proxy servers while using web requests to download and fetch information. For this we added a custom function `Invoke-IcingaWebRequest` as wrapper function for `Invoke-WebRequest`.
+
+## Enable Proxy Server Support
+
+To enable the proxy server support, you simply have to use the Cmdlet `Set-IcingaFrameworkProxyServer` and set your proxy server:
+
+```powershell
+Set-IcingaFrameworkProxyServer -Server 'http://example.com:8080';
+```
+
+Once set, the Framework will automatically use this server configuration for all web requests.
+
+## Disable Proxy Server Support
+
+To disable the proxy server, you can use the same Cmdlet again, but leaving the argument empty.
+
+```powershell
+Set-IcingaFrameworkProxyServer;
+```
+
+Now all web requests are executed without the proxy server.

lib/apis/Get-IcingaDirectorSelfServiceConfig.psm1

@@ -42,7 +42,7 @@ function Get-IcingaDirectorSelfServiceConfig()
 
     $EndpointUrl = Join-WebPath -Path $DirectorUrl -ChildPath ([string]::Format('/self-service/powershell-parameters?key={0}', $ApiKey));
 
-    $response = Invoke-WebRequest -Uri $EndpointUrl -UseBasicParsing -Headers @{ 'accept' = 'application/json'; 'X-Director-Accept' = 'application/json' } -Method 'POST';
+    $response = Invoke-IcingaWebRequest -Uri $EndpointUrl -UseBasicParsing -Headers @{ 'accept' = 'application/json'; 'X-Director-Accept' = 'application/json' } -Method 'POST';
 
     if ($response.StatusCode -ne 200) {
         throw $response.Content;

lib/apis/Get-IcingaDirectorSelfServiceTicket.psm1

@@ -42,7 +42,7 @@ function Get-IcingaDirectorSelfServiceTicket()
 
     [string]$url = Join-WebPath -Path $DirectorUrl -ChildPath ([string]::Format('/self-service/ticket?key={0}', $ApiKey));
 
-    $response = Invoke-WebRequest -Uri $url -UseBasicParsing -Headers @{ 'accept' = 'application/json'; 'X-Director-Accept' = 'application/json' } -Method 'POST';
+    $response = Invoke-IcingaWebRequest -Uri $url -UseBasicParsing -Headers @{ 'accept' = 'application/json'; 'X-Director-Accept' = 'application/json' } -Method 'POST';
 
     if ($response.StatusCode -ne 200) {
         throw $response.Content;

lib/apis/Register-IcingaDirectorSelfServiceHost.psm1

@@ -60,7 +60,7 @@ function Register-IcingaDirectorSelfServiceHost()
 
     $EndpointUrl = Join-WebPath -Path $DirectorUrl -ChildPath ([string]::Format('/self-service/register-host?name={0}&key={1}', $Hostname, $ApiKey));
 
-    $response = Invoke-WebRequest -Uri $EndpointUrl -UseBasicParsing -Headers @{ 'accept' = 'application/json'; 'X-Director-Accept' = 'application/json' } -Method 'POST' -Body $DirectorConfigJson;
+    $response = Invoke-IcingaWebRequest -Uri $EndpointUrl -UseBasicParsing -Headers @{ 'accept' = 'application/json'; 'X-Director-Accept' = 'application/json' } -Method 'POST' -Body $DirectorConfigJson;
 
     if ($response.StatusCode -ne 200) {
         throw $response.Content;

lib/core/framework/Get-IcingaFrameworkServiceBinary.psm1

@@ -36,7 +36,7 @@ function Get-IcingaFrameworkServiceBinary()
 
     if ([string]::IsNullOrEmpty($FrameworkServiceUrl)) {
         if ((Get-IcingaAgentInstallerAnswerInput -Prompt 'Do you provide a custom source of the service binary?' -Default 'n').result -eq 1) {
-            $LatestRelease       = (Invoke-WebRequest -Uri 'https://github.com/Icinga/icinga-powershell-service/releases/latest' -UseBasicParsing).BaseResponse.ResponseUri.AbsoluteUri;
+            $LatestRelease       = (Invoke-IcingaWebRequest -Uri 'https://github.com/Icinga/icinga-powershell-service/releases/latest' -UseBasicParsing).BaseResponse.ResponseUri.AbsoluteUri;
             $FrameworkServiceUrl = $LatestRelease.Replace('/tag/', '/download/');
             $Tag                 = $FrameworkServiceUrl.Split('/')[-1];
             $FrameworkServiceUrl = [string]::Format('{0}/icinga-service-{1}.zip', $FrameworkServiceUrl, $Tag);
@@ -64,9 +64,7 @@ function Get-IcingaFrameworkServiceBinary()
     $UpdateBin     = Join-Path -Path $ServiceDirectory -ChildPath 'icinga-service.exe.update';
     $ServiceBin    = Join-Path -Path $ServiceDirectory -ChildPath 'icinga-service.exe';
 
-    try {
-        Invoke-WebRequest -Uri $FrameworkServiceUrl -UseBasicParsing -OutFile $ZipArchive;
-    } catch {
+    if ((Invoke-IcingaWebRequest -Uri $FrameworkServiceUrl -UseBasicParsing -OutFile $ZipArchive).HasErrors) {
         Write-IcingaConsoleError -Message 'Failed to download the Icinga Service Binary from "{0}". Please try again.' -Objects $FrameworkServiceUrl;
         return Get-IcingaFrameworkServiceBinary;
     }

lib/core/framework/Get-IcingaPowerShellModuleArchive.psm1

@@ -70,11 +70,13 @@ function Get-IcingaPowerShellModuleArchive()
             if ($branch.ToLower() -eq 'snapshot') {
                 $DownloadUrl   = [string]::Format('https://github.com/{0}/{1}/archive/master.zip', $GitHubUser, $Repository);
             } else {
-                try {
-                    $LatestRelease = (Invoke-WebRequest -Uri ([string]::Format('https://github.com/{0}/{1}/releases/latest', $GitHubUser, $Repository)) -UseBasicParsing).BaseResponse.ResponseUri.AbsoluteUri;
+                $WebResponse = Invoke-IcingaWebRequest -Uri 'https://github.com/{0}/{1}/releases/latest' -Objects $GitHubUser, $Repository -UseBasicParsing;
+
+                if ($WebResponse.HasErrors -eq $FALSE) {
+                    $LatestRelease = $WebResponse.BaseResponse.ResponseUri.AbsoluteUri;
                     $DownloadUrl   = $LatestRelease.Replace('/releases/tag/', '/archive/');
                     $Tag           = $DownloadUrl.Split('/')[-1];
-                } catch {
+                } else {
                     Write-IcingaConsoleError -Message 'Failed to fetch latest release for "{0}" from GitHub. Either the module or the GitHub account do not exist' -Objects $ModuleName;
                 }
 
@@ -110,13 +112,11 @@ function Get-IcingaPowerShellModuleArchive()
         };
     }
 
-    try {
-        $DownloadDirectory   = New-IcingaTemporaryDirectory;
-        $DownloadDestination = (Join-Path -Path $DownloadDirectory -ChildPath ([string]::Format('{0}.zip', $Repository)));
-        Write-IcingaConsoleNotice ([string]::Format('Downloading "{0}" into "{1}"', $ModuleName, $DownloadDirectory));
+    $DownloadDirectory   = New-IcingaTemporaryDirectory;
+    $DownloadDestination = (Join-Path -Path $DownloadDirectory -ChildPath ([string]::Format('{0}.zip', $Repository)));
+    Write-IcingaConsoleNotice ([string]::Format('Downloading "{0}" into "{1}"', $ModuleName, $DownloadDirectory));
 
-        Invoke-WebRequest -UseBasicParsing -Uri $DownloadUrl -OutFile $DownloadDestination;
-    } catch {
+    if ((Invoke-IcingaWebRequest -UseBasicParsing -Uri $DownloadUrl -OutFile $DownloadDestination).HasErrors) {
         Write-IcingaConsoleError ([string]::Format('Failed to download "{0}" into "{1}". Starting cleanup process', $ModuleName, $DownloadDirectory));
         Start-Sleep -Seconds 2;
         Remove-Item -Path $DownloadDirectory -Recurse -Force;

lib/core/icingaagent/getters/Get-IcingaAgentMSIPackage.psm1

@@ -21,7 +21,7 @@ function Get-IcingaAgentMSIPackage()
     $LastUpdate   = $null;
 
     if ($Version -eq 'snapshot' -Or $Version -eq 'release') {
-        $Content      = (Invoke-WebRequest -Uri $Source -UseBasicParsing).RawContent.Split("`r`n");
+        $Content      = (Invoke-IcingaWebRequest -Uri $Source -UseBasicParsing).RawContent.Split("`r`n");
         $UsePackage   = $null;
 
         foreach ($line in $Content) {
@@ -62,7 +62,7 @@ function Get-IcingaAgentMSIPackage()
     if ($SkipDownload -eq $FALSE) {
         $DownloadPath = Join-Path $Env:TEMP -ChildPath $UsePackage;
         Write-IcingaConsoleNotice ([string]::Format('Downloading Icinga 2 Agent installer "{0}" into temp directory "{1}"', $UsePackage, $DownloadPath));
-        Invoke-WebRequest -Uri (Join-WebPath -Path $Source -ChildPath $UsePackage) -OutFile $DownloadPath;
+        Invoke-IcingaWebRequest -Uri (Join-WebPath -Path $Source -ChildPath $UsePackage) -OutFile $DownloadPath;
     }
 
     return @{

lib/core/icingaagent/installer/Install-IcingaAgentCertificates.psm1

@@ -272,7 +272,7 @@ function Copy-IcingaAgentCACertificate()
         Set-IcingaTLSVersion;
         # It could also be a web ressource
         try {
-            $response   = Invoke-WebRequest $CAPath -UseBasicParsing;
+            $response   = Invoke-IcingaWebRequest $CAPath -UseBasicParsing;
             [int]$Index = $response.RawContent.IndexOf("`r`n`r`n") + 4;
 
             [string]$CAContent = $response.RawContent.SubString(