Class: Spaceship::Portal::Certificate

Inherits:
Spaceship::PortalBase show all
Defined in:
lib/spaceship/portal/certificate.rb

Overview

Represents a certificate from the Apple Developer Portal.

This can either be a code signing identity or a push profile

Defined Under Namespace

Classes: ApplePay, DeveloperIDApplication, DeveloperIDInstaller, Development, DevelopmentPush, InHouse, MacAppDistribution, MacDevelopment, MacDevelopmentPush, MacInstallerDistribution, MacProductionPush, Passbook, Production, ProductionPush, PushCertificate, VoipPush, WebsitePush

Constant Summary collapse

IOS_CERTIFICATE_TYPE_IDS = 
{
  "5QPB9NHCEI" => Development,
  "R58UK2EWSO" => Production,
  "9RQEK7MSXA" => InHouse,
  "LA30L5BJEU" => Certificate,
  "BKLRAVXMGM" => DevelopmentPush,
  "3BQKVH9I2X" => ProductionPush,
  "Y3B2F3TYSI" => Passbook,
  "3T2ZP62QW8" => WebsitePush,
  "E5D663CMZW" => WebsitePush,
  "4APLUP237T" => ApplePay
}
MAC_CERTIFICATE_TYPE_IDS = 
{
  "749Y1QAGU7" => MacDevelopment,
  "HXZEUKP0FP" => MacAppDistribution,
  "2PQI8IDXNH" => MacInstallerDistribution,
  "OYVN2GW35E" => DeveloperIDInstaller,
  "W0EURJRMC5" => DeveloperIDApplication,
  "CDZ7EMXIZ1" => MacProductionPush,
  "HQ4KP3I34R" => MacDevelopmentPush,
  "DIVN2GW3XT" => DeveloperIDApplication
}
CERTIFICATE_TYPE_IDS = 
IOS_CERTIFICATE_TYPE_IDS.merge(MAC_CERTIFICATE_TYPE_IDS)

Instance Attribute Summary collapse

Attributes inherited from Base

#client, #raw_data

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Spaceship::PortalBase

client

Methods inherited from Base

attr_accessor, attr_mapping, #attributes, attributes, #initialize, #inspect, mapping_module, method_missing, set_client, #setup, #to_s

Constructor Details

This class inherits a constructor from Spaceship::Base

Instance Attribute Details

#created ⇒ Date

Returns The date and time when the certificate was created.

Examples:

2015-04-01 21:24:00 UTC

Returns:

  • (Date) —

    The date and time when the certificate was created



29
30
31
 
# File 'lib/spaceship/portal/certificate.rb', line 29

def created
  @created
end

#expires ⇒ Date

Returns The date and time when the certificate will expire.

Examples:

2016-04-01 21:24:00 UTC

Returns:

  • (Date) —

    The date and time when the certificate will expire



34
35
36
 
# File 'lib/spaceship/portal/certificate.rb', line 34

def expires
  @expires
end

#id ⇒ String

Returns The ID given from the developer portal. You’ll probably not need it.

Examples:

"P577TH3PAA"

Returns:

  • (String) —

    The ID given from the developer portal. You’ll probably not need it.



12
13
14
 
# File 'lib/spaceship/portal/certificate.rb', line 12

def id
  @id
end

#name ⇒ String

Returns The name of the certificate.

Examples:

Company

"SunApps GmbH"

Push Profile

"com.krausefx.app"

Returns:

  • (String) —

    The name of the certificate



19
20
21
 
# File 'lib/spaceship/portal/certificate.rb', line 19

def name
  @name
end

#owner_id ⇒ String

Returns The ID of the owner, that can be used to fetch more information.

Examples:

"75B83SPLAA"

Returns:

  • (String) —

    The ID of the owner, that can be used to fetch more information



57
58
59
 
# File 'lib/spaceship/portal/certificate.rb', line 57

def owner_id
  @owner_id
end

#owner_name ⇒ String

Returns The name of the owner.

Examples:

Code Signing Identity (usually the company name)

"SunApps Gmbh"

Push Certificate (the name of your App ID)

"Awesome App"

Returns:

  • (String) —

    The name of the owner



51
52
53
 
# File 'lib/spaceship/portal/certificate.rb', line 51

