ruby-sslyze 0.2.1 → 1.0.0

data/lib/sslyze/xml.rb

@@ -1,15 +1,20 @@
-require 'sslyze/target'
-require 'sslyze/invalid_target'
-require 'sslyze/types'
+require 'sslyze/xml/target'
+require 'sslyze/xml/invalid_target'
+require 'sslyze/xml/types'
+require 'sslyze/xml/attributes/title'
+
 require 'nokogiri'
 
 module SSLyze
   #
   # Represents the XML output from sslyze.
   #
+  # @see https://github.com/nabla-c0d3/sslyze/blob/master/xml_out.xsd
+  #
   class XML
 
     include Types
+    include Attributes::Title
 
     #
     # Initializes the XML.
@@ -51,7 +56,7 @@ module SSLyze
     # @return [String]
     #
     def version
-      @version ||= @doc.at('/document/@SSLyzeVersion').value.split(' ',2).last
+      @version ||= @doc.at_xpath('/document/@SSLyzeVersion').value
     end
 
     #
@@ -59,26 +64,10 @@ module SSLyze
     #
     # @return [Integer]
     #
-    def default_timeout
-      @default_time ||= @doc.at('/document/results/@defaultTimeout').value.to_i
-    end
-
-    #
-    # Whether an HTTPS tunnel was used.
+    # @since 1.0.0
     #
-    # @return [Boolean]
-    #
-    def https_tunnel
-      @https_tunnel ||= Boolean[@doc.at('/document/results/@httpsTunnel').value]
-    end
-
-    #
-    # Specifies whether STARTTLS was enabled.
-    #
-    # @return [Boolean]
-    #
-    def start_tls
-      @start_tls ||= Boolean[@doc.at('/document/results/@startTLS').value]
+    def network_timeout
+      @default_time ||= @doc.at_xpath('/document/results/@networkTimeout').value.to_i
     end
 
     #
@@ -87,18 +76,7 @@ module SSLyze
     # @return [Float]
     #
     def total_scan_time
-      @start_tls ||= @doc.at('/document/results/@totalScanTime').value.to_f
-    end
-
-    #
-    # @return [Array<InvalidTarget>]
-    #
-    # @see #each_invalid_target
-    #
-    # @since 0.2.0
-    #
-    def invalid_targets
-      each_invalid_target.to_a
+      @start_tls ||= @doc.at_xpath('/document/results/@totalScanTime').value.to_f
     end
 
     # Enumerates over each invalid target.
@@ -114,11 +92,22 @@ module SSLyze
     def each_invalid_target
       return enum_for(__method__) unless block_given?
 
-      @doc.search('invalidTargets/invalidTarget').each do |inval|
+      @doc.xpath('/document/invalidTargets/invalidTarget').each do |inval|
         yield InvalidTarget.new(inval)
       end
     end
 
+    #
+    # @return [Array<InvalidTarget>]
+    #
+    # @see #each_invalid_target
+    #
+    # @since 0.2.0
+    #
+    def invalid_targets
+      each_invalid_target.to_a
+    end
+
     #
     # Enumerates over each target.
     #
@@ -131,7 +120,7 @@ module SSLyze
     def each_target
       return enum_for(__method__) unless block_given?
 
-      @doc.search('/document/results/target').each do |target|
+      @doc.xpath('/document/results/target').each do |target|
         yield Target.new(target)
       end
     end

data/lib/sslyze/xml/attributes.rb

@@ -0,0 +1,5 @@
+require 'sslyze/xml/attributes/title'
+require 'sslyze/xml/attributes/is_supported'
+require 'sslyze/xml/attributes/is_vulnerable'
+require 'sslyze/xml/attributes/exception'
+require 'sslyze/xml/attributes/error'

data/lib/sslyze/xml/attributes/error.rb

@@ -0,0 +1,30 @@
+module SSLyze
+  class XML
+    module Attributes
+      #
+      # Provides methods for parsing the `error` XML attribute.
+      #
+      # @since 1.0.0
+      #
+      module Error
+        #
+        # The error message, if an error occurred.
+        #
+        # @return [String, nil]
+        #
+        def error
+          @error ||= @node['error']
+        end
+
+        #
+        # Determines if an error occurred.
+        #
+        # @return [Boolean]
+        #
+        def error?
+          !error.nil?
+        end
+      end
+    end
+  end
+end

data/lib/sslyze/xml/attributes/exception.rb

