F #2312: VMRC merged with master (#232)

Signed-off-by: Frederick Borges <[email protected]> Co-authored-by: Tino Vázquez <[email protected]>
OpenNebula · Sep 24, 2020 · 4177637 · 4177637
1 parent 1c3e4a7
commit 4177637
Show file tree

Hide file tree

Showing 44 changed files with 2,350 additions and 231 deletions.
diff --git a/.gitignore b/.gitignore
@@ -48,6 +48,10 @@ src/sunstone/public/package-lock.json
 src/sunstone/guac/node_modules
 src/sunstone/guac/dist
 src/sunstone/guac/package-lock.json
+src/sunstone/vmrc/node_modules
+src/sunstone/vmrc/dist
+src/sunstone/vmrc/package-lock.json
+src/sunstone/vmrc/v8-compile-cache-0/
 .tx/config
 
 src/fireedge/node_modules

diff --git a/install.sh b/install.sh
@@ -900,6 +900,7 @@ RUBY_LIB_FILES="src/mad/ruby/ActionManager.rb \
                 src/oca/ruby/opennebula.rb \
                 src/sunstone/OpenNebulaVNC.rb \
                 src/sunstone/OpenNebulaGuac.rb \
+                src/sunstone/OpenNebulaVMRC.rb \
                 src/sunstone/OpenNebulaAddons.rb \
                 src/vmm_mad/remotes/vcenter/vcenter_driver.rb \
                 src/vmm_mad/remotes/nsx/nsx_driver.rb \
@@ -2406,7 +2407,8 @@ SUNSTONE_MODELS_FILES="src/sunstone/models/OpenNebulaJSON.rb \
                        src/sunstone/models/OpenNebula2FA/SunstoneWebAuthn.rb \
                        src/sunstone/models/OpenNebula2FA/sunstone_qr_code.rb \
                        src/sunstone/models/OpenNebula2FA/sunstone_optp.rb \
-                       src/sunstone/models/OpenNebula2FA/sunstone_2f_auth.rb "
+                       src/sunstone/models/OpenNebula2FA/sunstone_2f_auth.rb \
+                       src/sunstone/models/OpenNebulaValidateFireedge.rb"
 
 SUNSTONE_MODELS_JSON_FILES="src/sunstone/models/OpenNebulaJSON/HostJSON.rb \
                     src/sunstone/models/OpenNebulaJSON/ImageJSON.rb \
@@ -2432,6 +2434,7 @@ SUNSTONE_MODELS_JSON_FILES="src/sunstone/models/OpenNebulaJSON/HostJSON.rb \
 SUNSTONE_VIEWS_FILES="src/sunstone/views/index.erb \
                       src/sunstone/views/login.erb \
                       src/sunstone/views/vnc.erb \
+                      src/sunstone/views/vmrc.erb \
                       src/sunstone/views/spice.erb \
                       src/sunstone/views/_login_standard.erb \
                       src/sunstone/views/_login_x509.erb"

