motion-sparkle-sandbox 0.8.0 → 2.1.0

data/lib/motion/project/appcast.rb

@@ -1,127 +1,200 @@
-module Motion::Project
-  class Sparkle
+# frozen_string_literal: true
+
+module Motion
+  module Project
+    class Sparkle
+      # Generate the appcast.
+      # Note: We do not support the old DSA keys, only the newer EdDSA keys.
+      #       See https://sparkle-project.org/documentation/eddsa-migration
+      # rubocop:disable Metrics/CyclomaticComplexity
+      def generate_appcast
+        generate_appcast_app = "#{vendored_sparkle_path}/bin/generate_appcast"
+        path = (project_path + archive_folder).realpath
+        appcast_filename = (path + appcast.feed_filename)
+
+        args = []
+
+        FileUtils.mkdir_p(path) unless File.exist?(path)
+
+        App.info('Sparkle', "Generating appcast using `#{generate_appcast_app}`")
+        puts "from files in `#{path}`...".indent(11)
+
+        if appcast.use_exported_private_key && File.exist?(private_key_path)
+          # -s <private-EdDSA-key>  The private EdDSA string (128 characters). If not
+          #                         specified, the private EdDSA key will be read from
+          #                         the Keychain instead.
+          private_key = File.read(private_key_path)
+          args << "-s=#{private_key}"
+        end
 
-    def create_release_notes
-      if File.exist?(release_notes_template_path)
-        File.open("#{release_notes_path}", "w") do |f|
-          template = File.read(release_notes_template_path)
-          f << ERB.new(template).result(binding)
+        # --download-url-prefix <url> A URL that will be used as prefix for the URL from
+        #                             where updates will be downloaded.
+        args << "--download-url-prefix=#{appcast.package_base_url}" if appcast.package_base_url.present?
+
+        # --release-notes-url-prefix <url> A URL that will be used as prefix for constructing
+        #                                  URLs for release notes.
+        args << "--release-notes-url-prefix=#{appcast.notes_base_url}" if appcast.notes_base_url.present?
+
+        # --link <link>           A URL to the application's website which Sparkle may
+        #                         use for directing users to if they cannot download a
+        #                         new update from within the application. This will be
+        #                         used for new generated update items. By default, no
+        #                         product link is used.
+
+        # --versions <versions>   An optional comma delimited list of application
+        #                         versions (specified by CFBundleVersion) to generate
+        #                         new update items for. By default, new update items
+        #                         are inferred from the available archives and are only
+        #                         generated if they are in the latest 5 updates in the
+        #                         appcast.
+
+        # --maximum-deltas <maximum-deltas>
+        #                         The maximum number of delta items to create for the
+        #                         latest update for each minimum required operating
+        #                         system. (default: 5)
+
+        # --channel <channel-name>
+        #                         The Sparkle channel name that will be used for
+        #                         generating new updates. By default, no channel is
+        #                         used. Old applications need to be using Sparkle 2 to
+        #                         use this feature.
+
+        # --major-version <major-version>
+        #                         The last major or minimum autoupdate sparkle:version
+        #                         that will be used for generating new updates. By
+        #                         default, no last major version is used.
+
+        # --phased-rollout-interval <phased-rollout-interval>
+        #                         The phased rollout interval in seconds that will be
+        #                         used for generating new updates. By default, no
+        #                         phased rollout interval is used.
+
+        # --critical-update-version <critical-update-version>
+        #                         The last critical update sparkle:version that will be
+        #                         used for generating new updates. An empty string
+        #                         argument will treat this update as critical coming
+        #                         from any application version. By default, no last
+        #                         critical update version is used. Old applications
+        #                         need to be using Sparkle 2 to use this feature.
+
+        # --informational-update-versions <informational-update-versions>
+        #                         A comma delimited list of application
+        #                         sparkle:version's that will see newly generated
+        #                         updates as being informational only. An empty string
+        #                         argument will treat this update as informational
+        #                         coming from any application version. By default,
+        #                         updates are not informational only. --link must also
+        #                         be provided. Old applications need to be using
+        #                         Sparkle 2 to use this feature.
+
+        # -o <output-path>        Path to filename for the generated appcast (allowed
+        #                         when only one will be created).
+
+        # -f <private-dsa-key-file> Path to the private DSA key file. Only use this
+        #                           option for transitioning to EdDSA from older updates.
+        # Note: only for supporting a legacy app that used DSA keys.  Check if the
+        # default DSA key exists in `sparkle/config/dsa_priv.pem` and if it does,
+        # add it to the command.
+        if File.exist?(legacy_private_key_path)
+          App.info 'Sparkle', "Also signing with legacy DSA key at #{legacy_private_key_path}"
+          args << "-f=#{legacy_private_key_path}"
         end
