StackHawk

Windows users wishing to install the <a href="https://docs.stackhawk.com/stackhawk-cli/" rel="nofollow noopener noreferrer" target="_blank">HawkScan CLI</a> may do so conveniently with either:

Option 1: Windows MSI Installer (Beta)

See <a href="https://docs.stackhawk.com/stackhawk-cli/#install-with-msi-windows-beta" rel="nofollow noopener noreferrer" target="_blank">Install with MSI (Windows) (BETA)</a>

- See <a href="https://docs.stackhawk.com/stackhawk-cli/#install-with-msi-windows-beta" rel="nofollow noopener noreferrer" target="_blank">Install with MSI (Windows) (BETA)</a>

Option 2: Manual ZIP File Installation

<a href="https://docs.microsoft.com/en-us/java/openjdk/overview" rel="nofollow noopener noreferrer" target="_blank">OpenJDK on Windows</a>

the StackHawk <a href="https://docs.stackhawk.com/stackhawk-cli/#install-with-zip-file" rel="nofollow noopener noreferrer" target="_blank">CLI ZIP file</a> download

<a href="https://docs.microsoft.com/en-us/powershell/scripting/overview?view=powershell-7.2" rel="nofollow noopener noreferrer" target="_blank">Powershell</a>

- <a href="https://docs.microsoft.com/en-us/java/openjdk/overview" rel="nofollow noopener noreferrer" target="_blank">OpenJDK on Windows</a>
- the StackHawk <a href="https://docs.stackhawk.com/stackhawk-cli/#install-with-zip-file" rel="nofollow noopener noreferrer" target="_blank">CLI ZIP file</a> download
- <a href="https://docs.microsoft.com/en-us/powershell/scripting/overview?view=powershell-7.2" rel="nofollow noopener noreferrer" target="_blank">Powershell</a>

___________________________________________________________

Simply follow the instructions in <a href="https://docs.stackhawk.com/stackhawk-cli/#install-with-msi-windows-beta" rel="nofollow noopener noreferrer" target="_blank">Install with MSI (Windows) (BETA)</a>.

This is the preferred method for installation where possible.

The overall requirements to run HawkScan on Windows are:

A full OpenJDK environment is installed (a JRE only is insufficient)

The Windows <code>Path</code> Environment Variable contains:

- the directory of the <code>java</code> program associated with the JDK
- the directory containing HawkScan (<code>talon-bootstrap-x.x.x.jar</code>)

The Windows <code>JAVA_HOME</code> Environment Variable is present and contains:

- the directory of the <code>java</code> program associated with the JDK

- A full OpenJDK environment is installed (a JRE only is insufficient)
- The Windows <code>Path</code> Environment Variable contains:
 - the directory of the <code>java</code> program associated with the JDK
 - the directory containing HawkScan (<code>talon-bootstrap-x.x.x.jar</code>)
- The Windows <code>JAVA_HOME</code> Environment Variable is present and contains:
 - the directory of the <code>java</code> program associated with the JDK

- Examples:
 - <a href="https://docs.microsoft.com/en-us/java/openjdk/install" rel="nofollow noopener noreferrer" target="_blank">Install Microsoft JDK</a> (Microsoft JDK 17)
 - <a href="https://access.redhat.com/documentation/en-us/openjdk/11/html-single/installing_and_using_openjdk_11_for_windows/index#openjdk_for_windows_installation_options" rel="nofollow noopener noreferrer" target="_blank">Install OpenJDK on Windows</a> (Redhat JDK 11)

Ensure that the JDK's directory is present in the Windows Path variable

1. Powershell: <code>echo $env:PATH</code>
2. Windows GUI: Settings--&gt;Edit Environment Variables--&gt;Select System or User--&gt;Path

Create a System Environment variable, JAVA_HOME, containing the same path to java as is populated in <code>$env:PATH</code>

1. Install an OpenJDK
 - Examples:
 - <a href="https://docs.microsoft.com/en-us/java/openjdk/install" rel="nofollow noopener noreferrer" target="_blank">Install Microsoft JDK</a> (Microsoft JDK 17)
 - <a href="https://access.redhat.com/documentation/en-us/openjdk/11/html-single/installing_and_using_openjdk_11_for_windows/index#openjdk_for_windows_installation_options" rel="nofollow noopener noreferrer" target="_blank">Install OpenJDK on Windows</a> (Redhat JDK 11)
2. Ensure that the JDK's directory is present in the Windows Path variable
 1. Powershell: <code>echo $env:PATH</code>
 2. Windows GUI: Settings--&gt;Edit Environment Variables--&gt;Select System or User--&gt;Path
3. Create a System Environment variable, JAVA_HOME, containing the same path to java as is populated in <code>$env:PATH</code>

Powershell (after Microsoft JDK 17 install):

PS C:\Users\Dan\hawk-2.7.0&gt; echo $env:PATH C:\Program Files\Microsoft\jdk-17.0.4.101-hotspot\bin; [...]

