ronin-support 0.5.1 → 1.0.0.beta1

data/lib/ronin/support/binary/ctypes/os/netbsd.rb

@@ -0,0 +1,147 @@
+# frozen_string_literal: true
+#
+# Copyright (c) 2006-2022 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# ronin-support is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# ronin-support is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with ronin-support.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+require 'ronin/support/binary/ctypes/os/bsd'
+
+module Ronin
+  module Support
+    module Binary
+      module CTypes
+        class OS
+          #
+          # Contains additional types available on NetBSD.
+          #
+          # @api semipublic
+          #
+          # @since 1.0.0
+          #
+          class NetBSD < BSD
+
+            #
+            # Initializes the NetBSD types object.
+            #
+            # @param [#[]] types
+            #   The base types module.
+            #
+            def initialize(types)
+              super(types)
+
+              typedef :int, :__clockid_t
+              typedef :int, :clockid_t
+              typedef :int, :__clock_t
+              typedef :int, :clock_t
+              typedef :ulong, :__cpuid_t
+              typedef :ulong, :cpuid_t
+              typedef :int, :daddr32_t
+              typedef :long_long, :daddr64_t
+              typedef :int, :daddr_t
+              typedef :int, :__dev_t
+              typedef :int, :dev_t
+              typedef :int, :__fd_mask
+              typedef :uint, :__fixpt_t
+              typedef :uint, :__gid_t
+              typedef :uint, :__id_t
+              typedef :uint, :id_t
+              typedef :uint, :__in_addr_t
+              typedef :uint, :__ino_t
+              typedef :uint, :ino_t
+              typedef :ushort, :__in_port_t
+              typedef :int, :__int_fast16_t
+              typedef :int, :__int_fast32_t
+              typedef :long_long, :__int_fast64_t
+              typedef :int, :__int_fast8_t
+              typedef :short, :__int_least16_t
+              typedef :int, :__int_least32_t
+              typedef :long_long, :__int_least64_t
+              typedef :char, :__int_least8_t
+              typedef :long_long, :__intmax_t
+              typedef :long, :__intptr_t
+              typedef :long, :__key_t
+              typedef :long, :key_t
+              typedef :uint, :__mode_t
+              typedef :uint, :mode_t
+              typedef :uint, :__nlink_t
+              typedef :uint, :nlink_t
+              typedef :long_long, :__off_t
+              typedef :ulong, :__paddr_t
+              typedef :ulong, :paddr_t
+              typedef :int, :__pid_t
+              typedef :ulong, :__psize_t
+              typedef :ulong, :psize_t
+              typedef :long, :__ptrdiff_t
+              typedef :int, :__register_t
+              typedef :int, :register_t
+              typedef :ulong_long, :__rlim_t
+              typedef :ulong_long, :rlim_t
+              typedef :int, :__rune_t
+              typedef :uchar, :__sa_family_t
+              typedef :int, :__segsz_t
+              typedef :ulong, :__size_t
+              typedef :ulong, :size_t
+              typedef :uint, :__socklen_t
+              typedef :long, :__ssize_t
+              typedef :long, :ssize_t
+              typedef :int, :__suseconds_t
+              typedef :int, :suseconds_t
+              typedef :int, :__swblk_t
+              typedef :int, :swblk_t
+              typedef :int, :__timer_t
+              typedef :int, :timer_t
+              typedef :int, :__time_t
+              typedef :int, :time_t
+              typedef :uint, :__uid_t
+              typedef :ushort, :uint16_t
+              typedef :uint, :uint32_t
+              typedef :ulong_long, :uint64_t
+              typedef :uchar, :uint8_t
+              typedef :uint, :__uint_fast16_t
+              typedef :uint, :__uint_fast32_t
+              typedef :ulong_long, :__uint_fast64_t
+              typedef :uint, :__uint_fast8_t
+              typedef :ushort, :__uint_least16_t
+              typedef :uint, :__uint_least32_t
+              typedef :ulong_long, :__uint_least64_t
+              typedef :uchar, :__uint_least8_t
+              typedef :ulong_long, :__uintmax_t
+              typedef :ulong, :__uintptr_t
+              typedef :uint, :uint
+              typedef :ulong, :ulong
+              typedef :uchar, :unchar
+              typedef :uint, :__useconds_t
+              typedef :ushort, :ushort
+              typedef :ulong, :__vaddr_t
+              typedef :ulong, :vaddr_t
+              typedef :ulong, :__vsize_t
+              typedef :ulong, :vsize_t
+              typedef :int, :__wchar_t
+              typedef :pointer, :__wctrans_t
+              typedef :pointer, :__wctype_t
+              typedef :int, :__wint_t
+
+              if types::ADDRESS_SIZE == 8
+                typedef :long, :intptr_t
+                typedef :ulong, :uintptr_t
+              end
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ronin/support/binary/ctypes/os/openbsd.rb

