oversip_p 1.0.0

data/lib/oversip.rb

@@ -0,0 +1,127 @@
+#
+# OverSIP
+# Copyright (c) 2012-2014 Iñaki Baz Castillo <ibc@aliax.net>
+# MIT License
+#
+
+# Ruby built-in libraries.
+
+require "rbconfig"
+require "etc"
+require "fileutils"
+require "socket"
+require "timeout"
+require "yaml"
+require "tempfile"
+require "base64"
+require "digest/md5"
+require "digest/sha1"
+require "securerandom"
+require "fiber"
+require "openssl"
+
+
+# Ruby external gems.
+
+require "syslog"
+gem "eventmachine", "~> 1.2.0"
+require "eventmachine"
+gem "iobuffer", "= 1.1.2"
+require "iobuffer"
+gem "em-udns", "= 0.3.6"
+require "em-udns"
+gem "escape_utils", "= 1.0.1"
+require "escape_utils"
+gem "term-ansicolor", "= 1.3.2"
+require "term/ansicolor"
+gem "posix-spawn", "= 0.3.9"
+require "posix-spawn"
+gem "em-synchrony", "= 1.0.3"
+require "em-synchrony"
+
+
+# OverSIP files.
+
+require "oversip/version.rb"
+require "oversip/syslog.rb"
+require "oversip/logger.rb"
+require "oversip/config.rb"
+require "oversip/config_validators.rb"
+require "oversip/proxies_config.rb"
+require "oversip/errors.rb"
+require "oversip/launcher.rb"
+require "oversip/utils.#{RbConfig::CONFIG["DLEXT"]}"
+require "oversip/utils.rb"
+require "oversip/default_server.rb"
+require "oversip/system_callbacks.rb"
+
+require "oversip/sip/sip.rb"
+require "oversip/sip/sip_parser.#{RbConfig::CONFIG["DLEXT"]}"
+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"
+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"
+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/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.#{RbConfig::CONFIG["DLEXT"]}"
+require "oversip/websocket/constants.rb"
+require "oversip/websocket/http_request.rb"
+require "oversip/websocket/listeners.rb"
+require "oversip/websocket/launcher.rb"
+require "oversip/websocket/ws_framing_utils.#{RbConfig::CONFIG["DLEXT"]}"
+require "oversip/websocket/ws_framing.rb"
+require "oversip/websocket/ws_sip_app.rb"
+
+require "oversip/fiber_pool.rb"
+require "oversip/tls.rb"
+require "oversip/stun.#{RbConfig::CONFIG["DLEXT"]}"
+
+require "oversip/modules/user_assertion.rb"
+require "oversip/modules/outbound_mangling.rb"
+
+require "oversip/ruby_ext/eventmachine.rb"
+
+
+module OverSIP
+
+  class << self
+    attr_accessor :pid_file, :master_name, :pid, :daemonized,
+                  :configuration,
+                  :proxies,
+                  :tls_public_cert, :tls_private_cert,
+                  :stud_pids,
+                  :is_ready,  # true, false
+                  :status,  # :loading, :running, :terminating
+                  :root_fiber
+
+    def daemonized?
+      @daemonized
+    end
+
+  end
+
+  # Pre-declare internal modules.
+  module SIP ; end
+  module WebSocket ; end
+  module Modules ; end
+
+  # Allow OverSIP::M::MODULE_NAME usage.
+  M = Modules
+
+end

data/test/oversip_test_helper.rb

@@ -0,0 +1,19 @@
+require "test/unit"
+require "oversip"
+
+
+class OverSIPTest < Test::Unit::TestCase
+
+  def assert_true(object, message="")
+    assert_equal(true, object, message)
+  end
+
+  def assert_false(object, message="")
+    assert_equal(false, object, message)
+  end
+
+  def assert_equal_options(options, element)
+    assert options.include?(element)
+  end
+
+end

data/test/test_http_parser.rb

