netfira-installer-generator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bee147204dd4460b4bcf0834bc98afdc95b636b9
+  data.tar.gz: 2c580bb0b62fd6259a62dc0c2d085a37a18d1957
+SHA512:
+  metadata.gz: 4c3b48fafe6632d6088b694dce95aa4f0bf234109a299221fe65c129d4ee224533d84bc0e3b36b7b888463b2597a886d8ae2e1b2c958d33b5fc66f2962c7d42f
+  data.tar.gz: 03dd5bf1168791d6f151165d2b5f951d1de790d167ba32222379e6e5c6733d850e5444dd19345d38c4f52b9169dd1ac8d0a3c49fcb313404d2168d0fe2de6e14

data/README.md

@@ -0,0 +1 @@
+TODO

data/bin/make_nf_installer

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require_relative '../lib/netfira-installer-generator.rb'
+Netfira::InstallerGenerator::Cli.main

data/lib/netfira-installer-generator.rb

@@ -0,0 +1,8 @@
+require 'pathname'
+require_relative 'netfira/installer_generator'
+
+module Netfira
+  class InstallerGenerator
+    GEM_ROOT = Pathname(__FILE__).parent.parent
+  end
+end

data/lib/netfira/installer_generator.rb

@@ -0,0 +1,130 @@
+require_relative 'installer_generator/version'
+require_relative 'installer_generator/nsis_template'
+require_relative 'installer_generator/binary'
+require_relative 'installer_generator/exception'
+require_relative 'installer_generator/cli'
+
+require 'uri'
+require 'fileutils'
+require 'tmpdir'
+require 'securerandom'
+require 'pathname'
+
+module Netfira
+  class InstallerGenerator
+    include FileUtils
+
+    def self.preflight!
+      [Binary::Makensis, Binary::Signcode].each do |klass|
+        raise "No binaries available from [ #{klass.bin_files.join ' | '} ]" unless klass.available?
+      end
+    end
+
+    # Because the writers are created en masse:
+    # noinspection RubyResolve
+    attr_reader :icon, :source, :signing_cert, :signing_key
+
+    attr_accessor :target, :shop_id, :shop_url, :sync_url, :use_ssl,
+                  :installer_name, :installer_filename, :temp_dir, :auth_server,
+                  :signing_description, :signing_url,
+                  :output_device
+
+    REQUIRED_VALUES = %i[shop_id shop_url sync_url icon source signing_cert signing_key target]
+
+    def initialize
+      self.output_device = :null
+      self.use_ssl = true
+      self.installer_name = 'Netfira Installer'
+      self.installer_filename = 'netfira_dlm.exe'
+      self.temp_dir = 'netfireb'
+      self.auth_server = 'auth.netfira.biz'
+    end
+
+    {   icon: 'Icon',
+        source: 'Source executable',
+        signing_cert: 'Signing certificate',
+        signing_key: 'Signing private key'
+
+    }.each do |method, description|
+      define_method :"#{method}=" do |path|
+        raise "#{description} not found at #{path}" unless File.exist? path
+        instance_variable_set :"@#{method}", path
+      end
+    end
+
+    def generate!
+
+      # Ensure we have all our binary friends
+      self.class.preflight!
+
+      # Ensure we have no missing required values
+      missing = REQUIRED_VALUES.select { |key| send(key).nil? }
+      raise Exception, "Missing value(s) for #{missing.join ', '}" unless missing.empty?
+
+      # Make a temporary build dir
+      build_dir = Pathname(Dir.tmpdir) + SecureRandom.uuid
+      mkdir build_dir
+
+      begin
+
+        # Copy the source exe and icon to the build dir
+        cp icon, build_dir + 'setup.ico'
+        cp source, build_dir + installer_filename
+
+        # Write the NSIS script to the build dir
+        File.write build_dir + 'nsis_script.nsi', render_nsis_template
+
+        # Run makensis
+        makensis build_dir or raise Exception, 'makensis failed'
+
+        # Run signcode
+        signcode build_dir or raise Exception, 'signcode failed'
+
+        # Write target file
+        mkdir_p File.dirname(target)
+        mv build_dir + 'signed.exe', target
+
+      ensure
+        rm_rf build_dir
+      end
+
+    end
+
+    private
+
+    def render_nsis_template
+      # noinspection RubyStringKeysInHashInspection
+      values = {
+          'INSTALLER_NAME' => installer_name,
+          'TEMP_DIR' => temp_dir,
+          'INSTALLER_FILENAME' => installer_filename,
+          'WHO_AM_I_GUID' => shop_id,
+          'AUTHENTICATION_SERVER_1' => auth_server,
+          'WEBSTORE_SYNC_URL' => sync_url,
+          'WEBSTORE_FRONT_URL' => shop_url,
+          'SHOP_ADDRESS' => URI.parse(shop_url).host,
+          'NO_USE_SSL' => use_ssl ? '0' : '1'
+      }
+      NsisTemplate.sub values
+    end
+
+    def makensis(build_dir)
+      b = Binary::Makensis.new
+      b.template_file_name = 'nsis_script.nsi'
+      b.build_dir = build_dir
+      b.run output_device
+    end
+
+    def signcode(build_dir)
+      b = Binary::Signcode.new
+      b.spc_path = signing_cert
+      b.key_path = signing_key
+      b.url = signing_url || shop_url
+      b.description = signing_description || installer_name
+      b.source_path = build_dir + 'nsis_generated.exe'
+      b.target_path = build_dir + 'signed.exe'
+      b.run output_device
+    end
+
+  end
+end

