oversip 0.9.0

data/lib/oversip/logger.rb

@@ -0,0 +1,170 @@
+module OverSIP
+
+  # Logging client module. Any class desiring to log messages must include (or extend) this module.
+  # In order to identify itself in the logs, the class can define log_ig() method or set @log_id
+  # attribute.
+  module Logger
+
+    SYSLOG_POSIXMQ_MAPPING = {
+      "debug"  => 0,
+      "info"   => 1,
+      "notice" => 2,
+      "warn"   => 3,
+      "error"  => 4,
+      "crit"   => 5,
+      "alert"  => 6,
+      "emerg"  => 7
+    }
+
+    def self.init_logger_mq(group = nil)
+      OverSIP.syslogger_mq_name = "/#{OverSIP.master_name}_syslogger"
+
+      @@logger_mq = ::OverSIP::PosixMQ.create_queue({
+        :name    => ::OverSIP.syslogger_mq_name,
+        :mode    => :write,
+        :maxmsg  => 1000,
+        :msgsize => 2000,
+        :group => group
+      })
+    end
+
+
+    def self.load_methods
+      begin
+        @@threshold = SYSLOG_POSIXMQ_MAPPING[::OverSIP.configuration[:core][:syslog_level]]
+      rescue
+        @@threshold = 0  # debug.
+      end
+
+      $oversip_debug = ( @@threshold == 0 ? true : false )
+
+      @@congested = false
+
+      SYSLOG_POSIXMQ_MAPPING.each do |level, level_value|
+        method_str = "
+          def log_system_#{level}(msg)
+        "
+
+        if ::OverSIP.syslogger_ready?
+          method_str << "
+            return false if @@threshold > #{level_value} || @@congested
+            begin
+              unless @@logger_mq.trysend ::OverSIP::Logger.syslog_system_msg2str(#{level_value}, msg, log_id), 0
+                @@congested = true
+                EM.add_timer(1) do
+                  @@logger_mq.trysend ::OverSIP::Logger.syslog_system_msg2str(4, \"logger message queue was full, some logs have been lost\", log_id), 1
+                  @@congested = false
+                end
+              end
+            rescue Errno::EMSGSIZE
+              @@logger_mq.trysend ::OverSIP::Logger.syslog_system_msg2str(4, \"too long message could not be logged\", log_id), 1 rescue nil
+            rescue => e
+              @@logger_mq.trysend ::OverSIP::Logger.syslog_system_msg2str(4, \"unexpected logging error (\#{e.class}: \#{e.message})\", log_id), 1 rescue nil
+            end
+          "
+        end
+
+        unless ::OverSIP.daemonized?
+          if %w{debug info notice}.include? level
+            method_str << "
+              puts ::OverSIP::Logger.fg_system_msg2str('#{level}', msg, log_id)
+            "
+          else
+            method_str << "
+              $stderr.puts ::OverSIP::Logger.fg_system_msg2str('#{level}', msg, log_id)
+            "
+          end
+        end
+
+        method_str << "end"
+
+        self.module_eval method_str
+
+
+        if ::OverSIP.syslogger_ready?
+          # User/script logs.
+          method_str = "
+            def log_#{level}(msg)
+              return false if @@threshold > #{level_value} || @@congested
+              begin
+                unless @@logger_mq.trysend ::OverSIP::Logger.syslog_user_msg2str(#{level_value}, msg, log_id), 0
+                  @@congested = true
+                  EM.add_timer(1) do
+                    @@logger_mq.trysend ::OverSIP::Logger.syslog_user_msg2str(4, \"logger message queue was full, some logs have been lost\", log_id), 1
+                    @@congested = false
+                  end
+                end
+              rescue Errno::EMSGSIZE
+                @@logger_mq.trysend ::OverSIP::Logger.syslog_user_msg2str(4, \"too long message could not be logged\", log_id), 1 rescue nil
+              rescue => e
+                @@logger_mq.trysend ::OverSIP::Logger.syslog_user_msg2str(4, \"unexpected logging error (\#{e.class}: \#{e.message})\", log_id), 1 rescue nil
+              end
+            end
+          "
+
+          self.module_eval method_str
+        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
+      end
+    end
+
+    # Generate nice log messages. It accepst three parameters:
+    # - level_value: Integer representing the log level.
+    # - msg: the String or Exception to be logged.
+    # - log_id: a String helping to identify the generator of this log message.
+    def self.syslog_system_msg2str(level_value, msg, log_id)
+      case msg
+      when ::String
+        level_value.to_s << "<" << log_id << "> " << msg
+      when ::Exception
+        "#{level_value}<#{log_id}> #{msg.message} (#{msg.class })\n#{(msg.backtrace || [])[0..3].join("\n")}"
+      else
+        level_value.to_s << "<" << log_id << "> " << msg.inspect
+      end
+    end
+
+    def self.syslog_user_msg2str(level_value, msg, log_id)
+      case msg
+      when ::String
+        level_value.to_s << "<" << log_id << "> script: " << msg
+      when ::Exception
+        "#{level_value}<#{log_id}> script: #{msg.message} (#{msg.class })\n#{(msg.backtrace || [])[0..3].join("\n")}"
+      else
+        level_value.to_s << "<" << log_id << "> script: " << msg.inspect
+      end
+    end
+
+    def self.fg_system_msg2str(level, msg, log_id)
+      case msg
+      when ::String
+        "#{level.upcase}: <#{log_id}> " << msg
+      when ::Exception
+        "#{level.upcase}: <#{log_id}> #{msg.message} (#{msg.class })\n#{(msg.backtrace || [])[0..3].join("\n")}"
+      else
+        "#{level.upcase}: <#{log_id}> " << msg.inspect
+      end
+    end
+
+    def self.close
+      @@logger_mq.close rescue nil
+      @@logger_mq.unlink rescue nil
+    end
+
+    # Default logging identifier is the class name. If log_id() method is redefined by the
+    # class including this module, or it sets @log_id, then such value takes preference.
+    def log_id
+      @log_id ||= self.class.name
+    end
+
+  end  # module Logger
+
+end

data/lib/oversip/master_process.rb

@@ -0,0 +1,67 @@
+# Ruby built-in libraries.
+
+require "base64"
+require "digest/md5"
+require "digest/sha1"
+require "securerandom"
+require "fiber"
+require "openssl"
+
+
+# Ruby external gems.
+
+gem "eventmachine-le", ">= 1.1.0"
+require "eventmachine-le"
+
+gem "iobuffer", ">= 1.1.2"
+require "iobuffer"
+gem "em-udns", ">= 0.3.6"
+require "em-udns"
+gem "escape_utils", ">= 0.2.4"
+require "escape_utils"
+gem "posix-spawn", ">= 0.3.6"
+require "posix-spawn"
+
+
+# OverSIP files.
+
+require "oversip/ruby_ext/eventmachine.rb"
+
+require "oversip/sip/sip.rb"
+require "oversip/sip/sip_parser.so"
+require "oversip/sip/constants.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/message_processor.rb"
+require "oversip/sip/listeners.rb"
+require "oversip/sip/launcher.rb"
+require "oversip/sip/server_transaction.rb"
+require "oversip/sip/client_transaction.rb"
+require "oversip/sip/transport_manager.rb"
+require "oversip/sip/timers.rb"
+require "oversip/sip/tags.rb"
+require "oversip/sip/rfc3263.rb"
+require "oversip/sip/logic.rb"
+require "oversip/sip/proxy.rb"
+
+require "oversip/websocket/ws_http_parser.so"
+require "oversip/websocket/constants.rb"
+require "oversip/websocket/http_request.rb"
+require "oversip/websocket/default_policy.rb"
+require "oversip/websocket/listeners.rb"
+require "oversip/websocket/launcher.rb"
+require "oversip/websocket/ws_framing_utils.so"
+require "oversip/websocket/ws_framing.rb"
+require "oversip/websocket/ws_app.rb"
+require "oversip/websocket/ws_apps.rb"
+
+require "oversip/fiber_pool.rb"
+require "oversip/tls.rb"
+require "oversip/stun.so"
+
+require "oversip/sip/modules/core.rb"
+require "oversip/sip/modules/user_assertion.rb"
+require "oversip/sip/modules/registrar_without_path.rb"

data/lib/oversip/posix_mq.rb

@@ -0,0 +1,121 @@
+module OverSIP
+
+  class PosixMQ
+
+    extend ::OverSIP::Logger
+
+    def self.create_queue options={}
+      @log_id = "PosixMQ #{options[:name]}"
+      @total_size ||= 0
+
+      # Queue attributes.
+      mq_name = options[:name]
+      mq_mode = case options[:mode]
+        when :read       then IO::RDONLY
+        when :write      then IO::WRONLY
+        when :read_write then IO::RDWR
+        end
+      mq_group = options[:group]
+      mq_attr = ::POSIX_MQ::Attr.new
+      # NOTE: maximun value for maxmsg is 65536.
+      mq_attr.maxmsg  = options[:maxmsg]
+      mq_attr.msgsize = options[:msgsize]
+      mq_attr.flags   = 0
+      mq_attr.curmsgs = 0
+
+      # Delete the queue if it exists.
+      begin
+        ::POSIX_MQ.unlink mq_name
+      rescue ::Errno::ENOENT
+      rescue ::Errno::EACCES => e
+        fatal "queue already exists and cannot remove it due file permissions"
+      end
+
+      # Set the UMASK in a way that the group has permission to delete the queue.
+      orig_umask = File.umask(0007)
+
+      # Change the effective group for the Posix queue. Keep the original
+      # group.
+      orig_gid = Process::GID.eid
+      if mq_group
+        gid = Etc.getgrnam(mq_group).gid
+        Process::GID.change_privilege(gid)
+      end
+
+      ### TODO: Este tamaño debe multiplicarse por el num de queues!
+      # System limits required size (ulimit -q).
+      mq_size = case 1.size
+        # 32 bits OS.
+        when 4 then mq_attr.maxmsg * 4 + mq_attr.maxmsg * mq_attr.msgsize
+        # 64 bits OS.
+        when 8 then mq_attr.maxmsg * 8 + mq_attr.maxmsg * mq_attr.msgsize
+        end
+      log_system_debug "queue requires #{mq_size} bytes"  if $oversip_debug
+
+      # Set RLIMIT_MSGQUEUE (ulimit) in order to create the queue with required
+      # ammount of memory.
+      @total_size += mq_size
+      if ( current_rlimit = ::Process.getrlimit(12)[1] ) < @total_size
+        log_system_debug "incrementing rlimits (currently #{current_rlimit} bytes) to #{@total_size} bytes (ulimit -q)"  if $oversip_debug
+        begin
+          ::Process.setrlimit(12, @total_size)
+        rescue Errno::EPERM
+          fatal "current user has no permissions to increase rlimits to #{@total_size} bytes (ulimit -q)"
+        end
+      end
+
+      # Create the Posix message queue to write into it.
+      # - IO::WRONLY   =>  Just write.
+      # - IO::CREAT    =>  Create if it doesn't exist.
+      # - IO::EXCL     =>  Raise if the queue already exists.
+      # - IO::NONBLOCK =>  Don't block when sending (instead raise Errno::EAGAIN).
+      # - mode: 00660  =>  User and group can write and read.
+      # - mq_attr      =>  Set maxmsg and msgsize.
+      begin
+        mq = ::POSIX_MQ.new mq_name, mq_mode | IO::CREAT | IO::EXCL | IO::NONBLOCK, 00660, mq_attr
+
+      # Kernel has no support for posix message queues.
+      rescue Errno::ENOSYS => e
+        fatal "the kernel has no support for posix messages queues, enable it (#{e.class}: #{e.message})"
+
+      # http://linux.die.net/man/3/mq_open
+      #
+      # O_CREAT was specified in oflag, and attr was not NULL, but attr->mq_maxmsg or attr->mq_msqsize was
+      # invalid. Both of these fields must be greater than zero. In a process that is unprivileged (does not
+      # have the CAP_SYS_RESOURCE capability), attr->mq_maxmsg must be less than or equal to the msg_max
+      # limit, and attr->mq_msgsize must be less than or equal to the msgsize_max limit. In addition, even
+      # in a privileged process, attr->mq_maxmsg cannot exceed the HARD_MAX limit. (See mq_overview(7) for
+      # details of these limits.)
+      rescue Errno::EINVAL
+        log_system_warn "cannot set queue attributes due to user permissions, using system default values"
+        mq = ::POSIX_MQ.new mq_name, mq_mode | IO::CREAT | IO::NONBLOCK, 00660
+      rescue Errno::ENOMEM => e
+        fatal "insufficient memory (#{e.class}: #{e.message})"
+      rescue Errno::EMFILE => e
+        fatal "the process already has the maximum number of files and message queues open (#{e.class}: #{e.message})"
+      rescue Errno::ENFILE => e
+        fatal "the system limit on the total number of open files and message queues has been reached (#{e.class}: #{e.message})"
+      rescue Errno::ENOSPC => e
+        fatal "insufficient space for the creation of a new message queue, probably occurred because the queues_max limit was encountered (#{e.class}: #{e.message})"
+
+      end
+
+      # Recover the original Umask settings.
+      File.umask(orig_umask)
+
+      # Recover the original effective group.
+      Process::GID.change_privilege(orig_gid)  if mq_group
+
+      if mq.attr.maxmsg == mq_attr.maxmsg and mq.attr.msgsize == mq_attr.msgsize
+        log_system_debug "maxmsg=#{mq.attr.maxmsg}, msgsize=#{mq.attr.msgsize}"  if $oversip_debug
+      else
+        log_system_warn "maxmsg=#{mq.attr.maxmsg}, msgsize=#{mq.attr.msgsize}, " \
+                    "but recommended values are maxmsg=#{mq_attr.maxmsg}, msgsize=#{mq_attr.msgsize}"
+      end
+
+      mq
+    end  # self.create_queue
+
+  end  # class PosixMQ
+
+end

data/lib/oversip/proxies_config.rb

@@ -0,0 +1,169 @@
+module OverSIP
+
+  module ProxiesConfig
+
+    extend ::OverSIP::Logger
+    extend ::OverSIP::Config::Validators
+
+    def self.log_id
+      @log_id ||= "ProxiesConfig"
+    end
+
+    @proxies = {}
+
+    @proxy_configuration = {
+      :do_loose_routing           => true,
+      :use_dns                    => true,
+      :use_dns_cache              => true,
+      :dns_cache_time             => 300,
+      :use_naptr                  => true,
+      :use_srv                    => true,
+      :transport_preference       => ["tls", "tcp", "udp"],
+      :force_transport_preference => false,
+      :ip_type_preference         => ["ipv6", "ipv4"],
+      :dns_failover_on_503        => true,
+      :timer_B                    => 32,
+      :timer_C                    => 120,
+      :timer_F                    => 32,
+      :tls_validation             => false
+    }
+
+    PROXY_CONFIG_VALIDATIONS = {
+      :do_loose_routing           => :boolean,
+      :use_dns                    => :boolean, 
+      :use_dns_cache              => :boolean,
+      :dns_cache_time             => [ :fixnum, [ :greater_equal_than, 300 ] ],
+      :use_naptr                  => :boolean,
+      :use_srv                    => :boolean,
+      :transport_preference       => [ [ :choices, %w{tls tcp udp}], :multi_value, :non_empty ],
+      :force_transport_preference => :boolean,
+      :ip_type_preference         => [ [ :choices, %w{ipv4 ipv6}], :multi_value, :non_empty ],
+      :dns_failover_on_503        => :boolean,
+      :timer_B                    => [ :fixnum, [ :greater_equal_than, 2 ], [ :minor_equal_than, 64 ] ],
+      :timer_C                    => [ :fixnum, [ :greater_equal_than, 8 ], [ :minor_equal_than, 180 ] ],
+      :timer_F                    => [ :fixnum, [ :greater_equal_than, 2 ], [ :minor_equal_than, 64 ] ],
+      :tls_validation             => :boolean
+    }
+
+    def self.load proxies_yaml
+      unless proxies_yaml.is_a? Hash
+        fatal "invalid proxies configuration file, it is not a collection"
+      end
+
+      begin
+        proxies_yaml.each do |proxy, conf|
+          unless proxy.is_a? String
+            fatal "proxy name is not a string (#{proxy.inspect})"
+          end
+
+          @proxies[proxy.to_sym] = @proxy_configuration.dup
+          @proxies[proxy.to_sym].each do |parameter, default_value|
+            @proxies[proxy.to_sym][parameter] = default_value.clone rescue default_value
+          end
+
+          PROXY_CONFIG_VALIDATIONS.each do |parameter, validations|
+            values = proxies_yaml[proxy][parameter.to_s]
+            validations = [ validations ]  unless validations.is_a?(Array)
+
+            if values == nil
+              if validations.include? :required
+                fatal "#{proxy}[#{parameter}] requires a value"
+              end
+              next
+            end
+
+            if values.is_a? Array
+              unless validations.include? :multi_value
+                fatal "#{proxy}[#{parameter}] does not allow multiple values"
+              end
+
+              if validations.include? :non_empty and values.empty?
+                fatal "#{proxy}[#{parameter}] does not allow empty values"
+              end
+            end
+
+            values = ( values.is_a?(Array) ? values : [ values ] )
+
+            values.each do |value|
+              validations.each do |validation|
+
+                if validation.is_a? Symbol
+                  args = []
+                elsif validation.is_a? Array
+                  args = validation[1..-1]
+                  validation = validation[0]
+                end
+
+                next if [:required, :multi_value, :non_empty].include? validation
+
+                unless send validation, value, *args
+                  fatal "#{proxy}[#{parameter}] has invalid value '#{::OverSIP::Config.humanize_value value}' (does not satisfy '#{validation}' validation requirement)"
+                end
+              end
+
+              @proxies[proxy.to_sym][parameter] = ( validations.include?(:multi_value) ? values : values[0] )
+            end
+
+          end  # PROXY_CONFIG_VALIDATIONS[section].each
+        end  # proxies_yaml.each
+
+        post_process
+
+      rescue OverSIP::ConfigurationError => e
+        fatal "proxies configuration error: #{e.message}"
+      rescue => e
+        fatal e
+      end
+
+      ::OverSIP.proxies = @proxies
+    end
+
+
+    def self.post_process
+      @proxies.each_key do |proxy|
+        # Add a string parameter with the proxy name itself.
+        @proxies[proxy][:name] = proxy.to_s
+
+        # If use_srv is not set then ensure use_naptr is also not set.
+        @proxies[proxy][:use_naptr] = false  unless @proxies[proxy][:use_srv]
+
+        # Convert transport values into Symbols.
+        @proxies[proxy][:transport_preference] = @proxies[proxy][:transport_preference].map do |transport|
+          transport.to_sym
+        end
+
+        # Ensure there are not duplicate transports.
+        @proxies[proxy][:transport_preference].uniq!
+
+        # Remove transports that are not supported.
+        @proxies[proxy][:transport_preference].delete :tls  unless ::OverSIP.configuration[:sip][:sip_tls]
+        @proxies[proxy][:transport_preference].delete :tcp  unless ::OverSIP.configuration[:sip][:sip_tcp]
+        @proxies[proxy][:transport_preference].delete :udp  unless ::OverSIP.configuration[:sip][:sip_udp]
+
+        # Convert IP type values into Symbols.
+        @proxies[proxy][:ip_type_preference] = @proxies[proxy][:ip_type_preference].map do |ip_type|
+          ip_type.to_sym
+        end
+
+        # Ensure there are not duplicate IP types.
+        @proxies[proxy][:ip_type_preference].uniq!
+
+        # Remove IP types that are not supported.
+        @proxies[proxy][:ip_type_preference].delete :ipv4  unless ::OverSIP.configuration[:sip][:listen_ipv4]
+        @proxies[proxy][:ip_type_preference].delete :ipv6  unless ::OverSIP.configuration[:sip][:listen_ipv6]
+
+        # Add new parameters for fast access.
+        @proxies[proxy][:has_sip_ipv4] = @proxies[proxy][:ip_type_preference].include?(:ipv4)
+        @proxies[proxy][:has_sip_ipv6] = @proxies[proxy][:ip_type_preference].include?(:ipv6)
+        @proxies[proxy][:has_sip_udp] = @proxies[proxy][:transport_preference].include?(:udp)
+        @proxies[proxy][:has_sip_tcp] = @proxies[proxy][:transport_preference].include?(:tcp)
+        @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]
+      end
+    end
+
+  end
+
+end 

data/lib/oversip/ruby_ext/eventmachine.rb

@@ -0,0 +1,38 @@
+module EventMachine
+
+  # Fast method for setting an outgoing TCP connection.
+  def self.oversip_connect_tcp_server bind_addr, server, port, klass, *args
+    s = bind_connect_server bind_addr, 0, server, port
+    c = klass.new s, *args
+    @conns[s] = c
+    block_given? and yield c
+    c
+  end
+
+
+  class Connection
+
+    # We require Ruby 1.9 so don't check String#bytesize method.
+    def send_data data
+      ::EventMachine::send_data @signature, data, data.bytesize
+    end
+
+    def send_datagram data, address, port
+      ::EventMachine::send_datagram @signature, data, data.bytesize, address, port
+    end
+
+    # Rewrite close_connection so it set an internal attribute (which can be
+    # inspected when unbind() callback is called).
+    alias _em_close_connection close_connection
+    def close_connection after_writing=false
+      @local_closed = true
+      _em_close_connection after_writing
+    end
+
+    def close_connection_after_writing
+      close_connection true
+    end
+
+  end
+
+end