@@ -0,0 +1,73 @@
+# coding: utf-8
+
+require "oversip_test_helper"
+
+
+class TestHttpParser < OverSIPTest
+
+  def parse data
+    parser = OverSIP::WebSocket::HttpRequestParser.new
+    buffer = IO::Buffer.new
+    request = OverSIP::WebSocket::HttpRequest.new
+
+    buffer << data
+
+    unless bytes_parsed = parser.execute(request, buffer.to_str, 0)
+      raise "ERROR: parsing error: \"#{parser.error}\""
+    end
+
+    if parser.finished?
+      buffer.read bytes_parsed
+      if request.content_length and ! request.content_length.zero?
+        request.body = buffer.read request.content_length
+      end
+      if buffer.size != 0
+        raise "ERROR: buffer is not empty after parsing"
+      end
+    else
+      raise "ERROR: parsed NOT finished!"
+    end
+
+    [parser, request]
+  end
+  private :parse
+
+  def test_parse_http_get
+    parser, request = parse <<-END
+GET /chat?qwe=QWE&asd=#fragment HTTP/1.1\r
+Host: server.example.Com.\r
+Upgrade: WebSocket\r
+Connection: keep-Alive ,  Upgrade\r
+Sec-WebSocket-Key: dGhlIHNhbXBsZSBub25jZQ==\r
+Sec-WebSocket-protocol: foo , chat.lalala.com\r
+Sec-WebSocket-protocol:  xmpp.nonaino.org\r
+Origin: http://example.Com\r
+Sec-WebSocket-Version: 13\r
+noNaino-lALA  :  qwe\r
+NOnaino-lala: asd\r
+\r
+END
+
+    assert_equal request.http_method, :GET
+    assert_equal request.http_version, "HTTP/1.1"
+
+    assert_equal "/chat?qwe=QWE&asd=#fragment", request.uri
+    assert_equal "/chat", request.uri_path
+    assert_equal "qwe=QWE&asd=", request.uri_query
+    assert_equal "fragment", request.uri_fragment
+    assert_equal request.uri_scheme, nil
+    assert_equal "server.example.com", request.host
+    assert_nil request.port
+
+    assert_nil request.content_length
+    assert request.hdr_connection.include?("upgrade")
+    assert_equal "websocket", request.hdr_upgrade
+    assert_equal 13, request.hdr_sec_websocket_version
+    assert_equal "dGhlIHNhbXBsZSBub25jZQ==", request.hdr_sec_websocket_key
+    assert_equal "http://example.com", request.hdr_origin
+    assert_equal ["foo", "chat.lalala.com", "xmpp.nonaino.org"], request.hdr_sec_websocket_protocol
+
+    assert_equal ["qwe", "asd"], request["Nonaino-Lala"]
+  end
+
+end

data/test/test_name_addr.rb

@@ -0,0 +1,27 @@
+# coding: utf-8
+
+require "oversip_test_helper"
+
+
+class TestNameAddr < OverSIPTest
+
+  def test_name_addr
+    full_name_addr = '"Iñaki Baz Castillo" <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"
+
+    name_addr = ::OverSIP::SIP::NameAddr.new "Iñaki Baz Castillo", :sips, "iñaki", "aliax.net", 5060
+    name_addr.transport_param = :tcp
+    name_addr.set_param "FOO", "123"
+    name_addr.set_param "baz", nil
+    name_addr.headers = "?X-Header-1=qwe&X-Header-2=asd"
+
+    assert_true name_addr.sip?
+    assert_false name_addr.tel?
+    assert_false name_addr.unknown_scheme?
+    assert_equal "iñaki", name_addr.user
+    assert_equal "123", name_addr.get_param("Foo")
+    assert_equal aor, name_addr.aor
+    assert_equal full_name_addr, name_addr.to_s
+  end
+
+end

data/test/test_name_addr_parser.rb

@@ -0,0 +1,24 @@
+# coding: utf-8
+
+require "oversip_test_helper"
+
+
+class TestNameAddrParser < OverSIPTest
+
+  def test_parse_name_addr
+    name_addr_str = '"Iñaki" <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"
+
+    name_addr = ::OverSIP::SIP::NameAddr.parse name_addr_str
+
+    assert_equal ::OverSIP::SIP::NameAddr, name_addr.class
+    assert_equal "Iñaki", name_addr.display_name
+    assert_true name_addr.sip?
+    assert_false name_addr.unknown_scheme?
+    assert_equal "iñaki", name_addr.user
+    assert_equal "123", name_addr.get_param("Foo")
+    assert_equal aor, name_addr.aor
+    assert_equal name_addr_str, name_addr.to_s
+  end
+
+end

