Class: Gem::Package

Inherits:
Object
  • Object
show all
Includes:
UserInteraction
Defined in:
lib/rubygems/package.rb

Direct Known Subclasses

Old

Defined Under Namespace

Classes: DigestIO, Error, FileSource, FormatError, IOSource, NonSeekableIO, Old, PathError, Source, TarHeader, TarInvalidError, TarReader, TarTestCase, TarWriter, TooLongFileName

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from UserInteraction

#alert, #alert_error, #alert_warning, #ask, #ask_for_password, #ask_yes_no, #choose_from_list, #say, #terminate_interaction, #verbose

Methods included from DefaultUserInteraction

ui, #ui, #ui=, ui=, use_ui, #use_ui

Methods included from Text

#clean_text, #format_text, #levenshtein_distance, #min3, #truncate_text

Constructor Details

#initialize(gem, security_policy) ⇒ Package

Creates a new package that will read or write to the file gem.


188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/rubygems/package.rb', line 188

def initialize(gem, security_policy) # :notnew:
  @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

Instance Attribute Details

#build_time ⇒ Object

:nodoc:


84
85
86
 
# File 'lib/rubygems/package.rb', line 84

def build_time
  @build_time
end

#checksums ⇒ Object (readonly)

Checksums for the contents of the package


89
90
91
 
# File 'lib/rubygems/package.rb', line 89

def checksums
  @checksums
end

#data_mode ⇒ Object

Permission for other files


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

def data_mode
  @data_mode
end

#dir_mode ⇒ Object

Permission for directories


114
115
116
 
# File 'lib/rubygems/package.rb', line 114

def dir_mode
  @dir_mode
end

#files ⇒ Object (readonly)

The files in this package. This is not the contents of the gem, just the files in the top-level container.


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

def files
  @files
end

#gem ⇒ Object (readonly)

Reference to the gem being packaged.


100
101
102
 
# File 'lib/rubygems/package.rb', line 100

def gem
  @gem
end

#prog_mode ⇒ Object

Permission for program files


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

def prog_mode
  @prog_mode
end

#security_policy ⇒ Object

The security policy used for verifying the contents of this package.


105
106
107
 
# File 'lib/rubygems/package.rb', line 105

def security_policy
  @security_policy
end

#spec ⇒ Object

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.


588
589
590
591
592
 
# File 'lib/rubygems/package.rb', line 588

def spec
  verify unless @spec

  @spec
end

Class Method Details

.build(spec, skip_validation = false, strict_validation = false, file_name = nil) ⇒ Object 


124
125
126
127
128
129
130
131
132
 
# File 'lib/rubygems/package.rb', line 124

def self.build(spec, skip_validation = false, strict_validation = false, file_name = nil)
  gem_file = file_name || spec.file_name

  package = new gem_file
  package.spec = spec
  package.build skip_validation, strict_validation

  gem_file
end

.new(gem, security_policy = nil) ⇒ Object

Creates a new Gem::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 Gem::Package::Old will be returned.


141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/rubygems/package.rb', line 141

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

.raw_spec(path, security_policy = nil) ⇒ Object

Extracts the Gem::Specification and raw metadata from the .gem file at path. –


164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/rubygems/package.rb', line 164

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

Instance Method Details

#add_checksums(tar) ⇒ Object

Adds a checksum for each entry in the gem to checksums.yaml.gz.


212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/rubygems/package.rb', line 212

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|
      YAML.dump checksums_by_algorithm, gz_io
    end
  end
end

#add_contents(tar) ⇒ Object

Adds the files listed in the packages's Gem::Specification to data.tar.gz and adds this file to the tar.


234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/rubygems/package.rb', line 234

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

#add_files(tar) ⇒ Object

Adds files included the package's Gem::Specification to the tar file


249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/rubygems/package.rb', line 249

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

    if stat.symlink?
      target_path = File.readlink(file)

      unless target_path.start_with? '.'
        relative_dir = File.dirname(file).sub("#{Dir.pwd}/", '')
        target_path = File.join(relative_dir, target_path)
      end

      tar.add_symlink file, target_path, 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) ⇒ Object

Adds the package's Gem::Specification to the tar file


277
278
279
280
281
282
283
284
285
 
# File 'lib/rubygems/package.rb', line 277

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

#build(skip_validation = false, strict_validation = false) ⇒ Object

Builds this package based on the specification set by #spec=


290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/rubygems/package.rb', line 290

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

#contents ⇒ Object

A list of file names contained in this gem


325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/rubygems/package.rb', line 325

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) ⇒ Object

Copies this package to path (if possible)


205
206
207
 
# File 'lib/rubygems/package.rb', line 205

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

#digest(entry) ⇒ Object

Creates a digest of the TarEntry entry from the digest algorithm set by the security policy.


353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/rubygems/package.rb', line 353

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 = "*") ⇒ Object

