Customizing Reports

This appendix describes how to customize Cisco Secure Scanner HTML reports.

This appendix includes the following sections:

Customizing the Reports

There are two ways to customize the Scanner reports:

You can edit the HTML report after the Scanner generates it, which only applies to the current report.

: The report is located in ./Cisco Secure Scanner/Udo/session name/session data/report name. Use the HTML editor of your choice to modify the report.

You can edit the report templates, which affects all subsequent reports.

: This method saves you time, because you can edit the templates once and apply a corporate style to all reports generated by the Scanner. The report templates are located in ./Cisco Secure Scanner/ReportComponents.

Table A-1 lists the Scanner report components and associated files.

Table A-1: Scanner Report Component Locations

Report Component Report File

Cover

/cover/cover.html

Executive Summary

/exec/exec0001.html
/exec/exec0002.html
/exec/exec0003.html
/exec/exec0004.html

Process Overview

/assess/assess0001.html

Host Discovery

/discovery/discover0001.html

Vulnerability Assessment

/vulner/vulner0001.html

Charts

Generated by the Report Wizard

Grids

Generated by the Report Wizard

Configuration Information Appendix

Generated by the Report Wizard

Host Discovery Appendix

Generated by the Report Wizard

Vulnerability Appendix

Generated by the Report Wizard

Report Component	Report File
Cover	/cover/cover.html
Executive Summary	/exec/exec0001.html /exec/exec0002.html /exec/exec0003.html /exec/exec0004.html
Process Overview	/assess/assess0001.html
Host Discovery	/discovery/discover0001.html
Vulnerability Assessment	/vulner/vulner0001.html
Charts	Generated by the Report Wizard
Grids	Generated by the Report Wizard
Configuration Information Appendix	Generated by the Report Wizard
Host Discovery Appendix	Generated by the Report Wizard
Vulnerability Appendix	Generated by the Report Wizard

Note Tables and technical appendixes are generated by the Report Wizard. You cannot edit these components.

Revising the Templates

Use the following procedure to revise these report template files:

cover.html
exec0001.html
exec0002.html
exec0003.html
exec0004.html
assess0001.html
discover0001.html
vulner0001.html

Step 1 Back up all of the report template files.

Step 2 Make a copy of the file that you want to revise.

Step 3 Open it in an HTML editor or in NotePad.

Caution Some HTML editors add tags to the report template files that are not needed. Be sure to remove these tags after you have saved your report (see Step 7).

Step 4 Make any changes that you need to the text or headings.

Note

Table A-2

Step 5 To add graphics files in the files that you are customizing, use the report variable ($IMG_SRC) with your image filename as shown in the following example:

Step 6 Save the file.

Step 7 Remove any extraneous HTML tags by opening the file in NotePad and deleting the following tag:

<HTML><BODY><HEAD>
</HEAD></BODY></HTML>

Step 8 Move the file to the correct directory.

For example, if you revised the Cover template, move it to /cover/cover.html.

Caution You must use the default filenames.

Note See

Table A-1

Step 9 Create a new report to test your template.

Report Variables

Table A-2 lists the Scanner variables used in the HTML report templates and their definitions.
Table A-2: Report Template Variables

Variables Definition

$Exec_Section

Placeholder for link to Executive Summary

$Process_Section

Placeholder for link to Process Overview

$Discovery_Section

Placeholder for link to Discovery section

$Vulner_Section

Placeholder for link to Vulnerability section

$Chart_Section

Placeholder for link to user-defined charts

$Grid_Section

Placeholder for link to user-defined grids

$Appendixes

Placeholder for link to appendixes

$Appendix_Config

Placeholder for link to Configuration Appendix

$Appendix_Discovery

Placeholder for link to Discovery Appendix

$Appendix_Vulner

Placeholder for link to Vulnerability Appendix

$CompanyName

Your company's name

$AddressRange

Address range(s) scanned by the Scanner

$ScanSchedule

Schedule of the scan (daily, weekly, hourly, and so forth)

$StartScanDate

Date scan started

(If the scan starts and stops on the same day, this is the only variable needed.)

$StopScanDate

Date the scan stopped

$TotalScanHours

How many hours it took to complete the scan

$TotLiveHosts

Total number of live hosts discovered

$TotVulner

Total vulnerabilities discovered

$TotPotentialVulner

Total number of potentially vulnerable hosts

$TotConfirmVulner

Total number of confirmed vulnerable hosts

$NameTopSvc_1

Name of the most popular service running

$NameTopSvc_2

Name of the second most popular service running

$NameTopSvc_3

Name of the third most popular service running

$NumTopSvc_1

Total count of all hosts running $NameTopSvc_1

$NumTopSvc_2

Total count of all hosts running $NameTopSvc_2

$NumTopSvc_3

Total count of all hosts running $NameTopSvc_3

$NamTopVulp_1

Name of the most common potential vulnerability found

$NamTopVulp_2

Name of the second most common potential vulnerability found

$NamTopVulp_3

Name of the third most common potential vulnerability found

$NumTopVulp_1

