Module/Rule.UserRight/Convert/UserRightRule.Convert.psm1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License.
using module .\..\..\Common\Common.psm1
using module .\..\UserRightRule.psm1

$exclude = @($MyInvocation.MyCommand.Name,'Template.*.txt')
$supportFileList = Get-ChildItem -Path $PSScriptRoot -Exclude $exclude
foreach ($supportFile in $supportFileList)
{
    Write-Verbose "Loading $($supportFile.FullName)"
    . $supportFile.FullName
}
# Header

<#
    .SYNOPSIS
        Convert the contents of an xccdf check-content element into a user right object
    .DESCRIPTION
        The UserRightRule class is used to extract the {} settings from the
        check-content of the xccdf. Once a STIG rule is identified a
        user right rule, it is passed to the UserRightRule class for parsing
        and validation.
#>

class UserRightRuleConvert : UserRightRule
{
    <#
        .SYNOPSIS
            Empty constructor for SplitFactory
    #>

    UserRightRuleConvert ()
    {
    }

    <#
        .SYNOPSIS
            Converts a xccdf STIG rule element into a User Right Rule
        .PARAMETER XccdfRule
            The STIG rule to convert
    #>

    UserRightRuleConvert ([xml.xmlelement] $XccdfRule) : base ($XccdfRule, $true)
    {
        $this.SetDisplayName()
        $this.SetConstant()
        $this.SetIdentity()
        $this.SetForce()
        $this.SetDuplicateRule()
        if (Test-ExistingRule -RuleCollection $global:stigSettings -NewRule $this)
        {
            $this.set_id((Get-AvailableId -Id $this.Id))
        }
        $this.SetDscResource()
    }

    #region Methods

    <#
        .SYNOPSIS
            Extracts the display name from the check-content and sets the value
        .DESCRIPTION
            Gets the display name from the xccdf content and sets the value. If
            the name that is returned is not valid, the parser status is set to fail.
    #>

    [void] SetDisplayName ()
    {
        $thisDisplayName = Get-UserRightDisplayName -CheckContent $this.SplitCheckContent

        if (-not $this.SetStatus($thisDisplayName))
        {
            $this.set_DisplayName($thisDisplayName)
        }
    }

    <#
        .SYNOPSIS
            Extracts the user right constant from the check-content and sets the value
        .DESCRIPTION
            Gets the user right constant from the xccdf content and sets the
            value. If the constant that is returned is not valid, the parser
            status is set to fail.
    #>

    [void] SetConstant ()
    {
        $thisConstant = Get-UserRightConstant -UserRightDisplayName $this.DisplayName

        if (-not $this.SetStatus($thisConstant))
        {
            $this.set_Constant($thisConstant)
        }
    }

    <#
        .SYNOPSIS
            Extracts the user right identity from the check-content and sets the value
        .DESCRIPTION
            Gets the user right identity from the xccdf content and sets the
            value. If the identity that is returned is not valid, the parser
            status is set to fail.
    #>

    [void] SetIdentity ()
    {
        $thisIdentity = Get-UserRightIdentity -CheckContent $this.SplitCheckContent
        $return = $true
        if ([String]::IsNullOrEmpty($thisIdentity))
        {
            $return = $false
        }
        elseif ($thisIdentity -ne 'NULL')
        {
            if ($thisIdentity -join "," -match "{Hyper-V}")
            {
                $this.SetOrganizationValueRequired()
                $HyperVIdentity = $thisIdentity -join "," -replace "{Hyper-V}", "NT Virtual Machine\\Virtual Machines"
                $NoHyperVIdentity = $thisIdentity.Where( {$PSItem -ne "{Hyper-V}"}) -join ","
                $this.set_OrganizationValueTestString("'{0}' -match '^($HyperVIdentity|$NoHyperVIdentity)$'")
            }
            elseif ($thisIdentity -contains "(Local account and member of Administrators group|Local account)")
            {
                $this.SetOrganizationValueRequired()
                $this.set_OrganizationValueTestString("'{0}' -match '$($thisIdentity -join ",")'")
            }
        }

        if ($this.OrganizationValueRequired -eq $false)
        {
            $this.Identity = $thisIdentity -Join ","
        }
    }

    <#
        .SYNOPSIS
            Extracts the force flag from the check-content and sets the value
        .DESCRIPTION
            Gets the force flag from the xccdf content and sets the value
    #>

    [void] SetForce ()
    {
        if (Test-SetForceFlag -CheckContent $this.SplitCheckContent)
        {
            $this.set_Force($true)
        }
        else
        {
            $this.set_Force($false)
        }
    }

    hidden [void] SetDscResource ()
    {
        if ($null -eq $this.DuplicateOf)
        {
            $this.DscResource = 'UserRightsAssignment'
        }
        else
        {
            $this.DscResource = 'None'
        }
    }

    static [bool] Match ([string] $CheckContent)
    {
        if
        (
            $CheckContent -Match 'gpedit\.msc' -and
            $CheckContent -Match 'User Rights Assignment' -and
            $CheckContent -NotMatch 'unresolved SIDs' -and
            $CheckContent -NotMatch 'SQL Server'
        )
        {
            return $true
        }
        return $false
    }

    <#
        .SYNOPSIS
            Tests if a rule contains multiple checks
        .DESCRIPTION
            Search the rule text to determine if multiple user rights are defined
        .PARAMETER CheckContent
            The rule text from the check-content element in the xccdf
    #>

    <#{TODO}#> # HasMultipleRules is implemented inconsistently.
    static [bool] HasMultipleRules ([string] $CheckContent)
    {
        if (Test-MultipleUserRightsAssignment -CheckContent ([UserRightRule]::SplitCheckContent($CheckContent)))
        {
            return $true
        }

        return $false
    }

    <#
        .SYNOPSIS
            Splits a rule into multiple checks
        .DESCRIPTION
            Once a rule has been found to have multiple checks, the rule needs
            to be split. This method splits a user right into multiple rules. Each
            split rule id is appended with a dot and letter to keep reporting
            per the ID consistent. An example would be is V-1000 contained 2
            checks, then SplitMultipleRules would return 2 objects with rule ids
            V-1000.a and V-1000.b
        .PARAMETER CheckContent
            The rule text from the check-content element in the xccdf
    #>

    static [string[]] SplitMultipleRules ([string] $CheckContent)
    {
        return (Split-MultipleUserRightsAssignment -CheckContent ([UserRightRule]::SplitCheckContent($CheckContent)))
    }

    #endregion
}