ethon-impersonate 0.17.1

data/lib/ethon_impersonate/impersonate/tls.rb

@@ -0,0 +1,189 @@
+# frozen_string_literal: true
+module EthonImpersonate
+  module Impersonate
+    module Tls
+      # TLS version are in the format of 0xAABB, where AA is major version and BB is minor
+      # version. As of today, the major version is always 03.
+      VERSION_MAP = {
+        0x0301 => :tlsv1_0,  # TLS 1.0
+        0x0302 => :tlsv1_1,  # TLS 1.1
+        0x0303 => :tlsv1_2,  # TLS 1.2
+        0x0304 => :tlsv1_3,  # TLS 1.3
+      }.freeze
+
+      MAX_DEFAULT_VERSION = :tlsv1_3
+
+      # A list of the possible cipher suite ids. Taken from
+      # http://www.iana.org/assignments/tls-parameters/tls-parameters.xml
+      # via BoringSSL
+      CIPHER_NAME_MAP = {
+        0x000A => "TLS_RSA_WITH_3DES_EDE_CBC_SHA",
+        0x002F => "TLS_RSA_WITH_AES_128_CBC_SHA",
+        0x0035 => "TLS_RSA_WITH_AES_256_CBC_SHA",
+        0x003C => "TLS_RSA_WITH_AES_128_CBC_SHA256",
+        0x003D => "TLS_RSA_WITH_AES_256_CBC_SHA256",
+        0x008C => "TLS_PSK_WITH_AES_128_CBC_SHA",
+        0x008D => "TLS_PSK_WITH_AES_256_CBC_SHA",
+        0x009C => "TLS_RSA_WITH_AES_128_GCM_SHA256",
+        0x009D => "TLS_RSA_WITH_AES_256_GCM_SHA384",
+        0xC008 => "TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA",
+        0xC009 => "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA",
+        0xC00A => "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA",
+        0xC012 => "TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA",
+        0xC013 => "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA",
+        0xC014 => "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA",
+        0xC023 => "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256",
+        0xC024 => "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384",
+        0xC027 => "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256",
+        0xC028 => "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384",
+        0xC02B => "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256",
+        0xC02C => "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384",
+        0xC02F => "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256",
+        0xC030 => "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384",
+        0xC035 => "TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA",
+        0xC036 => "TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA",
+        0xCCA8 => "TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256",
+        0xCCA9 => "TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256",
+        0xCCAC => "TLS_ECDHE_PSK_WITH_CHACHA20_POLY1305_SHA256",
+        0x1301 => "TLS_AES_128_GCM_SHA256",
+        0x1302 => "TLS_AES_256_GCM_SHA384",
+        0x1303 => "TLS_CHACHA20_POLY1305_SHA256",
+      }.freeze
+
+      # RFC tls extensions: https://datatracker.ietf.org/doc/html/rfc6066
+      # IANA list: https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml
+      EXTENSION_NAME_MAP = {
+        0 => "server_name", # default enabled
+        1 => "max_fragment_length",
+        2 => "client_certificate_url",
+        3 => "trusted_ca_keys",
+        4 => "truncated_hmac",
+        5 => "status_request", # default enabled
+        6 => "user_mapping",
+        7 => "client_authz",
+        8 => "server_authz",
+        9 => "cert_type",
+        10 => "supported_groups", # default enabled (renamed from "elliptic_curves")
+        11 => "ec_point_formats", # default enabled
+        12 => "srp",
+        13 => "signature_algorithms", # default enabled
+        14 => "use_srtp",
+        15 => "heartbeat",
+        16 => "application_layer_protocol_negotiation", # default enabled
+        17 => "status_request_v2",
+        18 => "signed_certificate_timestamp",
+        19 => "client_certificate_type",
+        20 => "server_certificate_type",
+        21 => "padding",
+        22 => "encrypt_then_mac",
+        23 => "extended_master_secret",
+        24 => "token_binding",
+        25 => "cached_info",
+        26 => "tls_lts",
+        27 => "compress_certificate",
+        28 => "record_size_limit",
+        29 => "pwd_protect",
+        30 => "pwd_clear",
+        31 => "password_salt",
+        32 => "ticket_pinning",
+        33 => "tls_cert_with_extern_psk",
+        34 => "delegated_credential",
+        35 => "session_ticket", # default enabled (renamed from "SessionTicket TLS")
+        36 => "TLMSP",
+        37 => "TLMSP_proxying",
+        38 => "TLMSP_delegate",
+        39 => "supported_ekt_ciphers",
+        # 40 => "Reserved",
+        41 => "pre_shared_key",
+        42 => "early_data",
+        43 => "supported_versions", # default enabled
+        44 => "cookie",
+        45 => "psk_key_exchange_modes", # default enabled
+        # 46 => "Reserved",
+        47 => "certificate_authorities",
+        48 => "oid_filters",
+        49 => "post_handshake_auth",
+        50 => "signature_algorithms_cert",
+        51 => "key_share", # default enabled
+        52 => "transparency_info",
+        # 53 => "connection_id", # (deprecated)
+        54 => "connection_id",
+        55 => "external_id_hash",
+        56 => "external_session_id",
+        57 => "quic_transport_parameters",
+        58 => "ticket_request",
+        59 => "dnssec_chain",
+        60 => "sequence_number_encryption_algorithms",
+        61 => "rrc",
+        17513 => "application_settings",  # BoringSSL private usage
+        # 62-2569 => "Unassigned",
+        # 2570 => "Reserved",
+        # 2571-6681 => "Unassigned",
+        # 6682 => "Reserved",
+        # 6683-10793 => "Unassigned",
+        # 10794 => "Reserved",
+        # 10795-14905 => "Unassigned",
+        # 14906 => "Reserved",
+        # 14907-19017 => "Unassigned",
+        # 19018 => "Reserved",
+        # 19019-23129 => "Unassigned",
+        # 23130 => "Reserved",
+        # 23131-27241 => "Unassigned",
+        # 27242 => "Reserved",
+        # 27243-31353 => "Unassigned",
+        # 31354 => "Reserved",
+        # 31355-35465 => "Unassigned",
+        # 35466 => "Reserved",
+        # 35467-39577 => "Unassigned",
+        # 39578 => "Reserved",
+        # 39579-43689 => "Unassigned",
+        # 43690 => "Reserved",
+        # 43691-47801 => "Unassigned",
+        # 47802 => "Reserved",
+        # 47803-51913 => "Unassigned",
+        # 51914 => "Reserved",
+        # 51915-56025 => "Unassigned",
+        # 56026 => "Reserved",
+        # 56027-60137 => "Unassigned",
+        # 60138 => "Reserved",
+        # 60139-64249 => "Unassigned",
+        # 64250 => "Reserved",
+        # 64251-64767 => "Unassigned",
+        64768 => "ech_outer_extensions",
+        # 64769-65036 => "Unassigned",
+        65037 => "encrypted_client_hello",
+        # 65038-65279 => "Unassigned",
+        # 65280 => "Reserved for Private Use",
+        65281 => "renegotiation_info", # default enabled
+        # 65282-65535 => "Reserved for Private Use",
+      }.freeze
+
+      EXTENSION_ID_MAP = EXTENSION_NAME_MAP.map { |k, v| [v.downcase.to_sym, k] }.to_h
+
+      EXTENSIONS_DEFAULT_ENABLED = [
+        :server_name, # 0
+        :status_request, # 5
+        :signature_algorithms, # 13
+        :supported_groups, # 10
+        :renegotiation_info, # 65281
+        :session_ticket, # 35
+        :supported_versions, # 43
+        :psk_key_exchange_modes, # 45
+        :key_share, # 51
+        :ec_point_formats, # 11
+        :application_layer_protocol_negotiation, # 16
+      ].freeze
+
+      EC_CURVES_MAP = {
+        19 => "P-192",
+        21 => "P-224",
+        23 => "P-256",
+        24 => "P-384",
+        25 => "P-521",
+        29 => "X25519",
+        4588 => "X25519MLKEM768",
+        25497 => "X25519Kyber768Draft00",
+      }.freeze
+    end
+  end
+end