Extracts the files in this package into destination_dir

If pattern is specified, only entries matching that glob will be extracted.


379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
 
# File 'lib/rubygems/package.rb', line 379

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 = "*") ⇒ Object

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.


408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
 
# File 'lib/rubygems/package.rb', line 408

def extract_tar_gz(io, destination_dir, pattern = "*") # :nodoc:
  directories = [] if dir_mode
  open_tar_gz io do |tar|
    tar.each do |entry|
      next unless File.fnmatch pattern, entry.full_name, File::FNM_DOTMATCH

      destination = install_location entry.full_name, destination_dir

      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
      directories << mkdir if directories

      mkdir_p_safe mkdir, mkdir_options, destination_dir, entry.full_name

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

      File.symlink(entry.header.linkname, destination) if entry.symlink?

      verbose destination
    end
  end

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

#file_mode(mode) ⇒ Object

:nodoc:


447
448
449
 
# File 'lib/rubygems/package.rb', line 447

def file_mode(mode) # :nodoc:
  ((mode & 0111).zero? ? data_mode : prog_mode) || mode
end

#gzip_to(io) ⇒ Object

Gzips content written to gz_io to io. – Also sets the gzip modification time to the package build time to ease testing.


457
458
459
460
461
462
463
464
 
# File 'lib/rubygems/package.rb', line 457

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) ⇒ Object

Returns the full path for installing filename.

If filename is not inside destination_dir an exception is raised.

Raises:


471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
 
# File 'lib/rubygems/package.rb', line 471

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

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

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

  begin
    real_destination = File.expand_path(File.realpath(destination))
  rescue
    # it's fine if the destination doesn't exist, because rm -rf'ing it can't cause any damage
    nil
  else
    raise Gem::Package::PathError.new(real_destination, destination_dir) unless
      real_destination.start_with? destination_dir + '/'
  end

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

#load_spec(entry) ⇒ Object

Loads a Gem::Specification from the TarEntry entry


522
523
524
525
526
527
528
529
530
531
 
# File 'lib/rubygems/package.rb', line 522

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

#mkdir_p_safe(mkdir, mkdir_options, destination_dir, file_name) ⇒ Object 


503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
 
# File 'lib/rubygems/package.rb', line 503

def mkdir_p_safe(mkdir, mkdir_options, destination_dir, file_name)
  destination_dir = File.realpath(File.expand_path(destination_dir))
  parts = mkdir.split(File::SEPARATOR)
  parts.reduce do |path, basename|
    path = File.realpath(path) unless path == ""
    path = File.expand_path(path + File::SEPARATOR + basename)
    lstat = File.lstat path rescue nil
    if !lstat || !lstat.directory?
      unless normalize_path(path).start_with? normalize_path(destination_dir) and (FileUtils.mkdir path, **mkdir_options rescue false)
        raise Gem::Package::PathError.new(file_name, destination_dir)
      end
    end
    path
  end
end

#normalize_path(pathname) ⇒ Object 


495
496
497
498
499
500
501
 
# File 'lib/rubygems/package.rb', line 495

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

#open_tar_gz(io) ⇒ Object

Opens io as a gzipped tar archive


536
537
538
539
540
541
542
 
# File 'lib/rubygems/package.rb', line 536

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

    yield tar
  end
end

#read_checksums(gem) ⇒ Object

Reads and loads checksums.yaml.gz from the tar file gem


547
548
549
550
551
552
553
554
555
 
# File 'lib/rubygems/package.rb', line 547

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

#setup_signer(signer_options: {}) ⇒ Object

Prepares the gem for signing and checksum generation. If a signing certificate and key are not present only checksum generation is set up.


561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
 
# File 'lib/rubygems/package.rb', line 561

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

#verify ⇒ Object

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


604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
 
# File 'lib/rubygems/package.rb', line 604

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.message
rescue Gem::Package::TarInvalidError => e
  raise Gem::Package::FormatError.new e.message, @gem
end

#verify_checksums(digests, checksums) ⇒ Object

Verifies the checksums against the digests. This check is not cryptographically secure. Missing checksums are ignored.


636
637
638
639
640
641
642
643
644
645
646
647
648
649
 
# File 'lib/rubygems/package.rb', line 636

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) ⇒ Object

Verifies entry in a .gem file.


654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
 
# File 'lib/rubygems/package.rb', line 654

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) ⇒ Object

Verifies the files of the gem


680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
 
# File 'lib/rubygems/package.rb', line 680

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) and duplicates.any?
    raise Gem::Security::Exception, "duplicate files in the package: (#{duplicates.map(&:inspect).join(', ')})"
  end
end

#verify_gz(entry) ⇒ Object

Verifies that entry is a valid gzipped file.


702
703
704
705
706
707
708
 
# File 'lib/rubygems/package.rb', line 702

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