facter 4.0.23

data/lib/resolvers/windows/dmi_computersystem_resolver.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Facter
+  module Resolvers
+    class DMIComputerSystem < BaseResolver
+      @log = Facter::Log.new(self)
+      @semaphore = Mutex.new
+      @fact_list ||= {}
+
+      class << self
+        # Name
+        # UUID
+
+        private
+
+        def post_resolve(fact_name)
+          @fact_list.fetch(fact_name) { read_fact_from_computer_system(fact_name) }
+        end
+
+        def read_fact_from_computer_system(fact_name)
+          win = Win32Ole.new
+          computersystem = win.return_first('SELECT Name,UUID FROM Win32_ComputerSystemProduct')
+          unless computersystem
+            @log.debug 'WMI query returned no results for Win32_ComputerSystemProduct with values Name and UUID.'
+            return
+          end
+
+          build_fact_list(computersystem)
+
+          @fact_list[fact_name]
+        end
+
+        def build_fact_list(computersys)
+          @fact_list[:name] = computersys.Name
+          @fact_list[:uuid] = computersys.UUID
+        end
+      end
+    end
+  end
+end

data/lib/resolvers/windows/ffi/ffi.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require 'ffi'
+
+FFI.typedef :uint16, :word
+FFI.typedef :uint32, :dword
+FFI.typedef :uintptr_t, :handle
+FFI.typedef :buffer_inout, :lpwstr
+FFI.typedef :pointer, :lpcvoid
+FFI.typedef :pointer, :lpvoid
+FFI.typedef :pointer, :lpdword
+FFI.typedef :pointer, :pdword
+FFI.typedef :pointer, :phandle
+FFI.typedef :pointer, :pbool
+FFI.typedef :pointer, :ulong_ptr
+FFI.typedef :uint32, :win32_ulong
+FFI.typedef :int32, :win32_long
+FFI.typedef :int32, :win32_bool
+FFI.typedef :uint16, :wchar
+FFI.typedef :uintptr_t, :hwnd
+
+ERROR_MORE_DATA = 234
+MAX_PATH = 32_767
+
+module FFI
+  WIN32FALSE = 0
+  END_OF_WCHAR_STRING = "\0\0".encode('UTF-16LE')
+
+  class Pointer
+    def read_wide_string_with_length(char_length)
+      # char_length is number of wide chars (typically excluding NULLs), *not* bytes
+      str = get_bytes(0, char_length * 2).force_encoding('UTF-16LE')
+      str.encode('UTF-8', str.encoding, {})
+    end
+
+    def read_wide_string_without_length
+      wide_character = get_bytes(0, 2)
+      i = 2
+      str = []
+
+      while wide_character.encode('UTF-16LE') != END_OF_WCHAR_STRING
+        str << wide_character
+        wide_character = get_bytes(i, 2)
+        i += 2
+      end
+      str.join.force_encoding('UTF-16LE').encode('UTF-8')
+    end
+
+    def read_win32_bool
+      # BOOL is always a 32-bit integer in Win32
+      # some Win32 APIs return 1 for true, while others are non-0
+      read_int32 != WIN32FALSE
+    end
+  end
+
+  class Struct
+    def self.read_list(first_address)
+      instance = new(first_address)
+      while instance.to_ptr != Pointer::NULL
+        yield(instance)
+        instance = new(instance[:Next])
+      end
+    end
+  end
+end

data/lib/resolvers/windows/ffi/hardware_ffi.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "#{ROOT_DIR}/lib/resolvers/windows/ffi/ffi"
+require "#{ROOT_DIR}/lib/resolvers/windows/ffi/system_info"
+
+module HardwareFFI
+  extend FFI::Library
+
+  ffi_convention :stdcall
+  ffi_lib :kernel32
+  attach_function :GetNativeSystemInfo, [:pointer], :void
+
+  PROCESSOR_ARCHITECTURE_INTEL = 0
+  PROCESSOR_ARCHITECTURE_ARM = 5
+  PROCESSOR_ARCHITECTURE_IA64 = 6
+  PROCESSOR_ARCHITECTURE_AMD64 = 9
+end

