idrac 0.1.31 → 0.1.40

data/lib/idrac/session.rb

@@ -0,0 +1,278 @@
+require 'faraday'
+require 'base64'
+require 'json'
+require 'colorize'
+require 'uri'
+
+module IDRAC
+  class Session
+    attr_reader :host, :username, :password, :port, :use_ssl, :verify_ssl, 
+                :x_auth_token, :session_location, :direct_mode, :auto_delete_sessions
+
+    def initialize(client)
+      @client = client
+      @host = client.host
+      @username = client.username
+      @password = client.password
+      @port = client.port
+      @use_ssl = client.use_ssl
+      @verify_ssl = client.verify_ssl
+      @x_auth_token = nil
+      @session_location = nil
+      @direct_mode = client.direct_mode
+      @sessions_maxed = false
+      @auto_delete_sessions = client.auto_delete_sessions
+    end
+
+    def connection
+      @connection ||= Faraday.new(url: base_url, ssl: { verify: verify_ssl }) do |faraday|
+        faraday.request :multipart
+        faraday.request :url_encoded
+        faraday.adapter Faraday.default_adapter
+      end
+    end
+
+    # Force clear all sessions by directly using Basic Auth
+    def force_clear_sessions
+      puts "Attempting to force clear all sessions...".light_cyan
+      
+      if delete_all_sessions_with_basic_auth
+        puts "Successfully cleared sessions using Basic Auth".green
+        true
+      else
+        puts "Failed to clear sessions using Basic Auth".red
+        false
+      end
+    end
+
+    # Delete all sessions using Basic Authentication
+    def delete_all_sessions_with_basic_auth
+      puts "Attempting to delete all sessions using Basic Authentication...".light_cyan
+      
+      # First, get the list of sessions
+      sessions_url = '/redfish/v1/SessionService/Sessions'
+      
+      begin
+        # Get the list of sessions
+        response = request_with_basic_auth(:get, sessions_url)
+        
+        if response.status != 200
+          puts "Failed to get sessions list: #{response.status} - #{response.body}".red
+          return false
+        end
+        
+        # Parse the response to get session IDs
+        begin
+          sessions_data = JSON.parse(response.body)
+          
+          if sessions_data['Members'] && sessions_data['Members'].any?
+            puts "Found #{sessions_data['Members'].count} active sessions".light_yellow
+            
+            # Delete each session
+            success = true
+            sessions_data['Members'].each do |session|
+              session_url = session['@odata.id']
+              
+              # Skip if no URL
+              next unless session_url
+              
+              # Delete the session
+              delete_response = request_with_basic_auth(:delete, session_url)
+              
+              if delete_response.status == 200 || delete_response.status == 204
+                puts "Successfully deleted session: #{session_url}".green
+              else
+                puts "Failed to delete session #{session_url}: #{delete_response.status}".red
+                success = false
+              end
+              
+              # Small delay between deletions
+              sleep(1)
+            end
+            
+            return success
+          else
+            puts "No active sessions found".light_yellow
+            return true
+          end
+        rescue JSON::ParserError => e
+          puts "Error parsing sessions response: #{e.message}".red.bold
+          return false
+        end
+      rescue => e
+        puts "Error during session deletion with Basic Auth: #{e.message}".red.bold
+        return false
+      end
+    end
+
+    # Create a Redfish session
+    def create
+      # Skip if we're in direct mode
+      if @direct_mode
+        puts "Skipping Redfish session creation (direct mode)".light_yellow
+        return false
+      end
+      
+      url = '/redfish/v1/SessionService/Sessions'
+      payload = { "UserName" => username, "Password" => password }
+      
+      # Try creation methods in sequence
+      return true if create_session_with_content_type(url, payload)
+      return true if create_session_with_basic_auth(url, payload)
+      return true if handle_max_sessions_and_retry(url, payload)
+      return true if create_session_with_form_urlencoded(url, payload)
+      
+      # If all attempts fail, switch to direct mode
+      @direct_mode = true
+      false
+    end
+    
+    # Delete the Redfish session
+    def delete
+      return unless @x_auth_token && @session_location
+      
+      begin
+        puts "Deleting Redfish session...".light_cyan
+        
+        # Use the X-Auth-Token for authentication
+        headers = { 'X-Auth-Token' => @x_auth_token }
+        
+        response = connection.delete(@session_location) do |req|
+          req.headers.merge!(headers)
+        end
+        
+        if response.status == 200 || response.status == 204
+          puts "Redfish session deleted successfully".green
+          @x_auth_token = nil
+          @session_location = nil
+          return true
+        else
+          puts "Failed to delete Redfish session: #{response.status} - #{response.body}".red
+          return false
+        end
+      rescue => e
+        puts "Error during Redfish session deletion: #{e.message}".red.bold
+        return false
+      end
+    end
+
+    private
+
+    def base_url
+      protocol = use_ssl ? 'https' : 'http'
+      "#{protocol}://#{host}:#{port}"
+    end
+    
+    def basic_auth_headers
+      {
+        'Authorization' => "Basic #{Base64.strict_encode64("#{username}:#{password}")}",
+        'Content-Type' => 'application/json'
+      }
+    end
+    
+    def request_with_basic_auth(method, url, body = nil)
+      connection.send(method, url) do |req|
+        req.headers.merge!(basic_auth_headers)
+        req.body = body if body
+      end
+    rescue => e
+      puts "Error during #{method} request with Basic Auth: #{e.message}".red.bold
+      raise e
+    end
+    
+    def process_session_response(response)
+      if response.status == 201 || response.status == 200
+        @x_auth_token = response.headers['X-Auth-Token']
+        @session_location = response.headers['Location']
+        @sessions_maxed = false
+        true
+      else
+        false
+      end
+    end
+    
+    def create_session_with_content_type(url, payload)
+      begin
+        response = connection.post(url) do |req|
+          req.headers['Content-Type'] = 'application/json'
+          req.body = payload.to_json
+        end
+        
+        if process_session_response(response)
+          puts "Redfish session created successfully".green
+          return true
+        end
+      rescue => e
+        puts "First session creation attempt failed: #{e.message}".light_red
+      end
+      false
+    end
+    
+    def create_session_with_basic_auth(url, payload)
+      begin
+        response = request_with_basic_auth(:post, url, payload.to_json)
+        
+        if process_session_response(response)
+          puts "Redfish session created successfully with Basic Auth".green
+          return true
+        elsif response.status == 400 && response.body.include?("maximum number of user sessions")
+          puts "Maximum sessions reached during Redfish session creation".light_red
+          @sessions_maxed = true
+          return false
+        else
+          puts "Failed to create Redfish session: #{response.status} - #{response.body}".red
+          return false
+        end
+      rescue => e
+        puts "Error during Redfish session creation with Basic Auth: #{e.message}".red.bold
+        return false
+      end
+    end
+    
+    def handle_max_sessions_and_retry(url, payload)
+      return false unless @sessions_maxed && @auto_delete_sessions
+      
+      puts "Auto-delete sessions is enabled, attempting to clear sessions".light_cyan
+      if force_clear_sessions
+        puts "Successfully cleared sessions, trying to create a new session".green
+        
+        # Try one more time after clearing
+        response = request_with_basic_auth(:post, url, payload.to_json)
+        
+        if process_session_response(response)
+          puts "Redfish session created successfully after clearing sessions".green
+          return true
+        else
+          puts "Failed to create Redfish session after clearing sessions: #{response.status} - #{response.body}".red
+          return false
+        end
+      else
+        puts "Failed to clear sessions, switching to direct mode".light_yellow
+        return false
+      end
+    end
+    
+    def create_session_with_form_urlencoded(url, payload)
+      # Only try with form-urlencoded if we had a 415 error previously
+      begin
+        puts "Trying with form-urlencoded content type".light_cyan
+        response = connection.post(url) do |req|
+          req.headers['Content-Type'] = 'application/x-www-form-urlencoded'
+          req.headers['Authorization'] = "Basic #{Base64.strict_encode64("#{username}:#{password}")}"
+          req.body = "UserName=#{URI.encode_www_form_component(username)}&Password=#{URI.encode_www_form_component(password)}"
+        end
+        
+        if process_session_response(response)
+          puts "Redfish session created successfully with form-urlencoded".green
+          return true
+        else
+          puts "Failed with form-urlencoded too: #{response.status} - #{response.body}".red
+          return false
+        end
+      rescue => e
+        puts "Error during form-urlencoded session creation: #{e.message}".red.bold
+        return false
+      end
+    end
+  end
+end 

