meshtastic 0.0.16 → 0.0.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a08e990fbc46c4caecefeaa6540bbadcf7375bf1d65b147a09888f2793dea9ef
-  data.tar.gz: 2248f4cf658c46f45ae1a57489fa46f6b9f9a748e4d75eb121832cbd1b9470ca
+  metadata.gz: 95418c85d77e376647941a4ad72cb556f36917e3e08c38459e7d500ebc198fe8
+  data.tar.gz: c25683cfd633e2aceb1a21c12b25bdaaaff2df1cca710457786e9721c9107971
 SHA512:
-  metadata.gz: 200bc30e3aaf7ef4ae66b7abdff5dea63b015b84651a0c3eb679c4c1153a4315150c62f745a1851f934a601c74911903bdb1ab92211ace5852e6fdcd69f8104c
-  data.tar.gz: 85264bb17cb44f2c9cc16956b7945db33dcd9b0c23639d9d26bbaad234b9d499c3b4beb4e416f5919ab9d16736d78935b9de98e054161a069b8325f465765416
+  metadata.gz: 07ad4d65c7734479d9f97c8f4af7ffa7496b1bca97adc108d1fa617b9f1836a793836d702171358cbbccc23151a2479975b4bd62a1a9e77024bd925fbb850870
+  data.tar.gz: 8a11bec783dd3b48dfc4c830b651771ec0f9aadb9d0fc4814fab478f20eaf1ff197ee79d91a2ea458f79a76c1a3a9815c848045fd6e93255606cc39041b83976

data/README.md

@@ -1,13 +1,16 @@
 # Meshtastic
-Ruby gem for interfacing with Meshtastic nodes.
+
+Ruby gem for interfacing with Meshtastic nodes / network.
 
 # Setting Expectations
