fastlane 1.111.0 → 2.0.1

data/match/lib/match/setup.rb

@@ -0,0 +1,20 @@
+module Match
+  class Setup
+    def run(path)
+      template = File.read("#{Match::ROOT}/lib/assets/MatchfileTemplate")
+
+      UI.important "Please create a new, private git repository"
+      UI.important "to store the certificates and profiles there"
+      url = UI.input("URL of the Git Repo: ")
+
+      template.gsub!("[[GIT_URL]]", url)
+      File.write(path, template)
+      UI.success "Successfully created '#{path}'. You can open the file using a code editor."
+
+      UI.important "You can now run `match development`, `match adhoc` and `match appstore`"
+      UI.message "On the first run for each environment it will create the provisioning profiles and"
+      UI.message "certificates for you. From then on, it will automatically import the existing profiles."
+      UI.message "For more information visit https://github.com/fastlane/fastlane/tree/master/match"
+    end
+  end
+end

data/match/lib/match/spaceship_ensure.rb

@@ -0,0 +1,78 @@
+module Match
+  # Ensures the certificate and profiles are also available on iTunes Connect
+  class SpaceshipEnsure
+    def initialize(user)
+      # We'll try to manually fetch the password
+      # to tell the user that a password is optional
+      require 'credentials_manager'
+
+      keychain_entry = CredentialsManager::AccountManager.new(user: user)
+
+      if keychain_entry.password(ask_if_missing: false).to_s.length == 0
+        UI.important("You can also run `match` in readonly mode to not require any access to the")
+        UI.important("Developer Portal. This way you only share the keys and credentials")
+        UI.command("match --readonly")
+        UI.important("More information https://github.com/fastlane/fastlane/tree/master/match#access-control")
+      end
+
+      UI.message("Verifying that the certificate and profile are still valid on the Dev Portal...")
+      Spaceship.login(user)
+      Spaceship.select_team
+    end
+
+    def bundle_identifier_exists(username: nil, app_identifier: nil)
+      found = Spaceship.app.find(app_identifier)
+      return if found
+
+      require 'sigh'
+      Sigh::Runner.new.print_produce_command({
+        username: username,
+        app_identifier: app_identifier
+      })
+      UI.error("An app with that bundle ID needs to exist in order to create a provisioning profile for it")
+      UI.error("================================================================")
+      available_apps = Spaceship.app.all.collect { |a| "#{a.bundle_id} (#{a.name})" }
+      UI.message("Available apps:\n- #{available_apps.join("\n- ")}")
+      UI.error("Make sure to run `match` with the same user and team every time.")
+      UI.user_error!("Couldn't find bundle identifier '#{app_identifier}' for the user '#{username}'")
+    end
+
+    def certificate_exists(username: nil, certificate_id: nil)
+      found = Spaceship.certificate.all.find do |cert|
+        cert.id == certificate_id
+      end
+      return if found
+
+      UI.error("Certificate '#{certificate_id}' (stored in your git repo) is not available on the Developer Portal")
+      UI.error("for the user #{username}")
+      UI.error("Make sure to use the same user and team every time you run 'match' for this")
+      UI.error("Git repository. This might be caused by revoking the certificate on the Dev Portal")
+      UI.user_error!("To reset the certificates of your Apple account, you can use the `match nuke` feature, more information on https://github.com/fastlane/fastlane/tree/master/match")
+    end
+
+    def profile_exists(username: nil, uuid: nil)
+      found = Spaceship.provisioning_profile.all.find do |profile|
+        profile.uuid == uuid
+      end
+
+      unless found
+        UI.error("Provisioning profile '#{uuid}' is not available on the Developer Portal")
+        UI.error("for the user #{username}")
+        UI.error("Make sure to use the same user and team every time you run 'match' for this")
+        UI.error("Git repository. This might be caused by deleting the provisioning profile on the Dev Portal")
+        UI.user_error!("To reset the provisioning profiles of your Apple account, you can use the `match nuke` feature, more information on https://github.com/fastlane/fastlane/tree/master/match")
+      end
+
+      if found.valid?
+        return found
+      else
+        UI.important("'#{found.name}' is available on the Developer Portal, however it's 'Invalid', fixing this now for you 🔨")
+        # it's easier to just create a new one, than to repair an existing profile
+        # it has the same effects anyway, including a new UUID of the provisioning profile
+        found.delete!
+        # return nil to re-download the new profile in runner.rb
+        return nil
+      end
+    end
+  end
+end

data/match/lib/match/table_printer.rb

