<commit_before>KillerBee
================

This is KillerBee - Framework and Tools for Attacking ZigBee and IEEE 802.15.4
networks.


MAINTAINERS/LICENSE
================

Distributed under a BSD license, see LICENSE for details.
All Rights Reserved.

The main toolkit was/is authored by:
+ 2009, <NAME> <<EMAIL>>
+ 2010-2015, <NAME> <<EMAIL>>
+ 2010-2011, <NAME> <<EMAIL>>

We appreciate the many contributers to the framework, including the following who have contributed
capabilities:
+ Anonymous Contributor
+ Spencer McIntyre (scapy extension)
+ <NAME> <<EMAIL>> (additional tools)


REQUIREMENTS
================
KillerBee is developed and tested on Linux systems.  Windows support may be
added in the future.

We have striven to use a minimum number of software dependencies, however, it
is necessary to install the following Python modules before installation:

+ serial
+ usb
+ crypto  (for some functions)
+ pygtk   (for use of tools that have GUIs)
+ cairo   (for use of tools that have GUIs)
+ scapy-com (for some tools which utilize 802.15.4 Scapy extensions)

On Ubuntu systems, you can install the needed dependencies with the following
commands:

```
# apt-get install python-gtk2 python-cairo python-usb python-crypto python-serial python-dev libgcrypt-dev
# hg clone https://bitbucket.org/secdev/scapy-com
# cd scapy-com
# python setup.py install
```

The python-dev and libgcrypt are required for the Scapy Extension Patch.

Also note that this is a fairly advanced and un-friendly attack platform.  This
is not Cain & Abel.  It is intended for developers and advanced analysts who are
attacking ZigBee and IEEE 802.15.4 networks.  I recommend you gain some
understanding of the ZigBee protocol (the book ZigBee Wireless Networks and
Transceivers by <NAME> at http://bit.ly/2I5ppI is reasonable, though
still not great) and familiarity with the Python language before digging into
this framework.


INSTALLATION
================
KillerBee uses the standard Python 'setup.py' installation file.  Install
KillerBee with the following command:

```
# python setup.py install
```

DIRECTORIES
================
The directory structure for the KillerBee code is described as follows:

+ doc       - HTML documentation on the KillerBee library, courtesy of epydoc.
+ firmware  - Firmware for supported KillerBee hardware devices.
+ killerbee - Python library source.
+ sample    - Sample packet captures, referenced below.
+ scripts   - Shell scripts used in development.
+ tools     - ZigBee and IEEE 802.15.4 attack tools developed using this framework.

REQUIRED HARDWARE
================
The KillerBee framework is being expanded to support multiple devices.
Currently there is support for the River Loop ApiMote,
Atmel RZ RAVEN USB Stick, MoteIV Tmote Sky, TelosB mote, and Sewino Sniffer.

Support for Freaklab's Freakduino with added hardware
and the Dartmouth arduino sketch as well as for the Zena Packet Analyzer board
are in development.

For the ApiMote v3 and v4beta:
The devices typically come preloaded and do not need to be reflashed for basic
use.

For the MoteIV Tmote Sky or TelosB mode:
This device can be loaded with firmware via USB. Attach the device, and then
within killerbee/firmware, run: ./flash\_goodfet.sh

