Class: Gem::Commands::CertCommand (Ruby 2.3.7)
Description: Class : Gem::Commands::CertCommand - Ruby 2.3.7

- Home
- Core 2.3.7
- Std-lib 2.3.7
- Downloads

Support for the Ruby 2.3 series has ended. See here for reference.

### Home Classes Methods

### In Files

- rubygems/commands/cert_command.rb

### Parent

Gem::Command

### Methods

- ::new
- #build
- #certificates_matching
- #execute
- #load_default_cert
- #load_default_key
- #sign

### Class/Module Index

Quicksearch

- Gem::AvailableSet
- Gem::BasicSpecification
- 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::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::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::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::DependencyGraph
- 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::SafeYAML
- Gem::Security
- Gem::Security::Exception
- Gem::Security::Policy
- Gem::Security::Signer
- Gem::Security::TrustDir
- 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::StreamUI
- Gem::StreamUI::SilentDownloadReporter
- Gem::StreamUI::SilentProgressReporter
- Gem::StreamUI::SimpleProgressReporter
- Gem::StreamUI::VerboseDownloadReporter
- Gem::StreamUI::VerboseProgressReporter
- Gem::StubSpecification
- Gem::SystemExitException
- Gem::TestCase
- Gem::TestCase::SpecFetcherSetup
- Gem::TestCase::StaticSet
- Gem::Text
- Gem::Uninstaller
- Gem::UnsatisfiableDependencyError
- Gem::UriFormatter
- Gem::UserInteraction
- Gem::Util
- Gem::Validator
- Gem::VerificationError
- Gem::Version
- Gem::VersionOption
- Kernel
- Object
- OpenSSL
- TempIO
- YAML::Syck
- YAML::Syck

No matching classes.

# Gem::Commands::CertCommand

### Public Class Methods

new() click to toggle source

                   # File rubygems/commands/cert_command.rb, line 12
    def initialize
      super 'cert', 'Manage RubyGems certificates and signing settings',
            :add => [], :remove => [], :list => [], :build => [], :sign => []

      OptionParser.accept OpenSSL::X509::Certificate do |certificate|
        begin
          OpenSSL::X509::Certificate.new File.read certificate
        rescue Errno::ENOENT
          raise OptionParser::InvalidArgument, "#{certificate}: does not exist"
        rescue OpenSSL::X509::CertificateError
          raise OptionParser::InvalidArgument,
            "#{certificate}: invalid X509 certificate"
        end
      end

      OptionParser.accept OpenSSL::PKey::RSA do |key_file|
        begin
          passphrase = ENV['GEM_PRIVATE_KEY_PASSPHRASE']
          key = OpenSSL::PKey::RSA.new File.read(key_file), passphrase
        rescue Errno::ENOENT
          raise OptionParser::InvalidArgument, "#{key_file}: does not exist"
        rescue OpenSSL::PKey::RSAError
          raise OptionParser::InvalidArgument, "#{key_file}: invalid RSA key"
        end

        raise OptionParser::InvalidArgument,
              "#{key_file}: private key not found" unless key.private?

        key
      end

      add_option('-a', '--add CERT', OpenSSL::X509::Certificate,
                 'Add a trusted certificate.') do |cert, options|
        options[:add] << cert
      end

      add_option('-l', '--list [FILTER]',
                 'List trusted certificates where the',
                 'subject contains FILTER') do |filter, options|
        filter ||= ''

        options[:list] << filter
      end

      add_option('-r', '--remove FILTER',
                 'Remove trusted certificates where the',
                 'subject contains FILTER') do |filter, options|
        options[:remove] << filter
      end

      add_option('-b', '--build EMAIL_ADDR',
                 'Build private key and self-signed',
                 'certificate for EMAIL_ADDR') do |email_address, options|
        options[:build] << email_address
      end

      add_option('-C', '--certificate CERT', OpenSSL::X509::Certificate,
                 'Signing certificate for --sign') do |cert, options|
        options[:issuer_cert] = cert
      end

      add_option('-K', '--private-key KEY', OpenSSL::PKey::RSA,
                 'Key for --sign or --build') do |key, options|
        options[:key] = key
      end

      add_option('-s', '--sign CERT',
                 'Signs CERT with the key from -K',
                 'and the certificate from -C') do |cert_file, options|
        raise OptionParser::InvalidArgument, "#{cert_file}: does not exist" unless
          File.file? cert_file

        options[:sign] << cert_file
      end
    end

### Public Instance Methods

build(name) click to toggle source

                   # File rubygems/commands/cert_command.rb, line 114
    def build name
      key, key_path = build_key
      cert_path = build_cert name, key

      say "Certificate: #{cert_path}"

      if key_path
        say "Private Key: #{key_path}"
        say "Don't forget to move the key file to somewhere private!"
      end
    end

certificates_matching(filter) click to toggle source

                   # File rubygems/commands/cert_command.rb, line 149
    def certificates_matching filter
      return enum_for __method__, filter unless block_given?

      Gem::Security.trusted_certificates.select do |certificate, _|
        subject = certificate.subject.to_s
        subject.downcase.index filter
      end.sort_by do |certificate, _|
        certificate.subject.to_a.map { |name, data,| [name, data] }
      end.each do |certificate, path|
        yield certificate, path
      end
    end

execute() click to toggle source

                   # File rubygems/commands/cert_command.rb, line 94
    def execute
      options[:add].each do |certificate|
        add_certificate certificate
      end

      options[:remove].each do |filter|
        remove_certificates_matching filter
      end

      options[:list].each do |filter|
        list_certificates_matching filter
      end

      options[:build].each do |name|
        build name
      end

      sign_certificates unless options[:sign].empty?
    end

load_default_cert() click to toggle source

                   # File rubygems/commands/cert_command.rb, line 208
    def load_default_cert
      cert_file = File.join Gem.default_cert_path
      cert = File.read cert_file
      options[:issuer_cert] = OpenSSL::X509::Certificate.new cert
    rescue Errno::ENOENT
      alert_error \
        "--certificate not specified and ~/.gem/gem-public_cert.pem does not exist"

      terminate_interaction 1
    rescue OpenSSL::X509::CertificateError
      alert_error \
        "--certificate not specified and ~/.gem/gem-public_cert.pem is not valid"

      terminate_interaction 1
    end

load_default_key() click to toggle source

                   # File rubygems/commands/cert_command.rb, line 224
    def load_default_key
      key_file = File.join Gem.default_key_path
      key = File.read key_file
      passphrase = ENV['GEM_PRIVATE_KEY_PASSPHRASE']
      options[:key] = OpenSSL::PKey::RSA.new key, passphrase
    rescue Errno::ENOENT
      alert_error \
        "--private-key not specified and ~/.gem/gem-private_key.pem does not exist"

      terminate_interaction 1
    rescue OpenSSL::PKey::RSAError
      alert_error \
        "--private-key not specified and ~/.gem/gem-private_key.pem is not valid"

      terminate_interaction 1
    end

sign(cert_file) click to toggle source

                   # File rubygems/commands/cert_command.rb, line 253
    def sign cert_file
      cert = File.read cert_file
      cert = OpenSSL::X509::Certificate.new cert

      permissions = File.stat(cert_file).mode & 0777

      issuer_cert = options[:issuer_cert]
      issuer_key = options[:key]

      cert = Gem::Security.sign cert, issuer_key, issuer_cert

      Gem::Security.write cert, cert_file, permissions
    end