ruby-sslyze 0.2.1 → 1.0.0

data/lib/sslyze/xml/reneg.rb

@@ -0,0 +1,28 @@
+require 'sslyze/xml/plugin'
+require 'sslyze/xml/reneg/session_renegotiation'
+
+module SSLyze
+  class XML
+    #
+    # Represents the `<reneg>` element.
+    #
+    # @since 1.0.0
+    #
+    class Reneg < Plugin
+
+      #
+      # Session Renegotiation information.
+      #
+      # @return [SessionRenegotiation, nil]
+      #
+      def session_renegotiation
+        @session_renegotiation ||= if (element = @node.at_xpath('sessionRenegotiation'))
+                                     SessionRenegotiation.new(element)
+                                   end
+      end
+
+      alias session session_renegotiation
+
+    end
+  end
+end

data/lib/sslyze/xml/reneg/session_renegotiation.rb

@@ -0,0 +1,51 @@
+require 'sslyze/xml/plugin'
+require 'sslyze/xml/types'
+
+module SSLyze
+  class XML
+    class Reneg < Plugin
+      #
+      # Represents the `<sessionRenegotiation>` XML element.
+      #
+      # @since 1.0.0
+      #
+      class SessionRenegotiation
+
+        include Types
+
+        #
+        # Initializes the {SessionRenegotiation} object.
+        #
+        # @param [Nokogiri::XML::Element] node
+        #   The `<sessionRenegotiation>` XML element.
+        #
+        def initialize(node)
+          @node = node
+        end
+
+        #
+        # Returns the `canBeClientInitiated` attribute.
+        #
+        # @return [Boolean]
+        #
+        def can_be_client_initiated?
+          Boolean[@node['canBeClientInitiated']]
+        end
+
+        alias client_initiated? can_be_client_initiated?
+
+        #
+        # Returns the `isSecure` attribute.
+        #
+        # @return [Boolean]
+        #
+        def is_secure?
+          Boolean[@node['isSecure']]
+        end
+
+        alias secure? is_secure?
+
+      end
+    end
+  end
+end

data/lib/sslyze/xml/resum.rb

@@ -0,0 +1,42 @@
+require 'sslyze/xml/plugin'
+require 'sslyze/xml/resum/session_resumption_with_session_ids'
+require 'sslyze/xml/resum/session_resumption_with_tls_tickets'
+
+module SSLyze
+  class XML
+    #
+    # Represents the `<resum>` XML element.
+    #
+    # @since 1.0.0
+    #
+    class Resum < Plugin
+
+      #
+      # Parses the `<sessionResumptionWithSessionIDs>` XML element.
+      #
+      # @return [SessionResumptionWithSessionIDs, nil]
+      #
+      def session_resumption_with_session_ids
+        @session_resumption_with_session_ids ||= if (element = @node.at_xpath('sessionResumptionWithSessionIDs'))
+                                                   SessionResumptionWithSessionIDs.new(element)
+                                                 end
+      end
+
+      alias with_session_ids session_resumption_with_session_ids
+
+      #
+      # Parses the `<sessionResumptionWithTLSTickets>` XML element.
+      #
+      # @return [SessionResumptionWithTLSTickets, nil]
+      #
+      def session_resumption_with_tls_tickets
+        @session_resumption_with_tls_tickets ||= if (element = @node.at_xpath('sessionResumptionWithTLSTickets'))
+                                                   SessionResumptionWithTLSTickets.new(element)
+                                                 end
+      end
+
+      alias with_tls_tickets session_resumption_with_tls_tickets
+
+    end
+  end
+end

data/lib/sslyze/xml/resum/session_resumption_with_session_ids.rb