data/lib/resolvers/windows/ffi/identity_ffi.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "#{ROOT_DIR}/lib/resolvers/windows/ffi/ffi"
+
+module IdentityFFI
+  extend FFI::Library
+
+  ffi_convention :stdcall
+  ffi_lib :secur32
+  attach_function :GetUserNameExW, %i[uint32 lpwstr pointer], :win32_bool
+
+  ffi_convention :stdcall
+  ffi_lib :shell32
+  attach_function :IsUserAnAdmin, [], :win32_bool
+end

data/lib/resolvers/windows/ffi/ip_adapter_addresses_lh.rb

@@ -0,0 +1,161 @@
+# frozen_string_literal: true
+
+MAX_ADAPTER_ADDRESS_LENGTH = 8
+MAX_DHCPV6_DUID_LENGTH = 130
+
+class SockAddr < FFI::Struct
+  layout(
+    :sa_family, :ushort,
+    :sa_data, [:uint8, 14]
+  )
+end
+
+class SocketAddress < FFI::Struct
+  layout(
+    :lpSockaddr, :pointer,
+    :iSockaddrLength, :int32
+  )
+end
+
+module Enums
+  extend FFI::Library
+
+  IP_PREFIX_ORIGIN = enum(
+    :IpPrefixOriginOther, 0,
+    :IpPrefixOriginManual,
+    :IpPrefixOriginWellKnown,
+    :IpPrefixOriginDhcp,
+    :IpPrefixOriginRouterAdvertisement,
+    :IpPrefixOriginUnchanged
+  )
+
+  IP_SUFFIX_ORIGIN = enum(
+    :NlsoOther, 0,
+    :NlsoManual,
+    :NlsoWellKnown,
+    :NlsoDhcp,
+    :NlsoLinkLayerAddress,
+    :NlsoRandom,
+    :IpSuffixOriginOther,
+    :IpSuffixOriginManual,
+    :IpSuffixOriginWellKnown,
+    :IpSuffixOriginDhcp,
+    :IpSuffixOriginLinkLayerAddress,
+    :IpSuffixOriginRandom,
+    :IpSuffixOriginUnchanged
+  )
+
+  IP_DAD_STATE = enum(
+    :NldsInvalid, 0,
+    :NldsTentative,
+    :NldsDuplicate,
+    :NldsDeprecated,
+    :NldsPreferred,
+    :IpDadStateInvalid,
+    :IpDadStateTentative,
+    :IpDadStateDuplicate,
+    :IpDadStateDeprecated,
+    :IpDadStatePreferred
+  )
+
+  IF_CONNECTION_TYPE = enum(
+    :NET_IF_CONNECTION_DEDICATED, 1,
+    :NET_IF_CONNECTION_PASSIVE,
+    :NET_IF_CONNECTION_DEMAND,
+    :NET_IF_CONNECTION_MAXIMUM
+  )
+
+  TUNNEL_TYPE = enum(
+    :TUNNEL_TYPE_NONE, 0,
+    :TUNNEL_TYPE_OTHER,
+    :TUNNEL_TYPE_DIRECT,
+    :TUNNEL_TYPE_6TO4,
+    :TUNNEL_TYPE_ISATAP,
+    :TUNNEL_TYPE_TEREDO,
+    :TUNNEL_TYPE_IPHTTPS
+  )
+end
+
+class IpAdapterUnicastAddressXPUnionStruct < FFI::Struct
+  layout(
+    :Length, :win32_ulong,
+    :Flags, :dword
+  )
+end
+
+class IpAdapterUnicastAddressXPUnion < FFI::Union
+  layout(
+    :Aligment, :ulong_long,
+    :Struct, IpAdapterUnicastAddressXPUnionStruct
+  )
+end
+
+class IpAdapterUnicastAddressLH < FFI::Struct
+  layout(
+    :Union, IpAdapterUnicastAddressXPUnion,
+    :Next, :pointer,
+    :Address, SocketAddress,
+    :PrefixOrigin, Enums::IP_PREFIX_ORIGIN,
+    :SuffixOrigin, Enums::IP_SUFFIX_ORIGIN,
+    :DadState, Enums::IP_DAD_STATE,
+    :ValidLifetime, :win32_ulong,
+    :PreferredLifetime, :win32_ulong,
+    :LeaseLifetime, :win32_ulong,
+    :OnLinkPrefixLength, :uint8
+  )
+end
+
+class AdapterAddressStruct < FFI::Struct
+  layout(
+    :Length, :win32_ulong,
+    :IfIndex, :dword
+  )
+end
+
+class AdapterAddressAligmentUnion < FFI::Union
+  layout(
+    :Aligment, :uint64,
+    :Struct, AdapterAddressStruct
+  )
+end
+
+class IpAdapterAddressesLh < FFI::Struct
+  layout(
+    :Union, AdapterAddressAligmentUnion,
+    :Next, :pointer,
+    :AdapterName, :pointer,
+    :FirstUnicastAddress, :pointer,
+    :FirstAnycastAddress, :pointer,
+    :FirstMulticastAddress, :pointer,
+    :FirstDnsServerAddress, :pointer,
+    :DnsSuffix, :pointer,
+    :Description, :pointer,
+    :FriendlyName, :pointer,
+    :PhysicalAddress, [:uchar, MAX_ADAPTER_ADDRESS_LENGTH],
+    :PhysicalAddressLength, :win32_ulong,
+    :Flags, :win32_ulong,
+    :Mtu, :win32_ulong,
+    :IfType, :dword,
+    :OperStatus, :uint8,
+    :Ipv6IfIndex, :dword,
+    :ZoneIndices, [:win32_ulong, 16],
+    :FirstPrefix, :pointer,
+    :TransmitLinkSpeed, :ulong_long,
+    :ReceiveLinkSpeed, :ulong_long,
+    :FirstWinsServerAddress, :pointer,
+    :FirstGatewayAddress, :pointer,
+    :Ipv4Metric, :win32_ulong,
+    :Ipv6Metric, :win32_ulong,
+    :Luid, :ulong_long,
+    :Dhcpv4Server, SocketAddress,
+    :CompartmentId, :uint32, # https://github.com/tpn/winsdk-10/blob/master/Include/10.0.14393.0/shared/ifdef.h
+    :NetworkGuid, [:uint8, 16], # https://docs.microsoft.com/en-us/windows/win32/api/guiddef/ns-guiddef-guid
+    :ConnectionType, Enums::IF_CONNECTION_TYPE,
+    :TunnelType, Enums::TUNNEL_TYPE,
+    :Dhcpv6Server, SocketAddress,
+    :Dhcpv6ClientDuid, [:uchar, MAX_DHCPV6_DUID_LENGTH],
+    :Dhcpv6ClientDuidLength, :win32_ulong,
+    :Dhcpv6Iaid, :win32_ulong,
+    :FirstDnsSuffix, :pointer
+  )
+end

