Installation – Kiuwan

This page walks you through installing KHS, verifying your setup, and preparing it to run analyses.

Prerequisites

OS

Windows, macOS, or Linux (supports any major release of the last 10 years)

Java

A Java Development Kit (JDK) 8 (1.8) or later, Oracle or OpenJDK.
Add your JDK’s bin folder to the system PATH so the javacommand is available everywhere.
(Recommended) Set JAVA_HOME to the JDK installation directory.

Apache

Ant 1.7 or later. Version 1.7.1 is known to work reliably.

Download: http://archive.apache.org/dist/ant/binaries/apache-ant-1.7.1-bin.zip (Recommended)
Unzip to any local folder and add its bin folder to the PATH so the ant command is available.
(Recommended) Set ANT_HOME to the Ant installation directory.

Note: Do not use a Java Runtime Environment (JRE).

Distribution ZIP file

The KHS release comes as a single zip file, for example, OptSecAnalyzer_060624.zip.
To install, extract the ZIP into the folder where you want to keep KHS on your local drive.
Future updates are shipped the same way: Download the new ZIP and extract it over your existing installation.

Important: Be careful not to overwrite changed configuration files.

The installation subfolders

From the installation ZIP file, you get the following folders:

bin	Configuration and main execution items, such as: qaking.user.properties: The main configuration file securityChecks.xml: The main Ant file that is executed to launch the KHS.
conf	Some configuration items, such as: log4j.properties: Define level of logging
definitions
doc	Documentation. These files are not updated, however. Please visit support.kiuwan.com for all documentation needs.
lib	All proprietary and third-party jar libraries necessary to run the KHS. These are (mostly) the same jar files as used in the KLA. For example: analyzer.jar: All classes used by all product rules, and other Engine classes.
libraries
licenses
logs	Generic Scanner logs.
out	All output from the scans is written, in subfolders on the client name. If no client name is given when executing the KHS, then the result files go the subfolder “MYCUSTOMER”.
rulesets	All rule definition files, in the old Checking QA format, that is one XML file for all rules of one language. There are 2 ruleset files per language, for example for Java: qaking_java.xml: (Larger) Ruleset for a “Quality” scan qaking_java_security.xml: (Smaller) Ruleset for a “Security” scan. In executing the KHS, by default, the “Quality” ruleset is used, and only if you specify an extra parameter, the “Security” scan is used.