data/test/test_sip_message_parser.rb

@@ -0,0 +1,168 @@
+# coding: utf-8
+
+require "oversip_test_helper"
+
+
+class TestSipMessageParser < OverSIPTest
+
+  def parse data
+    parser = OverSIP::SIP::MessageParser.new
+    buffer = IO::Buffer.new
+
+    buffer << data
+
+    unless bytes_parsed = parser.execute(buffer.to_str, 0)
+      raise "ERROR: parsing error for class #{parser.parsed.class}: \"#{parser.error}\""
+    end
+
+    msg = parser.parsed
+
+    if parser.finished?
+      buffer.read bytes_parsed
+      if msg.content_length and ! msg.content_length.zero?
+        msg.body = buffer.read msg.content_length
+      end
+      if buffer.size != 0
+        raise "ERROR: buffer is not empty after parsing"
+      end
+    else
+      raise "ERROR: parsed NOT finished! (msg.class = #{msg.class})"
+    end
+
+    parser.post_parsing
+
+    [parser, msg]
+  end
+  private :parse
+
+  def test_parse_sip_invite
+    parser, msg = parse <<-END
+INVITE sip:sips%3Auser%40example.com@example.NET.;transport=tcp;FOO=baz?Subject=lalala SIP/2.0\r
+via: SIP/2.0/UDP host5.example.net;branch=z9hG4bKkdjuw ; Rport\r
+v: SIP/2.0/TCP 1.2.3.4;branch=z9hG4bKkdjuw\r
+To: <tel:+(34)-94-499-44-22;lalala=lololo>\r
+from: <sips:I%20have%20spaces@[2001:123:Ab:0:0::123]:9999> ;\r
+  tag=938\r
+Route: <sip:qweqwe/.+asdasd@1.2.3.4:7777;LR;ob>,\r
+  "Server Ñ€áéíóú" <SIP:[01::000:A0f]:6666;lr>\r
+Max-Forwards: 87\r
+_i: esc01.239409asdfakjkn23onasd0-3234\r
+CSeq: 234234 INVITE\r
+C: application/sdp\r
+Require: AAA, Bbb\r
+Require: ccc\r
+Proxy-Require: AAA, Bbb\r
+Proxy-Require: ccc\r
+Supported: AAA, Bbb\r
+k: ccc\r
+Contact:\r
+ <sip:cal%6Cer@host5.example.net;%6C%72;n%61me=v%61lue%25%34%31;ob>;p1=foo;P2=BAR;+sip-instance=qweqwe;reg-id=1\r
+Content-Length: 150\r
+\r
+v=0\r
+o=mhandley 29739 7272939 IN IP4 192.0.2.1\r
+s=-\r
+c=IN IP4 192.0.2.1\r
+t=0 0\r
+m=audio 49217 RTP/AVP 0 12\r
+m=video 3227 RTP/AVP 31\r
+a=rtpmap:31 LPC\r
+END
+
+    assert_equal msg.class, OverSIP::SIP::Request
+    assert_equal msg.sip_method, :INVITE
+    assert_equal msg.sip_version, "SIP/2.0"
+    assert_true msg.initial?
+
+    assert_false parser.duplicated_core_header?
+    assert_equal parser.missing_core_header?, "Call-ID"
+
+    assert_equal msg.num_vias, 2
+    assert_equal msg.via_sent_by_host, "host5.example.net"
+    assert_nil msg.via_sent_by_port
+    assert_nil msg.via_received
+    assert_true msg.via_rport?
+    assert_equal msg.via_core_value, "SIP/2.0/UDP host5.example.net"
+    assert_nil msg.via_params
+    assert_equal ["SIP/2.0/UDP host5.example.net;branch=z9hG4bKkdjuw ; Rport", "SIP/2.0/TCP 1.2.3.4;branch=z9hG4bKkdjuw"], msg.hdr_via
+
+    assert_equal msg.cseq, 234234
+    assert_equal msg.max_forwards, 87
+    assert_equal msg.content_length, 150
+    assert_equal msg.body.bytesize, 150
+
+    assert_equal "sip:sips%3auser%40example.com@example.net.;transport=tcp;foo=baz?subject=lalala", msg.ruri.uri.downcase
+    assert_equal :sip, msg.ruri.scheme
+    assert_equal "sips:user@example.com", msg.ruri.user
+    assert_equal "example.net", msg.ruri.host
+    assert_equal :domain, msg.ruri.host_type
+    assert_nil msg.ruri.port
+    assert_equal({"transport" => "tcp", "foo" => "baz"}, msg.ruri.params)
+    assert_equal "?Subject=lalala", msg.ruri.headers
+    assert_equal :tcp, msg.ruri.transport_param
+    assert_nil msg.ruri.phone_context_param
+
+    assert_equal :sips, msg.from.scheme
+    assert_equal "I have spaces", msg.from.user
+    assert OverSIP::Utils.compare_ips("[2001:123:ab::123]", msg.from.host)
+    assert_equal :ipv6_reference, msg.from.host_type
+    assert_equal 9999, msg.from.port
+    assert_equal({}, msg.from.params)
+    assert_equal "938", msg.from_tag
+
+    assert_equal :tel, msg.to.scheme
+    assert_equal "+34944994422", msg.to.user
+    assert_nil msg.to.host
+    assert_nil msg.to.port
+    assert_equal({"lalala" => "lololo"}, msg.to.params)
+    assert_nil msg.to_tag
+
+    assert_equal :sip, msg.contact.scheme
+    assert_equal "caller", msg.contact.user
+    assert_equal "host5.example.net", msg.contact.host
+    assert_equal :domain, msg.contact.host_type
+    assert_nil msg.contact.port
+    assert_true msg.contact.ob_param?
+    assert_equal({"%6c%72" => nil, "n%61me" => "v%61lue%25%34%31", "ob" => nil}, msg.contact.params)
+    assert_equal ";p1=foo;P2=BAR;+sip-instance=qweqwe;reg-id=1", msg.contact_params
+    assert_true msg.contact_reg_id?
+
+    assert_equal 2, msg.routes.size
+
+    assert_nil msg.routes.first.display_name
+    assert_equal :sip, msg.routes.first.scheme
+    assert_equal "qweqwe/.+asdasd", msg.routes.first.user
+    assert OverSIP::Utils.compare_ips("1.2.3.4", msg.routes.first.host)
+    assert_equal "1.2.3.4", msg.routes.first.host
+    assert_equal :ipv4, msg.routes.first.host_type
+    assert_equal 7777, msg.routes.first.port
+    assert_true msg.routes.first.lr_param?
+
+    assert_equal "Server Ñ€áéíóú", msg.routes[1].display_name
+    assert_equal :sip, msg.routes[1].scheme
+    assert_nil msg.routes[1].user
+    assert OverSIP::Utils.compare_ips("[1::a0f]", msg.routes[1].host)
+    assert_equal :ipv6_reference, msg.routes[1].host_type
+    assert_equal 6666, msg.routes[1].port
+    assert_true msg.routes[1].lr_param?
+
+    assert_equal ["aaa", "bbb", "ccc"], msg.require
+    assert_equal ["aaa", "bbb", "ccc"], msg.proxy_require
+    assert_equal ["aaa", "bbb", "ccc"], msg.supported
+
+    # Change the full RURI and test again.
+    msg.ruri = ::OverSIP::SIP::Uri.new :sips, "iñaki", "aliax.net", 7070
+
+    assert_equal :sips, msg.ruri.scheme
+    assert_equal "iñaki", msg.ruri.user
+    assert_equal "aliax.net", msg.ruri.host
+    assert_equal :domain, msg.ruri.host_type
+    assert_equal 7070, msg.ruri.port
+    assert_equal({}, msg.ruri.params)
+    assert_nil msg.ruri.headers
+    assert_nil msg.ruri.transport_param
+    assert_nil msg.ruri.phone_context_param
+    assert_equal "sips:i%C3%B1aki@aliax.net:7070", msg.ruri.to_s
+  end
+
+end