(In the above case, <code>C:\Program Files\Microsoft\jdk-17.0.4.101-hotspot\bin</code> was already in the path as a result of the JDK installation; if it's absent, it can be added via the 'New' button)

obtain the latest version of the HawkScan <a href="https://docs.stackhawk.com/stackhawk-cli/#download" rel="nofollow noopener noreferrer" target="_blank">CLI ZIP file</a>

unzip the cli zip file in your preferred directory

- for instance: <code>C:'Users\Dan\hawk-2.7.0</code>

create a .hawk directory under the associated user’s home directory (local scan logs will be stored here)

- Powershell example: <code>mkdir ~/.hawk</code>

set HawkScan into the <code>PATH</code> variable:

- Windows GUI:
 - Settings--&gt;Edit Environment Variables--&gt;Select System or User--&gt;Path--&gt;Add hawk directory to Path (e.g., <code>C:\Users\Dan\hawk-2.7.0</code>)
- Powershell:
 - <code>$env:PATH="C:\Users\Dan\hawk-2.7.0; $Env:PATH"</code>

ensure that the OpenJDK is in the path; set it if not

- Example: <code>$env:PATH="C:\Program Files\Java\jdk-18.0.1.1\bin;$Env:PATH"</code>

create a System-level <code>JAVA_HOME</code> variable containing the OpenJDK path

(exit and re-launch Powershell after setting all PATH entries)

run the appropriate <code>hawk</code> in Powershell (hawk commands run from the <code>hawk.ps1 </code>script). For example:

- <a href="https://docs.stackhawk.com/stackhawk-cli/#hawk-init" rel="nofollow noopener noreferrer" target="_blank">hawk init</a>
- <a href="https://docs.stackhawk.com/stackhawk-cli/#hawk-validate-config" rel="nofollow noopener noreferrer" target="_blank">hawk validate config</a>
- <a href="https://docs.stackhawk.com/stackhawk-cli/#hawk-scan" rel="nofollow noopener noreferrer" target="_blank">hawk scan</a>
- <a href="https://docs.stackhawk.com/stackhawk-cli/#hawk-rescan" rel="nofollow noopener noreferrer" target="_blank">hawk rescan</a>

1. obtain the latest version of the HawkScan <a href="https://docs.stackhawk.com/stackhawk-cli/#download" rel="nofollow noopener noreferrer" target="_blank">CLI ZIP file</a>
2. unzip the cli zip file in your preferred directory
 - for instance: <code>C:'Users\Dan\hawk-2.7.0</code>
3. create a .hawk directory under the associated user’s home directory (local scan logs will be stored here)
 - Powershell example: <code>mkdir ~/.hawk</code>
4. set HawkScan into the <code>PATH</code> variable:
 - Windows GUI:
 - Settings--&gt;Edit Environment Variables--&gt;Select System or User--&gt;Path--&gt;Add hawk directory to Path (e.g., <code>C:\Users\Dan\hawk-2.7.0</code>)
 - Powershell:
 - <code>$env:PATH="C:\Users\Dan\hawk-2.7.0; $Env:PATH"</code>
5. ensure that the OpenJDK is in the path; set it if not
 - Example: <code>$env:PATH="C:\Program Files\Java\jdk-18.0.1.1\bin;$Env:PATH"</code>
6. create a System-level <code>JAVA_HOME</code> variable containing the OpenJDK path
7. (exit and re-launch Powershell after setting all PATH entries)
8. run the appropriate <code>hawk</code> in Powershell (hawk commands run from the <code>hawk.ps1 </code>script). For example:
 - <a href="https://docs.stackhawk.com/stackhawk-cli/#hawk-init" rel="nofollow noopener noreferrer" target="_blank">hawk init</a>
 - <a href="https://docs.stackhawk.com/stackhawk-cli/#hawk-validate-config" rel="nofollow noopener noreferrer" target="_blank">hawk validate config</a>
 - <a href="https://docs.stackhawk.com/stackhawk-cli/#hawk-scan" rel="nofollow noopener noreferrer" target="_blank">hawk scan</a>
 - <a href="https://docs.stackhawk.com/stackhawk-cli/#hawk-rescan" rel="nofollow noopener noreferrer" target="_blank">hawk rescan</a>

Options syntax in Powershell follows the <a href="https://docs.stackhawk.com/stackhawk-cli/#command-options" rel="nofollow noopener noreferrer" target="_blank">CLI Command Options</a> syntax.

- For instance, to turn on debug: 
 - <code>hawk scan --debug</code>

- Options syntax in Powershell follows the <a href="https://docs.stackhawk.com/stackhawk-cli/#command-options" rel="nofollow noopener noreferrer" target="_blank">CLI Command Options</a> syntax.
 - For instance, to turn on debug: 
 - <code>hawk scan --debug</code>

Another Option for Running the CLI on Windows is to enable WSL and install Ubuntu (or another linux distro), then install the CLI on that linux distro.

See <a href="https://help.stackhawk.com/en/articles/6461516-how-to-run-the-hawkscan-cli-on-ubuntu">How to run the HawkScan CLI on Ubuntu </a>for details

- See <a href="https://help.stackhawk.com/en/articles/6461516-how-to-run-the-hawkscan-cli-on-ubuntu">How to run the HawkScan CLI on Ubuntu </a>for details

Description

Procedure -- MSI Installer

Procedure -- ZIP File Installation

Requirements

Phase 1: Install Java

Phase 2: Install and run HawkScan

Additional Information