data/lib/ethon_impersonate/impersonate.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+require 'ethon_impersonate/impersonate/settings'
+require 'ethon_impersonate/impersonate/fingerprints'
+require 'ethon_impersonate/impersonate/targets'
+require 'ethon_impersonate/impersonate/tls'
+
+module EthonImpersonate
+  module Impersonate
+  end
+end

data/lib/ethon_impersonate/libc.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+module EthonImpersonate
+
+  # FFI Wrapper module for Libc.
+  #
+  # @api private
+  module Libc
+    extend FFI::Library
+    ffi_lib 'c'
+
+    # :nodoc:
+    def self.windows?
+      Gem.win_platform?
+    end
+
+    unless windows?
+      attach_function :getdtablesize, [], :int
+      attach_function :free, [:pointer], :void
+    end
+  end
+end

data/lib/ethon_impersonate/loggable.rb

@@ -0,0 +1,59 @@
+# encoding: utf-8
+# frozen_string_literal: true
+module EthonImpersonate
+
+  # Contains logging behaviour.
+  module Loggable
+
+    # Get the logger.
+    #
+    # @note Will try to grab Rails' logger first before creating a new logger
+    #   with stdout.
+    #
+    # @example Get the logger.
+    #   Loggable.logger
+    #
+    # @return [ Logger ] The logger.
+    def logger
+      return @logger if defined?(@logger)
+      @logger = rails_logger || default_logger
+    end
+
+    # Set the logger.
+    #
+    # @example Set the logger.
+    #   Loggable.logger = Logger.new($stdout)
+    #
+    # @param [ Logger ] logger The logger to set.
+    #
+    # @return [ Logger ] The new logger.
+    def logger=(logger)
+      @logger = logger
+    end
+
+    private
+
+    # Gets the default EthonImpersonate logger - stdout.
+    #
+    # @example Get the default logger.
+    #   Loggable.default_logger
+    #
+    # @return [ Logger ] The default logger.
+    def default_logger
+      logger = Logger.new($stdout)
+      logger.level = Logger::INFO
+      logger
+    end
+
+    # Get the Rails logger if it's defined.
+    #
+    # @example Get Rails' logger.
+    #   Loggable.rails_logger
+    #
+    # @return [ Logger ] The Rails logger.
+    def rails_logger
+      defined?(::Rails) && ::Rails.respond_to?(:logger) && ::Rails.logger
+    end
+  end
+  extend Loggable
+end