data/lib/resolvers/windows/ffi/kernel_ffi.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "#{ROOT_DIR}/lib/resolvers/windows/ffi/ffi"
+require "#{ROOT_DIR}/lib/resolvers/windows/ffi/os_version_info_ex"
+
+module KernelFFI
+  extend FFI::Library
+
+  ffi_convention :stdcall
+  ffi_lib [FFI::CURRENT_PROCESS, :ntdll]
+  attach_function :RtlGetVersion, [:pointer], :int32
+
+  STATUS_SUCCESS = 0
+end

data/lib/resolvers/windows/ffi/memory_ffi.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "#{ROOT_DIR}/lib/resolvers/windows/ffi/ffi"
+require "#{ROOT_DIR}/lib/resolvers/windows/ffi/performance_information"
+
+module MemoryFFI
+  extend FFI::Library
+
+  ffi_convention :stdcall
+  ffi_lib :psapi
+  attach_function :GetPerformanceInfo, %i[pointer dword], :win32_bool
+end

data/lib/resolvers/windows/ffi/network_utils.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+class NetworkUtils
+  @log = Facter::Log.new(self)
+  class << self
+    def address_to_string(addr)
+      return if addr[:lpSockaddr] == FFI::Pointer::NULL
+
+      size = FFI::MemoryPointer.new(NetworkingFFI::INET6_ADDRSTRLEN + 1)
+      buffer = FFI::MemoryPointer.new(:wchar, NetworkingFFI::INET6_ADDRSTRLEN + 1)
+      error = nil
+      3.times do
+        error = NetworkingFFI::WSAAddressToStringW(addr[:lpSockaddr], addr[:iSockaddrLength],
+                                                   FFI::Pointer::NULL, buffer, size)
+        break if error.zero?
+      end
+      unless error.zero?
+        @log.debug 'address to string translation failed!'
+        return
+      end
+      extract_address(buffer)
+    end
+
+    def extract_address(addr)
+      addr.read_wide_string_without_length.split('%').first
+    end
+
+    def ignored_ip_address(addr)
+      addr.empty? || addr.start_with?('127.', '169.254.') || addr.start_with?('fe80') || addr.eql?('::1')
+    end
+
+    def find_mac_address(adapter)
+      adapter[:PhysicalAddress].first(adapter[:PhysicalAddressLength])
+                               .map { |e| format('%<mac_address>02x', mac_address: e.to_i) }
+                               .join(':').upcase
+    end
+
+    def build_binding(addr, mask_length)
+      ip = IPAddr.new(addr)
+      mask = if ip.ipv6?
+               IPAddr.new('ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff').mask(mask_length)
+             else
+               IPAddr.new('255.255.255.255').mask(mask_length)
+             end
+      { address: addr, netmask: mask.to_s, network: ip.mask(mask_length).to_s }
+    end
+
+    def get_scope(sockaddr)
+      require 'socket'
+      scope6 = []
+      addrinfo = Addrinfo.new(['AF_INET6', 0, nil, sockaddr], :INET6)
+
+      scope6 << 'compat,' if addrinfo.ipv6_v4compat?
+      scope6 << if addrinfo.ipv6_linklocal?
+                  'link'
+                elsif addrinfo.ipv6_sitelocal?
+                  'site'
+                elsif addrinfo.ipv6_loopback?
+                  'host'
+                else 'global'
+                end
+      scope6.join
+    end
+  end
+end

