oversip 1.1.2 → 1.2.0

data/lib/oversip.rb

@@ -13,6 +13,10 @@ require "tempfile"
 require "term/ansicolor"
 require "posix_mq"
 require "syslog"
+# Load EventMachine-LE here to avoid som EM based gem in server.rb to be loaded first
+# (and load eventmachine instead of eventmachine-le).
+gem "eventmachine-le", ">= 1.1.3"
+require "eventmachine-le"
 
 
 # OverSIP files.
@@ -29,6 +33,7 @@ require "oversip/utils.so"
 require "oversip/utils.rb"
 require "oversip/posix_mq.rb"
 require "oversip/default_server.rb"
+require "oversip/system_callbacks.rb"
 
 
 
@@ -59,5 +64,9 @@ module OverSIP
   # Pre-declare internal modules.
   module SIP ; end
   module WebSocket ; end
+  module Modules ; end
+
+  # Allow OverSIP::M::MODULE_NAME usage.
+  M = Modules
 
 end

data/test/test_uri.rb

@@ -6,23 +6,27 @@ require "oversip_test_helper"
 class TestUri < OverSIPTest
 
   def test_sip_uri
-    full_uri = "sip:alice@atlanta.com:5060;transport=tcp;foo=123;baz?X-Header-1=qwe&X-Header-2=asd"
+    full_uri = "sips:i%C3%B1aki@aliax.net:5060;transport=tcp;foo=123;baz?X-Header-1=qwe&X-Header-2=asd"
+    aor = "sip:i%C3%B1aki@aliax.net"
 
     uri = ::OverSIP::SIP::Uri.new
-    uri.instance_variable_set :@scheme, :sip
-    uri.user = "alice"
-    uri.host = "atlanta.com"
+    uri.instance_variable_set :@scheme, :sips
+    uri.user = "iñaki"
+    uri.host = "aliax.net"
     uri.host_type = :domain
     uri.port = 5060
     uri.transport_param = :tcp
     uri.instance_variable_set :@params, {"transport"=>"tcp", "foo"=>"123", "baz"=>nil}
     uri.headers = "?X-Header-1=qwe&X-Header-2=asd"
 
+    assert_equal "iñaki", uri.user
+    assert_equal aor, uri.aor
     assert_equal full_uri, uri.to_s
   end
 
   def test_tel_uri
     full_uri = "tel:944991212;foo=bar;phone-context=+34"
+    aor = "tel:944991212"
 
     uri = ::OverSIP::SIP::Uri.new
     uri.instance_variable_set :@scheme, :tel
@@ -30,15 +34,18 @@ class TestUri < OverSIPTest
     uri.instance_variable_set :@params, {"foo"=>"bar"}
     uri.phone_context_param = "+34"
 
+    assert_equal aor, uri.aor
     assert_equal full_uri, uri.to_s
   end
 
   def test_http_uri
     full_uri = "http://oversip.net/authors/"
+    aor = nil
 
     uri = ::OverSIP::SIP::Uri.new
     uri.instance_variable_set :@uri, full_uri
 
+    assert_nil uri.aor
     assert_equal full_uri, uri.to_s
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oversip
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-29 00:00:00.000000000 Z
+date: 2012-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine-le
-  requirement: &19734060 !ruby/object:Gem::Requirement
+  requirement: &18819520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 1.1.3
   type: :runtime
   prerelease: false
-  version_requirements: *19734060
+  version_requirements: *18819520
 - !ruby/object:Gem::Dependency
   name: iobuffer
-  requirement: &19733500 !ruby/object:Gem::Requirement
+  requirement: &18819060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 1.1.2
   type: :runtime
   prerelease: false
-  version_requirements: *19733500
+  version_requirements: *18819060
 - !ruby/object:Gem::Dependency
   name: em-posixmq
-  requirement: &19732980 !ruby/object:Gem::Requirement
+  requirement: &18818600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: 0.2.3
   type: :runtime
   prerelease: false
-  version_requirements: *19732980
+  version_requirements: *18818600
 - !ruby/object:Gem::Dependency
   name: em-udns
-  requirement: &19732500 !ruby/object:Gem::Requirement
+  requirement: &18818140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: 0.3.6
   type: :runtime
   prerelease: false
-  version_requirements: *19732500
+  version_requirements: *18818140
 - !ruby/object:Gem::Dependency
   name: escape_utils
-  requirement: &19732040 !ruby/object:Gem::Requirement
+  requirement: &18587760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: 0.2.4
   type: :runtime
   prerelease: false
-  version_requirements: *19732040
+  version_requirements: *18587760
 - !ruby/object:Gem::Dependency
   name: term-ansicolor
