deepsecurity 0.0.19 → 0.0.20

data/lib/deepsecurity/soap_interface.rb

@@ -0,0 +1,57 @@
+# @author Udo Schneider <Udo.Schneider@homeaddress.de>
+
+module DeepSecurity
+
+  class SOAPInterface < SavonHelper::SOAPInterface
+
+    attr_accessor :manager
+
+    # Obtain a new wrapper around the DeepSecurity Manager SOAP API.
+    def initialize(hostname, port=4119, logger, log_level)
+      @hostname = hostname
+      @port = port
+      super("https://#{hostname}:#{port}/webservice/Manager?WSDL",
+            logger,
+            log_level,
+            {:convert_request_keys_to => :none, # or one of [:lower_camelcase, :upcase, :none]
+             :ssl_verify_mode => :none})
+
+    end
+
+    # @!group Request Helper
+
+    # Send an authenticated WebUI Request to the Server for URL +url and return the response body
+    def send_authenticated_http_get(path, sID)
+      logger.debug { "#{self.class}\##{__method__}(#{path.inspect})" }
+      url = "https://#{@hostname}:#{@port}#{path}"
+      request = HTTPI::Request.new(url)
+      request.auth.ssl.verify_mode = :none
+      request.headers = {
+          "Cookie" => "sID=#{sID}"
+      }
+      request.gzip
+      response = HTTPI.get request
+      response.body
+    end
+
+    # Send an authenticated WebUI Request to the Server for URL +url and return the response body
+    def send_authenticated_http_post(path, body, sID)
+      logger.debug { "#{self.class}\##{__method__}(#{path.inspect})" }
+      url = "https://#{@hostname}:#{@port}#{path}"
+      request = HTTPI::Request.new(url)
+      request.auth.ssl.verify_mode = :none
+      request.headers = {
+          "Cookie" => "sID=#{sID}",
+          "Content-Type" => "application/x-www-form-urlencoded"
+      }
+      request.gzip
+      request.body = body
+      response = HTTPI.post request
+      response.body
+    end
+
+    # @!endgroup
+
+  end
+
+end

data/lib/deepsecurity/transport_object.rb

@@ -14,7 +14,11 @@ module DeepSecurity
   # @note
   #   It defines it's own DSL to specify attributes, caching and operation. This allows you to completely hide the
   #   type-conversion needed by Savon behind a regular Ruby object.
-  class TransportObject < DSObject
+  class TransportObject < SavonHelper::CachingObject
+
+    def manager
+      interface.manager
+    end
 
   end
 

data/lib/deepsecurity/transport_objects/anti_malware_event.rb

@@ -48,33 +48,42 @@ module DeepSecurity
     attr_integer_accessor :scan_action2
     attr_string_accessor :summary_scan_result
 
-
     hint_object_accessor :host,
-                          Host,
-                          'The host this event corresponds to'
+                         Host,
+                         'The host this event corresponds to'
+
+
+    # cache_by_aspect :anti_malware_event_id
+
+    # @!group High-Level SOAP Wrapper
+
+    def host
+      manager.host(host_id)
+    end
 
+    # @!endgroup
+
+  end
 
-    # cache_by_aspect :id, :name
+  class Manager
 
     # @!group High-Level SOAP Wrapper
 
     # Return all AntiMalware events matching the filter
-    # @param [TimeFilter] time_filter
-    # @param [HostFilter] host_filter
-    # @param [IDFilter] event_id_filter
+    # @param time_filter [TimeFilter]
+    # @param host_filter [HostFilter]
+    # @param event_id_filter [IDFilter]
     # @return [Array<AntiMalwareEvent>]
-    def self.find_all(time_filter, host_filter, event_id_filter)
-      dsm.antiMalwareEventRetrieve(time_filter, host_filter, event_id_filter)
+    def anti_malware_events_by_time_host_event(time_filter, host_filter, event_id_filter)
+      interface.antiMalwareEventRetrieve(time_filter, host_filter, event_id_filter)
     end
 
-    def host
-      Host.find(host_id)
-    end
     # @!endgroup
 
+
   end
 
-  class Manager
+  class SOAPInterface
 
     # @!group Low-Level SOAP Wrapper
 
@@ -91,11 +100,11 @@ module DeepSecurity
     #
     # RETURNS
     #   AntiMalwareEventListTransport object.
