pprof 0.5.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 21276029f4a059802fcc59cdf37a843caa2b38cc11d6af22f76fa2969bf24975
-  data.tar.gz: 02eedbe630b35226f7a00c531d0b8075b11ab6f4c705434e2f4e4f3445251c8d
+  metadata.gz: fe023fb6399ea85e9aafbd5fe04e359134b37880148ab6796538db8a98bbfca9
+  data.tar.gz: 558e2fc9027127c7aeb87ffb7e80b85ef80439bc6ec4c2301e478b342fb767a7
 SHA512:
-  metadata.gz: 48eb1f57db15c832e6a9acf454d9c6a5ce3be07dc7db4d5877cccb7c32c96f6cfddcf7b3be78a8af8c2c9374148961273a0a1e22a5f51e13b0d8df7359b20ed7
-  data.tar.gz: fdb8efa34984352bc61242ae6452c3e5f6a6e3c11708735c0061d202dae12d8c232458ad88f02d572579221e7d1b8e7e30b1c457048ad626097d80d9825e5aba
+  metadata.gz: 825fa827ec95e13c0e18af1a4159d0c32a66e73f18d74e303018db47c4cc770eb500fcebe75537457045bc659a1128a13b7d7e24a42a46a9eb0ffa0d1d391d15
+  data.tar.gz: 34ac09512ae66a156695d8ed273b7c54b8b0381a03b02e4396fbd71f8bcbe880e7464a2c45dc7e1096e145eb05da9c66b6a06f5685d64c346c4770aaccc23a44

data/README.md

@@ -6,7 +6,9 @@
 
 `pprof` is a ruby library and binary to manipulate Provisioning Profiles.
 
-It can help you create ruby scripts to list, get information, find and filter local Provisioning Profiles easily.
+It can help you manage the Provisioning Profiles installed on your Mac (find the profiles UUIDs from the app names or bundle IDs, find detailed information on a given profile, clean up expired profiles from your Mac…) directly from the command line.
+
+It also supports printing the output in JSON format so you can pipe the result of printing provisioning profiles info into `jq` or similar tools.
 
 ## Installation
 
@@ -16,7 +18,7 @@ It can help you create ruby scripts to list, get information, find and filter lo
 $ gem install pprof
 ```
 
-_(You might need to run this command with `sudo` if your gem home is a system directory)_
+_(You might need to run this command with `sudo` if your gem home is a system directory. Alternatively, we recommend to use a Ruby Version Manager like `rbenv`.)_
 
 ### Build from source
 
@@ -32,6 +34,8 @@ _(You might need to run this command with `sudo` if your gem home is a system di
 
 ### Using it from the command line
 
+#### Listing (and filtering) provisioning profiles
+
 ```sh
 # List all provisioning profiles
 $ pprof 
@@ -65,6 +69,8 @@ $ pprof --has-devices --aps --appid com.foo
 $ pprof --exp -0 | xargs -0 rm
 ```
 
+#### Printing info for a given Provisioning Profile
+
 ```sh
 # Print info for a given Provisioning Profile
 $ pprof '12345678-ABCD-EF90-1234-567890ABCDEF'
@@ -80,6 +86,25 @@ $ pprof --certs --devices --info '12345678-ABCD-EF90-1234-567890ABCDEF'
 $ pprof -cdi '12345678-ABCD-EF90-1234-567890ABCDEF'
 ```
 
+#### Printing output in JSON
+
+```sh
+# Print info about all your provisioning profiles as a JSON array
+$ pprof --json
+# Print info about all your provisioning profiles whose name contains "Foo", as a JSON array
+$ pprof --name "Foo" --json
+# Print info about all your provisioning profiles as a JSON array, including list of devices and certificates in each profile
+$ pprof --json --devices --certs
+
+# Print info about a specific provisioning profile as JSON object
+$ pprof --json '12345678-ABCD-EF90-1234-567890ABCDEF'
+# Print info about a specific provisioning profile as JSON object, including list of devices and certificates
+$ pprof --json -c -d '12345678-ABCD-EF90-1234-567890ABCDEF'
+
+# Use `jq` (https://stedolan.github.io/jq/) to post-process the JSON output and generate some custom JSON array of objects from it
+$ pprof --name 'My App' --json --devices | jq '.[] | {uuid:.UUID, name:.AppIDName, nb_profiles: .ProvisionedDevices|length}'
+```
+
 ### Using it in Ruby
 
 ```ruby