-  requirement: &19731660 !ruby/object:Gem::Requirement
+  requirement: &18587300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *19731660
+  version_requirements: *18587300
 - !ruby/object:Gem::Dependency
   name: posix-spawn
-  requirement: &19731120 !ruby/object:Gem::Requirement
+  requirement: &18586620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: 0.3.6
   type: :runtime
   prerelease: false
-  version_requirements: *19731120
+  version_requirements: *18586620
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &19730620 !ruby/object:Gem::Requirement
+  requirement: &18585920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -98,7 +98,7 @@ dependencies:
         version: 0.9.2
   type: :development
   prerelease: false
-  version_requirements: *19730620
+  version_requirements: *18585920
 description: ! 'OverSIP is an async SIP proxy/server programmable in Ruby language.
   Some features of OverSIP are:
 
@@ -148,6 +148,7 @@ files:
 - lib/oversip/logger.rb
 - lib/oversip/fiber_pool.rb
 - lib/oversip/syslogger_process.rb
+- lib/oversip/system_callbacks.rb
 - lib/oversip/config.rb
 - lib/oversip/launcher.rb
 - lib/oversip/ruby_ext/eventmachine.rb
@@ -162,6 +163,7 @@ files:
 - lib/oversip/sip/message_processor.rb
 - lib/oversip/sip/response.rb
 - lib/oversip/sip/transport_manager.rb
+- lib/oversip/sip/core.rb
 - lib/oversip/sip/client_transaction.rb
 - lib/oversip/sip/message.rb
 - lib/oversip/sip/constants.rb
@@ -189,9 +191,6 @@ files:
 - lib/oversip/sip/listeners/tls_tunnel_connection.rb
 - lib/oversip/sip/grammar/uri.rb
 - lib/oversip/sip/grammar/name_addr.rb
-- lib/oversip/sip/modules/registrar_without_path.rb
-- lib/oversip/sip/modules/core.rb
-- lib/oversip/sip/modules/user_assertion.rb
 - lib/oversip/websocket/listeners.rb
 - lib/oversip/websocket/http_request.rb
 - lib/oversip/websocket/ws_framing.rb
@@ -209,6 +208,8 @@ files:
 - lib/oversip/websocket/listeners/ipv4_ws_server.rb
 - lib/oversip/websocket/listeners/ipv6_wss_server.rb
 - lib/oversip/websocket/listeners/wss_tunnel_server.rb
+- lib/oversip/modules/outbound_mangling.rb
+- lib/oversip/modules/user_assertion.rb
 - ext/common/ruby_c_util.h
 - ext/common/c_util.h
 - ext/sip_parser/extconf.rb
@@ -268,7 +269,7 @@ require_paths:
 required_ruby_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ~>
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement

data/lib/oversip/sip/modules/core.rb

