gsadmin/Invoke-OpenSSHConfiguration
1
0
Fork 0
mirror of https://github.com/Grace-Solutions/Invoke-OpenSSHConfiguration.git synced 2026-07-26 11:38:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

Automatic service management and Windows Firewall rules

Browse Source 
- Service auto-start and start now happen automatically (no switches)
- Windows Firewall rules created automatically per profile (Domain, Private, Public)
- Dynamic profile enumeration using [Microsoft.PowerShell.Cmdletization.GeneratedTypes.NetSecurity.Profile]
- Added -SSHPort parameter for custom port (default: 22)
- Idempotent firewall rule creation with update support
- Removed -EnableService and -StartService switches (now automatic)
This commit is contained in:
GraceSolutions
2026-05-01 15:21:54 -04:00
parent 825dfdab79
commit e566ab15f1
2 changed files with 70 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Invoke-OpenSSHConfiguration.ps1
+65 -28
View File
@@ -91,10 +91,8 @@
[String]$SFTPSubsystemPath,
[Parameter(Mandatory=$False)]
[Switch]$EnableService,
[Parameter(Mandatory=$False)]
[Switch]$StartService,
[ValidateNotNullOrEmpty()]
[Int]$SSHPort = 22,
[Parameter(Mandatory=$False)]
[ValidateNotNullOrEmpty()]
@@ -764,40 +762,79 @@ Switch (Test-ProcessElevationStatus)
}
#endregion
#region Service Management
Switch ($EnableService.IsPresent -eq $True)
#region Service Management (Automatic)
$SSHDService = Get-Service -Name 'sshd' -ErrorAction SilentlyContinue
Switch ($Null -ine $SSHDService)
{
{($_ -eq $True)}
{
$WriteLogMessage.Invoke(0, @("Configuring sshd service to start automatically. Please Wait..."))
$Null = Set-Service -Name 'sshd' -StartupType Automatic -ErrorAction SilentlyContinue
$WriteLogMessage.Invoke(0, @("sshd service configured for automatic startup."))
#region Configure Automatic Startup
Switch ($SSHDService.StartType -ine 'Automatic')
{
{($_ -eq $True)}
{
$WriteLogMessage.Invoke(0, @("Configuring sshd service to start automatically. Please Wait..."))
$Null = Set-Service -Name 'sshd' -StartupType Automatic -ErrorAction SilentlyContinue
$WriteLogMessage.Invoke(0, @("sshd service configured for automatic startup."))
}
}
#endregion
#region Start Service
Switch ($SSHDService.Status -ine 'Running')
{
{($_ -eq $True)}
{
$WriteLogMessage.Invoke(0, @("Starting sshd service. Please Wait..."))
$Null = Start-Service -Name 'sshd' -ErrorAction SilentlyContinue
$WriteLogMessage.Invoke(0, @("sshd service started."))
}
}
#endregion
}
}
#endregion
Switch ($StartService.IsPresent -eq $True)
#region Windows Firewall Configuration (Automatic)
$FirewallRuleName = 'OpenSSH-Server-In-TCP'
$FirewallProfiles = [System.Enum]::GetValues([Microsoft.PowerShell.Cmdletization.GeneratedTypes.NetSecurity.Profile])
ForEach ($FirewallProfile In $FirewallProfiles)
{
{($_ -eq $True)}
$ExistingRule = Get-NetFirewallRule -Name "$($FirewallRuleName)-$($FirewallProfile)" -ErrorAction SilentlyContinue
Switch ($Null -eq $ExistingRule)
{
$SSHDService = Get-Service -Name 'sshd' -ErrorAction SilentlyContinue
Switch ($Null -ine $SSHDService)
{($_ -eq $True)}
{
{($_ -eq $True)}
{
Switch ($SSHDService.Status -ine 'Running')
{
{($_ -eq $True)}
{
$WriteLogMessage.Invoke(0, @("Starting sshd service. Please Wait..."))
$Null = Start-Service -Name 'sshd' -ErrorAction SilentlyContinue
$WriteLogMessage.Invoke(0, @("sshd service started."))
}
$WriteLogMessage.Invoke(0, @("Creating Windows Firewall rule for profile `"$($FirewallProfile)`". Please Wait..."))
Default
{
$WriteLogMessage.Invoke(0, @("sshd service is already running."))
}
$FirewallRuleParameters = New-Object -TypeName 'System.Collections.Specialized.OrderedDictionary'
$FirewallRuleParameters.Add('Name', "$($FirewallRuleName)-$($FirewallProfile)")
$FirewallRuleParameters.Add('DisplayName', "OpenSSH SSH Server ($($FirewallProfile))")
$FirewallRuleParameters.Add('Description', "Inbound rule for OpenSSH SSH Server on TCP port $($SSHPort) for $($FirewallProfile) profile")
$FirewallRuleParameters.Add('Enabled', 'True')
$FirewallRuleParameters.Add('Direction', 'Inbound')
$FirewallRuleParameters.Add('Protocol', 'TCP')
$FirewallRuleParameters.Add('LocalPort', $SSHPort)
$FirewallRuleParameters.Add('Profile', $FirewallProfile)
$FirewallRuleParameters.Add('Action', 'Allow')
$FirewallRuleParameters.Add('ErrorAction', 'SilentlyContinue')
$Null = New-NetFirewallRule @FirewallRuleParameters
$WriteLogMessage.Invoke(0, @("Windows Firewall rule created for profile `"$($FirewallProfile)`"."))
}
Default
{
Switch (($ExistingRule.Enabled -eq $False) -or ($ExistingRule.LocalPort -ne $SSHPort))
{
{($_ -eq $True)}
{
$WriteLogMessage.Invoke(0, @("Updating Windows Firewall rule for profile `"$($FirewallProfile)`". Please Wait..."))
$Null = Set-NetFirewallRule -Name "$($FirewallRuleName)-$($FirewallProfile)" -Enabled 'True' -LocalPort $SSHPort -ErrorAction SilentlyContinue
$WriteLogMessage.Invoke(0, @("Windows Firewall rule updated for profile `"$($FirewallProfile)`"."))
}
}
}