pprof 0.3.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b298d026ed403f21ea18ce7023b6a31369b749c1
+  data.tar.gz: 9dbfec58d992aa3d80decc8bbb3f8167f2839a0a
+SHA512:
+  metadata.gz: 4be4244290d618ceb0a91b23ef21d9d327dadee0840e4291ac8d854b8f2a137269099898fb8c1001f08863df9eeabd37609b58431cb1340a1e71110aad275c4a
+  data.tar.gz: f00597c5cf7be23cf250861d47c8ac3cb5e75a43b15440155733a405baf7b5e8a4603caf6489a5e601bea7c6338ee23aba632268c0b4652b1da13e1edde899c7

data/LICENSE

@@ -0,0 +1,9 @@
+- MIT LICENSE -
+
+Copyright (c) 2016 Olivier Halligon
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,168 @@
+# pprof
+
+[![Twitter: @aligatr](https://img.shields.io/badge/contact-@aligatr-blue.svg?style=flat)](https://twitter.com/aligatr)
+[![License](https://img.shields.io/badge/license-MIT-green.svg?style=flat)](https://github.com/AliSoftware/pprof/blob/master/LICENSE)
+
+`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 Provisioning Profiles easily.
+
+## Installation
+
+### Rubygems
+
+As of now this library is very early stage and [hasn't been pushed on RubyGems yet](https://github.com/AliSoftware/pprof/issues/4).
+I intend to push it as soon as [#2](https://github.com/AliSoftware/pprof/issues/4) (unit tests) and [#3](https://github.com/AliSoftware/pprof/issues/4) (CHANGELOG) are addressed.
+
+### Build from source
+
+* Clone the repository
+* Build it using `gem build pprof.gemspec`
+* Install it using `gem install pprof-0.3.1.gem`
+
+## Example usages
+
+* Find all the Provisioning Profiles that are attached to a given Team, or with a given AppID, or that will expire after a given date.
+
+* List all your Provisioning Profiles and their inner information, like the provisioned device UDIDs, the list of certificates (with their associated subject/name), etc.
+
+### Using it from the command line
+
+```sh
+# List all provisioning profiles
+$ pprof 
+
+# Filter provisioning profiles by name
+$ pprof --name foo         # only ones containing 'foo', case sensitive
+$ pprof --name /foo/i      # only ones containing 'foo', case insensitive
+$ pprof --name '/foo|bar/' # only ones containing 'foo' or 'bar'
+$ pprof --name /^foo$/     # only the ones exactly matching 'foo'
+
+# Filter by AppID
+$ pprof --appid com.foo             # only ones containing 'com.foo'
+$ pprof --appid '/com\.(foo|bar)/'  # only ones containing 'com.foo' or 'com.bar'
+
+# List only provisioning profiles having push notifications
+$ pprof --aps
+$ pprof --aps development
+$ pprof --aps production
+
+# List only provisioning profiles being expired or not
+$ pprof --exp
+$ pprof --no-exp
+
+# List only provisioning profiles containing provisioned devices
+$ pprof --has-devices
+
+# Combine filters
+$ pprof --has-devices --aps --appid com.foo
+```
+```sh
+# Print info for a given Provisioning Profile
+$ pprof '12345678-ABCD-EF90-1234-567890ABCDEF'
+
+# Print certificates in a given PP
+$ pprof --certs '12345678-ABCD-EF90-1234-567890ABCDEF'
+
+# Print devices in a given PP
+$ pprof --devices '12345678-ABCD-EF90-1234-567890ABCDEF'
+
+# Print all info on a given PP
+$ pprof --certs --devices --info '12345678-ABCD-EF90-1234-567890ABCDEF'
+$ pprof -cdi '12345678-ABCD-EF90-1234-567890ABCDEF'
+```
+
+### Using it in Ruby
+
+```ruby
+require 'pprof'
+# Load the Provisioning Profile
+p = PProf::ProvisioningProfile.new('12345678-ABCD-EF90-1234-567890ABCDEF')
+
+# Print various informations
+puts p.name
+puts p.team_name
+puts p.entitlements.aps_environment
+puts p.provisioned_devices.count
+
+# Use an OutputFormatter to pretty-print the info
+o = PProf::OutputFormatter.new
+o.print_info(p)
+
+# You can also print into any IO other than $stdout, like a File
+File.open('certs.txt', 'w') do |file|
+  o2 = PProf::OutputFormatter.new(file)
+  o2.print_info(p, :certs => true)
+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
+end
+```
+
+
+## Anatomy of a Provisioning Profile
+
+Provisioning Profiles are in fact PKCS7 files which contain a plist payload. 
+
+That plist payload itself contains various data, including some textual information (Team Name, AppID, …), dates (expiration date, etc) but also X509 Certificates (`OpenSSL::X509::Certificate`).
+
+<details>
+<summary>Outline of the two main classes `ProvisioningProfile` and `Entitlements`</summary>
+
+```ruby
+PProf::ProvisioningProfile
+    ::DEFAULT_DIR
+    new(file) => PProf::ProvisioningProfile
+    to_hash => Hash<String, Any>
+    
+    name => String
+    uuid => String
+    app_id_name => String
+    app_id_prefix => String
+    creation_date => DateTime
+    expiration_date => DateTime
+    ttl => Int
+    team_ids => Array<String>
+    team_name => String
+    developer_certificates => Array<OpenSSL::X509::Certificate>
+    entitlements => PProf::Entitlements
+    provisioned_devices => Array<String>
+    provisions_all_devices => Bool
+
+PProf::Entitlements
+    new(dict) => PProf::Entitlements
+    to_hash => Hash<String, Any>
+    [](key) => Any
+    has_key?(key) => Bool
+    keys => Array<String>
+    
+    keychain_access_groups => Array<String>
+    get_task_allow => Bool
+    app_id => String
+    team_id => String
+    aps_environment => String
+    app_groups => Array<String>
+    beta_reports_active => Bool
+    healthkit => Bool
+    ubiquity_container_identifiers => Array<String>
+    ubiquity_kvstore_identifier => String
+```
+</details>
+
+## Contributing
+
+There's plenty of room for improvement, including:
+
+* Additional filters
+* Ability to change the output format
+* Parsing of additional entitlement keys
+
+Don't hesitate to contribute, either with an Issue to give ideas or additional keys that aren't parsed yet, or via a Pull Request to provide new features yourself!
+
+## License
+
+This project is under the MIT license. See `LICENSE` file for more details.

data/bin/pprof

@@ -0,0 +1,128 @@
+#!/usr/bin/env ruby
+
+require 'pprof'
+require 'optparse'
+
+
+def matcher(string)
+  m = string.match(%r[^/(.*)/(.*)$])
+  if m.nil?
+    Regexp.new(Regexp.escape(string))
+  else
+    Regexp.new(m[1], m[2].empty? ? nil : m[2])
+  end
+end
+
+# Command Line Parsing
+
+filters = {}
+options = {}
+parser = OptionParser.new do |opts|
+  opts.banner = <<-BANNER.gsub(/^ *\|/,'')
+    |Usage:
+    |  pprof [options] [PATH|UUID]
+    |  pprof [filters]
+    |
+    |Note: All filters expecting a string are interpreted as regular expressions if surrounded by slashes
+  BANNER
+
+  opts.separator ""
+  opts.separator "Print options"
+
+  opts.on("-i", "--info", "Print general info (default)") do
+    options[:info] = true
+  end
+  opts.on("-c", "--certs", "Print certificates") do
+    options[:certs] = true
+  end
+  opts.on("-d", "--devices", "Print provisioned devices") do
+    options[:devices] = true
+  end
+
+  opts.separator ""
+  opts.separator "Filters"
+
+  opts.on("-n", "--name NAME", "Filter by name") do |name|
+    filters[:name] = matcher(name)
+  end
+
+  opts.on("--appid-name APPID", "Filter by App ID Name") do |appid_name|
+    filters[:appid_name] = matcher(appid_name)
+  end
+
+  opts.on("-a", "--appid APPID", "Filter by App ID") do |appid|
+    filters[:appid] = matcher(appid)
+  end
+
+  opts.on("--uuid UUID", "Filter by UUID") do |uuid|
+    filters[:uuid] = matcher(uuid)
+  end
+
+  opts.on("-e", "--[no-]exp", "Only profiles (not) expired") do |flag|
+    filters[:exp] = flag
+  end
+
+  opts.on("--[no-]has-devices", "Filter by profiles having (no) provisioned devices") do |d|
+    filters[:has_devices] = d
+  end
+
+  opts.on("--[no-]all-devices", "Filter by profiles (not) provisioning all devices") do |d|
+    filters[:all_devices] = d
+  end
+
+  opts.on("--aps [ENV]", "Only profiles having Push entitlements (on a specific aps env)") do |env|
+    filters[:aps_env] = env.nil? ? true : matcher(env)
+  end
+
+
+  opts.separator ""
+  opts.separator "Misc"
+
+  opts.on_tail("-h", "--help", "Show this message") do
+    puts opts
+    exit
+  end
+
+  opts.on_tail("-v", "--version", "Show version") do
+    puts PProf::VERSION
+    exit
+  end
+end
+
+# Parse the options, catching parse errors nicely
+begin
+  parser.parse!
+rescue OptionParser::InvalidOption => err
+  puts err
+  puts parser.help()
+  exit 1
+end
+
+# Don't mix filters and options together, that doesn't make sense
+
+unless filters.empty? || ARGV.empty?
+  puts "You should use either filter flags to filter the whole list, or an specific path, not both."
+  puts parser # Usage
+  exit
+end
+
+unless options.empty? || !ARGV.empty?
+  puts "You should use option flags only when providing an specific path."
+  puts parser # Usage
+  exit
+end
+
+# Call the appropriate action
+
+if ARGV.empty?
+  # Print list of matching profiles
+  o = PProf::OutputFormatter.new
+  o.print_filtered_list(PProf::ProvisioningProfile::DEFAULT_DIR, filters)
+else
+  # Print info about given profile path/UUID
+  p = PProf::ProvisioningProfile.new(ARGV[0])
+  
+  o = PProf::OutputFormatter.new
+  options = { :info => true } if options.empty?
+  o.print_info(p, options)
+end

data/lib/pprof.rb

@@ -0,0 +1,6 @@
+require 'pprof/version'
+
+require 'pprof/provisioning_profile'
+require 'pprof/entitlements'
+
+require 'pprof/output_formatter'

data/lib/pprof/entitlements.rb

@@ -0,0 +1,93 @@
+module PProf
+  class Entitlements
+    def initialize(dict)
+      @dict = dict
+    end
+
+    # @return [Array<String>]
+    def keychain_access_groups
+      @dict['keychain-access-groups']
+    end
+
+    # @return [Bool]
+    def get_task_allow
+      @dict['get-task-allow']
+    end
+
+    # @return [String]
+    def app_id
+      @dict['application-identifier']
+    end
+
+    # @return [String]
+    def team_id
+      @dict['com.apple.developer.team-identifier']
+    end
+
+    # @return [String]
+    def aps_environment
+      @dict['aps-environment']
+    end
+
+    # @return [Array<String>]
+    def app_groups
+      @dict['com.apple.security.application-groups']
+    end
+
+    # @return [Bool]
+    def beta_reports_active
+      @dict['beta-reports-active']
+    end
+
+    # @return [Bool]
+    def healthkit
+      @dict['com.apple.developer.healthkit']
+    end
+
+    # @return [Array<String>]
+    def ubiquity_container_identifiers
+      @dict['com.apple.developer.ubiquity-container-identifiers']
+    end
+
+    # @return [String]
+    def ubiquity_kvstore_identifier
+      @dict['com.apple.developer.ubiquity-kvstore-identifier']
+    end
+
+    # Access entitlements by key
+    #
+    # @param [#to_s] key
+    #        The entitlement key to read
+    #
+    def [](key)
+      @dict[key.to_s]
+    end
+
+    # Check if a given entitlement key is present
+    #
+    # @param [#to_s] key
+    #        The key to check
+    #
+    def has_key?(key)
+      @dict.has_key?(key.to_s)
+    end
+
+    # The list of entitlement keys as String
+    #
+    # @return [Array<String>]
+    #
+    def keys
+      @dict.keys.map(&:to_s)
+    end
+
+    def to_hash
+      @dict
+    end
+
+    def to_s
+      @dict.map do |key, value|
+        "- #{key}: #{value}"
+      end.join("\n")
+    end
+  end
+end

data/lib/pprof/output_formatter.rb

@@ -0,0 +1,119 @@
+module PProf
+  class OutputFormatter
+    # Initialize a new OutputFormatter
+    #
+    # @param [IO] output
+    #        The output destination where to print the formatted data.
+    #        Defaults to $stdout
+    #
+    def initialize(output = $stdout)
+      @output = output
+    end
+
+    # A small helper to print ASCII tables
+    class ASCIITable
+      def initialize(*widths)
+        @widths = widths
+      end
+
+      def row(*cols)
+        '| ' + cols.zip(@widths).map do |c,w|
+          (c || '<nil>').to_s.ljust(w)[0...w]
+        end.join(' | ') + ' |'
+      end
+
+      def separator
+        '+' + @widths.map { |w| '-' * (w+2) }.join('+') + '+' 
+      end
+    end
+
+    # Prints the description of a Provisioning Profile
+    #
+    # @param [PProf::ProvisioningProfile] profile
+    #        The ProvisioningProfile object to print
+    # @param [Hash<Symbol,Bool>] options
+    #        Decide what to print. Valid keys are :info, :certs and :devices
+    #
+    def print_info(profile, options = nil)
+      options ||= { :info => true }
+      if options[:info]
+        keys = [:name, :uuid, :app_id_name, :app_id_prefix, :creation_date, :expiration_date, :ttl, :team_ids, :team_name]
+        keys.each do |key|
+          @output.puts "- #{key.to_s}: #{profile.send(key.to_sym)}"
+        end
+        @output.puts "- Entitlements:"
+        @output.puts profile.entitlements.to_s.split("\n").map { |line| "   #{line}" }
+      end
+
+      if options[:info] || options[:certs] 
+        @output.puts "- #{profile.developer_certificates.count} Developer Certificates"
+        profile.developer_certificates.each { |cert| @output.puts "   - #{cert.subject}" } if options[:certs]
+      end
+      if options[:info] || options[:devices]
+        @output.puts "- #{(profile.provisioned_devices || []).count} Provisioned Devices"
+        profile.provisioned_devices.each { |udid| @output.puts "   - #{udid}" } if options[:devices]
+        @output.puts "- Provision all devices: #{profile.provisions_all_devices.inspect}"
+      end
+    end
+
+    # Prints the filtered list of Provisioning Profiles
+    #
+    # Convenience method. Calls self.print_list with a filter block build from a filter hash
+    #
+    # @param [Hash<Symbol,Any>] filters
+    #        The hash describing the applied filters
+    #
+    def print_filtered_list(dir = PProf::ProvisioningProfile::DEFAULT_DIR, filters = {})
+      print_list(dir) do |p|
+        (filters[:name].nil? || p.name =~ filters[:name]) &&
+        (filters[:appid_name].nil? || p.app_id_name =~ filters[:appid_name]) &&
+        (filters[:appid].nil? || p.entitlements.app_id =~ filters[:appid]) &&
+        (filters[:uuid].nil? || p.uuid =~ filters[:uuid]) &&
+        (filters[:exp].nil? || (p.expiration_date < DateTime.now) == filters[:exp]) &&
+        (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])) &&
+        true
+      end
+    end
+
+    # Prints the filtered list
+    #
+    # @param [String] dir
+    #        The directory containing the mobileprovision files to list.
+    #        Defaults to '~/Library/MobileDevice/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_list(dir = PProf::ProvisioningProfile::DEFAULT_DIR)
+      count = 0
+
+      table = PProf::OutputFormatter::ASCIITable.new(36, 60, 45, 25, 2, 10)
+      @output.puts table.separator
+      @output.puts table.row('UUID', 'Name', 'AppID', 'Expiration Date', ' ', 'Team Name')
+      @output.puts table.separator
+
+      Dir[dir + '/*.mobileprovision'].each do |file|
+        p = PProf::ProvisioningProfile.new(file)
+        
+        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)
+        count += 1
+      end
+
+      @output.puts table.separator
+      @output.puts "#{count} Provisioning Profiles found."
+    end
+
+    private
+    def self.match_aps_env(actual, expected)
+      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
+      return actual =~ expected        # true if Push present and we filter on specific env
+    end
+  end
+end

data/lib/pprof/provisioning_profile.rb

@@ -0,0 +1,103 @@
+require 'openssl'
+require 'plist'
+require 'time'
+
+module PProf
+  class ProvisioningProfile
+    DEFAULT_DIR="#{ENV['HOME']}/Library/MobileDevice/Provisioning Profiles"
+
+    def initialize(file)
+      if file =~ %r/^[0-9A-F-]*$/i
+        path = "#{PProf::ProvisioningProfile::DEFAULT_DIR}/#{file}.mobileprovision"
+      else
+        path = file
+      end
+      pkcs7 = OpenSSL::PKCS7.new(File.read(path))
+      pkcs7.verify([], OpenSSL::X509::Store.new)
+      @plist = Plist::parse_xml(pkcs7.data)
+    end
+
+    # @return [String]
+    def name
+      @plist['Name']
+    end
+
+    # @return [String]
+    def uuid
+      @plist['UUID']
+    end
+
+    # @return [String]
+    def app_id_name
+      @plist['AppIDName']
+    end
+
+    # @return [String]
+    def app_id_prefix
+      @plist['ApplicationIdentifierPrefix']
+    end
+
+    # @return [DateTime]
+    def creation_date
+      @plist['CreationDate']
+    end
+
+    # @return [DateTime]
+    def expiration_date
+      @plist['ExpirationDate']
+    end
+
+    # @return [Int]
+    def ttl
+      @plist['TimeToLive'].to_i
+    end
+
+    # @return [Array<String>]
+    def team_ids
+      @plist['TeamIdentifier']
+    end
+    
+    # @return [String]
+    def team_name
+      @plist['TeamName']
+    end
+
+    # @return [Array<OpenSSL::X509::Certificate>] List of certificates associated with this profile
+    def developer_certificates
+      @plist['DeveloperCertificates'].map do |data|
+        OpenSSL::X509::Certificate.new(data.string)
+      end
+    end
+
+    # @return [Entitlements] All the entitlements associated with this profile
+    def entitlements
+      PProf::Entitlements.new(@plist['Entitlements'])
+    end
+
+    # @return [Array<String>] List of provisioned devices if any
+    def provisioned_devices
+      @plist['ProvisionedDevices']
+    end
+
+    # @return [Bool]
+    def provisions_all_devices
+      @plist['ProvisionsAllDevices'] || false
+    end
+
+    def to_hash
+      @dict
+    end
+
+    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
+  end
+end

data/lib/pprof/version.rb

@@ -0,0 +1,3 @@
+module PProf
+  VERSION = '0.3.2'
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: pprof
+version: !ruby/object:Gem::Version
+  version: 0.3.2
+platform: ruby
+authors:
+- Olivier Halligon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: plist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: library and binary tool to manipulate Provisioning Profile files
+email: olivier@halligon.net
+executables:
+- pprof
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/pprof
+- lib/pprof.rb
+- lib/pprof/entitlements.rb
+- lib/pprof/output_formatter.rb
+- lib/pprof/provisioning_profile.rb
+- lib/pprof/version.rb
+homepage: http://rubygems.org/gems/pp
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.7
+signing_key: 
+specification_version: 4
+summary: A Provisioning Profiles library
+test_files: []