def owner_name
  @owner_name
end

#owner_type ⇒ String

Returns The owner type that defines if it’s a push profile or a code signing identity.

Examples:

Code Signing Identity

"team"

Push Certificate

"bundle"

Returns:

  • (String) —

    The owner type that defines if it’s a push profile or a code signing identity



43
44
45
 
# File 'lib/spaceship/portal/certificate.rb', line 43

def owner_type
  @owner_type
end

#status ⇒ String

Returns Status of the certificate.

Examples:

"Issued"

Returns:

  • (String) —

    Status of the certificate



24
25
26
 
# File 'lib/spaceship/portal/certificate.rb', line 24

def status
  @status
end

#type_display_id ⇒ String

Indicates the type of this certificate which is automatically used to determine the class of the certificate. Available values listed in CERTIFICATE_TYPE_IDS

Examples:

Production Certificate

"R58UK2EWSO"

Development Certificate

"5QPB9NHCEI"

Returns:

  • (String) —

    The type of the certificate



67
68
69
 
# File 'lib/spaceship/portal/certificate.rb', line 67

def type_display_id
  @type_display_id
end

Class Method Details

.all(mac: false) ⇒ Array

Returns all certificates of this account. If this is called from a subclass of Certificate, this will only include certificates matching the current type.

Parameters:

  • mac (Bool) (defaults to: false) —

    Fetches Mac certificates if true. (Ignored if callsed from a subclass)

Returns:

  • (Array) —

    Returns all certificates of this account. If this is called from a subclass of Certificate, this will only include certificates matching the current type.



234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/spaceship/portal/certificate.rb', line 234

def all(mac: false)
  if self == Certificate # are we the base-class?
    type_ids = mac ? MAC_CERTIFICATE_TYPE_IDS : IOS_CERTIFICATE_TYPE_IDS
    types = type_ids.keys
  else
    types = [CERTIFICATE_TYPE_IDS.key(self)]
    mac = MAC_CERTIFICATE_TYPE_IDS.values.include? self
  end

  client.certificates(types, mac: mac).map do |cert|
    factory(cert)
  end
end

.create!(csr: nil, bundle_id: nil) ⇒ Device

Generate a new certificate based on a code certificate signing request

Examples:

# Create a new certificate signing request
csr, pkey = Spaceship::Certificate.create_certificate_signing_request

# Use the signing request to create a new distribution certificate
Spaceship::Certificate::Production.create!(csr: csr)

