Class: Gem::Package

# File 'lib/rubygems/package.rb', line 196

def initialize(gem, security_policy) # :notnew:
  require "zlib"

  @gem = gem

  @build_time      = Gem.source_date_epoch
  @checksums       = {}
  @contents        = nil
  @digests         = Hash.new {|h, algorithm| h[algorithm] = {} }
  @files           = nil
  @security_policy = security_policy
  @signatures      = {}
  @signer          = nil
  @spec            = nil
end

# File 'lib/rubygems/package.rb', line 172

def self.raw_spec(path, security_policy = nil)
  format = new(path, security_policy)
  spec = format.spec

  metadata = nil

  File.open path, Gem.binary_mode do |io|
    tar = Gem::Package::TarReader.new io
    tar.each_entry do |entry|
      case entry.full_name
      when "metadata" then
        metadata = entry.read
      when "metadata.gz" then
        metadata = Gem::Util.gunzip entry.read
      end
    end
  end

  return spec, metadata
end

# File 'lib/rubygems/package.rb', line 97

attr_reader :checksums

# File 'lib/rubygems/package.rb', line 130

attr_accessor :data_mode

# File 'lib/rubygems/package.rb', line 122

attr_accessor :dir_mode

# File 'lib/rubygems/package.rb', line 103

attr_reader :files

# File 'lib/rubygems/package.rb', line 108

attr_reader :gem

# File 'lib/rubygems/package.rb', line 126

attr_accessor :prog_mode

# File 'lib/rubygems/package.rb', line 113

attr_accessor :security_policy

# File 'lib/rubygems/package.rb', line 590

def spec
  verify unless @spec

  @spec
end

# File 'lib/rubygems/package.rb', line 118

attr_writer :spec

# File 'lib/rubygems/package.rb', line 244

def add_contents(tar) # :nodoc:
  digests = tar.add_file_signed "data.tar.gz", 0444, @signer do |io|
    gzip_to io do |gz_io|
      Gem::Package::TarWriter.new gz_io do |data_tar|
        add_files data_tar
      end
    end
  end

  @checksums["data.tar.gz"] = digests
end

# File 'lib/rubygems/package.rb', line 259

def add_files(tar) # :nodoc:
  @spec.files.each do |file|
    stat = File.lstat file

    if stat.symlink?
      tar.add_symlink file, File.readlink(file), stat.mode
    end

    next unless stat.file?

    tar.add_file_simple file, stat.mode, stat.size do |dst_io|
      File.open file, "rb" do |src_io|
        dst_io.write src_io.read 16384 until src_io.eof?
      end
    end
  end
end

# File 'lib/rubygems/package.rb', line 280

def add_metadata(tar) # :nodoc:
  digests = tar.add_file_signed "metadata.gz", 0444, @signer do |io|
    gzip_to io do |gz_io|
      gz_io.write @spec.to_yaml
    end
  end

  @checksums["metadata.gz"] = digests
end

# File 'lib/rubygems/package.rb', line 293

def build(skip_validation = false, strict_validation = false)
  raise ArgumentError, "skip_validation = true and strict_validation = true are incompatible" if skip_validation && strict_validation

  Gem.load_yaml

  @spec.mark_version
  @spec.validate true, strict_validation unless skip_validation

  setup_signer(
    signer_options: {
      expiration_length_days: Gem.configuration.cert_expiration_length_days,
    }
  )

  @gem.with_write_io do |gem_io|
    Gem::Package::TarWriter.new gem_io do |gem|
      add_metadata gem
      add_contents gem
      add_checksums gem
    end
  end

  say <<-EOM
Successfully built RubyGem
Name: #{@spec.name}
Version: #{@spec.version}
File: #{File.basename @gem.path}
EOM
ensure
  @signer = nil
end

# File 'lib/rubygems/package.rb', line 328

def contents
  return @contents if @contents

  verify unless @spec

  @contents = []

  @gem.with_read_io do |io|
    gem_tar = Gem::Package::TarReader.new io

    gem_tar.each do |entry|
      next unless entry.full_name == "data.tar.gz"

      open_tar_gz entry do |pkg_tar|
        pkg_tar.each do |contents_entry|
          @contents << contents_entry.full_name
        end
      end

      return @contents
    end
  end
end

