Class: Gem::Package
Relationships & Source Files | |
Namespace Children | |
Classes:
| |
Exceptions:
| |
Extension / Inclusion / Inheritance Descendants | |
Subclasses:
|
|
Super Chains via Extension / Inclusion / Inheritance | |
Instance Chain:
|
|
Inherits: | Object |
Defined in: | lib/rubygems/package.rb |
Overview
Example using a Package
Builds a #gem file given a Specification
. A #gem file is a tarball which contains a data.tar.gz, metadata.gz, checksums.yaml.gz and possibly signatures.
require 'rubygems'
require 'rubygems/package'
spec = Gem::Specification.new do |s|
s.summary = "Ruby based make-like utility."
s.name = 'rake'
s.version = PKG_VERSION
s.requirements << 'none'
s.files = PKG_FILES
s.description = <<-EOF
Rake is a Make-like program implemented in Ruby. Tasks
and dependencies are specified in standard Ruby syntax.
EOF
end
Gem::Package.build spec
Reads a #gem file.
require 'rubygems'
require 'rubygems/package'
the_gem = Gem::Package.new(path_to_dot_gem)
the_gem.contents # get the files in the gem
the_gem.extract_files destination_directory # extract the gem into a directory
the_gem.spec # get the spec out of the gem
the_gem.verify # check the gem is OK (contains valid gem specification, contains a not corrupt contents archive)
#files are the files in the #gem tar file, not the Ruby files in the gem #extract_files and #contents automatically call #verify
Class Method Summary
- .build(spec, skip_validation = false, strict_validation = false, file_name = nil)
-
.new(gem, security_policy = nil) ⇒ Package
constructor
Creates a new
Package
for the file at #gem. -
.raw_spec(path, security_policy = nil)
Extracts the
Specification
and raw metadata from the #gem file at path.
Instance Attribute Summary
-
#checksums
readonly
Checksums for the contents of the package.
-
#data_mode
rw
Permission for other files.
-
#dir_mode
rw
Permission for directories.
-
#files
readonly
The files in this package.
-
#gem
readonly
Reference to the gem being packaged.
-
#prog_mode
rw
Permission for program files.
-
#security_policy
rw
The security policy used for verifying the contents of this package.
-
#spec
rw
The spec for this gem.
-
#spec=(value)
rw
Sets the
Specification
to use to build this package. - #build_time rw Internal use only
DefaultUserInteraction
- Included
Instance Method Summary
-
#add_checksums(tar)
Adds a checksum for each entry in the gem to checksums.yaml.gz.
-
#build(skip_validation = false, strict_validation = false)
Builds this package based on the specification set by #spec=
-
#contents
A list of file names contained in this gem.
-
#copy_to(path)
Copies this package to path (if possible).
-
#extract_files(destination_dir, pattern = "*")
Extracts the files in this package into
destination_dir
-
#gzip_to(io)
Gzips content written to
gz_io
toio
. -
#initialize(gem, security_policy) ⇒ Package
constructor
Creates a new package that will read or write to the file #gem.
- #normalize_path(pathname)
-
#read_checksums(gem)
Reads and loads checksums.yaml.gz from the tar file #gem
-
#setup_signer(signer_options: {})
Prepares the gem for signing and checksum generation.
-
#verify
Verifies that this gem:
-
#verify_entry(entry)
Verifies
entry
in a #gem file. -
#verify_files(gem)
Verifies the files of the #gem
-
#add_contents(tar)
Internal use only
Adds the files listed in the packages’s
Specification
to data.tar.gz and adds this file to thetar
. -
#add_files(tar)
Internal use only
Adds files included the package’s
Specification
to thetar
file. -
#add_metadata(tar)
Internal use only
Adds the package’s
Specification
to thetar
file. -
#digest(entry)
Internal use only
Creates a digest of the TarEntry
entry
from the digest algorithm set by the security policy. -
#extract_tar_gz(io, destination_dir, pattern = "*")
Internal use only
Extracts all the files in the gzipped tar archive
io
intodestination_dir
. - #file_mode(mode) Internal use only
-
#install_location(filename, destination_dir)
Internal use only
Returns the full path for installing
filename
. -
#load_spec(entry)
Internal use only
Loads a
Specification
from the TarEntryentry
-
#open_tar_gz(io)
Internal use only
Opens
io
as a gzipped tar archive. -
#verify_checksums(digests, checksums)
Internal use only
Verifies the #checksums against the
digests
. -
#verify_gz(entry)
Internal use only
Verifies that
entry
is a valid gzipped file.
UserInteraction
- Included
#alert | Displays an alert |
#alert_error | Displays an error |
#alert_warning | Displays a warning |
#ask | Asks a |
#ask_for_password | Asks for a password with a |
#ask_yes_no | Asks a yes or no |
#choose_from_list | Asks the user to answer |
#say | Displays the given |
#terminate_interaction | Terminates the RubyGems process with the given |
#verbose | Calls |
DefaultUserInteraction
- Included
Text
- Included
#clean_text | Remove any non-printable characters and make the text suitable for printing. |
#format_text | Wraps |
#levenshtein_distance | Returns a value representing the “cost” of transforming str1 into str2 Vendored version of |
#truncate_text, #min3 |
Constructor Details
.new(gem, security_policy = nil) ⇒ Package
Creates a new Package
for the file at #gem. #gem can also be provided as an IO object.
If #gem is an existing file in the old format a Package::Old
will be returned.
# File 'lib/rubygems/package.rb', line 148
def self.new(gem, security_policy = nil) gem = if gem.is_a?(Gem::Package::Source) gem elsif gem.respond_to? :read Gem::Package::IOSource.new gem else Gem::Package::FileSource.new gem end return super unless Gem::Package == self return super unless gem.present? return super unless gem.start return super unless gem.start.include? "MD5SUM =" Gem::Package::Old.new gem end
#initialize(gem, security_policy) ⇒ Package
Creates a new package that will read or write to the file #gem.
# File 'lib/rubygems/package.rb', line 195
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
Class Method Details
.build(spec, skip_validation = false, strict_validation = false, file_name = nil)
[ GitHub ].raw_spec(path, security_policy = nil)
Extracts the Specification
and raw metadata from the #gem file at Gem.path. –
# File 'lib/rubygems/package.rb', line 171
def self.raw_spec(path, security_policy = nil) format = new(path, security_policy) spec = format.spec = 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 = entry.read when "metadata.gz" then = Gem::Util.gunzip entry.read end end end return spec, end
Instance Attribute Details
#build_time (rw)
# File 'lib/rubygems/package.rb', line 91
attr_accessor :build_time # :nodoc:
#checksums (readonly)
Checksums for the contents of the package
# File 'lib/rubygems/package.rb', line 96
attr_reader :checksums
#data_mode (rw)
Permission for other files
# File 'lib/rubygems/package.rb', line 129
attr_accessor :data_mode
#dir_mode (rw)
Permission for directories
# File 'lib/rubygems/package.rb', line 121
attr_accessor :dir_mode
#files (readonly)
The files in this package. This is not the contents of the gem, just the files in the top-level container.
# File 'lib/rubygems/package.rb', line 102
attr_reader :files
#gem (readonly)
Reference to the gem being packaged.
# File 'lib/rubygems/package.rb', line 107
attr_reader :gem
#prog_mode (rw)
Permission for program files
# File 'lib/rubygems/package.rb', line 125
attr_accessor :prog_mode
#security_policy (rw)
The security policy used for verifying the contents of this package.
# File 'lib/rubygems/package.rb', line 112
attr_accessor :security_policy
#spec (rw)
The spec for this gem.
If this is a package for a built gem the spec is loaded from the gem and returned. If this is a package for a gem being built the provided spec is returned.
# File 'lib/rubygems/package.rb', line 589
def spec verify unless @spec @spec end
#spec=(value) (rw)
Sets the Specification
to use to build this package.
# File 'lib/rubygems/package.rb', line 117
attr_writer :spec
Instance Method Details
#add_checksums(tar)
Adds a checksum for each entry in the gem to checksums.yaml.gz.
# File 'lib/rubygems/package.rb', line 221
def add_checksums(tar) Gem.load_yaml checksums_by_algorithm = Hash.new {|h, algorithm| h[algorithm] = {} } @checksums.each do |name, digests| digests.each do |algorithm, digest| checksums_by_algorithm[algorithm][name] = digest.hexdigest end end tar.add_file_signed "checksums.yaml.gz", 0444, @signer do |io| gzip_to io do |gz_io| Psych.dump checksums_by_algorithm, gz_io end end end
#add_contents(tar)
Adds the files listed in the packages’s Specification
to data.tar.gz and adds this file to the tar
.
#add_files(tar)
Adds files included the package’s Specification
to the tar
file
# File 'lib/rubygems/package.rb', line 258
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
#add_metadata(tar)
Adds the package’s Specification
to the tar
file
# File 'lib/rubygems/package.rb', line 279
def (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
#build(skip_validation = false, strict_validation = false)
Builds this package based on the specification set by #spec=
# File 'lib/rubygems/package.rb', line 292
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| 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
#contents
A list of file names contained in this gem
# File 'lib/rubygems/package.rb', line 327
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
#copy_to(path)
Copies this package to Gem.path (if possible)
#digest(entry)
Creates a digest of the TarEntry entry
from the digest algorithm set by the security policy.
# File 'lib/rubygems/package.rb', line 355
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
#extract_files(destination_dir, pattern = "*")
Extracts the files in this package into destination_dir
If pattern
is specified, only entries matching that glob will be extracted.
# File 'lib/rubygems/package.rb', line 381
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
#extract_tar_gz(io, destination_dir, pattern = "*")
Extracts all the files in the gzipped tar archive io
into destination_dir
.
If an entry in the archive contains a relative path above destination_dir
or an absolute path is encountered an exception is raised.
If pattern
is specified, only entries matching that glob will be extracted.
# File 'lib/rubygems/package.rb', line 410
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. (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 = {} [: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, ** 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_mode(mode)
# File 'lib/rubygems/package.rb', line 469
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
#gzip_to(io)
Gzips content written to gz_io
to io
.
# File 'lib/rubygems/package.rb', line 484
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
#install_location(filename, destination_dir)
Returns the full path for installing filename
.
If filename
is not inside destination_dir
an exception is raised.
# File 'lib/rubygems/package.rb', line 498
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. (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
#load_spec(entry)
Loads a Specification
from the TarEntry entry
# File 'lib/rubygems/package.rb', line 523
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
#normalize_path(pathname)
[ GitHub ]# File 'lib/rubygems/package.rb', line 512
def normalize_path(pathname) if Gem.win_platform? pathname.downcase else pathname end end
#open_tar_gz(io)
Opens io
as a gzipped tar archive
#read_checksums(gem)
Reads and loads checksums.yaml.gz from the tar file #gem
#setup_signer(signer_options: {})
Prepares the gem for signing and checksum generation. If a signing certificate and key are not present only checksum generation is set up.
# File 'lib/rubygems/package.rb', line 562
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, ) @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
#verify
Verifies that this gem:
-
Contains a valid gem specification
-
Contains a contents archive
-
The contents archive is not corrupt
After verification the gem specification from the gem is available from #spec
# File 'lib/rubygems/package.rb', line 605
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 if @security_policy true rescue Gem::Security::Exception @spec = nil @files = [] raise rescue Errno::ENOENT => e raise Gem::Package::FormatError.new e. rescue Gem::Package::TarInvalidError => e raise Gem::Package::FormatError.new e., @gem end
#verify_checksums(digests, checksums)
Verifies the #checksums against the digests
. This check is not cryptographically secure. Missing checksums are ignored.
# 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
#verify_entry(entry)
Verifies entry
in a #gem file.
# 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
#verify_files(gem)
Verifies the files of the #gem
# 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
#verify_gz(entry)
Verifies that entry
is a valid gzipped file.
# 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., entry.full_name) end