pcap2json 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e605ad6187e64706737b8b4986ca84e64b5b14b82446f56636650bb6791f8b94
+  data.tar.gz: bcfcb3fd42583db53e266d51698f14749bb88482965f2765b8d5d40a9c439876
+SHA512:
+  metadata.gz: abfc42a276b3bd7649daeef878c8f07ba71e9d3926022c1691ca81148087dca640fd3491d2d097c51fe3ba12b2cf0c43aa20cbbac1dd09906a24a405d4849bdf
+  data.tar.gz: 74acbb3be14387ee73ced083b3f51e698591044eefefa2f1d07b8f1679ef588b085d0c566769de8c1512bf9fdd823dc4ae376cdac14486b334456dcecc8f6a8a

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.rspec_status

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at kgruber1@emich.edu. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in pcap2json.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,51 @@
+PATH
+  remote: .
+  specs:
+    pcap2json (0.1.0)
+      oj (~> 3.7.11)
+      packetgen (~> 3.1.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    interfacez (1.0.3)
+    method_source (0.9.2)
+    oj (3.7.11)
+    packetgen (3.1.2)
+      interfacez (~> 1.0)
+      pcaprub (~> 0.12.4)
+      rasn1 (~> 0.5, >= 0.6.6)
+    pcaprub (0.12.4)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    rasn1 (0.6.8)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  pcap2json!
+  pry (~> 0.12.2)
+  rake (~> 10.0)
+  rspec (~> 3.8.0)
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Kent 'picat' Gruber
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,31 @@
+# pcap2json 
+
+Command-linee application to convert packets into json.
+
+## Installation
+
+```console
+$ gem install pcap2json
+```
+
+## Usage
+
+```console
+$ pcap2json file test.pcapng
+```
+
+```console
+$ pcap2json interface eth0
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/picatx/pcap2json. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Pcap2json project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/picatz/pcap2json/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/pcap2json

@@ -0,0 +1,39 @@
+#!/usr/bin/env ruby
+
+require "pcap2json"
+require "command_lion"
+
+Signal.trap("INT") { abort }
+
+CommandLion::App.run do
+
+  name "pcap2json"
+  version Pcap2JSON::VERSION
+
+  command :file do
+    description "Read a pcap/pcapng file as JSON and print to STDOUT"
+
+    type :string
+
+    action do
+      Pcap2JSON.from_file(argument) do |packet_json|
+        puts packet_json
+        return
+      end
+    end
+  end
+  
+  command :interface do
+    description "Read packets from a given interface as JSON and print to STDOUT"
+
+    type :string
+
+    action do
+      argument = PacketGen.default_iface if argument.nil?
+      Pcap2JSON.from_interface(argument) do |packet_json|
+        puts packet_json
+      end
+    end
+  end
+
+end

data/lib/pcap2json.rb

@@ -0,0 +1,24 @@
+require "packetgen"
+require "oj"
+require "pcap2json/version"
+require "pcap2json/packetgen_extensions"
+
+module Pcap2JSON
+  def self.from_file(filename)
+    PacketGen::PcapNG::File.new.read_packets(filename) do |packet|
+      yield packet.to_json
+    end
+  rescue StandardError => e
+    raise ArgumentError, e unless File.extname(filename.downcase) == '.pcap'
+    PCAPRUB::Pcap.open_offline(filename).each_packet do |packet|
+      next unless (packet = PacketGen.parse(packet.to_s))
+      yield packet.to_json
+    end
+  end
+
+  def self.from_interface(interface, **options)
+    PacketGen.capture(iface: interface, **options) do |packet|
+      yield packet.to_json
+    end
+  end
+end

data/lib/pcap2json/packetgen_extensions.rb

@@ -0,0 +1,165 @@
+require "pry"
+
+class PacketGen::Packet
+  def to_h
+    data = Hash.new
+    data["time"] = Time.now.to_i
+    self.headers.each do |header|
+      data[header.protocol_name.downcase] = header.to_h
+    rescue # => error
+      header.fields.reject { |field| field == :body }.each do |field|
+        data[field.to_s] = header.send(field)
+      end
+    end
+    unless self.body.nil?
+      data["payload"] = self.body.to_s.encode(Encoding.find('UTF-8'), {invalid: :replace, undef: :replace, replace: ''})
+    end
+    data
+  end
+
+  def to_json
+    Oj.dump(self.to_h)
+  end
+end
+
+class PacketGen::Header::DHCP
+  def to_h
+    data = Hash.new
+    
+    data["magic"] = self.magic
+    
+    data["options"] = []
+
+    self.options.each do |option|
+      data["options"] << option.to_human
+    end
+    
+    data
+  end
+end
+
+class PacketGen::Header::BOOTP
+  def to_h
+    {
+      "op" => self.op,
+      "htype" => self.htype,
+      "hlen" => self.hlen,
+      "xid" => self.xid,
+      "secs" => self.secs,
+      "flags" => self.flags,
+      "ciaddr" => self.ciaddr,
+      "yiaddr" => self.yiaddr,
+      "siaddr" => self.siaddr,
+      "giaddr" => self.giaddr,
+      "chaddr" => self.chaddr,
+      "sname" => self.sname,
+      "file" => self.file,
+    }
+  end
+
+end
+
+class PacketGen::Header::DNS
+  def to_h 
+    data = Hash.new
+    data["id"] = self.id
+    #data[:flags] = self.flags
+    data["opcode"] = self.opcode
+    data["rcode"] = self.rcode
+    data["qdcount"] = self.qdcount
+    data["ancount"] = self.ancount
+    data["nscount"] = self.nscount
+    data["arcount"] = self.arcount
+    data["qd"] = []
+    data["an"] = []
+    data["ns"] = []
+    data["ar"] = []
+    self.qd.to_a.each do |qd|
+      data["qd"] << qd.to_human
+    end
+    self.an.to_a.each do |an|
+      data["an"] << an.to_human
+    end
+    self.ns.to_a.each do |ns|
+      data["ns"] << ns.to_human 
+    end
+    self.ar.to_a.each do |ar|
+      data["ar"] << ar.to_human 
+    end
+    data
+  end
+end
+
+class PacketGen::Header::Eth
+  def to_h 
+    { 
+      "dst" =>  self.dst, 
+      "src" =>  self.src, 
+      "ethertype" =>  self.ethertype 
+    } 
+  end
+end
+
+class PacketGen::Header::IP
+  def to_h
+    { 
+      "u8" =>  self.u8, 
+      "version" =>  self.version, 
+      "ihl" =>  self.ihl,
+      "tos" =>  self.tos,
+      "length" =>  self.length,
+      "frag" =>  self.frag,
+      # flags =>  self.flags,
+      # frag_offset =>  self.frag_offset,
+      "ttl" =>  self.ttl,
+      "protocol" =>  self.protocol,
+      "checksum" =>  self.checksum,
+      "src" =>  self.src,
+      "dst" =>  self.dst
+    } 
+  end
+end
+
+class PacketGen::Header::TCP
+  def to_h 
+    {
+      "sport"       =>  self.sport,
+      "dport"       =>  self.dport,
+      "seqnum"      =>  self.seqnum,
+      "acknum"      =>  self.acknum,
+      "u16"         =>  self.u16,
+      "data_offset" =>  self.data_offset,
+      "reserved"    =>  self.reserved,
+      "flags"       =>  self.flags,
+      "window"      =>  self.window,
+      "checksum"    =>  self.checksum,
+      "urg_pointer" =>  self.urg_pointer,
+      # options =>  self.options
+    }
+  end
+end
+
+class PacketGen::Header::UDP
+  def to_h
+    { 
+      "sport"    =>  self.sport, 
+      "dport"    =>  self.dport, 
+      "length"   =>  self.length, 
+      "checksum" =>  self.checksum 
+    }
+  end
+end
+
+class PacketGen::Header::ARP
+  def to_h
+    { 
+      "hrd" => self.hrd, 
+      "pro" => self.pro, 
+      "hln" => self.hln, 
+      "op"  => self.op, 
+      "sha" => self.sha, 
+      "tha" => self.tha, 
+      "tpa" => self.tpa 
+    }
+  end
+end

data/lib/pcap2json/version.rb

@@ -0,0 +1,3 @@
+module Pcap2JSON
+  VERSION = "0.1.0"
+end

data/pcap2json.gemspec

@@ -0,0 +1,31 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "pcap2json/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "pcap2json"
+  spec.version       = Pcap2JSON::VERSION
+  spec.authors       = ["Kent 'picat' Gruber"]
+  spec.email         = ["kgruber1@emich.edu"]
+
+  spec.summary       = %q{Convert packets to json from a file or a live network interface.}
+  #spec.description   = %q{TODO: Write a longer description or delete this line.}
+  spec.homepage      = "https://github.com/picatz/pcap2json"
+  spec.license       = "MIT"
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  
+  spec.add_dependency "packetgen", "~> 3.1.2"
+  spec.add_dependency "oj", "~> 3.7.11"
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.8.0"
+  spec.add_development_dependency "pry", "~> 0.12.2"
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: pcap2json
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kent 'picat' Gruber
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-04-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: packetgen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.2
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.7.11
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.7.11
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+description: 
+email:
+- kgruber1@emich.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/pcap2json
+- lib/pcap2json.rb
+- lib/pcap2json/packetgen_extensions.rb
+- lib/pcap2json/version.rb
+- pcap2json.gemspec
+homepage: https://github.com/picatz/pcap2json
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 3.0.0.beta1
+signing_key: 
+specification_version: 4
+summary: Convert packets to json from a file or a live network interface.
+test_files: []