@@ -0,0 +1,30 @@
+module SSLyze
+  class XML
+    module Attributes
+      #
+      # Provides methods for accessing the `exception` XML attribute.
+      #
+      # @since 1.0.0
+      #
+      module Exception
+        #
+        # The exception message, if an exception occurred.
+        #
+        # @return [String, nil]
+        #
+        def exception
+          @exception ||= @node['exception']
+        end
+
+        #
+        # Tests whether an exception occurred.
+        #
+        # @return [Boolean]
+        #
+        def exception?
+          !exception.nil?
+        end
+      end
+    end
+  end
+end

data/lib/sslyze/xml/attributes/is_supported.rb

@@ -0,0 +1,29 @@
+require 'sslyze/xml/types'
+
+module SSLyze
+  class XML
+    module Attributes
+      #
+      # Common methods for the `isSupported` attribute.
+      #
+      # @since 1.0.0
+      #
+      module IsSupported
+
+        include Types
+
+        #
+        # Parses the `isSupported` attribute.
+        #
+        # @return [Boolean]
+        #
+        def is_supported?
+          Boolean[@node['isSupported']]
+        end
+
+        alias supported? is_supported?
+
+      end
+    end
+  end
+end

data/lib/sslyze/xml/attributes/is_vulnerable.rb

@@ -0,0 +1,29 @@
+require 'sslyze/xml/types'
+
+module SSLyze
+  class XML
+    module Attributes
+      #
+      # Common methods for the `isVulnerable` attribute.
+      #
+      # @since 1.0.0
+      #
+      module IsVulnerable
+
+        include Types
+
+        #
+        # Parses the `isVulnerable` attribute.
+        #
+        # @return [Boolean]
+        #
+        def is_vulnerable?
+          Boolean[@node['isVulnerable']]
+        end
+
+        alias vulnerable? is_vulnerable?
+
+      end
+    end
+  end
+end

data/lib/sslyze/xml/attributes/title.rb

@@ -0,0 +1,31 @@
+module SSLyze
+  class XML
+    module Attributes
+      #
+      # Provides methods for accessing the `title` XML attribute.
+      #
+      # @since 1.0.0
+      #
+      module Title
+        #
+        # The title.
+        #
+        # @return [String, nil]
+        #   The value of the `title` attribute.
+        #
+        def title
+          @title ||= @node['title']
+        end
+
+        #
+        # The title or an empty String.
+        #
+        # @return [String]
+        #
+        def to_s
+          title || ''
+        end
+      end
+    end
+  end
+end

data/lib/sslyze/xml/certinfo.rb

@@ -0,0 +1,67 @@
+require 'sslyze/xml/plugin'
+require 'sslyze/xml/certinfo/received_certificate_chain'
+require 'sslyze/xml/certinfo/certificate_validation'
+require 'sslyze/xml/certinfo/certificate_validation/verified_certificate_chain'
+require 'sslyze/xml/certinfo/ocsp_stapling'
+
+module SSLyze
+  class XML
+    #
+    # Represents the `<certinfo>` XML element.
+    #
+    # @since 1.0.0
+    #
+    class Certinfo < Plugin
+
+      #
+      # The received certificate chain.
+      #
+      # @return [ReceivedCertificateChain]
+      #
+      def received_certificate_chain
+        @received_certificate_chain ||= ReceivedCertificateChain.new(
+          @node.at_xpath('receivedCertificateChain')
+        )
+      end
+
+      alias received_chain received_certificate_chain
+
+      #
+      # Certificate validation information.
+      #
+      # @return [CertificateValidation]
+      #
+      def certificate_validation
+        @certificate_validation ||= CertificateValidation.new(
+          @node.at_xpath('certificateValidation')
+        )
+      end
+
+      alias validation certificate_validation
+
+      #
+      # The verified certificate chain.
+      #
+      # @return [VerifiedCertificateChain, nil]
+      #
+      def verified_certificate_chain
+        @verified_certificate_chain ||= if (element = @node.at_xpath('certificateValidation/verifiedCertificateChain'))
+                                          CertificateValidation::VerifiedCertificateChain.new(element)
+                                          
+                                        end
+      end
+
+      alias verified_chain verified_certificate_chain
+
+      #
+      # OCSP Stapling.
+      #
+      # @return [OCSPStapling]
+      #
+      def ocsp_stapling
+        @ocsp_stapling ||= OCSPStapling.new(@node.at_xpath('ocspStapling'))
+      end
+
+    end
+  end
+end

data/lib/sslyze/xml/certinfo/certificate.rb

