idrac 0.1.17 → 0.1.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d38771d98568288f7d80b1f3686c511eed0f4d44cd7e66658cbbee897a0ab49b
-  data.tar.gz: ddf5029c40b5b3a57f138fe89e24d1dd8c055b9a07025e7be4fb49038a60abd9
+  metadata.gz: 287cc837870fd1a004f10303ac8a0b60d594f3b2f4561c322e9a56b8cfa3de78
+  data.tar.gz: a34978f43c1157eb3d66a7e3399f057b238d2de777e79c1bfc5a3533a178cc6c
 SHA512:
-  metadata.gz: 0516e7373204bfcc8b71f45ae2291f031a23a01135e956bf971663912a92833d66b0c802ea01e38813bdffbcd1a4a9463036a6ad8d3aa127fb2c8726920d1c39
-  data.tar.gz: 0bd081077d25c963c1a15b2f327916fa0d86774ca994607acbda2278d3326a677c7348e74b3cfea1ab6ccfe0c19f31dfdc1b462efd0e30aaafb8c3548c36514a
+  metadata.gz: 6af64f193514911149d8f902ee0f9bab6a380abc9ad740461f0903cd3dc627f45fdd13e16511da646413922e950aa9c853768acfd8c6692d27c47804a9b70d01
+  data.tar.gz: 8391f69048343693a387bf469f6b71de1322b994435ce3410df031f4171d2fc202607ff5ee3e75df399d5f2ffa630ba3349af798bb54eb561f5cb6c0584b26bb

data/README.md

@@ -105,6 +105,21 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Changelog
 
+### Version 0.1.19
+- **Basic Auth Session Clearing**: Implemented direct session management using Basic Authentication
+- Added ability to list and delete all active sessions without requiring a session
+- Improved session clearing by directly accessing the Redfish Sessions API with Basic Auth
+- Enhanced force_clear_sessions to first try the direct Basic Auth approach before falling back to login/logout cycles
+- Added detailed logging of session clearing operations
+
+### Version 0.1.18
+- **Direct Mode Implementation**: Added a fallback mechanism for environments with persistent session issues
+- Implemented automatic switching to direct mode (Basic Auth) when session creation repeatedly fails
+- Added detection of maximum sessions condition to avoid unnecessary session creation attempts
+- Improved handling of authentication failures with graceful degradation to direct mode
+- Added Basic Auth support for all request types when in direct mode
+- Enhanced logging for better visibility into authentication mode changes
+
 ### Version 0.1.17
 - **Enhanced Session Clearing**: Added aggressive session clearing functionality
 - Implemented a force_clear_sessions method that attempts multiple login/logout cycles with both authentication methods

data/bin/idrac

@@ -19,6 +19,7 @@ module IDRAC
     class_option :port, type: :numeric, default: 443, desc: "iDRAC port"
     class_option :no_ssl, type: :boolean, default: false, desc: "Disable SSL"
     class_option :verify_ssl, type: :boolean, default: false, desc: "Enable SSL verification (not recommended for iDRAC's self-signed certificates)"
+    class_option :direct_mode, type: :boolean, default: false, desc: "Use direct mode with Basic Auth instead of sessions (for environments with session limits)"
 
     desc "firmware:update PATH", "Update firmware using the specified file"
     method_option :wait, type: :boolean, default: true, desc: "Wait for the update to complete"
@@ -191,7 +192,8 @@ module IDRAC
         password: options[:password],
         port: options[:port],
         use_ssl: !options[:no_ssl],
-        verify_ssl: options[:verify_ssl]
+        verify_ssl: options[:verify_ssl],
+        direct_mode: options[:direct_mode]
       )
     end
   end

data/lib/idrac/client.rb

@@ -4,12 +4,14 @@ require 'nokogiri'
 require 'base64'
 require 'uri'
 require 'httparty'
+require 'json'
 
 module IDRAC
   class Client
     attr_reader :host, :username, :password, :port, :use_ssl, :verify_ssl
+    attr_accessor :direct_mode
 
-    def initialize(host:, username:, password:, port: 443, use_ssl: true, verify_ssl: true)
+    def initialize(host:, username:, password:, port: 443, use_ssl: true, verify_ssl: true, direct_mode: false)
       @host = host
       @username = username
       @password = password
@@ -19,6 +21,9 @@ module IDRAC
       @session_id = nil
       @cookies = nil
       @x_auth_token = nil
+      @direct_mode = direct_mode
+      @sessions_maxed = false
+      @tried_clearing_sessions = false
     end
 
     def connection
@@ -33,6 +38,15 @@ module IDRAC
     def force_clear_sessions
       puts "Attempting to force clear all sessions..."
       
+      # First try to delete sessions directly using Basic Auth
+      if delete_all_sessions_with_basic_auth
+        puts "Successfully cleared sessions using Basic Auth"
+        return true
+      end
+      
+      # If direct deletion fails, try the login/logout cycle approach
+      puts "Falling back to login/logout cycle approach for clearing sessions..."
+      
       # Try multiple login/logout cycles with both methods
       3.times do |i|
         begin