data/lib/netfira/installer_generator/binary.rb

@@ -0,0 +1,28 @@
+require 'shellwords'
+
+module Netfira
+  class InstallerGenerator
+    class Binary
+
+      def self.available?
+        @available = !bin_file.nil?
+      end
+
+      def self.bin_file
+        @bin_file = bin_files.select{ |file| system "which #{file} > /dev/null" }.first
+      end
+
+      def run(output_device = :null)
+        system "#{command} > /dev/#{output_device}"
+      end
+
+      def esc(string)
+        Shellwords.escape string
+      end
+
+    end
+  end
+end
+
+require_relative 'binary/makensis'
+require_relative 'binary/signcode'

data/lib/netfira/installer_generator/binary/makensis.rb

@@ -0,0 +1,15 @@
+require 'shellwords'
+
+class Netfira::InstallerGenerator
+  class Binary::Makensis < Binary
+
+    def self.bin_files; %w[makensis] end
+
+    attr_accessor :build_dir, :template_file_name
+
+    def command
+      "cd #{esc build_dir}; makensis #{esc template_file_name}"
+    end
+
+  end
+end

data/lib/netfira/installer_generator/binary/signcode.rb

@@ -0,0 +1,54 @@
+class Netfira::InstallerGenerator
+  class Binary::Signcode < Binary
+
+    def self.bin_files; %w[osslsigncode signcode] end
+
+    attr_accessor :spc_path, :key_path, :description, :url, :source_path, :target_path
+
+    def command
+      send :"#{self.class.bin_file}_cmd"
+    end
+
+    private
+
+    # See http://development.adaptris.net/users/lchan/blog/2013/06/07/signing-windows-installers-on-linux/
+
+    def osslsigncode_cmd
+      parts = [
+          'osslsigncode',
+          '-spc', esc(spc_path),
+          '-key', esc(key_path),
+          '-n', esc(description || 'Netfira'),
+          '-i', esc(url || 'http://netfira.com'),
+          '-t http://timestamp.verisign.com/scripts/timstamp.dll',
+          '-in', esc(source_path),
+          '-out', esc(target_path)
+      ]
+      parts.join ' '
+    end
+
+    # From Amel's rendition:
+    # $signCommand = "signcode -spc {$certFileBase}authenticode.spc -v {$certFileBase}authenticode.pvk -a sha1 -$ commercial -n Netfira ";
+    # $signCommand .= "-i http://netfira.com -t http://timestamp.verisign.com/scripts/timstamp.dll -tr 10 ".$fileName;
+    #
+    # See http://manpages.ubuntu.com/manpages/precise/man1/signcode.1.html
+
+    def signcode_cmd
+      parts = [
+          'cp', esc(source_path), esc(target_path), '&&',
+          'signcode',
+          '-spc', esc(spc_path),
+          '-v', esc(key_path),
+          '-a sha1',                # Hash algorithm
+          '-$ commercial',          # Publisher information
+          '-n', esc(description || 'Netfira'),
+          '-i', esc(url || 'http://netfira.com'),
+          '-t http://timestamp.verisign.com/scripts/timstamp.dll',
+          '-tr 3 -tw 5',            # Try timestamping 3 times, 5 seconds apart
+          esc(target_path)
+      ]
+      parts.join ' '
+    end
+
+  end
+end

data/lib/netfira/installer_generator/cli.rb

@@ -0,0 +1,53 @@
+require 'optparse'
+
+module Netfira
+  class InstallerGenerator
+    module Cli
+      class << self
+
+        def main
+
+          generator = InstallerGenerator.new
+          generator.output_device = :stdout
+
+          option_parser = OptionParser.new do |opts|
+
+            opts.separator "\nInput/Output"
+
+            opts.on('-s', '--source [PATH]', 'Source EXE file') { |path| generator.source = path }
+            opts.on('-t', '--target [PATH]', 'The EXE file to write') { |path| generator.target = path }
+            opts.on('-i', '--icon [PATH]', 'The icon file to use for the generated installer') { |path| generator.icon = path }
+
+            opts.separator "\nSigning"
+
+            opts.on('-c', '--cert [PATH]', 'Signing certificate path') { |path| generator.signing_cert = path }
+            opts.on('-k', '--key [PATH]', 'Signing certificate private key path') { |path| generator.signing_key = path }
+            opts.on('-d', '--desc [TEXT]', 'Signing description') { |text| generator.signing_description = text }
+            opts.on('-r', '--url [URL]', 'Signing URL') { |url| generator.signing_url = url }
+
+            opts.separator "\nConfiguration"
+
+            opts.on('-n', '--name [TEXT]', 'Installer name') { |text| generator.installer_name = text }
+            opts.on('-x', '--temp-file [NAME]', 'Temporary installer filename') { |name| generator.installer_filename = name }
+            opts.on('-u', '--shop-id [VALUE]', 'Shop ID') { |id| generator.shop_id = id }
+            opts.on('-f', '--shop-url [URL]', 'Shop URL') { |url| generator.shop_url = url }
+            opts.on('-b', '--sync-url [URL]', 'Sync URL') { |url| generator.sync_url = url }
+            opts.on('-a', '--auth-server [URL]', 'Authentication server') { |url| generator.auth_server = url }
+            opts.on('-e', '--temp-dir [DIR]', 'Temporary installation directory') { |dir| generator.temp_dir = dir }
+
+          end
+
+          begin
+            option_parser.parse!
+            generator.generate!
+            puts "Wrote #{generator.target}"
+          rescue => exception
+            puts "#{exception.message}\n\n#{option_parser}"
+          end
+
+        end
+
+      end
+    end
+  end
+end

