nü-map =====

nü-map (or nümap/numap) is the second revision of NCC Group's python based USB host security assessment tool.

This revision will have all the features that were supported in the first revision:

• numap-emulate - USB device emulation
• numap-scan - USB host scanning for device support
• numap-detect - USB host OS detection (no implemented yet)
• numap-fuzz - USB host fuzzing

In this revision there will be some additional features:

• USB host fuzzing uses kitty as fuzzing engine
• nümap not only contains executable scripts, but is also installed as a package and may be used as a library

nümap was developed by NCC Group and Cisco SAS team. The numap modernization is developed by the FaceDancer team, incluing @ktemkin and Great Scott Gadgets, LLC. Most of the credit still goes to the original authors.

Since this is a very early version, nümap is not yet available from pypi, instead, use pip to install it directly from github:

$ pip install git+https://github.com/usb-tools/numap.git#egg=numap

nümap's dependencies are listed in setup.py and will be installed with numap, however, there are couple of things that you might want to do to add support for some devices:

1. Requires a disk image called stick.img in the running directory

1. Requires a folder/file called mtp_fs in the current directory.
2. Requires the python package pymtpdevice. This package is not on pypi at the moment, but can be downloaded and installed from here: https://github.com/BinyaminSharet/Mtp

• Facedancer is the recommended hardware for nümap. nümap was developed based on it, and you'll get the most support with it.
• Raspdancer <http://wiki.yobi.be/wiki/Raspdancer> is supported on RPi
• GadgetFS is partially supported. This support is very experimental (even more than the rest of nümap) and limited.
  • BeagleboneBlack starting from Linux kernel 4.4.9 with a patched gadgetfs driver
  • RaspberryPi Zero W starting from Linux kernel 4.12.0-rc3+ which requires no patches
  • Since 4.12.0-rc3+ requires no patches, there might be other devices that can be supported, if you know of such device or have made changes to make it run on other devices, please send us a word.

If you are interested, read the gadget/README.rst for more information.

nümap's basic functionallity is emulating a USB device. You can emulate one of the existing devices (use numaplist to see the available devices):

$ numap-emulate -P fd:/dev/ttyUSB0 -C mass_storage

or emulate your own device:

$ numap-emulate -P fd:/dev/ttyUSB0 -C ~/my_mass_storage.py

A detailed guide to add your device will be added soon, in the meantime, you can take a look at numap devices under numap/dev/

nümap can attempt to detect what types of USB devices are supported by the host. It is done by emulating each device that is implemented in nümap for a short period of time, and checking whether a device-specific message was sent.

$ numap-scan -P fd:/dev/ttyUSB0

In addition for scanning support of various device classes, nümap can scan the host for support of vendor specific devices.

Vendor specific scanning helps identifying the vendor specific drivers that are available on the host.

This can be done using the current nümap VID-PID DB (still working on it), or another file in the same format:

$ numap-vsscan -P fd:/dev/ttyUSB0 -d $UMAP2_DIR/data/vid_pid_db.py

Or by scanning a specific vid-pid range -in this example -scan for each combination of VID from 0x1001 to 0x1004 and PID from 0x0000 to 0xffff:

$ numap-vsscan -P fd:/dev/ttyUSB0 -s 1001-1004:0000-ffff

Any patches/additions to the vid_pid_db.py file are very welcome!

A detailed guide for fuzzing using nümap can be found in docs/fuzzing.rst

Fuzzing with nümap is composed of three steps, which might be unified into a single script in the future.

1. Find out what is the order of messages for the host you want to fuzz and the USB device that you emulate:

   $ numap-stages -P fd:/dev/ttyUSB0 -C keyboard -s keyboard.stages

2. Start the kitty fuzzer in a separate shell, and provide it with the stages generated in step 1.

   $ numap-kitty -s keyboard.stages

3. Start the numap keyboard emulation in fuzz mode

   $ numap-fuzz -P fd:/dev/ttyUSB0 -C keyboard

After stage 3 is performed, the fuzzing session will begin.

While numap may be used to emulate and discover MTP devices (see "Soft dependencies" section of this README), it does not fuzz the MTP layer at this point. In order to fuzz the MTP layer, you can use the fuzzer embedded in the MTP library. We plan to support MTP fuzzing directly from numap in future releases.

TBD