Parameters:

  • csr (OpenSSL::X509::Request) (defaults to: nil) —

    (required): The certificate signing request to use. Get one using ‘create_certificate_signing_request`

  • bundle_id (String) (defaults to: nil) —

    (optional): The app identifier this certificate is for. This value is only needed if you create a push profile. For normal code signing certificates, you must only pass a certificate signing request.

Returns:

  • (Device) —

    : The newly created device



269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/spaceship/portal/certificate.rb', line 269

def create!(csr: nil, bundle_id: nil)
  type = CERTIFICATE_TYPE_IDS.key(self)

  # look up the app_id by the bundle_id
  if bundle_id
    app = Spaceship::App.find(bundle_id)
    raise "Could not find app with bundle id '#{bundle_id}'" unless app
    app_id = app.app_id
  end

  # ensure csr is a OpenSSL::X509::Request
  csr = OpenSSL::X509::Request.new(csr) if csr.kind_of?(String)

  # if this succeeds, we need to save the .cer and the private key in keychain access or wherever they go in linux
  response = client.create_certificate!(type, csr.to_pem, app_id)
  # munge the response to make it work for the factory
  response['certificateTypeDisplayId'] = response['certificateType']['certificateTypeDisplayId']
  self.new(response)
end

.create_certificate_signing_request ⇒ Object

Create a new code signing request that can be used to generate a new certificate

Examples:

Create a new certificate signing request
csr, pkey = Spaceship.certificate.create_certificate_signing_request

# Use the signing request to create a new distribution certificate
Spaceship.certificate.production.create!(csr: csr)


177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/spaceship/portal/certificate.rb', line 177

def create_certificate_signing_request
  key = OpenSSL::PKey::RSA.new 2048
  csr = OpenSSL::X509::Request.new
  csr.version = 0
  csr.subject = OpenSSL::X509::Name.new([
    ['CN', 'PEM', OpenSSL::ASN1::UTF8STRING]
  ])
  csr.public_key = key.public_key
  csr.sign(key, OpenSSL::Digest::SHA1.new)
  return [csr, key]
end

.factory(attrs) ⇒ Object

Create a new object based on a hash. This is used to create a new object based on the server response.



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/spaceship/portal/certificate.rb', line 191

def factory(attrs)
  # Example:
  # => {"name"=>"iOS Distribution: SunApps GmbH",
  #  "certificateId"=>"XC5PH8DAAA",
  #  "serialNumber"=>"797E732CCE8B7AAA",
  #  "status"=>"Issued",
  #  "statusCode"=>0,
  #  "expirationDate"=>#<DateTime: 2015-11-25T22:45:50+00:00 ((2457352j,81950s,0n),+0s,2299161j)>,
  #  "certificatePlatform"=>"ios",
  #  "certificateType"=>
  #   {"certificateTypeDisplayId"=>"R58UK2EAAA",
  #    "name"=>"iOS Distribution",
  #    "platform"=>"ios",
  #    "permissionType"=>"distribution",
  #    "distributionType"=>"store",
  #    "distributionMethod"=>"app",
  #    "ownerType"=>"team",
  #    "daysOverlap"=>364,
  #    "maxActive"=>2}}

  if attrs['certificateType']
    # On some accounts this is nested, so we need to flatten it
    attrs.merge!(attrs['certificateType'])
    attrs.delete('certificateType')
  end

  # Parse the dates
  # rubocop:disable Style/RescueModifier
  attrs['expirationDate'] = (Time.parse(attrs['expirationDate']) rescue attrs['expirationDate'])
  attrs['dateCreated'] = (Time.parse(attrs['dateCreated']) rescue attrs['dateCreated'])
  # rubocop:enable Style/RescueModifier

  # Here we go
  klass = CERTIFICATE_TYPE_IDS[attrs['certificateTypeDisplayId']]
  klass ||= Certificate
  klass.client = @client
  klass.new(attrs)
end

.find(certificate_id, mac: false) ⇒ Certificate

Returns Find a certificate based on the ID of the certificate.

Parameters:

  • mac (Bool) (defaults to: false) —

    Searches Mac certificates if true

Returns:

  • (Certificate) —

    Find a certificate based on the ID of the certificate.



250
251
252
253
254
 
# File 'lib/spaceship/portal/certificate.rb', line 250

def find(certificate_id, mac: false)
  all(mac: mac).find do |c|
    c.id == certificate_id
  end
end

Instance Method Details

#download ⇒ OpenSSL::X509::Certificate

Returns Downloads and parses the certificate.

Returns:

  • (OpenSSL::X509::Certificate) —

    Downloads and parses the certificate



298
299
300
 
# File 'lib/spaceship/portal/certificate.rb', line 298

def download
  OpenSSL::X509::Certificate.new(download_raw)
end

#download_raw ⇒ String

Returns Download the raw data of the certificate without parsing.

Returns:

  • (String) —

    Download the raw data of the certificate without parsing



293
294
295
 
# File 'lib/spaceship/portal/certificate.rb', line 293

def download_raw
  client.download_certificate(id, type_display_id, mac: mac?)
end

#is_push? ⇒ Bool

rubocop:disable Style/PredicateName

Returns:

  • (Bool) —

    : Is this certificate a push profile for apps?



309
310
311
 
# File 'lib/spaceship/portal/certificate.rb', line 309

def is_push?
  self.kind_of? PushCertificate
end

#mac? ⇒ Bool

Returns Is this a Mac profile?.

Returns:

  • (Bool) —

    Is this a Mac profile?



315
316
317
 
# File 'lib/spaceship/portal/certificate.rb', line 315

def mac?
  MAC_CERTIFICATE_TYPE_IDS.include? type_display_id
end

#revoke! ⇒ Object

Revoke the certificate. You shouldn’t use this method probably.



303
304
305
 
# File 'lib/spaceship/portal/certificate.rb', line 303

def revoke!
  client.revoke_certificate!(id, type_display_id, mac: mac?)
end