oversip 1.2.1 → 1.3.0.dev1

data/lib/oversip/master_process.rb

@@ -18,6 +18,8 @@ gem "escape_utils", ">= 0.2.4"
 require "escape_utils"
 gem "posix-spawn", ">= 0.3.6"
 require "posix-spawn"
+gem "em-synchrony", ">=1.0.2"
+require "em-synchrony"
 
 
 # OverSIP files.
@@ -29,8 +31,8 @@ require "oversip/sip/core.rb"
 require "oversip/sip/message.rb"
 require "oversip/sip/request.rb"
 require "oversip/sip/response.rb"
-require "oversip/sip/grammar/uri.rb"
-require "oversip/sip/grammar/name_addr.rb"
+require "oversip/sip/uri.rb"
+require "oversip/sip/name_addr.rb"
 require "oversip/sip/message_processor.rb"
 require "oversip/sip/listeners.rb"
 require "oversip/sip/launcher.rb"
@@ -40,7 +42,10 @@ require "oversip/sip/transport_manager.rb"
 require "oversip/sip/timers.rb"
 require "oversip/sip/tags.rb"
 require "oversip/sip/rfc3263.rb"
+require "oversip/sip/client.rb"
 require "oversip/sip/proxy.rb"
+require "oversip/sip/uac.rb"
+require "oversip/sip/uac_request.rb"
 
 require "oversip/websocket/websocket.rb"
 require "oversip/websocket/ws_http_parser.so"

data/lib/oversip/proxies_config.rb

@@ -14,6 +14,8 @@ module OverSIP
       :use_dns                    => true,
       :use_dns_cache              => true,
       :dns_cache_time             => 300,
+      :use_blacklist              => true,
+      :blacklist_time             => 10,
       :use_naptr                  => true,
       :use_srv                    => true,
       :transport_preference       => ["tls", "tcp", "udp"],
@@ -31,6 +33,8 @@ module OverSIP
       :use_dns                    => :boolean, 
       :use_dns_cache              => :boolean,
       :dns_cache_time             => [ :fixnum, [ :greater_equal_than, 300 ] ],
+      :use_blacklist              => :boolean,
+      :blacklist_time             => [ :fixnum, [ :greater_equal_than, 2 ], [ :minor_equal_than, 600 ] ],
       :use_naptr                  => :boolean,
       :use_srv                    => :boolean,
       :transport_preference       => [ [ :choices, %w{tls tcp udp}], :multi_value, :non_empty ],
@@ -163,7 +167,10 @@ module OverSIP
         @proxies[proxy][:has_sip_tls] = @proxies[proxy][:transport_preference].include?(:tls)
 
         # Add a hash for the DNS cache.
-        @proxies[proxy][:dns_cache] = {}  if @proxies[proxy][:use_dns_cache]
+        @proxies[proxy][:dns_cache] = {}
+
+        # Add a hash for the blacklist.
+        @proxies[proxy][:blacklist] = {}
       end
     end
 

data/lib/oversip/sip/client.rb

@@ -0,0 +1,304 @@
+module OverSIP::SIP
+
+  class Client
+
+    include ::OverSIP::Logger
+
+    attr_reader :current_target
+
+    def initialize proxy_profile=:default_proxy
+      unless (@conf = ::OverSIP.proxies[proxy_profile.to_sym])
+        raise ::OverSIP::RuntimeError, "proxy profile '#{proxy_profile}' is not defined"
+      end
+    end
+
+    def on_provisional_response &block
+      @on_provisional_response_block = block
+    end
+
+    def on_success_response &block
+      @on_success_response_block = block
+    end
+
+    def on_failure_response &block
+      @on_failure_response_block = block
+    end
+
+    def on_canceled &block
+      @on_canceled_block = block
+    end
+
+    def on_invite_timeout &block
+      @on_invite_timeout_block = block
+    end
+
+    def on_error &block
+      @on_error_block = block
+    end
+
+    def on_target &block
+      @on_target_block = block
+    end
+
+    # By calling this method the request routing is aborted, no more DNS targets are tryed,
+    # a local 403 response is generated and on_error() callback is called with status 403.
+    def abort_routing
+      @aborted = true
+    end
+
+    # Manually insert the last target into the blacklist. Optionally a timeout value can be given
+    # (otherwise the proxy blacklist_time is used). The timeout must be between 2 and 600 seconds.
+    # Also the SIP code and reason can be passed.
+    def add_target_to_blacklist timeout=nil, status_code=403, reason_phrase="Destination Blacklisted"
+      return false  unless @current_target
+
+      if timeout
+        timeout = timeout.to_i
+        if timeout < 2 or timeout > 600
+          raise ::OverSIP::RuntimeError, "timeout must be between a and 600 seconds"
+        end
+      else
+        timeout = @conf[:blacklist_time]
+      end
+
+      blacklist_entry = @current_target.to_s
+      @conf[:blacklist][blacklist_entry] = [status_code, reason_phrase, nil, :destination_blacklisted]
+      ::EM.add_timer(timeout) { @conf[:blacklist].delete blacklist_entry }
+    end
+
+
+    ### Methods called by the client transaction.
+
+    def client_timeout
+      # Store the target and error in the blacklist.
+      if @conf[:use_blacklist]
+        blacklist_entry = @current_target.to_s
+        @conf[:blacklist][blacklist_entry] = [408, "Client Timeout", nil, :client_timeout]
+        ::EM.add_timer(@conf[:blacklist_time]) { @conf[:blacklist].delete blacklist_entry }
+      end
+
+      try_next_target 408, "Client Timeout", nil, :client_timeout
+    end
+
+    def connection_failed
+      # Store the target and error in the blacklist.
+      if @conf[:use_blacklist]
+        blacklist_entry = @current_target.to_s
+        @conf[:blacklist][blacklist_entry] = [500, "Connection Error", nil, :connection_error]
+        ::EM.add_timer(@conf[:blacklist_time]) { @conf[:blacklist].delete blacklist_entry }
+      end
+
+      try_next_target 500, "Connection Error", nil, :connection_error
+    end
+
+    def tls_validation_failed
+      # Store the target and error in the blacklist.
+      if @conf[:use_blacklist]
+        blacklist_entry = @current_target.to_s
+        @conf[:blacklist][blacklist_entry] = [500, "TLS Validation Failed", nil, :tls_validation_failed]
+        ::EM.add_timer(@conf[:blacklist_time]) { @conf[:blacklist].delete blacklist_entry }
+      end
+
+      try_next_target 500, "TLS Validation Failed", nil, :tls_validation_failed
+    end
+
+    # Timer C for INVITE.
+    def invite_timeout
+      @on_invite_timeout_block && @on_invite_timeout_block.call
+    end
+
+
+
+    private
+
+
+    def add_routing_headers
+    end
+
+
+    # Check the given URI into the DNS cache.
+    # - If the cache is not enabled it returns nil.
+    # - If present it returns true.
+    # - If not it returns dns_cache_key (String).
+    def check_dns_cache dst_scheme, dst_host, dst_host_type, dst_port, dst_transport
+      if dst_host_type == :domain and @conf[:use_dns_cache]
+        dns_cache_key = "#{dst_scheme}|#{dst_host}|#{dst_port}|#{dst_transport}"
+        if (result = @conf[:dns_cache][dns_cache_key])
+          log_system_debug "destination found in the DNS cache"  if $oversip_debug
+          if result.is_a? ::Symbol
+            rfc3263_failed result
+          else
+            rfc3263_succeeded result
+          end
+          return true
+        else
+          return dns_cache_key
+        end
+      else
+        return nil
+      end
+    end
+
+
+    def do_dns dns_cache_key, id, dst_scheme, dst_host, dst_host_type, dst_port, dst_transport
+      # Perform RFC 3261 procedures.
+      dns_query = ::OverSIP::SIP::RFC3263::Query.new @conf, id, dst_scheme, dst_host, dst_host_type, dst_port, dst_transport
+      case result = dns_query.resolve
+
+      # Async result so DNS took place.
+      when nil
+        # Async success.
+        dns_query.callback do |result|
+          # Store the result in the DNS cache.
+          if dns_cache_key
+            @conf[:dns_cache][dns_cache_key] = result
+            ::EM.add_timer(@conf[:dns_cache_time]) { @conf[:dns_cache].delete dns_cache_key }
+          end
+          rfc3263_succeeded result
+        end
+        # Async error.
+        dns_query.errback do |result|
+          # Store the result in the DNS cache.
+          if dns_cache_key
+            @conf[:dns_cache][dns_cache_key] = result
+            ::EM.add_timer(@conf[:dns_cache_time]) { @conf[:dns_cache].delete dns_cache_key }
+          end
+          rfc3263_failed result
+        end
+      # Instant error.
+      when ::Symbol
+        # Store the result in the DNS cache.
+        if dns_cache_key
+          @conf[:dns_cache][dns_cache_key] = result
+          ::EM.add_timer(@conf[:dns_cache_time]) { @conf[:dns_cache].delete dns_cache_key }
+        end
+        rfc3263_failed result
+      # Instant success so it's not a domain (no DNS performed).
+      else
+        rfc3263_succeeded result
+      end
+    end
+
+
+    def rfc3263_succeeded result
+      # After RFC 3263 (DNS) resolution we get N targets.
+      @num_target = 0  # First target is 0 (rather than 1).
+      @target = @targets = nil  # Avoid conflicts if same Proxy is used for serial forking to a new destination.
+
+      case result
+
+      when RFC3263::Target
+        @target = result  # Single Target.
+
+      when RFC3263::SrvTargets
+        log_system_debug "DNS result has multiple values, randomizing"  if $oversip_debug
+        @targets = result.randomize  # Array of Targets.
+
+      # This can contain Target and SrvTargets entries.
+      when RFC3263::MultiTargets
+        log_system_debug "DNS result has multiple values, randomizing"  if $oversip_debug
+        @targets = result.flatten  # Array of Targets.
+
+      end
+
+      try_next_target
+    end  # rfc3263_succeeded
+
+
+    def try_next_target status=nil, reason=nil, full_response=nil, code=nil
+      # Single target.
+      if @target and @num_target == 0
+        @current_target = @target
+        log_system_debug "trying single target: #{@current_target}"  if $oversip_debug
+        @num_target = 1
+        use_target @current_target
+
+      # Multiple targets (so @targets is set).
+      elsif @targets and @num_target < @targets.size
+        @current_target = @targets[@num_target]
+        log_system_debug "trying target #{@num_target+1} of #{@targets.size}: #{@current_target}"  if $oversip_debug
+        @num_target += 1
+        use_target @current_target
+
+      # No more targets.
+      else
+        no_more_targets status, reason, full_response, code
+      end
+    end  # try_next_target
+
+
+    def use_target target
+      # Lookup the target in the blacklist.
+      if @conf[:blacklist].any? and (blacklist_entry = @conf[:blacklist][target.to_s])
+        log_system_notice "destination found in the blacklist"  if $oversip_debug
+        try_next_target blacklist_entry[0], blacklist_entry[1], blacklist_entry[2], blacklist_entry[3]
+        return
+      end
+
+      # Call the on_target() callback if set by the user.
+      @on_target_block && @on_target_block.call(target)
+
+      # If the user has called to proxy.abort_routing() then stop next targets
+      # and call to on_error() callback.
+      if @aborted
+        log_system_notice "routing aborted for target #{target}"
+        @aborted = @target = @targets = nil
+        try_next_target 403, "Destination Aborted", nil, :destination_aborted
+        return
+      end
+
+      @client_transaction = (::OverSIP::SIP::ClientTransaction.get_class @request).new self, @request, @conf, target.transport, target.ip, target.ip_type, target.port
+      add_routing_headers
+      @client_transaction.send_request
+    end
+
+
+    def no_more_targets status, reason, full_response, code
+    end
+
+
+    def rfc3263_failed error
+      case error
+      when :rfc3263_domain_not_found
+        log_system_debug "no resolution"  if $oversip_debug
+        status = 404
+        reason = "No DNS Resolution"
+        code = :no_dns_resolution
+      when :rfc3263_unsupported_scheme
+        log_system_debug "unsupported URI scheme"  if $oversip_debug
+        status = 416
+        reason = "Unsupported URI scheme"
+        code = :unsupported_uri_scheme
+      when :rfc3263_unsupported_transport
+        log_system_debug "unsupported transport"  if $oversip_debug
+        status = 478
+        reason = "Unsupported Transport"
+        code = :unsupported_transport
+      when :rfc3263_no_ipv4
+        log_system_debug "destination requires unsupported IPv4"  if $oversip_debug
+        status = 478
+        reason = "Destination Requires Unsupported IPv4"
+        code = :no_ipv4
+      when :rfc3263_no_ipv6
+        log_system_debug "destination requires unsupported IPv6"  if $oversip_debug
+        status = 478
+        reason = "Destination Requires Unsupported IPv6"
+        code = :no_ipv6
+      when :rfc3263_no_dns
+        log_system_debug "destination requires unsupported DNS query"  if $oversip_debug
+        status = 478
+        reason = "Destination Requires Unsupported DNS Query"
+        code = :no_dns
+      end
+
+      do_dns_fail status, reason, code
+    end  # def rfc3263_failed
+
+
+    def do_dns_fail status, reason, code
+      @on_error_block && @on_error_block.call(status, reason, code)
+    end
+
+  end  # class Client
+
+end

data/lib/oversip/sip/client_transaction.rb

@@ -22,7 +22,7 @@ module OverSIP::SIP
       @transaction_id = ::SecureRandom.hex(4) << @request.antiloop_id
 
       # A client transaction for using an existing Outbound connection.
-      if transport.is_a? String
+      if transport.is_a? ::String
         @connection, @ip, @port = ::OverSIP::SIP::TransportManager.get_outbound_connection transport
         if @connection
           @server_klass = @connection.class
@@ -59,10 +59,13 @@ module OverSIP::SIP
       end
 
       # Ensure the request has Content-Length. Add it otherwise.
-      if @request.body
-        @request.headers["Content-Length"] = [ @request.body.bytesize.to_s ]
-      else
-        @request.headers["Content-Length"] = HDR_ARRAY_CONTENT_LENGTH_0
+      # NOTE: Don't do this for UAcRequest instances!
+      if @request.is_a? ::OverSIP::SIP::Request
+        if @request.body
+          @request.headers["Content-Length"] = [ @request.body.bytesize.to_s ]
+        else
+          @request.headers["Content-Length"] = HDR_ARRAY_CONTENT_LENGTH_0
+        end
       end
 
     end # def initialize
@@ -107,24 +110,20 @@ module OverSIP::SIP
       when :both_outbound_rr
         @out_rr = :rr
         @request.insert_header "Record-Route", "<sip:" << @request.route_outbound_flow_token << @server_klass.outbound_record_route_fragment
-      end
-
-      @request_leg_b = @request.to_s
+      end  if @request.in_rr
 
-      # NOTE: This cannot return false as the connection has been retrieved from the corresponding hash,
-      # and when a connection is terminated its value is automatically deleted from such hash.
-      @connection.send_sip_msg @request_leg_b, @ip, @port
+      @outgoing_request_str = @request.to_s
 
       @request.delete_header_top "Via"
       if @out_rr == :rr
         @request.delete_header_top "Record-Route"
       end
 
+      @connection.send_sip_msg @outgoing_request_str, @ip, @port
+
       start_timer_A  if @transport == :udp
       start_timer_B
       start_timer_C
-
-      true
     end
 
     def start_timer_A
@@ -177,7 +176,7 @@ module OverSIP::SIP
     end
 
     def retransmit_request
-      @connection.send_sip_msg @request_leg_b, @ip, @port
+      @connection.send_sip_msg @outgoing_request_str, @ip, @port
     end
 
     def receive_response response
@@ -284,21 +283,21 @@ module OverSIP::SIP
         @ack << "Via: #{@top_via}\r\n"
 
         @request.hdr_route.each do |route|
-          @ack << "Route: " << route << "\r\n"
+          @ack << "Route: " << route << CRLF
         end  if @request.hdr_route
 
-        @ack << "From: " << @request.hdr_from << "\r\n"
+        @ack << "From: " << @request.hdr_from << CRLF
         @ack << "To: " << @request.hdr_to
         unless @request.to_tag
           @ack << ";tag=#{response.to_tag}"  if response.to_tag
         end
-        @ack << "\r\n"
+        @ack << CRLF
 
-        @ack << "Call-ID: " << @request.call_id << "\r\n"
+        @ack << "Call-ID: " << @request.call_id << CRLF
         @ack << "CSeq: " << @request.cseq.to_s << " ACK\r\n"
         @ack << "Content-Length: 0\r\n"
-        @ack << HDR_USER_AGENT << "\r\n"
-        @ack << "\r\n"
+        @ack << HDR_USER_AGENT << CRLF
+        @ack << CRLF
       end
 
       log_system_debug "sending ACK for [3456]XX response"  if $oversip_debug
@@ -315,21 +314,21 @@ module OverSIP::SIP
       @cancel << "Via: #{@top_via}\r\n"
 
       @request.hdr_route.each do |route|
-        @cancel << "Route: " << route << "\r\n"
+        @cancel << "Route: " << route << CRLF
       end  if @request.hdr_route
 
       # RFC 3326. Copy Reason headers if present in the received CANCEL.
       cancel.header_all("Reason").each do |reason|
-        @cancel << "Reason: " << reason << "\r\n"
+        @cancel << "Reason: " << reason << CRLF
       end  if cancel
 
-      @cancel << "From: " << @request.hdr_from << "\r\n"
-      @cancel << "To: " << @request.hdr_to << "\r\n"
-      @cancel << "Call-ID: " << @request.call_id << "\r\n"
+      @cancel << "From: " << @request.hdr_from << CRLF
+      @cancel << "To: " << @request.hdr_to << CRLF
+      @cancel << "Call-ID: " << @request.call_id << CRLF
       @cancel << "CSeq: " << @request.cseq.to_s << " CANCEL\r\n"
       @cancel << "Content-Length: 0\r\n"
-      @cancel << HDR_USER_AGENT << "\r\n"
-      @cancel << "\r\n"
+      @cancel << HDR_USER_AGENT << CRLF
+      @cancel << CRLF
 
       # Just send the ACK inmediately if the branch has replied a 1XX response.
       send_cancel  if @state == :proceeding
@@ -437,11 +436,9 @@ module OverSIP::SIP
       when :both_outbound_path
         @out_rr = :rr
         @request.insert_header "Path", "<sip:" << @request.route_outbound_flow_token << @server_klass.outbound_path_fragment
-      end
-
-      @request_leg_b = @request.to_s
+      end  if @core.is_a? ::OverSIP::SIP::Proxy
 
-      @connection.send_sip_msg @request_leg_b, @ip, @port
+      @outgoing_request_str = @request.to_s
 
       @request.delete_header_top "Via"
       case @out_rr
@@ -451,10 +448,10 @@ module OverSIP::SIP
         @request.delete_header_top "Path"
       end
 
+      @connection.send_sip_msg @outgoing_request_str, @ip, @port
+
       start_timer_E  if @transport == :udp
       start_timer_F
-
-      true
     end
 
     def start_timer_E
@@ -493,7 +490,7 @@ module OverSIP::SIP
     end
 
     def retransmit_request
-      @connection.send_sip_msg @request_leg_b, @ip, @port
+      @connection.send_sip_msg @outgoing_request_str, @ip, @port
     end
 
     def receive_response response
@@ -570,8 +567,6 @@ module OverSIP::SIP
       @request.insert_header "Via", "#{@server_klass.via_core};branch=z9hG4bK#{@transaction_id}"
 
       @connection.send_sip_msg @request.to_s, @ip, @port
-
-      true
     end
 
     def connection_failed

data/lib/oversip/sip/core.rb

@@ -63,13 +63,16 @@ module OverSIP::SIP
 
       # Outgoing initial request asking for Outbound. Just valid when:
       # - It's an initial request.
+      # - The request comes via UDP or comes via TCP/TLS/WS/WSS but through a connection
+      #   opened by the peer (and not by OverSIP).
       # - Single Via (so there is no a proxy in front of us).
       # - It's an INVITE, REGISTER, SUBSCRIBE or REFER request.
       # - Has a preloaded top Route with ;ob param pointing to us, or has Contact with ;ob, or
-      #   it's a REGISTER with ;+sip.instance.
+      #   it's a REGISTER with ;+sip.instance..
       #
       if (
-            initial? and (
+            initial? and
+            @connection.class.outbound_listener? and (
               @force_outgoing_outbound or (
                 @num_vias == 1 and
                 outbound_aware? and (
@@ -164,8 +167,8 @@ module OverSIP::SIP
     def connection_outbound_flow_token
       @connection_outbound_flow_token ||= if @transport == :udp
         # NOTE: Add "_" so later we can figure that this is for UDP.
-        # NOTE: Replace "=" with "-" so it can be added as a SIP URI param (when Contact mangling is used
-        # if the registrar does not support Path).
+        # NOTE: Replace "=" with "-" so it can be added as a SIP URI param (needed i.e.
+        # for the OutboundMangling module).
         "_" << ::Base64.strict_encode64("#{@source_ip}_#{@source_port}").gsub(/=/,"-")
       else
         @connection.outbound_flow_token