# File 'lib/rubygems/package.rb', line 215

def copy_to(path)
  FileUtils.cp @gem.path, path unless File.exist? path
end

# File 'lib/rubygems/package.rb', line 356

def digest(entry) # :nodoc:
  algorithms = if @checksums
    @checksums.keys
  else
    [Gem::Security::DIGEST_NAME].compact
  end

  algorithms.each do |algorithm|
    digester = Gem::Security.create_digest(algorithm)

    digester << entry.read(16384) until entry.eof?

    entry.rewind

    @digests[algorithm][entry.full_name] = digester
  end

  @digests
end

# File 'lib/rubygems/package.rb', line 382

def extract_files(destination_dir, pattern = "*")
  verify unless @spec

  FileUtils.mkdir_p destination_dir, :mode => dir_mode && 0755

  @gem.with_read_io do |io|
    reader = Gem::Package::TarReader.new io

    reader.each do |entry|
      next unless entry.full_name == "data.tar.gz"

      extract_tar_gz entry, destination_dir, pattern

      return # ignore further entries
    end
  end
end

# File 'lib/rubygems/package.rb', line 411

def extract_tar_gz(io, destination_dir, pattern = "*") # :nodoc:
  directories = []
  symlinks = []

  open_tar_gz io do |tar|
    tar.each do |entry|
      full_name = entry.full_name
      next unless File.fnmatch pattern, full_name, File::FNM_DOTMATCH

      destination = install_location full_name, destination_dir

      if entry.symlink?
        link_target = entry.header.linkname
        real_destination = link_target.start_with?("/") ? link_target : File.expand_path(link_target, File.dirname(destination))

        raise Gem::Package::SymlinkError.new(full_name, real_destination, destination_dir) unless
          normalize_path(real_destination).start_with? normalize_path(destination_dir + "/")

        symlinks << [full_name, link_target, destination, real_destination]
      end

      FileUtils.rm_rf destination

      mkdir_options = {}
      mkdir_options[:mode] = dir_mode ? 0755 : (entry.header.mode if entry.directory?)
      mkdir =
        if entry.directory?
          destination
        else
          File.dirname destination
        end

      unless directories.include?(mkdir)
        FileUtils.mkdir_p mkdir, **mkdir_options
        directories << mkdir
      end

      if entry.file?
        File.open(destination, "wb") {|out| out.write entry.read }
        FileUtils.chmod file_mode(entry.header.mode), destination
      end

      verbose destination
    end
  end

  symlinks.each do |name, target, destination, real_destination|
    if File.exist?(real_destination)
      File.symlink(target, destination)
    else
      alert_warning "#{@spec.full_name} ships with a dangling symlink named #{name} pointing to missing #{target} file. Ignoring"
    end
  end

  if dir_mode
    File.chmod(dir_mode, *directories)
  end
end

# File 'lib/rubygems/package.rb', line 470

def file_mode(mode) # :nodoc:
  ((mode & 0111).zero? ? data_mode : prog_mode) ||
    # If we're not using one of the default modes, then we're going to fall
    # back to the mode from the tarball. In this case we need to mask it down
    # to fit into 2^16 bits (the maximum value for a mode in CRuby since it
    # gets put into an unsigned short).
    (mode & ((1 << 16) - 1))
end

# File 'lib/rubygems/package.rb', line 485

def gzip_to(io) # :yields: gz_io
  gz_io = Zlib::GzipWriter.new io, Zlib::BEST_COMPRESSION
  gz_io.mtime = @build_time

  yield gz_io
ensure
  gz_io.close
end

# File 'lib/rubygems/package.rb', line 499

def install_location(filename, destination_dir) # :nodoc:
  raise Gem::Package::PathError.new(filename, destination_dir) if
    filename.start_with? "/"

  destination_dir = File.realpath(destination_dir)
  destination = File.expand_path(filename, destination_dir)

  raise Gem::Package::PathError.new(destination, destination_dir) unless
    normalize_path(destination).start_with? normalize_path(destination_dir + "/")

  destination.tap(&Gem::UNTAINT)
  destination
end

# File 'lib/rubygems/package.rb', line 524