@@ -0,0 +1,94 @@
+require 'sslyze/xml/plugin'
+require 'sslyze/xml/types'
+require 'sslyze/xml/attributes/is_supported'
+
+module SSLyze
+  class XML
+    class Resum < Plugin
+      #
+      # Represents the `<sessionResumptionWithSessionIDs>` XML element.
+      #
+      # @since 1.0.0
+      #
+      class SessionResumptionWithSessionIDs
+
+        include Types
+        include Attributes::IsSupported
+
+        #
+        # Initializes the {SessionResumptionWithSessionIDs} object.
+        #
+        # @param [Nokogiri::XML::Element] node
+        #   The `<sessionResumptionWithSessionIDs>` XML element.
+        #
+        def initialize(node)
+          @node = node
+        end
+
+        #
+        # Number of failed attempts.
+        #
+        # @return [Integer]
+        #
+        def failed_attempts
+          @failed_attempts ||= @node['failedAttempts'].to_i
+        end
+
+        #
+        # Number of successful attempts.
+        #
+        # @return [Integer]
+        #
+        def successful_attempts
+          @successful_attempts ||= @node['successfulAttempts'].to_i
+        end
+
+        #
+        # Number of total attempts.
+        #
+        # @return [Integer]
+        #
+        def total_attempts
+          @total_attempts ||= @node['totalAttempts'].to_i
+        end
+
+        #
+        # The number of errors that occurred.
+        #
+        # @return [Integer]
+        #
+        def error_count
+          @error_count ||= @node['errors'].to_i
+        end
+
+        #
+        # Enumerates over each error message.
+        #
+        # @yield [error]
+        #
+        # @yieldparam [String] error
+        #
+        # @return [Enumerator]
+        #   An enumerator will be returned if no block was given.
+        #
+        def each_error
+          return enum_for(__method__) unless block_given?
+
+          @node.xpath('error').each do |error|
+            yield error.inner_text
+          end
+        end
+
+        #
+        # All error messages.
+        #
+        # @return [Array<String>]
+        #
+        def errors
+          each_error.to_a
+        end
+
+      end
+    end
+  end
+end

data/lib/sslyze/xml/resum/session_resumption_with_tls_tickets.rb

@@ -0,0 +1,69 @@
+require 'sslyze/xml/plugin'
+require 'sslyze/xml/types'
+require 'sslyze/xml/attributes/is_supported'
+require 'sslyze/xml/attributes/error'
+
+module SSLyze
+  class XML
+    class Resum < Plugin
+      #
+      # Represents the `<sessionResumptionWithTLSTickets>` XML element.
+      #
+      # @since 1.0.0
+      #
+      class SessionResumptionWithTLSTickets
+
+        include Types
+        include Attributes::IsSupported
+        include Attributes::Error
+
+        #
+        # Initializes the {SessionResumptionWithTLSTickets} object.
+        #
+        # @param [Nokogiri::XML::Element] node
+        #   The `<sessionResumptionWithTLSTickets>` XML element.
+        #
+        def initialize(node)
+          @node = node
+        end
+
+        #
+        # Returns the `error` attribute.
+        #
+        # @return [String, nil]
+        #
+        def error
+          @error ||= @node['error']
+        end
+
+        #
+        # Determines if there was an error.
+        #
+        # @return [Boolean]
+        #
+        def error?
+          !error.nil?
+        end
+
+        #
+        # Returns the descriptive reason.
+        #
+        # @return [String, nil]
+        #
+        def reason
+          @reason ||= @node['reason']
+        end
+
+        #
+        # Converts the element to a String.
+        #
+        # @return [String]
+        #
+        def to_s
+          reason || ''
+        end
+
+      end
+    end
+  end
+end

data/lib/sslyze/xml/resum_rate.rb

@@ -0,0 +1,30 @@
+require 'sslyze/xml/plugin'
+require 'sslyze/xml/resum/session_resumption_with_session_ids'
+
+module SSLyze
+  class XML
+    #
+    # Represents the `<resum_rate/>` XML element.
+    #
+    # @since 1.0.0
+    #
+    class ResumRate < Plugin
+
+      SessionResumptionWithSessionIDs = Resum::SessionResumptionWithSessionIDs
+
+      #
+      # Parses the `<sessionResumptionWithSessionIDs/>` XML element.
+      #
+      # @return [SessionResumptionWithSessionIDs, nil]
+      #
+      def session_resumption_with_session_ids
+        @session_resumption_with_session_ids ||= if (element = @node.at('sessionResumptionWithSessionIDs'))
+                                                   SessionResumptionWithSessionIDs.new(element)
+                                                 end
+      end
+
+      alias with_session_ids session_resumption_with_session_ids
+
+    end
+  end
+end

data/lib/sslyze/xml/target.rb