-        App.info 'Create', "./#{release_notes_path}"
-      else
-        App.fail "Release notes template not found as expected at ./#{release_notes_template_path}"
-      end
-    end
 
-    def create_appcast
-      create_release_folder
-      appcast_file = File.open("#{sparkle_release_path}/#{appcast.feed_filename}", 'w') do |f|
-        xml_string = ''
-        doc = REXML::Formatters::Pretty.new
-        doc.write(appcast_xml, xml_string)
-        f << "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n"
-        f << xml_string
-        f << "\n"
-      end
-      if appcast_file
-        App.info "Create", "./#{sparkle_release_path}/#{appcast.feed_filename}"
-      else
-        App.info "Fail", "./#{sparkle_release_path}/#{appcast.feed_filename} not created"
-      end
-    end
+        args << "-o=#{appcast_filename}" if appcast_filename.present?
 
-    def appcast_xml
-      rss = REXML::Element.new 'rss'
-      rss.attributes['xmlns:atom'] = "http://www.w3.org/2005/Atom"
-      rss.attributes['xmlns:sparkle'] = "http://www.andymatuschak.org/xml-namespaces/sparkle"
-      rss.attributes['xmlns:version'] = "2.0"
-      rss.attributes['xmlns:dc'] = "http://purl.org/dc/elements/1.1/"
-      channel = rss.add_element 'channel'
-      channel.add_element('title').text = @config.name
-      channel.add_element('description').text = "#{@config.name} updates"
-      channel.add_element('link').text = @config.info_plist["SUFeedURL"]
-      channel.add_element('language').text = 'en'
-      channel.add_element('pubDate').text = Time.now.strftime("%a, %d %b %Y %H:%M:%S %z")
-      atom_link = channel.add_element('atom:link')
-      atom_link.attributes['href'] = @config.info_plist["SUFeedURL"]
-      atom_link.attributes['rel'] = 'self'
-      atom_link.attributes['type'] = "application/rss+xml"
-      item = channel.add_element 'item'
-      item.add_element('title').text = "#{@config.name} #{@config.short_version}"
-      item.add_element('pubDate').text = Time.now.strftime("%a, %d %b %Y %H:%M:%S %z")
-      guid = item.add_element('guid')
-      guid.text = "#{@config.name}-#{@config.short_version}"
-      guid.attributes['isPermaLink'] = false
-      item.add_element('sparkle:releaseNotesLink').text = "#{appcast.notes_url}"
-      enclosure = item.add_element('enclosure')
-      enclosure.attributes['url'] = "#{appcast.package_url}"
-      enclosure.attributes['length'] = "#{@package_size}"
-      enclosure.attributes['type'] = "application/octet-stream"
-      enclosure.attributes['sparkle:version'] = @config.version
-      enclosure.attributes['sparkle:shortVersionString'] = @config.short_version
-      enclosure.attributes['sparkle:dsaSignature'] = @package_signature
-      rss
-    end
+        App.info 'Executing', [generate_appcast_app, *args, path.to_s].join(' ')
 
-    def release_notes_template_path
-      sparkle_config_path + "release_notes.template.erb"
-    end
+        results, status = Open3.capture2e(generate_appcast_app, *args, path.to_s)
 