data/test/test_sip_uri_parser.rb

@@ -0,0 +1,56 @@
+# coding: utf-8
+
+require "oversip_test_helper"
+
+
+class TestSipUriParser < OverSIPTest
+
+  def test_parse_sip_uri
+    uri_str = "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.parse uri_str
+
+    assert_equal ::OverSIP::SIP::Uri, uri.class
+    assert_true uri.sip?
+    assert_false uri.unknown_scheme?
+    assert_equal "iñaki", uri.user
+    assert_true uri.has_param? "FOO"
+    assert_false uri.has_param? "LALALA"
+    assert_equal "123", uri.get_param("Foo")
+    assert_equal aor, uri.aor
+    assert_equal uri_str, uri.to_s
+  end
+
+  def test_parse_tel_uri
+    uri_str = "tel:944991212;foo=bar;phone-context=+34"
+    aor = "tel:944991212"
+
+    uri = ::OverSIP::SIP::Uri.parse uri_str
+
+    assert_equal ::OverSIP::SIP::Uri, uri.class
+    assert_true uri.tel?
+    assert_false uri.unknown_scheme?
+    assert_equal "944991212", uri.number
+    assert_true uri.has_param? "FOO"
+    assert_false uri.has_param? "LALALA"
+    assert_equal "bar", uri.get_param("Foo")
+    assert_equal aor, uri.aor
+    assert_equal uri_str, uri.to_s
+  end
+
+  def test_parse_http_uri
+    uri_str = "http://oversip.net/authors/"
+    aor = nil
+
+    uri = ::OverSIP::SIP::Uri.parse uri_str
+
+    assert_equal ::OverSIP::SIP::Uri, uri.class
+    assert_false uri.sip?
+    assert_false uri.tel?
+    assert_true uri.unknown_scheme?
+    assert_nil uri.has_param? "FOO"
+    assert_nil uri.aor
+    assert_equal uri_str, uri.to_s
+  end
+end

