Module: Meshtastic::MQTT

Defined in:
lib/meshtastic/mqtt.rb

Class Method Summary collapse

Class Method Details

.authors ⇒ Object

Author(s)

0day Inc. [email protected]



319
320
321
322
323
 
# File 'lib/meshtastic/mqtt.rb', line 319

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

.connect(opts = {}) ⇒ Object

Supported Method Parameters

mqtt_obj = Meshtastic::MQTT.connect( host: 'optional - mqtt host (default: mqtt.meshtastic.org)', port: 'optional - mqtt port (defaults: 1883)', tls: 'optional - use TLS (default: false)', username: 'optional - mqtt username (default: meshdev)', password: 'optional - (default: large4cats)', client_id: 'optional - client ID (default: random 4-byte hex string)', keep_alive: 'optional - keep alive interval (default: 15)', ack_timeout: 'optional - acknowledgement timeout (default: 30)' )



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/meshtastic/mqtt.rb', line 28

public_class_method def self.connect(opts = {})
  # Publicly available MQTT server / credentials by default
  host = opts[:host] ||= 'mqtt.meshtastic.org'
  port = opts[:port] ||= 1883
  tls = true if opts[:tls]
  tls = false unless opts[:tls]
  username = opts[:username] ||= 'meshdev'
  password = opts[:password] ||= 'large4cats'
  client_id = opts[:client_id] ||= SecureRandom.random_bytes(4).unpack1('H*').to_s
  client_id = format("%0.8x", client_id) if client_id.is_a?(Integer)
  client_id = client_id.delete('!') if client_id.include?('!')
  keep_alive = opts[:keep_alive] ||= 15
  ack_timeout = opts[:ack_timeout] ||= 30

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

  mqtt_obj.keep_alive = keep_alive
  mqtt_obj.ack_timeout = ack_timeout

  mqtt_obj
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' )



308
309
310
311
312
313
314
315
 
# File 'lib/meshtastic/mqtt.rb', line 308

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

.help ⇒ Object

Display Usage for this Module



327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
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
 
# File 'lib/meshtastic/mqtt.rb', line 327

public_class_method def self.help
  puts "        USAGE:
    # Run the connect class method for this module.
    #{self}.connect(
      host: 'optional - value for host passed into connect',
      port: 'optional - value for port passed into connect',
      tls: 'optional - value for tls passed into connect',
      username: 'optional - value for username passed into connect',
      password: 'optional - value for password passed into connect',
      client_id: 'optional - value for client_id passed into connect',
      keep_alive: 'optional - value for keep_alive passed into connect',
      ack_timeout: 'optional - value for ack_timeout passed into connect'
    )

    # Run the subscribe class method for this module.
    #{self}.subscribe(
      mqtt_obj: 'optional - value for mqtt_obj passed into subscribe',
      root_topic: 'optional - value for root_topic passed into subscribe',
      region: 'optional - value for region passed into subscribe',
      topic: 'optional - value for topic passed into subscribe',
      psks: 'optional - value for psks passed into subscribe',
      qos: 'optional - value for qos passed into subscribe',
      json: 'optional - value for json passed into subscribe',
      exclude: 'optional - value for exclude passed into subscribe',
      include: 'optional - value for include passed into subscribe',
      gps_metadata: 'optional - value for gps_metadata passed into subscribe',
      include_raw: 'optional - value for include_raw passed into subscribe'
    )

    # Run the send_text class method for this module.
    #{self}.send_text(
      mqtt_obj: 'optional - value for mqtt_obj passed into send_text',
      from: 'optional - value for from passed into send_text',
      to: 'optional - value for to passed into send_text',
      root_topic: 'optional - value for root_topic passed into send_text',
      region: 'optional - value for region passed into send_text',
      topic: 'optional - value for topic passed into send_text',
      channel: 'optional - value for channel passed into send_text',
      via: 'optional - value for via passed into send_text',
      text: 'optional - value for text passed into send_text'
    )

    # Run the send_data class method for this module.
    #{self}.send_data(
      mqtt_obj: 'optional - value for mqtt_obj passed into send_data',
      data: 'optional - value for data passed into send_data',
      from: 'optional - value for from passed into send_data',
      to: 'optional - value for to passed into send_data',
      root_topic: 'optional - value for root_topic passed into send_data',
      region: 'optional - value for region passed into send_data',
      topic: 'optional - value for topic passed into send_data',
      channel: 'optional - value for channel passed into send_data',
      via: 'optional - value for via passed into send_data'
    )

    # Run the disconnect class method for this module.
    #{self}.disconnect(
      mqtt_obj: 'optional - value for mqtt_obj passed into disconnect'
    )

    # Run the authors class method for this module.
    #{self}.authors

  "
end

.send_data(opts = {}) ⇒ Object 



283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/meshtastic/mqtt.rb', line 283

public_class_method def self.send_data(opts = {})
  mqtt_obj = opts[:mqtt_obj]
  raise ArgumentError, 'mqtt_obj is required' unless mqtt_obj
  raise ArgumentError, 'data is required' unless opts[:data].is_a?(Meshtastic::Data)

  opts = opts.dup
  opts[:from] ||= mqtt_obj.client_id
  opts[:to] ||= '!ffffffff'
  opts[:root_topic] ||= 'msh'
  opts[:region] ||= 'US'
  opts[:topic] ||= '2/e/LongFast/#'
  opts[:topic] = opts[:topic].to_s.gsub('/#', '')
  opts[:channel] ||= 6
  absolute_topic = "#{opts[:root_topic]}/#{opts[:region]}/#{opts[:topic]}/#{opts[:from]}"
  opts[:topic] = absolute_topic
  opts[:via] = :mqtt
  mqtt_obj.publish(absolute_topic, Meshtastic::MeshInterface.new.send_data(opts))
