smart_proxy_omaha 0.0.1

data/lib/smart_proxy_omaha/omaha_protocol.rb

@@ -0,0 +1,65 @@
+require 'nokogiri'
+require 'smart_proxy_omaha/release_repository'
+require 'smart_proxy_omaha/metadata'
+require 'smart_proxy_omaha/metadata_provider'
+require 'smart_proxy_omaha/omaha_protocol/response'
+require 'smart_proxy_omaha/omaha_protocol/request'
+require 'smart_proxy_omaha/omaha_protocol/eventacknowledgeresponse'
+require 'smart_proxy_omaha/omaha_protocol/noupdateresponse'
+require 'smart_proxy_omaha/omaha_protocol/updateresponse'
+require 'smart_proxy_omaha/omaha_protocol/handler'
+
+module Proxy::Omaha::OmahaProtocol
+  COREOS_APPID = 'e96281a6-d1af-4bde-9a0a-97b76e56dc57'
+
+  EVENT_TYPES = {
+    0 => 'unknown',
+    1 => 'download complete',
+    2 => 'install complete',
+    3 => 'update complete',
+    4 => 'uninstall',
+    5 => 'download started',
+    6 => 'install started',
+    9 =>  'new application install started',
+    10 => 'setup started',
+    11 => 'setup finished',
+    12 => 'update application started',
+    13 => 'update download started',
+    14 => 'update download finished',
+    15 => 'update installer started',
+    16 => 'setup update begin',
+    17 => 'setup update complete',
+    20 => 'register product complete',
+    30 => 'OEM install first check',
+    40 => 'app-specific command started',
+    41 => 'app-specific command ended',
+    100 => 'setup failure',
+    102 => 'COM server failure',
+    103 => 'setup update failure',
+    800 => 'ping'
+  }.freeze
+
+  EVENT_RESULTS = {
+    0 =>  'error',
+    1 =>  'success',
+    2 =>  'success reboot',
+    3 =>  'success restart browser',
+    4 =>  'cancelled',
+    5 =>  'error installer MSI',
+    6 =>  'error installer other',
+    7 =>  'noupdate',
+    8 =>  'error installer system',
+    9 =>  'update deferred',
+    10 => 'handoff error'
+  }.freeze
+
+  def self.event_description(id)
+    id = 0 unless EVENT_TYPES.key?(id)
+    EVENT_TYPES[id]
+  end
+
+  def self.event_result(id)
+    id = 0 unless EVENT_RESULTS.key?(id)
+    EVENT_RESULTS[id]
+  end
+end

data/lib/smart_proxy_omaha/omaha_protocol/eventacknowledgeresponse.rb

@@ -0,0 +1,9 @@
+module Proxy::Omaha::OmahaProtocol
+  class Eventacknowledgeresponse < Response
+    protected
+
+    def xml_response(xml)
+      # Intentionally left blank
+    end
+  end
+end

data/lib/smart_proxy_omaha/omaha_protocol/handler.rb

@@ -0,0 +1,84 @@
+module Proxy::Omaha::OmahaProtocol
+  class Handler
+    include ::Proxy::Log
+    attr_reader :request, :foreman_client, :repository, :metadata_provider
+
+    def initialize(options = {})
+      @request = options.fetch(:request)
+      @foreman_client = options.fetch(:foreman_client)
+      @repository = options.fetch(:repository)
+      @metadata_provider = options.fetch(:metadata_provider)
+    end
+
+    def handle
+      logger.info "OmahaHandler: Received #{request.event_description} event with result: #{request.event_result}"
+
+      unless request.from_coreos?
+        logger.error "Appid does not match CoreOS. Aborting Omaha request."
+        return Proxy::Omaha::OmahaProtocol::Eventacknowledgeresponse.new(
+          :appid => request.appid,
+          :base_url => request.base_url,
+          :status => 'error-unknownApplication'
+        )
+      end
+
+      unless ['stable', 'beta', 'alpha'].include?(request.track)
+        logger.error "Unknown track requested. Aborting Omaha request."
+        return Proxy::Omaha::OmahaProtocol::Eventacknowledgeresponse.new(
+          :appid => request.appid,
+          :base_url => request.base_url,
+          :status => 'error-unknownApplication'
+        )
+      end
+
+      upload_facts
+      process_report
+
+      if request.updatecheck
+        handle_update
+      else
+        handle_event
+      end
+    end
+
+    private
+
+    def upload_facts
+      foreman_client.post_facts(request.facts_data.to_json)
+    end
+
+    def handle_event
+      Proxy::Omaha::OmahaProtocol::Eventacknowledgeresponse.new(
+        :appid => request.appid,
+        :base_url => request.base_url
+      )
+    end
+
+    def process_report
+      report = {
+        'host' => request.hostname,
+        'status' => request.to_status.to_s,
+        'omaha_version' => request.version,
+        'reported_at' => Time.now.getutc.to_s
+      }
+      foreman_client.post_report({'omaha_report' => report}.to_json)
+    end
+
+    def handle_update
+      latest_os = repository.latest_os(request.track)
+      if !latest_os.nil? && latest_os > Gem::Version.new(request.version)
+        Proxy::Omaha::OmahaProtocol::Updateresponse.new(
+          :appid => request.appid,
+          :metadata => metadata_provider.get(request.track, latest_os),
+          :board => request.board,
+          :base_url => request.base_url
+        )
+      else
+        Proxy::Omaha::OmahaProtocol::Noupdateresponse.new(
+          :appid => request.appid,
+          :base_url => request.base_url
+        )
+      end
+    end
+  end
+end

