dhcpsapi 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c9740f4c12d6acbd2ec1543f1b2df97e2b4ecd80
-  data.tar.gz: 89ebad17dc6a96c7354a06754dfc79f76d7bde8c
+  metadata.gz: 90390bfda1251be29291f1ccc64fae4358333060
+  data.tar.gz: e0709a99e9c7996f1de1928226edfa92ff12b6e2
 SHA512:
-  metadata.gz: d389e520e1ab8e5e29920b6a29c082f71a4d4b5a42021c4ba201d2ce1a71c7f2c355e9c1b420290d7c8fdd34972d7e25a50dc1e5423a62610133f11f659cc5dd
-  data.tar.gz: 66f36da0548a51a88bf410f3fb91cce72da8eb5cdf5a8ba0680a051cac1842b7ac04c14b91fc959b4ad0566f5683ebb0842d8233f9ead53a9d88d81db7a3bb9f
+  metadata.gz: 8d71ceba9348203e4a045afa1867281575f126430e7473beb40adafee6f3e793ad49dc509dae4875ee54ce3a2c97978339b1ed6d3302e615c02d2050a742127b
+  data.tar.gz: 458300694746a914f91580cbcb2ce38f70d931559e69913fef9b237471aacc1821735f1ca1c16da349fef845620664bac9c61a37c5515c876d800a4eabba49fe

data/lib/dhcpsapi/client.rb

@@ -1,5 +1,34 @@
 module DhcpsApi
   module Client
+    # Returns a a list of subnet clients (Windows 2008-compatible version).
+    #
+    # @example List subnet clients
+    #
+    # api.list_clients_2008('192.168.42.0')
+    #
+    # @param subnet_address [String] Subnet ip address
+    #
+    # @return [Array<Hash>]
+    #
+    # @see DHCP_CLIENT_INFO_V4 DHCP_CLIENT_INFO_V4 documentation for the list of available fields.
+    #
+    def list_clients_2008(subnet_address)
+      items, _ = retrieve_items(:dhcp_enum_subnet_clients_v4, subnet_address, 1024, 0)
+      items
+    end
+
+    # Returns a a list of subnet clients (Windows 2012-compatible version).
+    #
+    # @example List subnet clients
+    #
+    # api.list_clients('192.168.42.0')
+    #
+    # @param subnet_address [String] Subnet ip address
+    #
+    # @return [Array<Hash>]
+    #
+    # @see DHCP_CLIENT_INFO_PB DHCP_CLIENT_INFO_PB documentation for the list of available fields.
+    #
     def list_clients(subnet_address)
       items, _ = retrieve_items(:dhcp_v4_enum_subnet_clients, subnet_address, 1024, 0)
       items
@@ -121,6 +150,30 @@ module DhcpsApi
       to_return
     end
 
+    def dhcp_enum_subnet_clients_v4(subnet_address, preferred_maximum, resume_handle)
+      resume_handle_ptr = FFI::MemoryPointer.new(:uint32).put_uint32(0, resume_handle)
+      client_info_ptr_ptr = FFI::MemoryPointer.new(:pointer)
+      elements_read_ptr = FFI::MemoryPointer.new(:uint32).put_uint32(0, 0)
+      elements_total_ptr = FFI::MemoryPointer.new(:uint32).put_uint32(0, 0)
+
+      error = DhcpsApi::Win2008::Client.DhcpEnumSubnetClientsV4(
+          to_wchar_string(server_ip_address), ip_to_uint32(subnet_address), resume_handle_ptr, preferred_maximum,
+          client_info_ptr_ptr, elements_read_ptr, elements_total_ptr)
+      return empty_response if error == 259
+      if is_error?(error)
+        unless (client_info_ptr_ptr.null? || (to_free = client_info_ptr_ptr.read_pointer).null?)
+          free_memory(DhcpsApi::DHCP_CLIENT_INFO_ARRAY_V4.new(to_free))
+        end
+        raise DhcpsApi::Error.new("Error retrieving clients from subnet '%s'." % [subnet_address], error)
+      end
+
+      leases_array = DhcpsApi::DHCP_CLIENT_INFO_ARRAY_V4.new(client_info_ptr_ptr.read_pointer)
+      leases = leases_array.as_ruby_struct
+      free_memory(leases_array)
+
+      [leases, resume_handle_ptr.get_uint32(0), elements_read_ptr.get_uint32(0), elements_total_ptr.get_uint32(0)]
+    end
+
     def dhcp_v4_enum_subnet_clients(subnet_address, preferred_maximum, resume_handle)
       resume_handle_ptr = FFI::MemoryPointer.new(:uint32).put_uint32(0, resume_handle)
       client_info_ptr_ptr = FFI::MemoryPointer.new(:pointer)

data/lib/dhcpsapi/data_structures.rb

@@ -292,18 +292,21 @@ module DhcpsApi
            :classes, :pointer
   end
 
