Home
Reference
Review reference information for the product.
AppScan® Source Data Access API
The Data Access API provides access to AppScan® Source-generated assessment results, including findings and finding details. It also provides access to assessment metrics such as analysis date and time, lines of code, V-density, and number of findings.
Ounce/Maven plug-in
This section describes the Ounce/Maven plug-in, which uses Maven, an Apache build tool, to integrate AppScan® Source into the Maven workflow.
Ounce/Maven goals
ounce:report

Reference
Review reference information for the product.
- The Ounce/Make build utility
  Ounce/Make is a tool that automates the importing of configuration information into AppScan® Source from build environments that use makefile. Ounce/Make eliminates the need to import configuration information from makefiles manually; this the recommended method of configuring these projects.
- AppScan® Source command line interface (CLI)
  The CLI is an interface to core AppScan® Source functionality.
- The Ounce/Ant build tool
  This section describes how to use Ounce/Ant, an AppScan® Source build utility that integrates AppScan Source and Apache Ant. Integrating Ounce/Ant with your Ant environment helps you automate builds and code assessments.
- AppScan® Source Data Access API
  The Data Access API provides access to AppScan® Source-generated assessment results, including findings and finding details. It also provides access to assessment metrics such as analysis date and time, lines of code, V-density, and number of findings.
  - Data Access API object model
  - Using the Data Access API
    You can find complete examples for a number of Data Access API scenarios in the SamplePublished.java and SampleSdk.java files included in <install_dir>\sdk\sample\com\ouncelabs\sdk\sample (where <install_dir> is the location of your AppScan® Source installation).
  - Data Access API classes and methods
  - Ounce/Maven plug-in
    This section describes the Ounce/Maven plug-in, which uses Maven, an Apache build tool, to integrate AppScan® Source into the Maven workflow.
    - Installing Ounce/Maven
    - Using Ounce/Maven
      The Ounce/Maven plug-in allows you to use Ounce/Maven to create AppScan® Source projects and applications, scan the applications, publish the resulting assessments, and generate AppScan Source reports. Specify the Ounce/Maven goals and parameters as you would for any other Maven plugin.
    - Ounce/Maven scenarios
    - Ounce/Maven goals
  - AppScan® Source for Automation
    The Automation Server (ounceautod) allows you to automate key aspects of the AppScan® Source workflow and integrate security with build environments during the software development life cycle (SDLC). The Automation Server allows you to queue requests to scan and publish assessments, and generate reports on the security of application code.
  - Framework for Frameworks handling APIs
    AppScan® Source provides a set of Java™ APIs that allow you to add support for frameworks that are used in your applications. The classes and methods offered in these APIs allow you to account for frameworks for which built-in support is not provided.
  - AppScan® Source client component error messages
  - AppScan® Source for Analysis samples
    AppScan® Source for Analysis includes a sample applicationsample applications that you can use to familiarize yourself with the product.
  - The AppScan® Source for Analysis work environment
    To get the most out of AppScan® Source, you should understand the basic concepts behind the AppScan Source for Analysis working environment and how to use the options that best fit your workflow.
  - Views and windows
    AppScan® Source for Development views and windows provide alternative presentations of findings, support code editing, and allow you to navigate the information in your workbench. A view might appear by itself, or stacked with other views in a tabbed notebook. You can change the layout of a perspective or window layout by opening and closing views and by docking them in different positions in the Workbench window.
  - CWE support
    The Common Weakness Enumeration (CWE) is an industry standard list that provides common names for publicly known software weaknesses. This topic lists the CWE IDs that are supported in the current version of AppScan® Source.
- Glossary
  Learn common product terminology.

`ounce:report`

Description

The ounce:report goal generates a report from an assessment. If you do not specify an existing assessment, ounce:report runs ounce:scan before generating the report. Run ounce:report from the command line.

Specify the report parameters described in reportType Values and reportOutputType Values. If you specify the reportType, you must also specify reportOutputType and reportOutputPath. You can also choose to include remediation information in the report.

`reportType` Values

A Findings report:
- Findings
- Findings by Fix Group
- Findings by Type
- Findings by Classification
- Findings by File
- Findings by API
- Findings by Bundle
- Findings by CWE
- DTS Activity
An AppScan® Source report:
- CWE SANS Top 25 2011
- DISA Application Security and Development STIG V4R10
- DISA Application Security and Development STIG V5R1
- OWASP Mobile Top 10
- OWASP Top 10 2013
- OWASP Top 10 2017
- PCI Data Security Standard V3.2
- Software Security Profile
A custom report, if available.

`reportOutputType` Values

Specify one of the following formats for this report:
- html: Generates the report as HTML and displays it online.
- zip: Creates a ZIP file that contains all HTML report components.
For reports in PDF format, you can specify the level of detail:
- pdf-summary: Contains counts for each custom report group
- pdf-detailed: Contains counts for each API for each vulnerability property
- pdf-comprehensive: Contains tables consisting of every finding for every API
- pdf-annotated: Contains all findings, any notes included with the findings, and designated code snippets
- pdf-annotated: Generates an annotated report as a PDF file.

Remediation information

Include How to Fix information in the report for remediation of findings:

Command line variable:
```
-Dounce.includeHowToFix
```
Example:
```
-Dounce.includeHowToFix=true
```