-This gem was created to support alt-comm capabilities w/in a security research framework known as [PWN]('https://github.com/0dayInc/pwn').  Contributors of this effort cannot guarantee full functionality or support for all Meshtastic features.
+
+This gem was created to support alt-comm capabilities w/in a security research framework known as [PWN](https://github.com/0dayInc/pwn).  Contributors of this effort cannot guarantee full functionality or support for all Meshtastic features.
 
 # Objectives
-- Consume the [Meshtastic Protobofs]('https://github.com/meshtastic/protobufs') and [generate Ruby protobuf modules for Meshtastic]('https://github.com/0dayInc/meshtastic/blob/master/AUTOGEN_meshtastic_protobufs.sh') using the protoc command: Complete
-- Integrate a working gem that can interface with the automatically generated Ruby protobuf modules: Complete
-- Scale out Meshtastic Ruby Modules for their respective protobufs within the meshtastic gem (e.g. Meshtastic::MQTTPB is auto-generated based on latest Meshtastic protobuf specs and extended via Meshtastic::MQTT for more MQTT interaction as desired): Continued Effort
+
+- Consume the latest [Meshtastic Protobof Specs](https://github.com/meshtastic/protobufs) and [auto-generate Ruby protobuf modules for Meshtastic](https://github.com/0dayInc/meshtastic/blob/master/AUTOGEN_meshtastic_protobufs.sh) using the `protoc` command: `Complete`
+- Integrate auto-generated Ruby protobuf modules into a working Ruby gem: `Complete`
+- Scale out Meshtastic Ruby Modules for their respective protobufs within the meshtastic gem (e.g. Meshtastic::MQTTPB is auto-generated based on latest Meshtastic protobuf specs and extended via Meshtastic::MQTT for more MQTT interaction as desired): `Ongoing Effort`
 
 ## Installation
 
@@ -21,7 +24,7 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ## Usage
 
-At the moment the only working module is `Meshtastic::MQTT`.  To view MQTT messages, run the following:
+At the moment the only module available is `Meshtastic::MQTT`.  To view MQTT messages, run the following:
 
 ```ruby
 require 'meshtastic'
@@ -32,8 +35,8 @@ Meshtastic::MQTT.subscribe(mqtt_obj: mqtt_obj)
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/0dayinc/meshtastic. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/meshtastic/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/0dayinc/meshtastic. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/0dayinc/meshtastic/blob/master/CODE_OF_CONDUCT.md).
 
 ## Code of Conduct
 
-Everyone interacting in the Meshtastic project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/meshtastic/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Meshtastic project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/0dayinc/meshtastic/blob/master/CODE_OF_CONDUCT.md).

data/lib/meshtastic/mqtt.rb

@@ -49,7 +49,8 @@ module Meshtastic
     #   channel: 'optional - channel name (default: LongFast)',
     #   psk: 'optional - channel pre-shared key (default: AQ==)',
     #   qos: 'optional - quality of service (default: 0)',
-    #   json: 'optional - JSON output (default: false)'
+    #   json: 'optional - JSON output (default: false)',
+    #   filter: 'optional - comma-delimited string(s) to search for in the payload (default: nil)'
     # )
 
     public_class_method def self.subscribe(opts = {})
@@ -59,6 +60,7 @@ module Meshtastic
       psk = opts[:psk] ||= 'AQ=='
       qos = opts[:qos] ||= 0
       json = opts[:json] ||= false
+      filter = opts[:filter]
 
       # TODO: Find JSON URI for this
       root_topic = "msh/#{region}/2/json" if json
@@ -78,71 +80,34 @@ module Meshtastic
 
       # cipher = OpenSSL::Cipher.new('AES-256-CTR')
       cipher = OpenSSL::Cipher.new('AES-128-CTR')
+      filter_arr = filter.to_s.split(',').map(&:strip)
       mqtt_obj.get_packet do |packet_bytes|
-        # puts "Packet Bytes: #{packet_bytes.public_methods}"
         raw_packet = packet_bytes.to_s.b
         raw_packet_len = raw_packet.to_s.b.length
         raw_topic = packet_bytes.topic
         raw_payload = packet_bytes.payload
-        raw_payload_len = raw_payload.length
 
         begin
-          puts '-' * 80
-
           payload = {}
           if json
-            json_payload = JSON.parse(raw_payload, symbolize_names: true)
-            payload = Meshtastic::ServiceEnvelope.json_decode(json_payload)
-            map_report = Meshtastic::MapReport.json_decode(json_payload)
+            payload = JSON.parse(raw_payload, symbolize_names: true)
           else
-            svc_envl= Meshtastic::ServiceEnvelope.decode(raw_payload)
+            svc_envl = Meshtastic::ServiceEnvelope.decode(raw_payload)
+            # map_report = Meshtastic::MapReport.decode(raw_payload)
             payload = svc_envl.to_h[:packet]
-            # puts "STILL GOOD: #{payload.inspect}"
-            # puts "Public Methods: #{Meshtastic::MapReport.public_methods}"
-            # puts "Public Methods: #{Meshtastic::MapReport.class}"
-            # map_report_decode = Meshtastic::MapReport.decode(raw_payload)
-            # map_report = map_report_decode.to_h
-            # puts "STILL GOOD: #{map_report.inspect}"
-          end
-
-          puts "*** MESSAGE ***"
-          packet_from = payload[:from]
-          puts "Packet From: #{packet_from}"
-          packet_to = payload[:to]
-          puts "Packet To: #{packet_to}"
-          channel = payload[:channel]
-          puts "Channel: #{channel}"
-          packet_id = payload[:id]
-          puts "Packet ID: #{packet_id}"
-          puts "\nTopic: #{raw_topic}"
-
-          decoded_payload = payload[:decoded]
-          if decoded_payload
-            port_num = decoded_payload[:portnum]
-            puts "Port Number: #{port_num}"
-            decp = decoded_payload[:payload].b
-            puts "Decoded Payload: #{decp.inspect}"
-            want_response = decoded_payload[:want_response]
-            puts "Want Response: #{want_response}"
-            dest = decoded_payload[:dest]
-            puts "Destination: #{dest}"
-            source = decoded_payload[:source]
-            puts "Source: #{source}"
-            request_id = decoded_payload[:request_id]
-            puts "Request ID: #{request_id}"
-            reply_id = decoded_payload[:reply_id]
-            puts "Reply ID: #{reply_id}"
-            emoji = decoded_payload[:emoji]
-            puts "Emoji: #{emoji}"
           end
+          payload[:topic] = raw_topic
+          payload[:node_id_from] = "!#{payload[:from].to_i.to_s(16)}"
+          payload[:node_id_to] = "!#{payload[:to].to_i.to_s(16)}"
 
           encrypted_payload = payload[:encrypted]
           # If encrypted_payload is not nil, then decrypt the message
           if encrypted_payload.length.positive?
+            packet_id = payload[:id]
+            packet_from = payload[: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
-            puts "Nonce: #{nonce.inspect} | Length: #{nonce.length}"
 
             # Decrypt the message
             # Key must be 32 bytes
@@ -150,62 +115,42 @@ module Meshtastic
             cipher.decrypt
             cipher.key = dec_psk
             cipher.iv = nonce
-            puts "\nEncrypted Payload:\n#{encrypted_payload.inspect}"
-            puts "Length: #{encrypted_payload.length}" if encrypted_payload
 
             decrypted = cipher.update(encrypted_payload) + cipher.final
-            puts "\nDecrypted Payload:\n#{decrypted.inspect}"
-            puts "Length: #{decrypted.length}" if decrypted
+            payload[:decrypted] = decrypted
           end
-          puts '*' * 20
-
-          # map_long_name = map_report[:long_name].b
-          # puts "\n*** MAP STATS ***"
-          # puts "Map Long Name: #{map_long_name.inspect}"
-          # map_short_name = map_report[:short_name]
-          # puts "Map Short Name: #{map_short_name}"
-          # role = map_report[:role]
-          # puts "Role: #{role}"
-          # hw_model = map_report[:hw_model]
-          # puts "Hardware Model: #{hw_model}"
-          # firmware_version = map_report[:firmware_version]
-          # puts "Firmware Version: #{firmware_version}"
-          # region = map_report[:region]
-          # puts "Region: #{region}"
-          # modem_preset = map_report[:modem_preset]
-          # puts "Modem Preset: #{modem_preset}"
-          # has_default_channel = map_report[:has_default_channel]
-          # puts "Has Default Channel: #{has_default_channel}"
-          # latitiude_i = map_report[:latitude_i]
-          # puts "Latitude: #{latitiude_i}"
-          # longitude_i = map_report[:longitude_i]
-          # puts "Longitude: #{longitude_i}"
-          # altitude = map_report[:altitude]
-          # puts "Altitude: #{altitude}"
-          # position_precision = map_report[:position_precision]
-          # puts "Position Precision: #{position_precision}"
-          # num_online_local_nodes = map_report[:num_online_local_nodes]
-          # puts "Number of Online Local Nodes: #{num_online_local_nodes}"
-          # puts '*' * 20
-
-          puts "\n*** PACKET DEBUGGING ***"
-          puts "Payload: #{payload.inspect}"
-          # puts "\nMap Report: #{map_report.inspect}"
-          puts "\nRaw Packet: #{raw_packet.inspect}"
-          puts "Length: #{raw_packet_len}"
-          puts '*' * 20
-        rescue Google::Protobuf::ParseError => e
-          puts "ERROR: #{e.inspect}"
-          puts "\n*** PACKET DEBUGGING ***"
-          puts "Payload: #{payload.inspect}"
+
+          filter_arr = [payload[:id].to_s] if filter.nil?
+          disp = false
+          flat_payload = payload.values.join(' ')
+
+          disp = true if filter_arr.first == payload[:id] ||
+                         filter_arr.all? { |filter| flat_payload.include?(filter) }
+
+          if disp
+            puts "\n"
+            puts '-' * 80
+            puts "\n*** DEBUGGING ***"
+            puts "Payload:\n#{payload}"
+            # puts "\nMap Report: #{map_report.inspect}"
+            puts "\nRaw Packet: #{raw_packet.inspect}"
+            puts "Length: #{raw_packet_len}"
+            puts '-' * 80
+            puts "\n\n\n"
+          else
+            print '.'
+          end
+        rescue Google::Protobuf::ParseError
+          puts "\n"
+          puts '-' * 80
+          puts "\n*** DEBUGGING ***"
+          puts "Payload:\n#{payload}"
           # puts "\nMap Report: #{map_report.inspect}"
           puts "\nRaw Packet: #{raw_packet.inspect}"
           puts "Length: #{raw_packet_len}"
-          puts '*' * 20
-          next
-        ensure
           puts '-' * 80
           puts "\n\n\n"
+          next
         end
       end
     rescue Interrupt

data/lib/meshtastic/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Meshtastic
-  VERSION = '0.0.16'
+  VERSION = '0.0.18'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: meshtastic
 version: !ruby/object:Gem::Version
-  version: 0.0.16
+  version: 0.0.18
 platform: ruby
 authors:
 - 0day Inc.