Module: Meshtastic::MQTT

Defined in:
lib/meshtastic/mqtt.rb

Class Method Summary collapse

Class Method Details

.authors ⇒ Object

Author(s)

0day Inc. <[email protected]>



358
359
360
361
362
 
# File 'lib/meshtastic/mqtt.rb', line 358

public_class_method def self.authors
  "AUTHOR(S):
    0day Inc. <[email protected]>
  "
end

.connect(opts = {}) ⇒ Object

Supported Method Parameters

mqtt_obj = Meshtastic::MQQT.connect(

host: 'optional - mqtt host (default: mqtt.meshtastic.org)',
port: 'optional - mqtt port (defaults: 1883)',
username: 'optional - mqtt username (default: meshdev)',
password: 'optional - (default: large4cats)'

)



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/meshtastic/mqtt.rb', line 25

public_class_method def self.connect(opts = {})
  # Publicly available MQTT server / credentials by default
  host = opts[:host] ||= 'mqtt.meshtastic.org'
  port = opts[:port] ||= 1883
  username = opts[:username] ||= 'meshdev'
  password = opts[:password] ||= 'large4cats'

  mqtt_obj = MQTTClient.connect(
    host: host,
    port: port,
    username: username,
    password: password
  )

  mqtt_obj.client_id = SecureRandom.random_bytes(8).unpack1('H*')

  mqtt_obj
rescue StandardError => e
  raise e
end

.decode_payload(opts = {}) ⇒ Object

Supported Method Parameters

Meshtastic::MQQT.decode_payload(

payload: 'required - payload to recursively decode',
msg_type: 'required - message type (e.g. :TEXT_MESSAGE_APP)',
gps_metadata: 'optional - include GPS metadata in output (default: false)',

)



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/meshtastic/mqtt.rb', line 73

public_class_method def self.decode_payload(opts = {})
  payload = opts[:payload]
  msg_type = opts[:msg_type]
  gps_metadata = opts[:gps_metadata]

  case msg_type
  when :ADMIN_APP
    decoder = Meshtastic::AdminMessage
  when :ATAK_FORWARDER, :ATAK_PLUGIN
    decoder = Meshtastic::TAKPacket
    # when :AUDIO_APP
    # decoder = Meshtastic::Audio
  when :DETECTION_SENSOR_APP
    decoder = Meshtastic::DeviceState
    # when :IP_TUNNEL_APP
    # decoder = Meshtastic::IpTunnel
  when :MAP_REPORT_APP
    decoder = Meshtastic::MapReport
    # when :MAX
    # decoder = Meshtastic::Max
  when :NEIGHBORINFO_APP
    decoder = Meshtastic::NeighborInfo
  when :NODEINFO_APP
    decoder = Meshtastic::User
  when :PAXCOUNTER_APP
    decoder = Meshtastic::Paxcount
  when :POSITION_APP
    decoder = Meshtastic::Position
    # when :PRIVATE_APP
    # decoder = Meshtastic::Private
  when :RANGE_TEST_APP
    # Unsure if this is the correct protobuf object
    decoder = Meshtastic::FromRadio
  when :REMOTE_HARDWARE_APP
    decoder = Meshtastic::HardwareMessage
    # when :REPLY_APP
    # decoder = Meshtastic::Reply
  when :ROUTING_APP
    decoder = Meshtastic::Routing
  when :SERIAL_APP
    decoder = Meshtastic::SerialConnectionStatus
  when :SIMULATOR_APP
    decoder = Meshtastic::Compressed
  when :STORE_FORWARD_APP
    decoder = Meshtastic::StoreAndForward
  when :TEXT_MESSAGE_APP
    # Unsure if this is the correct protobuf object
    # decoder = Meshtastic::MqttClientProxyMessage
    decoder = Meshtastic::Data
  when :TELEMETRY_APP
    decoder = Meshtastic::Telemetry
  when :TRACEROUTE_APP
    decoder = Meshtastic::RouteDiscovery
  when :WAYPOINT_APP
    decoder = Meshtastic::Waypoint
    # when :ZPS_APP
    # decoder = Meshtastic::Zps
  end

  payload = decoder.decode(payload).to_h

  if payload.keys.include?(:latitude_i)
    lat = payload[:latitude_i] * 0.0000001
    payload[:latitude] = lat
  end

  if payload.keys.include?(:longitude_i)
    lon = payload[:longitude_i] * 0.0000001
    payload[:longitude] = lon
  end

  if payload.keys.include?(:macaddr)
    mac_raw = payload[:macaddr]
    mac_hex_arr = mac_raw.bytes.map { |byte| byte.to_s(16).rjust(2, '0') }
    mac_hex_str = mac_hex_arr.join(':')
    payload[:macaddr_hex] = mac_hex_str
  end

  if payload.keys.include?(:time)
    time_int = payload[:time]
    time_utc = Time.at(time_int).utc if time_int.is_a?(Integer)
    payload[:time_utc] = time_utc
  end

  if gps_metadata && payload[:latitude] && payload[:longitude]
    lat = payload[:latitude]
    lon = payload[:longitude]
    unless lat.zero? && lon.zero?
      gps_search_resp = gps_search(lat: lat, lon: lon)
      payload[:gps_metadata] = gps_search_resp
    end
  end

  payload
