Class: PProf::ProvisioningProfile

Inherits:
Object
  • Object
show all
Defined in:
lib/pprof/provisioning_profile.rb

Overview

Represents the content of a Provisioning Profile file

Constant Summary collapse

DEFAULT_DIR =

The default location where all the Provisioning Profiles are stored on a Mac

"#{ENV['HOME']}/Library/MobileDevice/Provisioning Profiles"

Instance Method Summary collapse

Constructor Details

#initialize(file) ⇒ ProvisioningProfile

Create a new ProvisioningProfile object from a file path or UUID

  • If the parameter given has the form of an UUID, a file named with this UUID and a ‘.mobileprovision` is searched in the default directory `DEFAULT_DIR`

  • Otherwise, the parameter is interpreted as a file path

Parameters:

  • file (String) —

    File path or UUID of the ProvisioningProfile



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/pprof/provisioning_profile.rb', line 21

def initialize(file)
  if file =~ %r/^[0-9A-F-]*$/i
    path = "#{PProf::ProvisioningProfile::DEFAULT_DIR}/#{file}.mobileprovision"
  else
    path = file
  end
  xml = nil
  begin
    pkcs7 = OpenSSL::PKCS7.new(File.read(path))
    pkcs7.verify([], OpenSSL::X509::Store.new)
    xml = pkcs7.data
    raise "Empty PKCS7 payload" if xml.nil? || xml.empty?
  rescue
    # Seems like sometimes OpenSSL fails to parse the PKCS7 payload
    # Besides, OpenSSL is deprecated on macOS so might not be up-to-date on all machines
    # So as a fallback, we run the `security` command line.
    # (We could use `security` everytime, but invoking a command line is generally less 
    #  efficient than calling the OpenSSL gem if available, so for now it's just used as fallback)
    xml = `security cms -D -i "#{path}" 2> /dev/null`
  end
  @plist = Plist::parse_xml(xml)
  raise "Unable to parse file #{file}." if @plist.nil?
end

Instance Method Details

#app_id_name ⇒ String

Note:

This is not the AppID itself, but rather the name you associated to that AppID in your Developer Portal

The name of the Application Identifier associated with this Provisioning Profile

Returns:

  • (String) 


65
66
67
 
# File 'lib/pprof/provisioning_profile.rb', line 65

def app_id_name
  @plist['AppIDName']
end

#app_id_prefix ⇒ String

The AppID prefix (which is typically the ID of the team)

Returns:

  • (String) 


72
73
74
 
# File 'lib/pprof/provisioning_profile.rb', line 72

def app_id_prefix
  @plist['ApplicationIdentifierPrefix']
end

#creation_date ⇒ DateTime

The Creation date of this Provisioning Profile

Returns:

  • (DateTime) 


79
80
81
 
# File 'lib/pprof/provisioning_profile.rb', line 79

def creation_date
  @plist['CreationDate']
end

#developer_certificates ⇒ Array<OpenSSL::X509::Certificate>

The list of X509 Developer Certifiates associated with this profile

Returns:

  • (Array<OpenSSL::X509::Certificate>) 


115
116
117
118
119
 
# File 'lib/pprof/provisioning_profile.rb', line 115

def developer_certificates
  @plist['DeveloperCertificates'].map do |data|
    OpenSSL::X509::Certificate.new(data.string)
  end
end

#entitlements ⇒ Entitlements

All the entitlements associated with this Provisioning Profile

Returns:



124
125
126
 
# File 'lib/pprof/provisioning_profile.rb', line 124

def entitlements
  PProf::Entitlements.new(@plist['Entitlements'])
end

#expiration_date ⇒ DateTime

The expiration date of this Provisioning Profile

Returns:

  • (DateTime) 


86
87
88
 
# File 'lib/pprof/provisioning_profile.rb', line 86

def expiration_date
  @plist['ExpirationDate']
end

#name ⇒ String

The name of the Provisioning Profile

Returns:

  • (String) 


48
49
50
 
# File 'lib/pprof/provisioning_profile.rb', line 48

def name
  @plist['Name']
end

#provisioned_devices ⇒ Array<String>

The list of devices provisioned with this Provisioning Profile (if any)

Returns:

  • (Array<String>) 


131
132
133
 
# File 'lib/pprof/provisioning_profile.rb', line 131

def provisioned_devices
  @plist['ProvisionedDevices']
end

#provisions_all_devices ⇒ Bool

Indicates if this Provisioning Profile is provisioned for all devices or only for a list of some specific devices

Returns:

  • (Bool) 


139
140
141
 
# File 'lib/pprof/provisioning_profile.rb', line 139

def provisions_all_devices
  @plist['ProvisionsAllDevices'] || false
end

#team_ids ⇒ Array<String>

Note:

typically Provisioning Profiles contain only one team

The Team IDs associated with this Provisioning Profile

Returns:

  • (Array<String>) 


101
102
103
 
# File 'lib/pprof/provisioning_profile.rb', line 101

def team_ids
  @plist['TeamIdentifier']
end

#team_name ⇒ String

The name of the Team associated with this Provisioning Profile

Returns:

  • (String) 


108
109
110
 
# File 'lib/pprof/provisioning_profile.rb', line 108

def team_name
  @plist['TeamName']
end

#to_hash ⇒ Hash

The hash representation of this Provisioning Profile

Returns:

  • (Hash) 


146
147
148
 
# File 'lib/pprof/provisioning_profile.rb', line 146

def to_hash
  @dict
end

#to_s ⇒ String

The human-readable string representation of this Provisioning Profile Typically suitable for printing this Provisioning Profile information to the user.

Returns:

  • (String) 


154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/pprof/provisioning_profile.rb', line 154

def to_s
  lines = [:name, :uuid, :app_id_name, :app_id_prefix, :creation_date, :expiration_date, :ttl, :team_ids, :team_name].map do |key|
    "- #{key.to_s}: #{self.send(key.to_sym)}"
  end +
  [
    "- #{developer_certificates.count} Developer Certificates",
    "- #{provisioned_devices.count} Provisioned Devices",
    "- Entitlements:"
  ] + entitlements.to_hasg.map { |key, value| "   - #{key}: #{value}" }
  lines.join("\n")
end

#ttl ⇒ Int

The Time-To-Live of this Provisioning Profile

Returns:

  • (Int) 


92
93
94
 
# File 'lib/pprof/provisioning_profile.rb', line 92

def ttl
  @plist['TimeToLive'].to_i
end

#uuid ⇒ String

The UUID of the Provisioning Profile

Returns:

  • (String) 


55
56
57
 
# File 'lib/pprof/provisioning_profile.rb', line 55

def uuid
  @plist['UUID']
end