@@ -0,0 +1,43 @@
+module Match
+  class TablePrinter
+    # logs public key's  name, user, organisation, country, availability dates
+    def self.print_certificate_info(cert_info: nil)
+      params = {
+        rows: cert_info,
+        title: "Installed Certificate".green
+      }
+
+      puts ""
+      puts Terminal::Table.new(params)
+      puts ""
+    rescue => ex
+      UI.error(ex)
+    end
+
+    def self.print_summary(app_identifier: nil, type: nil)
+      rows = []
+
+      type = type.to_sym
+
+      rows << ["App Identifier", "", app_identifier]
+      rows << ["Type", "", type]
+
+      {
+        Utils.environment_variable_name(app_identifier: app_identifier, type: type) => "Profile UUID",
+        Utils.environment_variable_name_profile_name(app_identifier: app_identifier, type: type) => "Profile Name",
+        Utils.environment_variable_name_team_id(app_identifier: app_identifier, type: type) => "Development Team ID"
+      }.each do |env_key, name|
+        rows << [name, env_key, ENV[env_key]]
+      end
+
+      params = {}
+      params[:rows] = rows
+      params[:title] = "Installed Provisioning Profile".green
+      params[:headings] = ['Parameter', 'Environment Variable', 'Value']
+
+      puts ""
+      puts Terminal::Table.new(params)
+      puts ""
+    end
+  end
+end

data/match/lib/match/utils.rb

@@ -0,0 +1,59 @@
+module Match
+  class Utils
+    def self.import(item_path, keychain, password: "")
+      keychain_path = FastlaneCore::Helper.keychain_path(keychain)
+      FastlaneCore::KeychainImporter.import_file(item_path, keychain_path, keychain_password: password, output: $verbose)
+    end
+
+    # Fill in an environment variable, ready to be used in _xcodebuild_
+    def self.fill_environment(key, value)
+      UI.important "Setting environment variable '#{key}' to '#{value}'" if $verbose
+      ENV[key] = value
+    end
+
+    def self.environment_variable_name(app_identifier: nil, type: nil)
+      base_environment_variable_name(app_identifier: app_identifier, type: type).join("_")
+    end
+
+    def self.environment_variable_name_team_id(app_identifier: nil, type: nil)
+      (base_environment_variable_name(app_identifier: app_identifier, type: type) + ["team-id"]).join("_")
+    end
+
+    def self.environment_variable_name_profile_name(app_identifier: nil, type: nil)
+      (base_environment_variable_name(app_identifier: app_identifier, type: type) + ["profile-name"]).join("_")
+    end
+
+    def self.get_cert_info(cer_certificate_path)
+      command = "openssl x509 -inform der -in #{cer_certificate_path.shellescape} -subject -dates -noout"
+      command << " &" # start in separate process
+      output = Helper.backticks(command, print: $verbose)
+
+      # openssl output:
+      # subject= /UID={User ID}/CN={Certificate Name}/OU={Certificate User}/O={Organisation}/C={Country}\n
+      # notBefore={Start datetime}\n
+      # notAfter={End datetime}
+      cert_info = output.gsub(/\s*subject=\s*/, "").tr("/", "\n")
+      out_array = cert_info.split("\n")
+      openssl_keys_to_readable_keys = {
+           'UID' => 'User ID',
+           'CN' => 'Common Name',
+           'OU' => 'Organisation Unit',
+           'O' => 'Organisation',
+           'C' => 'Country',
+           'notBefore' => 'Start Datetime',
+           'notAfter' => 'End Datetime'
+       }
+
+      return out_array.map { |x| x.split(/=+/) if x.include? "=" }
+                      .compact
+                      .map { |k, v| [openssl_keys_to_readable_keys.fetch(k, k), v] }
+    rescue => ex
+      UI.error(ex)
+      return {}
+    end
+
+    def self.base_environment_variable_name(app_identifier: nil, type: nil)
+      ["sigh", app_identifier, type]
+    end
+  end
+end

data/pem/README.md

