This project is not a vulnerable application. It is a framework designed for quickly configuring training virtual machines with tools and vulnerable application targets. For example, an instructor could use SamuraiWTF to easily set up a virtual machine image containing OWASP ZAP and OWASP Juice Shop, and then distribute it to each student as a training lab environment.
This project includes and uses the Samurai Katana project to manage installation and running of tools and targets in the virtual environment.
Reference Implementation Currently the reference implementation for this project is built on top of Ubuntu 20.04 (look in the ubuntu-20 subfolder).
Want to chat with us? Join us in either the OWASP Slack #project-samuraiwtf channel.
Want to Contribute? See here
Art Credit: the above Samurai figure is the original work of Ben Faircloth, who has granted the OWASP SamuraiWTF project permission to use in the product and websites.
There are several options available to you. The quickest option is to download a pre-built virtual machine and then use Katana (already installed) to configure it with the targets you want to use.
This option works best if you are not using Windows, or if you are using Windows without Hyper-V running.
Download SamuraiWTF for VirtualBox
- MD5:
1da174a13218ad60080d4666f305124d - SHA256:
92490a0f16584644ad681d94a3b144778fcb837a845a4f5f63d252e71d98ed4d
For more information on removing or disabling Hyper-V, see these instructions from Microsoft.
This option works best if you are running Windows 10 or higher and already have Hyper-V installed. If you use the Windows Linux Subsystem (WLS), then you have Hyper-V installed.
Download SamuraiWTF for Hyper-V
- MD5:
B7B406D70956574CE29A83344CD59E97 - SHA256:
9FD30B272A20CD3CA1003BAC0CEB180D18202F0A448FCFDEB0EDE52CA65DDA74
Once it is downloaded, you will want to unzip the file and then create a new VM in Hyper-V. Attach the .hvdx drive and set the RAM to at least 4096.
This option works best if you are familiar with Amazon Web Services (AWS) and want your students to remote into the lab environments instead of running them as local virtual machines. This can be a great option when students are running potentially low-powered machines because it even works from a Chromebook. For details, view /amazon-linux/README.md.
Please note that once the Docker containers have been added to the Workspace instance, you can no longer create an image from the instance. While this won't affect most people using this as a training environment, it does break the ability to prebuild classroom labs using AWS Workspaces. We have reached out to AWS to see if there is a fix.
Currently, the most stable Vagrant build is the one for Ubuntu 20.04. Details are in the file /amazon-linux/README.md.
There is a default user and password for the SamuraiWTF environment: samurai / samurai
This is the same for every build except the AWS Workspace, where you will instead use your workspace username and password.
Once you log in to the environment, you can install tools and targets using katana either from the command line, or from a browser.
Simply use the command katana list to see which packages are available, then install any package with katana install <package>. For example, to install ZAP and JuiceShop:
katana install zap
katana install juice-shop
katana start juice-shopThe web UI can be seen in a browser by visiting http://katana.wtf.
If it is not running, you may first need to use the command line to install and start katana. This is done with the commands:
katana install katana
katana start katanaMore detailed instructions on using Katana are available in the readme of the Samurai Katana GitHub project.
IMPORTANT: Be aware that Katana runs with root privileges and is not intended to be run in a secure or production environment.
Most of the development in this repo is related to updating basebox provisioning scripts and supporting additional platforms.
- Our integration branch is the one called
next. That's where all new features and bug fixes go for testing before a planned release. Themainbranch should be kept stable at all times. - Larger changes should be done in separate feature branches. Make sure to merge
nextinto your feature branch, then PR the feature branch to merge intonext. - If you break
nextormain, fix it (with help if necessary). It's best to run a full test build (i.e.vagrant destroy,vagrant up) and make sure tools ard targets are working before pushing changes.
Once you load the VM, unless this was a AWS Workspace install the username and password are:
- Username: samurai
- Password: samurai
The menus are available in the top-left corner of the desktop.
Once you log in, there are a couple of things that might need to be adjusted manually.
- To automatically adjust the display resolution, do the following:
- Select Virtualbox
Menu -> View - Click Auto-Resize Guest Display
- Resize Virtualbox window and display should change to fit window size.
- OR: Use the
Menu -> View -> Virtual Screen 1menu to adjust the screen dimensions (e.g. Resize to 1440x900; Scale to 200%).
- Select Virtualbox
The scripts and resources belonging directly to this project are licensed under the Lesser GNU Public License version 3 (LGPLv3). All software loaded into the VM, including the tools, targets, utilities, and operating system itself retain their original license agreements.
Contributors are very welcome and the contribution process is standard:
- fork this project
- make your contribution
- submit a pull request
Substantial or Regular contributors may also be brought in as full team members. This includes those who have made substantial contributions to previous versions of SamuraiWTF with the assumption they will continue to do so.