Class: Gem::Security::TrustDir

Inherits:
Object
  • Object
show all
Defined in:
lib/rubygems/security/trust_dir.rb

Overview

The TrustDir manages the trusted certificates for gem signature verification.

Constant Summary collapse

DEFAULT_PERMISSIONS =

Default permissions for the trust directory and its contents

{
  trust_dir: 0o700,
  trusted_cert: 0o600,
}.freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(dir, permissions = DEFAULT_PERMISSIONS) ⇒ TrustDir

Creates a new TrustDir using dir where the directory and file permissions will be checked according to permissions



25
26
27
28
29
30
 
# File 'lib/rubygems/security/trust_dir.rb', line 25

def initialize(dir, permissions = DEFAULT_PERMISSIONS)
  @dir = dir
  @permissions = permissions

  @digester = Gem::Security.create_digest
end

Instance Attribute Details

#dir ⇒ Object (readonly)

The directory where trusted certificates will be stored.



19
20
21
 
# File 'lib/rubygems/security/trust_dir.rb', line 19

def dir
  @dir
end

Instance Method Details

#cert_path(certificate) ⇒ Object

Returns the path to the trusted certificate



35
36
37
 
# File 'lib/rubygems/security/trust_dir.rb', line 35

def cert_path(certificate)
  name_path certificate.subject
end

#each_certificate ⇒ Object

Enumerates trusted certificates.



42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/rubygems/security/trust_dir.rb', line 42

def each_certificate
  return enum_for __method__ unless block_given?

  glob = File.join @dir, "*.pem"

  Dir[glob].each do |certificate_file|
    certificate = load_certificate certificate_file

    yield certificate, certificate_file
  rescue OpenSSL::X509::CertificateError
    next # HACK: warn
  end
end

#issuer_of(certificate) ⇒ Object

Returns the issuer certificate of the given certificate if it exists in the trust directory.



60
61
62
63
64
65
66
 
# File 'lib/rubygems/security/trust_dir.rb', line 60

def issuer_of(certificate)
  path = name_path certificate.issuer

  return unless File.exist? path

  load_certificate path
end

#load_certificate(certificate_file) ⇒ Object

Loads the given certificate_file



80
81
82
83
84
 
# File 'lib/rubygems/security/trust_dir.rb', line 80

def load_certificate(certificate_file)
  pem = File.read certificate_file

  OpenSSL::X509::Certificate.new pem
end

#name_path(name) ⇒ Object

Returns the path to the trusted certificate with the given ASN.1 name



71
72
73
74
75
 
# File 'lib/rubygems/security/trust_dir.rb', line 71

def name_path(name)
  digest = @digester.hexdigest name.to_s

  File.join @dir, "cert-#{digest}.pem"
end

#trust_cert(certificate) ⇒ Object

Add a certificate to trusted certificate list.



89
90
91
92
93
94
95
96
97
98
 
# File 'lib/rubygems/security/trust_dir.rb', line 89

def trust_cert(certificate)
  verify

  destination = cert_path certificate

  File.open destination, "wb", 0o600 do |io|
    io.write certificate.to_pem
    io.chmod(@permissions[:trusted_cert])
  end
end

#verify ⇒ Object

Make sure the trust directory exists. If it does exist, make sure it’s actually a directory. If not, then create it with the appropriate permissions.



105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/rubygems/security/trust_dir.rb', line 105

def verify
  require "fileutils"
  if File.exist? @dir
    raise Gem::Security::Exception,
      "trust directory #{@dir} is not a directory" unless
        File.directory? @dir

    FileUtils.chmod 0o700, @dir
  else
    FileUtils.mkdir_p @dir, mode: @permissions[:trust_dir]
  end
end