Class: Gem::Request (Ruby 2.7.2)
Description: Class : Gem::Request - Ruby 2.7.2

### Home Classes Methods

### In Files

- rubygems/request.rb
- rubygems/request/connection_pools.rb
- rubygems/request/http_pool.rb
- rubygems/request/https_pool.rb
- rubygems/s3_uri_signer.rb

### Parent

Object

### Namespace

- CLASS Gem::Request::ConnectionPools

### Methods

- ::configure_connection_for_https
- ::get_cert_files
- ::get_proxy_from_env
- ::new
- ::verify_certificate
- ::verify_certificate_message
- #cert_files
- #connection_for
- #fetch
- #proxy_uri
- #reset
- #user_agent

### Included Modules

- Gem::UserInteraction

### Class/Module Index

Quicksearch

- Bundler
- Gem::AvailableSet
- Gem::BasicSpecification
- Gem::BundlerVersionFinder
- Gem::Command
- Gem::CommandLineError
- Gem::CommandManager
- Gem::Commands
- Gem::Commands::BuildCommand
- Gem::Commands::CertCommand
- Gem::Commands::CheckCommand
- Gem::Commands::CleanupCommand
- Gem::Commands::ContentsCommand
- Gem::Commands::DependencyCommand
- Gem::Commands::EnvironmentCommand
- Gem::Commands::FetchCommand
- Gem::Commands::GenerateIndexCommand
- Gem::Commands::HelpCommand
- Gem::Commands::InfoCommand
- Gem::Commands::InstallCommand
- Gem::Commands::ListCommand
- Gem::Commands::LockCommand
- Gem::Commands::MirrorCommand
- Gem::Commands::OpenCommand
- Gem::Commands::OutdatedCommand
- Gem::Commands::OwnerCommand
- Gem::Commands::PristineCommand
- Gem::Commands::PushCommand
- Gem::Commands::QueryCommand
- Gem::Commands::RdocCommand
- Gem::Commands::SearchCommand
- Gem::Commands::ServerCommand
- Gem::Commands::SetupCommand
- Gem::Commands::SetupCommand::MakeDirs
- Gem::Commands::SigninCommand
- Gem::Commands::SignoutCommand
- Gem::Commands::SourcesCommand
- Gem::Commands::SpecificationCommand
- Gem::Commands::StaleCommand
- Gem::Commands::UninstallCommand
- Gem::Commands::UnpackCommand
- Gem::Commands::UpdateCommand
- Gem::Commands::WhichCommand
- Gem::Commands::YankCommand
- Gem::ConfigFile
- Gem::ConflictError
- Gem::ConsoleUI
- Gem::DefaultUserInteraction
- Gem::Dependency
- Gem::DependencyError
- Gem::DependencyInstaller
- Gem::DependencyList
- Gem::DependencyRemovalException
- Gem::DependencyResolutionError
- Gem::Deprecate
- Gem::Doctor
- Gem::DocumentError
- Gem::EndOfYAMLException
- Gem::ErrorReason
- Gem::Exception
- Gem::Ext
- Gem::Ext::BuildError
- Gem::Ext::Builder
- Gem::Ext::CmakeBuilder
- Gem::Ext::ConfigureBuilder
- Gem::Ext::ExtConfBuilder
- Gem::Ext::RakeBuilder
- Gem::FakeFetcher
- Gem::FilePermissionError
- Gem::FormatException
- Gem::GemNotFoundException
- Gem::GemNotInHomeException
- Gem::GemRunner
- Gem::GemcutterUtilities
- Gem::ImpossibleDependenciesError
- Gem::Indexer
- Gem::InstallError
- Gem::InstallUpdateOptions
- Gem::Installer
- Gem::Installer::FakePackage
- Gem::InstallerTestCase
- Gem::InvalidSpecificationException
- Gem::Licenses
- Gem::List
- Gem::LoadError
- Gem::LocalRemoteOptions
- Gem::MissingSpecError
- Gem::MissingSpecVersionError
- Gem::MockGemUi
- Gem::MockGemUi::InputEOFError
- Gem::MockGemUi::SystemExitException
- Gem::MockGemUi::TTY
- Gem::MockGemUi::TermError
- Gem::NameTuple
- Gem::NoAliasYAMLTree
- Gem::OperationNotSupportedError
- Gem::Package::DigestIO
- Gem::Package::Error
- Gem::Package::FormatError
- Gem::Package::NonSeekableIO
- Gem::Package::Old
- Gem::Package::PathError
- Gem::Package::TarHeader
- Gem::Package::TarInvalidError
- Gem::Package::TarReader
- Gem::Package::TarReader::Entry
- Gem::Package::TarReader::UnexpectedEOF
- Gem::Package::TarTestCase
- Gem::Package::TarWriter
- Gem::Package::TarWriter::BoundedStream
- Gem::Package::TarWriter::FileOverflow
- Gem::Package::TarWriter::RestrictedStream
- Gem::Package::TooLongFileName
- Gem::PackageTask
- Gem::PathSupport
- Gem::Platform
- Gem::PlatformMismatch
- Gem::RemoteError
- Gem::RemoteFetcher
- Gem::RemoteFetcher::FetchError
- Gem::RemoteFetcher::UnknownHostError
- Gem::RemoteInstallationCancelled
- Gem::RemoteInstallationSkipped
- Gem::RemoteSourceException
- Gem::Request::ConnectionPools
- Gem::Request::ConnectionPools::Net
- Gem::RequestSet
- Gem::RequestSet::GemDependencyAPI
- Gem::RequestSet::Lockfile
- Gem::RequestSet::Lockfile::ParseError
- Gem::RequestSet::Lockfile::Parser
- Gem::RequestSet::Lockfile::Tokenizer
- Gem::Requirement
- Gem::Requirement::BadRequirementError
- Gem::Resolver
- Gem::Resolver::APISet
- Gem::Resolver::APISpecification
- Gem::Resolver::ActivationRequest
- Gem::Resolver::BestSet
- Gem::Resolver::ComposedSet
- Gem::Resolver::Conflict
- Gem::Resolver::CurrentSet
- Gem::Resolver::DependencyRequest
- Gem::Resolver::GitSet
- Gem::Resolver::GitSpecification
- Gem::Resolver::IndexSet
- Gem::Resolver::IndexSpecification
- Gem::Resolver::InstalledSpecification
- Gem::Resolver::InstallerSet
- Gem::Resolver::LocalSpecification
- Gem::Resolver::LockSet
- Gem::Resolver::LockSpecification
- Gem::Resolver::Molinillo
- Gem::Resolver::Molinillo::CircularDependencyError
- Gem::Resolver::Molinillo::Delegates
- Gem::Resolver::Molinillo::Delegates::ResolutionState
- Gem::Resolver::Molinillo::Delegates::SpecificationProvider
- Gem::Resolver::Molinillo::DependencyGraph
- Gem::Resolver::Molinillo::DependencyGraph::Action
- Gem::Resolver::Molinillo::DependencyGraph::AddEdgeNoCircular
- Gem::Resolver::Molinillo::DependencyGraph::DeleteEdge
- Gem::Resolver::Molinillo::DependencyGraph::DetachVertexNamed
- Gem::Resolver::Molinillo::DependencyGraph::Log
- Gem::Resolver::Molinillo::DependencyGraph::Tag
- Gem::Resolver::Molinillo::DependencyGraph::Vertex
- Gem::Resolver::Molinillo::DependencyState
- Gem::Resolver::Molinillo::NoSuchDependencyError
- Gem::Resolver::Molinillo::PossibilityState
- Gem::Resolver::Molinillo::ResolutionState
- Gem::Resolver::Molinillo::Resolver
- Gem::Resolver::Molinillo::Resolver::Resolution
- Gem::Resolver::Molinillo::ResolverError
- Gem::Resolver::Molinillo::SpecificationProvider
- Gem::Resolver::Molinillo::UI
- Gem::Resolver::Molinillo::VersionConflict
- Gem::Resolver::RequirementList
- Gem::Resolver::Set
- Gem::Resolver::SourceSet
- Gem::Resolver::SpecSpecification
- Gem::Resolver::Specification
- Gem::Resolver::Stats
- Gem::Resolver::VendorSet
- Gem::Resolver::VendorSpecification
- Gem::RubyVersionMismatch
- Gem::RuntimeRequirementNotMetError
- Gem::S3URISigner
- Gem::S3URISigner::ConfigurationError
- Gem::S3URISigner::InstanceProfileError
- Gem::SafeYAML
- Gem::Security
- Gem::Security::Exception
- Gem::Security::Policy
- Gem::Security::Signer
- Gem::Security::TrustDir
- Gem::SecurityOption
- Gem::Server
- Gem::SilentUI
- Gem::Source
- Gem::Source::Git
- Gem::Source::Installed
- Gem::Source::Local
- Gem::Source::Lock
- Gem::Source::SpecificFile
- Gem::Source::Vendor
- Gem::SourceFetchProblem
- Gem::SourceList
- Gem::SpecFetcher
- Gem::SpecificGemNotFoundException
- Gem::Specification
- Gem::SpecificationPolicy
- Gem::StreamUI
- Gem::StreamUI::SilentDownloadReporter
- Gem::StreamUI::SilentProgressReporter
- Gem::StreamUI::SimpleProgressReporter
- Gem::StreamUI::ThreadedDownloadReporter
- Gem::StreamUI::VerboseProgressReporter
- Gem::StubSpecification
- Gem::SystemExitException
- Gem::TestCase
- Gem::TestCase::SpecFetcherSetup
- Gem::TestCase::StaticSet
- Gem::Text
- Gem::UninstallError
- Gem::Uninstaller
- Gem::UnsatisfiableDependencyError
- Gem::UriFormatter
- Gem::UriParser
- Gem::UriParsing
- Gem::UserInteraction
- Gem::Util
- Gem::Validator
- Gem::VerificationError
- Gem::Version
- Gem::VersionOption
- Kernel
- Object
- OpenSSL
- TempIO
- YAML::Syck
- YAML::Syck

No matching classes.

# Gem::Request

### Public Class Methods

configure_connection_for_https(connection, cert_files) click to toggle source

                   # File rubygems/request.rb, line 48
    def self.configure_connection_for_https(connection, cert_files)
      require 'net/https'
      connection.use_ssl = true
      connection.verify_mode =
        Gem.configuration.ssl_verify_mode || OpenSSL::SSL::VERIFY_PEER
      store = OpenSSL::X509::Store.new

      if Gem.configuration.ssl_client_cert
        pem = File.read Gem.configuration.ssl_client_cert
        connection.cert = OpenSSL::X509::Certificate.new pem
        connection.key = OpenSSL::PKey::RSA.new pem
      end

      store.set_default_paths
      cert_files.each do |ssl_cert_file|
        store.add_file ssl_cert_file
      end
      if Gem.configuration.ssl_ca_cert
        if File.directory? Gem.configuration.ssl_ca_cert
          store.add_path Gem.configuration.ssl_ca_cert
        else
          store.add_file Gem.configuration.ssl_ca_cert
        end
      end
      connection.cert_store = store

      connection.verify_callback = proc do |preverify_ok, store_context|
        verify_certificate store_context unless preverify_ok

        preverify_ok
      end

      connection
    rescue LoadError => e
      raise unless (e.respond_to?(:path) && e.path == 'openssl') ||
                   e.message =~ / -- openssl$/

      raise Gem::Exception.new(
              'Unable to require openssl, install OpenSSL and rebuild Ruby (preferred) or use non-HTTPS sources')
    end

