Skip to content

Commit

Permalink
Update documentation for release v1.1
Browse files Browse the repository at this point in the history
  • Loading branch information
xcellerator committed Feb 3, 2018
1 parent d1d860d commit c9aed58
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 3 deletions.
6 changes: 3 additions & 3 deletions ADDED.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

As things get crossed off the [TODO](TODO.md) list, they will be written about here.

### Read-Only Storage Mode `Version: TBA`
### Read-Only Storage Mode `Version: 1.1`
A feature that I'm very excited to be releasing is being able to present a Read-Only Mass Storage device to a host via the USB Ninja. As usual, you can do this by adding a new line to `options.txt`.

```
Expand All @@ -15,7 +15,7 @@ storage_ro: yes

If you set this straight away, then you just won't be able to add anything to the mass storage. The idea is that you should leave the device in read/write mode (by simply omitting a `storage_ro` line in `options.txt`) and place a payload of some kind on the drive. You can then set the read-only flag in `options.txt` so ensure that an AV solution present on the target cannot delete or quarantine your payload if it is detected.

### Post-Setup Scripts `Version: TBA`
### Post-Setup Scripts `Version: 1.1`

You can now specify a script or executable than will be ran after the gadgets are setup and running.
This done by adding a new line to `options.txt`.
Expand All @@ -36,7 +36,7 @@ You can do this with a simple `chmod` as below:
$ sudo chmod +x /boot/usbninja/exec.sh
```

### Alternative Backing File in `storage` mode `Vesion: TBA`
### Alternative Backing File in `storage` mode `Vesion: 1.1`

By default, the backing file used in `storage` mode is the one located at `/lib/usbninja/storage.img`. However, you can create another one, as detailed in [STORAGE.img](src/STORAGE.img). Once done, you can specify the location of your new backing file in `options.txt` with the `storage: ` line.
```
Expand Down
5 changes: 5 additions & 0 deletions doc/STORAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@

The mass storage gadget is activated by putting `storage` on the `gadget: ` line in `options.txt`. By default, there is a total of 1GB available, but this can be changed by quite easily. The "storage" part of mass storage arises from the "backing file", one of which can be located in `/lib/usbninja/storage.img`. You can create your own backing file by following the instructions below, and then set the location in `options.txt`.

### Gadget-Specific `options.txt` entries
You have two extra (optional) configurations available to you in `options.txt`
* `storage_ro` - Determines whether the storage device will be presented as read-only or not. Can be set to either `yes` or `no`.
* `storage` - An absolute path to another backing file if the default one is too small for you.

**Note: You do not need to do this. There is an existing empty `storage.img` file already in place in `/lib/usbninja/storage.img`.**

### Creating your own backing file
Expand Down

0 comments on commit c9aed58

Please sign in to comment.