Module: PWN::SDR::Decoder::ZigBee

Defined in:
lib/pwn/sdr/decoder/zigbee.rb

Overview

True-air + detector-fallback decoder for ZigBee. Prefers PWN::FFI I/Q (RTL-SDR / ADALM-Pluto / HackRF / capture file) via Base.run_iq; degrades to Base.run_detector with no hardware.

Defined Under Namespace

Classes: DemodIQ

Class Method Summary collapse

Class Method Details

.authorsObject

Author(s)

0day Inc. support@0dayinc.com



109
110
111
# File 'lib/pwn/sdr/decoder/zigbee.rb', line 109

public_class_method def self.authors
  "AUTHOR(S):\n  0day Inc. <support@0dayinc.com>\n"
end

.decode(opts = {}) ⇒ Object

Supported Method Parameters

PWN::SDR::Decoder::ZigBee.decode( freq_obj: 'required - freq_obj returned from PWN::SDR::GQRX.init_freq' )



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
# File 'lib/pwn/sdr/decoder/zigbee.rb', line 74

public_class_method def self.decode(opts = {})
  freq_obj = opts[:freq_obj]

  rate  = (opts[:sample_rate] || freq_obj[:iq_rate] || 2_000_000).to_i
  proto = 'ZigBee'
  demod = DemodIQ.new(
    rate: rate, protocol: proto, modulation: 'O-QPSK',
    extra: { threshold: 8.0 }
  )
  PWN::SDR::Decoder::Base.run_iq(
    freq_obj: freq_obj,
    protocol: proto,
    sample_rate: rate,
    source: opts[:source],
    file: opts[:file],
    demod: demod,
    threshold: 8.0,
    note: 'O-QPSK 250 kbit/s DSSS — true-air I/Q path reports frame bursts on the tuned channel.',
    describe: proc { |b| { modulation: 'O-QPSK', symbol_rate: 62_500, classification: b[:duration_ms] < 5 ? 'ACK' : 'MAC-frame' } }
  )
end

.helpObject



113
114
115
116
117
118
119
120
121
122
123
# File 'lib/pwn/sdr/decoder/zigbee.rb', line 113

public_class_method def self.help
  puts "USAGE (true-air I/Q via PWN::FFI + detector fallback):
    #{self}.decode(
      freq_obj: 'required - freq_obj returned from PWN::SDR::GQRX.init_freq',
      source:   'optional - :auto|:rtlsdr|:adalm_pluto|:file',
      file:     'optional - .cu8/.cs16 capture'
    )

    #{self}.authors
  "
end

.parse_line(opts = {}) ⇒ Object



96
97
98
99
100
101
102
103
104
105
# File 'lib/pwn/sdr/decoder/zigbee.rb', line 96

public_class_method def self.parse_line(opts = {})
  line = opts[:line].to_s
  out  = { protocol: 'ZigBee' }
  out[:pan]    = ::Regexp.last_match(1) if line =~ /PAN[:= ]+([0-9A-Fa-f]+)/i
  out[:src]    = ::Regexp.last_match(1) if line =~ /src[:= ]+([0-9A-Fa-f:]+)/i
  out[:dst]    = ::Regexp.last_match(1) if line =~ /dst[:= ]+([0-9A-Fa-f:]+)/i
  out[:cmd]    = ::Regexp.last_match(1) if line =~ /\b(Beacon|Data|ACK|Cmd)\b/i
  out[:summary] = "ZigBee #{out[:cmd]} PAN=#{out[:pan]} #{out[:src]}#{out[:dst]}"
  out.compact
end