data/lib/ethon_impersonate/multi/operations.rb

@@ -0,0 +1,228 @@
+# frozen_string_literal: true
+module EthonImpersonate
+  class Multi # :nodoc
+    # This module contains logic to run a multi.
+    module Operations
+      STARTED_MULTI = "ETHON: started MULTI"
+      PERFORMED_MULTI = "ETHON: performed MULTI"
+
+      # Return the multi handle. Inititialize multi handle,
+      # in case it didn't happened already.
+      #
+      # @example Return multi handle.
+      #   multi.handle
+      #
+      # @return [ FFI::Pointer ] The multi handle.
+      def handle
+        @handle ||= FFI::AutoPointer.new(Curl.multi_init, Curl.method(:multi_cleanup))
+      end
+
+      # Initialize variables.
+      #
+      # @example Initialize variables.
+      #   multi.init_vars
+      #
+      # @return [ void ]
+      def init_vars
+        if @execution_mode == :perform
+          @timeout = ::FFI::MemoryPointer.new(:long)
+          @timeval = Curl::Timeval.new
+          @fd_read = Curl::FDSet.new
+          @fd_write = Curl::FDSet.new
+          @fd_excep = Curl::FDSet.new
+          @max_fd = ::FFI::MemoryPointer.new(:int)
+        elsif @execution_mode == :socket_action
+          @running_count_pointer = FFI::MemoryPointer.new(:int)
+        end
+      end
+
+      # Perform multi.
+      #
+      # @return [ nil ]
+      #
+      # @example Perform multi.
+      #   multi.perform
+      def perform
+        ensure_execution_mode(:perform)
+
+        EthonImpersonate.logger.debug(STARTED_MULTI)
+        while ongoing?
+          run
+          timeout = get_timeout
+          next if timeout == 0
+          reset_fds
+          set_fds(timeout)
+        end
+        EthonImpersonate.logger.debug(PERFORMED_MULTI)
+        nil
+      end
+
+      # Prepare multi.
+      #
+      # @return [ nil ]
+      #
+      # @example Prepare multi.
+      #   multi.prepare
+      #
+      # @deprecated It is no longer necessary to call prepare.
+      def prepare
+        EthonImpersonate.logger.warn(
+          "ETHON: It is no longer necessay to call "+
+          "Multi#prepare. Its going to be removed "+
+          "in future versions."
+        )
+      end
+
+      # Continue execution with an external IO loop.
+      #
+      # @example When no sockets are ready yet, or to begin.
+      #   multi.socket_action
+      #
+      # @example When a socket is readable
+      #   multi.socket_action(io_object, [:in])
+      #
+      # @example When a socket is readable and writable
+      #   multi.socket_action(io_object, [:in, :out])
+      #
+      # @return [ Symbol ] The Curl.multi_socket_action return code.
+      def socket_action(io = nil, readiness = 0)
+        ensure_execution_mode(:socket_action)
+
+        fd = if io.nil?
+          ::EthonImpersonate::Curl::SOCKET_TIMEOUT
+        elsif io.is_a?(Integer)
+          io
+        else
+          io.fileno
+        end
+
+        code = Curl.multi_socket_action(handle, fd, readiness, @running_count_pointer)
+        @running_count = @running_count_pointer.read_int
+
+        check
+
+        code
+      end
+
+      # Return whether the multi still contains requests or not.
+      #
+      # @example Return if ongoing.
+      #   multi.ongoing?
+      #
+      # @return [ Boolean ] True if ongoing, else false.
+      def ongoing?
+        easy_handles.size > 0 || (!defined?(@running_count) || running_count > 0)
+      end
+
+      private
+
+      # Get timeout.
+      #
+      # @example Get timeout.
+      #   multi.get_timeout
+      #
+      # @return [ Integer ] The timeout.
+      #
+      # @raise [ EthonImpersonate::Errors::MultiTimeout ] If getting the timeout fails.
+      def get_timeout
+        code = Curl.multi_timeout(handle, @timeout)
+        raise Errors::MultiTimeout.new(code) unless code == :ok
+        timeout = @timeout.read_long
+        timeout = 1 if timeout < 0
+        timeout
+      end
+
+      # Reset file describtors.
+      #
+      # @example Reset fds.
+      #   multi.reset_fds
+      #
+      # @return [ void ]
+      def reset_fds
+        @fd_read.clear
+        @fd_write.clear
+        @fd_excep.clear
+      end
+
+      # Set fds.
+      #
+      # @example Set fds.
+      #   multi.set_fds
+      #
+      # @return [ void ]
+      #
+      # @raise [ EthonImpersonate::Errors::MultiFdset ] If setting the file descriptors fails.
+      # @raise [ EthonImpersonate::Errors::Select ] If select fails.
+      def set_fds(timeout)
+        code = Curl.multi_fdset(handle, @fd_read, @fd_write, @fd_excep, @max_fd)
+        raise Errors::MultiFdset.new(code) unless code == :ok
+        max_fd = @max_fd.read_int
+        if max_fd == -1
+          sleep(0.001)
+        else
+          @timeval[:sec] = timeout / 1000
+          @timeval[:usec] = (timeout * 1000) % 1000000
+          loop do
+            code = Curl.select(max_fd + 1, @fd_read, @fd_write, @fd_excep, @timeval)
+            break unless code < 0 && ::FFI.errno == Errno::EINTR::Errno
+          end
+          raise Errors::Select.new(::FFI.errno) if code < 0
+        end
+      end
+
+      # Check.
+      #
+      # @example Check.
+      #   multi.check
+      #
+      # @return [ void ]
+      def check
+        msgs_left = ::FFI::MemoryPointer.new(:int)
+        while true
+          msg = Curl.multi_info_read(handle, msgs_left)
+          break if msg.null?
+          next if msg[:code] != :done
+          easy = easy_handles.find{ |e| e.handle == msg[:easy_handle] }
+          easy.return_code = msg[:data][:code]
+          EthonImpersonate.logger.debug { "ETHON:         performed #{easy.log_inspect}" }
+          delete(easy)
+          easy.complete
+        end
+      end
+
+      # Run.
+      #
+      # @example Run
+      #   multi.run
+      #
+      # @return [ void ]
+      def run
+        running_count_pointer = FFI::MemoryPointer.new(:int)
+        begin code = trigger(running_count_pointer) end while code == :call_multi_perform
+        check
+      end
+
+      # Trigger.
+      #
+      # @example Trigger.
+      #   multi.trigger
+      #
+      # @return [ Symbol ] The Curl.multi_perform return code.
+      def trigger(running_count_pointer)
+        code = Curl.multi_perform(handle, running_count_pointer)
+        @running_count = running_count_pointer.read_int
+        code
+      end
+
+      # Return number of running requests.
+      #
+      # @example Return count.
+      #   multi.running_count
+      #
+      # @return [ Integer ] Number running requests.
+      def running_count
+        @running_count ||= nil
+      end
+    end
+  end
+end