-=begin
-  typedef struct _DHCP_CLIENT_INFO_V4 {
-    DHCP_IP_ADDRESS ClientIpAddress;
-    DHCP_IP_MASK    SubnetMask;
-    DHCP_CLIENT_UID ClientHardwareAddress;
-    LPWSTR          ClientName;
-    LPWSTR          ClientComment;
-    DATE_TIME       ClientLeaseExpires;
-    DHCP_HOST_INFO  OwnerHost;
-    BYTE            bClientType;
-  } DHCP_CLIENT_INFO_V4, *LPDHCP_CLIENT_INFO_V4;
-=end
+  #
+  # DHCP_CLIENT_INFO_V4 defines a client information record used by the DHCP server.
+  #
+  # Available fields:
+  # :client_ip_address [String],
+  # :subnet_mask [String],
+  # :client_hardware_address [String],
+  # :client_name [String],
+  # :client_comment [String],
+  # :client_lease_expires [Date],
+  # :owner_host [DHCP_HOST_INFO],
+  # :client_type, [Fixnum]
+  #
+  # @see https://msdn.microsoft.com/en-us/library/windows/desktop/dd897579(v=vs.85).aspx
+  #
   class DHCP_CLIENT_INFO_V4 < DHCPS_Struct
     layout :client_ip_address, :uint32,
            :subnet_mask, :uint32,
@@ -319,6 +322,23 @@ module DhcpsApi
     ruby_struct_attr :to_string, :client_name, :client_comment
   end
 
+=begin
+  typedef struct _DHCP_CLIENT_INFO_ARRAY_V4 {
+    DWORD                 NumElements;
+    LPDHCP_CLIENT_INFO_V4 *Clients;
+  } DHCP_CLIENT_INFO_ARRAY_V4, *LPDHCP_CLIENT_INFO_ARRAY_V4;
+=end
+  class DHCP_CLIENT_INFO_ARRAY_V4 < DHCPS_Struct
+    layout :num_elements, :uint32,
+           :clients, :pointer
+
+    def as_ruby_struct
+      0.upto(self[:num_elements]-1).inject([]) do |all, offset|
+        all << DHCP_CLIENT_INFO_V4.new((self[:clients] + offset*FFI::Pointer.size).read_pointer).as_ruby_struct
+      end
+    end
+  end
+
 =begin
   typedef struct _DHCP_CLIENT_SEARCH_INFO {
     DHCP_SEARCH_INFO_TYPE SearchType;
@@ -568,24 +588,27 @@ typedef struct _DHCP_OPTION_ARRAY {
 # Data structures available in Win2012
 #
 
-=begin
-  typedef struct _DHCP_CLIENT_INFO_PB {
-    DHCP_IP_ADDRESS  ClientIpAddress;
-    DHCP_IP_MASK     SubnetMask;
-    DHCP_CLIENT_UID  ClientHardwareAddress;
-    LPWSTR           ClientName;
-    LPWSTR           ClientComment;
-    DATE_TIME        ClientLeaseExpires;
-    DHCP_HOST_INFO   OwnerHost;
-    BYTE             bClientType;
-    BYTE             AddressState;
-    QuarantineStatus Status;
-    DATE_TIME        ProbationEnds;
-    BOOL             QuarantineCapable;
-    DWORD            FilterStatus;
-    LPWSTR           PolicyName;
-  } DHCP_CLIENT_INFO_PB, *LPDHCP_CLIENT_INFO_PB;
-=end
+  #
+  # DHCP_CLIENT_INFO_V4 defines a client information record used by the DHCP server.
+  #
+  # Available fields:
+  # :client_ip_address [String],
+  # :subnet_mask [String],
+  # :client_hardware_address [String],
+  # :client_name [String],
+  # :client_comment [String],
+  # :client_lease_expires [Date],
+  # :owner_host [DHCP_HOST_INFO],
+  # :client_type, [Fixnum]
+  # :address_state, [Fixnum]
+  # :status, [Fixnum]
+  # :probation_ends, [Date]
+  # :quarantine_capable, [Boolean]
+  # :filter_status, [Fixnum]
+  # :policy_name, [String]
+  #
+  # @see https://msdn.microsoft.com/en-us/library/windows/desktop/hh404371(v=vs.85).aspx
+  #
   class DHCP_CLIENT_INFO_PB < DhcpsApi::DHCPS_Struct
     layout  :client_ip_address, :uint32,
             :subnet_mask, :uint32,

data/lib/dhcpsapi/version.rb

@@ -1,3 +1,3 @@
 module DhcpsApi
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/lib/dhcpsapi/win2008/client.rb

@@ -4,6 +4,19 @@ module DhcpsApi::Win2008
     ffi_lib 'dhcpsapi'
     ffi_convention :stdcall
 
+=begin
+  DWORD DHCP_API_FUNCTION DhcpEnumSubnetClientsV4(
+    _In_    DHCP_CONST WCHAR            *ServerIpAddress,
+    _In_    DHCP_IP_ADDRESS             SubnetAddress,
+    _Inout_ DHCP_RESUME_HANDLE          *ResumeHandle,
+    _In_    DWORD                       PreferredMaximum,
+    _Out_   LPDHCP_CLIENT_INFO_ARRAY_V4 *ClientInfo,
+    _Out_   DWORD                       *ClientsRead,
+    _Out_   DWORD                       *ClientsTotal
+  );
+=end
+    attach_function :DhcpEnumSubnetClientsV4, [:pointer, :uint32, :pointer, :uint32, :pointer, :pointer, :pointer], :uint32
+
 =begin
   DWORD DhcpCreateClientInfoV4(
     _In_ DHCP_CONST WCHAR                 *ServerIpAddress,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dhcpsapi
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Dmitri Dolguikh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-01 00:00:00.000000000 Z
+date: 2016-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi