Skip to content

btle: Add definitions for Bluetooth 5.0 control PDUs #3037

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Jan 10, 2021
Merged

btle: Add definitions for Bluetooth 5.0 control PDUs #3037

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9350d16
btle: Add definitions for Bluetooth 5.0 control PDUs
Matheus-Garbelini Aug 17, 2019
cd9a08d
Minor cosmetics changes
gpotter2 Jan 9, 2021
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
330 changes: 319 additions & 11 deletions scapy/layers/bluetooth4LE.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,10 @@
PPI_BTLE
from scapy.packet import Packet, bind_layers
from scapy.fields import BitEnumField, BitField, ByteEnumField, ByteField, \
Field, LEIntField, LEShortEnumField, LEShortField, \
Field, FlagsField, LEIntField, LEShortEnumField, LEShortField, \
MACField, PacketListField, SignedByteField, X3BytesField, XBitField, \
XByteField, XIntField, XShortField, XLEIntField, XLEShortField
XByteField, XIntField, XShortField, XLEIntField, XLELongField, \
XLEShortField
from scapy.contrib.ethercat import LEBitEnumField, LEBitField

from scapy.layers.bluetooth import EIR_Hdr, L2CAP_Hdr
Expand Down Expand Up @@ -128,6 +129,37 @@ def getfield(self, pkt, s):
return s[5:], self.m2i(pkt, struct.unpack(self.fmt, s[:5] + b"\x00\x00\x00")[0]) # noqa: E501


class BTLEFeatureField(FlagsField):
def __init__(self, name, default):
super(BTLEFeatureField, self).__init__(
name, default, -64,
['le_encryption',
'conn_par_req_proc',
'ext_reject_ind',
'slave_init_feat_exch',
'le_ping',
'le_data_len_ext',
'll_privacy',
'ext_scan_filter',
'le_2m_phy',
'tx_mod_idx',
'rx_mod_idx',
'le_coded_phy',
'le_ext_adv',
'le_periodic_adv',
'ch_sel_alg',
'le_pwr_class']
)


class BTLEPhysField(FlagsField):
def __init__(self, name, default):
super(BTLEPhysField, self).__init__(
name, default, -8,
['phy_1m', 'phy_2m', 'phy_coded']
)


##########
# Layers #
##########
Expand Down Expand Up @@ -300,23 +332,270 @@ class BTLE_CONNECT_REQ(Packet):


BTLE_Versions = {
7: '4.1'
6: '4.0',
7: '4.1',
8: '4.2',
9: '5.0',
10: '5.1',
11: '5.2',
}


BTLE_Corp_IDs = {
0xf: 'Broadcom Corporation'
0xf: 'Broadcom Corporation',
0x59: 'Nordic Semiconductor ASA'
}


class CtrlPDU(Packet):
name = "CtrlPDU"
BTLE_BTLE_CTRL_opcode = {
0x00: 'LL_CONNECTION_UPDATE_REQ',
0x01: 'LL_CHANNEL_MAP_REQ',
0x02: 'LL_TERMINATE_IND',
0x03: 'LL_ENC_REQ',
0x04: 'LL_ENC_RSP',
0x05: 'LL_START_ENC_REQ',
0x06: 'LL_START_ENC_RSP',
0x07: 'LL_UNKNOWN_RSP',
0x08: 'LL_FEATURE_REQ',
0x09: 'LL_FEATURE_RSP',
0x0A: 'LL_PAUSE_ENC_REQ',
0x0B: 'LL_PAUSE_ENC_RSP',
0x0C: 'LL_VERSION_IND',
0x0D: 'LL_REJECT_IND',
0x0E: 'LL_SLAVE_FEATURE_REQ',
0x0F: 'LL_CONNECTION_PARAM_REQ',
0x10: 'LL_CONNECTION_PARAM_RSP',
0x14: 'LL_LENGTH_REQ',
0x15: 'LL_LENGTH_RSP',
0x16: 'LL_PHY_REQ',
0x17: 'LL_PHY_RSP',
0x18: 'LL_PHY_UPDATE_IND',
}


class BTLE_EMPTY_PDU(Packet):
name = "Empty data PDU"


class BTLE_CTRL(Packet):
name = "BTLE_CTRL"
fields_desc = [
ByteEnumField("opcode", 0, BTLE_BTLE_CTRL_opcode)
]


class LL_CONNECTION_UPDATE_IND(Packet):
name = 'LL_CONNECTION_UPDATE_IND'
fields_desc = [
XByteField("win_size", 0),
XLEShortField("win_offset", 0),
XLEShortField("interval", 6),
XLEShortField("latency", 0),
XLEShortField("timeout", 50),
XLEShortField("instant", 6),
]