def load_spec(entry) # :nodoc:
  case entry.full_name
  when "metadata" then
    @spec = Gem::Specification.from_yaml entry.read
  when "metadata.gz" then
    Zlib::GzipReader.wrap(entry, external_encoding: Encoding::UTF_8) do |gzio|
      @spec = Gem::Specification.from_yaml gzio.read
    end
  end
end

# File 'lib/rubygems/package.rb', line 513

def normalize_path(pathname)
  if Gem.win_platform?
    pathname.downcase
  else
    pathname
  end
end

# File 'lib/rubygems/package.rb', line 538

def open_tar_gz(io) # :nodoc:
  Zlib::GzipReader.wrap io do |gzio|
    tar = Gem::Package::TarReader.new gzio

    yield tar
  end
end

# File 'lib/rubygems/package.rb', line 549

def read_checksums(gem)
  Gem.load_yaml

  @checksums = gem.seek "checksums.yaml.gz" do |entry|
    Zlib::GzipReader.wrap entry do |gz_io|
      Gem::SafeYAML.safe_load gz_io.read
    end
  end
end

# File 'lib/rubygems/package.rb', line 563

def setup_signer(signer_options: {})
  passphrase = ENV["GEM_PRIVATE_KEY_PASSPHRASE"]
  if @spec.signing_key
    @signer =
      Gem::Security::Signer.new(
        @spec.signing_key,
        @spec.cert_chain,
        passphrase,
        signer_options
      )

    @spec.signing_key = nil
    @spec.cert_chain = @signer.cert_chain.map {|cert| cert.to_s }
  else
    @signer = Gem::Security::Signer.new nil, nil, passphrase
    @spec.cert_chain = @signer.cert_chain.map {|cert| cert.to_pem } if
      @signer.cert_chain
  end
end

# File 'lib/rubygems/package.rb', line 606

def verify
  @files     = []
  @spec      = nil

  @gem.with_read_io do |io|
    Gem::Package::TarReader.new io do |reader|
      read_checksums reader

      verify_files reader
    end
  end

  verify_checksums @digests, @checksums

  @security_policy&.verify_signatures @spec, @digests, @signatures

  true
rescue Gem::Security::Exception
  @spec = nil
  @files = []
  raise
rescue Errno::ENOENT => e
  raise Gem::Package::FormatError.new e.message
rescue Gem::Package::TarInvalidError => e
  raise Gem::Package::FormatError.new e.message, @gem
end

# File 'lib/rubygems/package.rb', line 637

def verify_checksums(digests, checksums) # :nodoc:
  return unless checksums

  checksums.sort.each do |algorithm, gem_digests|
    gem_digests.sort.each do |file_name, gem_hexdigest|
      computed_digest = digests[algorithm][file_name]

      unless computed_digest.hexdigest == gem_hexdigest
        raise Gem::Package::FormatError.new \
          "#{algorithm} checksum mismatch for #{file_name}", @gem
      end
    end
  end
end

# File 'lib/rubygems/package.rb', line 655

def verify_entry(entry)
  file_name = entry.full_name
  @files << file_name

  case file_name
  when /\.sig$/ then
    @signatures[$`] = entry.read if @security_policy
    return
  else
    digest entry
  end

  case file_name
  when "metadata", "metadata.gz" then
    load_spec entry
  when "data.tar.gz" then
    verify_gz entry
  end
rescue
  warn "Exception while verifying #{@gem.path}"
  raise
end

# File 'lib/rubygems/package.rb', line 681

def verify_files(gem)
  gem.each do |entry|
    verify_entry entry
  end

  unless @spec
    raise Gem::Package::FormatError.new "package metadata is missing", @gem
  end

  unless @files.include? "data.tar.gz"
    raise Gem::Package::FormatError.new \
            "package content (data.tar.gz) is missing", @gem
  end

  if (duplicates = @files.group_by {|f| f }.select {|k,v| v.size > 1 }.map(&:first)) && duplicates.any?
    raise Gem::Security::Exception, "duplicate files in the package: (#{duplicates.map(&:inspect).join(', ')})"
  end
end

# File 'lib/rubygems/package.rb', line 703

def verify_gz(entry) # :nodoc:
  Zlib::GzipReader.wrap entry do |gzio|
    gzio.read 16384 until gzio.eof? # gzip checksum verification
  end
rescue Zlib::GzipFile::Error => e
  raise Gem::Package::FormatError.new(e.message, entry.full_name)
end