Class: FastlaneCore::CertChecker

Inherits:
Object
  • Object
show all
Defined in:
fastlane_core/lib/fastlane_core/cert_checker.rb

Overview

This class checks if a specific certificate is installed on the current mac

Class Method Summary collapse

Class Method Details

.install_missing_wwdr_certificates(in_keychain: nil) ⇒ Object 



163
164
165
166
167
168
169
170
171
 
# File 'fastlane_core/lib/fastlane_core/cert_checker.rb', line 163

def self.install_missing_wwdr_certificates(in_keychain: nil)
  # Install all Worldwide Developer Relations Intermediate Certificates listed here: https://www.apple.com/certificateauthority/
  keychain = in_keychain || wwdr_keychain
  missing = WWDRCA_CERTIFICATES.map { |c| c[:alias] } - installed_wwdr_certificates(keychain: keychain)
  missing.each do |cert_alias|
    install_wwdr_certificate(cert_alias, keychain: keychain)
  end
  missing.count
end

.install_wwdr_certificate(cert_alias, keychain: nil) ⇒ Object 



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'fastlane_core/lib/fastlane_core/cert_checker.rb', line 173

def self.install_wwdr_certificate(cert_alias, keychain: nil)
  url = WWDRCA_CERTIFICATES.find { |c| c[:alias] == cert_alias }.fetch(:url)
  file = Tempfile.new([File.basename(url, ".cer"), ".cer"])
  filename = file.path
  keychain ||= wwdr_keychain # backwards compatibility
  keychain = "-k #{keychain.shellescape}" unless keychain.empty?

  # Attempts to fix an issue installing WWDR cert tends to fail on CIs
  # https://github.com/fastlane/fastlane/issues/20960
  curl_extras = ""
  if FastlaneCore::Feature.enabled?('FASTLANE_WWDR_USE_HTTP1_AND_RETRIES')
    curl_extras = "--http1.1 --retry 3 --retry-all-errors "
  end

  import_command = "curl #{curl_extras}-f -o #{filename} #{url} && security import #{filename} #{keychain}"
  UI.verbose("Installing WWDR Cert: #{import_command}")

  require 'open3'
  stdout, stderr, status = Open3.capture3(import_command)
  if FastlaneCore::Globals.verbose?
    UI.command_output(stdout)
    UI.command_output(stderr)
  end

  unless status.success?
    UI.verbose("Failed to install WWDR Certificate, checking output to see why")
    # Check the command output, WWDR might already exist
    unless /The specified item already exists in the keychain./ =~ stderr
      UI.user_error!("Could not install WWDR certificate")
    end
    UI.verbose("WWDR Certificate was already installed")
  end
  return true
end

.installed?(path, in_keychain: nil) ⇒ Boolean

Returns:



58
59
60
61
62
63
64
65
66
67
 
# File 'fastlane_core/lib/fastlane_core/cert_checker.rb', line 58

def self.installed?(path, in_keychain: nil)
  UI.user_error!("Could not find file '#{path}'") unless File.exist?(path)

  in_keychain &&= FastlaneCore::Helper.keychain_path(in_keychain)
  ids = installed_identities(in_keychain: in_keychain)
  ids += installed_installers(in_keychain: in_keychain)
  finger_print = sha1_fingerprint(path)

  return ids.include?(finger_print)
end

.installed_identities(in_keychain: nil) ⇒ Object 



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'fastlane_core/lib/fastlane_core/cert_checker.rb', line 74