rescue Google::Protobuf::ParseError
  payload
rescue StandardError => e
  raise e
end

.disconnect(opts = {}) ⇒ Object

Supported Method Parameters

mqtt_obj = Meshtastic.disconnect(

mqtt_obj: 'required - mqtt_obj returned from #connect method'

)



347
348
349
350
351
352
353
354
 
# File 'lib/meshtastic/mqtt.rb', line 347

public_class_method def self.disconnect(opts = {})
  mqtt_obj = opts[:mqtt_obj]

  mqtt_obj.disconnect if mqtt_obj
  nil
rescue StandardError => e
  raise e
end

.gps_search(opts = {}) ⇒ Object

Supported Method Parameters

mqtt_obj = Meshtastic.gps_search(

lat: 'required - latitude float (e.g. 37.7749)',
lon: 'required - longitude float (e.g. -122.4194)',

)



330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/meshtastic/mqtt.rb', line 330

public_class_method def self.gps_search(opts = {})
  lat = opts[:lat]
  lon = opts[:lon]

  raise 'ERROR: Latitude and Longitude are required' unless lat && lon

  gps_arr = [lat.to_f, lon.to_f]

  Geocoder.search(gps_arr).first.data
rescue StandardError => e
  raise e
end

.help ⇒ Object

Display Usage for this Module



366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
 
# File 'lib/meshtastic/mqtt.rb', line 366

public_class_method def self.help
  puts "USAGE:
    mqtt_obj = #{self}.connect(
      host: 'optional - mqtt host (default: mqtt.meshtastic.org)',
      port: 'optional - mqtt port (defaults: 1883)',
      username: 'optional - mqtt username (default: meshdev)',
      password: 'optional - (default: large4cats)'
    )

    #{self}.subscribe(
      mqtt_obj: 'required - mqtt_obj object returned from #connect method',
      root_topic: 'optional - root topic (default: msh)',
      region: 'optional - region e.g. 'US/VA', etc (default: US)',
      channel: 'optional - channel name e.g. '2/stat/#' (default: '2/e/LongFast/#')',
      psks: 'optional - hash of :channel => psk key value pairs (default: { LongFast: 'AQ==' })',
      qos: 'optional - quality of service (default: 0)',
      json: 'optional - JSON output (default: false)',
      filter: 'optional - comma-delimited string(s) to filter on in message (default: nil)',
      gps_metadata: 'optional - include GPS metadata in output (default: false)'
    )

    #{self}.gps_search(
      lat: 'required - latitude float (e.g. 37.7749)',
      lon: 'required - longitude float (e.g. -122.4194)',
    )

    mqtt_obj = #{self}.disconnect(
      mqtt_obj: 'required - mqtt_obj object returned from #connect method'
    )

    #{self}.authors
  "
end

.subscribe(opts = {}) ⇒ Object

Supported Method Parameters

Meshtastic::MQQT.subscribe(

mqtt_obj: 'required - mqtt_obj returned from #connect method'
root_topic: 'optional - root topic (default: msh)',
region: 'optional - region e.g. 'US/VA', etc (default: US)',
channel: 'optional - channel name e.g. "2/stat/#" (default: "2/e/LongFast/#")',
psks: 'optional - hash of :channel => psk key value pairs (default: { LongFast: "AQ==" })',
qos: 'optional - quality of service (default: 0)',
filter: 'optional - comma-delimited string(s) to filter on in message (default: nil)',
gps_metadata: 'optional - include GPS metadata in output (default: false)',
include_raw: 'optional - include raw packet data in output (default: false)'

)



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/meshtastic/mqtt.rb', line 186

