oversip 1.1.2 → 1.2.0

data/etc/server.rb

@@ -19,13 +19,15 @@ module MyExampleApp
   # Custom configuration options:
 
   # Set this to _true_ if the SIP registrar behind OverSIP does not support Path.
-  SIP_USE_MODULE_REGISTRAR_WITHOUT_PATH = true
+  # OverSIP::Modules::OutboundMangling methods will be used.
+  DO_OUTBOUND_MANGLING = true
 
   # Set this to _true_ if the SIP proxy/server behind OverSIP performing the authentication
   # is ready to accept a P-Asserted-Identity header from OverSIP indicating the already
   # asserted SIP user of the client's connection (this avoids authenticating all the requests
   # but the first one).
-  SIP_USE_MODULE_USER_ASSERTION = true
+  # OverSIP::Modules::UserAssertion methods will be used.
+  DO_USER_ASSERTION = true
 end
 
 
@@ -34,14 +36,23 @@ end
 ### OverSIP System Events:
 
 
-# This callback is called once the OverSIP reactor has been started.
+# This method is called when the main configuration files have been loaded.
+# Place here 3rd party modules initializer code.
+# This method is not executed again when OverSIP is reloaded (HUP signal).
+#
+# def (OverSIP::SystemEvents).on_initialize
+#   [...]
+# end
+
+
+# This method is called once the OverSIP reactor has been started.
 #
 # def (OverSIP::SystemEvents).on_started
 #   [...]
 # end
 
 
-# This callback is called when a USR1 signal is received by OverSIP main
+# This method is called when a USR1 signal is received by OverSIP main
 # process and allows the user to set custom code to be executed
 # or reloaded.
 #
@@ -50,7 +61,7 @@ end
 # end
 
 
-# This callback is called after OverSIP has been terminated. It's called
+# This method is called after OverSIP has been terminated. It's called
 # with argument "error" which is _true_ in case OverSIP has died in an
 # unexpected way.
 #
@@ -64,7 +75,7 @@ end
 ### OverSIP SIP Events:
 
 
-# This callback is called when a SIP request is received.
+# This method is called when a SIP request is received.
 #
 def (OverSIP::SipEvents).on_request request
 
@@ -107,9 +118,9 @@ def (OverSIP::SipEvents).on_request request
     return
   end
 
-  if MyExampleApp::SIP_USE_MODULE_REGISTRAR_WITHOUT_PATH
+  if MyExampleApp::DO_OUTBOUND_MANGLING
     # Extract the Outbound flow token from the RURI.
-    ::OverSIP::SIP::Modules::RegistrarWithoutPath.extract_outbound_from_ruri request
+    ::OverSIP::Modules::OutboundMangling.extract_outbound_from_ruri request
   end
 
   # The request goes to a client using Outbound through OverSIP.
@@ -149,8 +160,8 @@ def (OverSIP::SipEvents).on_request request
 
   when :INVITE, :MESSAGE, :OPTIONS, :SUBSCRIBE, :PUBLISH, :REFER
 
-    if MyExampleApp::SIP_USE_MODULE_USER_ASSERTION
-      ::OverSIP::SIP::Modules::UserAssertion.add_pai request
+    if MyExampleApp::DO_USER_ASSERTION
+      ::OverSIP::Modules::UserAssertion.add_pai request
     end
 
     proxy = ::OverSIP::SIP::Proxy.new :proxy_out
@@ -180,32 +191,32 @@ def (OverSIP::SipEvents).on_request request
 
   when :REGISTER
 
-    if MyExampleApp::SIP_USE_MODULE_REGISTRAR_WITHOUT_PATH
+    if MyExampleApp::DO_OUTBOUND_MANGLING
       # Contact mangling for the case in which the registrar does not support Path.
-      ::OverSIP::SIP::Modules::RegistrarWithoutPath.add_outbound_to_contact request
+      ::OverSIP::Modules::OutboundMangling.add_outbound_to_contact request
     end
 
     proxy = ::OverSIP::SIP::Proxy.new :proxy_out
 
     proxy.on_success_response do |response|