data/lib/idrac/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module IDRAC
-  VERSION = "0.1.31"
+  VERSION = "0.1.40"
 end

data/lib/idrac/web.rb

@@ -0,0 +1,187 @@
+require 'httparty'
+require 'nokogiri'
+require 'uri'
+require 'colorize'
+
+module IDRAC
+  class Web
+    attr_reader :client, :session_id, :cookies
+
+    def initialize(client)
+      @client = client
+      @session_id = nil
+      @cookies = nil
+      @tried_clearing_sessions = false
+    end
+
+    # Login to the WebUI
+    def login(retry_count = 0)
+      # Limit retries to prevent infinite loops
+      if retry_count >= 3
+        puts "Maximum retry count reached for WebUI login".red
+        return false
+      end
+      
+      # Skip if we already have a session ID
+      return true if @session_id
+      
+      begin
+        puts "Logging in to WebUI...".light_cyan
+        
+        # Create the login URL
+        login_url = "#{base_url}/data/login"
+        
+        # Create the login payload
+        payload = {
+          'user' => client.username,
+          'password' => client.password
+        }
+        
+        # Make the login request
+        response = HTTParty.post(
+          login_url,
+          body: payload,
+          verify: client.verify_ssl,
+          headers: { 'Content-Type' => 'application/x-www-form-urlencoded' }
+        )
+        
+        # Check if the login was successful
+        if response.code == 200
+          # Extract the session ID from the response
+          if response.body.include?('ST2')
+            @session_id = response.body.match(/ST2=([^;]+)/)[1]
+            @cookies = response.headers['set-cookie']
+            puts "WebUI login successful".green
+            return response.body
+          else
+            puts "WebUI login failed: No session ID found in response".red
+            return false
+          end
+        elsif response.code == 400 && response.body.include?("maximum number of user sessions")
+          puts "Maximum sessions reached during WebUI login".light_red
+          
+          # Try to clear sessions if auto_delete_sessions is enabled
+          if client.auto_delete_sessions && !@tried_clearing_sessions
+            puts "Auto-delete sessions is enabled, attempting to clear sessions".light_cyan
+            @tried_clearing_sessions = true
+            
+            if client.session.force_clear_sessions
+              puts "Successfully cleared sessions, trying WebUI login again".green
+              return login(retry_count + 1)
+            else
+              puts "Failed to clear sessions for WebUI login".red
+              return false
+            end
+          else
+            puts "Auto-delete sessions is disabled or already tried clearing".light_yellow
+            return false
+          end
+        else
+          puts "WebUI login failed: #{response.code} - #{response.body}".red
+          return false
+        end
+      rescue => e
+        puts "Error during WebUI login: #{e.message}".red.bold
+        return false
+      end
+    end
+
+    # Logout from the WebUI
+    def logout
+      return unless @session_id
+      
+      begin
+        puts "Logging out from WebUI...".light_cyan
+        
+        # Create the logout URL
+        logout_url = "#{base_url}/data/logout"
+        
+        # Make the logout request
+        response = HTTParty.get(
+          logout_url,
+          verify: client.verify_ssl,
+          headers: { 'Cookie' => @cookies }
+        )
+        
+        # Check if the logout was successful
+        if response.code == 200
+          puts "WebUI logout successful".green
+          @session_id = nil
+          @cookies = nil
+          return true
+        else
+          puts "WebUI logout failed: #{response.code} - #{response.body}".red
+          return false
+        end
+      rescue => e
+        puts "Error during WebUI logout: #{e.message}".red.bold
+        return false
+      end
+    end
+
+    # Capture a screenshot
+    def capture_screenshot
+      # Login to get the forward URL and cookies
+      forward_url = login
+      return nil unless forward_url
+      
+      # Extract the key-value pairs from the forward URL (format: index?ST1=ABC,ST2=DEF)
+      tokens = forward_url.split("?").last.split(",").inject({}) do |acc, kv| 
+        k, v = kv.split("=")
+        acc[k] = v
+        acc
+      end
+      
+      # Generate a timestamp for the request
+      timestamp_ms = (Time.now.to_f * 1000).to_i
+      
+      # First request to trigger the screenshot capture
+      path = "data?get=consolepreview[manual%20#{timestamp_ms}]"
+      res = get(path: path, headers: tokens)
+      raise Error, "Failed to trigger screenshot capture." unless res.code.between?(200, 299)
+      
+      # Wait for the screenshot to be generated
+      sleep 2
+      
+      # Second request to get the actual screenshot image
+      path = "capconsole/scapture0.png?#{timestamp_ms}"
+      res = get(path: path, headers: tokens)
+      raise Error, "Failed to retrieve screenshot image." unless res.code.between?(200, 299)
+      
+      # Save the screenshot to a file
+      filename = "idrac_screenshot_#{timestamp_ms}.png"
+      File.open(filename, "wb") { |f| f.write(res.body) }
+      
+      # Return the filename
+      filename
+    end
+
+    # HTTP GET request for WebUI operations
+    def get(path:, headers: {})
+      headers_to_use = {
+        "User-Agent" => "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.114 Safari/537.36",
+        "Accept-Encoding" => "deflate, gzip"
+      }
+      
+      if @cookies
+        headers_to_use["Cookie"] = @cookies
+      elsif client.direct_mode
+        # In direct mode, use Basic Auth
+        headers_to_use["Authorization"] = "Basic #{Base64.strict_encode64("#{client.username}:#{client.password}")}"
+      end
+      
+      HTTParty.get(
+        "#{base_url}/#{path}",
+        headers: headers_to_use.merge(headers),
+        verify: false
+      )
+    end
+
+    private
+
+    def base_url
+      protocol = client.use_ssl ? 'https' : 'http'
+      "#{protocol}://#{client.host}:#{client.port}"
+    end
+  end
+end 