public_class_method def self.subscribe(opts = {})
  mqtt_obj = opts[:mqtt_obj]
  root_topic = opts[:root_topic] ||= 'msh'
  region = opts[:region] ||= 'US'
  channel = opts[:channel] ||= '2/e/LongFast/#'
  # TODO: Support Array of PSKs and attempt each until decrypted

  public_psk = '1PG7OiApB1nwvP+rz05pAQ=='
  psks = opts[:psks] ||= { LongFast: public_psk }
  raise 'ERROR: psks parameter must be a hash of :channel => psk key value pairs' unless psks.is_a?(Hash)

  psks[:LongFast] = public_psk if psks[:LongFast] == 'AQ=='
  psks = get_cipher_keys(psks: psks)

  qos = opts[:qos] ||= 0
  json = opts[:json] ||= false
  filter = opts[:filter]
  gps_metadata = opts[:gps_metadata] ||= false
  include_raw = opts[:include_raw] ||= false

  # NOTE: Use MQTT Explorer for topic discovery
  full_topic = "#{root_topic}/#{region}/#{channel}"
  puts "Subscribing to: #{full_topic}"
  mqtt_obj.subscribe(full_topic, qos)

  filter_arr = filter.to_s.split(',').map(&:strip)
  mqtt_obj.get_packet do |packet_bytes|
    raw_packet = packet_bytes.to_s.b if include_raw
    raw_topic = packet_bytes.topic ||= ''
    raw_payload = packet_bytes.payload ||= ''

    begin
      disp = false
      decoded_payload_hash = {}
      message = {}
      stdout_message = ''

      if json
        decoded_payload_hash = JSON.parse(raw_payload, symbolize_names: true)
      else
        decoded_payload = Meshtastic::ServiceEnvelope.decode(raw_payload)
        decoded_payload_hash = decoded_payload.to_h
      end

      message = decoded_payload_hash[:packet] if decoded_payload_hash.keys.include?(:packet)
      message[:topic] = raw_topic
      message[:node_id_from] = "!#{message[:from].to_i.to_s(16)}"
      message[:node_id_to] = "!#{message[:to].to_i.to_s(16)}"

      # If encrypted_message is not nil, then decrypt
      # the message prior to decoding.
      encrypted_message = message[:encrypted]
      if encrypted_message.to_s.length.positive?
        packet_id = message[:id]
        packet_from = message[:from]

        nonce_packet_id = [packet_id].pack('V').ljust(8, "\x00")
        nonce_from_node = [packet_from].pack('V').ljust(8, "\x00")
        nonce = "#{nonce_packet_id}#{nonce_from_node}".b

        psk = psks[:LongFast]
        target_channel = decoded_payload_hash[:channel_id].to_s.to_sym
        psk = psks[target_channel] if psks.keys.include?(target_channel)
        dec_psk = Base64.strict_decode64(psk)

        cipher = OpenSSL::Cipher.new('AES-128-CTR')
        cipher = OpenSSL::Cipher.new('AES-256-CTR') if dec_psk.length == 32
        cipher.decrypt
        cipher.key = dec_psk
        cipher.iv = nonce

        decrypted = cipher.update(encrypted_message) + cipher.final
        message[:decoded] = Meshtastic::Data.decode(decrypted).to_h
        message[:encrypted] = :decrypted
      end

      if message[:decoded]
        # payload = Meshtastic::Data.decode(message[:decoded][:payload]).to_h
        payload = message[:decoded][:payload]
        msg_type = message[:decoded][:portnum]
        message[:decoded][:payload] = decode_payload(
          payload: payload,
          msg_type: msg_type,
          gps_metadata: gps_metadata
        )
      end

      message[:raw_packet] = raw_packet if include_raw
      decoded_payload_hash[:packet] = message
      unless block_given?
        message[:stdout] = 'pretty'
        stdout_message = JSON.pretty_generate(decoded_payload_hash)
      end
    rescue Google::Protobuf::ParseError,
           JSON::GeneratorError,
           ArgumentError => e

      message[:decrypted] = e.message if e.message.include?('key must be')
      message[:decrypted] = 'unable to decrypt - psk?' if e.message.include?('occurred during parsing')
      decoded_payload_hash[:packet] = message
      unless block_given?
        puts "WARNING: #{e.inspect} - MSG IS >>>"
        # puts e.backtrace
        message[:stdout] = 'inspect'
        stdout_message = decoded_payload_hash.inspect
      end

      next
    ensure
      filter_arr = [message[:id].to_s] if filter.nil?
      flat_message = message.values.join(' ')

      disp = true if filter_arr.first == message[:id] ||
                     filter_arr.all? { |filter| flat_message.include?(filter) }

      if disp
        if block_given?
          yield decoded_payload_hash
        else
          puts "\n"
          puts '-' * 80
          puts 'MSG:'
          puts stdout_message
          puts '-' * 80
          puts "\n\n\n"
        end
      else
        print '.'
      end
    end
  end
rescue Interrupt
  puts "\nCTRL+C detected. Exiting..."
rescue StandardError => e
  raise e
ensure
  mqtt_obj.disconnect if mqtt_obj
end