@@ -104,10 +129,13 @@ File.open('certs.txt', 'w') do |file|
 end
 
 # And you can easily loop on all provisioning profiles and manipulate each
-dir = PProf::ProvisioningProfile::DEFAULT_DIR
-Dir["#{dir}/*.mobileprovision"].each do |file|
-  p = PProf::ProvisioningProfile.new(file)
-  puts p.name
+profiles_dirs = PProf::ProvisioningProfile::DEFAULT_DIRS
+# `*.mobileprovision` are typically for iOS profiles, `*.provisionprofile` for Mac profiles
+profiles_dirs.each do |dir|
+  Dir["#{dir}/*.{mobileprovision,provisionprofile}"].each do |file|
+    p = PProf::ProvisioningProfile.new(file)
+    puts p.name
+  end
 end
 ```
 
@@ -123,7 +151,7 @@ That plist payload itself contains various data, including some textual informat
 
 ```ruby
 PProf::ProvisioningProfile
-    ::DEFAULT_DIR
+    ::DEFAULT_DIRS
     new(file) => PProf::ProvisioningProfile
     to_hash => Hash<String, Any>
     

data/bin/pprof

@@ -88,6 +88,10 @@ parser = OptionParser.new do |opts|
     filters[:appid] = matcher(appid)
   end
 
+  opts.on('--platform PLATFORM', 'Filter by Platform (OSX, iOS, xrOS/visionOS, …)') do |platform|
+    filters[:platform] = platform
+  end
+
   opts.on('--uuid UUID', 'Filter by UUID') do |uuid|
     filters[:uuid] = matcher(uuid)
   end

data/lib/pprof/output_formatter.rb

@@ -7,7 +7,7 @@ module PProf
   # A helper tool to pretty-print Provisioning Profile informations
   class OutputFormatter
     # List of properties of a `PProf::ProvisioningProfile` to print when using the `-i` flag
-    MAIN_PROFILE_KEYS = %i[name uuid app_id_name app_id_prefix creation_date expiration_date ttl team_ids team_name]
+    MAIN_PROFILE_KEYS = %i[path name uuid app_id_name app_id_prefix creation_date expiration_date ttl team_ids team_name].freeze
 
     # Initialize a new OutputFormatter
     #
@@ -110,6 +110,7 @@ module PProf
     #
     def as_json(profile, options = {})
       hash = profile.to_hash.dup
+      hash['path'] = profile.path
       hash.delete 'DER-Encoded-Profile'
       hash.delete 'ProvisionedDevices' unless options[:devices]
       if options[:certs]
@@ -157,21 +158,22 @@ module PProf
           (filters[:has_devices].nil? || !(p.provisioned_devices || []).empty? == filters[:has_devices]) &&
           (filters[:all_devices].nil? || p.provisions_all_devices == filters[:all_devices]) &&
           (filters[:aps_env].nil? || match_aps_env(p.entitlements.aps_environment, filters[:aps_env])) &&
+          (filters[:platform].nil? || p.platform.include?(filters[:platform])) &&
           true
       end
     end
 
     # Prints the filtered list as a table
     #
-    # @param [String] dir
-    #        The directory containing the mobileprovision files to list.
-    #        Defaults to '~/Library/MobileDevice/Provisioning Profiles'
+    # @param [String] dirs
+    #        The directories containing the mobileprovision/provisionprofile files to list.
+    #        Defaults to ['~/Library/MobileDevice/Provisioning Profiles', '~/Library/Developer/Xcode/UserData/Provisioning Profiles']
     #
     # @yield each provisioning provile for filtering/validation
     #        The block is given ProvisioningProfile object and should
     #        return true to display the row, false to filter it out
     #
-    def print_table(dir: PProf::ProvisioningProfile::DEFAULT_DIR)
+    def print_table(dirs: PProf::ProvisioningProfile::DEFAULT_DIRS)
       count = 0
       errors = []
 
@@ -180,19 +182,21 @@ module PProf
       @output.puts table.row('UUID', 'Name', 'AppID', 'Expiration Date', ' ', 'Team Name')
       @output.puts table.separator
 
-      Dir['*.mobileprovision', base: dir].each do |file_name|
-        file = File.join(dir, file_name)
-        begin
-          p = PProf::ProvisioningProfile.new(file)
+      dirs.each do |dir|
+        Dir['*.{mobileprovision,provisionprofile}', base: dir].each do |file_name|
+          file = File.join(dir, file_name)
+          begin
+            p = PProf::ProvisioningProfile.new(file)
 