data/lib/netfira/installer_generator/exception.rb

@@ -0,0 +1,7 @@
+module Netfira
+  class InstallerGenerator
+    class Exception < RuntimeError
+
+    end
+  end
+end

data/lib/netfira/installer_generator/nsis_template.rb

@@ -0,0 +1,74 @@
+module Netfira
+  class InstallerGenerator
+    module NsisTemplate
+
+      def self.sub(variables)
+        template.gsub(/\{([A-Z][_A-Z]*)\}/) { variables[$1] }
+      end
+
+      private
+
+      def self.template
+        @template ||= <<-__EOF__
+; This script creates the bootstrap installer for the Netfira download manager.
+
+;--------------------------------
+; No output from this bootstrap installer:
+SilentInstall silent
+
+; The name of the installer
+Name "{INSTALLER_NAME}"
+Icon setup.ico
+
+; The file to write
+OutFile "nsis_generated.exe"
+
+; The default installation directory
+InstallDir $TEMP\{TEMP_DIR}
+
+; The stuff to install
+Section ""
+
+  ; Set output path to the installation directory.
+  SetOutPath $INSTDIR
+
+  ; Put file Netfira download manager in the temp directory
+  File {INSTALLER_FILENAME}
+
+  ; WhoAmIGUID
+  ReadRegStr $1 HKLM "Software\Netfire\AMIPS" "WhoAmIGUID"
+
+  ; if the registry value is empty - set it, otherwise continue
+  StrCmp $1 "" 0 +2
+    WriteRegStr HKLM "Software\Netfire\AMIPS" "WhoAmIGUID" "{WHO_AM_I_GUID}"
+
+  ; AuthenticationServer1
+  ReadRegStr $1 HKLM "Software\Netfire\AMIPS" "AuthenticationServer1"
+
+  ; if the registry value is empty - set it, otherwise continue
+  StrCmp $1 "" 0 +2
+  	WriteRegStr HKLM "Software\Netfire\AMIPS" "AuthenticationServer1" "{AUTHENTICATION_SERVER_1}"
+
+  ; Webstore
+  ReadRegStr $1 HKLM "Software\Netfire\Webstore" "SyncURL"
+
+  ; if the registry value is empty - set it, otherwise continue
+  StrCmp $1 "" 0 +2
+  	WriteRegStr HKLM "Software\Netfire\Webstore" "SyncURL" "{WEBSTORE_SYNC_URL}"
+  StrCmp $1 "" 0 +2
+  	WriteRegStr HKLM "Software\Netfire\Webstore" "StoreFrontURL" "{WEBSTORE_FRONT_URL}"
+  StrCmp $1 "" 0 +2
+    WriteRegStr HKLM "Software\Netfire\Webstore" "Server" "{SHOP_ADDRESS}"
+  StrCmp $1 "" 0 +2
+    WriteRegStr HKLM "Software\Netfire\Networking" "NoUseSsl" "{NO_USE_SSL}"
+
+  ; Execute the download manager:
+  Exec '"$INSTDIR\{INSTALLER_FILENAME}"'
+
+SectionEnd
+        __EOF__
+      end
+
+    end
+  end
+end

data/lib/netfira/installer_generator/version.rb

@@ -0,0 +1,5 @@
+module Netfira
+  class InstallerGenerator
+    VERSION = '0.1.0'
+  end
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: netfira-installer-generator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Neil E. Pearson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-23 00:00:00.000000000 Z
+dependencies: []
+description: Netfira Windows App Installer Generator
+email:
+- neil@helium.net.au
+executables:
+- make_nf_installer
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/make_nf_installer
+- lib/netfira-installer-generator.rb
+- lib/netfira/installer_generator.rb
+- lib/netfira/installer_generator/binary.rb
+- lib/netfira/installer_generator/binary/makensis.rb
+- lib/netfira/installer_generator/binary/signcode.rb
+- lib/netfira/installer_generator/cli.rb
+- lib/netfira/installer_generator/exception.rb
+- lib/netfira/installer_generator/nsis_template.rb
+- lib/netfira/installer_generator/version.rb
+homepage: http://netfira.com.au/
+licenses:
+- Proprietary
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Netfira Windows App Installer Generator
+test_files: []