-    def release_notes_content_path
-      sparkle_config_path + "release_notes.content.html"
-    end
+        App.info('Sparkle', "Saved appcast to `#{appcast_filename}`") if status.success?
+        puts results.indent(11)
 
-    def release_notes_path
-      sparkle_release_path + appcast.notes_filename.to_s
-    end
+        return unless status.success?
 
-    def release_notes_content
-      if File.exist?(release_notes_content_path)
-        File.read(release_notes_content_path)
-      else
-        App.fail "Missing #{release_notes_content_path}"
+        puts
+        puts "SUFeedURL     : #{feed_url}".indent(11)
+        puts "SUPublicEDKey : #{public_EdDSA_key}".indent(11)
       end
-    end
+      # rubocop:enable Metrics/CyclomaticComplexity
 
-    def release_notes_html
-      release_notes_content
-    end
+      def generate_appcast_help
+        generate_appcast_app = "#{vendored_sparkle_path}/bin/generate_appcast"
+        results, _status = Open3.capture2e(generate_appcast_app, '--help')
+        puts results
+      end
+
+      def create_release_notes
+        App.fail "Release notes template not found as expected at ./#{release_notes_template_path}" unless File.exist?(release_notes_template_path)
+
+        create_release_folder
 
+        File.open(release_notes_path.to_s, 'w') do |f|
+          template = File.read(release_notes_template_path)
+          f << ERB.new(template).result(binding)
+        end
 
-    class Appcast
-      attr_accessor :base_url,
-        :feed_base_url,
-        :feed_filename,
-        :notes_base_url, 
-        :notes_filename, 
-        :package_base_url,
-        :package_filename,
-        :archive_folder
-
-      def initialize
-        @feed_base_url = nil
-        @feed_filename = 'releases.xml'
-        @notes_base_url = nil
-        @notes_filename = 'release_notes.html'
-        @package_base_url = nil
-        @package_filename = nil
-        @base_url = nil
-        @archive_folder = nil
+        App.info 'Create', "./#{release_notes_path}"
       end
 
-      def feed_url
-        "#{feed_base_url || base_url}/#{feed_filename}"
+      def release_notes_template_path
+        sparkle_config_path.join('release_notes.template.erb')
       end
 
-      def notes_url
-        "#{notes_base_url || base_url}/#{notes_filename}"
+      def release_notes_content_path
+        sparkle_config_path.join('release_notes.content.html')
       end
 
-      def package_url
-        "#{package_base_url || base_url}/#{package_filename}"
+      def release_notes_path
+        sparkle_release_path + (appcast.notes_filename || "#{app_name}.#{@config.short_version}.html")
       end
 
-    end
+      def release_notes_content
+        if File.exist?(release_notes_content_path)
+          File.read(release_notes_content_path)
+        else
+          App.fail "Missing #{release_notes_content_path}"
+        end
+      end
+
+      def release_notes_html
+        release_notes_content
+      end
 
+      class Appcast
+        attr_accessor :base_url,
+                      :feed_base_url,
+                      :feed_filename,
+                      :notes_filename,
+                      :package_filename,
+                      :archive_folder,
+                      :use_exported_private_key
+        attr_writer   :notes_base_url,
+                      :package_base_url
+
+        def initialize
+          @feed_base_url = nil
+          @feed_filename = 'releases.xml'
+          @notes_base_url = nil
+          @notes_filename = nil
+          @package_base_url = nil
+          @package_filename = nil
+          @base_url = nil
+          @archive_folder = nil
+          @use_exported_private_key = false
+        end
+
+        def feed_url
+          "#{feed_base_url || base_url}#{feed_filename}"
+        end
+
+        def notes_base_url
+          @notes_base_url || base_url
+        end
+
+        def package_base_url
+          @package_base_url || base_url
+        end
+      end
+    end
   end
 end

data/lib/motion/project/indent_string.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# https://makandracards.com/makandra/6087-ruby-indent-a-string
+String.class_eval do
+  def indent(count, char = ' ', skip_first_line: false)
+    gsub(/([^\n]*)(\n|$)/) do |_match|
+      last_iteration = (Regexp.last_match(1) == '' && Regexp.last_match(2) == '')
+      line = String.new
+      line << (char * count) unless last_iteration || skip_first_line
+      line << Regexp.last_match(1)
+      line << Regexp.last_match(2)
+
+      skip_first_line = false
+
+      line
+    end
+  end
+end

