lib-dhcp 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fdd10e98acc7696e58820d6b1e40ce262a65c9a85a48d60229a5a9b9c2876b3b
-  data.tar.gz: 739aff2909214a5dc49bf09d8169bf8f0fda1b4349bb67a1cd372502bc135950
+  metadata.gz: 469107e2ffb835ce16363c3551c164b4599452f141f875d7e747608307f63fe6
+  data.tar.gz: 4daff9d9484b41dc9ff57707bb3a364546a499228d8b16e7910a3a219a57e4b5
 SHA512:
-  metadata.gz: 0465a4aa77a5fea5860de2676ffcce737ba494055db6fcda1296aa3b69c42fb412ff53f7477697834c55b8ca55bfb558d0b35691f0ce0fdafac0e0bae833b964
-  data.tar.gz: c5705c5689e2155aff7225cdb8b7cd0cd8b57755366eb77ecff58264a7b26083b75b5bfdabd66ceba06be506578c4c8d3a04bd87c7aa57db3899856f4c3d2f93
+  metadata.gz: eb49b3e6f14db18cfb548d1b4ab82d4e02ce46be31a8b2b5b222288780885dbe9fc487941171646c5972d16f9205e2191b39ad5cc458aa1d22b6c59756179b9a
+  data.tar.gz: bede9b42341af0dca0b8e5563700bad97f9dccb7f479a3f2f0755b2c3654c13479d5a165444a8921953c9e9850324eb0245bf3ac07591d4da475b2f4eff6072c

data/README.md

@@ -2,6 +2,8 @@
 
 Ruby library to low level handle the DHCP protocol.
 
+Lib::Dhcp provides tools for constructing, parsing, and manipulating DHCP packets, enabling developers to interact with
+the DHCP protocol directly.
 
 ## Installation
 
@@ -19,10 +21,113 @@ Or install it yourself as:
 
     $ gem install lib-dhcp
 
+## Usage
+
+Below are some examples of how to use the `lib-dhcp` library:
+
+### Creating a DHCP Packet
+
+You can create a new DHCP Discovery packet:
+
+```ruby
+require 'lib/dhcp'
+
+# Create a new DHCP Discovery message
+packet = Lib::DHCP::Message::Discover.new
+
+# Print the generated packet
+puts packet.to_s
+```
+
+### Parsing an Incoming DHCP Packet
+
+To parse a binary DHCP packet:
+
+```ruby
+require 'lib/dhcp'
+
+# Binary data representing a DHCP packet
+data = "\x01\x01\x06\x00\x8D\x9E2\xA4\x00\x00\x00\x00\x00\x00\x00\x00" \
+  "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00" \
+  "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00.\x00\x00\x00\x00\x00\x00" \
+  "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00" \
+  "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00" \
+  "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00" \
+  "\x00\x00\x00\x00\x00\x00.\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00" \
+  "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00" \
+  "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00" \
+  "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00" \
+  "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00" \
+  "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00" \
+  "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00" \
+  "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00c\x82Sc5\x01" \
+  "\x01\xFF\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00" \
+  "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00" \
+  "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00" \
+  "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00"
+
+# Parse the binary data into a Lib::DHCP::Message
+packet = Lib::DHCP::Message.unpack(data)
+
+# Access packet fields and options
+puts "Transaction ID: #{packet.xid}"
+puts "DHCP Message Type: #{packet.option53}"
+```
+
+### Working with DHCP Options
+
+You can manipulate DHCP options easily:
+
+```ruby
+require 'lib/dhcp'
+
+packet = Lib::DHCP::Message::Request.new
+
+# Add options
+packet.options.add([51, 3600]) # Lease Time
+packet.options.add([1, '255.255.255.0']) # Subnet mask
+packet.option3 = '192.168.1.1' # Router (Gateway)
+
+# Retrieve an option
+lease_time = packet.option51 # Returns the lease time
+puts "Lease Time: #{lease_time}s"
+```
+
+### Reading DHCP Data from a UDP Socket
+
+You can listen for DHCP packets on a UDP socket:
+
+```ruby
+require 'socket'
+require 'lib/dhcp'
+
+# Open UDP socket to listen on port 67 (DHCP Server Port)
+socket = UDPSocket.new
+socket.bind('0.0.0.0', 67)
+
+puts "Listening for DHCP packets on port 67..."
+
+loop do
+  # Receive data from the socket
+  data, _addr = socket.recvfrom(1024)
+
+  # Parse the received data
+  packet = Lib::DHCP::Message.unpack(data)
+
+  # Print information about the packet
+  puts "Received DHCP Packet:"
+  puts "Transaction ID: #{packet.xid}"
+  puts "Client IP: #{packet.ciaddr}"
+  puts "Your IP: #{packet.yiaddr}"
+  puts "DHCP Message Type: #{packet.options[53]}"
+end
+```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/pwojcieszonek/lib-dhcp. 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.
+Bug reports and pull requests are welcome on GitHub at https://github.com/pwojcieszonek/lib-dhcp. 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
 
@@ -30,4 +135,5 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Lib::Dhcp project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/lib-dhcp/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Lib::Dhcp project’s codebases, issue trackers, chat rooms and mailing lists is expected to
+follow the [code of conduct](https://github.com/pwojcieszonek/lib-dhcp/blob/master/CODE_OF_CONDUCT.md).

data/lib/lib/dhcp/messages/message.rb

@@ -50,6 +50,8 @@ module Lib
       end
 
       def self.from_json(json)
+        json = JSON.parse(json) if json.is_a? String
+        json["options"] = json["options"].reject { |option| option["oid"] == 255 || option["oid"] == 0 }
         self.unpack(super(json).pack)
       end
 

data/lib/lib/dhcp/version.rb

@@ -1,5 +1,5 @@
 module Lib
   module DHCP
-    VERSION = '0.2.1'
+    VERSION = '0.2.2'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lib-dhcp
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Piotr Wojcieszonek