-      if MyExampleApp::SIP_USE_MODULE_REGISTRAR_WITHOUT_PATH
+      if MyExampleApp::DO_OUTBOUND_MANGLING
         # Undo changes done to the Contact header provided by the client, so it receives
         # the same value in the 200 response from the registrar.
-        ::OverSIP::SIP::Modules::RegistrarWithoutPath.remove_outbound_from_contact response
+        ::OverSIP::Modules::OutboundMangling.remove_outbound_from_contact response
       end
 
-      if MyExampleApp::SIP_USE_MODULE_USER_ASSERTION
+      if MyExampleApp::DO_USER_ASSERTION
         # The registrar replies 200 after a REGISTER with credentials so let's assert
         # the current SIP user to this connection.
-        ::OverSIP::SIP::Modules::UserAssertion.assert_connection response
+        ::OverSIP::Modules::UserAssertion.assert_connection response
       end
     end
 
     proxy.on_failure_response do |response|
-      if MyExampleApp::SIP_USE_MODULE_USER_ASSERTION
+      if MyExampleApp::DO_USER_ASSERTION
         # We don't add PAI for re-REGISTER, so 401 will be replied, and after it let's
         # revoke the current user assertion (will be re-added upon REGISTER with credentials).
-        ::OverSIP::SIP::Modules::UserAssertion.revoke_assertion response
+        ::OverSIP::Modules::UserAssertion.revoke_assertion response
       end
     end
 
@@ -223,7 +234,7 @@ def (OverSIP::SipEvents).on_request request
 end
 
 
-# This callback is called when a client initiates a SIP TLS handshake.
+# This method is called when a client initiates a SIP TLS handshake.
 def (OverSIP::SipEvents).on_client_tls_handshake connection, pems
 
   log_info "validating TLS connection from IP #{connection.remote_ip} and port #{connection.remote_port}"
@@ -241,7 +252,7 @@ def (OverSIP::SipEvents).on_client_tls_handshake connection, pems
 end
 
 
-# This callback is called when conntacting a SIP TLS server and the TLS handshake takes place.
+# This method is called when conntacting a SIP TLS server and the TLS handshake takes place.
 def (OverSIP::SipEvents).on_server_tls_handshake connection, pems
 
   log_info "validating TLS connection to IP #{connection.remote_ip} and port #{connection.remote_port}"
@@ -264,7 +275,7 @@ end
 ### OverSIP WebSocket Events:
 
 
-# This callback is called when a new WebSocket connection is being requested.
+# This method is called when a new WebSocket connection is being requested.
 # Here you can inspect the connection and the HTTP GET request. If you
 # decide not to accept this connection then call to:
 #
@@ -279,7 +290,7 @@ end
 # end
 
 
-# This callback is called when a WebSocket connection is closed. The connection
+# This method is called when a WebSocket connection is closed. The connection
 # is given as first argument along with a second argument "client_closed" which
 # is _true_ in case the WebSocket connection was closed by the client.
 #
@@ -288,7 +299,7 @@ end
 # end
 
 
-# This callback is called when a client initiates a WebSocket TLS handshake.
+# This method is called when a client initiates a WebSocket TLS handshake.
 def (OverSIP::WebSocketEvents).on_client_tls_handshake connection, pems
 
   log_info "validating TLS connection from IP #{connection.remote_ip} and port #{connection.remote_port}"

data/ext/stun/stun_ruby.c

@@ -54,7 +54,7 @@ static VALUE mStun;
 VALUE Stun_parse_request(VALUE self, VALUE rb_stun_request, VALUE rb_source_ip, VALUE rb_source_port)
 {
   TRACE();
-  
+
   char *request = NULL;
   size_t request_len = 0;
   char *source_ip = NULL;
@@ -228,7 +228,8 @@ VALUE Stun_parse_request(VALUE self, VALUE rb_stun_request, VALUE rb_source_ip,
       break;
     /* Not valid INET family, hummmm. */
     case -1:
-      rb_raise(rb_eTypeError, "Family AF_INET (IPv4) not supported");
+      LOG("ERROR: Family AF_INET (IPv4) not supported\n");
+      return Qfalse;
       break;
     /* Let's check with IPv6. */
     case 0:
@@ -239,11 +240,13 @@ VALUE Stun_parse_request(VALUE self, VALUE rb_stun_request, VALUE rb_source_ip,
           break;
           /* Not valid INET family, hummmm. */
         case -1:
-          rb_raise(rb_eTypeError, "Family AF_INET6 (IPv6) not supported");
+          LOG("ERROR: Family AF_INET6 (IPv6) not supported\n");
+          return Qfalse;
           break;
         /* The string is neither an IPv4 or IPv6. */
         case 0:
-          rb_raise(rb_eTypeError, "Given IP string is neither IPv4 or IPv6");
+          LOG("ERROR: Unknown Address Family\n");
+          return Qfalse;
           break;
       }
   }

data/ext/utils/utils_ruby.c

@@ -228,6 +228,8 @@ VALUE Utils_normalize_ipv6(int argc, VALUE *argv, VALUE self)
  * - Second argument is the type of host (:ipv4, :ipv6, :ipv6_reference or :domain).
  * - Third argument is optional. If true, returned value is a pure IPv6 even
  *   if the first argument is a IPv6 reference.
+ *
+ * TODO: Not in use and seems really ugly!
  */
 VALUE Utils_normalize_host(int argc, VALUE *argv, VALUE self)
 {
@@ -259,6 +261,8 @@ VALUE Utils_normalize_host(int argc, VALUE *argv, VALUE self)
 /*
  * If the given argument is a IPV6 reference it returns a new string with the pure IPv6.
  * In any other case, return the given argument.
+ *
+ * TODO: Not documented in the API (seems ugly).
  */
 VALUE Utils_to_pure_ip(VALUE self, VALUE string)
 {
@@ -273,6 +277,11 @@ VALUE Utils_to_pure_ip(VALUE self, VALUE string)
 }
 
 
+/*
+ * TODO: We lack a simple "normalice_host(ip)" method that parses the given ip and so on...
+ */
+
+
 /*
  * Expects a string like "1.2.3.4_5060" or "1af:43::ab_9090" and returns
  * an Array as follows:

data/lib/oversip/config.rb

@@ -8,9 +8,9 @@ module OverSIP
     extend ::OverSIP::Logger
     extend ::OverSIP::Config::Validators
 
-    DEFAULT_CONFIG_DIR = "/etc/oversip/"
-    DEFAULT_TLS_DIR = "tls/"
-    DEFAULT_TLS_CA_DIR = "tls/ca/"
+    DEFAULT_CONFIG_DIR = "/etc/oversip"
+    DEFAULT_TLS_DIR = "tls"
+    DEFAULT_TLS_CA_DIR = "tls/ca"
     DEFAULT_CONFIG_FILE = "oversip.conf"
     PROXIES_FILE = "proxies.conf"
     SERVER_FILE = "server.rb"
@@ -127,27 +127,31 @@ module OverSIP
       @proxies_file = ::File.join(@config_dir, PROXIES_FILE)
       @server_file = ::File.join(@config_dir, SERVER_FILE)
 
+      # Load the oversip.conf YAML file.
       begin
         conf_yaml = ::YAML.load_file @config_file
       rescue ::Exception => e
         log_system_crit "error loading Main Configuration file '#{@config_file}':"
-        fatal e
+        ::OverSIP::Launcher.fatal e
       end
 
+      # Load the proxies.conf YAML file.
       begin
         proxies_yaml = ::YAML.load_file @proxies_file
       rescue ::Exception => e
         log_system_crit "error loading Proxies Configuration file '#{@proxies_file}':"
-        fatal e
+        ::OverSIP::Launcher.fatal e
       end
 
+      # Load the server.rb file.
       begin
-        ::Kernel.load @server_file
+        require @server_file
       rescue ::Exception => e
         log_system_crit "error loading Server file '#{@server_file}':"
-        fatal e
+        ::OverSIP::Launcher.fatal e
       end
 
+      # Process the oversip.conf file.
       begin
         pre_check(conf_yaml)
 
@@ -158,18 +162,18 @@ module OverSIP
 
             if values == nil
               if validations.include? :required
-                fatal "#{section}[#{parameter}] requires a value"
+                ::OverSIP::Launcher.fatal "#{section}[#{parameter}] requires a value"
               end
               next
             end
 
             if values.is_a? ::Array
               unless validations.include? :multi_value
-                fatal "#{section}[#{parameter}] does not allow multiple values"
+                ::OverSIP::Launcher.fatal "#{section}[#{parameter}] does not allow multiple values"
               end
 
               if validations.include? :non_empty and values.empty?
-                fatal "#{section}[#{parameter}] does not allow empty values"
+                ::OverSIP::Launcher.fatal "#{section}[#{parameter}] does not allow empty values"
               end
             end
 
@@ -188,7 +192,7 @@ module OverSIP
                 next if [:required, :multi_value, :non_empty].include? validation
 
                 unless send validation, value, *args
-                  fatal "#{section}[#{parameter}] has invalid value '#{humanize_value value}' (does not satisfy '#{validation}' validation requirement)"
+                  ::OverSIP::Launcher.fatal "#{section}[#{parameter}] has invalid value '#{humanize_value value}' (does not satisfy '#{validation}' validation requirement)"
                 end
               end
 
@@ -202,20 +206,21 @@ module OverSIP
         post_check
 
       rescue ::OverSIP::ConfigurationError => e
-        fatal "configuration error: #{e.message}"
+        ::OverSIP::Launcher.fatal "configuration error: #{e.message}"
       rescue => e
-        fatal e
+        ::OverSIP::Launcher.fatal e
       end
 
       ::OverSIP.configuration = @configuration
 
+      # Process the proxies.conf file.
       begin
         ::OverSIP::ProxiesConfig.load proxies_yaml
       rescue ::OverSIP::ConfigurationError => e
-        fatal "error loading Proxies Configuration file '#{@proxies_file}':  #{e.message}"
+        ::OverSIP::Launcher.fatal "error loading Proxies Configuration file '#{@proxies_file}':  #{e.message}"
       rescue ::Exception => e
         log_system_crit "error loading Proxies Configuration file '#{@proxies_file}':"
-        fatal e
+        ::OverSIP::Launcher.fatal e
       end
     end
 
@@ -551,6 +556,7 @@ module OverSIP
     def self.system_reload
       log_system_notice "reloading OverSIP..."
 
+      # Load and process the proxies.conf file.
       begin
         proxies_yaml = ::YAML.load_file @proxies_file
         ::OverSIP::ProxiesConfig.load proxies_yaml, reload=true
@@ -562,6 +568,7 @@ module OverSIP
         log_system_crit e
       end
 
+      # Load the server.rb file.
       begin
         ::Kernel.load @server_file
         log_system_notice "Server file '#{@server_file}' reloaded"

data/lib/oversip/default_server.rb

@@ -4,16 +4,20 @@ module OverSIP
 
     extend ::OverSIP::Logger
 
+    def self.on_initialize
+      log_system_notice "on_initialize() method is not defined"
+    end
+
     def self.on_started
-      log_system_notice "on_started() callback is not defined"
+      log_system_notice "on_started() method is not defined"
     end
 
     def self.on_user_reload
-      log_system_notice "on_user_reload() callback is not defined"
+      log_system_notice "on_user_reload() method is not defined"
     end
 
     def self.on_terminated error
-      log_system_notice "on_terminated() callback is not defined"
+      log_system_notice "on_terminated() method is not defined"
     end
 
 
@@ -24,15 +28,15 @@ module OverSIP
     extend ::OverSIP::Logger
 
     def self.on_request request
-      log_system_notice "on_request() callback is not defined"
+      log_system_notice "on_request() method is not defined"
     end
 
     def self.on_client_tls_handshake connection, pems
-      log_system_notice "on_client_tls_handshake() callback is not defined"
+      log_system_notice "on_client_tls_handshake() method is not defined"
     end
 
     def self.on_server_tls_handshake connection, pems
-      log_system_notice "on_server_tls_handshake() callback is not defined"
+      log_system_notice "on_server_tls_handshake() method is not defined"
     end
 
   end
@@ -42,15 +46,15 @@ module OverSIP
     extend ::OverSIP::Logger
 
     def self.on_connection connection, http_request
-      log_system_notice "on_connection() callback is not defined"
+      log_system_notice "on_connection() method is not defined"
     end
 
     def self.on_disconnection connection, client_closed
-      log_system_notice "on_disconnection() callback is not defined"
+      log_system_notice "on_disconnection() method is not defined"
     end
 
     def self.on_client_tls_handshake connection, pems
-      log_system_notice "on_client_tls_handshake() callback is not defined"
+      log_system_notice "on_client_tls_handshake() method is not defined"
     end
 
   end

data/lib/oversip/launcher.rb

@@ -2,7 +2,7 @@ module OverSIP::Launcher
 
   extend ::OverSIP::Logger
 
-  READY_PIPE_TIMEOUT = 6
+  READY_PIPE_TIMEOUT = 8
 
   @log_id = "launcher"
 
@@ -54,6 +54,7 @@ module OverSIP::Launcher
           master_ok = (rd.read(2) rescue nil)
         end
       rescue ::Timeout::Error
+        log_system_crit "master process is not ready within #{READY_PIPE_TIMEOUT/2} seconds, killing it..."
         begin
           ::Process.kill(:TERM, master_pid)
           10.times do |i|
@@ -65,7 +66,7 @@ module OverSIP::Launcher
           ::Process.kill(:KILL, master_pid) rescue nil
         rescue ::Errno::ESRCH
         end
-        fatal "master process is not ready within #{READY_PIPE_TIMEOUT/2} seconds, killing it"
+        fatal "master process killed"
       end
       unless master_ok == "ok"
         fatal "master process failed to start"
@@ -279,8 +280,28 @@ module OverSIP::Launcher
 
         log_system_info "reactor running"
 
-        # Run the user provided on_started callback.
-        log_system_info "calling OverSIP::SystemEvents.on_started()..."
+        # Run the user provided on_initialize method.
+        log_system_info "calling OverSIP::SystemEvents.on_initialize() method..."
+        begin
+          ::OverSIP::SystemEvents.on_initialize
+        rescue ::Exception => e
+          log_system_crit "error calling OverSIP::SystemEvents.on_initialize():"
+          fatal e
+        end
+
+        # Run the on_started provided callbacks.
+        log_system_info "executing OverSIP::SystemCallbacks.on_started_callbacks..."
+        ::OverSIP::SystemCallbacks.on_started_callbacks.each do |cb|
+          begin
+            cb.call
+          rescue ::Exception => e
+            log_system_crit "error executing a callback in OverSIP::SystemCallbacks.on_started_callbacks:"
+            fatal e
+          end
+        end
+
+        # Run the user provided on_started method.
+        log_system_info "calling OverSIP::SystemEvents.on_started() method..."
         begin
           ::OverSIP::SystemEvents.on_started
         rescue ::Exception => e
@@ -323,6 +344,14 @@ module OverSIP::Launcher
   end # def self.run
 
 
+  def self.fatal msg
+    log_system_crit msg
+    log_system_crit "exiting with error status"
+
+    terminate error=true, fatal=true
+  end
+
+
   def self.create_pid_file(path)
     # Check that the PID file is accesible.
     begin
@@ -424,11 +453,22 @@ module OverSIP::Launcher
     trap :HUP do
       log_system_notice "HUP signal received, reloading configuration files..."
       ::OverSIP::Config.system_reload
+
+      # Run the on_reload provided callbacks.
+      log_system_info "executing OverSIP::SystemCallbacks.on_reload_callbacks..."
+      ::OverSIP::SystemCallbacks.on_reload_callbacks.each do |cb|
+        begin
+          cb.call
+        rescue ::Exception => e
+          log_system_crit "error executing a callback in OverSIP::SystemCallbacks.on_reload_callbacks:"
+          log_system_crit e
+        end
+      end
     end
 
     # Signal USR1 reloads custom code provided by the user.
     trap :USR1 do
-      log_system_notice "USR1 signal received, calling OverSIP::SystemEvents.on_user_reload()..."
+      log_system_notice "USR1 signal received, calling OverSIP::SystemEvents.on_user_reload() method..."
       # Run the user provided on_started callback.
       begin
         ::OverSIP::SystemEvents.on_user_reload
@@ -447,9 +487,24 @@ module OverSIP::Launcher
 
 
   def self.terminate error=false, fatal=false
+    # Trap TERM/QUIT signals (we are already exiting).
+    trap(:TERM) {}
+    trap(:QUIT) {}
+
     unless fatal
-      # Run the user provided on_terminated callback.
-      log_system_info "calling OverSIP::SystemEvents.on_terminated()..."
+      # Run the on_terminated provided callbacks.
+      log_system_info "executing OverSIP::SystemCallbacks.on_terminated_callbacks..."
+      ::OverSIP::SystemCallbacks.on_terminated_callbacks.each do |cb|
+        begin
+          cb.call error
+        rescue ::Exception => e
+          log_system_crit "error executing a callback in OverSIP::SystemCallbacks.on_terminated_callbacks:"
+          log_system_crit e
+        end
+      end
+
+      # Run the user provided on_terminated method.
+      log_system_info "calling OverSIP::SystemEvents.on_terminated() method..."
       begin
         ::OverSIP::SystemEvents.on_terminated error
       rescue ::Exception => e

data/lib/oversip/logger.rb

@@ -108,15 +108,6 @@ module OverSIP
         end
 
       end  # .each
-
-      # A convenient method to ensure that fatal logs are properly logged and program
-      # exited with error status.
-      def fatal msg
-        log_system_crit msg
-        log_system_crit "exiting with error status"
-
-        ::OverSIP::Launcher.terminate error=true, fatal=true
-      end
     end
 
     # Generate nice log messages. It accepst three parameters:

data/lib/oversip/master_process.rb

@@ -10,8 +10,6 @@ require "openssl"
 
 # Ruby external gems.
 
-gem "eventmachine-le", ">= 1.1.3"
-require "eventmachine-le"
 gem "iobuffer", ">= 1.1.2"
 require "iobuffer"
 gem "em-udns", ">= 0.3.6"
@@ -27,6 +25,7 @@ require "posix-spawn"
 require "oversip/sip/sip.rb"
 require "oversip/sip/sip_parser.so"
 require "oversip/sip/constants.rb"
+require "oversip/sip/core.rb"
 require "oversip/sip/message.rb"
 require "oversip/sip/request.rb"
 require "oversip/sip/response.rb"
@@ -53,13 +52,11 @@ require "oversip/websocket/ws_framing_utils.so"
 require "oversip/websocket/ws_framing.rb"
 require "oversip/websocket/ws_sip_app.rb"
 
-require "oversip/sip/modules/core.rb"
-require "oversip/sip/modules/user_assertion.rb"
-require "oversip/sip/modules/registrar_without_path.rb"
-
-require "oversip/default_server.rb"
 require "oversip/fiber_pool.rb"
 require "oversip/tls.rb"
 require "oversip/stun.so"
 
+require "oversip/modules/user_assertion.rb"
+require "oversip/modules/outbound_mangling.rb"
+
 require "oversip/ruby_ext/eventmachine.rb"

data/lib/oversip/modules/outbound_mangling.rb

@@ -0,0 +1,60 @@
+module OverSIP::Modules
+
+  module OutboundMangling
+
+    extend ::OverSIP::Logger
+
+    @log_id = "OutboundMangling module"
+
+    def self.add_outbound_to_contact request
+      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
+        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 OutboundMangling
+
+end