@@ -0,0 +1,371 @@
+require 'sslyze/xml/types'
+require 'sslyze/xml/certinfo'
+require 'sslyze/xml/compression'
+require 'sslyze/xml/heartbleed'
+require 'sslyze/xml/http_headers'
+require 'sslyze/xml/reneg'
+require 'sslyze/xml/resum'
+require 'sslyze/xml/resum_rate'
+require 'sslyze/xml/protocol'
+require 'sslyze/xml/fallback'
+require 'sslyze/xml/openssl_ccs'
+
+require 'ipaddr'
+
+module SSLyze
+  class XML
+    #
+    # Represents the `<target>` XML element.
+    #
+    class Target
+
+      include Types
+
+      #
+      # Initializes the target.
+      #
+      # @param [Nokogiri::XML::Node] node
+      #   The `<target>` XML element.
+      #
+      def initialize(node)
+        @node = node
+      end
+
+      #
+      # The host name of the target.
+      #
+      # @return [String]
+      #
+      def host
+        @host ||= @node['host']
+      end
+
+      #
+      # The IP address of the target.
+      #
+      # @return [String]
+      #
+      def ip
+        @ip ||= @node['ip']
+      end
+
+      #
+      # The IP address of the target.
+      # 
+      # @return [IPAddr]
+      #
+      # @since 1.0.0
+      #
+      def ipaddr
+        IPAddr.new(ip)
+      end
+
+      #
+      # The port number that was scanned.
+      #
+      # @return [Integer]
+      #
+      def port
+        @port ||= @node['port'].to_i
+      end
+
+      #
+      # Which compression algorithms are supported.
+      #
+      # @return [Compression, nil]
+      #
+      def compression
+        @compression ||= if (element = @node.at_xpath('compression'))
+                           Compression.new(element)
+                         end
+      end
+
+      #
+      # Certificate information.
+      #
+      # @return [Certinfo, nil]
+      #
+      # @since 1.0.0
+      #
+      def certinfo
+        @cert_info ||= if (element = @node.at_xpath('certinfo'))
+                         Certinfo.new(element)
+                       end
+      end
+
+      alias cert_info certinfo
+
+      #
+      # @return [Heartbleed, nil]
+      #
+      # @since 1.0.0
+      #
+      def heartbleed
+        @heartbleed ||= if (element = @node.at_xpath('heartbleed'))
+                          Heartbleed.new(element)
+                        end
+      end
+
+      #
+      # @return [HTTPHeaders, nil]
+      #
+      # @since 1.0.0
+      #
+      def http_headers
+        @http_headers ||= if (element = @node.at_xpath('http_headers'))
+                            HTTPHeaders.new(element)
+                          end
+      end
+
+      #
+      # Specifies whether the service supports Session Renegotiation.
+      #
+      # @return [Reneg, nil]
+      #
+      # @since 1.0.0
+      # 
+      def reneg
+        @reneg ||= if (element = @node.at_xpath('reneg'))
+                     Reneg.new(element)
+                   end
+      end
+
+      alias session_renegotiation reneg
+
+      #
+      # @return [Resum, nil]
+      #
+      # @since 1.0.0
+      #
+      def resum
+        @resum ||= if (element = @node.at_xpath('resum'))
+                     Resum.new(element)
+                   end
+      end
+
+      alias session_resumption resum
+
+      #
+      # @return [Resum, nil]
+      #
+      # @since 1.0.0
+      #
+      def resum_rate
+        @resum ||= if (element = @node.at_xpath('resum_rate'))
+                     ResumRate.new(element)
+                   end
+      end
+
+      alias session_resumption resum_rate
+
+      #
+      # SSLv2 protocol information.
+      #
+      # @return [Protocol, nil]
+      #
+      def sslv2
+        @sslv2 ||= if (element = @node.at_xpath('sslv2'))
+                     Protocol.new(element)
+                   end
+      end
+
+      alias ssl_v2 sslv2
+
+      #
+      # SSLv3 protocol information.
+      #
+      # @return [Protocol, nil]
+      #
+      def sslv3
+        @sslv3 ||= if (element = @node.at_xpath('sslv3'))
+                     Protocol.new(element)
+                   end
+      end
+
+      alias ssl_v3 sslv3
+
+      #
+      # TLSv1 protocol information.
+      #
+      # @return [Protocol, nil]
+      #
+      def tlsv1
+        @tlsv1 ||= if (element = @node.at_xpath('tlsv1'))
+                     Protocol.new(element)
+                   end
+      end
+
+      alias tls_v1 tlsv1
+
+      #
+      # TLSv1.1 protocol information.
+      #
+      # @return [Protocol, nil]
+      #
+      def tlsv1_1
+        @tlsv1_1 ||= if (element = @node.at_xpath('tlsv1_1'))
+                       Protocol.new(element)
+                     end
+      end
+
+      alias tls_v1_1 tlsv1_1
+
+      #
+      # TLSv1.2 protocol information.
+      #
+      # @return [Protocol, nil]
+      #
+      def tlsv1_2
+        @tlsv1_2 ||= if (element = @node.at_xpath('tlsv1_2'))
+                       Protocol.new(element)
+                     end
+      end
+
+      alias tls_v1_2 tlsv1_2
+
+      #
+      # Iterates over every SSL protocol.
+      #
+      # @yield [protocol]
+      #   The given block will be passed each SSL protocol.
+      #
+      # @yieldparam [Protocol] protocol
+      #   A SSL protocol.
+      #
+      # @return [Enumerator]
+      #   If a no block was given, an Enumerator will be returned.
+      #
+      # @see #sslv2
+      # @see #sslv3
+      #
+      def each_ssl_protocol
+        return enum_for(__method__) unless block_given?
+
+        yield sslv2 if sslv2
+        yield sslv3 if sslv3
+      end
+
+      #
+      # All supported SSL protocols.
+      #
+      # @return [Array<Protocol>]
+      #
+      def ssl_protocols
+        each_ssl_protocol.to_a
+      end
+
+      #
+      # Iterates over every TLS protocol.
+      #
+      # @yield [protocol]
+      #   The given block will be passed each TLS protocol.
+      #
+      # @yieldparam [Protocol] protocol
+      #   A TLS protocol.
+      #
+      # @return [Enumerator]
+      #   If a no block was given, an Enumerator will be returned.
+      #
+      # @see #tlsv1
+      # @see #tlsv1_1
+      # @see #tlsv1_2
+      #
+      def each_tls_protocol
+        return enum_for(__method__) unless block_given?
+
+        yield tlsv1 if tlsv1
+        yield tlsv1_1 if tlsv1_1
+        yield tlsv1_2 if tlsv1_2
+      end
+
+      #
+      # All supported TLS protocols.
+      #
+      # @return [Array<Protocol>]
+      #
+      def tls_protocols
+        each_tls_protocol.to_a
+      end
+
+      #
+      # Iterates over every SSL/TLS protocol.
+      #
+      # @yield [protocol]
+      #   The given block will be passed each SSL/TLS protocol.
+      #
+      # @yieldparam [Protocol] protocol
+      #   A SSL/TLS protocol.
+      #
+      # @return [Enumerator]
+      #   If a no block was given, an Enumerator will be returned.
+      #
+      # @see #sslv2
+      # @see #sslv3
+      # @see #tlsv1
+      # @see #tlsv1_1
+      # @see #tlsv1_2
+      #
+      def each_protocol(&block)
+        return enum_for(__method__) unless block
+
+        each_ssl_protocol(&block)
+        each_tls_protocol(&block)
+      end
+
+      #
+      # All supported SSL/TLS protocols.
+      #
+      # @return [Array<Protocol>]
+      #
+      def protocols
+        each_protocol.to_a
+      end
+
+      #
+      # @return [Fallback, nil]
+      #
+      # @since 1.0.0
+      #
+      def fallback
+        @fallback ||= if (element = @node.at_xpath('fallback'))
+                        Fallback.new(element)
+                      end
+      end
+
+      #
+      # @return [OpenSSLCCS, nil]
+      #
+      # @since 1.0.0
+      #
+      def openssl_ccs
+        @openssl_ccs ||= if (element = @node.at_xpath('openssl_ccs'))
+                           OpenSSLCCS.new(element)
+                         end
+      end
+
+      #
+      # Convert the target to a String.
+      #
+      # @return [String]
+      #   The host and port.
+      #
+      def to_s
+        "#{host}:#{port}"
+      end
+
+      #
+      # Compares the other target to this target.
+      #
+      # @param [Target] other
+      #   The other target.
+      #
+      # @return [Boolean]
+      #   Whether the other target has the same {#host} and {#port}.
+      #
+      def ==(other)
+        other.kind_of?(self.class) && other.host == host && other.port == port
+      end
+
+    end
+  end
+end