data/lib/ethon_impersonate/multi/options.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+module EthonImpersonate
+  class Multi
+
+    # This module contains the logic and knowledge about the
+    # available options on multi.
+    module Options
+
+      # Sets max_total_connections option.
+      #
+      # @example Set max_total_connections option.
+      #   multi.max_total_conections = $value
+      #
+      # @param [ String ] value The value to set.
+      #
+      # @return [ void ]
+      def max_total_connections=(value)
+        Curl.set_option(:max_total_connections, value_for(value, :int), handle, :multi)
+      end
+
+      # Sets maxconnects option.
+      #
+      # @example Set maxconnects option.
+      #   multi.maxconnects = $value
+      #
+      # @param [ String ] value The value to set.
+      #
+      # @return [ void ]
+      def maxconnects=(value)
+        Curl.set_option(:maxconnects, value_for(value, :int), handle, :multi)
+      end
+
+      # Sets pipelining option.
+      #
+      # @example Set pipelining option.
+      #   multi.pipelining = $value
+      #
+      # @param [ String ] value The value to set.
+      #
+      # @return [ void ]
+      def pipelining=(value)
+        Curl.set_option(:pipelining, value_for(value, :int), handle, :multi)
+      end
+
+      # Sets socketdata option.
+      #
+      # @example Set socketdata option.
+      #   multi.socketdata = $value
+      #
+      # @param [ String ] value The value to set.
+      #
+      # @return [ void ]
+      def socketdata=(value)
+        Curl.set_option(:socketdata, value_for(value, :string), handle, :multi)
+      end
+
+      # Sets socketfunction option.
+      #
+      # @example Set socketfunction option.
+      #   multi.socketfunction = $value
+      #
+      # @param [ String ] value The value to set.
+      #
+      # @return [ void ]
+      def socketfunction=(value)
+        Curl.set_option(:socketfunction, value_for(value, :string), handle, :multi)
+      end
+
+      # Sets timerdata option.
+      #
+      # @example Set timerdata option.
+      #   multi.timerdata = $value
+      #
+      # @param [ String ] value The value to set.
+      #
+      # @return [ void ]
+      def timerdata=(value)
+        Curl.set_option(:timerdata, value_for(value, :string), handle, :multi)
+      end
+
+      # Sets timerfunction option.
+      #
+      # @example Set timerfunction option.
+      #   multi.timerfunction = $value
+      #
+      # @param [ String ] value The value to set.
+      #
+      # @return [ void ]
+      def timerfunction=(value)
+        Curl.set_option(:timerfunction, value_for(value, :string), handle, :multi)
+      end
+
+      private
+
+      # Return the value to set to multi handle. It is converted with the help
+      # of bool_options, enum_options and int_options.
+      #
+      # @example Return casted the value.
+      #   multi.value_for(:verbose)
+      #
+      # @return [ Object ] The casted value.
+      def value_for(value, type, option = nil)
+        return nil if value.nil?
+
+        if type == :bool
+          value ? 1 : 0
+        elsif type == :int
+          value.to_i
+        elsif value.is_a?(String)
+          EthonImpersonate::Easy::Util.escape_zero_byte(value)
+        else
+          value
+        end
+      end
+    end
+  end
+end