-          next if block_given? && !yield(p)
+            next if block_given? && !yield(p)
 
-          state = DateTime.now < p.expiration_date ? "\u{2705}" : "\u{274c}" # 2705=checkmark, 274C=red X
-          @output.puts table.row(p.uuid, p.name, p.entitlements.app_id, p.expiration_date.to_time, state, p.team_name)
-        rescue StandardError => e
-          errors << { message: e, file: file }
+            state = DateTime.now < p.expiration_date ? "\u{2705}" : "\u{274c}" # 2705=checkmark, 274C=red X
+            @output.puts table.row(p.uuid, p.name, p.entitlements.app_id, p.expiration_date.to_time, state, p.team_name)
+          rescue StandardError => e
+            errors << { message: e, file: file }
+          end
+          count += 1
         end
-        count += 1
       end
 
       @output.puts table.separator
@@ -203,55 +207,59 @@ module PProf
 
     # Prints the filtered list of UUIDs or Paths only
     #
-    # @param [String] dir
-    #        The directory containing the mobileprovision files to list.
-    #        Defaults to '~/Library/MobileDevice/Provisioning Profiles'
     # @param [Hash] options
     #        The options hash typically filled while parsing the command line arguments.
     #         - :mode: will print the UUIDs if set to `:list`, the file path otherwise
     #         - :zero: will concatenate the entries with `\0` instead of `\n` if set
+    # @param [String] dirs
+    #        The directories containing the mobileprovision/provisionprofile files to list.
+    #        Defaults to ['~/Library/MobileDevice/Provisioning Profiles', '~/Library/Developer/Xcode/UserData/Provisioning Profiles']
     #
     # @yield each provisioning profile for filtering/validation
     #        The block is given ProvisioningProfile object and should
     #        return true to display the row, false to filter it out
     #
-    def print_list(dir: PProf::ProvisioningProfile::DEFAULT_DIR, options:) # rubocop:disable Style/OptionalArguments
+    def print_list(options:, dirs: PProf::ProvisioningProfile::DEFAULT_DIRS)
       errors = []
-      Dir['*.mobileprovision', base: dir].each do |file_name|
-        file = File.join(dir, file_name)
-        p = PProf::ProvisioningProfile.new(file)
-        next if block_given? && !yield(p)
+      dirs.each do |dir|
+        Dir['*.{mobileprovision,provisionprofile}', base: dir].each do |file_name|
+          file = File.join(dir, file_name)
+          p = PProf::ProvisioningProfile.new(file)
+          next if block_given? && !yield(p)
 
-        @output.print options[:mode] == :list ? p.uuid.chomp : file.chomp
-        @output.print options[:zero] ? "\0" : "\n"
-      rescue StandardError => e
-        errors << { message: e, file: file }
+          @output.print options[:mode] == :list ? p.uuid.chomp : file.chomp
+          @output.print options[:zero] ? "\0" : "\n"
+        rescue StandardError => e
+          errors << { message: e, file: file }
+        end
       end
       errors.each { |e| print_error(e[:message], e[:file]) } unless errors.empty?
     end
 
     # Prints the filtered list of profiles as a JSON array
     #
-    # @param [String] dir
-    #        The directory containing the mobileprovision files to list.
-    #        Defaults to '~/Library/MobileDevice/Provisioning Profiles'
     # @param [Hash] options
     #        The options hash typically filled while parsing the command line arguments.
     #         - :certs: will print the UUIDs if set to `:list`, the file path otherwise
     #         - :devices: will concatenate the entries with `\0` instead of `\n` if set
+    # @param [String] dirs
+    #        The directories containing the mobileprovision/provisionprofile files to list.
+    #        Defaults to ['~/Library/MobileDevice/Provisioning Profiles', '~/Library/Developer/Xcode/UserData/Provisioning Profiles']
     #
     # @yield each provisioning profile for filtering/validation
     #        The block is given ProvisioningProfile object and should
     #        return true to display the row, false to filter it out
     #
-    def print_json_list(dir: PProf::ProvisioningProfile::DEFAULT_DIR, options:) # rubocop:disable Style/OptionalArguments
+    def print_json_list(options:, dirs: PProf::ProvisioningProfile::DEFAULT_DIRS)
       errors = []
