# frozen_string_literal: true module AppMap class Config Package = Struct.new(:path, :package_name, :exclude, :labels) do def initialize(path, package_name: nil, exclude: [], labels: []) super path, package_name, exclude, labels end def to_h { path: path, package_name: package_name, exclude: exclude.blank? ? nil : exclude, labels: labels.blank? ? nil : labels }.compact end end Hook = Struct.new(:method_names, :package) do end OPENSSL_PACKAGE = Package.new('openssl', package_name: 'openssl', labels: %w[security crypto]) # Methods that should always be hooked, with their containing # package and labels that should be applied to them. HOOKED_METHODS = { 'ActiveSupport::SecurityUtils' => Hook.new(:secure_compare, Package.new('active_support', package_name: 'active_support', labels: %w[security crypto])) }.freeze BUILTIN_METHODS = { 'OpenSSL::PKey::PKey' => Hook.new(:sign, OPENSSL_PACKAGE), 'Digest::Instance' => Hook.new(:digest, OPENSSL_PACKAGE), 'OpenSSL::X509::Request' => Hook.new(%i[sign verify], OPENSSL_PACKAGE), 'OpenSSL::PKCS5' => Hook.new(%i[pbkdf2_hmac_sha1 pbkdf2_hmac], OPENSSL_PACKAGE), 'OpenSSL::Cipher' => Hook.new(%i[encrypt decrypt final], OPENSSL_PACKAGE), 'OpenSSL::X509::Certificate' => Hook.new(:sign, OPENSSL_PACKAGE), 'Logger' => Hook.new(:add, Package.new('logger', labels: %w[log io])), 'Net::HTTP' => Hook.new(:request, Package.new('net/http', package_name: 'net/http', labels: %w[http io])), 'Net::SMTP' => Hook.new(:send, Package.new('net/smtp', package_name: 'net/smtp', labels: %w[smtp email io])), 'Net::POP3' => Hook.new(:mails, Package.new('net/pop3', package_name: 'net/pop', labels: %w[pop pop3 email io])), 'Net::IMAP' => Hook.new(:send_command, Package.new('net/imap', package_name: 'net/imap', labels: %w[imap email io])), 'IO' => Hook.new(%i[read write open close], Package.new('io', labels: %w[io])), 'Marshal' => Hook.new(%i[dump load], Package.new('marshal', labels: %w[serialization marshal])), 'Psych' => Hook.new(%i[dump dump_stream load load_stream parse parse_stream], Package.new('yaml', package_name: 'psych', labels: %w[serialization yaml])), 'JSON::Ext::Parser' => Hook.new(:parse, Package.new('json', package_name: 'json', labels: %w[serialization json])), 'JSON::Ext::Generator::State' => Hook.new(:generate, Package.new('json', package_name: 'json', labels: %w[serialization json])) }.freeze attr_reader :name, :packages def initialize(name, packages = []) @name = name @packages = packages end class << self # Loads configuration data from a file, specified by the file name. def load_from_file(config_file_name) require 'yaml' load YAML.safe_load(::File.read(config_file_name)) end # Loads configuration from a Hash. def load(config_data) packages = (config_data['packages'] || []).map do |package| Package.new(package['path'], exclude: package['exclude'] || []) end Config.new config_data['name'], packages end end def to_h { name: name, packages: packages.map(&:to_h) } end def package_for_method(method) defined_class, _, method_name = ::AppMap::Hook.qualify_method_name(method) package = find_package(defined_class, method_name) return package if package location = method.source_location location_file, = location return unless location_file location_file = location_file[Dir.pwd.length + 1..-1] if location_file.index(Dir.pwd) == 0 packages.find do |pkg| (location_file.index(pkg.path) == 0) && !pkg.exclude.find { |p| location_file.index(p) } end end def included_by_location?(method) !!package_for_method(method) end def always_hook?(defined_class, method_name) !!find_package(defined_class, method_name) end def find_package(defined_class, method_name) hook = find_hook(defined_class) return nil unless hook Array(hook.method_names).include?(method_name) ? hook.package : nil end def find_hook(defined_class) HOOKED_METHODS[defined_class] || BUILTIN_METHODS[defined_class] end end end