StackHawk

Ubuntu 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 a combination of:

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

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

___________________________________________________________

The procedure below uses apt to install openjdk; various other methods could be used as well, so long as the end results are:

A full openjdk is installed (a JRE only is insufficient)

<code>java -version</code> returns the installed openjdk

<code>java</code> itself is in <code>$PATH</code>

- A full openjdk is installed (a JRE only is insufficient)
- <code>java -version</code> returns the installed openjdk
- <code>java</code> itself is in <code>$PATH</code>
- <code>hawk</code> is in <code>$PATH</code>

<a href="https://www.linuxcapable.com/how-to-install-openjdk-18-on-ubuntu-22-04-lts/" rel="nofollow noopener noreferrer" target="_blank">Install openjdk with apt</a>

1. update apt: <code>sudo apt update &amp;&amp; sudo apt upgrade -y</code>
2. locate available openjdk versions: <code>apt-cache search openjdk</code>
3. install latest openjdk version (e.g., 17): <code>sudo apt-get install openjdk-17-jdk -y</code>
 1. this will also add the openjdk to $PATH automatically

<code>sudo apt get install unzip</code> (if unzip isn't installed)

<a href="https://docs.stackhawk.com/stackhawk-cli/#install-with-zip-file" rel="nofollow noopener noreferrer" target="_blank">Install the ZIP file</a> (2.6.0 example below; the zip file and directory name will change over time)

1. <code>curl -v https://download.stackhawk.com/hawk/cli/hawk-2.6.0.zip -o hawk-2.6.0.zip</code>
2. <code>unzip hawk-2.6.0.zip</code>
3. Add hawk to <code>$PATH</code>:
 1. <code>echo "export PATH=$HOME/hawk-2.6.0:$PATH" &gt;&gt; ~/.bash_profile</code>
 2. <code>source ~/.bash_profile</code>

Confirm that the hawk dir and java dir are in the <code>echo $PATH</code> output

Run <code>hawk version</code> – should output a version (e.g., <code>v2.6.0</code>)

<a href="https://docs.stackhawk.com/stackhawk-cli/#hawk-scan" rel="nofollow noopener noreferrer" target="_blank"><code>Scan yer apps</code></a>!!

1. <a href="https://www.linuxcapable.com/how-to-install-openjdk-18-on-ubuntu-22-04-lts/" rel="nofollow noopener noreferrer" target="_blank">Install openjdk with apt</a>
 1. update apt: <code>sudo apt update &amp;&amp; sudo apt upgrade -y</code>
 2. locate available openjdk versions: <code>apt-cache search openjdk</code>
 3. install latest openjdk version (e.g., 17): <code>sudo apt-get install openjdk-17-jdk -y</code>
 1. this will also add the openjdk to $PATH automatically
2. <code>sudo apt get install unzip</code> (if unzip isn't installed)
3. <a href="https://docs.stackhawk.com/stackhawk-cli/#install-with-zip-file" rel="nofollow noopener noreferrer" target="_blank">Install the ZIP file</a> (2.6.0 example below; the zip file and directory name will change over time)
 1. <code>curl -v https://download.stackhawk.com/hawk/cli/hawk-2.6.0.zip -o hawk-2.6.0.zip</code>
 2. <code>unzip hawk-2.6.0.zip</code>
 3. Add hawk to <code>$PATH</code>:
 1. <code>echo "export PATH=$HOME/hawk-2.6.0:$PATH" &gt;&gt; ~/.bash_profile</code>
 2. <code>source ~/.bash_profile</code>
4. Confirm that the hawk dir and java dir are in the <code>echo $PATH</code> output
5. Run <code>hawk version</code> – should output a version (e.g., <code>v2.6.0</code>)
6. Run <code>hawk init</code>
 1. Add API KEY
7. <a href="https://docs.stackhawk.com/stackhawk-cli/#hawk-scan" rel="nofollow noopener noreferrer" target="_blank"><code>Scan yer apps</code></a>!!

Example command outputs when all elements are in place:

dan@DESKTOP:~$ java -version openjdk version "17.0.4" 2022-07-19 OpenJDK Runtime Environment (build 17.0.4+8-Ubuntu-120.04) OpenJDK 64-Bit Server VM (build 17.0.4+8-Ubuntu-120.04, mixed mode, sharing) dan@DESKTOP:~$ which java /bin/java dan@DESKTOP:~$ echo $PATH /home/dan/hawk-2.6.0:/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/snap/bin dan@DESKTOP:~$ hawk version v2.6.0

On Ubuntu, $PATH management may vary depending on the <a href="https://askubuntu.com/questions/3744/how-do-i-modify-my-path-so-that-the-changes-are-available-in-every-terminal-sess" rel="nofollow noopener noreferrer" target="_blank">presence or absence of .profile, .bash_profile, and .bashrc</a>.

- On Ubuntu, $PATH management may vary depending on the <a href="https://askubuntu.com/questions/3744/how-do-i-modify-my-path-so-that-the-changes-are-available-in-every-terminal-sess" rel="nofollow noopener noreferrer" target="_blank">presence or absence of .profile, .bash_profile, and .bashrc</a>.

Simply pre-pend the above procedure with the following step:

<a href="https://www.howtogeek.com/249966/how-to-install-and-use-the-linux-bash-shell-on-windows-10/" rel="nofollow noopener noreferrer" target="_blank">Enable WSL and install Ubuntu</a>

1. <a href="https://www.howtogeek.com/249966/how-to-install-and-use-the-linux-bash-shell-on-windows-10/" rel="nofollow noopener noreferrer" target="_blank">Enable WSL and install Ubuntu</a>

If scanning a local application, Windows Firewall may intercept you when you first run <code>hawk scan</code> and require you to allow java to access the host endpoint

When manipulating configuration files, note that the underlying Windows filesystem may be accessible via the <code>/mnt</code> filesystem, allowing you to pull Windows files into the linux directories you're scanning from

- for instance, you could copy yml files from your Documents folder into your Ubuntu user's home dir:
 - <code>cp /mnt/c/Users/Dan/Documents/stackhawk.yml ~</code>

- If scanning a local application, Windows Firewall may intercept you when you first run <code>hawk scan</code> and require you to allow java to access the host endpoint
- When manipulating configuration files, note that the underlying Windows filesystem may be accessible via the <code>/mnt</code> filesystem, allowing you to pull Windows files into the linux directories you're scanning from
 - for instance, you could copy yml files from your Documents folder into your Ubuntu user's home dir:
 - <code>cp /mnt/c/Users/Dan/Documents/stackhawk.yml ~</code>

How to run the HawkScan CLI on Ubuntu

Description

Procedure (Ubuntu)

Procedure (Ubuntu on WSL on Windows)