data/lib/motion/project/install.rb

@@ -1,75 +1,31 @@
-module Motion::Project
-  class Sparkle
+# frozen_string_literal: true
 
-    SPARKLE_ZIP_FILE = 'Sparkle.zip'
-
-    def sparkle_distrib
-      file_path = Pathname.new File.dirname(__FILE__)
-      distrib_path = "vendor/#{SPARKLE_ZIP_FILE}"
-      (file_path.parent.parent.parent + distrib_path).to_s
-      Pathname.new(sparkle_vendor_path + SPARKLE_ZIP_FILE)
-    end
-
-    def sparkle_vendor_path
-      file_path = Pathname.new File.dirname(__FILE__)
-      (file_path.parent.parent.parent + 'vendor/').to_s
-    end
-
-    def sparkle_path
-      Pathname.new(vendor_path + 'Sparkle')
-    end
-
-    def sparkle_framework_path
-      Pathname.new(vendor_path + 'Sparkle/Sparkle.framework')
-    end
-
-    def sparkle_xpc_path
-      Pathname.new(vendor_path + 'Sparkle/XPCServices')
-    end
-
-    def sparkle_zipball
-      Pathname.new(vendor_path + SPARKLE_ZIP_FILE)
-    end
-
-    def copy_zipball
-      `cp #{sparkle_distrib} #{sparkle_zipball}`
-    end
-
-    def unzip
-      `unzip #{sparkle_zipball.to_s} -d #{vendor_path.to_s}`
-      `rm #{sparkle_zipball}`
-    end
-
-    def installed?
-      File.directory?(sparkle_framework_path)
-    end
+module Motion
+  module Project
+    class Sparkle
+      def vendored_sparkle_path
+        vendor_path.join('Pods/Sparkle')
+      end
 
-    def install
-      FileUtils.rm_rf(sparkle_path) if File.directory?(sparkle_path) # force clean install
-      copy_zipball
-      unzip
-    end
+      def vendored_sparkle_framework_path
+        vendored_sparkle_path.join('Sparkle.framework')
+      end
 
-    def embed
-      @config.embedded_frameworks << sparkle_framework_path
-    end
+      def vendored_sparkle_xpc_path
+        vendored_sparkle_path.join('XPCServices')
+      end
 
-    def install_and_embed
-      install unless installed?
-      embed
-    end
+      def installed?
+        File.directory?(vendored_sparkle_framework_path)
+      end
 
-    def verify_installation
-      if installed?
-        App.info "Sparkle", "Framework installed in #{sparkle_framework_path.to_s}"
-      else
-        App.fail "Sparkle framework not correctly copied to #{sparkle_framework_path.to_s}
-Run `rake sparkle:install` manually or, if the problem persists,
-please explain your setup and problem as an issue on GitHub at:
-https://github.com/digitalmoksha/motion-sparkle-sandbox/issues
-"
+      def verify_installation
+        if installed?
+          App.info 'Sparkle', "Framework installed in #{vendored_sparkle_framework_path}"
+        else
+          App.fail "Sparkle Cocoapod not correctly installed to #{vendored_sparkle_path}. Run `rake pod:install`."
+        end
       end
     end
-
   end
 end

data/lib/motion/project/package.rb

@@ -1,44 +1,60 @@
-module Motion::Project
-  class Sparkle
-
-    def package
-      return unless setup_ok?
-      create_release_folder
-      @config.build_mode = :release
-      return unless create_zip_file
-      App.info "Release", version_string
-      App.info "Version", @config.short_version
-      App.info "Build", @config.version || 'unspecified in Rakefile'
-      App.info "Size", @package_size.to_s
-      sign_package
-      create_appcast
-      create_release_notes
-      `open #{sparkle_release_path}`
-    end
+# frozen_string_literal: true
 