@@ -0,0 +1,168 @@
+# frozen_string_literal: true
+#
+# Copyright (c) 2006-2022 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# ronin-support is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# ronin-support is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with ronin-support.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+require 'ronin/support/binary/ctypes/os/bsd'
+
+module Ronin
+  module Support
+    module Binary
+      module CTypes
+        class OS
+          #
+          # Contains additional types available on OpenBSD.
+          #
+          # @api semipublic
+          #
+          # @since 1.0.0
+          #
+          class OpenBSD < BSD
+
+            #
+            # Initializes the OpenBSD types object.
+            #
+            # @param [#[]] types
+            #   The base types module.
+            #
+            def initialize(types)
+              super(types)
+
+              typedef :int, :__clockid_t
+              typedef :int, :clockid_t
+              typedef :ulong, :__cpuid_t
+              typedef :ulong, :cpuid_t
+              typedef :int, :daddr32_t
+              typedef :int, :__dev_t
+              typedef :int, :dev_t
+              typedef :uint, :__fixpt_t
+              typedef :uint, :__gid_t
+              typedef :uint, :__id_t
+              typedef :uint, :id_t
+              typedef :uint, :__in_addr_t
+              typedef :ushort, :__in_port_t
+              typedef :ushort, :in_port_t
+              typedef :int, :__int_fast16_t
+              typedef :int, :__int_fast32_t
+              typedef :long_long, :__int_fast64_t
+              typedef :int, :__int_fast8_t
+              typedef :short, :__int_least16_t
+              typedef :int, :__int_least32_t
+              typedef :long_long, :__int_least64_t
+              typedef :char, :__int_least8_t
+              typedef :long_long, :__intmax_t
+              typedef :long, :__intptr_t
+              typedef :long, :__key_t
+              typedef :long, :key_t
+              typedef :uint, :__mode_t
+              typedef :uint, :mode_t
+              typedef :uint, :__nlink_t
+              typedef :uint, :nlink_t
+              typedef :long_long, :__off_t
+              typedef :ulong, :__paddr_t
+              typedef :ulong, :paddr_t
+              typedef :int, :__pid_t
+              typedef :ulong, :__psize_t
+              typedef :ulong, :psize_t
+              typedef :long, :__ptrdiff_t
+              typedef :ulong_long, :__rlim_t
+              typedef :ulong_long, :rlim_t
+              typedef :int, :__rune_t
+              typedef :uchar, :__sa_family_t
+              typedef :int, :__segsz_t
+              typedef :ulong, :__size_t
+              typedef :ulong, :size_t
+              typedef :uint, :__socklen_t
+              typedef :long, :__ssize_t
+              typedef :long, :ssize_t
+              typedef :int, :__swblk_t
+              typedef :int, :swblk_t
+              typedef :int, :__timer_t
+              typedef :int, :timer_t
+              typedef :uint, :__uid_t
+              typedef :ushort, :uint16_t
+              typedef :uint, :uint32_t
+              typedef :ulong_long, :uint64_t
+              typedef :uchar, :uint8_t
+              typedef :uint, :__uint_fast16_t
+              typedef :uint, :__uint_fast32_t
+              typedef :ulong_long, :__uint_fast64_t
+              typedef :uint, :__uint_fast8_t
+              typedef :ushort, :__uint_least16_t
+              typedef :uint, :__uint_least32_t
+              typedef :ulong_long, :__uint_least64_t
+              typedef :uchar, :__uint_least8_t
+              typedef :ulong_long, :__uintmax_t
+              typedef :ulong, :__uintptr_t
+              typedef :ulong, :ulong
+              typedef :uchar, :unchar
+              typedef :uint, :__useconds_t
+              typedef :ulong, :__vaddr_t
+              typedef :ulong, :vaddr_t
+              typedef :ulong, :__vsize_t
+              typedef :ulong, :vsize_t
+              typedef :int, :__wchar_t
+              typedef :pointer, :__wctrans_t
+              typedef :pointer, :__wctype_t
+              typedef :int, :__wint_t
+
+              if types::ADDRESS_SIZE == 8
+                typedef :long_long, :__blkcnt_t
+                typedef :long_long, :blkcnt_t
+                typedef :int, :__blksize_t
+                typedef :int, :blksize_t
+                typedef :long_long, :__clock_t
+                typedef :long_long, :clock_t
+                typedef :long_long, :daddr_t
+                typedef :uint, :__fd_mask
+                typedef :ulong_long, :__fsblkcnt_t
+                typedef :ulong_long, :fsblkcnt_t
+                typedef :ulong_long, :__fsfilcnt_t
+                typedef :ulong_long, :fsfilcnt_t
+                typedef :ulong_long, :__ino_t
+                typedef :ulong_long, :ino_t
+                typedef :long, :__register_t
+                typedef :long, :register_t
+                typedef :uint, :sigset_t
+                typedef :long, :__suseconds_t
+                typedef :long, :suseconds_t
+                typedef :long_long, :__time_t
+                typedef :long_long, :time_t
+              else
+                typedef :int, :__clock_t
+                typedef :int, :clock_t
+                typedef :long_long, :daddr64_t
+                typedef :int, :daddr_t
+                typedef :int, :__fd_mask
+                typedef :uint, :__ino_t
+                typedef :uint, :ino_t
+                typedef :long, :intptr_t
+                typedef :int, :__register_t
+                typedef :int, :register_t
+                typedef :int, :__suseconds_t
+                typedef :int, :suseconds_t
+                typedef :int, :__time_t
+                typedef :int, :time_t
+                typedef :ulong, :uintptr_t
+              end
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ronin/support/binary/ctypes/os/unix.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+#
+# Copyright (c) 2006-2022 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# ronin-support is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# ronin-support is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with ronin-support.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+require 'ronin/support/binary/ctypes/os'
+
+module Ronin
+  module Support
+    module Binary
+      module CTypes
+        class OS
+          #
+          # Common types shared by all UNIX `libc` implementations.
+          #
+          # @api private
+          #
+          # @since 1.0.0
+          #
+          class UNIX < OS
+            #
+            # Initializes the common UNIX `libc` typedefs.
+            #
+            # @param [#[]] types
+            #   The base types module.
+            #
+            def initialize(types)
+              super(types)
+
+              typedef :char,  :__int8_t
+              typedef :short, :__int16_t
+              typedef :int,   :__int32_t
+
+              typedef :uchar,  :__uint8_t
+              typedef :ushort, :__uint16_t
+              typedef :uint,   :__uint32_t
+
+              typedef :char,  :int8_t
+              typedef :short, :int16_t
+              typedef :int,   :int32_t
+
+              typedef :uchar,      :u_int8_t
+              typedef :ushort,     :u_int16_t
+              typedef :uint,       :u_int32_t
+              typedef :ulong_long, :u_int64_t
+
+              typedef :uchar,  :u_char
+              typedef :uint,   :u_int
+              typedef :ulong,  :u_long
+              typedef :ushort, :u_short
+
+              typedef :uint, :uid_t
+              typedef :uint, :gid_t
+              typedef :int,  :pid_t
+
+              typedef :uint,   :in_addr_t
+              typedef :ushort, :in_port_t
+              typedef :uint,   :socklen_t
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ronin/support/binary/ctypes/os/windows.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+#
+# Copyright (c) 2006-2022 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# ronin-support is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# ronin-support is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with ronin-support.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+require 'ronin/support/binary/ctypes/os'
+
+module Ronin
+  module Support
+    module Binary
+      module CTypes
+        class OS
+          #
+          # Contains additional types available on Windows.
+          #
+          # @api semipublic
+          #
+          # @since 1.0.0
+          #
+          class Windows < OS
+
+            #
+            # Initializes the Windows types object.
+            #
+            # @param [#[]] types
+            #   The base types module.
+            #
+            def initialize(types)
+              super(types)
+
+              if types::ADDRESS_SIZE == 8
+                # NOTE: `long` and `unsigne long` are actually 4 bytes on
+                # 64bit Windows systems.
+                #
+                # https://www.intel.com/content/www/us/en/developer/articles/technical/size-of-long-integer-type-on-different-architecture-and-os.html
+                typedef types::INT32, :long
+                typedef types::UINT32, :ulong
+              end
+
+              typedef :uint, :_dev_t
+              typedef :uint, :dev_t
+              typedef :int, :errno_t
+              typedef :ushort, :_ino_t
+              typedef :ushort, :ino_t
+              typedef :short, :int16_t
+              typedef :int, :int32_t
+              typedef :long_long, :int64_t
+              typedef :char, :int8_t
+              typedef :short, :int_fast16_t
+              typedef :int, :int_fast32_t
+              typedef :long_long, :int_fast64_t
+              typedef :char, :int_fast8_t
+              typedef :short, :int_least16_t
+              typedef :int, :int_least32_t
+              typedef :long_long, :int_least64_t
+              typedef :char, :int_least8_t
+              typedef :long_long, :intmax_t
+              typedef :ushort, :_mode_t
+              typedef :ushort, :mode_t
+              typedef :long, :off32_t
+              typedef :long_long, :_off64_t
+              typedef :long_long, :off64_t
+              typedef :long, :_off_t
+              typedef :long_long, :off_t
+              typedef :long, :__time32_t
+              typedef :long_long, :__time64_t
+              typedef :ushort, :uint16_t
+              typedef :ulong_long, :uint64_t
+              typedef :uchar, :uint8_t
+              typedef :ushort, :uint_fast16_t
+              typedef :uint, :uint_fast32_t
+              typedef :ulong_long, :uint_fast64_t
+              typedef :uchar, :uint_fast8_t
+              typedef :ushort, :uint_least16_t
+              typedef :ulong_long, :uint_least64_t
+              typedef :uchar, :uint_least8_t
+              typedef :ulong_long, :uintmax_t
+              typedef :uint, :useconds_t
+              typedef :ushort, :wchar_t
+              typedef :ushort, :wctype_t
+              typedef :ushort, :wint_t
+
+              if types::ADDRESS_SIZE == 8
+                typedef :long_long, :intptr_t
+                typedef :long_long, :_pid_t
+                typedef :long_long, :pid_t
+                typedef :long_long, :ptrdiff_t
+                typedef :ulong_long, :rsize_t
+                typedef :ulong_long, :_sigset_t
+                typedef :ulong_long, :size_t
+                typedef :long_long, :ssize_t
+                typedef :long_long, :time_t
+                typedef :ulong_long, :uintptr_t
+              else
+                typedef :int, :intptr_t
+                typedef :int, :_pid_t
+                typedef :int, :pid_t
+                typedef :int, :ptrdiff_t
+                typedef :uint, :rsize_t
+                typedef :ulong, :_sigset_t
+                typedef :uint, :size_t
+                typedef :int, :ssize_t
+                typedef :long, :time_t
+                typedef :uint, :uintptr_t
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ronin/support/binary/ctypes/os.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+#
+# Copyright (c) 2006-2022 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# ronin-support is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# ronin-support is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with ronin-support.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+module Ronin
+  module Support
+    module Binary
+      module CTypes
+        #
+        # Represents additional typedefs defined by an Operating System (OS).
+        #
+        # @api private
+        #
+        # @since 1.0.0
+        #
+        class OS
+
+          # The base types that the OS inherits.
+          #
+          # @return [Native, LittleEndian, BigEndian, Network,
+          #          Arch::ARM, Arch::ARM::BigEndian,
+          #          Arch::ARM64, Arch::ARM64::BigEndian,
+          #          Arch::MIPS, Arch::MIPS::LittleEndian,
+          #          Arch::MIPS64, Arch::MIPS64::LittleEndian,
+          #          Arch::PPC64, Arch::PPC, Arch::X86_64, Arch::X86,
+          #          OS::FreeBSD,
+          #          OS::NetBSD,
+          #          OS::OpenBSD,
+          #          OS::Linux,
+          #          OS::MacOS,
+          #          OS::Windows]
+          attr_reader :types
+
+          # The defined typedefs for the OS.
+          #
+          # @return [Hash{Symbol => Type}]
+          attr_reader :typedefs
+
+          #
+          # Initializes the OS with the given base types.
+          #
+          # @param [Native, LittleEndian, BigEndian, Network,
+          #          Arch::ARM, Arch::ARM::BigEndian,
+          #          Arch::ARM64, Arch::ARM64::BigEndian,
+          #          Arch::MIPS, Arch::MIPS::LittleEndian,
+          #          Arch::MIPS64, Arch::MIPS64::LittleEndian,
+          #          Arch::PPC64, Arch::PPC, Arch::X86_64, Arch::X86,
+          #          OS::FreeBSD,
+          #          OS::NetBSD,
+          #          OS::OpenBSD,
+          #          OS::Linux,
+          #          OS::MacOS,
+          #          OS::Windows] types
+          #   The base types that the OS builds upon.
+          #
+          def initialize(types)
+            @types    = types
+            @typedefs = {}
+          end
+
+          #
+          # Retrieves the type with the given name.
+          #
+          # @param [Symbol] name
+          #
+          # @return [Type]
+          #
+          # @api public
+          #
+          def [](name)
+            @typedefs.fetch(name) { @types[name] }
+          end
+
+          #
+          # Defines a typedef within the type system.
+          #
+          # @param [Symbol, Type] type
+          #   The original type to point to.
+          #
+          # @param [Symbol] new_name
+          #   The new type name.
+          #
+          # @raise [ArgumentError]
+          #   The given type was not a Symbol or a {Type}.
+          #
+          # @example
+          #   os.typedef :uint, :foo_t
+          #
+          def typedef(type,new_name)
+            case type
+            when Type   then @typedefs[new_name] = type
+            when Symbol then @typedefs[new_name] = self[type]
+            else
+              raise(ArgumentError,"type must be either a Symbol or a #{Type}: #{type.inspect}")
+            end
+          end
+
+        end
+      end
+    end
+  end
+end
+
+require 'ronin/support/binary/ctypes/os/unix'
+require 'ronin/support/binary/ctypes/os/linux'
+require 'ronin/support/binary/ctypes/os/bsd'
+require 'ronin/support/binary/ctypes/os/freebsd'
+require 'ronin/support/binary/ctypes/os/openbsd'
+require 'ronin/support/binary/ctypes/os/netbsd'
+require 'ronin/support/binary/ctypes/os/macos'
+require 'ronin/support/binary/ctypes/os/windows'