@@ -0,0 +1,175 @@
+<h3 align="center">
+  <a href="https://github.com/fastlane/fastlane/tree/master/fastlane">
+    <img src="../fastlane/assets/fastlane.png" width="150" />
+    <br />
+    fastlane
+  </a>
+</h3>
+<p align="center">
+  <a href="https://github.com/fastlane/fastlane/tree/master/deliver">deliver</a> &bull;
+  <a href="https://github.com/fastlane/fastlane/tree/master/snapshot">snapshot</a> &bull;
+  <a href="https://github.com/fastlane/fastlane/tree/master/frameit">frameit</a> &bull;
+  <b>pem</b> &bull;
+  <a href="https://github.com/fastlane/fastlane/tree/master/sigh">sigh</a> &bull;
+  <a href="https://github.com/fastlane/fastlane/tree/master/produce">produce</a> &bull;
+  <a href="https://github.com/fastlane/fastlane/tree/master/cert">cert</a> &bull;
+  <a href="https://github.com/fastlane/fastlane/tree/master/spaceship">spaceship</a> &bull;
+  <a href="https://github.com/fastlane/fastlane/tree/master/pilot">pilot</a> &bull;
+  <a href="https://github.com/fastlane/boarding">boarding</a> &bull;
+  <a href="https://github.com/fastlane/fastlane/tree/master/gym">gym</a> &bull;
+  <a href="https://github.com/fastlane/fastlane/tree/master/scan">scan</a> &bull;
+  <a href="https://github.com/fastlane/fastlane/tree/master/match">match</a>
+</p>
+-------
+
+<p align="center">
+  <img src="assets/pem.png" height="110">
+</p>
+
+pem
+============
+
+[![Twitter: @FastlaneTools](https://img.shields.io/badge/contact-@FastlaneTools-blue.svg?style=flat)](https://twitter.com/FastlaneTools)
+[![License](https://img.shields.io/badge/license-MIT-green.svg?style=flat)](https://github.com/fastlane/fastlane/blob/master/pem/LICENSE)
+[![Gem](https://img.shields.io/gem/v/pem.svg?style=flat)](http://rubygems.org/gems/pem)
+
+###### Automatically generate and renew your push notification profiles
+
+Tired of manually creating and maintaining your push notification profiles for your iOS apps? Tired of generating a `pem` file for your server?
+
+`pem` does all that for, just by simply running `pem`.
+
+`pem` creates new .pem, .cer, and .p12 files to be uploaded to your push server if a valid push notification profile is needed. `pem` does not cover uploading the file to your server.
+
+To automate iOS Provisioning profiles you can use [sigh](https://github.com/fastlane/fastlane/tree/master/sigh).
+
+Get in contact with the developer on Twitter: [@FastlaneTools](https://twitter.com/FastlaneTools)
+
+-------
+<p align="center">
+    <a href="#features">Features</a> &bull;
+    <a href="#installation">Installation</a> &bull;
+    <a href="#usage">Usage</a> &bull;
+    <a href="#how-does-it-work">How does it work?</a> &bull;
+    <a href="#tips">Tips</a> &bull;
+    <a href="#need-help">Need help?</a>
+</p>
+
+-------
+
+<h5 align="center"><code>pem</code> is part of <a href="https://fastlane.tools">fastlane</a>: The easiest way to automate beta deployments and releases for your iOS and Android apps.</h5>
+
+# Features
+Well, it's actually just one: Generate the ```pem``` file for your server.
+
+
+Check out this gif:
+
+![assets/PEMRecording.gif](assets/PEMRecording.gif)
+
+# Installation
+    sudo gem install fastlane
+
+Make sure, you have the latest version of the Xcode command line tools installed:
+
+    xcode-select --install
+
+# Usage
+
+    fastlane pem
+
+Yes, that's the whole command!
+
+This does the following:
+
+- Create a new signing request
+- Create a new push certification
+- Downloads the certificate
+- Generates a new ```.pem``` file in the current working directory, which you can upload to your server
+
+```pem``` will never revoke your existing certificates.
+
+If you already have a push certificate enabled, which is active for at least 30 more days, `pem` will not create a new certificate. If you still want to create one, use the `force`:
+
+    fastlane pem --force
+
+You can pass parameters like this:
+
+    fastlane pem -a com.krausefx.app -u username
+
+If you want to generate a development certificate instead:
+
+    fastlane pem --development
+
+Set a password for your `p12` file:
+
+    fastlane pem -p "MyPass"
+
+You can specify a name for the output file:
+
+    fastlane pem -o my.pem
+
+To get a list of available options run:
+
+    fastlane pem --help
+
+
+### Note about empty `p12` passwords and Keychain Access.app
+
+`pem` will produce a valid `p12` without specifying a password, or using the empty-string as the password.
+While the file is valid, Mac OSX's Keychain Access will not allow you to open the file without specifying a passphrase.
+
+Instead, you may verify the file is valid using OpenSSL:
+
+    openssl pkcs12 -info -in my.p12
+
+##### [Like this tool? Be the first to know about updates and new fastlane tools](https://tinyletter.com/krausefx)
+
+## Environment Variables
+
+Run `fastlane pem --help` to get a list of available environment variables.
+
+# How does it work?
+
+`pem` uses [spaceship](https://spaceship.airforce) to communicate with the Apple Developer Portal to request a new push certificate for you.
+
+## How is my password stored?
+```pem``` uses the [password manager](https://github.com/fastlane/fastlane/tree/master/credentials_manager) from `fastlane`. Take a look the [CredentialsManager README](https://github.com/fastlane/fastlane/tree/master/credentials_manager) for more information.
+
+# Tips
+
+## [`fastlane`](https://fastlane.tools) Toolchain
+
+- [`fastlane`](https://fastlane.tools): The easiest way to automate beta deployments and releases for your iOS and Android apps
+- [`deliver`](https://github.com/fastlane/fastlane/tree/master/deliver): Upload screenshots, metadata and your app to the App Store
+- [`snapshot`](https://github.com/fastlane/fastlane/tree/master/snapshot): Automate taking localized screenshots of your iOS app on every device
+- [`frameit`](https://github.com/fastlane/fastlane/tree/master/frameit): Quickly put your screenshots into the right device frames
+- [`sigh`](https://github.com/fastlane/fastlane/tree/master/sigh): Because you would rather spend your time building stuff than fighting provisioning
+- [`produce`](https://github.com/fastlane/fastlane/tree/master/produce): Create new iOS apps on iTunes Connect and Dev Portal using the command line
+- [`cert`](https://github.com/fastlane/fastlane/tree/master/cert): Automatically create and maintain iOS code signing certificates
+- [`spaceship`](https://github.com/fastlane/fastlane/tree/master/spaceship): Ruby library to access the Apple Dev Center and iTunes Connect
+- [`pilot`](https://github.com/fastlane/fastlane/tree/master/pilot): The best way to manage your TestFlight testers and builds from your terminal
+- [`boarding`](https://github.com/fastlane/boarding): The easiest way to invite your TestFlight beta testers
+- [`gym`](https://github.com/fastlane/fastlane/tree/master/gym): Building your iOS app has never been easier
+- [`scan`](https://github.com/fastlane/fastlane/tree/master/scan): The easiest way to run tests of your iOS and Mac app
+- [`match`](https://github.com/fastlane/fastlane/tree/master/match): Easily sync your certificates and profiles across your team using git
+
+##### [Like this tool? Be the first to know about updates and new fastlane tools](https://tinyletter.com/krausefx)
+
+## Use the 'Provisioning Quicklook plugin'
+Download and install the [Provisioning Plugin](https://github.com/chockenberry/Provisioning).
+
+It will show you the ```pem``` files like this:
+![assets/QuickLookScreenshot.png](assets/QuickLookScreenshot.png)
+
+
+# Need help?
+Please submit an issue on GitHub and provide information about your setup
+
+# Code of Conduct
+Help us keep `pem` open and inclusive. Please read and follow our [Code of Conduct](https://github.com/fastlane/fastlane/blob/master/CODE_OF_CONDUCT.md).
+
+# License
+This project is licensed under the terms of the MIT license. See the LICENSE file.
+
+> This project and all fastlane tools are in no way affiliated with Apple Inc. This project is open source under the MIT license, which means you have full access to the source code and can modify it to fit your own needs. All fastlane tools run on your own computer or server, so your credentials or other sensitive information will never leave your own computer. You are responsible for how you use fastlane tools.

data/pem/lib/pem.rb

@@ -0,0 +1,21 @@
+require 'pem/manager'
+require 'pem/options'
+
+require 'fastlane_core'
+
+module PEM
+  # Use this to just setup the configuration attribute and set it later somewhere else
+  class << self
+    attr_accessor :config
+  end
+
+  TMP_FOLDER = "/tmp/PEM/"
+  FileUtils.mkdir_p TMP_FOLDER
+
+  ENV['FASTLANE_TEAM_ID'] ||= ENV["PEM_TEAM_ID"]
+  ENV['DELIVER_USER'] ||= ENV["PEM_USERNAME"]
+
+  Helper = FastlaneCore::Helper # you gotta love Ruby: Helper.* should use the Helper class contained in FastlaneCore
+  UI = FastlaneCore::UI
+  ROOT = Pathname.new(File.expand_path('../..', __FILE__))
+end

data/pem/lib/pem/commands_generator.rb

@@ -0,0 +1,41 @@
+require 'commander'
+
+HighLine.track_eof = false
+
+module PEM
+  class CommandsGenerator
+    include Commander::Methods
+
+    def self.start
+      self.new.run
+    end
+
+    def run
+      program :name, 'pem'
+      program :version, Fastlane::VERSION
+      program :description, 'CLI for \'PEM\' - Automatically generate and renew your push notification profiles'
+      program :help, 'Author', 'Felix Krause <pem@krausefx.com>'
+      program :help, 'Website', 'https://fastlane.tools'
+      program :help, 'GitHub', 'https://github.com/fastlane/PEM'
+      program :help_formatter, :compact
+
+      global_option('--verbose') { $verbose = true }
+
+      FastlaneCore::CommanderGenerator.new.generate(PEM::Options.available_options)
+
+      command :renew do |c|
+        c.syntax = 'pem renew'
+        c.description = 'Renews the certificate (in case it expired) and shows the path to the generated pem file'
+
+        c.action do |args, options|
+          PEM.config = FastlaneCore::Configuration.create(PEM::Options.available_options, options.__hash__)
+          PEM::Manager.start
+        end
+      end
+
+      default_command :renew
+
+      run!
+    end
+  end
+end

data/pem/lib/pem/manager.rb

@@ -0,0 +1,93 @@
+require 'pathname'
+require 'spaceship'
+
+module PEM
+  # Creates the push profile and stores it in the correct location
+  class Manager
+    class << self
+      def start
+        FastlaneCore::PrintTable.print_values(config: PEM.config, hide_keys: [:new_profile], title: "Summary for PEM #{Fastlane::VERSION}")
+        login
+
+        existing_certificate = certificate.all.detect do |c|
+          c.name == PEM.config[:app_identifier]
+        end
+
+        if existing_certificate
+          remaining_days = (existing_certificate.expires - Time.now) / 60 / 60 / 24
+          UI.message "Existing push notification profile '#{existing_certificate.owner_name}' is valid for #{remaining_days.round} more days."
+          if remaining_days > 30
+            if PEM.config[:force]
+              UI.success "You already have an existing push certificate, but a new one will be created since the --force option has been set."
+            else
+              UI.success "You already have a push certificate, which is active for more than 30 more days. No need to create a new one"
+              UI.success "If you still want to create a new one, use the --force option when running PEM."
+              return false
+            end
+          end
+        end
+
+        return create_certificate
+      end
+
+      def login
+        UI.message "Starting login with user '#{PEM.config[:username]}'"
+        Spaceship.login(PEM.config[:username], nil)
+        Spaceship.client.select_team
+        UI.message "Successfully logged in"
+      end
+
+      def create_certificate
+        UI.important "Creating a new push certificate for app '#{PEM.config[:app_identifier]}'."
+
+        csr, pkey = Spaceship.certificate.create_certificate_signing_request
+
+        begin
+          cert = certificate.create!(csr: csr, bundle_id: PEM.config[:app_identifier])
+        rescue => ex
+          if ex.to_s.include? "You already have a current"
+            # That's the most common failure probably
+            UI.message ex.to_s
+            UI.user_error!("You already have 2 active push profiles for this application/environment. You'll need to revoke an old certificate to make room for a new one")
+          else
+            raise ex
+          end
+        end
+
+        x509_certificate = cert.download
+        certificate_type = (PEM.config[:development] ? 'development' : 'production')
+        filename_base = PEM.config[:pem_name] || "#{certificate_type}_#{PEM.config[:app_identifier]}"
+        filename_base = File.basename(filename_base, ".pem") # strip off the .pem if it was provided.
+
+        output_path = PEM.config[:output_path]
+        FileUtils.mkdir_p(File.expand_path(output_path))
+
+        if PEM.config[:save_private_key]
+          private_key_path = File.join(output_path, "#{filename_base}.pkey")
+          File.write(private_key_path, pkey.to_pem)
+          UI.message("Private key: ".green + Pathname.new(private_key_path).realpath.to_s)
+        end
+
+        if PEM.config[:generate_p12]
+          p12_cert_path = File.join(output_path, "#{filename_base}.p12")
+          p12 = OpenSSL::PKCS12.create(PEM.config[:p12_password], certificate_type, pkey, x509_certificate)
+          File.write(p12_cert_path, p12.to_der)
+          UI.message("p12 certificate: ".green + Pathname.new(p12_cert_path).realpath.to_s)
+        end
+
+        x509_cert_path = File.join(output_path, "#{filename_base}.pem")
+        File.write(x509_cert_path, x509_certificate.to_pem + pkey.to_pem)
+        UI.message("PEM: ".green + Pathname.new(x509_cert_path).realpath.to_s)
+        return x509_cert_path
+      end
+
+      def certificate
+        if PEM.config[:development]
+          Spaceship.certificate.development_push
+        else
+          Spaceship.certificate.production_push
+        end
+      end
+    end
+  end
+end