Skip to content
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.

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

Add example configurations for Windows baselines #572

Merged
merged 3 commits into from
Oct 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 3 additions & 1 deletion build.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,9 @@ $filesForWindowsPackage = @(
'RunCommandOnSet.exe',
'windowspowershell.dsc.resource.json',
'wmi.dsc.resource.json',
'wmi.resource.ps1'
'wmi.resource.ps1',
'configurations/windows_baseline.dsc.yaml',
'configurations/windows_inventory.dsc.yaml'
)

$filesForLinuxPackage = @(
Expand Down
62 changes: 62 additions & 0 deletions configurations/windows_baseline.dsc.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
# This configuration validates a Windows system against a security baseline configuration
$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json
metadata:
Microsoft.DSC:
securityContext: Elevated
resources:
- name: Validate the OS is Windows
type: Microsoft.DSC/Assertion
properties:
$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json
resources:
- name: os
type: Microsoft/OSInfo
properties:
family: Windows
- name: Registry checks
type: Microsoft.DSC/Group
dependsOn:
- "[resourceId('Microsoft.DSC/Assertion','Validate the OS is Windows')]"
properties:
$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json
resources:
- name: Default RDP port
type: Microsoft.Windows/Registry
metadata:
area: Network Access
severity: Critical
properties:
keyPath: HKLM\System\CurrentControlSet\Control\Terminal Server\WinStations\RDP-Tcp
valueName: PortNumber
valueData:
DWord: 3389
- name: Disable SMBv1
type: Microsoft.Windows/Registry
metadata:
area: Network Access
severity: Critical
properties:
keyPath: HKLM\SYSTEM\CurrentControlSet\Services\LanmanServer\Parameters
valueName: SMB1
valueData:
DWord: 0 # Disabled
- name: Disable Windows Search service
type: Microsoft.Windows/Registry
metadata:
area: Services
severity: Critical
properties:
keyPath: HKLM\SYSTEM\CurrentControlSet\Services\WSearch
valueName: Start
valueData:
DWord: 4 # Disabled
- name: Scan Removeable Drives
type: Microsoft.Windows/Registry
metadata:
area: Services
severity: Critical
properties:
keyPath: HKLM\SOFTWARE\Policies\Microsoft\Windows Defender
valueName: DisableRemovableDriveScanning
valueData:
DWord: 0 # Disabled
Original file line number Diff line number Diff line change
@@ -1,7 +1,18 @@
$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json
resources:
- name: Validate the OS is Windows
type: Microsoft.DSC/Assertion
properties:
$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json
resources:
- name: os
type: Microsoft/OSInfo
properties:
family: Windows
- name: WMI
type: Microsoft.Windows/WMI
dependsOn:
- "[resourceId('Microsoft.DSC/Assertion','Validate the OS is Windows')]"
properties:
resources:
- name: computer system
Expand Down Expand Up @@ -39,4 +50,4 @@ resources:
adaptertype:
netconnectionid:
serviceName:
netconnectionstatus: 2
netconnectionstatus: 2 # Connected
12 changes: 6 additions & 6 deletions wmi-adapter/Tests/wmi.tests.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -47,15 +47,15 @@ Describe 'WMI adapter resource tests' {
}

It 'Example config works' -Skip:(!$IsWindows) {
$configPath = Join-Path $PSScriptRoot '..\..\dsc\examples\wmi_inventory.dsc.yaml'
$configPath = Join-Path $PSScriptRoot '..\..\configurations\windows_inventory.dsc.yaml'
$r = dsc config get -p $configPath
$LASTEXITCODE | Should -Be 0
$r | Should -Not -BeNullOrEmpty
$res = $r | ConvertFrom-Json
$res.results[0].result.actualState[0].Name | Should -Not -BeNullOrEmpty
$res.results[0].result.actualState[0].BootupState | Should -BeNullOrEmpty
$res.results[0].result.actualState[1].Caption | Should -Not -BeNullOrEmpty
$res.results[0].result.actualState[1].BuildNumber | Should -BeNullOrEmpty
$res.results[0].result.actualState[4].AdapterType | Should -BeLike "Ethernet*"
$res.results[1].result.actualState[0].Name | Should -Not -BeNullOrEmpty
$res.results[1].result.actualState[0].BootupState | Should -BeNullOrEmpty
$res.results[1].result.actualState[1].Caption | Should -Not -BeNullOrEmpty
$res.results[1].result.actualState[1].BuildNumber | Should -BeNullOrEmpty
$res.results[1].result.actualState[4].AdapterType | Should -BeLike "Ethernet*"
}
}
6 changes: 0 additions & 6 deletions wmi-adapter/wmi.resource.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -165,12 +165,6 @@ elseif ($Operation -eq 'Get')

$result += @($instance_result)
}
else
{
$errmsg = "Can not find type " + $r.type + "; please ensure that Get-CimInstance returns this resource type"
Write-Trace $errmsg
exit 1
}
}
}
else # we are processing an individual resource call
Expand Down
Loading