AzSKInfo/AzSKInfo.ps1

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
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
Set-StrictMode -Version Latest
function Get-AzSKInfo
{
    
    <#
    .SYNOPSIS
    This command would help users to get details of various components of AzSK.
     
    .DESCRIPTION
    This command will fetch details of AzSK components and help user to provide details of different component using single command. Refer https://aka.ms/azskossdocs for more information
     
    .PARAMETER InfoType
        InfoType for which type of information required by user.
    .PARAMETER SubscriptionId
        Subscription id for which the security evaluation has to be performed.
    .PARAMETER ResourceGroupNames
        ResourceGroups for which the security evaluation has to be performed. Comma separated values are supported. Wildcards are not permitted. By default, the command gets all resources in the subscription.
    .PARAMETER ResourceType
        Gets only resources of the specified resource type. Wildcards are not permitted. e.g.: Microsoft.KeyVault/vaults. Run command 'Get-AzSKSupportedResourceTypes' to get the list of supported types.
    .PARAMETER ResourceTypeName
        Friendly name of resource type. e.g.: KeyVault. Run command 'Get-AzSKSupportedResourceTypes' to get the list of supported values.
    .PARAMETER ResourceNames
        Gets a resource with the specified name. Comma separated values are supported. Wildcards/like searches are not permitted. By default, the command gets all resources in the subscription.
    .PARAMETER Tag
        The tag filter for Azure resource. The expected format is @{tagName1=$null} or @{tagName = 'tagValue'; tagName2='value1'}.
    .PARAMETER TagName
        The name of the tag to query for Azure resource.
    .PARAMETER TagValue
        The value of the tag to query for Azure resource.
    .PARAMETER FilterTags
        Comma separated tags to filter the security controls. e.g.: RBAC, SOX, AuthN etc.
    .PARAMETER DoNotOpenOutputFolder
        Switch to specify whether to open output folder containing all security evaluation report or not.
    .PARAMETER UseBaselineControls
        This switch would scan only for baseline controls defined at org level
    .PARAMETER ControlIds
        Comma separated control ids to filter the security controls. e.g.: Azure_Subscription_AuthZ_Limit_Admin_Owner_Count, Azure_Storage_DP_Encrypt_At_Rest_Blob etc.
    .PARAMETER ControlSeverity
            Select one of the control severity (Critical, High, Low, Medium)
    .PARAMETER ControlIdContains
            The list of control ids for which fixes should be applied.
 
    .NOTES
    This command helps the application team to verify whether their Azure resources are compliant with the security guidance or not
 
    .LINK
    https://aka.ms/azskossdocs
 
    #>

    Param(
        [Parameter(Mandatory = $false)]
        [ValidateSet("SubscriptionInfo", "ControlInfo", "HostInfo" , "AttestationInfo", "ComplianceInfo")] 
        [Alias("itype")]
        $InfoType,

        [ResourceTypeName]
        [Alias("rtn")]
        $ResourceTypeName = [ResourceTypeName]::All,

        [string]
        [Alias("rt")]
        $ResourceType,

        [string]
        [Alias("cids")]
        $ControlIds,

        [switch]
        [Alias("ubc")]
        $UseBaselineControls,

        [string]
        [Alias("ft")]
        $FilterTags,

        [string]
        [Alias("sid","s")]
        $SubscriptionId,

        [string]
        [Alias("rgns")]
        $ResourceGroupNames,

        [string]
        [Alias("ResourceName","rns")]
        $ResourceNames,

        [ValidateSet("Critical", "High", "Medium" , "Low")] 
        [Alias("cs")]
        $ControlSeverity,

        [string]
        [Alias("cidc")]
        $ControlIdContains,

        [switch]
        [Parameter(Mandatory = $false, HelpMessage = "Switch to specify whether to open output folder.")]
        [Alias("dnof")]
        $DoNotOpenOutputFolder
    )

    Begin
    {
        [CommandHelper]::BeginCommand($PSCmdlet.MyInvocation);
        [ListenerHelper]::RegisterListeners();
    }

    Process
    {
        try 
        {
            if ([string]::IsNullOrEmpty($SubscriptionId))
            {
                if((-not [string]::IsNullOrEmpty($InfoType)) -and ($InfoType.ToString() -eq 'AttestationInfo' -or $InfoType.ToString() -eq 'ComplianceInfo'))
                {
                    $SubscriptionId = Read-Host "SubscriptionId"
                    $SubscriptionId = $SubscriptionId.Trim()
                }
                else
                {
                    $SubscriptionId = [Constants]::BlankSubscriptionId
                }
            }

            if(-not [string]::IsNullOrEmpty($InfoType))
            {
                switch ($InfoType.ToString()) 
                {
                    SubscriptionInfo 
                    {
                        $basicInfo = [BasicInfo]::new($SubscriptionId, $PSCmdlet.MyInvocation);
                        if ($basicInfo) 
                        {
                            return $basicInfo.InvokeFunction($basicInfo.GetBasicInfo);
                        }
                    }
                    ControlInfo 
                    {
                        If($PSCmdlet.MyInvocation.BoundParameters["Verbose"] -and $PSCmdlet.MyInvocation.BoundParameters["Verbose"].IsPresent)
                        {
                            $Full = $true
                        }
                        else
                        {
                            $Full = $false
                        }

                        $controlsInfo = [ControlsInfo]::new($SubscriptionId, $PSCmdlet.MyInvocation, $ResourceTypeName, $ResourceType, $ControlIds, $UseBaselineControls, $FilterTags, $Full, $ControlSeverity, $ControlIdContains);
                        if ($controlsInfo) 
                        {
                            return $controlsInfo.InvokeFunction($controlsInfo.GetControlDetails);
                        }
                    }
                    HostInfo 
                    {
                        $environmentInfo = [EnvironmentInfo]::new($SubscriptionId, $PSCmdlet.MyInvocation);
                        if ($environmentInfo) 
                        {
                            return $environmentInfo.InvokeFunction($environmentInfo.GetEnvironmentInfo);
                        }
                    }
                    AttestationInfo
                    {
                        if([string]::IsNullOrWhiteSpace($ResourceType) -and [string]::IsNullOrWhiteSpace($ResourceTypeName))
                        {
                            $ResourceTypeName = [ResourceTypeName]::All
                        }
                        $resolver = [SVTResourceResolver]::new($SubscriptionId, $ResourceGroupNames, $ResourceNames, $ResourceType, $ResourceTypeName);            

                        $attestationReport = [SVTStatusReport]::new($SubscriptionId, $PSCmdlet.MyInvocation, $resolver);
                        if ($attestationReport) 
                        {
                            $attestationReport.ControlIdString = $ControlIds;

                            [AttestationOptions] $attestationOptions = [AttestationOptions]::new();
                            #$attestationOptions.AttestationStatus = $AttestationStatus
                            $attestationReport.AttestationOptions = $attestationOptions;        
                            return  ([CommandBase]$attestationReport).InvokeFunction($attestationReport.FetchAttestationInfo);    
                        }     
                    }
                    ComplianceInfo
                    {
                        If($PSCmdlet.MyInvocation.BoundParameters["Verbose"] -and $PSCmdlet.MyInvocation.BoundParameters["Verbose"].IsPresent)
                        {
                            $Full = $true
                        }
                        else
                        {
                            $Full = $false
                        }
                        $complianceInfo = [ComplianceInfo]::new($SubscriptionId, $PSCmdlet.MyInvocation, $Full);
                        if ($complianceInfo) 
                        {
                            return $complianceInfo.InvokeFunction($complianceInfo.GetComplianceInfo);
                        }
                    }
                    Default
                    {
                        Write-Host $([Constants]::DefaultInfoCmdMsg)
                    }
                }
            }
            else
            {
                Write-Host $([Constants]::DefaultInfoCmdMsg)
            }
        }
        catch 
        {
            [EventBase]::PublishGenericException($_);
        }  
    }

    End
    {
        [ListenerHelper]::UnregisterListeners();
    }
}
function Update-AzSKPersistedState 
{    
    <#
    .SYNOPSIS
    This command helps in updating security state stored by DevOps Kit.
 
    .DESCRIPTION
    This command helps in updating security state stored by DevOps Kit.
     
    .PARAMETER SubscriptionId
        Subscription id for which DevOps Kit state has to be updated.
    .PARAMETER StateType
        This represents the specific type of DevOps Kit state that has to be updated.
    .PARAMETER FilePath
        Path to file containing list of controls for which state has to be updated.
    .PARAMETER DoNotOpenOutputFolder
        Switch to specify whether to open output folder containing all security evaluation report or not.
 
    .LINK
    https://aka.ms/azskossdocs
    #>

    Param(

        [string]
        [Parameter(Position = 0, Mandatory = $true, HelpMessage = "Subscription id for which DevOps Kit state has to be updated.", ParameterSetName = "Default")]
        [Parameter(Position = 0, Mandatory = $true, HelpMessage = "Subscription id for which DevOps Kit state has to be updated.", ParameterSetName = "UserComments")]
        [ValidateNotNullOrEmpty()]
        [Alias("sid","s")]
        $SubscriptionId,

        [string]
        [Parameter(Mandatory = $false, HelpMessage = "Path to file containing list of controls for which state has to be updated.", ParameterSetName = "UserComments")]
        [Alias("fp")]
        $FilePath,

        [ValidateSet("UserComments")]
        [Parameter(Mandatory = $true, HelpMessage = "This represents the specific type of DevOps Kit state that has to be updated.", ParameterSetName = "UserComments")]
        [Alias("st")]
        $StateType,
    
        [switch]
        [Parameter(Mandatory = $false, HelpMessage = "Switch to specify whether to open output folder containing all security evaluation report or not.", ParameterSetName = "Default")]
        [Parameter(Mandatory = $false, HelpMessage = "Switch to specify whether to open output folder containing all security evaluation report or not.", ParameterSetName = "UserComments")]
        [Alias("dnof")]
        $DoNotOpenOutputFolder
    )

    Begin
    {
        [CommandHelper]::BeginCommand($PSCmdlet.MyInvocation);
        [ListenerHelper]::RegisterListeners();
    }

    Process
    {
        try 
        {
            $persistedStateInfo = [PersistedStateInfo]::new($SubscriptionId, $PSCmdlet.MyInvocation);
            if ($persistedStateInfo -and $StateType -eq "UserComments") 
            {
                return $persistedStateInfo.InvokeFunction($persistedStateInfo.UpdatePersistedState,@($FilePath));
            }
        }
        catch 
        {
            [EventBase]::PublishGenericException($_);
        }          
    }

    End
    {
        [ListenerHelper]::UnregisterListeners();
    }
}