Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation update202209 #263

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 13 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ The install will detect and prompt you for what is needed.
On Ubuntu systems, you can install the needed dependencies with the following
commands:
```
# apt-get install python-usb python-crypto python-serial python-dev libgcrypt-dev
# apt install python3-setuptools python3-scapy python3-pycryptodome python3-usb python3-cryptography python3-serial python3-dev libgcrypt-dev
```

On Mac OS, you can install the dependencies with the following commands
Expand Down Expand Up @@ -156,9 +156,6 @@ summarized below.
a target device. May be able to reset the device's PAN ID or Channel
+ zbfakebeacon - Spoofs beacon frames, either spamming them or on response to seeing
a beacon request come through.
+ zbopenear - Assists in data capture where devices are operating on multiple
channels or fast-frequency-hopping. It assigns multiple
interfaces sequentially across all channels.
+ zbassocflood - Repeatedly associate to the target PANID in an effort to cause
the device to crash from too many connected stations.
+ zbconvert - Convert a packet capture from Libpcap to Daintree SNA format,
Expand All @@ -184,14 +181,23 @@ summarized below.
must be in binary format (obj hexfile's are not supported). To
convert from the hexfile format to a binary file, use the
objcopy tool: objcopy -I ihex -O binary mem.hex mem.bin
+ zbscapy - Provides an interactive Scapy shell for interacting via a
KillerBee interface. Scapy must be installed to run this.
+ kbbootloader - Switches device into DFU/BOOTLOADER mode (if device is capable)

This repository is a framework-only repository and so some of the implementation tools
have been removed and placed in a dedicated repo: https://github.com/rmspeers/zigbee-security
Those tools are:

+ zbopenear - Assists in data capture where devices are operating on multiple
channels or fast-frequency-hopping. It assigns multiple
interfaces sequentially across all channels.
+ zbwardrive - Discovers available interfaces and uses one to inject beacon
requests and listen for respones across channels. Once a network
is found on a channel, it assigns another device to continuously
capture traffic on that channel to a PCAP file. Scapy must be
installed to run this.
+ zbscapy - Provides an interactive Scapy shell for interacting via a
KillerBee interface. Scapy must be installed to run this.
+ kbbootloader - Switches device into DFU/BOOTLOADER mode (if device is capable)


Additional tools, that are for special cases or are not stable, are stored in
the Api-Do project repository: http://code.google.com/p/zigbee-security/
Expand Down