Total count of hosts with $NamTopVulp_1

$NumTopVulp_2

Total count of hosts with $NamTopVulp_2

$NumTopVulp_3

Total count of hosts with $NamTopVulp_3

$NamTopVulc_1

Name of the most common confirmed vulnerability found

$NamTopVulc_2

Name of the second most common confirmed vulnerability found

$NamTopVulc_3

Name of the third most common confirmed vulnerability found

$NumTopVulc_1

Total number of hosts with $NamTopVulc_1

$NumTopVulc_2

Total number of hosts with $NamTopVulc_2

$NumTopVulc_3

Total number of hosts with $NamTopVulc_3

$TotalHostSeverityHigh

Number of hosts with high severity vulnerabilities

$TotalHostSeverityMedium

Number of hosts with medium severity vulnerabilities

$TotalHostSeverityLow

Number of hosts with low severity vulnerabilities

$TotalNumSeverityHigh

Total number of high severity vulnerabilities; if two hosts have the same high vulnerability, this number will be 2

$TotalNumSeverityMedium

Total number of medium severity vulnerabilities: if two hosts have the same medium vulnerability, this number will be 2

$TcpPortsScanned

TCP ports that have been scanned

$UdpPortsScanned

UDP ports that have been scanned

$TotalNumSeverityLow

Total number of low severity vulnerabilities; if two hosts have the same low vulnerability, this number will be 2

$IMG_SRC

This can be used to insert image files in the report; you must have the following line in the HTML file:

<!--$IMG_SRC="cover/vert.gif"-> (see "Revising the Templates" for more information)

Variables	Definition
$Exec_Section	Placeholder for link to Executive Summary
$Process_Section	Placeholder for link to Process Overview
$Discovery_Section	Placeholder for link to Discovery section
$Vulner_Section	Placeholder for link to Vulnerability section
$Chart_Section	Placeholder for link to user-defined charts
$Grid_Section	Placeholder for link to user-defined grids
$Appendixes	Placeholder for link to appendixes
$Appendix_Config	Placeholder for link to Configuration Appendix
$Appendix_Discovery	Placeholder for link to Discovery Appendix
$Appendix_Vulner	Placeholder for link to Vulnerability Appendix
$CompanyName	Your company's name
$AddressRange	Address range(s) scanned by the Scanner
$ScanSchedule	Schedule of the scan (daily, weekly, hourly, and so forth)
$StartScanDate	Date scan started (If the scan starts and stops on the same day, this is the only variable needed.)
$StopScanDate	Date the scan stopped
$TotalScanHours	How many hours it took to complete the scan
$TotLiveHosts	Total number of live hosts discovered
$TotVulner	Total vulnerabilities discovered
$TotPotentialVulner	Total number of potentially vulnerable hosts
$TotConfirmVulner	Total number of confirmed vulnerable hosts
$NameTopSvc_1	Name of the most popular service running
$NameTopSvc_2	Name of the second most popular service running
$NameTopSvc_3	Name of the third most popular service running
$NumTopSvc_1	Total count of all hosts running $NameTopSvc_1
$NumTopSvc_2	Total count of all hosts running $NameTopSvc_2
$NumTopSvc_3	Total count of all hosts running $NameTopSvc_3
$NamTopVulp_1	Name of the most common potential vulnerability found
$NamTopVulp_2	Name of the second most common potential vulnerability found
$NamTopVulp_3	Name of the third most common potential vulnerability found
$NumTopVulp_1	Total count of hosts with $NamTopVulp_1
$NumTopVulp_2	Total count of hosts with $NamTopVulp_2
$NumTopVulp_3	Total count of hosts with $NamTopVulp_3
$NamTopVulc_1	Name of the most common confirmed vulnerability found
$NamTopVulc_2	Name of the second most common confirmed vulnerability found
$NamTopVulc_3	Name of the third most common confirmed vulnerability found
$NumTopVulc_1	Total number of hosts with $NamTopVulc_1
$NumTopVulc_2	Total number of hosts with $NamTopVulc_2
$NumTopVulc_3	Total number of hosts with $NamTopVulc_3
$TotalHostSeverityHigh	Number of hosts with high severity vulnerabilities
$TotalHostSeverityMedium	Number of hosts with medium severity vulnerabilities
$TotalHostSeverityLow	Number of hosts with low severity vulnerabilities
$TotalNumSeverityHigh	Total number of high severity vulnerabilities; if two hosts have the same high vulnerability, this number will be 2
$TotalNumSeverityMedium	Total number of medium severity vulnerabilities: if two hosts have the same medium vulnerability, this number will be 2
$TcpPortsScanned	TCP ports that have been scanned
$UdpPortsScanned	UDP ports that have been scanned
$TotalNumSeverityLow	Total number of low severity vulnerabilities; if two hosts have the same low vulnerability, this number will be 2
$IMG_SRC	This can be used to insert image files in the report; you must have the following line in the HTML file: <!--$IMG_SRC="cover/vert.gif"-> (see "Revising the Templates" for more information)

Table of Contents