For the Atmel RZ RAVEN USB Stick:
(http://www.atmel.com/dyn/products/tools_card.asp?tool_id=4396).  This hardware 
is convenient as the base firmware is open source with a freely-available IDE.
The KillerBee firmware for the RZ RAVEN included in the firmware/ directory is
a modified version of the stock firmware distributed by Atmel to include
attack functionality.

The RZ RAVEN USB Stick is available from common electronics resellers for
approximately $40/USD:
<commit_msg>add headlines for better overview<commit_after>KillerBee
================

This is KillerBee - Framework and Tools for Attacking ZigBee and IEEE 802.15.4
networks.


MAINTAINERS/LICENSE
================

Distributed under a BSD license, see LICENSE for details.
All Rights Reserved.

The main toolkit was/is authored by:
+ 2009, <NAME> <<EMAIL>>
+ 2010-2015, <NAME> <<EMAIL>>
+ 2010-2011, <NAME> <<EMAIL>>

We appreciate the many contributers to the framework, including the following who have contributed
capabilities:
+ Anonymous Contributor
+ <NAME> (scapy extension)
+ <NAME> <<EMAIL>> (additional tools)


REQUIREMENTS
================
KillerBee is developed and tested on Linux systems.  Windows support may be
added in the future.

We have striven to use a minimum number of software dependencies, however, it
is necessary to install the following Python modules before installation:

+ serial
+ usb
+ crypto  (for some functions)
+ pygtk   (for use of tools that have GUIs)
+ cairo   (for use of tools that have GUIs)
+ scapy-com (for some tools which utilize 802.15.4 Scapy extensions)

On Ubuntu systems, you can install the needed dependencies with the following
commands:

```
# apt-get install python-gtk2 python-cairo python-usb python-crypto python-serial python-dev libgcrypt-dev
# hg clone https://bitbucket.org/secdev/scapy-com
# cd scapy-com
# python setup.py install
```

The python-dev and libgcrypt are required for the Scapy Extension Patch.

Also note that this is a fairly advanced and un-friendly attack platform.  This
is not Cain & Abel.  It is intended for developers and advanced analysts who are
attacking ZigBee and IEEE 802.15.4 networks.  I recommend you gain some
understanding of the ZigBee protocol (the book ZigBee Wireless Networks and
Transceivers by <NAME> at http://bit.ly/2I5ppI is reasonable, though
still not great) and familiarity with the Python language before digging into
this framework.


INSTALLATION
================
KillerBee uses the standard Python 'setup.py' installation file.  Install
KillerBee with the following command:

```
# python setup.py install
```

DIRECTORIES
================
The directory structure for the KillerBee code is described as follows:

+ doc       - HTML documentation on the KillerBee library, courtesy of epydoc.
+ firmware  - Firmware for supported KillerBee hardware devices.
+ killerbee - Python library source.
+ sample    - Sample packet captures, referenced below.
+ scripts   - Shell scripts used in development.
+ tools     - ZigBee and IEEE 802.15.4 attack tools developed using this framework.

REQUIRED HARDWARE
================
The KillerBee framework is being expanded to support multiple devices.
Currently there is support for the River Loop ApiMote,
Atmel RZ RAVEN USB Stick, MoteIV Tmote Sky, TelosB mote, and Sewino Sniffer.

Support for Freaklab's Freakduino with added hardware
and the Dartmouth arduino sketch as well as for the Zena Packet Analyzer board
are in development.

ApiMote v3 and v4beta:
----------------
The devices typically come preloaded and do not need to be reflashed for basic
use.

MoteIV Tmote Sky or TelosB mode:
----------------
This device can be loaded with firmware via USB. Attach the device, and then
within killerbee/firmware, run: ./flash\_goodfet.sh

Atmel RZ RAVEN USB Stick:
----------------
(http://www.atmel.com/dyn/products/tools_card.asp?tool_id=4396).  This hardware 
is convenient as the base firmware is open source with a freely-available IDE.
The KillerBee firmware for the RZ RAVEN included in the firmware/ directory is
a modified version of the stock firmware distributed by Atmel to include
attack functionality.

The RZ RAVEN USB Stick is available from common electronics resellers for
approximately $40/USD:

{'fraction_non_alphanumeric': 0.08650380456547857, 'fraction_numerical': 0.014684287812041116, 'mean_word_length': 4.378320172290022, 'pattern_counts': {'":': 0, '<': 30, '<?xml version=': 0, '>': 30, 'https://': 2, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '7261371', 'n_tokens_mistral': 2228, 'n_tokens_neox': 2047, 'n_words': 983}