-    def create_zip_file
-      unless File.exist?(app_bundle_path)
-        App.fail "You need to build your app with the Release target to use Sparkle"
-      end
-      if File.exist?("#{sparkle_release_path}/#{zip_file}")
-        App.fail "Release already exists at ./#{sparkle_release_path}/#{zip_file} (remove it manually with `rake sparkle:clean`)"
+module Motion
+  module Project
+    class Sparkle
+      def package
+        return unless setup_ok?
+
+        create_release_folder
+        @config.build_mode = :release
+        return unless create_zip_file
+
+        App.info 'Release', version_string
+        App.info 'Version', @config.short_version
+        App.info 'Build', @config.version || 'unspecified in Rakefile'
+        App.info 'Size', @package_size.to_s
+
+        sign_package
+        create_release_notes
+
+        `open #{sparkle_release_path}`
       end
-      FileUtils.cd(app_release_path) do
-        `zip -r --symlinks "#{zip_file}" "#{app_file}"`
+
+      def create_zip_file
+        App.fail 'You need to build your app with the Release target to use Sparkle' unless File.exist?(app_bundle_path)
+
+        App.info 'Create', "./#{sparkle_release_path}/#{zip_file}"
+
+        if File.exist?("#{sparkle_release_path}/#{zip_file}")
+          App.fail "Release already exists at ./#{sparkle_release_path}/#{zip_file} (remove it manually with `rake sparkle:clean`)"
+        end
+
+        FileUtils.cd(app_release_path) do
+          `zip -r --symlinks "#{zip_file}" "#{app_file}"`
+        end
+
+        FileUtils.mv "#{app_release_path}/#{zip_file}", "./#{sparkle_release_path}/"
+
+        @package_file = zip_file
+        @package_size = File.size "./#{sparkle_release_path}/#{zip_file}"
       end
-      FileUtils.mv "#{app_release_path}/#{zip_file}", "./#{sparkle_release_path}/"
-      App.info "Create", "./#{sparkle_release_path}/#{zip_file}"
-      @package_file = zip_file
-      @package_size = File.size "./#{sparkle_release_path}/#{zip_file}"
-    end
 
-    def sign_package
-      package = "./#{sparkle_release_path}/#{zip_file}"
-      @package_signature = `#{openssl} dgst -sha1 -binary < "#{package}" | #{openssl} dgst -dss1 -sign "#{private_key_path}" | #{openssl} enc -base64`
-      @package_signature = @package_signature.strip
-      App.info "Signature", "\"#{@package_signature}\""
-    end
+      def sign_package
+        package = "./#{sparkle_release_path}/#{zip_file}"
+        sign_update_app = "#{vendored_sparkle_path}/bin/sign_update"
+        args = []
+
+        if appcast.use_exported_private_key && File.exist?(private_key_path)
+          # -s <private-key>        The private EdDSA (ed25519) key
+          private_key = File.read(private_key_path)
+          args << "-s=#{private_key}"
+        end
 
+        results, _status = Open3.capture2e(sign_update_app, *args, package)
 
+        App.info 'Signature', results
+      end
+    end
   end
 end

data/lib/motion/project/project.rb

@@ -1,67 +1,57 @@
-module Motion::Project
+# frozen_string_literal: true
 
-  class Config
-    variable :sparkle
+require 'open3'
 
-    def sparkle(&block)
-      @sparkle ||= Motion::Project::Sparkle.new(self)
-      if block
-        @sparkle.instance_eval &block
-      end
-      @sparkle
-    end
-  end
+module Motion
+  module Project
+    class Config
+      variable :sparkle
 
-  class App
-    class << self
-      def build_with_sparkle(platform, opts = {})
-        if App.config.sparkle.setup_ok?
-          App.info "Sparkle", "Setup OK"
-        else
-          exit 1
-        end
-        build_without_sparkle(platform, opts)
+      def sparkle(&block)
+        @sparkle ||= Motion::Project::Sparkle.new(self)
+        @sparkle.instance_eval(&block) if block
+        @sparkle
       end