class LL_CHANNEL_MAP_IND(Packet):
name = 'LL_CHANNEL_MAP_IND'
fields_desc = [
BTLEChanMapField("chM", 0xFFFFFFFFFE),
XLEShortField("instant", 0),
]


class LL_TERMINATE_IND(Packet):
name = 'LL_TERMINATE_IND'
fields_desc = [
XByteField("code", 0x0),
]


class LL_ENC_REQ(Packet):
name = 'LL_ENC_REQ'
fields_desc = [
XLELongField("rand", 0),
XLEShortField("ediv", 0),
XLELongField("skdm", 0),
XLEIntField("ivm", 0),
]


class LL_ENC_RSP(Packet):
name = 'LL_ENC_RSP'
fields_desc = [
XLELongField("skds", 0),
XLEIntField("ivs", 0),
]


class LL_START_ENC_REQ(Packet):
name = 'LL_START_ENC_REQ'
fields_desc = []


class LL_START_ENC_RSP(Packet):
name = 'LL_START_ENC_RSP'


class LL_UNKNOWN_RSP(Packet):
name = 'LL_UNKNOWN_RSP'
fields_desc = [
XByteField("code", 0x0),
]


class LL_FEATURE_REQ(Packet):
name = "LL_FEATURE_REQ"
fields_desc = [
BTLEFeatureField("feature_set", 0)
]


class LL_FEATURE_RSP(Packet):
name = "LL_FEATURE_RSP"
fields_desc = [
BTLEFeatureField("feature_set", 0)
]


class LL_PAUSE_ENC_REQ(Packet):
name = "LL_PAUSE_ENC_REQ"


class LL_PAUSE_ENC_RSP(Packet):
name = "LL_PAUSE_ENC_RSP"


class LL_VERSION_IND(Packet):
name = "LL_VERSION_IND"
fields_desc = [
XByteField("optcode", 0),
ByteEnumField("version", 0, BTLE_Versions),
LEShortEnumField("Company", 0, BTLE_Corp_IDs),
ByteEnumField("version", 8, BTLE_Versions),
LEShortEnumField("company", 0, BTLE_Corp_IDs),
XShortField("subversion", 0)
]


class LL_REJECT_IND(Packet):
name = "LL_REJECT_IND"
fields_desc = [
XByteField("code", 0x0),
]


class LL_SLAVE_FEATURE_REQ(Packet):
name = "LL_SLAVE_FEATURE_REQ"
fields_desc = [
BTLEFeatureField("feature_set", 0)
]


class LL_CONNECTION_PARAM_REQ(Packet):
name = "LL_CONNECTION_PARAM_REQ"
fields_desc = [
XShortField("interval_min", 0x6),
XShortField("interval_max", 0x6),
XShortField("latency", 0x0),
XShortField("timeout", 0x0),
XByteField("preferred_periodicity", 0x0),
XShortField("reference_conn_evt_count", 0x0),
XShortField("offset0", 0x0),
XShortField("offset1", 0x0),
XShortField("offset2", 0x0),
XShortField("offset3", 0x0),
XShortField("offset4", 0x0),
XShortField("offset5", 0x0),
]


class LL_CONNECTION_PARAM_RSP(Packet):
name = "LL_CONNECTION_PARAM_RSP"
fields_desc = [
XShortField("interval_min", 0x6),
XShortField("interval_max", 0x6),
XShortField("latency", 0x0),
XShortField("timeout", 0x0),
XByteField("preferred_periodicity", 0x0),
XShortField("reference_conn_evt_count", 0x0),
XShortField("offset0", 0x0),
XShortField("offset1", 0x0),
XShortField("offset2", 0x0),
XShortField("offset3", 0x0),
XShortField("offset4", 0x0),
XShortField("offset5", 0x0),
]


class LL_REJECT_EXT_IND(Packet):
name = "LL_REJECT_EXT_IND"
fields_desc = [
XByteField("reject_opcode", 0x0),
XByteField("error_code", 0x0),
]


class LL_PING_REQ(Packet):
name = "LL_PING_REQ"


class LL_PING_RSP(Packet):
name = "LL_PING_RSP"


class LL_LENGTH_REQ(Packet):
name = ' LL_LENGTH_REQ'
fields_desc = [
XLEShortField("max_rx_bytes", 251),
XLEShortField("max_rx_time", 2120),
XLEShortField("max_tx_bytes", 251),
XLEShortField("max_tx_time", 2120),
]


class LL_LENGTH_RSP(Packet):
name = ' LL_LENGTH_RSP'
fields_desc = [
XLEShortField("max_rx_bytes", 251),
XLEShortField("max_rx_time", 2120),
XLEShortField("max_tx_bytes", 251),
XLEShortField("max_tx_time", 2120),
]