data/test/test_uri.rb

@@ -0,0 +1,68 @@
+# coding: utf-8
+
+require "oversip_test_helper"
+
+
+class TestUri < OverSIPTest
+
+  def test_sip_uri
+    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 :sips, "iñaki", "aliax.net", 5060
+    uri.transport_param = :tcp
+    uri.set_param "FOO", "123"
+    uri.set_param "baz", nil
+    uri.headers = "?X-Header-1=qwe&X-Header-2=asd"
+
+    assert_true uri.sip?
+    assert_false uri.tel?
+    assert_false uri.unknown_scheme?
+    assert_equal "iñaki", uri.user
+    assert_equal "123", uri.get_param("Foo")
+    assert_equal aor, uri.aor
+    assert_equal full_uri, uri.to_s
+
+    uri.clear_params
+
+    assert_equal({}, uri.params)
+    assert_equal "sips:i%C3%B1aki@aliax.net:5060?X-Header-1=qwe&X-Header-2=asd", 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 :tel, "944991212"
+    uri.set_param "FOO", "bar"
+    uri.phone_context_param = "+34"
+
+    assert_false uri.sip?
+    assert_true uri.tel?
+    assert_false uri.unknown_scheme?
+    assert_equal "944991212", uri.number
+    assert_equal "bar", uri.get_param("Foo")
+    assert_equal aor, uri.aor
+    assert_equal full_uri, uri.to_s
+
+    uri.clear_params
+
+    assert_equal({}, uri.params)
+    assert_equal aor, uri.to_s
+  end
+
+  def test_http_uri
+    full_uri = "http://oversip.net/authors/"
+    aor = nil
+
+    uri = ::OverSIP::SIP::Uri.allocate
+    uri.instance_variable_set :@uri, full_uri
+
+    assert_false uri.sip?
+    assert_false uri.tel?
+    assert_true uri.unknown_scheme?
+    assert_nil uri.aor
+    assert_equal full_uri, uri.to_s
+    assert_nil uri.clear_params
+  end
+end