Update src/WinBGP-API.ps1

Improve jobs management

.gitignore

@@ -1,6 +1,13 @@
 # Service builder executable outputs
 service/*.exe
 
+# Signed code
+engine/*.*
+
+
 # Installer outputs
 builder/*.msi
 builder/*.wixpdb
+
+# MSI Release
+release/*.msi

CHANGELOG.md

@@ -2,6 +2,56 @@
 
 All notable changes to this project will be documented in this file.
 
+## Release 1.1.4 (2025-01-13)
+
+[Full Changelog](https://github.com/webalexeu/winbgp/compare/v1.1.3...v1.1.4)
+
+**Features**
+
+- Improve API graceful shutdown
+- Add control on HealtChecks jobs through CLI
+
+**Bugfixes**
+
+## Release 1.1.3 (2025-01-07)
+
+[Full Changelog](https://github.com/webalexeu/winbgp/compare/v1.1.2...v1.1.3)
+
+**Features**
+
+- Add service start if feature is installed and routing enabled
+
+**Bugfixes**
+
+- [API restart cause failure of the engine](https://github.com/webalexeu/winbgp/issues/1)
+
+## Release 1.1.2 (2025-01-06)
+
+[Full Changelog](https://github.com/webalexeu/winbgp/compare/v1.1.1...v1.1.2)
+
+**Features**
+
+- Sign API/Engine/HealthCheck/CLI binaries
+- Force process to exit when a failure occurs
+
+**Bugfixes**
+
+**Known Issues**
+
+- API restart cause failure of the engine
+
+## Release 1.1.1 (2024-12-30)
+
+[Full Changelog](https://github.com/webalexeu/winbgp/compare/v1.1.0...v1.1.1)
+
+**Features**
+
+- Sign MSI installer
+
+**Bugfixes**
+
+**Known Issues**
+
 ## Release 1.1.0 (2024-12-20)
 
 **Features**

LICENCE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright {yyyy} {name of copyright owner}
+   Copyright 2024 Alexandre JARDON (WebalexEU)
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

builder/build.ps1

@@ -4,7 +4,11 @@ Param (
     [String] $Version,
     [Parameter(Mandatory = $false)]
     [ValidateSet("amd64", "arm64")]
-    [String] $Arch = "amd64"
+    [String] $Arch = "amd64",
+    [Parameter(ParameterSetName='Signing', Mandatory = $false)]
+    [Switch] $Sign = $false,
+    [Parameter(ParameterSetName='Signing', Mandatory = $false)]
+    [String] $CertificateThumbprint
 )
 $ErrorActionPreference = "Stop"
 
@@ -17,12 +21,43 @@ Trap {
     # Reset working dir on error
     Pop-Location
 }
+# If signing, get the certificate
+if ($Sign) {
+    $cert=Get-ChildItem Cert:\CurrentUser\My -CodeSigningCert | Where-Object { $_.Thumbprint -eq $CertificateThumbprint }
+}
 
+# Building service executable
+Write-Output "Building WinBGP service"
+& "..\service\WinBGP-Service.ps1" -Build
+Move-Item -Path "..\builder\WinBGP-Service.exe" -Destination "..\service\WinBGP-Service.exe" -Force
+if ($Sign) {
+    & "C:\Program Files (x86)\Windows Kits\10\bin\10.0.26100.0\x64\signtool.exe" sign /sha1 $CertificateThumbprint /tr http://time.certum.pl/ /td sha256 /fd sha256 /v "..\service\WinBGP-Service.exe"
+}
 
-Write-Verbose "Creating winbgp-${Version}-${Arch}.msi"
+# Building engine
+Write-Output "Building engine"
+New-Item -ItemType Directory -Path "..\engine" -Force | Out-Null
+Get-ChildItem -Path '..\src' | Where-Object {$_.Extension -eq '.ps1'} |  ForEach-Object {
+    Copy-Item -Path $_.FullName  -Destination "..\engine" -Force
+    if ($Sign) {
+        Set-AuthenticodeSignature -FilePath "..\engine\$($_.Name)" -TimestampServer 'http://time.certum.pl' -Certificate $cert 
+    }
+}
+
+Write-Output "Building winbgp-${Version}-${Arch}.msi"
 $wixArch = @{"amd64" = "x64"; "arm64" = "arm64"}[$Arch]
 
 Invoke-Expression "wix build -arch $wixArch -o .\WinBGP-$($Version)-$($Arch).msi .\files.wxs .\main.wxs -d ProductName=WinBGP -d Version=$($MsiVersion) -ext WixToolset.Firewall.wixext -ext WixToolset.UI.wixext -ext WixToolset.Util.wixext"
 
-Write-Verbose "Done!"
-Pop-Location
+Write-Output "Build complete !"
+
+# Clean temporary build folder
+Remove-Item -Path "..\engine\*"
+
+Write-Output "Release build"
+New-Item -ItemType Directory -Path "..\release" -Force | Out-Null
+Copy-Item -Path "WinBGP-$($Version)-$($Arch).msi" -Destination "..\release" -Force
+if ($Sign) {
+    & "C:\Program Files (x86)\Windows Kits\10\bin\10.0.26100.0\x64\signtool.exe" sign /sha1 $CertificateThumbprint /tr http://time.certum.pl/ /td sha256 /fd sha256 /v "..\release\WinBGP-$($Version)-$($Arch).msi"
+}
+

builder/files.wxs

@@ -20,7 +20,7 @@
             <Component Transitive="yes">
                 <File Id="winbgp_service" Source="..\service\WinBGP-Service.exe" KeyPath="yes" Vital="yes" Checksum="yes" />
                 <ServiceInstall
-                    Id="InstallExporterService"
+                    Id="InstallWinBGPService"
                     Name="WinBGP"
                     DisplayName="WinBGP Engine"
                     Description="The BGP swiss army knife of networking on Windows"
@@ -39,10 +39,10 @@
                     <ServiceDependency Id="RemoteAccess" />
                 </ServiceInstall>
                 <ServiceControl 
-                    Id="MyServiceControl" 
+                    Id="WinBGPServiceControl" 
                     Name="WinBGP" 
-                    Remove="both"
                     Stop="both"
+                    Remove="both"
                     Wait="yes" />
             </Component>
         </DirectoryRef>

builder/main.wxs

@@ -29,8 +29,8 @@
      xmlns="http://wixtoolset.org/schemas/v4/wxs"
     >
     <Package UpgradeCode="0889d60f-67d5-4bf5-8918-2d5e810f888d" Name="$(var.ProductName)" Version="$(var.Version)"
-             Manufacturer="Webalex System" Language="1033" Scope="perMachine">
-        <SummaryInformation Manufacturer="Webalex System" Description="$(var.ProductName) $(var.Version) installer" />
+             Manufacturer="WebalexEU" Language="1033" Scope="perMachine">
+        <SummaryInformation Manufacturer="WebalexEU" Description="$(var.ProductName) $(var.Version) installer" />
 
         <CustomAction Id="GenerateConfig" 
             Execute="deferred" 
@@ -75,6 +75,14 @@
             Return="check"
         />
 
+        <CustomAction Id="ServiceStart" 
+            Execute="immediate"
+            Impersonate="no" 
+            Directory="TARGETDIR" 
+            ExeCommand="powershell.exe -ExecutionPolicy Bypass -Command &quot;if ((Get-RemoteAccess).RoutingStatus -eq 'Installed') { Write-Host 'Starting WinBGP service'; Start-Service -Name WinBGP -ErrorAction SilentlyContinue }&quot;"
+            Return="ignore"
+        />
+    
         <CustomAction Id="RemoveConfig" 
             Execute="deferred" 
             Impersonate="no" 
@@ -88,10 +96,11 @@
 
         <InstallExecuteSequence>
             <Custom Action="GenerateConfig" After="InstallFiles" Condition="NOT Installed AND NOT WIX_UPGRADE_DETECTED AND NOT WIX_DOWNGRADE_DETECTED" />
-            <Custom Action="EnableWindowsFeature" After="InstallFiles" Condition="&amp;Features=3 AND NOT Installed" />
-            <Custom Action="EnableWindowsFeatureRSAT" After="EnableWindowsFeature" Condition="&amp;Features=3 AND NOT Installed" />
-            <Custom Action="EnableRouting" After="EnableWindowsFeatureRSAT" Condition="&amp;Features=3 AND NOT Installed" /> <!-- TO CHECK to use Condition="MAINTENANCE" for upgrade  -->
-            <ScheduleReboot After="InstallFinalize" Condition="&amp;Features=3 AND NOT Installed" /> <!-- TO CHECK <Condition>REBOOT_REQUIRED</Condition>  -->
+            <Custom Action="EnableWindowsFeature" After="InstallFiles" Condition="&amp;Features=3 AND NOT Installed AND (MsiNTProductType=2 OR MsiNTProductType=3)" />
+            <Custom Action="EnableWindowsFeatureRSAT" After="EnableWindowsFeature" Condition="&amp;Features=3 AND NOT Installed AND (MsiNTProductType=2 OR MsiNTProductType=3)" />
+            <Custom Action="EnableRouting" After="EnableWindowsFeatureRSAT" Condition="&amp;Features=3 AND NOT Installed AND (MsiNTProductType=2 OR MsiNTProductType=3)" />
+            <Custom Action="ServiceStart" After="InstallFinalize" Condition='NOT REMOVE="ALL" AND (MsiNTProductType=2 OR MsiNTProductType=3)' />
+            <ScheduleReboot After="InstallFinalize" Condition="&amp;Features=3 AND NOT Installed AND NOT (WIX_UPGRADE_DETECTED OR UPGRADINGPRODUCTCODE) AND (MsiNTProductType=2 OR MsiNTProductType=3)" /> <!-- TO CHECK <Condition>REBOOT_REQUIRED</Condition>  -->
             <Custom Action='RemoveConfig' Before='RemoveFiles' Condition='Installed AND (REMOVE="ALL") AND NOT (WIX_UPGRADE_DETECTED OR UPGRADINGPRODUCTCODE)' />
         </InstallExecuteSequence>
 
@@ -127,7 +136,7 @@
                 Id="Features"
                 Level="1"
                 Title="Routing features"
-                Description="Enable required windows features for routing capabilities"
+                Description="Enable required windows features for routing capabilities (Only available on Windows Server)"
                 Display="expand"
                 AllowAdvertise="no"
                 InstallDefault="local"
@@ -167,13 +176,13 @@
         <StandardDirectory Id="ProgramFiles64Folder">
             <Directory Id="APPLICATIONFOLDER" Name="WinBGP">
                 <Component Id="winbgp_engine" Guid="a7b5748a-16c9-4594-85ad-de032fb3f39c">
-                    <File Id="winbgp_engine" Source="..\src\WinBGP-Engine.ps1" KeyPath="yes" Vital="yes" Checksum="yes" />
+                    <File Id="winbgp_engine" Source="..\engine\WinBGP-Engine.ps1" KeyPath="yes" Vital="yes" Checksum="yes" />
                 </Component>
                 <Component Id="winbgp_healthcheck" Guid="8a356315-8307-4508-b19d-00eb05e59428">
-                    <File Id="winbgp_healthcheck" Source="..\src\WinBGP-HealthCheck.ps1" KeyPath="yes" Vital="yes" Checksum="yes" />
+                    <File Id="winbgp_healthcheck" Source="..\engine\WinBGP-HealthCheck.ps1" KeyPath="yes" Vital="yes" Checksum="yes" />
                 </Component>
                 <Component Id="winbgp_api" Guid="77de0ab1-0e53-4967-9469-142f49b397a4">
-                    <File Id="winbgp_api" Source="..\src\WinBGP-API.ps1" KeyPath="yes" Vital="yes" Checksum="yes" />
+                    <File Id="winbgp_api" Source="..\engine\WinBGP-API.ps1" KeyPath="yes" Vital="yes" Checksum="yes" />
                 </Component>
                 <Component Id="winbgp_config" Guid="03063c39-1063-4126-b974-5cad888d5804" NeverOverwrite="yes" Permanent="yes" >
                     <File Id="winbgp_config" Name="winbgp.json" Source="..\src\winbgp.json.example" KeyPath="yes" Checksum="yes" />
@@ -182,7 +191,7 @@
                     <File Id="winbgp_config_example" Source="..\src\winbgp.json.example" KeyPath="yes" Checksum="yes" />
                 </Component>
                 <Component Id="winbgp_cli" Guid="b74d4be4-3de4-4006-a271-b56d078d2bcc">
-                    <File Id="winbgp_cli" Source="..\src\WinBGP.ps1" KeyPath="yes" Vital="yes" Checksum="yes" />
+                    <File Id="winbgp_cli" Source="..\engine\WinBGP.ps1" KeyPath="yes" Vital="yes" Checksum="yes" />
                 </Component>
             </Directory>
         </StandardDirectory>

service/WinBGP-Service.ps1

@@ -897,10 +897,10 @@ if ($Build) {                   # Install the service
   # Generate the service .EXE from the C# source embedded in this script
 
   # Overwrite for builder
-  $exeFullName=".\$exeName"
+  $exeFullName=$exeName
 
   try {
-    Write-Verbose "Compiling $exeFullName"
+    Write-Output "Compiling $exeFullName"
     Add-Type -TypeDefinition $source -Language CSharp -OutputAssembly $exeFullName -OutputType ConsoleApplication -ReferencedAssemblies "System.ServiceProcess" -Debug:$false
   } catch {
     $msg = $_.Exception.Message

src/WinBGP-API.ps1

@@ -23,7 +23,7 @@ Param (
     $Configuration=$false
 )
 
-$scriptVersion = '1.1.1'
+$scriptVersion = '1.1.2'
 
 # Create detailled log for WinBGP-API
 # New-EventLog –LogName Application –Source 'WinBGP-API' -ErrorAction SilentlyContinue
@@ -316,6 +316,10 @@ if ($Configuration) {
         }
         # Starting listerner
         $listener.Start()
+
+        # Flag to control the loop
+        $keepListening = $true
+
         # Output listeners
         foreach ($ListenerPrefixe in $ListenerPrefixes) {
             [String]$Protocol = $ListenerPrefixe.Split('://')[0]
@@ -324,11 +328,12 @@ if ($Configuration) {
             Write-Log -Message "API started - Listening on '$($IP):$($Port)' (Protocol: $Protocol)"
         }
         
-        while ($listener.IsListening) {
+        while (($listener.IsListening) -and ($keepListening)) {
             # Default return
             $statusCode = [System.Net.HttpStatusCode]::OK
             $commandOutput = [string]::Empty
             $outputHeader = @{}
+            # Accept incoming request
             $context = $listener.GetContext()
             $request = $context.Request
             [string]$RequestHost=$request.RemoteEndPoint
@@ -358,6 +363,8 @@ if ($Configuration) {
                 # Write-Log "API request received: $FullRequest" -EventLogSource 'WinBGP-API'
                 $FullPath=($request.RawUrl).substring(1)
                 $Path=$FullPath.Split('?')[0]
+                switch -wildcard ($FullPath) {
+                    'api*' {
                         switch ($request.HttpMethod) {
                             'GET' {
                                 if ($FullPath -eq 'api') {
@@ -449,55 +456,9 @@ if ($Configuration) {
                                             $statusCode = [System.Net.HttpStatusCode]::NotImplemented
                                         }
                                     }
-                        } elseif ($FullPath -eq 'metrics') {
-                            # Define WinBGP Prometheus metrics
-                            $WinBGP_metrics=@()
-                            
-                            # WinBGP peer status
-                            $state_peerDescriptor=New-PrometheusMetricDescriptor -Name winbgp_state_peer -Type gauge -Help 'WinBGP Peers status' -Labels local_asn,local_ip,name,peer_asn,peer_ip,state
-                            $peerStatus=@('connected','connecting','stopped')
-                            # Try/catch to detect if BGP is configured properly
-                            $BgpStatus=$null
-                            try {
-                                $peersCurrentStatus=Get-BgpPeer -ErrorAction SilentlyContinue | Select-Object PeerName,LocalIPAddress,LocalASN,PeerIPAddress,PeerASN,@{Label='ConnectivityStatus';Expression={$_.ConnectivityStatus.ToString()}}
-                            }
-                            catch {
-                              #If BGP Router (Local) is not configured, catch it
-                              $BgpStatus=($_).ToString()
-                            }
-                            if ($BgpStatus -eq 'BGP is not configured.') {
-                                $peersCurrentStatus=$null
-                            }
-                            # Parse all peers and generate metric
-                            foreach ($peerCurrentStatus in $peersCurrentStatus) {
-                                foreach ($status in $peerStatus) {
-                                    $WinBGP_metrics+=New-PrometheusMetric -PrometheusMetricDescriptor $state_peerDescriptor -Value $(if ($status -eq $peerCurrentStatus.ConnectivityStatus) { 1 } else { 0 }) -Labels $peerCurrentStatus.LocalASN,$peerCurrentStatus.LocalIPAddress,$peerCurrentStatus.PeerName,$peerCurrentStatus.PeerASN,$peerCurrentStatus.PeerIPAddress,$status
-                                }
-                            }
-
-                            # WinBGP route status
-                            $state_routeDescriptor=New-PrometheusMetricDescriptor -Name winbgp_state_route -Type gauge -Help 'WinBGP routes status' -Labels family,maintenance_timestamp,name,network,state
-                            $routeStatus=@('down','maintenance','up','warning')
-                            # Silently continue as WinBGP is generating errors when BGP is not configured (TO REVIEW)
-                            $routesCurrentStatus=(WinBGP -ErrorAction SilentlyContinue | Select-Object Name,Network,Status,@{Label='MaintenanceTimestamp';Expression={($_.MaintenanceTimestamp).ToString("yyyy-MM-ddTHH:mm:ss.fffK")}})
-                            foreach ($routeCurrentStatus in $routesCurrentStatus) {
-                                foreach ($status in $routeStatus) {
-                                    $WinBGP_metrics+=New-PrometheusMetric -PrometheusMetricDescriptor $state_routeDescriptor -Value $(if ($status -eq $routeCurrentStatus.Status) { 1 } else { 0 }) -Labels 'ipv4',$routeCurrentStatus.MaintenanceTimestamp,$routeCurrentStatus.Name,$routeCurrentStatus.Network,$status
-                                }
-                            }
-
-                            # Return output
-                            $commandOutput = Export-PrometheusMetrics -Metrics $WinBGP_metrics
-                            
-                            # Add header
-                            $outputHeader.Add('Content-Type', 'text/plain; version=0.0.4; charset=utf-8')
-                            $statusCode = [System.Net.HttpStatusCode]::OK
-                        } else {
-                            $statusCode = [System.Net.HttpStatusCode]::NotImplemented
                                 }
                             }
                             'POST' {
-                        if ($FullPath -like 'api/*') {
                                 $RouteName = $request.QueryString.Item("RouteName")
                                 $Path=$Path.replace('api/','')
                                 Write-Log "API received POST request '$Path' from '$RequestUser' - Source IP: '$RequestHost'" -AdditionalFields $RouteName
@@ -535,10 +496,151 @@ if ($Configuration) {
                                     'Success' { $statusCode = [System.Net.HttpStatusCode]::OK }
                                     'WinBGP not ready' { $statusCode = [System.Net.HttpStatusCode]::InternalServerError }
                                 }
-                        } else {
+                            }
+                            Default {
                                 $statusCode = [System.Net.HttpStatusCode]::NotImplemented
                             }
                         }
+                    }
+                    'metrics' {
+                        switch ($request.HttpMethod) {
+                            'GET' {
+                                # Define WinBGP Prometheus metrics
+                                $WinBGP_metrics=@()
+                                
+                                # WinBGP peer status
+                                $state_peerDescriptor=New-PrometheusMetricDescriptor -Name winbgp_state_peer -Type gauge -Help 'WinBGP Peers status' -Labels local_asn,local_ip,name,peer_asn,peer_ip,state
+                                $peerStatus=@('connected','connecting','stopped')
+                                # Try/catch to detect if BGP is configured properly
+                                $BgpStatus=$null
+                                try {
+                                    $peersCurrentStatus=Get-BgpPeer -ErrorAction SilentlyContinue | Select-Object PeerName,LocalIPAddress,LocalASN,PeerIPAddress,PeerASN,@{Label='ConnectivityStatus';Expression={$_.ConnectivityStatus.ToString()}}
+                                }
+                                catch {
+                                    # If BGP Router (Local) is not configured, catch it
+                                    $BgpStatus=($_).ToString()
+                                }
+                                if ($BgpStatus -eq 'BGP is not configured.') {
+                                    $peersCurrentStatus=$null
+                                }
+                                # Parse all peers and generate metric
+                                foreach ($peerCurrentStatus in $peersCurrentStatus) {
+                                    foreach ($status in $peerStatus) {
+                                        $WinBGP_metrics+=New-PrometheusMetric -PrometheusMetricDescriptor $state_peerDescriptor -Value $(if ($status -eq $peerCurrentStatus.ConnectivityStatus) { 1 } else { 0 }) -Labels $peerCurrentStatus.LocalASN,$peerCurrentStatus.LocalIPAddress,$peerCurrentStatus.PeerName,$peerCurrentStatus.PeerASN,$peerCurrentStatus.PeerIPAddress,$status
+                                    }
+                                }
+                            
+                                # WinBGP route status
+                                $state_routeDescriptor=New-PrometheusMetricDescriptor -Name winbgp_state_route -Type gauge -Help 'WinBGP routes status' -Labels family,maintenance_timestamp,name,network,state
+                                $routeStatus=@('down','maintenance','up','warning')
+                                # Silently continue as WinBGP is generating errors when BGP is not configured (TO REVIEW)
+                                $routesCurrentStatus=(WinBGP -ErrorAction SilentlyContinue | Select-Object Name,Network,Status,@{Label='MaintenanceTimestamp';Expression={($_.MaintenanceTimestamp).ToString("yyyy-MM-ddTHH:mm:ss.fffK")}})
+                                foreach ($routeCurrentStatus in $routesCurrentStatus) {
+                                    foreach ($status in $routeStatus) {
+                                        $WinBGP_metrics+=New-PrometheusMetric -PrometheusMetricDescriptor $state_routeDescriptor -Value $(if ($status -eq $routeCurrentStatus.Status) { 1 } else { 0 }) -Labels 'ipv4',$routeCurrentStatus.MaintenanceTimestamp,$routeCurrentStatus.Name,$routeCurrentStatus.Network,$status
+                                    }
+                                }
+                            
+                                # Return output
+                                $commandOutput = Export-PrometheusMetrics -Metrics $WinBGP_metrics
+                                
+                                # Add header
+                                $outputHeader.Add('Content-Type', 'text/plain; version=0.0.4; charset=utf-8')
+                                $statusCode = [System.Net.HttpStatusCode]::OK
+                            }
+                            Default {
+                                $statusCode = [System.Net.HttpStatusCode]::NotImplemented
+                            }
+                        }
+                    }
+                    'mcp' {
+                        # Always send json header for MCP
+                        $outputHeader.Add('Content-Type', 'application/json')
+                        # Body request
+                        $requestBodyReader = New-Object System.IO.StreamReader $request.InputStream
+                        $requestBody=$requestBodyReader.ReadToEnd()
+                        $jsonRequestBody=$requestBody | convertfrom-json
+                        switch ($request.HttpMethod) {
+                            'GET' {
+                                # Send not allowed (405) to avoid switching to SSE
+                                $statusCode = [System.Net.HttpStatusCode]::MethodNotAllowed
+                            }
+                            'POST' {
+                                switch ($jsonRequestBody.method) {
+                                    'initialize' {
+                                        $commandOutput = '{"jsonrpc":"2.0","id":' + ($jsonRequestBody.id | ConvertTo-Json -Depth 10 -Compress) + ',"result":{"protocolVersion":"2025-03-26","capabilities":{"tools":{"listChanged":false}},"serverInfo":{"name":"WinBGP MCP Server","version":"0.1.0"}}}'
+                                        $statusCode = [System.Net.HttpStatusCode]::OK
+                                    }
+                                    'notifications/initialized' {
+                                        # Accept the initialization request
+                                        $statusCode = [System.Net.HttpStatusCode]::Accepted
+                                    }
+                                    'notifications/responses' {
+                                        # Accept the notification request
+                                        $statusCode = [System.Net.HttpStatusCode]::Accepted
+                                    }
+                                    'tools/list' {
+                                        $toolsListJson = '{"name":"Get-WinBGPRoute","description":"Get-WinBGPRoute","inputSchema":{"type":"object","properties":{"ComputerName":{"type":"string","description":"Single or multiple ComputerName (Default: localhost)"},"Name":{"type":"string","description":"Single or multiple Route Name (IntelliSense availalble)"}},"required":[]},"returns":{"type":"string","description":"Get-WinBGPRoute"}}'
+                                        $commandOutput = '{"jsonrpc":"2.0","id":' + ($jsonRequestBody.id | ConvertTo-Json -Depth 10 -Compress) + ',"result":{"tools":' + $toolsListJson + '}}'
+                                        $statusCode = [System.Net.HttpStatusCode]::OK
+                                    }
+                                    'tools/call' {
+                                        #$toolName = $jsonRequestBody.params.name
+                                        #$Arguments = $jsonRequestBody.params.arguments
+                                    
+                                        #$result = & $toolName @targetArgs
+                                        $result=[PSCustomObject]@{
+                                            Name                 = 'demo.webalex.lab'
+                                            Network              = '172.16.10.10/32'
+                                            Status               = 'up'
+                                            MaintenanceTimestamp = $null
+                                            ComputerName         = 'server1.webalex.lab'
+                                        }
+                                    
+                                        $callresponse = [ordered]@{
+                                            jsonrpc = "2.0"
+                                            id      = $jsonRequestBody.id
+                                            result  = @{
+                                                content = @(
+                                                    [ordered]@{
+                                                        type = "text"
+                                                        text = $result | Out-String
+                                                    }
+                                                )
+                                                isError = $false
+                                            }
+                                        }
+                                    
+                                        $commandOutput=$callresponse | ConvertTo-Json -Depth 10 -Compress
+                                        $statusCode = [System.Net.HttpStatusCode]::OK
+                                    }
+                                    Default {
+                                        $statusCode = [System.Net.HttpStatusCode]::NotImplemented
+                                    }
+                                }
+                            }
+                            Default {
+                                $statusCode = [System.Net.HttpStatusCode]::NotImplemented
+                            }
+                        }
+                    }
+                    # Add stop method to stop API (TO IMPROVE)
+                    'stop' {
+                        switch ($request.HttpMethod) {
+                            'POST' {
+                                # Only local request are authorized
+                                if ($request.IsLocal) {
+                                    $keepListening = $false
+                                    $statusCode = [System.Net.HttpStatusCode]::OK
+                                } else {
+                                    $statusCode = [System.Net.HttpStatusCode]::Forbidden
+                                }
+                            }
+                            Default {
+                                $statusCode = [System.Net.HttpStatusCode]::NotImplemented
+                            }
+                        }
+                    }
                     Default {
                         $statusCode = [System.Net.HttpStatusCode]::NotImplemented
                     }
@@ -559,7 +661,10 @@ if ($Configuration) {
             $output.Write($buffer,0,$buffer.Length)
             $output.Close()
         }
+        if ($listener.IsListening) {
             $listener.Stop()
+            $listener.Close()
+        }
     } else {
         Write-Log -Message "API failed - No Uri listener available" -Level Error
     }

src/WinBGP-Engine.ps1

@@ -54,7 +54,7 @@ Param(
 )
 
 # Don't forget to increment version when updating engine
-$scriptVersion = '1.1.0'
+$scriptVersion = '1.1.1'
 
 
 # This script name, with various levels of details
@@ -66,6 +66,9 @@ $scriptFullName = $argv0.fullname       # Ex: C:\Temp\PSService.ps1
 # Global settings
 $serviceName = "WinBGP"                # A one-word name used for net start commands
 $serviceDisplayName = "WinBGP"
+# To improve (Service name should be rationalized)
+$serviceInternalName = "$($serviceName)-Service"
+$engineName = "$($serviceName)-Engine"
 $ServiceDescription = "The BGP swiss army knife of networking on Windows"
 $pipeName = "Service_$serviceName"      # Named pipe name. Used for sending messages to the service task
 $installDir = "${ENV:ProgramW6432}\$serviceDisplayName"  # Where to install the service files
@@ -943,7 +946,7 @@ function Add-RoutePolicy() {
 #                                                                             #
 #   Function        Start-API                                                 #
 #                                                                             #
-#   Description     Starting API Engine                                       #
+#   Description     Starting API Job                                          #
 #                                                                             #
 #   Arguments       See the Param() block at the top of this script           #
 #                                                                             #
@@ -960,6 +963,7 @@ function Start-API() {
   )
   # Start API
   Write-Log "Starting API engine"
+
   # ArgumentList (,$ApiConfiguration) is to handle array as argument
   Start-Job -Name 'API' -FilePath "$installDir\$serviceDisplayName-API.ps1" -ArgumentList (,$ApiConfiguration)
 }
@@ -968,7 +972,7 @@ function Start-API() {
 #                                                                             #
 #   Function        Stop-API                                                  #
 #                                                                             #
-#   Description     Stopping API Engine                                       #
+#   Description     Stopping API Job                                          #
 #                                                                             #
 #   Arguments       See the Param() block at the top of this script           #
 #                                                                             #
@@ -980,18 +984,64 @@ function Start-API() {
 function Stop-API() {
   # Stop API
   Write-Log "Stopping API engine"
-  ### IMPROVEMENT - To be check if we can kill API properly ###
-  $ProcessID=$null
-  $ApiPID=$null
-  # Get service PID
-  $ProcessID=(Get-CimInstance Win32_Process -Filter "name = 'powershell.exe'" -OperationTimeoutSec 1 | Where-Object {$_.CommandLine -like "*'$installDir\$serviceDisplayName.ps1' -Service*"}).ProcessId
-  if ($ProcessID) {
-  # Get API PID
-    $ApiPID=(Get-WmiObject win32_process -filter "Name='powershell.exe' AND ParentProcessId=$ProcessID").ProcessId
-  }
-  Stop-Process -Id $ApiPID -Force -ErrorAction SilentlyContinue
+  # Send API stop signal (TO IMPROVE)
+  try {
+    if ((Invoke-WebRequest -Uri 'http://127.0.0.1:8888/stop' -Method Post -TimeoutSec 5).StatusCode -eq 200) {
       Stop-Job -Name 'API' -ErrorAction SilentlyContinue
       Remove-Job -Name 'API' -Force -ErrorAction SilentlyContinue
+    }
+  } catch {
+    Write-Log "Error stopping API engine: $_" -Level Error
+  }
+}
+
+#-----------------------------------------------------------------------------#
+#                                                                             #
+#   Function        Start-HealthCheck                                         #
+#                                                                             #
+#   Description     Starting HealthCheck Job                                  #
+#                                                                             #
+#   Arguments       See the Param() block at the top of this script           #
+#                                                                             #
+#   Notes                                                                     #
+#                                                                             #
+#   History                                                                   #
+#                                                                             #
+#-----------------------------------------------------------------------------#
+function Start-HealthCheck() {
+  Param
+  (
+      [Parameter(Mandatory=$true)]
+      $Route
+  )
+  # Starting HealthCheck Job
+  Write-Log "Starting HealthCheck Process" -AdditionalFields @($Route.RouteName)
+  Start-Job -Name $Route.RouteName -FilePath "$installDir\WinBGP-HealthCheck.ps1" -ArgumentList $Route
+}
+
+#-----------------------------------------------------------------------------#
+#                                                                             #
+#   Function        Stop-HealthCheck                                          #
+#                                                                             #
+#   Description     Stopping API HealthCheck                                  #
+#                                                                             #
+#   Arguments       See the Param() block at the top of this script           #
+#                                                                             #
+#   Notes                                                                     #
+#                                                                             #
+#   History                                                                   #
+#                                                                             #
+#-----------------------------------------------------------------------------#
+function Stop-HealthCheck() {
+  Param
+  (
+      [Parameter(Mandatory=$true)]
+      $Route
+  )
+  # Stopping HealthCheck Job
+  Write-Log "Stopping HealthCheck Process" -AdditionalFields @($Route.RouteName)
+  Stop-Job -Name $Route.RouteName
+  Remove-Job -Name $Route.RouteName -Force
 }
 
 #-----------------------------------------------------------------------------#
@@ -1115,9 +1165,10 @@ if ($Service) {                 # Run the service
       $configuration = Get-Content -Path $configdir | ConvertFrom-Json 
       Write-Log "Loading configuration file '$($configdir)'"
     } else {
-      Write-Log "Configuration file '$($configdir)' is not valid - Stopping $($serviceDisplayName) process" -Level Error
+      Write-Log "Configuration file '$($configdir)' is not valid" -Level Warning
+      Write-Log "Stopping $($serviceInternalName) process" -Level Error
       # Forcing stop process so service will know that process is not running
-      Stop-Process -Name $serviceDisplayName -Force
+      Stop-Process -Name $serviceInternalName -Force
       exit 1
     }
 
@@ -1210,8 +1261,7 @@ if ($Service) {                 # Run the service
         Write-Log "Route '$($route.RouteName)' is in maintenance mode" -AdditionalFields @($route.RouteName)
       } else {
         # Starting HealthCheck Job
-        Write-Log "Starting HealthCheck Process" -AdditionalFields @($route.RouteName)
-        Start-Job -Name $route.RouteName -FilePath "$installDir\WinBGP-HealthCheck.ps1" -ArgumentList $route
+        Start-HealthCheck -Route $route
       }
     }
 
@@ -1301,7 +1351,6 @@ if ($Service) {                 # Run the service
                       # Start Api
                       Start-API -ApiConfiguration $configuration.api
                     } else {
-                      ### TO BE IMPROVED because killing all healthchecks jobs ###
                       # Stop Api
                       Stop-API
                     }
@@ -1334,9 +1383,7 @@ if ($Service) {                 # Run the service
                     if ($routeReloaded.SideIndicator -eq '<=') {
                       Write-Log "Route '$($routeReloaded.RouteName)' removed" -AdditionalFields @($oldRoute.RouteName)
                       # Stopping HealthCheck Job
-                      Write-Log "Stopping HealthCheck Process" -AdditionalFields @($oldRoute.RouteName)
-                      Stop-Job -Name $oldRoute.RouteName
-                      Remove-Job -Name $oldRoute.RouteName -Force
+                      Stop-HealthCheck -Route $oldRoute
                       # Remove routing policy
                       if (get-BgpRoutingPolicy -Name $oldRoute.RouteName -ErrorAction SilentlyContinue) {
                         Write-Log "Removing BGP Routing Policy [$($oldRoute.RouteName)]" -AdditionalFields @($oldRoute.RouteName)
@@ -1363,8 +1410,7 @@ if ($Service) {                 # Run the service
                       # Create routing policies
                       Add-RoutePolicy -Route $route -Peers $configuration.peers
                       # Starting HealthCheck Job
-                      Write-Log "Starting HealthCheck Process" -AdditionalFields @($route.RouteName)
-                      Start-Job -Name $route.RouteName -FilePath "$installDir\WinBGP-HealthCheck.ps1" -ArgumentList $route
+                      Start-HealthCheck -Route $route
                     } elseif ($routeReloaded.SideIndicator -eq '==') {
                       # Comparing old route and new route to check if there are updates to perform
                       if (($route.Network -ne $oldRoute.Network) -or ($route.DynamicIpSetup -ne $oldRoute.DynamicIpSetup) -or ($route.Interface -ne $oldRoute.Interface) -or ($route.Interval -ne $oldRoute.Interval) -or (Compare-Object -ReferenceObject $oldRoute.Community -DifferenceObject $route.Community) -or ($route.Metric -ne $oldRoute.Metric) -or ($route.NextHop -ne $oldRoute.NextHop) -or ($route.WithdrawOnDown -ne $oldRoute.WithdrawOnDown) -or ($route.WithdrawOnDownCheck -ne $oldRoute.WithdrawOnDownCheck)) {
@@ -1376,10 +1422,9 @@ if ($Service) {                 # Run the service
                           # If WithdrawOnDown change, restart healthcheck
                           Write-Log "Restarting HealthCheck Process" -AdditionalFields @($route.RouteName)
                           # Stopping HealthCheck Job
-                          Stop-Job -Name $oldRoute.RouteName
-                          Remove-Job -Name $oldRoute.RouteName -Force
+                          Stop-HealthCheck -Route $route
                           # Starting HealthCheck Job
-                          Start-Job -Name $route.RouteName -FilePath "$installDir\WinBGP-HealthCheck.ps1" -ArgumentList $route
+                          Start-HealthCheck -Route $route
                         }
                         # Manage WithdrawOnDownCheck change (Only if WithdrawOnDown was enabled and it still enabled)
                         if ($route.WithdrawOnDown -and $oldRoute.WithdrawOnDown) {
@@ -1387,22 +1432,18 @@ if ($Service) {                 # Run the service
                             Write-Log "WithdrawOnDownCheck change - Old Check: '$($oldRoute.WithdrawOnDownCheck)' - New Check: '$($route.WithdrawOnDownCheck)'"  -AdditionalFields @($Route.RouteName)
                             Write-Log "Restarting HealthCheck Process" -AdditionalFields @($route.RouteName)
                             # Stopping HealthCheck Job
-                            Stop-Job -Name $oldRoute.RouteName
-                            Remove-Job -Name $oldRoute.RouteName -Force
+                            Stop-HealthCheck -Route $oldRoute
                             # Starting HealthCheck Job
-                            Start-Job -Name $route.RouteName -FilePath "$installDir\WinBGP-HealthCheck.ps1" -ArgumentList $route
+                            Start-HealthCheck -Route $route
                           }
                         }
                         # Manage interval change
                         if ($route.Interval -ne $oldRoute.Interval) {
                           Write-Log "Interval change - Old Interval: '$oldRouteInterval' - New Interval: '$period'"  -AdditionalFields @($Route.RouteName)
                           # Stopping HealthCheck Job
-                          Write-Log "Stopping HealthCheck Process" -AdditionalFields @($oldRoute.RouteName)
-                          Stop-Job -Name $oldRoute.RouteName
-                          Remove-Job -Name $oldRoute.RouteName -Force
+                          Stop-HealthCheck -Route $oldRoute
                           # Starting HealthCheck Job
-                          Write-Log "Starting HealthCheck Process" -AdditionalFields @($route.RouteName)
-                          Start-Job -Name $route.RouteName -FilePath "$installDir\WinBGP-HealthCheck.ps1" -ArgumentList $route
+                          Start-HealthCheck -Route $route
                         }
                         # Manage network change
                         if ($route.Network -ne $oldRoute.Network) {
@@ -1533,7 +1574,7 @@ if ($Service) {                 # Run the service
                     }
                   }
                 } else {
-                  Write-Log "Reload aborted - Configuration file '$($configdir)' is not a valid JSON file" -Level Error
+                  Write-Log "Reload aborted - Configuration file '$($configdir)' is not a valid JSON file" -Level Warning
                 }
                 $pipeThread = Start-PipeHandlerThread $pipeName -Event "ControlMessage"
               }
@@ -1591,9 +1632,7 @@ if ($Service) {                 # Run the service
                     # Export maintenance variable on each change (To be moved to function)
                     $maintenance | Export-CliXml -Path $FunctionCliXml -Force
                     # Stopping HealthCheck Job
-                    Write-Log "Stopping HealthCheck Process" -AdditionalFields @($route_maintenance.RouteName)
-                    Stop-Job -Name $route_maintenance.RouteName
-                    Remove-Job -Name $route_maintenance.RouteName -Force
+                    Stop-HealthCheck -Route $route_maintenance
                     # Removing route
                     if ((Get-BgpCustomRoute).Network -contains "$($route_maintenance.Network)") {
                       remove-Bgp -Route $route_maintenance
@@ -1614,8 +1653,7 @@ if ($Service) {                 # Run the service
                     # Export maintenance variable on each change (To be moved to function)
                     $maintenance | Export-CliXml -Path $FunctionCliXml -Force
                     # Starting HealthCheck Job
-                    Write-Log "Starting HealthCheck Process" -AdditionalFields @($route_maintenance.RouteName)
-                    Start-Job -Name $route_maintenance.RouteName -FilePath "$installDir\WinBGP-HealthCheck.ps1" -ArgumentList $route_maintenance
+                    Start-HealthCheck -Route $route_maintenance
                   }
                   else {
                     Write-Log "Route '$($route_maintenance.RouteName)' was not in maintenance mode" -Level Warning
@@ -1633,6 +1671,29 @@ if ($Service) {                 # Run the service
                 # Start another thread waiting for control messages
                 $pipeThread = Start-PipeHandlerThread $pipeName -Event "ControlMessage"
               }
+              elseif ($message -like 'healthcheck*') {
+                $route_to_control=$message.split(' ')[1]
+                $control_action=$message.split(' ')[2]
+                # Grabbing route
+                $route_healthcheck=$configuration.routes | Where-Object {$_.RouteName -eq $route_to_control}
+                if ($control_action -eq 'start') {
+                  # Start HealthCheck
+                  Start-HealthCheck -Route $route_healthcheck
+                }
+                elseif ($control_action -eq 'stop') {
+                  # Stop HealthCheck
+                  Stop-HealthCheck -Route $route_healthcheck
+                } elseif ($control_action -eq 'restart') {
+                  # Log
+                  Write-Log "Restarting HealthCheck engine"
+                  # Stop HealthCheck
+                  Stop-HealthCheck -Route $route_healthcheck
+                  # Start HealthCheck
+                  Start-HealthCheck -Route $route_healthcheck
+                }
+                # Start another thread waiting for control messages
+                $pipeThread = Start-PipeHandlerThread $pipeName -Event "ControlMessage"
+              }
               elseif (($message -ne "stop") -and ($message -ne "suspend")) { # Start another thread waiting for control messages
                 $pipeThread = Start-PipeHandlerThread $pipeName -Event "ControlMessage"
               }
@@ -1667,7 +1728,7 @@ if ($Service) {                 # Run the service
                 # Cleaning unhealthy HealthCheck
                 Write-Log "Restarting HealthCheck Process (Watchdog)" -AdditionalFields @($route.RouteName) -Level Warning
                 Remove-Job -Name $route.RouteName -Force -ErrorAction SilentlyContinue
-                Start-Job -Name $route.RouteName -FilePath "$installDir\WinBGP-HealthCheck.ps1" -ArgumentList $route
+                Start-HealthCheck -Route $route
               }
             }
           }
@@ -1685,9 +1746,7 @@ if ($Service) {                 # Run the service
     Write-Log -Message "Stopping HealthCheck engine"
     ForEach ($route in $configuration.routes) {
       # Stopping HealthCheck Job
-      Write-Log "Stopping HealthCheck Process" -AdditionalFields @($route.RouteName)
-      Stop-Job -Name $route.RouteName -ErrorAction SilentlyContinue
-      Remove-Job -Name $route.RouteName -Force -ErrorAction SilentlyContinue
+      Stop-HealthCheck -Route $route
     }
 
     # Stopping API
@@ -1728,6 +1787,9 @@ if ($Service) {                 # Run the service
     $msg = $_.Exception.Message
     $line = $_.InvocationInfo.ScriptLineNumber
     Write-Log -Message "Error at line ${line}: $msg" -Level Error
+    Write-Log "Stopping $($serviceInternalName) process" -Level Error
+    # Forcing stop process so service will know that process is not running (to avoid having service running without process)
+    Stop-Process -Name $serviceInternalName -Force
   } finally { # Invoked in all cases: Exception or normally by -Stop
     # Cleanup the periodic timer used in the above example
     Unregister-Event -SourceIdentifier $timerName

src/WinBGP.ps1

@@ -124,6 +124,15 @@ Param(
   [Parameter(ParameterSetName='RouteName', Mandatory=$false)]
   [Switch]$StopRoute,     # Control message to send to the service
 
+  [Parameter(ParameterSetName='RouteName', Mandatory=$false)]
+  [Switch]$StartHealthCheck,     # Control message to send to the service
+
+  [Parameter(ParameterSetName='RouteName', Mandatory=$false)]
+  [Switch]$StopHealthCheck,     # Control message to send to the service
+
+  [Parameter(ParameterSetName='RouteName', Mandatory=$false)]
+  [Switch]$RestartHealthCheck,     # Control message to send to the service
+
   [Parameter(ParameterSetName='BGPStatus', Mandatory=$false)]
   [Switch]$BGPStatus = $($PSCmdlet.ParameterSetName -eq 'BGPStatus'), # Get the current service status
 
@@ -144,7 +153,7 @@ Param(
 )
 
 # Don't forget to increment version when updating engine
-$scriptVersion = '1.0.1'
+$scriptVersion = '1.0.2'
 
 # This script name, with various levels of details
 # Ex: PSService
@@ -560,9 +569,12 @@ if ($RestartAPI) {
 }
 
 # Start/stop control or Maintenance control
-if ($StartRoute -or $StopRoute -or $StartMaintenance -or $StopMaintenance) {
+if ($StartRoute -or $StopRoute -or $StartMaintenance -or $StopMaintenance -or $StartHealthCheck -or $StopHealthCheck -or $RestartHealthCheck) {
+  if ($StartRoute -or $StopRoute -or $StartMaintenance -or $StopMaintenance ) {
     # Logging
     Write-Log "Operation for route '$RouteName' triggered by '$currentUserName'"
+  }
+
   # Read configuration
   $configuration = Get-Content -Path $configdir | ConvertFrom-Json
   $routeCheck=$null
@@ -589,6 +601,21 @@ if ($StartRoute -or $StopRoute -or $StartMaintenance -or $StopMaintenance) {
       $control="maintenance $RouteName stop"
     }
   }
+  # Start/stop control HealthCheck
+  if ($StartHealthCheck -or $StopHealthCheck -or $RestartHealthCheck) {
+    # START
+    if ($StartHealthCheck) {
+      $control="healthcheck $RouteName start"
+    }
+    # STOP
+    if ($StopHealthCheck) {
+        $control="healthcheck $RouteName stop" 
+    }
+    # RESTART
+    if ($RestartHealthCheck) {
+      $control="healthcheck $RouteName restart" 
+    }
+  }
   if($routeCheck) {
     $PipeStatus=$null
     # Performing Action