@@ -74,8 +88,84 @@ module IDRAC
       puts "Completed session clearing attempts"
     end
 
+    # Delete all sessions using Basic Authentication
+    def delete_all_sessions_with_basic_auth
+      puts "Attempting to delete all sessions using Basic Authentication..."
+      
+      # First, get the list of sessions
+      sessions_url = '/redfish/v1/SessionService/Sessions'
+      
+      # Create a connection with Basic Auth
+      basic_auth_headers = {
+        'Authorization' => "Basic #{Base64.strict_encode64("#{username}:#{password}")}",
+        'Content-Type' => 'application/json'
+      }
+      
+      begin
+        # Get the list of sessions
+        response = connection.get(sessions_url) do |req|
+          req.headers.merge!(basic_auth_headers)
+        end
+        
+        if response.status != 200
+          puts "Failed to get sessions list: #{response.status} - #{response.body}"
+          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"
+            
+            # 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 = connection.delete(session_url) do |req|
+                req.headers.merge!(basic_auth_headers)
+              end
+              
+              if delete_response.status == 200 || delete_response.status == 204
+                puts "Successfully deleted session: #{session_url}"
+              else
+                puts "Failed to delete session #{session_url}: #{delete_response.status}"
+                success = false
+              end
+              
+              # Small delay between deletions
+              sleep(1)
+            end
+            
+            return success
+          else
+            puts "No active sessions found"
+            return true
+          end
+        rescue JSON::ParserError => e
+          puts "Error parsing sessions response: #{e.message}"
+          return false
+        end
+      rescue => e
+        puts "Error during session deletion with Basic Auth: #{e.message}"
+        return false
+      end
+    end
+
     # Create a Redfish session (preferred method for all Redfish API calls)
     def create_redfish_session
+      # Skip if we're in direct mode or we know sessions are maxed out
+      if @direct_mode || @sessions_maxed
+        puts "Skipping Redfish session creation (direct mode or sessions maxed)"
+        return false
+      end
+      
       url = '/redfish/v1/SessionService/Sessions'
       payload = { "UserName" => username, "Password" => password }
       
@@ -92,24 +182,38 @@ module IDRAC
         @session_location = response.headers['Location']
         
         puts "Redfish session created successfully"
+        @sessions_maxed = false
         return true
       elsif response.status == 400 && response.body.include?("maximum number of user sessions")
         puts "Maximum sessions reached during Redfish session creation"
-        force_clear_sessions
+        @sessions_maxed = true
         
-        # Try one more time after clearing
-        response = connection.post(url) do |req|
-          req.headers['Content-Type'] = 'application/json'
-          req.body = payload.to_json
-        end
-        
-        if response.status == 201 || response.status == 200
-          @x_auth_token = response.headers['X-Auth-Token']
-          @session_location = response.headers['Location']
-          puts "Redfish session created successfully after clearing sessions"
-          return true
+        # Only try to clear sessions if we haven't tried too many times
+        if !@tried_clearing_sessions
+          @tried_clearing_sessions = true
+          force_clear_sessions
+          
+          # Try one more time after clearing
+          response = connection.post(url) do |req|
+            req.headers['Content-Type'] = 'application/json'
+            req.body = payload.to_json
+          end
+          
+          if response.status == 201 || response.status == 200
+            @x_auth_token = response.headers['X-Auth-Token']
+            @session_location = response.headers['Location']
+            puts "Redfish session created successfully after clearing sessions"
+            @sessions_maxed = false
+            return true
+          else
+            puts "Failed to create Redfish session after clearing: #{response.status} - #{response.body}"
+            # If we still can't create a session, switch to direct mode
+            @direct_mode = true
+            return false
+          end
         else
-          puts "Failed to create Redfish session after clearing: #{response.status} - #{response.body}"
+          # If we've already tried clearing sessions, switch to direct mode
+          @direct_mode = true
           return false
         end
       else
@@ -142,8 +246,16 @@ module IDRAC
 
     # Legacy login method for screenshot functionality
     def legacy_login(retry_count = 0)
+      # Skip if we're in direct mode
+      if @direct_mode
+        puts "Skipping legacy login (direct mode)"
+        return false
+      end
+      
       # Limit retries to prevent infinite loops
       if retry_count >= 3
+        # If we've tried too many times, switch to direct mode
+        @direct_mode = true
         raise Error, "Failed to login after multiple attempts due to maximum sessions limit"
       end
       
@@ -216,20 +328,34 @@ module IDRAC
 
     # Main login method that decides which approach to use
     def login
+      # If we're in direct mode, skip login attempts
+      if @direct_mode
+        puts "Operating in direct mode (no session)"
+        return true
+      end
+      
       # First try to create a Redfish session
       if create_redfish_session
         return true
       else
         # If we failed to create a Redfish session, try to clear sessions first