@@ -1,194 +0,0 @@
-module OverSIP::SIP
-
-  module Modules
-    module Core
-
-      # Create a server transaction for the incoming request.
-      def create_transaction
-        return false  if @server_transaction
-
-        case @sip_method
-        when :INVITE
-          ::OverSIP::SIP::InviteServerTransaction.new self
-          return true
-        when :ACK
-          return nil
-        when :CANCEL
-          return nil
-        else
-          ::OverSIP::SIP::NonInviteServerTransaction.new self
-          return true
-        end
-      end
-
-
-      def check_max_forwards max_forwards
-        if @max_forwards
-          unless @max_forwards.zero?
-            @new_max_forwards = ( @max_forwards > max_forwards ? max_forwards : @max_forwards - 1 )
-            return true
-          else
-            log_system_notice "Max-Forwards is 0 => 483"
-            reply 483
-            return false
-          end
-        else
-          @new_max_forwards = max_forwards
-          return true
-        end
-      end
-
-
-      def loose_route
-        num_removes = 0
-        has_preloaded_route_with_ob_param = false
-
-        # Remove all the Route's pointing to the proxy until a Route not pointing to us is found.
-        if @routes
-          @routes.each do |route|
-            if ::OverSIP::SIP::Tags.check_value_for_route_ovid(route.ovid_param)
-              num_removes += 1
-            else
-              if local_uri? route
-                has_preloaded_route_with_ob_param = true  if route.ob_param?
-                num_removes += 1
-              else
-                break
-              end
-            end
-          end
-        end
-
-        ### Outbound stuf. RFC 5626 section 5.3.
-
-        # Outgoing initial request asking for Outbound. Just valid when:
-        # - It's an initial request.
-        # - 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.
-        #
-        if (
-              initial? and (
-                @force_outgoing_outbound or (
-                  @num_vias == 1 and
-                  outbound_aware? and (
-                    ( has_preloaded_route_with_ob_param or (@contact and @contact.ob_param?) ) or
-                    ( @sip_method == :REGISTER and contact_reg_id?)
-                  )
-                )
-              )
-            )
-          @outgoing_outbound_requested = true
-          log_system_debug "applying outgoing Outbound support"  if $oversip_debug
-        end
-
-        # Incoming initial request or in-dialog incoming/outgoing request. Must only perform
-        # Outbound for the incoming case and just when:
-        # - There are 2 Route headers.
-        # - All the Route headers point to us.
-        # - The latest Route has a flow token and a valid ;ovid param (so has been generated
-        #   previously by us).
-        #     NOTE: But don't check its value so it still would work in case of server reboot.
-        # - It's an incoming Outbound request (so flow token in the Route does not match the
-        #   flow token of the incoming connection).
-        if (
-              num_removes == 2 and
-              @routes.size == 2 and
-              (outbound_route = @routes.last) and
-              outbound_route.ovid_param and
-              (@route_outbound_flow_token = outbound_route.user) != @connection_outbound_flow_token
-            )
-          @incoming_outbound_requested = true
-          log_system_debug "destination is an incoming Outbound connection"  if $oversip_debug
-        end
-
-        # If there are not Route headers return false.
-        return false  unless @routes
-
-        # Remove the Route values pointintg to us.
-        unless num_removes == 0
-          @headers["Route"].shift num_removes
-          @routes.shift num_removes
-        end
-        @routes.empty? and @routes = nil
-
-        # Return true if it is an in-dialog request and the top Route pointed to us.
-        # False otherwise as we shouldn't receive an in-dialog request with a top Route non
-        # pointing to us.
-        if in_dialog?
-          return ( num_removes > 0 ? true : false )
-        # Return true if it was an initial request and more Route headers remain after inspection.
-        elsif @routes
-          return true
-        # Return false if it was an initial request and all its Route headers pointed to the proxy.
-        else
-          return false
-        end
-      end
-
-
-      # Checks whether the RURI points to a local domain or address.
-      # Typically, prior to using this method the user has verified the return value of loose_route()
-      # in case it's an initial request (if it's _true_ then the request has pre-loaded Route).
-      def destination_myself?
-        return true if @destination_myself
-        return false if @destination_myself == false
-
-        if local_uri? @ruri
-          log_system_debug "RURI destination is myself"  if $oversip_debug
-          return @destination_myself = true
-        else
-          log_system_debug "RURI destination is not myself"  if $oversip_debug
-          return @destination_myself = false
-        end
-      end
-
-
-      def fix_nat
-        # Force rport usage for UDP clients.
-        @via_rport = @source_port
-
-        # Force outgoing Outbound.
-        if initial? and @num_vias == 1 and outbound_aware?
-          @force_outgoing_outbound = true
-        end
-      end
-
-
-      def outgoing_outbound_requested?       ; @outgoing_outbound_requested  end
-
-      def incoming_outbound_requested?       ; @incoming_outbound_requested  end
-
-
-      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).
-          "_" << ::Base64.strict_encode64("#{@source_ip}_#{@source_port}").gsub(/=/,"-")
-        else
-          @connection.outbound_flow_token
-        end
-      end
-
-
-      private
-
-
-      def local_uri? uri
-        # NOTE: uri.host has been normalized during parsing in case it's an IPv6 and it's
-        # an :ipv6_reference.
-        ( uri.port and ::OverSIP::SIP.local_aliases["#{uri.host}:#{uri.port}"] ) or
-        ( not uri.port and ::OverSIP::SIP.local_aliases[uri.host] )
-      end
-
-    end  # module Core
-  end  # module Modules
-
-
-  class Request
-    include ::OverSIP::SIP::Modules::Core
-  end
-
-end

data/lib/oversip/sip/modules/registrar_without_path.rb

@@ -1,72 +0,0 @@
-module OverSIP::SIP
-
-  module Modules
-    module RegistrarWithoutPath
-
-      extend ::OverSIP::Logger
-
-      def self.log_id
-        @@log_id ||= "RegistrarWithoutPath module"
-      end
-
-      def self.add_outbound_to_contact request
-        unless request.sip_method == :REGISTER
-          raise ::OverSIP::RuntimeError, "request must be a REGISTER"
-        end
-
-        if request.contact and request.connection_outbound_flow_token
-          log_system_debug "performing Contact mangling (adding ;ov-ob Outbound param) for #{request.log_id}"  if $oversip_debug
-
-          # Add the ;ov-ob param to the Contact URI.
-          request.contact.set_param "ov-ob", request.connection_outbound_flow_token
-          # NOTE: request.contact_params is a String with the original Contact URI params
-          # so they are added at the end of the new URI with the added ;ov-ob param.
-          # TODO: This should be done automatically, right?
-          request.set_header "Contact", "#{request.contact.to_s}#{request.contact_params}"
-          return true
-        else
-          return false
-        end
-      end
-
-      def self.extract_outbound_from_ruri request
-        # Do nothing if the request already contains a Route header with the Outbound flow token (so
-        # the registrar *does* support Path).
-        unless request.incoming_outbound_requested?
-          if (ov_ob = request.ruri.del_param("ov-ob"))
-            log_system_debug "incoming Outbound flow token extracted from ;ov-ob param in RURI for #{request.log_id}"  if $oversip_debug
-            request.route_outbound_flow_token = ov_ob
-            request.incoming_outbound_requested = true
-            return true
-          else
-            return false
-          end
-
-        else
-          # If the request already contains a proper Outbound Route header, then at least try to remove
-          # the ;ov-ob param from the RURI.
-          request.ruri.del_param("ov-ob")
-          return false
-        end
-      end
-
-      def self.remove_outbound_from_contact message
-        unless message.is_a? ::OverSIP::SIP::Message
-          raise ::OverSIP::RuntimeError, "message must be a OverSIP::SIP::Request or OverSIP::SIP::Response"
-        end
-
-        if (contacts = message.headers["Contact"])
-          log_system_debug "reverting original Contact value (removing ;ov-ob Outbound param) for response"  if $oversip_debug
-          contacts.each do |contact|
-            contact.gsub! /;ov-ob=[_\-0-9A-Za-z]+/, ""
-          end
-          return true
-        else
-          return false
-        end
-      end
-
-    end  # module RegistrarWithoutPath
-  end  # module Modules
-
-end  # module OverSIP::SIP

data/lib/oversip/sip/modules/user_assertion.rb

@@ -1,77 +0,0 @@
-module OverSIP::SIP
-
-  module Modules
-    module UserAssertion
-
-      extend ::OverSIP::Logger
-
-      def self.log_id
-        @@log_id ||= "UserAssertion module"
-      end
-
-      def self.assert_connection message
-        case message
-        when ::OverSIP::SIP::Request
-          request = message
-        when ::OverSIP::SIP::Response
-          request = message.request
-        else
-          raise ::OverSIP::RuntimeError, "message must be a OverSIP::SIP::Request or OverSIP::SIP::Response"
-        end
-
-        # Don't do this stuf for UDP or for outbound connections.
-        return false  unless request.connection.class.reliable_transport_listener?
-        # Return if already set.
-        return request.cvars[:asserted_user]  if request.cvars[:asserted_user]
-        # Don't do this stuf in case of P-Preferred-Identity header is present.
-        return false  if request.headers["P-Preferred-Identity"]
-
-        log_system_debug "user #{request.from.uri} asserted to connection"  if $oversip_debug
-        # Store the request From URI as "asserted_user" for this connection.
-        request.cvars[:asserted_user] = request.from.uri
-      end
-
-      def self.revoke_assertion message
-        case message
-        when ::OverSIP::SIP::Request
-          request = message
-        when ::OverSIP::SIP::Response
-          request = message.request
-        else
-          raise ::OverSIP::RuntimeError, "message must be a OverSIP::SIP::Request or OverSIP::SIP::Response"
-        end
-
-        request.cvars.delete :asserted_user
-        true
-      end
-
-      def self.add_pai request
-        # Add P-Asserted-Identity if the user has previously been asserted but JUST
-        # in case it matches request From URI !
-        # NOTE: If the connection is not asserted (it's null) then it will not match this
-        # comparisson, so OK.
-        if request.cvars[:asserted_user] == request.from.uri
-          # Don't add P-Asserted-Identity if the request contains P-Preferred-Identity header.
-          unless request.headers["P-Preferred-Identity"]
-            log_system_debug "user asserted, adding P-Asserted-Identity for #{request.log_id}"  if $oversip_debug
-            request.set_header "P-Asserted-Identity", "<" << request.cvars[:asserted_user] << ">"
-            return true
-          else
-            # Remove posible P-Asserted-Identity header!
-            log_system_debug "user asserted but P-Preferred-Identity header present, P-Asserted-Identity not added for #{request.log_id}"  if $oversip_debug
-            request.headers.delete "P-Asserted-Identity"
-            return nil
-          end
-
-        # Otherwise ensure the request has no spoofed P-Asserted-Identity headers!
-        else
-          request.headers.delete "P-Asserted-Identity"
-          return false
-
-        end
-      end
-
-    end  # module UserAssertion
-  end  # module Modules
-
-end