data/lib/smart_proxy_omaha/omaha_protocol/noupdateresponse.rb

@@ -0,0 +1,9 @@
+module Proxy::Omaha::OmahaProtocol
+  class Noupdateresponse < Response
+    protected
+
+    def xml_response(xml)
+      xml.updatecheck(:status => 'noupdate')
+    end
+  end
+end

data/lib/smart_proxy_omaha/omaha_protocol/request.rb

@@ -0,0 +1,101 @@
+require 'resolv'
+require 'ipaddr'
+
+module Proxy::Omaha::OmahaProtocol
+  class Request
+    attr_reader :appid, :version, :track, :updatecheck, :eventtype, :eventresult, :board,
+      :alephversion, :oemversion, :oem,
+      :platform, :osmajor, :osminor, :hostname, :ipaddress, :ipaddress6,
+      :body, :ip, :base_url
+
+    def initialize(body, options)
+      @body = body
+      @ip = options.fetch(:ip)
+      @base_url = options.fetch(:base_url)
+      parse_request
+      parse_ipaddress
+      raise "Could not determine request hostname." if hostname.nil?
+    end
+
+    def facts_data
+      {
+        :name => hostname,
+        :facts => to_facts.merge({:_type => :foreman_omaha, :_timestamp => Time.now})
+      }
+    end
+
+    def to_status
+      return :downloading if eventtype == 13 && eventresult == 1
+      return :downloaded if eventtype == 14 && eventresult == 1
+      return :installed if eventtype == 3 && eventresult == 1
+      return :instance_hold if eventtype == 800 && eventresult == 1
+      return :complete if eventtype == 3 && eventresult == 2
+      return :error if eventtype == 3 && eventresult == 0
+      :unknown
+    end
+
+    def event_description
+      Proxy::Omaha::OmahaProtocol.event_description(eventtype)
+    end
+
+    def event_result
+      Proxy::Omaha::OmahaProtocol.event_result(eventresult)
+    end
+
+    def from_coreos?
+      appid == Proxy::Omaha::OmahaProtocol::COREOS_APPID
+    end
+
+    private
+
+    def parse_request
+      xml_request = Nokogiri::XML(body)
+      @appid = xml_request.xpath('/request/app/@appid').to_s.gsub(/^{?([a-f0-9\-]+)}?$/, '\1')
+      @version = xml_request.xpath('/request/app/@version').to_s
+      @osmajor = version.gsub(/^(\d+)\.\d\.\d$/, '\1')
+      @osminor = version.gsub(/^\d+\.(\d\.\d)$/, '\1')
+      @track = xml_request.xpath('/request/app/@track').to_s
+      @board = xml_request.xpath('/request/app/@board').to_s
+      @alephversion = xml_request.xpath('/request/app/@alephversion').to_s
+      @oemversion = xml_request.xpath('/request/app/@oemversion').to_s
+      @oem = xml_request.xpath('/request/app/@oem').to_s
+      @platform = xml_request.xpath('/request/os/@platform').to_s
+      @platform = 'CoreOS' if @platform.empty?
+      @updatecheck = !xml_request.xpath('/request/app/updatecheck').to_s.empty?
+      @eventtype = xml_request.xpath('/request/app/event/@eventtype').to_s.to_i
+      @eventresult = xml_request.xpath('/request/app/event/@eventresult').to_s.to_i
+    end
+
+    def parse_ipaddress
+      ipaddr = IPAddr.new(ip) rescue nil
+      return if ipaddr.nil?
+      @ipaddress = ipaddr.to_s if ipaddr.ipv4?
+      @ipaddress6 = ipaddr.to_s if ipaddr.ipv6?
+      @hostname = lookup_hostname(ipaddr.to_s)
+    end
+
+    def lookup_hostname(hostip)
+      Resolv.getname(hostip)
+    rescue Resolv::ResolvError
+      nil
+    end
+
+    def to_facts
+      {
+        :appid => appid,
+        :version => version,
+        :track => track,
+        :board => board,
+        :alephversion => alephversion,
+        :oemversion => oemversion,
+        :oem => oem,
+        :platform => platform,
+        :osmajor => osmajor,
+        :osminor => osminor,
+        :ipaddress => ipaddress,
+        :ipaddress6 => ipaddress6,
+        :hostname => hostname
+      }
+    end
+  end
+end

data/lib/smart_proxy_omaha/omaha_protocol/response.rb

