Framework/Managers/AzSKPDFExtension.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
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
Set-StrictMode -Version Latest

class AzSKPDFExtension
{
    static [void] GeneratePDF([string] $reportFolderPath, [PSObject] $subscriptionObject, [PSObject] $dataObject, [bool] $isLandscape)
    {
        # Get Context Info
        $executedBy = (Get-AzureRmContext).Account

        # Verify whether word is installed on machine

        If (test-path HKLM:SOFTWARE\Classes\Word.Application)
        {
            # Initialize word file
            try
            {
                $Word = New-Object -ComObject word.application
                $Word.Visible = $false;
                $AzSKReportDoc = $Word.Documents.Add();
                if($isLandscape)
                {
                    $AzSKReportDoc.PageSetup.Orientation = 1
                }
                else
                {
                    $AzSKReportDoc.PageSetup.Orientation = 0
                }

                $pdfPath = "$reportFolderPath\SecurityReport.pdf"
                $margin = 36 # 1.26 cm
                $AzSKReportDoc.PageSetup.LeftMargin = $margin
                $AzSKReportDoc.PageSetup.RightMargin = $margin
                #$AzSKReportDoc.PageSetup.TopMargin = $margin
                $AzSKReportDoc.PageSetup.BottomMargin = $margin

                $isSubscriptionCore = $false

                $selection = $Word.Selection
                $selection.WholeStory
                $selection.Style = "No Spacing"

                # Region Front Page
                [AzSKPDFExtension]::WriteText($selection, 'DevSecOps Kit for Azure (AzSK)','Title', $true, $true, $false)
                [AzSKPDFExtension]::WriteText($selection, 'Security Report','TOC Heading', $true, $true, $false)
                $selection.InsertBreak(6)
                $selection.InsertBreak(6)
                $selection.InsertBreak(6)
                $selection.InsertBreak(6)
                $selection.InsertBreak(6)

                $TitleTableRange = $selection.Range();
                $AzSKReportDoc.Tables.Add($TitleTableRange,11,2) | Out-Null
                $AzSKTitleTable = $AzSKReportDoc.Tables.item(1)
                [AzSKPDFExtension]::WriteHeaderTableCell($AzSKTitleTable, 1, 'Subscription Name', $subscriptionObject.SubscriptionName)
                [AzSKPDFExtension]::WriteHeaderTableCell($AzSKTitleTable, 2, 'SubscriptionId', $subscriptionObject.SubscriptionId)
                [AzSKPDFExtension]::WriteHeaderTableCell($AzSKTitleTable, 3, 'AzSK Version', $dataObject.MyCommand.Version.ToString())
                [AzSKPDFExtension]::WriteHeaderTableCell($AzSKTitleTable, 4, 'Generated by', 'AzSK')
                [AzSKPDFExtension]::WriteHeaderTableCell($AzSKTitleTable, 5, 'Generated on', (get-date).ToUniversalTime().ToString("MMMM dd, yyyy HH:mm") + " (UTC)")
                [AzSKPDFExtension]::WriteHeaderTableCell($AzSKTitleTable, 6, 'Requested by', $executedBy.Id.ToString() + " (" + $executedBy.Type.ToString() + ")")
                [AzSKPDFExtension]::WriteHeaderTableCell($AzSKTitleTable, 7, 'Command Executed', $dataObject.Line.Trim())
                [AzSKPDFExtension]::WriteHeaderTableCell($AzSKTitleTable, 8, 'Documentation', 'http://aka.ms/azskdocs')
                [AzSKPDFExtension]::WriteHeaderTableCell($AzSKTitleTable, 9, 'FAQ', 'http://aka.ms/azskdocs/faq')
                [AzSKPDFExtension]::WriteHeaderTableCell($AzSKTitleTable, 10, 'Support DL', 'mailto:isrmazsksup@microsoft.com')

                $AzSKTitleTable.Borders.OutsideLineStyle = 1
                $AzSKTitleTable.Style = 'Table Grid Light'
                $AzSKTitleTable.Borders.OutsideLineStyle = 1
                $AzSKTitleTable.Borders.InsideLineStyle = 0
                $AzSKTitleTable.Columns.AutoFit()

                $Word.Selection.Start= $AzSKReportDoc.Content.End

                $selection.InsertBreak(7)
                #end region

                # Region TOC
                [AzSKPDFExtension]::WriteText($selection, 'Contents','TOC Heading', $false, $true, $false)
                $range = $Selection.Range
                $toc = $AzSKReportDoc.TablesOfContents.Add($range)
                $selection.TypeParagraph()
                $selection.InsertBreak(7)

                # End region TOC

                # Region Headers/Footers

                #$Section = $AzSKReportDoc.Sections.Item(1)
                #$Header = $Section.Footers.Item(1)
                #$Header.Range.Text = (get-date).ToUniversalTime().ToString("HH:mm MMMM dd, yyyy") + "(UTC)"
                #$Header.Range.Font.Size = 9
                #$Header.Range.ParagraphFormat.Alignment = 2
                $AzSKReportDoc.Sections(1).Footers(1).PageNumbers.Add(2)

                # End region Headers/Footers

                #region -> Add the CSV report
                $selection.TypeText("Security Report Summary");
                $selection.Style = 'Heading 1'
                $selection.TypeParagraph()
                $selection.Style = 'No Spacing'
                $selection.InsertBreak(6)

                $ReportRange = $selection.Range();

                $reportCSVFilePath = @();
                $reportCSVFilePath += Get-ChildItem -Path $reportFolderPath -Filter "*.CSV" -Recurse
                if($reportCSVFilePath.Length -le 0)
                {
                    [AzSKPDFExtension]::WriteText($selection, 'Unable to find the required security report under the report folder.','No Spacing', $false, $true, $false)
                    [AzSKPDFExtension]::WriteText($selection, 'Or','No Spacing', $true, $true, $false)
                    [AzSKPDFExtension]::WriteText($selection, 'No controls have been found to evaluate for the Subscription.','No Spacing', $false, $true, $false)
                    #throw "Didn't find the required security report under the report folder.";
                }
                else
                {
                    $controls = Import-Csv -Path $reportCSVFilePath[0].FullName
                    $isAttestedResult = $false
                    if(($controls | Measure-Object).Count -gt 0)
                    {
                        $Number_Of_Controls = (($controls | Measure-Object).Count +1)
                        if($controls[0] | Get-Member -Name "AttestedSubStatus")
                        {
                            $isAttestedResult = $true
                        }

                        if($isAttestedResult)
                        {
                            $Number_Of_Columns = 7 # ControlID, Status, RG, ResourceName, Control Severity
                        }
                        else
                        {
                            $Number_Of_Columns = 6
                        }

                        $x = 2

                        $AzSKReportDoc.Tables.Add($ReportRange,$Number_Of_Controls,$Number_Of_Columns) | Out-Null
                        $AzSKReportTable = $AzSKReportDoc.Tables.item(2)

                        $AzSKReportTable.Cell(1,1).Range.Text = "ControlId"
                        $AzSKReportTable.Cell(1,2).Range.Text = "Status"
                        $AzSKReportTable.Cell(1,3).Range.Text = "ResourceGroup"
                        $AzSKReportTable.Cell(1,4).Range.Text = "Resource"
                        $AzSKReportTable.Cell(1,5).Range.Text = "Severity"
                        $AzSKReportTable.Cell(1,6).Range.Text = "Description"
                        if($isAttestedResult)
                        {
                            $AzSKReportTable.Cell(1,7).Range.Text = "Attestation Description"
                        }

                        Foreach($control in $controls)
                        {
                             $AzSKReportTable.Cell($x,1).Range.Text=$control.ControlId
                             $AzSKReportTable.Cell($x,2).Range.Text=$control.Status
                             if($control | Get-Member -Name "ResourceGroupName")
                             {
                                $AzSKReportTable.Cell($x,3).Range.Text=$control.ResourceGroupName
                                if(($control | Get-Member -Name "ChildResourceName") -and (-Not [string]::IsNullOrEmpty($control.ChildResourceName)))
                                {
                                    $AzSKReportTable.Cell($x,4).Range.Text=$control.ResourceName + "/" + $control.ChildResourceName
                                }
                                else
                                {
                                    $AzSKReportTable.Cell($x,4).Range.Text=$control.ResourceName
                                }
                             }
                             else
                             {
                                $isSubscriptionCore = $true
                                $AzSKReportTable.Cell($x,3).Range.Text="Subscription"
                                $AzSKReportTable.Cell($x,4).Range.Text="Subscription"
                             }
                             $AzSKReportTable.Cell($x,5).Range.Text=$control.ControlSeverity
                             $AzSKReportTable.Cell($x,6).Range.Text=$control.Description
                             $AzSKReportTable.Cell($x,6).Range.Font.Size = 9

                             if($isAttestedResult -and ($control.AttestedSubStatus))
                             {
                                #$AzSKReportTable.Cell($x,7).Range.Text=$control.ActualStatus
                                $attstionDescription = "Attested Status: " + $control.AttestedSubStatus + "`vAttested By: " + $control.AttestedBy + "`vJustification: " + $control.AttesterJustification
                                $AzSKReportTable.Cell($x,7).Range.Text = $attstionDescription
                                $AzSKReportTable.Cell($x,7).Range.Font.Size = 9
                             }
                             $x++

                             #if(($control | Get-Member -Name "AttestedSubStatus") -and ($control.AttestedSubStatus))
                             #{
                                #$AzSKReportTable.Cell($x,2).Range.Text= "Actual Status : " + $control.ActualStatus

                                #$attstionDescription = "Attestation Description`vAttested Status: " + $control.AttestedSubStatus + "`vAttested By: " + $control.AttestedBy + "`vJustification: " + $control.AttesterJustification
                                #$AzSKReportTable.Cell($x,6).Range.Text = $attstionDescription
                                #$AzSKReportTable.Cell($x,6).Range.Font.Size = 9
                                #$x++;
                             # }
                        }

                        $AzSKReportTable.Style = 'Grid Table 4 - Accent 1'
                        $AzSKReportTable.Columns.Autofit()
                        $selection = $Word.Selection
                        $selection.WholeStory
                        $selection.Style = "No Spacing"
                        $wdStory = 6
                        $wdMove = 0

                        $ret = $selection.EndKey($wdStory, $wdMove)
                        $selection.TypeParagraph()
                        $selection.InsertBreak(7)
                    }
                

                    #end region

                    #region -> Adding PowerShell output

                    Get-ChildItem -Path $reportFolderPath -Directory | Where-Object {($_.Name -eq "etc")} | %{
                        $rootfolder = $_
                        [AzSKPDFExtension]::WriteText($selection, 'PowerShell Output','Heading 1', $false, $true, $false)

                        Get-ChildItem -Path $rootfolder.FullName -Recurse -Filter "PowerShellOutput.LOG" | %{
                            $logfilepath = $_
                            $log = Get-Content $logfilepath.FullName | Out-String
                            [AzSKPDFExtension]::WriteText($selection, $log,'No Spacing', $false, $true, $false)
                            $selection.TypeText("#################################################################");
                            $selection.TypeParagraph()
                        }
                    }

                    $selection.InsertBreak(7)

                    #end region -> Adding PowerShell output

                    #region -> Adding detailed logs

                    [AzSKPDFExtension]::WriteText($selection, 'Detailed Output','Heading 1', $false, $true, $false)
                    $selection.InsertBreak(6)

                    Get-ChildItem -Path $reportFolderPath -Directory | Where-Object {-not ($_.Name -eq "etc")} | %{
                        $rootfolder = $_

                        if($isSubscriptionCore)
                        {
                            [AzSKPDFExtension]::WriteText($selection, 'Subscription Name: '+ ($rootfolder.Name),'Heading 2', $false, $true, $false)
                        }
                        else
                        {
                            [AzSKPDFExtension]::WriteText($selection, 'Resource Group Name: ' + ($rootfolder.Name),'Heading 2', $false, $true, $false)
                        }
                        Get-ChildItem -Path $rootfolder.FullName -Recurse -Filter "*.LOG" | %{
                            $logfilepath = $_
                            [AzSKPDFExtension]::WriteText($selection, 'Resource Type: ' + ($logfilepath.BaseName),'Heading 3', $false, $true, $false)
                            $logs = Get-Content $logfilepath.FullName
                            ForEach($log in $logs)
                            {
                                [AzSKPDFExtension]::WriteText($selection, ($log | Out-String),'No Spacing', $false, $false, $false)
                            }

                            $selection.TypeParagraph()
                            $selection.InsertBreak(7)
                        }
                    }

                    #end region

                    # Update table of content
                    $toc.Update()
                }
            }
            catch
            {
                throw $_.Exception
            }
            finally
            {
                $wdExportFormatPDF = 17
                $wdDoNotSaveChanges = 0
                $AzSKReportDoc.ExportAsFixedFormat($pdfPath,$wdExportFormatPDF)
                $AzSKReportDoc.close([ref]$wdDoNotSaveChanges)
                $Word.Quit()
                if (test-path variable:AzSKReportDoc)
                {
                    [System.Runtime.Interopservices.Marshal]::ReleaseComObject($AzSKReportDoc) | Out-Null
                }
                if (test-path variable:word)
                {
                    [System.Runtime.Interopservices.Marshal]::ReleaseComObject($word) | Out-Null
                }
                if (test-path variable:range)
                {
                    [System.Runtime.Interopservices.Marshal]::ReleaseComObject($range) | Out-Null
                }
                if (test-path variable:ReportRange)
                {
                    [System.Runtime.Interopservices.Marshal]::ReleaseComObject($ReportRange) | Out-Null
                }
                if (test-path variable:AzSKReportTable)
                {
                    [System.Runtime.Interopservices.Marshal]::ReleaseComObject($AzSKReportTable) | Out-Null
                }
                if (test-path variable:TitleTableRange)
                {
                    [System.Runtime.Interopservices.Marshal]::ReleaseComObject($TitleTableRange) | Out-Null
                }
                if (test-path variable:AzSKTitleTable)
                {
                    [System.Runtime.Interopservices.Marshal]::ReleaseComObject($AzSKTitleTable) | Out-Null
                }

                Remove-Variable range
                [gc]::collect()
                [gc]::WaitForPendingFinalizers()
            }
        }
        else
        {
            throw ([SuppressedException]::new(("You must have Microsoft Word application installed on machine to generate PDF report."), [SuppressedExceptionType]::Generic))
        }
    }

    static [void] WriteText([PSObject] $selectionObj, [string] $textToWrite, [string] $style, [bool] $bold, [bool] $newParagraph, [bool] $newLine)
    {
        $selectionObj.TypeText($textToWrite);
        $selectionObj.Style = $style
        if($bold)
        {
            $selectionObj.Range.Font.Bold = 1
        }
        else
        {
            $selectionObj.Range.Font.Bold = 0
        }

        if($newParagraph)
        {
            $selectionObj.TypeParagraph()
        }
        if($newLine)
        {
            $selectionObj.TypeText("`v");
        }
        $selectionObj.WholeStory
        $selectionObj.Style = "No Spacing"
    }

    static [void] WriteHeaderTableCell([PSObject] $tableObj, [int] $row, [string] $title, [string] $value)
    {
        $tableObj.Cell($row,1).Range.Text = $title
        $tableObj.Cell($row,1).Range.Bold = 1
        $tableObj.Cell($row,2).Range.Text = $value
    }
}