data/lib/idrac.rb

@@ -6,13 +6,15 @@ require 'faraday'
 require 'faraday/multipart'
 require 'base64'
 require 'uri'
+require 'colorize'
 # If dev, required debug
 require 'debug' if ENV['RUBY_ENV'] == 'development'
 
 require_relative "idrac/version"
 require_relative "idrac/error"
+require_relative "idrac/session"
+require_relative "idrac/web"
 require_relative "idrac/client"
-require_relative "idrac/screenshot"
 require_relative "idrac/firmware"
 require_relative "idrac/firmware_catalog"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: idrac
 version: !ruby/object:Gem::Version
-  version: 0.1.31
+  version: 0.1.40
 platform: ruby
 authors:
 - Jonathan Siegel
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-02 00:00:00.000000000 Z
+date: 2025-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -136,14 +136,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -214,51 +214,19 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".rspec"
 - README.md
-- Rakefile
 - bin/console
 - bin/idrac
 - bin/setup
-- dell_firmware_downloads/Catalog.etag
-- dell_firmware_downloads/Catalog.xml
-- idrac-0.1.6/.rspec
-- idrac-0.1.6/README.md
-- idrac-0.1.6/Rakefile
-- idrac-0.1.6/bin/console
-- idrac-0.1.6/bin/idrac
-- idrac-0.1.6/bin/setup
-- idrac-0.1.6/idrac.gemspec
-- idrac-0.1.6/lib/idrac.rb
-- idrac-0.1.6/lib/idrac/client.rb
-- idrac-0.1.6/lib/idrac/firmware.rb
-- idrac-0.1.6/lib/idrac/version.rb
-- idrac-0.1.6/sig/idrac.rbs
-- idrac-0.1.7/.rspec
-- idrac-0.1.7/README.md
-- idrac-0.1.7/Rakefile
-- idrac-0.1.7/bin/console
-- idrac-0.1.7/bin/idrac
-- idrac-0.1.7/bin/setup
-- idrac-0.1.7/idrac.gemspec
-- idrac-0.1.7/lib/idrac.rb
-- idrac-0.1.7/lib/idrac/client.rb
-- idrac-0.1.7/lib/idrac/firmware.rb
-- idrac-0.1.7/lib/idrac/screenshot.rb
-- idrac-0.1.7/lib/idrac/version.rb
-- idrac-0.1.7/sig/idrac.rbs
 - idrac.gemspec
-- idrac.py
 - lib/idrac.rb
 - lib/idrac/client.rb
 - lib/idrac/error.rb
 - lib/idrac/firmware.rb
 - lib/idrac/firmware_catalog.rb
-- lib/idrac/screenshot.rb
+- lib/idrac/session.rb
 - lib/idrac/version.rb
-- sig/idrac.rbs
-- test_firmware_update.rb
-- updater.rb
+- lib/idrac/web.rb
 homepage: http://github.com
 licenses:
 - MIT
@@ -279,7 +247,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
 summary: API Client for Dell iDRAC

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/Rakefile

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-task default: :spec
-
-# Add a task that tags and pushes to the repository and builds 
-# the gem and pushes it to rubygems.org.
-# Depend on the build task to ensure the gem is up to date.
-task :release => [:build] do
-  system "git tag v#{Idrac::VERSION}"
-  system "git push --tags"
-  system "gem push pkg/idrac-#{Idrac::VERSION}.gem"
-end

data/dell_firmware_downloads/Catalog.etag

@@ -1 +0,0 @@
-"8e46be845f83db1:0"

data/idrac-0.1.6/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper