tttls1.3 0.2.9 → 0.2.14

data/lib/tttls1.3/message/alert.rb

@@ -8,7 +8,7 @@ module TTTLS13
       FATAL   = "\x02"
     end
 
-    # rubocop: disable Layout/AlignHash
+    # rubocop: disable Layout/HashAlignment
     ALERT_DESCRIPTION = {
       close_notify:                    "\x00",
       unexpected_message:              "\x0a",
@@ -38,7 +38,7 @@ module TTTLS13
       certificate_required:            "\x74",
       no_application_protocol:         "\x78"
     }.freeze
-    # rubocop: enable Layout/AlignHash
+    # rubocop: enable Layout/HashAlignment
 
     class Alert
       attr_reader :level

data/lib/tttls1.3/message/extension/status_request.rb

@@ -9,23 +9,20 @@ module TTTLS13
         OCSP = "\x01"
       end
 
-      class StatusRequest
+      class OCSPStatusRequest
         attr_reader :extension_type
         attr_reader :responder_id_list
         attr_reader :request_extensions
 
-        # @param responder_id_list [Array of String]
-        # @param request_extensions [String]
+        # @param responder_id_list [Array of OpenSSL::ASN1::ASN1Data]
+        # @param request_extensions [Array of OpenSSL::ASN1::ASN1Data]
         #
         # @example
-        #   StatusRequest.new(
-        #       responder_id_list: [],
-        #       request_extensions: []
-        #   )
-        def initialize(responder_id_list: [], request_extensions: '')
+        #   OCSPStatusRequest.new
+        def initialize(responder_id_list: [], request_extensions: [])
           @extension_type = ExtensionType::STATUS_REQUEST
           @responder_id_list = responder_id_list || []
-          @request_extensions = request_extensions || ''
+          @request_extensions = request_extensions || []
         end
 
         # @return [String]
@@ -34,9 +31,9 @@ module TTTLS13
           binary += CertificateStatusType::OCSP
           binary += @responder_id_list.length.to_uint16
           binary += @responder_id_list.map do |id|
-            id.length.to_uint16 + id
+            id.to_der.prefix_uint16_length
           end.join
-          binary += @request_extensions.prefix_uint16_length
+          binary += @request_extensions.map(&:to_der).join.prefix_uint16_length
 
           @extension_type + binary.prefix_uint16_length
         end
@@ -45,8 +42,9 @@ module TTTLS13
         #
         # @raise [TTTLS13::Error::ErrorAlerts]
         #
-        # @return [TTTLS13::Message::Extension::StatusRequest, nil]
+        # @return [TTTLS13::Message::Extension::OCSPStatusRequest, nil]
         # rubocop: disable Metrics/CyclomaticComplexity
+        # rubocop: disable Metrics/PerceivedComplexity
         def self.deserialize(binary)
           raise Error::ErrorAlerts, :internal_error if binary.nil?
           return nil if binary.length < 5 ||
@@ -64,14 +62,20 @@ module TTTLS13
 
           re_len = Convert.bin2i(binary.slice(i, 2))
           i += 2
-          request_extensions = binary.slice(i, re_len)
+          exs_bin = binary.slice(i, re_len)
+          begin
+            request_extensions = OpenSSL::ASN1.decode_all(exs_bin)
+          rescue OpenSSL::ASN1::ASN1Error
+            return nil
+          end
           i += re_len
           return nil unless i == binary.length
 
-          StatusRequest.new(responder_id_list: responder_id_list,
-                            request_extensions: request_extensions)
+          OCSPStatusRequest.new(responder_id_list: responder_id_list,
+                                request_extensions: request_extensions)
         end
         # rubocop: enable Metrics/CyclomaticComplexity
+        # rubocop: enable Metrics/PerceivedComplexity
 
         class << self
           private
@@ -80,7 +84,7 @@ module TTTLS13
           #
           # @raise [TTTLS13::Error::ErrorAlerts]
           #
-          # @return [Array of String, nil] received unparsable binary, nil
+          # @return [Array of ASN1Data, nil] received unparsable binary, nil
           def deserialize_request_ids(binary)
             raise Error::ErrorAlerts, :internal_error if binary.nil?
 
@@ -92,7 +96,11 @@ module TTTLS13
               id_len = Convert.bin2i(binary.slice(i, 2))
               i += 2
               id = binary.slice(i, id_len)
-              request_ids += id
+              begin
+                request_ids += OpenSSL::ASN1.decode(id)
+              rescue OpenSSL::ASN1::ASN1Error
+                return nil
+              end
               i += id_len
             end
             return nil if i != binary.length
@@ -101,6 +109,54 @@ module TTTLS13
           end
         end
       end
+
+      class OCSPResponse
+        attr_reader :extension_type
+        attr_reader :ocsp_response
+
+        # @param ocsp_response [OpenSSL::OCSP::Response]
+        #
+        # @example
+        #   OCSPResponse.new(
+        #     OpenSSL::OCSP::Response.create(status, basic_resp)
+        #   )
+        def initialize(ocsp_response)
+          @extension_type = ExtensionType::STATUS_REQUEST
+          @ocsp_response = ocsp_response
+        end
+
+        # @return [String]
+        def serialize
+          binary = ''
+          binary += CertificateStatusType::OCSP
+          binary += @ocsp_response.to_der.prefix_uint24_length
+
+          @extension_type + binary.prefix_uint16_length
+        end
+
+        # @param binary [String]
+        #
+        # @raise [TTTLS13::Error::ErrorAlerts]
+        #
+        # @return [TTTLS13::Message::Extension::OCSPResponse, nil]
+        def self.deserialize(binary)
+          raise Error::ErrorAlerts, :internal_error if binary.nil?
+          return nil if binary.length < 4 ||
+                        binary[0] != CertificateStatusType::OCSP
+
+          res_len = Convert.bin2i(binary.slice(1, 3))
+          res = binary.slice(4, res_len)
+          ocsp_response = nil
+          begin
+            ocsp_response = OpenSSL::OCSP::Response.new(res)
+          rescue OpenSSL::OCSP::OCSPError
+            return nil
+          end
+          return nil if 4 + res_len != binary.length
+
+          OCSPResponse.new(ocsp_response)
+        end
+      end
     end
   end
 end

data/lib/tttls1.3/message/extensions.rb

@@ -1,7 +1,8 @@
 # encoding: ascii-8bit
 # frozen_string_literal: true
 
-Dir[File.dirname(__FILE__) + '/extension/*.rb'].each { |f| require f }
+# signature_algorithms_cert.rb needs signature_algorithms.rb so that `sort`
+Dir[File.dirname(__FILE__) + '/extension/*.rb'].sort.each { |f| require f }
 
 module TTTLS13
   using Refinements
@@ -43,10 +44,11 @@ module TTTLS13
       #
       # @return [TTTLS13::Message::Extensions]
       # rubocop: disable Metrics/CyclomaticComplexity
+      # rubocop: disable Metrics/PerceivedComplexity
       def self.deserialize(binary, msg_type)
         raise Error::ErrorAlerts, :internal_error if binary.nil?
 
-        extensions = []
+        exs = Extensions.new
         i = 0
         while i < binary.length
           raise Error::ErrorAlerts, :decode_error if i + 4 > binary.length
@@ -65,32 +67,41 @@ module TTTLS13
             ex = Extension::UnknownExtension.new(extension_type: extension_type,
                                                  extension_data: ex_bin)
           end
-          extensions << ex
+
+          # There MUST NOT be more than one extension of the same type in a
+          # given extension block.
+          raise Error::ErrorAlerts, :unsupported_extension \
+            if exs.include?(extension_type)
+
+          exs[extension_type] = ex
           i += ex_len
         end
         raise Error::ErrorAlerts, :decode_error unless i == binary.length
 
-        Extensions.new(extensions)
+        exs
       end
       # rubocop: enable Metrics/CyclomaticComplexity
+      # rubocop: enable Metrics/PerceivedComplexity
 
       # @param key [TTTLS13::Message::ExtensionType]
+      # @param default
       #
       # @return [TTTLS13::Message::Extension::$Object]
-      def [](key)
+      def fetch(key, default = nil)
         return nil if super_fetch(key, nil).is_a?(Extension::UnknownExtension)
 
-        super_fetch(key, nil)
+        super_fetch(key, default)
       end
 
-      # @param key [TTTLS13::Message::ExtensionType]
-      # @param default
+      def [](key)
+        fetch(key)
+      end
+
+      # @param ex [TTTLS13::Message::Extension::$Object]
       #
       # @return [TTTLS13::Message::Extension::$Object]
-      def fetch(key, default = nil)
-        return nil if super_fetch(key, nil).is_a?(Extension::UnknownExtension)
-
-        super_fetch(key, default)
+      def <<(ex)
+        store(ex.extension_type, ex)
       end
 
       class << self
@@ -109,12 +120,23 @@ module TTTLS13
         #
         # @return [TTTLS13::Message::Extension::$Object, nil]
         # rubocop: disable Metrics/CyclomaticComplexity
+        # rubocop: disable Metrics/MethodLength
         def deserialize_extension(binary, extension_type, msg_type)
           raise Error::ErrorAlerts, :internal_error if binary.nil?
 
           case extension_type
           when ExtensionType::SERVER_NAME
             Extension::ServerName.deserialize(binary)
+          when ExtensionType::STATUS_REQUEST
+            if msg_type == HandshakeType::CLIENT_HELLO
+              return Extension::OCSPStatusRequest.deserialize(binary)
+            end
+
+            if msg_type == HandshakeType::CERTIFICATE
+              return Extension::OCSPResponse.deserialize(binary)
+            end
+
+            Extension::UnknownExtension.deserialize(binary, extension_type)
           when ExtensionType::SUPPORTED_GROUPS
             Extension::SupportedGroups.deserialize(binary)
           when ExtensionType::SIGNATURE_ALGORITHMS
@@ -142,6 +164,7 @@ module TTTLS13
           end
         end
         # rubocop: enable Metrics/CyclomaticComplexity
+        # rubocop: enable Metrics/MethodLength
       end
     end
   end

data/lib/tttls1.3/server.rb

@@ -46,11 +46,13 @@ module TTTLS13
 
   DEFAULT_SERVER_SETTINGS = {
     crt_file: nil,
+    chain_files: nil,
     key_file: nil,
     cipher_suites: DEFAULT_SP_CIPHER_SUITES,
     signature_algorithms: DEFAULT_SP_SIGNATURE_ALGORITHMS,
     supported_groups: DEFAULT_SP_NAMED_GROUP_LIST,
     alpn: nil,
+    process_ocsp_response: nil,
     compatibility_mode: true,
     loglevel: Logger::WARN
   }.freeze
@@ -75,6 +77,14 @@ module TTTLS13
       klass = @crt.public_key.class
       @key = klass.new(File.read(@settings[:key_file]))
       raise Error::ConfigError unless @crt.check_private_key(@key)
+
+      @chain = @settings[:chain_files]&.map do |f|
+        OpenSSL::X509::Certificate.new(File.read(f))
+      end
+      @chain ||= []
+      ([@crt] + @chain).each_cons(2) do |cert, sign|
+        raise Error::ConfigError unless cert.verify(sign.public_key)
+      end
     end
 
     # NOTE:
@@ -227,10 +237,14 @@ module TTTLS13
 
           ch = transcript[CH]
           rsl = @send_record_size \
-            unless ch.extensions[Message::ExtensionType::RECORD_SIZE_LIMIT].nil?
+            if ch.extensions.include?(Message::ExtensionType::RECORD_SIZE_LIMIT)
           ee = transcript[EE] = gen_encrypted_extensions(ch, @alpn, rsl)
           # TODO: [Send CertificateRequest]
-          ct = transcript[CT] = gen_certificate(@crt)
+
+          # status_request
+          ocsp_response = fetch_ocsp_response \
+            if ch.extensions.include?(Message::ExtensionType::STATUS_REQUEST)
+          ct = transcript[CT] = gen_certificate(@crt, @chain, ocsp_response)
           digest = CipherSuite.digest(@cipher_suite)
           cv = transcript[CV] = gen_certificate_verify(
             @key,
@@ -341,7 +355,7 @@ module TTTLS13
     #
     # @return [TTTLS13::Message::ServerHello]
     def send_hello_retry_request(ch1, cipher_suite)
-      exs = []
+      exs = Message::Extensions.new
       # supported_versions
       exs << Message::Extension::SupportedVersions.new(
         msg_type: Message::HandshakeType::SERVER_HELLO
@@ -363,7 +377,7 @@ module TTTLS13
         random: Message::HRR_RANDOM,
         legacy_session_id_echo: ch1.legacy_session_id,
         cipher_suite: cipher_suite,
-        extensions: Message::Extensions.new(exs)
+        extensions: exs
       )
       send_handshakes(Message::ContentType::HANDSHAKE, [sh],
                       Cryptograph::Passer.new)
@@ -394,11 +408,18 @@ module TTTLS13
     end
 
     # @param crt [OpenSSL::X509::Certificate]
+    # @param chain [Array of OpenSSL::X509::Certificate]
+    # @param ocsp_response [OpenSSL::OCSP::Response]
     #
     # @return [TTTLS13::Message::Certificate, nil]
-    def gen_certificate(crt)
-      ce = Message::CertificateEntry.new(crt)
-      Message::Certificate.new(certificate_list: [ce])
+    def gen_certificate(crt, chain = [], ocsp_response = nil)
+      exs = Message::Extensions.new
+      # status_request
+      exs << Message::Extension::OCSPResponse.new(ocsp_response) \
+        unless ocsp_response.nil?
+      ces = [Message::CertificateEntry.new(crt, exs)] \
+            + (chain || []).map { |c| Message::CertificateEntry.new(c) }
+      Message::Certificate.new(certificate_list: ces)
     end
 
     # @param key [OpenSSL::PKey::PKey]
@@ -433,7 +454,7 @@ module TTTLS13
     # @return [TTTLS13::Message::Extensions]
     # @return [OpenSSL::PKey::EC.$Object]
     def gen_sh_extensions(named_group)
-      exs = []
+      exs = Message::Extensions.new
       # supported_versions: only TLS 1.3
       exs << Message::Extension::SupportedVersions.new(
         msg_type: Message::HandshakeType::SERVER_HELLO
@@ -444,7 +465,7 @@ module TTTLS13
                  = Message::Extension::KeyShare.gen_sh_key_share(named_group)
       exs << key_share
 
-      [Message::Extensions.new(exs), priv_key]
+      [exs, priv_key]
     end
 
     # @param ch [TTTLS13::Message::ClientHello]
@@ -453,15 +474,16 @@ module TTTLS13
     #
     # @return [TTTLS13::Message::Extensions]
     def gen_ee_extensions(ch, alpn, record_size_limit)
-      exs = []
+      exs = Message::Extensions.new
 
       # server_name
       exs << Message::Extension::ServerName.new('') \
         if ch.extensions.include?(Message::ExtensionType::SERVER_NAME)
 
       # supported_groups
-      exs \
-      << Message::Extension::SupportedGroups.new(@settings[:supported_groups])
+      exs << Message::Extension::SupportedGroups.new(
+        @settings[:supported_groups]
+      )
 
       # alpn
       exs << Message::Extension::Alpn.new([alpn]) unless alpn.nil?
@@ -470,7 +492,7 @@ module TTTLS13
       exs << Message::Extension::RecordSizeLimit.new(record_size_limit) \
         unless record_size_limit.nil?
 
-      Message::Extensions.new(exs)
+      exs
     end
 
     # @param key [OpenSSL::PKey::PKey]
@@ -532,6 +554,11 @@ module TTTLS13
 
       matching_san?(crt, server_name)
     end
+
+    # @return [OpenSSL::OCSP::Response, nil]
+    def fetch_ocsp_response
+      @settings[:process_ocsp_response]&.call
+    end
   end
   # rubocop: enable Metrics/ClassLength
 end

data/lib/tttls1.3/utils.rb

@@ -61,6 +61,21 @@ module TTTLS13
         length.to_uint64 + self
       end
     end
+
+    refine OpenSSL::X509::Certificate do
+      unless method_defined?(:ocsp_uris)
+        define_method(:ocsp_uris) do
+          aia = extensions.find { |ex| ex.oid == 'authorityInfoAccess' }
+          return nil if aia.nil?
+
+          ostr = OpenSSL::ASN1.decode(aia.to_der).value.last
+          ocsp = OpenSSL::ASN1.decode(ostr.value)
+                              .map(&:value)
+                              .select { |des| des.first.value == 'OCSP' }
+          ocsp&.map { |o| o[1].value }
+        end
+      end
+    end
   end
 
   module Convert

data/lib/tttls1.3/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TTTLS13
-  VERSION = '0.2.9'
+  VERSION = '0.2.14'
 end

data/spec/extensions_spec.rb

@@ -2,6 +2,7 @@
 # frozen_string_literal: true
 
 require_relative 'spec_helper'
+using Refinements
 
 RSpec.describe Extensions do
   context 'empty extensions' do
@@ -167,4 +168,19 @@ RSpec.describe Extensions do
       expect(extensions).to include ExtensionType::RECORD_SIZE_LIMIT
     end
   end
+
+  context 'duplicated extension_type' do
+    let(:server_name) do
+      ServerName.new('example.com')
+    end
+
+    let(:testbinary) do
+      server_name.serialize * 2
+    end
+
+    it 'should raise error, if extension_type get duplicated' do
+      expect { Extensions.deserialize(testbinary, HandshakeType::CLIENT_HELLO) }
+        .to raise_error(ErrorAlerts)
+    end
+  end
 end