Power Shell For WebInspect Module

Table of Contents

• Overview
• Current API Support
• Installation
• Configuration
• Example
• Logging
• Developing and Contributing
• Licensing

Overview

This is a PowerShell module that provides command-line interaction and automation for the WebInspect API.

Use Cases

Although the module can be used generically, some use cases where it can be applied include:

• Automating scans and reports from a PowerShell command line and scripts.
• Running Dynamic Scans from third party build tools where a plugin is not currently available.
• Programatically creating dashboards from WebInspect data together with data from other sources.

---

Current API Support

At present, this module can:

• Authenticate against the WebInspect API using (none, Basic and Windows authentication)
• Execute a generic WebInspect API REST command with authentication
• Query, run, start, stop and remove Scans

Development is ongoing, with the goal to add broad support for the entire API set.

Review example usage to see how the module can be used to accomplish some example tasks.

---

Installation

You can get the latest release of the PowerShellForWebInspect from the PowerShell Gallery

Install-Module -Name PowerShellForWebInspect

---

Configuration

To access the WebInspect API you will need to have installed WebInspect as per the documentation and started the Windows WebInspect API Service either automatically or using the Micro Focus Fortify Monitor Tool. Using the Monitor tool you can configure the Authentication method to use:

Assuming you have configured Basic Authentication, then you can configure this module using the following:

$Credential = Get-Credential
Set-WIConfig -ApiUri http://localhost:8083/webinspect -AuthMethod Basic -Credential $Credential

You will be requested for your authentication details after the first command which will then be stored on the filesystem for all future requests. For more information on how to authenticate please refer to USAGE.

Example

Example command:

Get-WIScans -Status "complete" -Name 'test' | Out-GridView

For more example commands, please refer to USAGE.

---

Developing and Contributing

Please see the Contribution Guide for information on how to develop and contribute.

If you have any problems, please consult GitHub Issues to see if has already been discussed.

---

Licensing

PowerShellForWebInspect is licensed under the GNU General Public license.

This is community content provided by and for the benefit of Micro Focus customers, it is not officially endorsed nor supported via Micro Focus Software Support.