Sha256: 7c1430402806a66dc4f0480c41c63069975f4d499dd79fb8968f8bd739d45cd6

Contents?: true

Size: 1.98 KB

Versions: 11

Compression:

Stored size: 1.98 KB

Contents

# frozen_string_literal: true

module Mihari
  module Clients
    #
    # VirusTotal API client
    #
    class VirusTotal < Base
      #
      # @param [String] base_url
      # @param [String, nil] api_key
      # @param [Hash] headers
      # @param [Integer] pagination_interval
      # @param [Integer, nil] timeout
      #
      def initialize(
        base_url = "https://www.virustotal.com",
        api_key:,
        headers: {},
        pagination_interval: Mihari.config.pagination_interval,
        timeout: nil
      )
        raise(ArgumentError, "api_key is required") if api_key.nil?

        headers["x-apikey"] = api_key

        super(base_url, headers:, pagination_interval:, timeout:)
      end

      #
      # @param [String] query
      #
      # @return [Hash]
      #
      def domain_search(query)
        get_json "/api/v3/domains/#{query}/resolutions"
      end

      #
      # @param [String] query
      #
      # @return [Hash]
      #
      def ip_search(query)
        get_json "/api/v3/ip_addresses/#{query}/resolutions"
      end

      #
      # @param [String] query
      # @param [String, nil] cursor
      #
      # @return [Mihari::Structs::VirusTotalIntelligence::Response]
      #
      def intel_search(query, cursor: nil)
        params = {query:, cursor:}.compact
        Structs::VirusTotalIntelligence::Response.from_dynamic! get_json("/api/v3/intelligence/search", params:)
      end

      #
      # @param [String] query
      # @param [Integer] pagination_limit
      #
      # @return [Enumerable<Mihari::Structs::VirusTotalIntelligence::Response>]
      #
      def intel_search_with_pagination(query, pagination_limit: Mihari.config.pagination_limit)
        cursor = nil

        Enumerator.new do |y|
          pagination_limit.times do
            res = intel_search(query, cursor:)

            y.yield res

            cursor = res.meta.cursor
            break if cursor.nil?

            sleep_pagination_interval
          end
        end
      end
    end
  end
end

Version data entries

11 entries across 11 versions & 1 rubygems

Version Path
mihari-8.1.0 lib/mihari/clients/virustotal.rb
mihari-8.0.2 lib/mihari/clients/virustotal.rb
mihari-8.0.1 lib/mihari/clients/virustotal.rb
mihari-8.0.0 lib/mihari/clients/virustotal.rb
mihari-7.6.4 lib/mihari/clients/virustotal.rb
mihari-7.6.3 lib/mihari/clients/virustotal.rb
mihari-7.6.2 lib/mihari/clients/virustotal.rb
mihari-7.6.1 lib/mihari/clients/virustotal.rb
mihari-7.6.0 lib/mihari/clients/virustotal.rb
mihari-7.5.0 lib/mihari/clients/virustotal.rb
mihari-7.4.0 lib/mihari/clients/virustotal.rb