metasploit-gs/lib/msf/core/windows_version.rb

# -*- coding: binary -*-

module Msf
  #
  # Represents the version of a Windows operating system
  #
  class WindowsVersion

    VER_NT_WORKSTATION = 1
    VER_NT_DOMAIN_CONTROLLER = 2
    VER_NT_SERVER = 3

    Win2000 = Rex::Version.new('5.0.2195')
    XP_SP0 = Rex::Version.new('5.1.2600.0')
    XP_SP1 = Rex::Version.new('5.1.2600.1')
    XP_SP2 = Rex::Version.new('5.1.2600.2')
    XP_SP3 = Rex::Version.new('5.1.2600.3')
    Server2003_SP0 = Rex::Version.new('5.2.3790.0')
    Server2003_SP1 = Rex::Version.new('5.2.3790.1')
    Server2003_SP2 = Rex::Version.new('5.2.3790.2')
    Vista_SP0 = Server2008_SP0 = Rex::Version.new('6.0.6000.0')
    Vista_SP1 = Server2008_SP1 = Rex::Version.new('6.0.6001.1')
    Vista_SP2 = Server2008_SP2 = Rex::Version.new('6.0.6002.2')
    Server2008_SP2_Update = Rex::Version.new('6.0.6003.2') # https://support.microsoft.com/en-us/topic/build-number-changing-to-6003-in-windows-server-2008-1335e4d4-c155-52eb-4a45-b85bd1909ca8
    Win7_SP0 = Server2008_R2_SP0 = Rex::Version.new('6.1.7600.0')
    Win7_SP1 = Server2008_R2_SP1 = Rex::Version.new('6.1.7601.1')
    Win8 = Server2012 = Rex::Version.new('6.2.9200.0')
    Win81 = Server2012_R2 = Rex::Version.new('6.3.9600.0')
    Win10_1507 = Win10_InitialRelease = Rex::Version.new('10.0.10240.0')
    Win10_1511 = Rex::Version.new('10.0.10586.0')
    Win10_1607 = Server2016 = Rex::Version.new('10.0.14393.0')
    Win10_1703 = Rex::Version.new('10.0.15063.0')
    Win10_1709 = Rex::Version.new('10.0.16299.0')
    Win10_1803 = Rex::Version.new('10.0.17134.0')
    Win10_1809 = Server2019 = Rex::Version.new('10.0.17763.0')
    Win10_1903 = Rex::Version.new('10.0.18362.0')
    Win10_1909 = Rex::Version.new('10.0.18363.0')
    Win10_2004 = Rex::Version.new('10.0.19041.0')
    Win10_20H2 = Rex::Version.new('10.0.19042.0')
    Win10_21H1 = Rex::Version.new('10.0.19043.0')
    Win10_21H2 = Rex::Version.new('10.0.19044.0')
    Win10_22H2 = Rex::Version.new('10.0.19045.0')
    Server2022 = Rex::Version.new('10.0.20348.0')
    Win11_21H2 = Rex::Version.new('10.0.22000.0')
    Win11_22H2 = Rex::Version.new('10.0.22621.0')

    module MajorRelease
      NT351 = 'Windows NT 3.51'.freeze
      Win95 = 'Windows 95'.freeze
      Win98 = 'Windows 98'.freeze
      WinME = 'Windows ME'.freeze
      Win2000 = 'Windows 2000'.freeze

      XP = 'Windows XP'.freeze
      Server2003 = 'Windows Server 2003'.freeze

      Vista = 'Windows Vista'.freeze
      Server2008 = 'Windows Server 2008'.freeze

      Win7 = 'Windows 7'.freeze
      Server2008R2 = 'Windows 2008 R2'.freeze

      Win8 = 'Windows 8'.freeze
      Server2012 = 'Windows Server 2012'.freeze

      Win81 = 'Windows 8.1'.freeze
      Server2012R2 = 'Windows Server 2012 R2'.freeze

      Win10Plus = 'Windows 10+'.freeze
      Server2016Plus = 'Windows Server 2016+'.freeze
    end

    def initialize(major, minor, build, service_pack, revision, product_type)
      self._major = major
      self._minor = minor
      self._build = build
      self._service_pack = service_pack
      self._revision = revision
      self.product_type = product_type
    end

    # The specific revision number of this version
    # This is mainly going to be present on Windows 10+, wherein it's easy to get it from the registry.
    def revision_number
      _revision
    end

    # The specific build number of this version (major.minor.build.service_pack)
    def build_number
      Rex::Version.new("#{_major}.#{_minor}.#{_build}.#{_service_pack}")
    end

    # Is this OS a Windows Server instance?
    def windows_server?
      # There are other types than just workstation/server/DC, but Microsoft's own documentation says
      # "If it's not Workstation, then it's Server"
      # https://learn.microsoft.com/en-us/windows/win32/api/winnt/ns-winnt-osversioninfoexa
      product_type != VER_NT_WORKSTATION
    end

    # Is this a Workstation build?
    def workstation?
      product_type == VER_NT_WORKSTATION
    end

    # This Windows Server has been promoted to a DC
    def domain_controller?
      product_type == VER_NT_DOMAIN_CONTROLLER
    end

    # The name of the OS, as it is most commonly rendered. Includes Service Pack if present, or build number if Win10 or higher.
    def product_name
      result = "Unknown Windows version: #{_major}.#{_minor}.#{_build}"
      name = major_release_name
      result = name unless name.nil?
      result = "#{result} Service Pack #{_service_pack}" if _service_pack != 0
      result = "#{result} Build #{_build}" if build_number >= Win10_InitialRelease

      result
    end

    def to_s
      product_name
    end

    # Is this version number from the Vista/Server 2008 generation of Windows OSes
    def vista_or_2008?
      build_number.between?(Vista_SP0, Vista_SP2)
    end

    # Is this version number from the Windows 7/Server 2008 R2 generation of Windows OSes
    def win7_or_2008r2?
      build_number.between?(Win7_SP0, Win7_SP1)
    end

    # Is this version number from the XP/Server 2003 generation of Windows OSes
    def xp_or_2003?
      build_number.between?(XP_SP0, Server2003_SP2)
    end

    private

    attr_accessor :_major, :_minor, :_build, :_service_pack, :_revision, :product_type

    # The major release within which this build fits
    def major_release_name
      if _major == 5
        if _minor == 0
          return MajorRelease::Win2000
        elsif _minor == 1
          return MajorRelease::XP
        elsif _minor == 2
          return MajorRelease::Server2003 if windows_server?

          return MajorRelease::XP
        end
      elsif _major == 6
        if _minor == 0
          return MajorRelease::Server2008 if windows_server?

          return MajorRelease::Vista
        elsif _minor == 1
          return MajorRelease::Server2008R2 if windows_server?

          return MajorRelease::Win7
        elsif _minor == 2
          return MajorRelease::Server2012 if windows_server?

          return MajorRelease::Win8
        elsif _minor == 3
          return MajorRelease::Server2012R2 if windows_server?

          return MajorRelease::Win81
        end
      elsif _major == 10
        if _minor == 0
          return MajorRelease::Server2016Plus if windows_server?

          return MajorRelease::Win10Plus
        end
      end
      return nil
    end
  end
end