-    def antiMalwareEventRetrieve(timeFilter, hostFilter, eventIdFilter, sID = dsm.sID)
+    def antiMalwareEventRetrieve(timeFilter, hostFilter, eventIdFilter, sID = manager.sID)
       request_array(:anti_malware_event_retrieve, AntiMalwareEvent, :anti_malware_events,
-                    :timeFilter => timeFilter.to_savon_data,
-                    :hostFilter => hostFilter.to_savon_data,
-                    :eventIdFilter => eventIdFilter.to_savon_data,
+                    :timeFilter => timeFilter.to_savon,
+                    :hostFilter => hostFilter.to_savon,
+                    :eventIdFilter => eventIdFilter.to_savon,
                     :sID => sID)
     end
 

data/lib/deepsecurity/transport_objects/host.rb

@@ -79,34 +79,60 @@ module DeepSecurity
 
     # @!group High-Level SOAP Wrapper
 
+    def host_group
+      manager.host_group(host_group_id)
+    end
+
+    #@!endgroup
+  end
+
+  class Manager
+
+    # @!group High-Level SOAP Wrapper
+
     # Retrieves Hosts.
     # @return [Array<Host>]
-    def self.all
-      dsm.hostRetrieveAll()
+    def hosts()
+      cache.fetch(Host.cache_key(:all, :all)) do
+        interface.hostRetrieveAll()
+      end
     end
 
     # Retrieves a Host by ID.
-    # @param [Integer] id Host ID
+    # @param id [Integer] Host ID
     # @return [Host]
-    def self.find(id)
-      dsm.hostRetrieve(id)
+    def host(id)
+      cache.fetch(Host.cache_key(:id, id)) do
+        interface.hostRetrieve(id)
+      end
     end
 
     # Retrieves a Host by name.
-    # @param [String] hostname hostname
+    # @param hostname [String] hostname
     # @return [Host]
-    def self.find_by_name(hostname)
-      dsm.hostRetrieveByName(hostname)
+    def host_by_name(hostname)
+      cache.fetch(Host.cache_key(:name, hostname)) do
+        interface.hostRetrieveByName(hostname)
+      end
     end
 
-    def host_group
-      HostGroup.find(host_group_id)
+    #@!endgroup
+
+    # @!group Low-Level Screenscraping Wrapper
+
+    def security_profile
+      Manager.current.security_progile(@security_profile_id)
     end
 
-    #@!endgroup
+    def dpi_rule_identifiers_for_host(id, argument)
+      payload_filters2_show_rules(id, argument)
+      payload_filters2(:hostID => id, :arguments => argument).map { |hash| hash[:name].split(' ').first }
+    end
+    # @!endgroup
+
   end
 
-  class Manager
+  class SOAPInterface
 
     # @!group Low-Level SOAP Wrapper
 
@@ -120,11 +146,9 @@ module DeepSecurity
     #
     # RETURNS
     #   HostTransport object array.
-    def hostRetrieveAll(sID = dsm.sID)
-      cache.fetch(Host.cache_key(:all, :all)) do
-        request_array(:host_retrieve_all, Host, nil,
-                      :sID => sID)
-      end
+    def hostRetrieveAll(sID = manager.sID)
+      request_array(:host_retrieve_all, Host, nil,
+                    :sID => sID)
     end
 
     # Retrieves a Host by ID.
@@ -138,10 +162,8 @@ module DeepSecurity
     #
     # RETURNS
     #   HostTransport object.
-    def hostRetrieve(id, sID = dsm.sID)
-      cache.fetch(Host.cache_key(:id, id)) do
-        request_object(:host_retrieve, Host, :id => id, :sID => sID)
-      end
+    def hostRetrieve(id, sID = manager.sID)
+      request_object(:host_retrieve, Host, :id => id, :sID => sID)
     end
 
     # Retrieves a Host by name.
@@ -155,25 +177,12 @@ module DeepSecurity
     #
     # RETURNS
     #   HostTransport object.
-    def hostRetrieveByName(hostname, sID = dsm.sID)
-      cache.fetch(Host.cache_key(:name, hostname)) do
-        request_object(:host_retrieve_by_name, Host, :hostname => hostname, :sID => sID)
-      end
+    def hostRetrieveByName(hostname, sID = manager.sID)
+      request_object(:host_retrieve_by_name, Host, :hostname => hostname, :sID => sID)
     end
 
     # @!endgroup
 