-        force_clear_sessions
+        if !@tried_clearing_sessions
+          @tried_clearing_sessions = true
+          force_clear_sessions
+          
+          # Try Redfish again
+          if create_redfish_session
+            return true
+          end
+        end
         
-        # Try Redfish again
-        if create_redfish_session
-          return true
-        else
-          # Fall back to legacy login if Redfish session creation fails
+        # Fall back to legacy login if Redfish session creation fails
+        if !@direct_mode
           puts "Falling back to legacy login method"
           return legacy_login
+        else
+          puts "Operating in direct mode (no session)"
+          return true
         end
       end
     end
@@ -250,22 +376,32 @@ module IDRAC
     def authenticated_request(method, path, options = {}, retry_count = 0)
       # Limit retries to prevent infinite loops
       if retry_count >= 3
-        raise Error, "Failed to complete request after multiple attempts due to session issues"
+        # If we've tried too many times, switch to direct mode
+        @direct_mode = true
+        puts "Switching to direct mode after multiple authentication failures"
       end
       
-      # Ensure we have a valid session
-      begin
-        login unless @x_auth_token || @session_id
-      rescue Error => e
-        # If login fails with maximum sessions error, try to handle it
-        if e.message.include?("maximum number of user sessions") && retry_count < 2
-          puts "Maximum sessions reached during initial login, attempting to clear sessions (attempt #{retry_count + 1}/3)..."
-          logout
-          sleep(5)  # Longer delay
-          return authenticated_request(method, path, options, retry_count + 1)
-        else
-          # Re-raise other errors or if we've tried too many times
-          raise
+      # Ensure we have a valid session (unless in direct mode)
+      unless @direct_mode
+        begin
+          login unless @x_auth_token || @session_id
+        rescue Error => e
+          # If login fails with maximum sessions error, try to handle it
+          if e.message.include?("maximum number of user sessions") && retry_count < 2
+            puts "Maximum sessions reached during initial login, attempting to clear sessions (attempt #{retry_count + 1}/3)..."
+            logout
+            sleep(5)  # Longer delay
+            return authenticated_request(method, path, options, retry_count + 1)
+          else
+            # If we've tried too many times, switch to direct mode
+            if retry_count >= 2
+              @direct_mode = true
+              puts "Switching to direct mode after multiple authentication failures"
+            else
+              # Re-raise other errors or if we've tried too many times
+              raise
+            end
+          end
         end
       end
       
@@ -277,6 +413,9 @@ module IDRAC
       elsif @session_id
         # Fall back to session cookie if needed
         options[:headers]['Cookie'] = "sessionid=#{@session_id}"
+      elsif @direct_mode
+        # In direct mode, use Basic Auth
+        options[:headers]['Authorization'] = "Basic #{Base64.strict_encode64("#{username}:#{password}")}"
       end
       
       response = connection.send(method, path, options[:params]) do |req|
@@ -285,7 +424,7 @@ module IDRAC
       end
       
       # Handle authentication errors
-      if response.status == 401
+      if response.status == 401 && !@direct_mode
         puts "Session expired, re-authenticating..."
         logout
         sleep(3)
@@ -297,12 +436,21 @@ module IDRAC
           options[:headers]['X-Auth-Token'] = @x_auth_token
         elsif @session_id
           options[:headers]['Cookie'] = "sessionid=#{@session_id}"
+        elsif @direct_mode
+          options[:headers]['Authorization'] = "Basic #{Base64.strict_encode64("#{username}:#{password}")}"
         end
         
         response = connection.send(method, path, options[:params]) do |req|
           req.headers.merge!(options[:headers])
           req.body = options[:body] if options[:body]
         end
+        
+        # If we still get a 401, switch to direct mode
+        if response.status == 401 && retry_count < 2
+          @direct_mode = true
+          puts "Switching to direct mode after authentication failure"
+          return authenticated_request(method, path, options, retry_count + 1)
+        end
       end
       
       # Check for maximum sessions error in the response
@@ -328,17 +476,25 @@ module IDRAC
 
     def get(path:, headers: {})
       # For screenshot functionality, we need to use the legacy cookies
-      if @cookies.nil?
+      if @cookies.nil? && !@direct_mode
         legacy_login unless @session_id
       end
       
+      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 @direct_mode
+        # In direct mode, use Basic Auth
+        headers_to_use["Authorization"] = "Basic #{Base64.strict_encode64("#{username}:#{password}")}"
+      end
+      
       response = HTTParty.get(
         "#{base_url}/#{path}",
-        headers: {
-          "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",
-          "Cookie" => @cookies
-        }.merge(headers),
+        headers: headers_to_use.merge(headers),
         verify: false
       )
     end

data/lib/idrac/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: idrac
 version: !ruby/object:Gem::Version
-  version: 0.1.17
+  version: 0.1.19
 platform: ruby
 authors:
 - Jonathan Siegel