rescue StandardError => e
  raise e
end

.send_text(opts = {}) ⇒ Object

Supported Method Parameters

Meshtastic::MQTT.send_text( mqtt_obj: 'required - mqtt_obj returned from #connect method', from: 'required - From ID (String or Integer) (Default: "!00000b0b")', to: 'optional - Destination ID (Default: "!ffffffff")', root_topic: 'optional - root topic (default: msh)', region: 'optional - region e.g. "US/VA", etc (default: US)', topic: 'optional - topic to publish to (default: "2/e/LongFast/#")', channel: 'optional - channel (Default: 6)', text: 'optional - Text Message (Default: SYN)', want_ack: 'optional - Want Acknowledgement (Default: false)', want_response: 'optional - Want Response (Default: false)', hop_limit: 'optional - Hop Limit (Default: 3)', on_response: 'optional - Callback on Response', psks: 'optional - hash of :channel_id => psk key value pairs (default: { LongFast: "AQ==" })' )



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/meshtastic/mqtt.rb', line 260

public_class_method def self.send_text(opts = {})
  mqtt_obj = opts[:mqtt_obj]
  opts[:from] ||= mqtt_obj.client_id
  opts[:to] ||= '!ffffffff'
  opts[:root_topic] ||= 'msh'
  opts[:region] ||= 'US'
  opts[:topic] ||= '2/e/LongFast/#'
  opts[:topic] = opts[:topic].to_s.gsub('/#', '')
  opts[:channel] ||= 6
  absolute_topic = "#{opts[:root_topic]}/#{opts[:region]}/#{opts[:topic]}/#{opts[:from]}"
  opts[:topic] = absolute_topic
  opts[:via] = :mqtt

  text = opts.fetch(:text, 'SYN').to_s
  max_len = Meshtastic::Constants::DATA_PAYLOAD_LEN
  raise ArgumentError, "ERROR: Text Length > #{max_len} Bytes" if text.bytesize > max_len

  opts[:text] = text
  mqtt_obj.publish(absolute_topic, Meshtastic::MeshInterface.new.send_text(opts))
rescue StandardError => e
  raise e
end

.subscribe(opts = {}) ⇒ Object

Supported Method Parameters

Meshtastic::MQTT.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)', topic: 'optional - channel ID path e.g. "2/stat/#" (default: "2/e/LongFast/#")', psks: 'optional - hash of :channel_id => psk key value pairs (default: { LongFast: "AQ==" })', qos: 'optional - quality of service (default: 0)', exclude: 'optional - comma-delimited string(s) to exclude in message (default: nil)', include: 'optional - comma-delimited string(s) to include 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)' )



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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
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
 
# File 'lib/meshtastic/mqtt.rb', line 73

public_class_method def self.subscribe(opts = {})
  mqtt_obj = opts[:mqtt_obj]
  root_topic = opts[:root_topic] ||= 'msh'
  region = opts[:region] ||= 'US'
  topic = opts[:topic] ||= '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_id => psk key value pairs' unless psks.is_a?(Hash)

  psks[:LongFast] = public_psk if psks[:LongFast] == 'AQ=='
  mui = Meshtastic::MeshInterface.new
  psks = mui.get_cipher_keys(psks: psks)

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

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

  # MQTT::ProtocolException: No Ping Response received for 23 seconds (MQTT::ProtocolException)

  include_arr = include.to_s.split(',').map(&:strip)
  exclude_arr = exclude.to_s.split(',').map(&:strip)
  mqtt_obj.get_packet do |packet_bytes|
    raw_packet = packet_bytes.to_s if include_raw
    raw_topic = packet_bytes.topic ||= ''
    raw_payload = packet_bytes.payload ||= ''

    begin
      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

      next unless decoded_payload_hash[:packet].is_a?(Hash)

      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 message.keys.include?(:rx_time)
        rx_time_int = message[:rx_time]
        if rx_time_int.is_a?(Integer)
          rx_time_utc = Time.at(rx_time_int).utc.to_s
          message[:rx_time_utc] = rx_time_utc
        end
      end

      if message.keys.include?(:public_key)
        raw_public_key = message[:public_key]
        message[:public_key] = Base64.strict_encode64(raw_public_key)
      end

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

        # if message[:pki_encrypted]
        #   # TODO: Display Decrypted PKI Message
        #   public_key = message[:public_key]
        #   dec_public_key = Base64.strict_decode64(public_key)
        # else
        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}"

        psk = psks[:LongFast]
        target_channel = message[:topic].split('/')[-2].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
        # end
        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]
        mui = Meshtastic::MeshInterface.new
        message[:decoded][:payload] = mui.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 Encoding::CompatibilityError,
           Google::Protobuf::ParseError,
           JSON::GeneratorError,
           ArgumentError => e

      unless e.is_a?(Encoding::CompatibilityError)
        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
      end

      next
    ensure
      # include_arr = [message[:id].to_s] if include_arr.empty?
      if message.is_a?(Hash)
        flat_message = message.values.join(' ')

        disp = exclude_arr.none? { |exc| flat_message.include?(exc) } &&
               include_arr.all? { |inc| flat_message.include?(inc) }

        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
  end
rescue Interrupt
  puts "\nCTRL+C detected. Exiting..."
rescue StandardError => e
  raise e
ensure
  mqtt_obj.disconnect if mqtt_obj
end