get_cert_files() click to toggle source

                   # File rubygems/request.rb, line 43
    def self.get_cert_files
      pattern = File.expand_path("./ssl_certs/*/*.pem", File.dirname(__FILE__))
      Dir.glob(pattern)
    end

get_proxy_from_env(scheme = 'http') click to toggle source

Returns a proxy URI for the given `scheme` if one is set in the environment variables.

                   # File rubygems/request.rb, line 165
    def self.get_proxy_from_env(scheme = 'http')
      _scheme = scheme.downcase
      _SCHEME = scheme.upcase
      env_proxy = ENV["#{_scheme}_proxy"] || ENV["#{_SCHEME}_PROXY"]

      no_env_proxy = env_proxy.nil? || env_proxy.empty?

      if no_env_proxy
        return (_scheme == 'https' || _scheme == 'http') ?
          :no_proxy : get_proxy_from_env('http')
      end

      require "uri"
      uri = URI(Gem::UriFormatter.new(env_proxy).normalize)

      if uri and uri.user.nil? and uri.password.nil?
        user     = ENV["#{_scheme}_proxy_user"] || ENV["#{_SCHEME}_PROXY_USER"]
        password = ENV["#{_scheme}_proxy_pass"] || ENV["#{_SCHEME}_PROXY_PASS"]

        uri.user     = Gem::UriFormatter.new(user).escape
        uri.password = Gem::UriFormatter.new(password).escape
      end

      uri
    end

new(uri, request_class, last_modified, pool) click to toggle source

                   # File rubygems/request.rb, line 30
    def initialize(uri, request_class, last_modified, pool)
      @uri = uri
      @request_class = request_class
      @last_modified = last_modified
      @requests = Hash.new 0
      @user_agent = user_agent

      @connection_pool = pool
    end

