packetgen 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 45af460b696e393ab1c89b3e27fba605246eafc5
-  data.tar.gz: 18f621d8edd0c5c5fee18a97c5ffb9c1d31043c3
+  metadata.gz: 3cb4095a7e2fda39a7560ad82d4296016c5a633a
+  data.tar.gz: aed1db17fd5274a7d842ac6ba855ed73b7d271fe
 SHA512:
-  metadata.gz: dfc16c31052743888efb32945d26d16995e975d6affb47c3a52f4fa4338e7906b75548f8d87e14c963ea89d21e08d877e3f9b62cfa723cf35da90b33a42d3cd4
-  data.tar.gz: d88d482c4eb651b4175453b29c1e71215935d8ff630598dfcb44c33662b272227bda2aea46f7c219c52cd57c9f5093cf2d03dc668e097c03c58f4a89f725dbf3
+  metadata.gz: a520f1dfaf0a6960c33fb27c5f564923c4de11c8d310b77c7dcf151c688df70d15396b1ce74987b7a8ca811e86f58a2f6eaf1d0a18ba03613ed02aebde9f9730
+  data.tar.gz: e8396d8782c437335f50a3b8ee2e63138a9b0c4ea874b46838249fcb58e8f1acc89f1a7c24c6fd0fda5169c856f9724296e2c285c826223c91eebca5eba60a95

data/README.md

@@ -16,13 +16,16 @@ Yes. But PacketFu is limited:
 * parse packets top-down, and sometimes bad parse down layers
 * cannot send packet on wire at IP/IPv6 level (Ethernet header is mandatory)
 
-## use cases
+## Installation
+Via RubyGems:
 
-These use cases are the roadmap for PacketGen.
+    $ gem install packetgen
 
-Not yet implemented:
-- encapsulation/decapsulation
-- some protocols...
+Or add it to a Gemfile:
+```ruby
+gem 'packetgen'
+```
+## Usage
 
 ### Easily create packets
 ```
@@ -91,7 +94,7 @@ pkt.is? 'TCP'   # => true
 pkt.is? 'IP'    # => true
 pkt.is? 'UDP'   # => false
 
-# encapulsate/decapsulate packets
+# encapulsate/decapsulate packets (TODO)
 pkt2 = PacketGen.gen('IP').add('ESP', spi: 1234)
 pkt.encap pkt2                         # pkt is now a IP/ESP/IP/TCP packet
                                        # eq. to pkt.encap('IP', 'ESP', esp_spi: 1234)
@@ -109,6 +112,10 @@ pkt.write('one_packet.pcapng')
 PacketGen.write('more_packets.pcapng', packets)
 ```
 
+## Pull requests?
+
+yes
+
 ## License
 MIT License (see [LICENSE](https://github.com/sdaubert/packetgen/LICENSE))
 
@@ -118,4 +125,4 @@ Copyright © 2016 Sylvain Daubert
 All original code maintains its copyright from its original authors and licensing.
 
 This is mainly for StrucFu (copied from [PacketFu](https://github.com/packetfu/packetfu))
-and PcapNG module (also copied from PacketFu, but I am the author).
+and PcapNG module (also copied from PacketFu, but I am the author).

data/lib/packetgen.rb

@@ -42,7 +42,7 @@ module PacketGen
   # @yieldparam [Packet] packet
   # @return [Array<Packet>]
   def self.capture(iface, options={})
-    Packet.capture(iface, options) { |packet| yield packet }
+    Packet.capture(iface, options) { |packet| yield packet if block_given? }
   end
 
   # Shortcut for {Packet.read}

data/lib/packetgen/capture.rb

@@ -65,7 +65,7 @@ module PacketGen
       @cap_thread.join(@timeout)
     end
 
-    # Stop capture. Should be used from another thread, as {#start} blocs.
+    # Stop capture. Should be used from another thread, as {#start} blocks.
     #
     # BEWARE: multiple capture should not be started in different threads. No effort
     # has been made to make Capture nor PacketGen thread-safe.
@@ -79,11 +79,7 @@ module PacketGen
     def set_options(options)
       @max = options[:max] if options[:max]
       @filter = options[:filter] if options[:filter]
-      if options[:timeout]
-        @timeout = options[:timeout]
-      else
-        @timeout ||= 0
-      end
+      @timeout = options[:timeout] if options[:timeout]
       if options[:promisc]
         @promisc = options[:promisc]
       else

data/lib/packetgen/header/header_methods.rb

@@ -52,6 +52,12 @@ module PacketGen
         iph
       end
 
+      # Return header protocol name
+      # @return [String]
+      def protocol_name
+        self.class.to_s.sub(/.*::/, '')
+      end
+
       # Common inspect method for headers
       # @return [String]
       def inspect

data/lib/packetgen/packet.rb

@@ -169,7 +169,7 @@ module PacketGen
         if binding.nil?
           msg = "#{prev_header.class} knowns no layer association with #{protocol}. "
           msg << "Try #{prev_header.class}.bind_layer(PacketGen::Header::#{protocol}, "
-          msg << "#{prev_header.class.to_s.gsub(/(.*)::/, '').downcase}_proto_field: "
+          msg << "#{prev_header.protocol_name.downcase}_proto_field: "
           msg << "value_for_#{protocol.downcase})"
           raise ArgumentError, msg
         end
@@ -252,7 +252,7 @@ module PacketGen
       if @headers.first.respond_to? :to_w
         @headers.first.to_w(iface)
       else
-        type = @headers.first.class.to_s.gsub(/.*::/, '')
+        type = @headers.first.protocol_name
         raise WireError, "don't known how to send a #{type} packet on wire"
       end
     end

data/lib/packetgen/version.rb

@@ -8,5 +8,5 @@
 # @author Sylvain Daubert
 module PacketGen
   # PacketGen version
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: packetgen
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Sylvain Daubert
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-18 00:00:00.000000000 Z
+date: 2016-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pcaprub