foreman_bootdisk 16.1.0 → 18.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f4504c1358b4e4a789bf50d8eeac0e61b5097039694039e77151e47980b2f14
-  data.tar.gz: e46dffaf3739195d4f5988458e2eaa6b38d3eac66ede08c77c07034f8a77d40a
+  metadata.gz: bae1a6f6ec8738a5577fa0314357d3fbbc1ec3d406df374597991b02d28954ca
+  data.tar.gz: '03834a3ecfa7fbc5950f42af43970937e11cb3f245591f7afd5c47ebbe3e02cc'
 SHA512:
-  metadata.gz: '09868d38c5adb714d029fe6ffc554bf3469204343d14d77f789b5c2bbb8badc1bdc760be477ffa69fb1cf3850a6854ae257165e2baba2a7d28373d58b4b9a5b5'
-  data.tar.gz: 4d25edcd1342b1b619d7001a7a4b82f282da9aaed4561e4b8deb85ddccad3df09100ff038f8782a45f4f04b75a8a8403554b3378a6344ea5424047d80d3efec5
+  metadata.gz: e9b0922dc86411ffbe6d24a9170ba1e3ce9222383ed65556f1e0d3f1efc9a7363746b3c37e3b82f0cdb0dd16c7f1f76274d57ce272f48da13f80607d2cb92fdf
+  data.tar.gz: ea1871432fc83b73b5af5c5dce3d3cd0c1778f08c9ff474b64ac17096bfb503a4965d4c3540a23a623518236789dd29e6eae647916e550ad98414a7ef0f667d2

data/.github/workflows/rubocop.yaml

@@ -0,0 +1,19 @@
+name: Rubocop
+
+on: [pull_request]
+
+jobs:
+  rubocop:
+    runs-on: ubuntu-latest
+    env:
+      BUNDLE_FOREMAN: '0'
+      BUNDLE_WITHOUT: development:test
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.5
+          bundler-cache: true
+      - name: Run rubocop
+        run: bundle exec rubocop -P --format github

data/.tx/config

@@ -1,7 +1,7 @@
 [main]
 host = https://www.transifex.com
 
-[foreman.bootdisk]
+[foreman.foreman_bootdisk]
 file_filter = locale/<lang>/foreman_bootdisk.edit.po
 source_file = locale/foreman_bootdisk.pot
 source_lang = en

data/AUTHORS

@@ -1,8 +1,10 @@
 Adam Ruzicka
+Bernhard Suttner
 Bryan Kearney
 crito
 Damon Maria
 Dominic Cleal
+Dominik Matoulek
 Greg Sutcliffe
 Ido Kanner
 Jon Fautley
@@ -12,13 +14,16 @@ Lukas Zapletal
 Lukáš Zapletal
 Marek Hulan
 Marek Hulán
+Markus Bucher
 Martin Bačovský
 Michael Hofer
 Michael Moll
 Ohad Levy
+Oleh Fedorenko
 Ondrej Prazak
 Ondřej Ezr
 Ondřej Pražák
+Pat Riehecky
 Robert Antoni Buj Gelonch
 Rohan21Lobo
 Ronald van Zantvoort

data/README.md

@@ -50,6 +50,10 @@ gPXE images are unsupported due to lack of initrd support.
 | >= 1.19         | ~> 13.0        |
 | >= 1.20         | ~> 14.0        |
 | >= 1.21         | ~> 15.0        |
+| >= 1.23         | ~> 16.0        |
+| >= 1.24         | ~> 16.1        |
+| >= 2.0          | ~> 16.1        |
+| >= 2.1          | ~> 17.0        |
 
 # Usage
 
@@ -119,6 +123,7 @@ TFTP settings are needed.
     <th>DHCP reservation</th>
     <th>Pre-register host</th>
     <th>OS-specific</th>
+    <th>EFI supported</th>
   </tr>
   <tr>
     <td>Per-host image</td>