diff --git a/src/sunstone/OpenNebulaVMRC.rb b/src/sunstone/OpenNebulaVMRC.rb
@@ -0,0 +1,203 @@
+# -------------------------------------------------------------------------- #
+# Copyright 2002-2020, OpenNebula Project, OpenNebula Systems                #
+#                                                                            #
+# Licensed under the Apache License, Version 2.0 (the "License"); you may    #
+# not use this file except in compliance with the License. You may obtain    #
+# a copy of the License at                                                   #
+#                                                                            #
+# http://www.apache.org/licenses/LICENSE-2.0                                 #
+#                                                                            #
+# Unless required by applicable law or agreed to in writing, software        #
+# distributed under the License is distributed on an "AS IS" BASIS,          #
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.   #
+# See the License for the specific language governing permissions and        #
+# limitations under the License.                                             #
+#--------------------------------------------------------------------------- #
+
+#----------------------------------------------------------------------------#
+# This class provides support for launching and stopping a vmrc proxy server #
+#----------------------------------------------------------------------------#
+
+require 'rubygems'
+require 'json'
+require 'opennebula'
+require 'base64'
+require 'openssl'
+require 'vcenter_driver'
+require 'fileutils'
+
+if !ONE_LOCATION
+    VMRC_TICKETS = "/var/lib/one/sunstone_vnc_tokens/vmrc/"
+else
+    VMRC_TICKETS = ONE_LOCATION + "/var/lib/one/sunstone_vnc_tokens/vmrc/"
+end
+
+FileUtils.mkdir_p VMRC_TICKETS
+
+VMRC_STATES = [
+        #0,  #LCM_INIT
+        #1,  #PROLOG
+        #2,  #BOOT
+        "3",  #RUNNING
+        "4",  #MIGRATE
+        #5,  #SAVE_STOP
+        #6,  #SAVE_SUSPEND
+        #7,  #SAVE_MIGRATE
+        #8,  #PROLOG_MIGRATE
+        #9,  #PROLOG_RESUME
+        #10, #EPILOG_STOP
+        #11, #EPILOG
+        "12", #SHUTDOWN
+        "13", #CANCEL
+        #14, #FAILURE
+        #15, #CLEANUP_RESUBMIT
+        "16", #UNKNOWN
+        "17", #HOTPLUG
+        "18", #SHUTDOWN_POWEROFF
+        #19, #BOOT_UNKNOWN
+        #20, #BOOT_POWEROFF
+        #21, #BOOT_SUSPENDED
+        #22, #BOOT_STOPPED
+        #23, #CLEANUP_DELETE
+        "24", #HOTPLUG_SNAPSHOT
+        "25", #HOTPLUG_NIC
+        "26", #HOTPLUG_SAVEAS
+        "27", #HOTPLUG_SAVEAS_POWEROFF
+        "28", #HOTPLUG_SAVEAS_SUSPENDED
+        "29", #SHUTDOWN_UNDEPLOY
+        #30, #EPILOG_UNDEPLOY
+        #31, #PROLOG_UNDEPLOY
+        #32, #BOOT_UNDEPLOY
+        #33, #HOTPLUG_PROLOG_POWEROFF
+        #34, #HOTPLUG_EPILOG_POWEROFF
+        #35, #BOOT_MIGRATE
+        #36, #BOOT_FAILURE
+        #37, #BOOT_MIGRATE_FAILURE
+        #38, #PROLOG_MIGRATE_FAILURE
+        #39, #PROLOG_FAILURE
+        #40, #EPILOG_FAILURE
+        #41, #EPILOG_STOP_FAILURE
+        #42, #EPILOG_UNDEPLOY_FAILURE
+        #43, #PROLOG_MIGRATE_POWEROFF
+        #44, #PROLOG_MIGRATE_POWEROFF_FAILURE
+        #45, #PROLOG_MIGRATE_SUSPEND
+        #46, #PROLOG_MIGRATE_SUSPEND_FAILURE
+        #47, #BOOT_UNDEPLOY_FAILURE
+        #48, #BOOT_STOPPED_FAILURE
+        #49, #PROLOG_RESUME_FAILURE
+        #50, #PROLOG_UNDEPLOY_FAILURE
+        #51, #DISK_SNAPSHOT_POWEROFF
+        #52, #DISK_SNAPSHOT_REVERT_POWEROFF
+        #53, #DISK_SNAPSHOT_DELETE_POWEROFF
+        #54, #DISK_SNAPSHOT_SUSPENDED
+        #55, #DISK_SNAPSHOT_REVERT_SUSPENDED
+        #56, #DISK_SNAPSHOT_DELETE_SUSPENDED
+        "57", #DISK_SNAPSHOT
+        "58", #DISK_SNAPSHOT_REVERT
+        #59, #DISK_SNAPSHOT_DELETE
+        #60, #PROLOG_MIGRATE_UNKNOWN
+        #61, #PROLOG_MIGRATE_UNKNOWN_FAILURE
+        "62" #DISK_RESIZE
+        #63, #DISK_RESIZE_POWEROFF
+        #64  #DISK_RESIZE_UNDEPLOYED
+        #65  #HOTPLUG_NIC_POWEROFF
+]
+
+class OpenNebulaVMRC
+
+    attr_reader :proxy_port
+
+    def initialize(config, logger, options = {})
+        opts={ :json_errors => true }.merge(options)
+
+        @options = opts
+        @logger = logger
+    end
+
+    def sanitize(ticket)
+        # Bad as defined by wikipedia: https://en.wikipedia.org/wiki/Filename#Reserved_characters_and_words
+        # Also have to escape the backslash
+        bad_chars = [ '/', '\\', '?', '%', '*', ':', '|', '"', '<', '>', '.', ' ' ]
+        bad_chars.each do |bad_char|
+            ticket.gsub!(bad_char, '_')
+        end
+        ticket
+    end
+
+    def proxy(vm_resource)
+        # Check configurations and VM attributes
+
+        unless is_running?
+            return error(400, "Fireedge Server is not running, please contact your cloud administrator")
+        end
+
+        # Check configurations and VM attributes
+        unless VMRC_STATES.include?(vm_resource['LCM_STATE'])
+            return error(400, "Wrong state (#{vm_resource['LCM_STATE']}) to open a VMRC session")
+        end
+
+        if vm_resource['USER_TEMPLATE/HYPERVISOR'] == "vcenter"
+            if vm_resource['MONITORING/VCENTER_ESX_HOST']
+                hostname = vm_resource['MONITORING/VCENTER_ESX_HOST']
+            else
+                return error(400,"Could not determine the vCenter ESX host where the VM is running. 
+                    Wait till the VCENTER_ESX_HOST attribute is retrieved once the host has been monitored")
+            end
+        else
+            return error(400, "VMRC Connection is only for vcenter hipervisor")
+        end
+
+        vm_id  = vm_resource['ID']
+        one_vm = VCenterDriver::VIHelper.one_item(OpenNebula::VirtualMachine, vm_id)
+        vm_ref = one_vm['DEPLOY_ID']
+
+        host_id = one_vm['HISTORY_RECORDS/HISTORY[last()]/HID'].to_i
+
+        vi_client = VCenterDriver::VIClient.new_from_host(host_id)
+
+        vm = VCenterDriver::VirtualMachine.new(vi_client, vm_ref, vm_id)
+
+        parameters = vm.get_html_console_parameters
+
+        data =  {
+            :host       => parameters[:host],
+            :port       => parameters[:port],
+            :ticket     => parameters[:ticket]
+        }
+
+        File.open(VMRC_TICKETS + sanitize(data[:ticket]), 'w') { |file| file.write("https://" + data[:host] + ":" + data[:port].to_s ) }
+
+        [200, { :data => data }.to_json]
+	end
+
+    def status
+        if is_running?
+            STDOUT.puts "VMRC server is running"
+            true
+        else
+            STDOUT.puts "VMRC server is NOT running"
+            false
+        end
+    end
+
+    private
+
+    def error(code, msg)
+        if @options[:json_errors]
+            [code, OpenNebula::Error.new(msg).to_json]
+        else
+            [code,msg]
+        end
+    end
+
+    def is_running?
+
+        if $conf[:fireedge_up]
+            return true
+        end
+
+        false
+    end
+    alias_method :get_vmrc_pid, :is_running?
+
+end
diff --git a/src/sunstone/etc/sunstone-server.conf b/src/sunstone/etc/sunstone-server.conf
@@ -161,6 +161,10 @@
 :guac_port: 29877
 :guacd_port: 4822
 
+:vmrc_port: 2616
+:fireedge_server_endpoint: "http://localhost:2616"
+:max_waiting_tries: 5
+
 # Login Session Length in seconds, defaults to 1 hour.
 #:session_expire_time: 3600
 
@@ -264,4 +268,4 @@
 ################################################################################
 
 :zeromq_server: tcp://localhost:2101
-:autorefresh_ip: 127.0.0.1
+:autorefresh_ip: 127.0.0.1
diff --git a/src/sunstone/etc/sunstone-views/kvm/admin.yaml b/src/sunstone/etc/sunstone-views/kvm/admin.yaml
@@ -419,6 +419,7 @@ tabs:
             VM.edit_labels: true
             VM.menu_labels: true
             VM.startvnc: true
+            VM.startvmrc: true
             VM.startspice: true
             VM.vnc: true
             VM.ssh: true

diff --git a/src/sunstone/etc/sunstone-views/kvm/cloud.yaml b/src/sunstone/etc/sunstone-views/kvm/cloud.yaml
@@ -92,6 +92,7 @@ tabs:
             VM.lockU: true
             VM.unlock: true
             VM.startvnc: true
+            VM.startvmrc: true
             VM.startspice: true
             VM.vnc: true
             VM.ssh: true

diff --git a/src/sunstone/etc/sunstone-views/kvm/groupadmin.yaml b/src/sunstone/etc/sunstone-views/kvm/groupadmin.yaml
@@ -418,6 +418,7 @@ tabs:
             VM.edit_labels: true
             VM.menu_labels: true
             VM.startvnc: true
+            VM.startvmrc: true
             VM.startspice: true
             VM.vnc: true
             VM.ssh: true

diff --git a/src/sunstone/etc/sunstone-views/kvm/user.yaml b/src/sunstone/etc/sunstone-views/kvm/user.yaml
@@ -411,6 +411,7 @@ tabs:
             VM.edit_labels: true
             VM.menu_labels: true
             VM.startvnc: true
+            VM.startvmrc: true
             VM.startspice: true
             VM.vnc: true
             VM.ssh: true

diff --git a/src/sunstone/etc/sunstone-views/mixed/admin.yaml b/src/sunstone/etc/sunstone-views/mixed/admin.yaml
@@ -419,6 +419,7 @@ tabs:
             VM.edit_labels: true
             VM.menu_labels: true
             VM.startvnc: true
+            VM.startvmrc: true
             VM.startspice: true
             VM.vnc: true
             VM.ssh: true

diff --git a/src/sunstone/etc/sunstone-views/mixed/cloud.yaml b/src/sunstone/etc/sunstone-views/mixed/cloud.yaml
@@ -92,6 +92,7 @@ tabs:
             VM.lockU: true
             VM.unlock: true
             VM.startvnc: true
+            VM.startvmrc: true
             VM.startspice: true
             VM.vnc: true
             VM.ssh: true

diff --git a/src/sunstone/etc/sunstone-views/mixed/groupadmin.yaml b/src/sunstone/etc/sunstone-views/mixed/groupadmin.yaml
@@ -418,6 +418,7 @@ tabs:
             VM.edit_labels: true
             VM.menu_labels: true
             VM.startvnc: true
+            VM.startvmrc: true
             VM.startspice: true
             VM.vnc: true
             VM.ssh: true

diff --git a/src/sunstone/etc/sunstone-views/mixed/user.yaml b/src/sunstone/etc/sunstone-views/mixed/user.yaml
@@ -411,6 +411,7 @@ tabs:
             VM.edit_labels: true
             VM.menu_labels: true
             VM.startvnc: true
+            VM.startvmrc: true
             VM.startspice: true
             VM.vnc: true
             VM.ssh: true

diff --git a/src/sunstone/etc/sunstone-views/vcenter/admin.yaml b/src/sunstone/etc/sunstone-views/vcenter/admin.yaml
@@ -417,6 +417,7 @@ tabs:
             VM.edit_labels: true
             VM.menu_labels: true
             VM.startvnc: true
+            VM.startvmrc: true
             VM.startspice: true
             VM.vnc: true
             VM.ssh: true

diff --git a/src/sunstone/etc/sunstone-views/vcenter/cloud.yaml b/src/sunstone/etc/sunstone-views/vcenter/cloud.yaml
@@ -93,6 +93,7 @@ tabs:
             VM.lockU: true
             VM.unlock: true
             VM.startvnc: true
+            VM.startvmrc: true
             VM.startspice: true
             VM.vnc: true
             VM.ssh: true

diff --git a/src/sunstone/etc/sunstone-views/vcenter/groupadmin.yaml b/src/sunstone/etc/sunstone-views/vcenter/groupadmin.yaml
@@ -418,6 +418,7 @@ tabs:
             VM.edit_labels: true
             VM.menu_labels: true
             VM.startvnc: true
+            VM.startvmrc: true
             VM.startspice: true
             VM.vnc: true
             VM.ssh: true

diff --git a/src/sunstone/etc/sunstone-views/vcenter/user.yaml b/src/sunstone/etc/sunstone-views/vcenter/user.yaml
@@ -411,6 +411,7 @@ tabs:
             VM.edit_labels: true
             VM.menu_labels: true
             VM.startvnc: true
+            VM.startvmrc: true
             VM.startspice: true
             VM.vnc: true
             VM.ssh: true