@@ -0,0 +1,33 @@
+require 'uri'
+
+module Proxy::Omaha::OmahaProtocol
+  class Response
+    include ::Proxy::Log
+
+    attr_reader :appid, :base_url, :host, :status
+
+    def initialize(options = {})
+      @appid = options.fetch(:appid)
+      @base_url = options.fetch(:base_url)
+      @host = URI.parse(base_url).host
+      @status = options.fetch(:status, 'ok')
+    end
+
+    def to_xml
+      xml.to_xml
+    end
+
+    protected
+
+    def xml
+      @xml ||= Nokogiri::XML::Builder.new(:encoding => 'UTF-8') do |xml|
+        xml.response(:protocol => '3.0', :server => host) do
+          xml.daystart(:elapsed_seconds => 0)
+          xml.app(:app_id => appid, :status => status) do
+            xml_response(xml)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/smart_proxy_omaha/omaha_protocol/updateresponse.rb

@@ -0,0 +1,35 @@
+module Proxy::Omaha::OmahaProtocol
+  class Updateresponse < Response
+    attr_reader :metadata, :release, :architecture, :sha1_b64, :name, :size, :sha256_b64, :server, :track
+
+    def initialize(options = {})
+      @metadata = options.fetch(:metadata)
+      @architecture = options.fetch(:board)
+      @name = 'update.gz'
+      @size = metadata.size
+      @sha1_b64 = metadata.sha1_b64
+      @sha256_b64 = metadata.sha256_b64
+      @release = metadata.release
+      @track = metadata.track
+      super
+    end
+
+    protected
+
+    def xml_response(xml)
+      xml.updatecheck(:status => 'ok') do
+        xml.urls do
+          xml.url(:codebase => "#{base_url}/omahareleases/#{track}/#{release}/")
+        end
+        xml.manifest(:version => release) do
+          xml.packages do
+            xml.package(:hash => sha1_b64, :name => name, :size => size, :required => false)
+          end
+          xml.actions do
+            xml.action(:event => 'postinstall', :sha256 => sha256_b64, :needsadmin => false, :IsDelta => false, :DisablePayloadBackoff => true, :ChromeOSVersion => '')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/smart_proxy_omaha/release.rb

@@ -0,0 +1,121 @@
+require 'fileutils'
+require 'smart_proxy_omaha/http_download'
+require 'smart_proxy_omaha/metadata_provider'
+
+module Proxy::Omaha
+  class Release
+    include Proxy::Log
+
+    attr_accessor :track, :version
+
+    def initialize(options)
+      @track = options.fetch(:track).to_s
+      @version = Gem::Version.new(options.fetch(:version))
+    end
+
+    def path
+      @path ||= File.join(Proxy::Omaha::Plugin.settings.contentpath, track, version.to_s)
+    end
+
+    def metadata
+      metadata_provider.get(track, release)
+    end
+
+    def exists?
+      File.directory?(path)
+    end
+
+    def valid?
+      expected_files_exist?
+    end
+
+    def create
+      logger.debug "Creating #{track} #{version}"
+      return false unless create_path
+      return false unless download
+      return false unless create_metadata
+      true
+    end
+
+    def <=>(other)
+      return unless self.class === other
+      version.<=>(other.version)
+    end
+
+    def ==(other)
+      self.class === other && track == other.track && version == other.version
+    end
+
+    def to_s
+      version.to_s
+    end
+
+    def download
+      sources.map do |url|
+        file = URI.parse(url).path.split('/').last
+        dst = File.join(path, file)
+        logger.debug "Downloading file #{url} to #{dst}"
+        task = ::Proxy::Omaha::HttpDownload.new(url, dst)
+        task.start
+        task
+      end.each(&:join).map(&:result).all?
+    end
+
+    def create_metadata
+      metadata_provider.store(Metadata.new(
+        :track => track,
+        :release => version.to_s,
+        :size => File.size(updatefile),
+        :sha1_b64 => Digest::SHA1.file(updatefile).base64digest,
+        :sha256_b64 => Digest::SHA256.file(updatefile).base64digest,
+      ))
+      true
+    rescue
+      false
+    end
+
+    def create_path
+      FileUtils.mkdir_p(path)
+      true
+    rescue
+      false
+    end
+
+    def updatefile
+      File.join(path, 'update.gz')
+    end
+
+    def sources
+      upstream = "https://#{track}.release.core-os.net/amd64-usr/#{version}"
+      [
+        "#{upstream}/coreos_production_pxe.vmlinuz",
+        "#{upstream}/coreos_production_pxe_image.cpio.gz",
+        "https://update.release.core-os.net/amd64-usr/#{version}/update.gz"
+      ]
+    end
+
+    def expected_files
+      sources.map { |source| File.basename(source) }
+    end
+
+    def expected_files_exist?
+      expected_files.map {|file| File.file?(File.join(path, file)) }.all?
+    end
+
+    def purge
+      FileUtils.rm(Dir.glob(File.join(path, '*')), :force => true)
+      FileUtils.remove_dir(path)
+      true
+    rescue
+      false
+    end
+
+    private
+
+    def metadata_provider
+      MetadataProvider.new(
+        :contentpath => Proxy::Omaha::Plugin.settings.contentpath
+      )
+    end
+  end
+end