-    # @!group Low-Level Screenscraping Wrapper
-
-    def security_profile
-      Manager.current.security_progile(@security_profile_id)
-    end
-
-    def dpi_rule_identifiers_for_host(id, argument)
-      payload_filters2_show_rules(id, argument)
-      payload_filters2(:hostID => id, :arguments => argument).map { |hash| hash[:name].split(' ').first }
-    end
-    # @!endgroup
 
   end
 

data/lib/deepsecurity/transport_objects/host_detail.rb

@@ -4,33 +4,6 @@ module DeepSecurity
   # merging states of potentially multiple endpoints (i.e., Agent + Appliance).
   class HostDetail < Host
 
-
-    attr_integer_accessor :id
-    attr_string_accessor :name
-    attr_string_accessor :description
-
-    attr_string_accessor :display_name,
-                         'Computer display name'
-    attr_boolean_accessor :external,
-                          'Administrative external boolean for integration purposes.'
-    attr_string_accessor :external_id,
-                         'Administrative external ID for integration purposes.'
-    attr_integer_accessor :host_group_id,
-                          'Assigned HostGroupTransport ID'
-    attr_enum_accessor :host_type,
-                       EnumHostType,
-                       'Assigned host type'
-    attr_string_accessor :platform,
-                         'Computer platform'
-    attr_integer_accessor :security_profile_id,
-                          'Assigned SecurityProfileTransport ID'
-
-    hint_object_accessor :host_group,
-                         HostGroup,
-                         'The host group this host belongs to'
-
-    # ABOVE is duplicates from Host!
-
     attr_string_accessor :anti_malware_classic_pattern_version,
                          "Current version of the classic Anti-Malware pattern"
     attr_string_accessor :anti_malware_engine_version,
@@ -124,28 +97,29 @@ module DeepSecurity
     array_object_accessor :host_interfaces,
                           HostInterface
 
-    cache_by_aspect :id, :name
+    # cache_by_aspect :id, :name
+
+  end
+
+  class Manager
 
     # @!group High-Level SOAP Wrapper
 
     # Return all HostDetails matching the hosts filter with the given detail level
-    # @param [HostFilter] host_filter
-    # @param [EnumHostDetailLevel] detail_level
+    # @param host_filter [HostFilter]
+    # @param detail_level [EnumHostDetailLevel]
     # @return [Array<HostDetail>]
-    def self.find_all(host_filter, detail_level)
-      dsm.hostDetailRetrieve(host_filter, detail_level)
-    end
-
-    def host_group
-      return nil if host_group_id.nil?
-      HostGroup.find(host_group_id)
+    def host_details(host_filter, detail_level)
+      cache.fetch(HostDetail.cache_key(:all, :all)) do
+        interface.hostDetailRetrieve(host_filter, detail_level)
+      end
     end
 
     # @!endgroup
 
   end
 
-  class Manager
+  class SOAPInterface
 
     # @!group Low-Level SOAP Wrapper
 
@@ -161,13 +135,11 @@ module DeepSecurity
     #
     # RETURNS
     #   HostDetailTransport object array.
-    def hostDetailRetrieve(hostFilter, hostDetailLevel, sID = dsm.sID)
-      cache.fetch(HostDetail.cache_key(:all, :all)) do
-        request_array(:host_detail_retrieve, HostDetail, nil,
-                      :hostFilter => hostFilter.to_savon_data,
-                      :hostDetailLevel => EnumHostDetailLevel.key(hostDetailLevel),
-                      :sID => sID)
-      end
+    def hostDetailRetrieve(hostFilter, hostDetailLevel, sID = manager.sID)
+      request_array(:host_detail_retrieve, HostDetail, nil,
+                    :hostFilter => hostFilter.to_savon,
+                    :hostDetailLevel => EnumHostDetailLevel.key(hostDetailLevel),
+                    :sID => sID)
     end
 
     # @!endgroup

data/lib/deepsecurity/transport_objects/host_filter.rb

@@ -28,7 +28,7 @@ module DeepSecurity
     end
 
     # Return a new instance for hosts in the group defined by the given host_group_id.
-    # @param [Integer] host_group_id
+    # @param host_group_id [Integer]
     # @return [HostFilter]
     def self.hosts_in_group(host_group_id)
       instance = self.new()
@@ -38,7 +38,7 @@ module DeepSecurity
     end
 
     # Return a new instance for hosts in the security profile defined by the given security_profile_id.
-    # @param [Integer] security_profile_id
+    # @param security_profile_id [Integer]
     # @return [HostFilter]
     def self.hosts_using_security_profile(security_profile_id)
       instance = self.new()