data/lib/resolvers/windows/ffi/networking_ffi.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "#{ROOT_DIR}/lib/resolvers/windows/ffi/ffi"
+require "#{ROOT_DIR}/lib/resolvers/windows/ffi/network_utils"
+require "#{ROOT_DIR}/lib/resolvers/windows/ffi/ip_adapter_addresses_lh"
+
+module NetworkingFFI
+  extend FFI::Library
+
+  ffi_convention :stdcall
+  ffi_lib :iphlpapi
+  attach_function :GetAdaptersAddresses, %i[uint32 uint32 pointer pointer pointer], :dword
+
+  ffi_convention :stdcall
+  ffi_lib :ws2_32
+  attach_function :WSAAddressToStringW, %i[pointer dword pointer pointer pointer], :int32
+
+  AF_UNSPEC = 0
+  GAA_FLAG_SKIP_ANYCAST = 2
+  GAA_FLAG_SKIP_MULTICAST = 4
+  GAA_FLAG_SKIP_DNS_SERVER = 8
+  BUFFER_LENGTH = 15_000
+  ERROR_SUCCES = 0
+  ERROR_BUFFER_OVERFLOW = 111
+  ERROR_NO_DATA = 232
+  IF_OPER_STATUS_UP = 1
+  IF_OPER_STATUS_DOWN = 2
+  IF_TYPE_ETHERNET_CSMACD = 6
+  IF_TYPE_IEEE80211 = 71
+  IP_ADAPTER_DHCP_ENABLED = 4
+  INET6_ADDRSTRLEN = 46
+  AF_INET = 2
+  AF_INET6 = 23
+end

data/lib/resolvers/windows/ffi/os_version_info_ex.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+class OsVersionInfoEx < FFI::Struct
+  layout(
+    :dwOSVersionInfoSize, :win32_ulong,
+    :dwMajorVersion, :win32_ulong,
+    :dwMinorVersion, :win32_ulong,
+    :dwBuildNumber, :win32_ulong,
+    :dwPlatformId, :win32_ulong,
+    :szCSDVersion, [:wchar, 128],
+    :wServicePackMajor, :ushort,
+    :wServicePackMinor, :ushort,
+    :wSuiteMask, :ushort,
+    :wProductType, :uchar,
+    :wReserved, :uchar
+  )
+end