KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #ai-agents #developer-tools #codex #claude-code #mcp #rust #deepseek-harness #typescript #ai-agent #cli

samuraiwtf

★ 570 Open GitHub ↗

The main SamuraiWTF collaborative distro repo.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

## Samurai Web Training Framework 6.0

----

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 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][samurai-katana-url] 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 22.04 (look in the ubuntu-22 subfolder).

**Important Notes**
- All targets installed with Katana will be configured in the `.test` primary domain
- All targets will use port 8443 for HTTPS connections

**Want to chat with us? Join us in either the OWASP Slack #project-samuraiwtf channel.**

**Want to Contribute? See [here](#Contributors)**

**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.

## How to set up Samurai WTF
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.

### Option 1: Download Pre-Built OVA (for Oracle VirtualBox)
This option works best if you are not using Windows, or if you are using Windows without Hyper-V running.

[Download SamuraiWTF for VirtualBox](https://downloads-samuraiwtf-com.s3.us-west-2.amazonaws.com/SamuraiWTF.ova)
* MD5: `1da174a13218ad60080d4666f305124d`
* SHA256: `92490a0f16584644ad681d94a3b144778fcb837a845a4f5f63d252e71d98ed4d`

For more information on removing or disabling Hyper-V, see [these instructions from Microsoft](https://support.microsoft.com/en-us/help/3204980/virtualization-applications-do-not-work-together-with-hyper-v-device-g).

### Option 2: Download Pre-Built VHDX (for Hyper-V)
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](https://downloads-samuraiwtf-com.s3.us-west-2.amazonaws.com/SamuraiWTF_HyperV.zip)
* 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.

### Option 3: Build an Amazon Workspace (DEPRECATED)
This option is now deprecated due to ongoing issues with AWS Workspaces provisioning. Historical documentation can be found at [/amazon-linux/README.md](https://github.com/SamuraiWTF/samuraiwtf/blob/main/amazon-linux/README.md).

### Build on Hyper-V or VirtualBox with Vagrant
Currently, the most stable Vagrant build is the one for Ubuntu 22.04. Details are in the file [/ubuntu-22/README.md](https://github.com/SamuraiWTF/samuraiwtf/blob/main/ubuntu-22/README.md).

## Default Password
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.

## Root Certificate Authority
During the build process, SamuraiWTF generates a local Root Certificate Authority (CA) that is used to secure internal training targets. To properly simulate real-world pentesting scenarios, you'll need to import this CA into your browser:

1. The Root CA certificate is located at `/opt/samurai/SamuraiWTF_Root_CA.crt`
2. To import in Firefox:
   - Go to Settings (or Preferences)
   - Search for "certificates"
   - Click "View Certificates"
   - Go to the "Authorities" tab
   - Click "Import" and select the Root CA file
   - Check "Trust this CA to identify websites"

⚠️ **SECURITY WARNING**: This Root CA should ONLY be trusted in browsers used for training within the SamuraiWTF VM. Never import this certificate on browsers used outside the VM or for regular web browsing, as it could compromise your browser security.

## Lab Quick Setup
Once you log in to the environment, you can install tools and targets using katana either from the command line, or from a browser.

### Command Line
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:

```shell script
katana install zap
katana install juice-shop
katana start juice-shop
```

## Web UI
The web UI can be seen in a browser by visiting `https://katana.test`.

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:
```shell script
katana install katana
katana start katana
```

More detailed instructions on using Katana are available in the readme of the [Samurai Katana][samurai-katana-url] GitHub project.

**IMPORTANT**: Be aware that Katana runs with root privileges and is not intended to be run in a secure or production environment.

## Development
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.  The `main` branch should be kept stable at all times.
- Larger changes should be done in separate feature branches.  Make sure to merge `next` into your feature branch, then PR the feature branch to merge into `next`.
- If you break `next` or `main`, 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.

## Production VM Notes:
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.

## Virtualbox Display
- 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 1` menu to adjust the screen dimensions (e.g. Resize to 1440x900; Scale to 200%).

# License
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
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.

[samurai-katana-url]: https://github.com/SamuraiWTF/katana

samuraiwtf

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README