@@ -127,6 +132,7 @@ TFTP settings are needed.
     <td>No</td>
     <td>Yes</td>
     <td>No</td>
+    <td>No</td>
   </tr>
   <tr>
     <td>Full host image</td>
@@ -135,6 +141,7 @@ TFTP settings are needed.
     <td>No</td>
     <td>Yes</td>
     <td>Yes</td>
+    <td>Yes</td>
   </tr>
   <tr>
     <td>Generic image</td>
@@ -143,6 +150,7 @@ TFTP settings are needed.
     <td>No</td>
     <td>Yes</td>
     <td>No</td>
+    <td>No</td>
   </tr>
   <tr>
     <td>Subnet image</td>
@@ -151,6 +159,7 @@ TFTP settings are needed.
     <td>No</td>
     <td>Yes</td>
     <td>No</td>
+    <td>Yes</td>
   </tr>
 </table>
 
@@ -219,7 +228,7 @@ The installation can continue on either the DHCP or static IP depending on how
 the OS iPXE template is configured, and could configure the assigned IP
 address statically for the installed system via the kickstart file.
 
-To generate the image from the web interface, view a host page, click the
+To generate the image from the web interface, view a subnet page, click the
 "Boot disk" button and select "Generic image".
 
 To generate using the Hammer CLI, install the [hammer_cli_foreman_bootdisk](https://github.com/theforeman/hammer_cli_foreman_bootdisk)
@@ -260,8 +269,7 @@ the "Templates" module enabled and configured.
 
 This image is generic for all hosts with a provisioning NIC on that subnet.
 
-To generate the image from the web interface, view a host page, click the
-"Boot disk" button and select "Subnet image".
+To generate the image from the web interface, view a subnet page and select "Subnet image" from subnet action buttons.
 
 To generate using the Hammer CLI, install the [hammer_cli_foreman_bootdisk](https://github.com/theforeman/hammer_cli_foreman_bootdisk)
 plugin and run:

data/app/controllers/concerns/allowed_actions.rb

@@ -0,0 +1,16 @@
+module AllowedActions
+  extend ActiveSupport::Concern
+
+  def bootdisk_type_allowed?(action = params[:action])
+    return true if Setting::Bootdisk.allowed_types&.include?(action)
+
+    message = _('This type of bootdisk is not allowed. Please contact administrator.')
+    if api_request?
+      render_error :custom_error, status: :unprocessable_entity, locals: { message: message}
+    else
+      error(message)
+      redirect_back(fallback_location: '/')
+    end
+    false
+  end
+end

data/app/controllers/foreman_bootdisk/api/v2/disks_controller.rb

@@ -7,11 +7,13 @@ module ForemanBootdisk
     module V2
       class DisksController < ::Api::V2::BaseController
         include ::Api::Version2
+        include AllowedActions
 
         resource_description do
           api_base_url '/bootdisk/api'
         end
 
+        before_action :bootdisk_type_allowed?, only: :generic
         before_action :find_resource, only: :host
         skip_after_action :log_response_body
 
@@ -21,9 +23,10 @@ module ForemanBootdisk
 
         api :GET, '/generic', N_('Download generic image')
         def generic
+          # EFI not supported for iPXE generic bootdisk
           tmpl = ForemanBootdisk::Renderer.new.generic_template_render
           ForemanBootdisk::ISOGenerator.generate(ipxe: tmpl) do |iso|
-            send_data read_file(iso), filename: "bootdisk_#{URI.parse(Setting[:foreman_url]).host}.iso"
+            send_file(iso, filename: "bootdisk_#{URI.parse(Setting[:foreman_url]).host}.iso")
           end
         end
 
@@ -33,23 +36,27 @@ module ForemanBootdisk
         def host
           host = @disk
           if params[:full]
-            ForemanBootdisk::ISOGenerator.generate_full_host(host) do |iso|
-              send_data read_file(iso), filename: "#{host.name}#{ForemanBootdisk::ISOGenerator.token_expiry(host)}.iso"
+            return unless bootdisk_type_allowed?('full_host')
+            begin
+              ForemanBootdisk::ISOGenerator.generate_full_host(host) do |iso|
+                send_file(iso, filename: "#{host.name}#{ForemanBootdisk::ISOGenerator.token_expiry(host)}.iso")
+              end
+            rescue ::Foreman::Exception => e
+              raise e unless e.code == 'ERF42-2893'
+              render_error json: { error: _('Host is not in build mode')}, status: :method_not_allowed
             end
           else
+            return unless bootdisk_type_allowed?
+            # EFI not supported for iPXE host bootdisk
             tmpl = host.bootdisk_template_render
             ForemanBootdisk::ISOGenerator.generate(ipxe: tmpl) do |iso|
-              send_data read_file(iso), filename: "#{host.name}.iso"
+              send_file(iso, filename: "#{host.name}.iso")
             end
           end
         end
 
         private
 
-        def read_file(filename)
-          File.read(filename)
-        end
-
         def resource_scope
           Host::Managed.authorized('view_hosts')
         end

data/app/controllers/foreman_bootdisk/api/v2/subnet_disks_controller.rb

@@ -7,11 +7,14 @@ module ForemanBootdisk
     module V2
       class SubnetDisksController < ::Api::V2::BaseController
         include ::Api::Version2
+        include AllowedActions
 
         resource_description do
           api_base_url '/bootdisk/api'
         end
 
+        rescue_from ActiveRecord::RecordNotFound, :with => :subnet_not_found
+        before_action :bootdisk_type_allowed?, only: :subnet
         before_action :find_resource, only: :subnet
 
         skip_after_action :log_response_body
@@ -25,10 +28,15 @@ module ForemanBootdisk
         def subnet
           subnet = @subnet_disk
           subnet.tftp || raise(::Foreman::Exception.new(N_('TFTP feature not enabled for subnet %s'), subnet.name))
-          tmpl = ForemanBootdisk::Renderer.new.generic_template_render(subnet)
-          ForemanBootdisk::ISOGenerator.generate(ipxe: tmpl) do |iso|
-            name = subnet.name
-            send_data File.read(iso), filename: "bootdisk_subnet_#{name}.iso"
+          tmpl_bios = ForemanBootdisk::Renderer.new.generic_template_render(subnet)
+          tmpl_efi = nil
+          if subnet.httpboot
+            tmpl_efi = ForemanBootdisk::Renderer.new.generic_efi_template_render(subnet)
+          else
+            ForemanBootdisk.logger.warn('HTTPBOOT feature is not enabled for subnet %s, UEFI may not be available for bootdisk' % subnet.name)
+          end
+          ForemanBootdisk::ISOGenerator.generate(ipxe: tmpl_bios, grub: tmpl_efi) do |temp_iso_filename|
+            send_file(temp_iso_filename, filename: subnet.name)
           end
         end
 
@@ -37,6 +45,10 @@ module ForemanBootdisk
         def resource_scope
           Subnet.authorized('view_subnets')
         end
+
+        def subnet_not_found
+          not_found ("Subnet not found by id '%s'") % params[:id]
+        end
       end
     end
   end

data/app/controllers/foreman_bootdisk/disks_controller.rb

@@ -4,7 +4,14 @@ require 'uri'
 
 module ForemanBootdisk
   class DisksController < ::ApplicationController
-    before_action :find_resource, only: %w[host full_host subnet]
+    include AllowedActions
+    include PrettyError
+
+    helper DiskHelper
+
+    before_action :bootdisk_type_allowed?, except: :help
+
+    before_action :find_resource, only: %w[host full_host]
 
     # as this engine is isolated, we need to include url helpers from core explicitly
     # to render help page layout
@@ -12,6 +19,7 @@ module ForemanBootdisk
 
     def generic
       begin
+        # EFI not supported for iPXE generic bootdisk
         tmpl = ForemanBootdisk::Renderer.new.generic_template_render
       rescue StandardError => e
         error_rendering(e)
@@ -20,13 +28,14 @@ module ForemanBootdisk
       end
 
       ForemanBootdisk::ISOGenerator.generate(ipxe: tmpl) do |iso|
-        send_data read_file(iso), filename: "bootdisk_#{URI.parse(Setting[:foreman_url]).host}.iso"
+        send_file(iso, filename: "bootdisk_#{URI.parse(Setting[:foreman_url]).host}.iso")
       end
     end
 
     def host
       host = @disk
       begin
+        # EFI not supported for iPXE host bootdisk
         tmpl = host.bootdisk_template_render
       rescue StandardError => e
         error_rendering(e)
@@ -34,32 +43,25 @@ module ForemanBootdisk
         return
       end
 
+      prolong_token(host)
+
       ForemanBootdisk::ISOGenerator.generate(ipxe: tmpl) do |iso|
-        send_data read_file(iso), filename: "#{host.name}.iso"
+        send_file(iso, filename: "#{host.name}.iso")
       end
     end
 
     def full_host
       host = @disk
-      ForemanBootdisk::ISOGenerator.generate_full_host(host) do |iso|
-        send_data read_file(iso), filename: "#{host.name}#{ForemanBootdisk::ISOGenerator.token_expiry(host)}.iso"
-      end
-    end
 
-    def subnet
-      host = @disk
+      prolong_token(host)
       begin
-        subnet = host.try(:subnet) || raise(::Foreman::Exception.new(N_('Subnet is not assigned to the host %s'), host.name))
-        subnet.tftp || raise(::Foreman::Exception.new(N_('TFTP feature not enabled for subnet %s'), subnet.name))
-        tmpl = ForemanBootdisk::Renderer.new.generic_template_render(subnet)
-      rescue StandardError => e
-        error_rendering(e)
+        ForemanBootdisk::ISOGenerator.generate_full_host(host) do |iso|
+          send_file(iso, filename: "#{host.name}#{ForemanBootdisk::ISOGenerator.token_expiry(host)}.iso")
+        end
+      rescue ::Foreman::Exception => e
+        raise e unless e.code == 'ERF42-2893'
+        error _('Host is not in build mode.')
         redirect_back(fallback_location: '/')
-        return
-      end
-
-      ForemanBootdisk::ISOGenerator.generate(ipxe: tmpl) do |iso|
-        send_data read_file(iso), filename: "bootdisk_subnet_#{subnet.name}.iso"
       end
     end
 
@@ -67,10 +69,6 @@ module ForemanBootdisk
 
     private
 
-    def read_file(filename)
-      File.read(filename)
-    end
-
     def resource_scope(_controller = controller_name)
       Host::Managed.authorized(:view_hosts)
     end
@@ -80,5 +78,13 @@ module ForemanBootdisk
       error("#{msg}: #{exception.message}")
       ::Foreman::Logging.exception(msg, exception)
     end
+
+    def prolong_token(host)
+      return if Setting[:token_duration] == 0 || host.token.nil?
+
+      # update build token
+      token = host.token
+      token.update(expires: Time.zone.now + Setting[:token_duration].minutes)
+    end
   end
 end

data/app/controllers/foreman_bootdisk/subnet_disks_controller.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module ForemanBootdisk
+  class SubnetDisksController < ::ApplicationController
+    include PrettyError
+
+    before_action :find_resource, only: :subnet
+
+    # as this engine is isolated, we need to include url helpers from core explicitly
+    # to render help page layout
+    include Rails.application.routes.url_helpers
+
+    def subnet
+      begin
+        @subnet.tftp || raise(::Foreman::Exception.new(N_('TFTP feature not enabled for subnet %s'), @subnet.name))
+        @subnet.httpboot || ForemanBootdisk.logger.warn('HTTPBOOT feature is not enabled for subnet %s, UEFI may not be available for bootdisk' % @subnet.name)
+
+        tmpl_bios = ForemanBootdisk::Renderer.new.generic_template_render(@subnet)
+        tmpl_efi = ForemanBootdisk::Renderer.new.generic_efi_template_render(@subnet)
+      rescue StandardError => e
+        error_rendering(e)
+        redirect_back(fallback_location: '/')
+        return
+      end
+
+      ForemanBootdisk::ISOGenerator.generate(ipxe: tmpl_bios, grub: tmpl_efi) do |iso|
+        send_file(iso, filename: "bootdisk_subnet_#{@subnet.name}.iso")
+      end
+    end
+
+    private
+
+    def resource_scope(_controller = controller_name)
+      Subnet.authorized(:view_subnets)
+    end
+
+    def find_resource
+      @subnet = Subnet.find(params[:id])
+    end
+  end
+end

data/app/helpers/bootdisk_links_helper.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module BootdiskLinksHelper
+  # Core Foreman helpers can't look up a URL against a mounted engine
+  def display_bootdisk_link_if_authorized(name, options = {}, html_options = {})
+    if bootdisk_authorized_for(options)
+      link_to(name, bootdisk_url(options), html_options)
+    else
+      ''
+    end
+  end
+
+  def bootdisk_url(options)
+    ForemanBootdisk::Engine.routes.url_for(options.merge(only_path: true, script_name: foreman_bootdisk_path))
+  end
+
+  def bootdisk_authorized_for(options)
+    User.current.allowed_to?(options)
+  end
+
+  def divider
+    tag(:li, class: 'divider')
+  end
+
+  def bootdisk_help_link
+    display_bootdisk_link_if_authorized(
+      _('Boot disk Help'),
+    {
+        controller: 'foreman_bootdisk/disks',
+        action: 'help'
+      },
+      class: 'la'
+    )
+  end
+
+  def bootdisk_title_action_buttons(actions)
+    title_actions(
+      button_group(
+        select_action_button(
+          _('Boot disk'), { class: 'btn btn-group' },
+          actions
+        )
+      )
+    )
+  end
+end

data/app/helpers/concerns/foreman_bootdisk/hosts_helper_ext.rb

@@ -2,51 +2,11 @@
 
 module ForemanBootdisk
   module HostsHelperExt
+    include BootdiskLinksHelper
+
     def host_title_actions(host)
       if host.bootdisk_downloadable?
-        title_actions(
-          button_group(
-            select_action_button(
-              _('Boot disk'), { class: 'btn btn-group' },
-              display_bootdisk_link_if_authorized(
-                _("Host '%s' image") % host.name.split('.')[0],
-                {
-                  controller: 'foreman_bootdisk/disks',
-                  action: 'host',
-                  id: host
-                },
-                class: 'la'
-              ),
-              display_bootdisk_link_if_authorized(
-                _("Full host '%s' image") % host.name.split('.')[0],
-                {
-                  controller: 'foreman_bootdisk/disks',
-                  action: 'full_host',
-                  id: host
-                },
-                class: 'la'
-              ),
-              content_tag(:li, '', class: 'divider'),
-              display_bootdisk_link_if_authorized(
-                _('Generic image'),
-                {
-                  controller: 'foreman_bootdisk/disks',
-                  action: 'generic'
-                },
-                class: 'la'
-              ),
-              display_bootdisk_for_subnet(host),
-              content_tag(:li, '', class: 'divider'),
-              display_bootdisk_link_if_authorized(
-                _('Help'), {
-                  controller: 'foreman_bootdisk/disks',
-                  action: 'help'
-                },
-                class: 'la'
-              )
-            )
-          )
-        )
+        bootdisk_title_action_buttons(host_action_buttons(host))
       else
         bootdisk_button_disabled(host)
       end
@@ -65,7 +25,7 @@ module ForemanBootdisk
 
     # need to wrap this one in a test for template proxy presence
     def display_bootdisk_for_subnet(host)
-      if (proxy = host.try(:subnet).try(:tftp)) && proxy.has_feature?('Templates')
+      if (proxy = host.try(:subnet).try(:tftp) || host.try(:subnet).try(:httpboot)) && proxy.has_feature?('Templates')
         display_bootdisk_link_if_authorized(
           _("Subnet '%s' generic image") % host.subnet.name, {
             controller: 'foreman_bootdisk/disks',
@@ -95,5 +55,59 @@ module ForemanBootdisk
     def bootdisk_authorized_for(options)
       User.current.allowed_to?(options)
     end
+
+    def host_action_buttons(host)
+      actions = []
+
+      allowed_actions = Setting::Bootdisk.allowed_types
+      return '' unless allowed_actions
+
+      host_image_link = display_bootdisk_link_if_authorized(
+                          _("Host '%s' image") % host.name.split('.')[0],
+                        {
+                            controller: 'foreman_bootdisk/disks',
+                            action: 'host',
+                            id: host
+                          },
+                          class: 'la'
+                        )
+
+      full_host_image_link = display_bootdisk_link_if_authorized(
+                               _("Full host '%s' image") % host.name.split('.')[0],
+                             {
+                                 controller: 'foreman_bootdisk/disks',
+                                 action: 'full_host',
+                                 id: host
+                               },
+                               class: 'la'
+                             )
+
+      full_host_blind_link = if bootdisk_authorized_for({controller: 'foreman_bootdisk/disks', action: 'full_host', id: host})
+                               link_to(_("Full host '%s' image") % host.name.split('.')[0],
+                                       '#',
+                                       class: 'la btn btn-info',
+                                       disabled: true,
+                                       title: _('Host is not in build mode')
+                               )
+                             else
+                               ''
+                             end
+
+      actions << host_image_link if allowed_actions.include?('host')
+      if allowed_actions.include?('full_host')
+        if host.build?
+          actions << full_host_image_link
+        else
+          actions << full_host_blind_link
+        end
+      end
+
+
+      actions << divider if (host_image_link.present? && allowed_actions.include?('host')) || (full_host_image_link.present? && allowed_actions.include?('full_host'))
+
+      actions << bootdisk_help_link
+
+      actions
+    end
   end
 end

data/app/helpers/concerns/foreman_bootdisk/pretty_error.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module ForemanBootdisk
+  module PrettyError
+    extend ActiveSupport::Concern
+
+    def error_rendering(exception)
+      msg = _('Failed to render boot disk template')
+      error("#{msg}: #{exception.message}")
+      ::Foreman::Logging.exception(msg, exception)
+    end
+  end
+end

data/app/helpers/concerns/foreman_bootdisk/subnets_helper_ext.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module ForemanBootdisk
+  module SubnetsHelperExt
+    include BootdiskLinksHelper
+
+    def display_bootdisk_for_subnet(subnet)
+      if (proxy = subnet.tftp || subnet.httpboot) && proxy.has_feature?('Templates') && Setting::Bootdisk.allowed_types.include?('subnet')
+        display_bootdisk_link_if_authorized(
+            _("Subnet generic image"), {
+            controller: 'foreman_bootdisk/subnet_disks',
+            action: 'subnet',
+            id: subnet.id
+        },
+            class: 'la'
+        )
+      else
+        ''
+      end
+    end
+
+    def display_bootdisk_title_buttons
+
+      actions = []
+
+      generic_image_link = display_bootdisk_link_if_authorized(
+                             _('Generic image'),
+                           {
+                               controller: 'foreman_bootdisk/disks',
+                               action: 'generic'
+                             },
+                             class: 'la'
+                           )
+
+      if Setting::Bootdisk.allowed_types&.include?('generic')
+        actions << generic_image_link
+        actions << divider
+      end
+
+      actions << bootdisk_help_link
+
+      bootdisk_title_action_buttons(actions)
+    end
+  end
+end

data/app/helpers/disk_helper.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module DiskHelper
+  def mark_disabled_bootdisk_type(type)
+    return '' if Setting::Bootdisk.allowed_types&.include?(type)
+    '*'
+  end
+end