def self.installed_identities(in_keychain: nil)
  install_missing_wwdr_certificates(in_keychain: in_keychain)

  available = list_available_identities(in_keychain: in_keychain)
  # Match for this text against word boundaries to avoid edge cases around multiples of 10 identities!
  if /\b0 valid identities found\b/ =~ available
    UI.error([
      "There are no local code signing identities found.",
      "You can run" << " `security find-identity -v -p codesigning #{in_keychain}".rstrip << "` to get this output.",
      "This Stack Overflow thread has more information: https://stackoverflow.com/q/35390072/774.",
      "(Check in Keychain Access for an expired WWDR certificate: https://stackoverflow.com/a/35409835/774 has more info.)"
    ].join("\n"))
  end

  ids = []
  available.split("\n").each do |current|
    next if current.include?("REVOKED")
    begin
      (ids << current.match(/.*\) ([[:xdigit:]]*) \".*/)[1])
    rescue
      # the last line does not match
    end
  end

  return ids
end

.installed_installers(in_keychain: nil) ⇒ Object 



101
102
103
104
105
106
 
# File 'fastlane_core/lib/fastlane_core/cert_checker.rb', line 101

def self.installed_installers(in_keychain: nil)
  available = self.list_available_third_party_mac_installer(in_keychain: in_keychain)
  available += self.list_available_developer_id_installer(in_keychain: in_keychain)

  return available.scan(/^SHA-1 hash: ([[:xdigit:]]+)$/).flatten
end

.installed_wwdr_certificates(keychain: nil) ⇒ Object 



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'fastlane_core/lib/fastlane_core/cert_checker.rb', line 134

def self.installed_wwdr_certificates(keychain: nil)
  keychain ||= wwdr_keychain # backwards compatibility

  # Find all installed WWDRCA certificates. A single `security
  # find-certificate` call can only match one common name, so query the
  # keychain once per common name used by the certificates
  installed_certs = []
  WWDRCA_CERTIFICATE_NAMES.each do |certificate_name|
    Helper.backticks("security find-certificate -a -c '#{certificate_name}' -p #{keychain.shellescape}", print: false)
          .lines
          .each do |line|
      if line.start_with?('-----BEGIN CERTIFICATE-----')
        installed_certs << line
      else
        installed_certs.last << line
      end
    end
  end

  # Get the alias (see `WWDRCA_CERTIFICATES`) of the installed WWDRCA certificates
  installed_certs
    .map do |pem|
      sha256 = Digest::SHA256.hexdigest(OpenSSL::X509::Certificate.new(pem).to_der)
      WWDRCA_CERTIFICATES.find { |c| c[:sha256].casecmp?(sha256) }&.fetch(:alias)
    end
    .compact
    .uniq
end

.is_installed?(path) ⇒ Boolean

Legacy Method, use installed? instead

Returns:



70
71
72
 
# File 'fastlane_core/lib/fastlane_core/cert_checker.rb', line 70

def self.is_installed?(path)
  installed?(path)
end

.list_available_developer_id_installer(in_keychain: nil) ⇒ Object 



125
126
127
128
129
130
131
132
 
# File 'fastlane_core/lib/fastlane_core/cert_checker.rb', line 125

def self.list_available_developer_id_installer(in_keychain: nil)
  # -Z  Print SHA-256 (and SHA-1) hash of the certificate
  # -a  Find all matching certificates, not just the first one
  # -c  Match on "name" when searching (optional)
  commands = ['security find-certificate -Z -a -c "Developer ID Installer"']
  commands << in_keychain if in_keychain
  `#{commands.join(' ')}`
end

.list_available_identities(in_keychain: nil) ⇒ Object 



108
109
110
111
112
113
114
 
# File 'fastlane_core/lib/fastlane_core/cert_checker.rb', line 108

def self.list_available_identities(in_keychain: nil)
  # -v  Show valid identities only (default is to show all identities)
  # -p  Specify policy to evaluate
  commands = ['security find-identity -v -p codesigning']
  commands << in_keychain if in_keychain
  `#{commands.join(' ')}`
end

.list_available_third_party_mac_installer(in_keychain: nil) ⇒ Object 



116
117
118
119
120
121
122
123
 
# File 'fastlane_core/lib/fastlane_core/cert_checker.rb', line 116

def self.list_available_third_party_mac_installer(in_keychain: nil)
  # -Z  Print SHA-256 (and SHA-1) hash of the certificate
  # -a  Find all matching certificates, not just the first one
  # -c  Match on "name" when searching (optional)
  commands = ['security find-certificate -Z -a -c "3rd Party Mac Developer Installer"']
  commands << in_keychain if in_keychain
  `#{commands.join(' ')}`
end

.sha1_fingerprint(path) ⇒ Object 



223
224
225
226
227
228
229
230
 
# File 'fastlane_core/lib/fastlane_core/cert_checker.rb', line 223

def self.sha1_fingerprint(path)
  file_data = File.read(path.to_s)
  cert = OpenSSL::X509::Certificate.new(file_data)
  return OpenSSL::Digest::SHA1.new(cert.to_der).to_s.upcase
rescue => error
  UI.error(error)
  UI.user_error!("Error parsing certificate '#{path}'")
end

.wwdr_keychain ⇒ Object 



208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'fastlane_core/lib/fastlane_core/cert_checker.rb', line 208

def self.wwdr_keychain
  priority = [
    "security default-keychain -d user",
    "security list-keychains -d user"
  ]
  priority.each do |command|
    keychains = Helper.backticks(command, print: FastlaneCore::Globals.verbose?).split("\n")
    unless keychains.empty?
      # Select first keychain name from returned keychains list
      return keychains[0].strip.tr('"', '')
    end
  end
  return ""
end