@@ -0,0 +1,202 @@
+require 'sslyze/xml/plugin'
+require 'sslyze/x509/name'
+require 'sslyze/x509/extension_set'
+require 'sslyze/x509/public_key'
+
+require 'openssl'
+
+module SSLyze
+  class XML
+    class Certinfo < Plugin
+      #
+      # Represents the `<certificate>` XML element.
+      #
+      class Certificate
+
+        #
+        # Initializes the certificate.
+        #
+        # @param [Nokogiri::XML::Node] node
+        #   The `<certificate>` XML element.
+        #
+        def initialize(node)
+          @node = node
+        end
+
+        #
+        # The AS PEM information.
+        #
+        # @return [String]
+        #
+        def as_pem
+          @as_pem ||= @node.at_xpath('asPEM').inner_text
+        end
+
+        alias to_s as_pem
+
+        #
+        # The parsed X509 certificate.
+        #
+        # @return [OpenSSL::X509::Certificate]
+        #
+        # @see http://www.rubydoc.info/stdlib/openssl/OpenSSL/X509/Certificate
+        #
+        # @since 1.0.0
+        #
+        def x509
+          @x509 ||= OpenSSL::X509::Certificate.new(as_pem)
+        end
+
+        #
+        # @return [X509::ExtensionSet]
+        #
+        # @group OpenSSL Methods
+        #
+        def extensions
+          X509::ExtensionSet.new(x509.extensions)
+        end
+
+        #
+        # @return [X509::Name]
+        #
+        # @see http://www.rubydoc.info/stdlib/openssl/OpenSSL/X509/Name
+        #
+        # @group OpenSSL Methods
+        #
+        def issuer
+          @issuer ||= X509::Name.new(x509.issuer)
+        end
+
+        #
+        # @return [Time]
+        #
+        # @group OpenSSL Methods
+        #
+        def not_after
+          x509.not_after
+        end
+
+        #
+        # @return [Time]
+        #
+        # @group OpenSSL Methods
+        #
+        def not_before
+          x509.not_before
+        end
+
+        #
+        # @return [X509::PublicKey]
+        #
+        # @group OpenSSL Methods
+        #
+        def public_key
+          @public_key ||= X509::PublicKey.new(x509.public_key)
+        end
+
+        #
+        # @return [OpenSSL::BN]
+        #
+        # @see http://www.rubydoc.info/stdlib/openssl/OpenSSL/BN
+        #
+        # @group OpenSSL Methods
+        #
+        def serial
+          x509.serial
+        end
+
+        #
+        # @return [String]
+        #
+        # @group OpenSSL Methods
+        #
+        def signature_algorithm
+          x509.signature_algorithm
+        end
+
+        #
+        # @return [X509::Name]
+        #
+        # @group OpenSSL Methods
+        #
+        def subject
+          @subject ||= X509::Name.new(x509.subject)
+        end
+
+        #
+        # @return [String]
+        #
+        # @group OpenSSL Methods
+        #
+        def to_der
+          x509.to_der
+        end
+
+        #
+        # @return [String]
+        #
+        # @group OpenSSL Methods
+        #
+        def to_text
+          x509.to_text
+        end
+
+        #
+        # @return [Integer]
+        #
+        # @group OpenSSL Methods
+        #
+        def version
+          x509.version
+        end
+
+        #
+        # The SHA1 fingerprint of the cert.
+        #
+        # @return [String]
+        #
+        def sha1_fingerprint
+          @sha1_fingerprint ||= @node['sha1Fingerprint']
+        end
+
+        #
+        # The HPKP SHA256 Pin.
+        #
+        # @return [String]
+        #
+        # @since 1.0.0
+        #
+        def hpkp_sha256_pin
+          @hpkp_sha256_pin ||= @node['hpkpSha256Pin']
+        end
+
+        #
+        # The supplied server name indication.
+        #
+        # @return [String]
+        #
+        # @since 1.0.0
+        #
+        def supplied_server_name_indication
+          @supplied_server_name_indication ||= @node['suppliedServerNameIndication']
+        end
+
+        #
+        # Compares the other certificiate to this certificate.
+        #
+        # @param [Certificate] other
+        #   The other certificate.
+        #
+        # @return [Boolean]
+        #   Whether the other certificate has the same {#as_pem}.
+        #
+        # @since 1.0.0
+        #
+        def ==(other)
+          other.kind_of?(self.class) && other.as_pem == as_pem
+        end
+
+      end
+    end
+  end
+end