-
-      alias_method "build_without_sparkle", "build"
-      alias_method "build", "build_with_sparkle"
     end
-  end
 
-  class Builder
-    # if we're using the sandboxed version of Sparkle, then we need to copy the
-    # xpc services to the proper folder and sign them.  This has to be done
-    # before we sign the app itself
-    #------------------------------------------------------------------------------
-    def codesign_with_sparkle(config, platform)
-      if App.config.embedded_frameworks.any? {|item| item.to_s.include?('Sparkle.framework')}
-        bundle_path = App.config.app_bundle('MacOSX')
+    class App
+      class << self
+        def build_with_sparkle(platform, opts = {})
+          App.fail 'Sparkle not setup correctly' unless App.config.sparkle.setup_ok?
 
-        if File.directory?(App.config.sparkle.sparkle_xpc_path)
-          App.info 'Sparkle', 'Removing unnecessary executables...'
-          sparkle_path = File.join(bundle_path, "Frameworks/Sparkle.framework")
-          ['Resources/Autoupdate', 'Resources/Updater.app'].each do |item|
-            bundle = File.join(sparkle_path, item)
-            FileUtils.rm_r(bundle) if File.exist?(bundle)
-          end
+          App.info 'Sparkle', 'Setup OK'
 
-          xpc_path = File.join(bundle_path, "XPCServices")
-          App.info 'Sparkle', "Copying XPCServices to #{xpc_path}"
+          build_without_sparkle(platform, opts)
+        end
 
-          FileUtils.mkdir_p(xpc_path)
-          `cp -R #{App.config.sparkle.sparkle_xpc_path}/*.xpc "#{xpc_path}"`
+        alias_method 'build_without_sparkle', 'build'
+        alias_method 'build', 'build_with_sparkle'
+      end
+    end
 
-          Dir.glob("#{xpc_path}/*.xpc").each do |path|
-            App.info 'Codesign', path
-            results = `#{App.config.sparkle.sparkle_vendor_path}/codesign_xpc "#{App.config.codesign_certificate}" "#{File.expand_path(path)}" 2>&1`
-          end
+    class Builder
+      # The XPC services are already residing in the Sparkle package.  But we need
+      # to re-sign the entire package to ensure all executables have the hardened
+      # runtime and correct certificate.
+      #------------------------------------------------------------------------------
+      def codesign_with_sparkle(config, platform)
+        if App.config.embedded_frameworks.any? { |item| item.to_s.include?('Sparkle.framework') }
+          bundle_path = App.config.app_bundle('MacOSX')
+          sparkle_path = File.join(bundle_path, 'Frameworks', 'Sparkle.framework')
+
+          `/usr/bin/codesign -f -s "#{config.codesign_certificate}" -o runtime "#{sparkle_path}/Versions/B/Autoupdate"`
+          `/usr/bin/codesign -f -s "#{config.codesign_certificate}" -o runtime "#{sparkle_path}/Versions/B/Updater.app"`
+          `/usr/bin/codesign -f -s "#{config.codesign_certificate}" -o runtime "#{sparkle_path}/Versions/B/XPCServices/org.sparkle-project.InstallerLauncher.xpc"`
+          `/usr/bin/codesign -f -s "#{config.codesign_certificate}" -o runtime --entitlements "./vendor/Pods/Sparkle/Entitlements/org.sparkle-project.Downloader.entitlements" "#{sparkle_path}/Versions/B/XPCServices/org.sparkle-project.Downloader.xpc"` # rubocop:disable Layout/LineLength
+
+          `/usr/bin/codesign -f -s "#{config.codesign_certificate}" -o runtime "#{sparkle_path}"`
         end
+
+        codesign_without_sparkle(config, platform)
       end
 
-      codesign_without_sparkle(config, platform)
+      alias_method 'codesign_without_sparkle', 'codesign'
+      alias_method 'codesign', 'codesign_with_sparkle'
     end
-
-    alias_method "codesign_without_sparkle", "codesign"
-    alias_method "codesign", "codesign_with_sparkle"
   end
 end