verify_certificate(store_context) click to toggle source

                   # File rubygems/request.rb, line 89
    def self.verify_certificate(store_context)
      depth  = store_context.error_depth
      error  = store_context.error_string
      number = store_context.error
      cert   = store_context.current_cert

      ui.alert_error "SSL verification error at depth #{depth}: #{error} (#{number})"

      extra_message = verify_certificate_message number, cert

      ui.alert_error extra_message if extra_message
    end

verify_certificate_message(error_number, cert) click to toggle source

                   # File rubygems/request.rb, line 102
    def self.verify_certificate_message(error_number, cert)
      return unless cert
      case error_number
      when OpenSSL::X509::V_ERR_CERT_HAS_EXPIRED then
        "Certificate #{cert.subject} expired at #{cert.not_after.iso8601}"
      when OpenSSL::X509::V_ERR_CERT_NOT_YET_VALID then
        "Certificate #{cert.subject} not valid until #{cert.not_before.iso8601}"
      when OpenSSL::X509::V_ERR_CERT_REJECTED then
        "Certificate #{cert.subject} is rejected"
      when OpenSSL::X509::V_ERR_CERT_UNTRUSTED then
        "Certificate #{cert.subject} is not trusted"
      when OpenSSL::X509::V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT then
        "Certificate #{cert.issuer} is not trusted"
      when OpenSSL::X509::V_ERR_INVALID_CA then
        "Certificate #{cert.subject} is an invalid CA certificate"
      when OpenSSL::X509::V_ERR_INVALID_PURPOSE then
        "Certificate #{cert.subject} has an invalid purpose"
      when OpenSSL::X509::V_ERR_SELF_SIGNED_CERT_IN_CHAIN then
        "Root certificate is not trusted (#{cert.subject})"
      when OpenSSL::X509::V_ERR_UNABLE_TO_GET_ISSUER_CERT_LOCALLY then
        "You must add #{cert.issuer} to your local trusted store"
      when
        OpenSSL::X509::V_ERR_UNABLE_TO_VERIFY_LEAF_SIGNATURE then
        "Cannot verify certificate issued by #{cert.issuer}"
      end
    end

### Public Instance Methods

cert_files() click to toggle source

                   # File rubygems/request.rb, line 41
    def cert_files; @connection_pool.cert_files; end

connection_for(uri) click to toggle source

Creates or an HTTP connection based on `uri`, or retrieves an existing connection, using a proxy if needed.

                   # File rubygems/request.rb, line 133
    def connection_for(uri)
      @connection_pool.checkout
    rescue defined?(OpenSSL::SSL) ? OpenSSL::SSL::SSLError : Errno::EHOSTDOWN,
           Errno::EHOSTDOWN => e
      raise Gem::RemoteFetcher::FetchError.new(e.message, uri)
    end

fetch() click to toggle source

                   # File rubygems/request.rb, line 140
    def fetch
      request = @request_class.new @uri.request_uri

      unless @uri.nil? || @uri.user.nil? || @uri.user.empty?
        request.basic_auth Gem::UriFormatter.new(@uri.user).unescape,
                           Gem::UriFormatter.new(@uri.password).unescape
      end

      request.add_field 'User-Agent', @user_agent
      request.add_field 'Connection', 'keep-alive'
      request.add_field 'Keep-Alive', '30'

      if @last_modified
        request.add_field 'If-Modified-Since', @last_modified.httpdate
      end

      yield request if block_given?

      perform_request request
    end

proxy_uri() click to toggle source

                   # File rubygems/request.rb, line 40
    def proxy_uri; @connection_pool.proxy_uri; end

reset(connection) click to toggle source

Resets HTTP connection `connection`.

                   # File rubygems/request.rb, line 269
    def reset(connection)
      @requests.delete connection.object_id

      connection.finish
      connection.start
    end

user_agent() click to toggle source

                   # File rubygems/request.rb, line 276
    def user_agent
      ua = "RubyGems/#{Gem::VERSION} #{Gem::Platform.local}".dup

      ruby_version = RUBY_VERSION
      ruby_version += 'dev' if RUBY_PATCHLEVEL == -1

      ua << " Ruby/#{ruby_version} (#{RUBY_RELEASE_DATE}"
      if RUBY_PATCHLEVEL >= 0
        ua << " patchlevel #{RUBY_PATCHLEVEL}"
      elsif defined?(RUBY_REVISION)
        ua << " revision #{RUBY_REVISION}"
      end
      ua << ")"

      ua << " #{RUBY_ENGINE}" if RUBY_ENGINE != 'ruby'

      ua
    end