-      profiles = Dir['*.mobileprovision', base: dir].map do |file_name|
-        file = File.join(dir, file_name)
-        p = PProf::ProvisioningProfile.new(file)
-        as_json(p, options) unless block_given? && !yield(p)
-      rescue StandardError => e
-        errors << { message: e, file: file }
+      profiles = dirs.flat_map do |dir|
+        Dir['*.{mobileprovision,provisionprofile}', base: dir].map do |file_name|
+          file = File.join(dir, file_name)
+          p = PProf::ProvisioningProfile.new(file)
+          as_json(p, options) unless block_given? && !yield(p)
+        rescue StandardError => e
+          errors << { message: e, file: file }
+        end
       end.compact
       errors.each { |e| print_error(e[:message], e[:file]) } unless errors.empty?
       @output.puts JSON.pretty_generate(profiles)
@@ -261,7 +269,7 @@ module PProf
       return false if actual.nil? # false if no Push entitlements
       return true if expected == true # true if Push present but we don't filter on specific env
 
-      actual =~ expected        # true if Push present and we filter on specific env
+      actual =~ expected # true if Push present and we filter on specific env
     end
   end
 end

data/lib/pprof/provisioning_profile.rb

@@ -9,26 +9,35 @@ module PProf
   # Represents the content of a Provisioning Profile file
   class ProvisioningProfile
     # The default location where all the Provisioning Profiles are stored on a Mac
-    DEFAULT_DIR = "#{ENV['HOME']}/Library/MobileDevice/Provisioning Profiles"
+    DEFAULT_DIRS = [
+      File.join(Dir.home, 'Library', 'MobileDevice', 'Provisioning Profiles'),
+      File.join(Dir.home, 'Library', 'Developer', 'Xcode', 'UserData', 'Provisioning Profiles')
+    ].freeze
+
+    attr_reader :path
 
     # 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`
+    #   and a `.mobileprovision` is searched in the default directories `DEFAULT_DIRS`
     # - Otherwise, the parameter is interpreted as a file path
     #
     # @param [String] file
     #        File path or UUID of the ProvisioningProfile
     #
     def initialize(file)
-      path = if file =~ /^[0-9A-F-]*$/i
-               "#{PProf::ProvisioningProfile::DEFAULT_DIR}/#{file}.mobileprovision"
-             else
-               file
-             end
+      @path = if file.match?(/^[0-9A-F-]*$/i)
+                PProf::ProvisioningProfile::DEFAULT_DIRS.flat_map do |dir|
+                  Dir["#{dir}/#{file}.{mobileprovision,provisionprofile}"]
+                end.compact.first
+              else
+                file
+              end
+      raise "Unable to find Provisioning Profile with UUID #{file}." if @path.nil?
+
       xml = nil
       begin
-        pkcs7 = OpenSSL::PKCS7.new(File.read(path))
+        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?
@@ -38,10 +47,10 @@ module PProf
         # 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`
+        xml = `security cms -D -i "#{@path}" 2> /dev/null`
       end
       @plist = Plist.parse_xml(xml)
-      raise "Unable to parse file #{file}." if @plist.nil?
+      raise "Unable to parse file #{@path}." if @plist.nil?
     end
 
     # The name of the Provisioning Profile
@@ -58,6 +67,14 @@ module PProf
       @plist['UUID']
     end
 
+    # The list of Platforms the Provisioning Profile is for.
+    # Typical values include `OSX`, `iOS`, `xrOS`, `visionOS`, …
+    #
+    # @return [Array<String>]
+    def platform
+      @plist['Platform']
+    end
+
     # The name of the Application Identifier associated with this Provisioning Profile
     #
     # @note This is not the AppID itself, but rather the name you associated to that
@@ -154,7 +171,7 @@ module PProf
     #
     # @return [String]
     def to_s
-      lines = %i[name uuid app_id_name app_id_prefix creation_date expiration_date ttl team_ids team_name].map do |key|
+      lines = %i[path name uuid app_id_name app_id_prefix creation_date expiration_date ttl team_ids team_name].map do |key|
         "- #{key}: #{send(key.to_sym)}"
       end +
               [

data/lib/pprof/version.rb

@@ -2,5 +2,5 @@
 
 module PProf
   # Module version
-  VERSION = '0.5.1'
+  VERSION = '1.1.0'
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: pprof
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Olivier Halligon
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-09 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: plist
@@ -44,7 +43,6 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -59,8 +57,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key:
+rubygems_version: 3.6.8
 specification_version: 4
 summary: A Provisioning Profiles library
 test_files: []