NIST Logo and ITL Banner Link to the NIST Homepage Link to the ITL Homepage Link to the NIST Homepage
Search CSRC:
AppVet Logo

3.  Installation


3.1 System Requirements

AppVet has the following minimum system requirements and recommendations:

  • 64-bit Windows recommended (Note that although AppVet is Java-based, installation problems have been reported under Linux)
  • 1GB RAM
  • 50 GB free hard disk space (for installation of all AppVet-required platforms, libraries and components)
  • Network access with static IP address

3.2 Platform Requirements

AppVet requires the following to be installed on the host.

3.2.1 Java

AppVet requires Java JDK 7 to be installed. For 64-bit operating systems, it is recommended to use 64-bit Java JDK. After installing Java JDK, set the JAVA_HOME environment variable to the path of your Java JDK root directory.

3.2.2 Android APKTool (Android only)

For Android app analysis, AppVet requires Android APKTool 2.0 to be installed. After installing APKTool, add the path of your APKTool root directory to your PATH environment variable. Ensure that APKTool can be executed from a console (e.g., apktool.bat on Windows).

3.2.3 Apache Tomcat

AppVet requires a web server and servlet container to be installed. For 64-bit operating systems, it is recommended to use 64-bit Apache Tomcat 7. For Windows systems, it is recommended to install Tomcat using the 32-bit/64-bit Windows Service Installer. After installing Tomcat, set the CATALINA_HOME environment variable to the path of your Tomcat root directory.

To manage Tomcat, add a user with attribute roles="manager-gui" to the $CATALINA_HOME/conf/tomcat-users.xml configuration file. This will allow the user to manage Tomcat from the Tomcat web browser UI.

Verify proper installation of Tomcat by starting the Tomcat service under Windows Services, opening a browser, and ensuring the Tomcat page is visible at http://<host>:<port> . Also ensure that Tomcat starts automatically after reboot.

AppVet recommends the use of Secure Socket Layer (SSL). To enable SSL for Apache Tomcat, add an SSL-enabled connector to the $CATALINA_HOME/conf/server.xml configuration file. For example:

<Connector SSLEnabled="true" clientAuth="false" keystoreFile="C:\mykeystore.jks" keystorePass="mypassword123!" maxThreads="150" port="443" protocol="HTTP/1.1" scheme="https" secure="true" sslProtocol="TLSv1.2" />

Note that when using SSL, a keystore containing a valid certificate should reside on the host. Note that for production systems, a certificate from a Certificate Authority (CA) should be used in lieu of a self-signed certificate.

3.2.4 MySQL

AppVet requires a relational database to be installed. For 64-bit operating systems, it is recommended to use the 64-bit MySQL 5 Community Server Edition.

3.3 Eclipse

AppVet source code is distributed as an Eclipse IDE project and requires Eclipse v4.3 (Kepler) to be installed. For 64-bit operating systems, it is recommended to use 64-bit Eclipse. After installing Eclipse, install the Google Web Toolkit (GWT) Eclipse plug-in by selecting Help > Install New Software from Eclipse. Next, select Add... and enter the URL https://dl.google.com/eclipse/plugin/4.3 in the location field then select Ok. Select the following software packages to install:

  • Google Plugin for Eclipse (required)
  • GWT Designer for GPE (recommended)
  • SDKs/Google Web Toolkit SDK 2.6.1

3.3.1 Downloading AppVet

The AppVet source code distribution is stored in a GitHub repository. To download and import the source code directly into Eclipse, the EGit Eclipse plug-in must first be installed. To install EGit, select Help > Install New Software from Eclipse. Next, select Add... and enter the URL http://download.eclipse.org/egit/updates. After installing EGit, restart Eclipse.

To download the AppVet source code from GitHub, open a web browser and go to https://github.com/AppVet/appvet . Here, select the Copy to clipboard icon under HTTPS Clone URL on the right-hand side of the web page. Next, go back to Eclipse and select Window > Show View > Other > Git > Git Repositories. Then, right-click in the Eclipse Git Repositories view and select Paste Repository Path or URI. In the Source Git Repository dialog box select Next. Under Branch Selection select Next. Under Local Destination/Projects select Import all existing projects after clone finishes and then select Finish. EGit then clones (i.e., downloads) the AppVet Eclipse project appvet and displays it in the Eclipse Project Explorer view.

After cloning the appvet project, a red icon may appear next to the project in the Eclipse Project Explorer view. Typically, these errors are due to path conflicts with Eclipse on your local machine. To resolve these path conflicts, right-click on the appvet project and select Properties > Java Build Path > Libraries. Here, if any libraries appear with a red icon, select that library and then select Edit... then locate and select the correct library on your local machine.

Note that AppVet bundles required libraries including Apache Commons, GWT Servlet, and MySQL libraries in /war/WEB-INF/lib and that using other versions of these libraries could lead to incorrect behavior of AppVet.

3.3.2 Integrating Tomcat

Development of AppVet requires that Tomcat be integrated with Eclipse. To integrate Tomcat with Eclipse, open Eclipse's Servers view by selecting Windows > Show View and select Servers > Servers. This will open the Servers view in the Eclipse IDE. Next, right-click on the Servers view and select New > Server. From the New Server dialog, select Apache Tomcat v7.x then select Next. From the Add and Remove dialog, add the appvet project to the Configured view and select Finish. To save the modified configuration, select File > Save from the Eclipse menu.

You will see the newly created server in Eclipse's Servers view. Next, double-click on the newly created server to open the server's configuration panel. Here, select Use Tomcat installation under Server Locations and set the Deploy path to $CATALINA_HOME/webapps . Next, select the Modules tab at the bottom of the Tomcat configuration panel to bring up the Tomcat Web Modules view. Here, select appvet and then select Add Web Module... This will install the AppVet application as a WAR (Web Application Resource) in Tomcat.

3.3.3 AppVet Compilation

To compile AppVet, right-click on the appvet project and select Google > GWT Compile. Note that compiling using the GWT Compiler will also compile all non-GWT code including the AppVet servlet and will automatically update the appvet WAR in Tomcat.