OCCP Administration Utility
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib
logs
occp/edu/uri/dfcsc/occp
setup
.gitignore
MANIFEST.MF
Makefile
README.md
build.xml
doxygen.conf
logging.properties
occp_run.sh

README.md

Open Cyber Challenge Platform Administration Utility

This program is part of the Open Cyber Challenge Platform (OCCP). It runs on the Admin VM to control hypervisor(s) being used with the OCCP. Initially developed by The University of Rhode Island's Digital Forensics and Cyber Security Center under funding from the National Science Foundation. Pull requests are welcomed.

For more information visit: https://www.opencyberchallenge.net

Updating your Admin VM

  1. Before starting, you should snapshot your Admin VM. This will allow you to easily revert if you encounter any problems.
  2. From your Admin VM, navigate to the source directory. cd ~/occp/source
  3. Pull the latest source code git pull
  4. Run the updater sudo ./setup/setup.sh -c
  5. Reboot sudo reboot
  6. Confirm the update occpadmin --version

Note: Once you are satisfied that the update was successful and everything is in working order, you may wish to delete the snapshot created the first step.

Contributing

Since the Administration Utility and Admin VM are inherently linked, altering the utility may require configuration changes to the Admin VM. If that is the case, you should include changes to the occpadmin module in the setup folder as part of your pull request.

This project has adopted the branching model described on http://nvie.com/posts/a-successful-git-branching-model/

Installation

Stop! This program is already installed in the OCCP Admin VM. Most users should visit the project's web site to download the Admin VM instead of trying to create their own. The following is only meant for platform developers that wish to make their own Admin VM.

Creating an Admin VM

  1. Clone the Ubuntu 16.04 Server Base VM
  2. Add a second NIC to the VM and attach it to your setup network
  3. Login to the VM. The default credentials are root:0ccpadmin.
  4. You should update the VM now apt-get update && apt-get dist-upgrade -y
  5. Install git apt-get install -y git
  6. Clone this repository git clone https://github.com/OpenCyberChallengePlatform/OccpAdmin.git
  7. Run the installer ./OccpAdmin/setup/setup.sh -c*
  8. Remove the old repository sudo rm -rf /root/OccpAdmin
  9. Reboot the VM reboot
  10. Login with the new credentials (occpadmin:0ccpadmin)
  11. You should change the password, but otherwise you should have an equivalent Admin VM to the one available from the project's website.

*Note: Experienced users may discover the Puppet module has some parameters that are not exposed via the setup script. Changing those parameters should be done with caution since it will create an Admin VM that does not match published documentation.