class LL_PHY_REQ(Packet):
name = "LL_PHY_REQ"
fields_desc = [
BTLEPhysField('tx_phys', 0),
BTLEPhysField('rx_phys', 0),
]


class LL_PHY_RSP(Packet):
name = "LL_PHY_RSP"
fields_desc = [
BTLEPhysField('tx_phys', 0),
BTLEPhysField('rx_phys', 0),
]


class LL_PHY_UPDATE_IND(Packet):
name = "LL_PHY_UPDATE_IND"
fields_desc = [
BTLEPhysField('tx_phy', 0),
BTLEPhysField('rx_phy', 0),
XShortField("instant", 0x0),
]


class LL_MIN_USED_CHANNELS_IND(Packet):
name = "LL_MIN_USED_CHANNELS_IND"
fields_desc = [
BTLEPhysField('phys', 0),
ByteField("min_used_channels", 2),
]


# Advertisement (37-39) channel PDUs
bind_layers(BTLE, BTLE_ADV, access_addr=0x8E89BED6)
bind_layers(BTLE, BTLE_DATA)
bind_layers(BTLE_ADV, BTLE_ADV_IND, PDU_type=0)
Expand All @@ -327,9 +606,38 @@ class CtrlPDU(Packet):
bind_layers(BTLE_ADV, BTLE_CONNECT_REQ, PDU_type=5)
bind_layers(BTLE_ADV, BTLE_ADV_SCAN_IND, PDU_type=6)

bind_layers(BTLE_DATA, L2CAP_Hdr, LLID=2) # BTLE_DATA / L2CAP_Hdr / ATT_Hdr
# Data channel (0-36) PDUs
# LLID=1 -> Continue
bind_layers(BTLE_DATA, CtrlPDU, LLID=3)
bind_layers(BTLE_DATA, L2CAP_Hdr, LLID=2)
bind_layers(BTLE_DATA, BTLE_CTRL, LLID=3)
bind_layers(BTLE_DATA, BTLE_EMPTY_PDU, {'len': 0, 'LLID': 1})
bind_layers(BTLE_CTRL, LL_CONNECTION_UPDATE_IND, opcode=0x00)
bind_layers(BTLE_CTRL, LL_CHANNEL_MAP_IND, opcode=0x01)
bind_layers(BTLE_CTRL, LL_TERMINATE_IND, opcode=0x02)
bind_layers(BTLE_CTRL, LL_ENC_REQ, opcode=0x03)
bind_layers(BTLE_CTRL, LL_ENC_RSP, opcode=0x04)
bind_layers(BTLE_CTRL, LL_START_ENC_REQ, opcode=0x05)
bind_layers(BTLE_CTRL, LL_START_ENC_RSP, opcode=0x06)
bind_layers(BTLE_CTRL, LL_UNKNOWN_RSP, opcode=0x07)
bind_layers(BTLE_CTRL, LL_FEATURE_REQ, opcode=0x08)
bind_layers(BTLE_CTRL, LL_FEATURE_RSP, opcode=0x09)
bind_layers(BTLE_CTRL, LL_PAUSE_ENC_REQ, opcode=0x0A)
bind_layers(BTLE_CTRL, LL_PAUSE_ENC_RSP, opcode=0x0B)
bind_layers(BTLE_CTRL, LL_VERSION_IND, opcode=0x0C)
bind_layers(BTLE_CTRL, LL_REJECT_IND, opcode=0x0D)
bind_layers(BTLE_CTRL, LL_SLAVE_FEATURE_REQ, opcode=0x0E)
bind_layers(BTLE_CTRL, LL_CONNECTION_PARAM_REQ, opcode=0x0F)
bind_layers(BTLE_CTRL, LL_CONNECTION_PARAM_RSP, opcode=0x10)
bind_layers(BTLE_CTRL, LL_REJECT_EXT_IND, opcode=0x11)
bind_layers(BTLE_CTRL, LL_PING_REQ, opcode=0x12)
bind_layers(BTLE_CTRL, LL_PING_RSP, opcode=0x13)
bind_layers(BTLE_CTRL, LL_LENGTH_REQ, opcode=0x14)
bind_layers(BTLE_CTRL, LL_LENGTH_RSP, opcode=0x15)
bind_layers(BTLE_CTRL, LL_PHY_REQ, opcode=0x16)
bind_layers(BTLE_CTRL, LL_PHY_RSP, opcode=0x17)
bind_layers(BTLE_CTRL, LL_PHY_UPDATE_IND, opcode=0x18)
bind_layers(BTLE_CTRL, LL_MIN_USED_CHANNELS_IND, opcode=0x19)


conf.l2types.register(DLT_BLUETOOTH_LE_LL, BTLE)
conf.l2types.register(DLT_BLUETOOTH_LE_LL_WITH_PHDR, BTLE_RF)
Expand Down
Loading