data/lib/ethon_impersonate/multi/stack.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+module EthonImpersonate
+  class Multi
+
+    # This module provides the multi stack behaviour.
+    module Stack
+
+      # Return easy handles.
+      #
+      # @example Return easy handles.
+      #   multi.easy_handles
+      #
+      # @return [ Array ] The easy handles.
+      def easy_handles
+        @easy_handles ||= []
+      end
+
+      # Add an easy to the stack.
+      #
+      # @example Add easy.
+      #   multi.add(easy)
+      #
+      # @param [ Easy ] easy The easy to add.
+      #
+      # @raise [ EthonImpersonate::Errors::MultiAdd ] If adding an easy failed.
+      def add(easy)
+        return nil if easy_handles.include?(easy)
+
+        code = Curl.multi_add_handle(handle, easy.handle)
+        raise Errors::MultiAdd.new(code, easy) unless code == :ok
+        easy_handles << easy
+      end
+
+      # Delete an easy from stack.
+      #
+      # @example Delete easy from stack.
+      #
+      # @param [ Easy ] easy The easy to delete.
+      #
+      # @raise [ EthonImpersonate::Errors::MultiRemove ] If removing an easy failed.
+      def delete(easy)
+        if easy_handles.delete(easy)
+          code = Curl.multi_remove_handle(handle, easy.handle)
+          raise Errors::MultiRemove.new(code, handle) unless code == :ok
+        end
+      end
+    end
+  end
+end