@@ -48,7 +48,7 @@ module DeepSecurity
     end
 
     # Return a new instance for hosts in the group and their subgroups defined by the given host_group_id.
-    # @param [Integer] host_group_id
+    # @param host_group_id [Integer]
     # @return [HostFilter]
     def self.hosts_in_group_and_all_subgroups(host_group_id)
       instance = self.new()
@@ -58,7 +58,7 @@ module DeepSecurity
     end
 
     # Return a new instance for hosts defined by the given host_id.
-    # @param [Integer] host_id
+    # @param host_id [Integer]
     # @return [HostFilter]
     def self.specific_host(host_id)
       instance = self.new()

data/lib/deepsecurity/transport_objects/host_group.rb

@@ -25,34 +25,49 @@ module DeepSecurity
     # @!group High-Level SOAP Wrapper
 
     def parent_group
-      return nil if @parent_group_id.nil?
-      @dsm.host_group(@parent_group_id)
+      return nil if parent_group_id.nil?
+      manager.host_group(parent_group_id)
     end
 
+    # @!group High-Level SOAP Wrapper
+  end
+
+  class Manager
+
+    # @!group High-Level SOAP Wrapper
+
     # Retrieves HostGroups.
     # @return [Array<HostGroup>]
-    def self.all
-      dsm.hostGroupRetrieveAll()
+    def host_groups()
+      cache.fetch(HostGroup.cache_key(:all, :all)) do
+        interface.hostGroupRetrieveAll()
+      end
     end
 
     # Retrieves a HostGroup by ID.
-    # @param [Integer] id HostGroup ID
+    # @param id [Integer] HostGroup ID
     # @return [HostGroup]
-    def self.find(id)
-      dsm.hostGroupRetrieve(id)
+    def host_group(id)
+      return nil if id.nil?
+      cache.fetch(HostGroup.cache_key(:id, id)) do
+        interface.hostGroupRetrieve(id)
+      end
     end
 
     # Retrieves a HostGroup by name.
-    # @param [String] hostname hostname
+    # @param hostname [String] hostname
     # @return [HostGroup]
-    def self.find_by_name(hostname)
-      dsm.hostGroupRetrieveByName(hostname)
+    def host_group_by_name(hostname)
+      return nil if hostname.blank?
+      cache.fetch(HostGroup.cache_key(:name, name)) do
+        interface.hostGroupRetrieveByName(hostname)
+      end
     end
     #@!endgroup
 
   end
 
-  class Manager
+  class SOAPInterface
 
     # @!group Low-Level SOAP Wrapper
 
@@ -66,11 +81,9 @@ module DeepSecurity
     #
     # RETURNS
     #   HostGroupTransport object array.
-    def hostGroupRetrieveAll(sID = dsm.sID)
-      cache.fetch(HostGroup.cache_key(:all, :all)) do
-        request_array(:host_group_retrieve_all, HostGroup, nil,
-                      :sID => sID)
-      end
+    def hostGroupRetrieveAll(sID = manager.sID)
+      request_array(:host_group_retrieve_all, HostGroup, nil,
+                    :sID => sID)
     end
 
     # Retrieves a Host Group by ID.
@@ -84,12 +97,10 @@ module DeepSecurity
     #
     # RETURNS
     #   HostGroupTransport object.
-    def hostGroupRetrieve(id, sID = dsm.sID)
-      cache.fetch(HostGroup.cache_key(:id, id)) do
-        request_object(:host_group_retrieve, HostGroup,
-                       :id => id,
-                       :sID => sID)
-      end
+    def hostGroupRetrieve(id, sID = manager.sID)
+      request_object(:host_group_retrieve, HostGroup,
+                     :id => id,
+                     :sID => sID)
     end
 
 
@@ -100,16 +111,14 @@ module DeepSecurity
     #
     # PARAMETERS
     #   Name  Identifying Host Group name.
-    #   sID Authentication session identifier ID.
+    #   sID   Authentication session identifier ID.
     #
     # RETURNS
     #   HostGroupTransport object.
-    def hostGroupRetrieveByName(name, sID = dsm.sID)
-      cache.fetch(HostGroup.cache_key(:name, name)) do
-        request_object(:host_group_retrieve_by_name, HostGroup,
-                       :name => name,
-                       :sID => sID)
-      end
+    def hostGroupRetrieveByName(name, sID = manager.sID)
+      request_object(:host_group_retrieve_by_name, HostGroup,
+                     :name => name,
+                     :sID => sID)
     end
 
     # @!endgroup