oversip_p 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b0af28ece88d6d586ab78387230438424963e8aad32cf135d4cd9ded4a2b5b5a
+  data.tar.gz: 9674501195d60508e628a9f52a60291fa1f90d3ac696e36ceee974f8d83bdc80
+SHA512:
+  metadata.gz: 2f75e78a9a99e04bac9e73edd5288a59fcfcf8c9e81b44b23f30e6765377b1909f7d582886b66c470cb02706734bb8b6e4bfe51f03f762d899d86f17c69e5a1e
+  data.tar.gz: 68f6970a37273c69361d0ab534a5daab3004464adf246a10becc6c89bd42691efaed0c9a79176e01004ec95ac7823f23beb6dd0319fea3b5f85af81a4e8979ec

data/AUTHORS

@@ -0,0 +1,22 @@
+MAIN AUTHOR
+===========
+
+- Iñaki Baz Castillo <ibc@aliax.net> (Github @ibc)
+
+
+
+CONTRIBUTORS
+============
+
+- Jon Bonilla <manwe@aholab.ehu.es> (Github @manwe)
+
+  Lots of help with packaging for Debian based distributions.
+  The first deployment of OverSIP in production for thousands of clients.
+
+- Saúl Ibarra Corretgé <saghul@gmail.com> (Github @saghul)
+
+  Testing, ideas, proposals, too many proposals.
+
+- José Luis Millán <jmillan@aliax.net> (Github @jmillan)
+
+  Intensive testing with JsSIP library acting as a SIP Outbound UA with OverSIP.

data/LICENSE

@@ -0,0 +1,25 @@
+Name: OverSIP
+Maintainer: Iñaki Baz Castillo <ibc@aliax.net>
+Copyright (c) 2012-2016 Iñaki Baz Castillo
+
+
+License: The MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,43 @@
+<p align="center"><a href="http://oversip.net"><img src="http://oversip.net/images/oversip-banner.png"/></a></p>
+
+[![Build Status](https://secure.travis-ci.org/versatica/OverSIP.png?branch=master)](http://travis-ci.org/versatica/OverSIP)
+
+## Website
+
+* [www.oversip.net](http://www.oversip.net)
+
+
+## Overview
+
+OverSIP is a powerful and flexible SIP proxy & server by the authors of [RFC 7118](http://tools.ietf.org/html/rfc7118) (*The WebSocket Protocol as a Transport for SIP*):
+
+* Works on Linux/BSD/OSX
+* Fully asynchronous event-based design, never block!
+* Enjoy coding your SIP logic in Ruby language, feel free to code whatever you need!
+* Fast: core and message parsers written in C language
+* SIP over UDP, TCP, TLS and WebSocket (use true SIP in your web apps)
+* Full support for IPv4, IPv6 and DNS resolution (NAPTR, SRV, A, AAAA)
+* The perfect Outbound Edge Proxy
+* Written by the authors of [RFC 7118 "The WebSocket Protocol as a Transport for SIP"](http://tools.ietf.org/html/rfc7118) and [JsSIP](http://jssip.net)
+
+
+## Documentation
+
+* [www.oversip.net/documentation](http://www.oversip.net/documentation/)
+
+
+## Authors
+
+### Main Author
+
+* Iñaki Baz Castillo (<ibc@aliax.net> | [github](https://github.com/ibc) | [twitter](https://twitter.com/ibc_tw))
+
+### Contributors
+
+* José Luis Millán (<jmillan@aliax.net> | [github](https://github.com/jmillan) | [twitter](https://twitter.com/jomivi))
+* Saúl Ibarra Corretgé (<saghul@gmail.com> | [github](https://github.com/saghul) | [twitter](https://twitter.com/saghul))
+* Jon Bonilla (<manwe@aholab.ehu.es> |  [github](https://github.com/manwe) | [twitter](https://twitter.com/jbmanwe))
+
+## License
+
+OverSIP is released under the [MIT license](http://www.oversip.net/license).

data/Rakefile

@@ -0,0 +1,54 @@
+require "rake/testtask"
+require "rake/clean"
+
+
+OVERSIP_EXTENSIONS = [
+  { :dir => "ext/sip_parser", :lib => "sip_parser.#{RbConfig::CONFIG["DLEXT"]}", :dest => "lib/oversip/sip" },
+  { :dir => "ext/stun", :lib => "stun.#{RbConfig::CONFIG["DLEXT"]}", :dest => "lib/oversip" },
+  { :dir => "ext/utils", :lib => "utils.#{RbConfig::CONFIG["DLEXT"]}", :dest => "lib/oversip" },
+  { :dir => "ext/websocket_framing_utils", :lib => "ws_framing_utils.#{RbConfig::CONFIG["DLEXT"]}", :dest => "lib/oversip/websocket" },
+  { :dir => "ext/websocket_http_parser", :lib => "ws_http_parser.#{RbConfig::CONFIG["DLEXT"]}", :dest => "lib/oversip/websocket" },
+]
+
+OVERSIP_EXTENSIONS.each do |ext|
+  file ext[:lib] => Dir.glob(["#{ext[:dir]}/*{.c,.h}"]) do
+    Dir.chdir(ext[:dir]) do
+      ruby "extconf.rb"
+      sh "make"
+    end
+    cp "#{ext[:dir]}/#{ext[:lib]}", "#{ext[:dest]}/"
+  end
+
+  CLEAN.include("#{ext[:dir]}/*{.o,.log,.so,.a,.bundle}")
+  CLEAN.include("#{ext[:dir]}/Makefile")
+  CLEAN.include("#{ext[:dest]}/#{ext[:lib]}")
+end
+
+# Stud stuff.
+directory "tmp"
+file "bin/oversip_stud" => "tmp" do
+  Dir.chdir("ext/stud") do
+    ruby "extconf.rb"
+  end
+  FileUtils.remove_dir "tmp"
+end
+CLEAN.include("ext/stud/Makefile")
+CLEAN.include("thirdparty/stud/mkmf.log")
+CLEAN.include("bin/oversip_stud")
+
+
+OVERSIP_COMPILE_ITEMS = OVERSIP_EXTENSIONS.map {|e| e[:lib]} << "bin/oversip_stud"
+
+task :default => :compile
+
+desc "Compile"
+task :compile => OVERSIP_COMPILE_ITEMS
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+end
+
+# Make the :test task depend on the shared object, so it will be built automatically
+# before running the tests.
+desc "Run tests"
+task :test => OVERSIP_COMPILE_ITEMS

data/bin/oversip

@@ -0,0 +1,184 @@
+#!/usr/bin/env ruby
+# -*- encoding: binary -*-
+
+unless RUBY_VERSION >= "1.9.2"
+  raise ::LoadError, "OverSIP requires Ruby version >= 1.9.2 (current version is #{RUBY_VERSION})"
+end
+
+$LOAD_PATH.insert 0, File.expand_path(File.join(File.dirname(__FILE__), "../", "lib"))
+
+# When OverSIP is executed automaticaly via the system init (i.e. after booting the host)
+# the Encoding.default_external is US_ASCII which causes fails when reading daat from
+# some files (i.e. the cacert.pem file which contains no valid US_ASCII symbols). So
+# make the default external encoding UTF-8 right now.
+::Encoding.default_external = ::Encoding::UTF_8
+
+# First of all, trap some signals in order to ignore them if they arrive while
+# loading server libraries.
+[:HUP, :INT, :USR1, :USR2].each {|signal| trap(signal) {} }
+
+require "optparse"
+require "etc"
+require "oversip"
+
+
+module OverSIP
+
+  class Executable
+    extend ::OverSIP::Logger
+
+    @log_id = "executable"
+
+    def self.run
+      $0 = ::File.basename(__FILE__)
+      ::OverSIP::Logger.load_methods
+
+      # Options by default.
+      options = {
+        :colorize => true
+      }
+
+      OptionParser.new("", 28, "  ") do |opts|
+        opts.banner = "#{::OverSIP::DESCRIPTION}" \
+                      "\n\nUsage: #{File.basename(__FILE__)} " \
+                      "[#{::OverSIP::PROGRAM_NAME} options] [Ruby options]"
+
+        opts.separator "\n#{::OverSIP::PROGRAM_NAME} options:"
+
+        opts.on("-P", "--pid FILE", "Create a PID file (required)") do |value|
+          options[:pid_file] = value
+        end
+
+        opts.on("-p", "--process-name NAME", "Change the running process name (default 'oversip')") do |value|
+          options[:process_name] = value
+          $0 = options[:process_name]
+          ::OverSIP::Logger.load_methods
+        end
+
+        opts.on("--config-dir DIR", "Absolute path to the directory with user configuration files (default '/etc/oversip/')") do |value|
+          options[:config_dir] = value
+        end
+
+        opts.on("--config-file FILE", "Name of the configuration file within the configuration directory (default 'oversip.conf')") do |value|
+          options[:config_file] = value
+        end
+
+        opts.on("-u", "--user USER", "System user to run with") do |value|
+          options[:user] = value
+        end
+
+        opts.on("-g", "--group GROUP", "System group to run with") do |value|
+          options[:group] = value
+        end
+
+        opts.on("--no-color", "Don't colorize text printed in stdout") do |value|
+          options[:colorize] = false
+        end
+
+        opts.separator "\nRuby options:"
+
+        opts.on("-d", "--debug", "Set debugging flags ($DEBUG = true)") do
+          $DEBUG = true
+        end
+
+        opts.on("-w", "--warn", "Turn warnings on ($-w = true)") do
+          $-w = true
+        end
+
+        opts.on("-I", "--include PATH", "Add PATH to $LOAD_PATH (may be used more than once)") do |path|
+          $LOAD_PATH.unshift(*path.split(/:/))
+        end
+
+        opts.on("-r", "--require LIBRARY", "Load LIBRARY before running the programm (may be used more than once)") do |library|
+          require library
+        end
+
+        opts.separator "\nCommon options:"
+
+        opts.on_tail("-h", "--help", "Show this message") do
+          puts opts.to_s
+          exit
+        end
+
+        opts.on_tail("-v", "--version", "Show version") do
+          puts ::OverSIP::DESCRIPTION
+          exit
+        end
+
+        begin
+          opts.parse! ARGV
+        rescue ::OptionParser::InvalidOption => e
+          log_system_error e.message
+          puts
+          puts opts.to_s
+          exit! 1
+        rescue ::OptionParser::MissingArgument => e
+          log_system_error e.message
+          puts
+          puts opts.to_s
+          exit! 1
+        end
+      end
+
+      log_system_notice "#{::OverSIP::PROGRAM_NAME} #{::OverSIP::VERSION} starting..."
+
+      # Options checks.
+
+      # PID file is required.
+      unless options[:pid_file]
+        ::OverSIP::Launcher.fatal "PID file is required (use -P or --pid option)"
+      end
+
+      # Ignore user/group if the launcher is not being running as root.
+      unless ::Process.euid == 0
+        if options[:user] or options[:group]
+          log_system_warn "ignoring user/group parameters when not running as root"
+        end
+
+        options.delete :user
+        options.delete :group
+      else
+        # Get the uid and gid to run with.
+        if options[:user]
+          begin
+            ::Etc.getpwnam options[:user]
+          rescue ::ArgumentError
+            ::OverSIP::Launcher.fatal "user '#{options[:user]}' does not exist in the system"
+          end
+        end
+        if options[:group]
+          begin
+            ::Etc.getgrnam options[:group]
+          rescue ::ArgumentError
+            ::OverSIP::Launcher.fatal "group '#{options[:group]}' does not exist in the system"
+          end
+        end
+      end
+
+      # Set the command name (as it appears in "ps" output) to given --process_name option (-p)
+      # or to the script filename otherwise.
+      ::OverSIP.master_name = options[:process_name] || ::File.basename(__FILE__)
+      $0 = ::OverSIP.master_name
+      log_system_info "process name: #{::OverSIP.master_name}"
+
+      ::OverSIP::Config.load options[:config_dir], options[:config_file]
+      ::OverSIP::Config.print options[:colorize]
+
+      ::OverSIP::Logger::load_methods
+
+      begin
+        ::Process.setrlimit Process::RLIMIT_NOFILE, 65536, 65536
+      rescue => e
+        # ::OverSIP::Launcher.fatal e
+        log_system_error "error increasing rlimits for 'nofiles': #{e.message} (#{e.class})"
+      end
+
+      ::OverSIP::Launcher.daemonize!(options)
+      ::OverSIP::Launcher.run(options)
+
+    end  # def run
+  end  # class Executable
+end  # module OverSIP
+
+
+::OverSIP::Executable.run

data/etc/oversip.conf

@@ -0,0 +1,274 @@
+#
+# OverSIP - Main Configuration.
+#
+#
+# IMPORTANT:
+#   This is a YAML [1] format configuration file. DON'T USE tab for indentation
+#   as it's not allowed and would raise unexpected errors. Instead, respect
+#   the existing indentation spaces.
+#   [1] http://en.wikipedia.org/wiki/YAML
+
+
+core:
+
+  # DNS nameserver to use. Note that OverSIP requires a recursive DNS server
+  # (recommended unbound: a DNS recursive and caching DNS resolver).
+  # Value can be:
+  # - An IPv4.
+  # - An array of IPv4 (for failover).
+  # - _null_: nameservers in /etc/resolv.conf are used.
+  # Default value is _null_.
+  #
+  nameservers: null
+
+  # Syslog facility. Can be "kern", "user", "daemon", "local0"..."local7".
+  # By default "daemon".
+  #
+  syslog_facility: daemon
+
+  # Syslog level. Can be "debug", "info", "notice", "warn", "error", "crit".
+  # By default "info".
+  #
+  syslog_level: debug
+
+
+sip:
+
+  # Use SIP over UDP. By default _yes_.
+  #
+  sip_udp: yes
+
+  # Use SIP over TCP. By default _yes_.
+  #
+  sip_tcp: yes
+
+  # Use SIP over TLS. By default _yes_.
+  #
+  sip_tls: yes
+
+  # Enable or disable IPv4. By default _yes_.
+  #
+  enable_ipv4: yes
+
+  # IPv4 in which OverSIP listens for SIP messages. Using "0.0.0.0" is not
+  # allowed.
+  # - Use an IPv4 string for listening in that address.
+  # - Use _null_ for IP autodiscovery.
+  # Default value is _null_.
+  #
+  listen_ipv4: null
+
+  # Advertised IPv4 for Via, Record-Route and Path headers.
+  # Useful when OverSIP runs behind a NAT and must expose the router public
+  # IPv4 to the outside.
+  # Default value is _null_ which means that the local IPv4 is used.
+  #
+  advertised_ipv4: null
+
+  # Enable or disable IPv6. By default _yes_.
+  #
+  enable_ipv6: yes
+
+  # IPv6 in which OverSIP listens for SIP messages. Using "::" is not
+  # allowed.
+  # - Use an IPv6 string for listening in that address.
+  # - Use _null_ for IP autodiscovery.
+  # Default value is _null_.
+  #
+  listen_ipv6: null
+
+  # Advertised IPv6 for Via, Record-Route and Path headers.
+  # Useful when OverSIP runs behind a NAT and must expose the router public
+  # IPv4 to the outside.
+  # Default value is _null_ which means that the local IPv6 is used.
+  #
+  advertised_ipv6: null
+
+  # Listening port for SIP over UDP and TCP.
+  # By default 5060.
+  #
+  listen_port: 5060
+
+  # Listening port for SIP over TLS.
+  # By default 5061.
+  #
+  listen_port_tls: 5061
+
+  # By enabling this option OverSIP does not listen in SIP TLS but, instead,
+  # runs an instance of Stud TLS proxy which communicates with OverSIP using
+  # plain TCP.
+  # By default _yes_.
+  #
+  use_tls_tunnel: yes
+
+  # The port which listens for TCP traffic from the Stud TLS proxy running in
+  # this host.
+  # By default 5062.
+  #
+  listen_port_tls_tunnel: 5062
+
+  # Call the OverSIP::SipEvents.on_client_tls_handshake() callback when a SIP
+  # client attemps a TLS handshake with OverSIP.
+  # By default _yes_.
+  #
+  callback_on_client_tls_handshake: yes
+
+  # Local domains OverSIP is responsible for.  Value can be:
+  # - A domain.
+  # - An array of domains.
+  # - _null_: no one, just local IP's are matched as local destinations.
+  # Default value is _null_.
+  #
+  # local domains: [ example.net, sip.example.org ]
+  local_domains: null
+
+  # TCP keepalive interval (in seconds).
+  # When acting as a TCP server, OverSIP sends TCP packets with null data payload
+  # as described in http://tldp.org/HOWTO/html_single/TCP-Keepalive-HOWTO/.
+  # If not set, TCP keepalive is disabled.
+  # Minimun value is 180 seconds. Default value is _null_ (not enabled).
+  #
+  tcp_keepalive_interval: 300
+
+  # Use a hostname for Record-Route/Path header when using TLS or WSS transports
+  # over IPv4 (rather than using the server IP). This is good when a peer
+  # sends us an in-dialog request via TLS so it could check whether the host part
+  # of the top Route header matches a domain in the certificate we provide to it.
+  # If not set, the server IPv4 will be used.
+  # Default value is _null_ (IPv4 is used).
+  #
+  # record_route_hostname_tls_ipv4: outbound.example.net
+  record_route_hostname_tls_ipv4: null
+
+  # The same for IPv6.
+  # If not set, the server IPv6 will be used.
+  # Default value is _null_ (IPv6 is used).
+  #
+  # record_route_hostname_tls_ipv6: outbound.example.net
+  record_route_hostname_tls_ipv6:  null
+
+
+websocket:
+
+  # Use SIP over WebSocket. By default _yes_.
+  #
+  sip_ws: yes
+
+  # Use SIP over WebSocket with TLS. By default _yes_.
+  #
+  sip_wss: yes
+
+  # Enable or disable IPv4. By default _yes_.
+  #
+  enable_ipv4: yes
+
+  # IPv4 in which OverSIP listens for WebSocket messages. Using "0.0.0.0" is not
+  # allowed.
+  # - Use an IPv4 string for listening in that address.
+  # - Use _null_ for IP autodiscovery.
+  # Default value is _null_.
+  #
+  listen_ipv4: null
+
+  # Advertised IPv4 for Via, Record-Route and Path headers.
+  # Useful when OverSIP runs behind a NAT and must expose the router public
+  # IPv4 to the outside.
+  # Default value is _null_ which means that the local IPv4 is used.
+  #
+  advertised_ipv4: null
+
+  # Enable or disable IPv6. By default _yes_.
+  #
+  enable_ipv6: yes
+
+  # IPv6 in which OverSIP listens for SIP messages. Using "::" is not
+  # allowed.
+  # - Use an IPv6 string for listening in that address.
+  # - Use _null_ for IP autodiscovery.
+  # Default value is _null_.
+  #
+  listen_ipv6: null
+
+  # Advertised IPv6 for Via, Record-Route and Path headers.
+  # Useful when OverSIP runs behind a NAT and must expose the router public
+  # IPv4 to the outside.
+  # Default value is _null_ which means that the local IPv6 is used.
+  #
+  advertised_ipv6: null
+
+  # Listening port for WebSocket over HTTP.
+  # By default 10080.
+  #
+  listen_port: 10080
+
+  # Listening port for WebSocket over HTTPS.
+  # By default 10443.
+  #
+  listen_port_tls: 10443
+
+  # By enabling this option OverSIP does not listen in WebSocket TLS but, instead,
+  # runs an instance of Stud TLS proxy which communicates with OverSIP using
+  # plain TCP.
+  # By default _yes_.
+  #
+  use_tls_tunnel: yes
+
+  # The port which listens for TCP traffic from the Stud TLS proxy running in
+  # this host.
+  # By default 10444.
+  #
+  listen_port_tls_tunnel: 10444
+
+  # Call the OverSIP::WebSocketEvents.on_client_tls_handshake() callback when a WebSocket
+  # client attemps a TLS handshake with OverSIP.
+  # By default _yes_.
+  #
+  callback_on_client_tls_handshake: yes
+
+  # WebSocket message max size (bytes). By default 65536.
+  #
+  max_ws_message_size: 65536
+
+  # WebSocket frame max size (bytes). By default 65536.
+  #
+  max_ws_frame_size: 65536
+
+  # WebSocket PING frames interval (in seconds).
+  # If set, OverSIP sends WebSocket PING control frames as the given interval.
+  # Minimun value is 180. Default value is _null_.
+  #
+  ws_keepalive_interval: 300
+
+
+# TLS parameters affect to any interface of OverSIP using TLS, including SIP and WebSocket.
+tls:
+
+  # Server TLS public certificate. It must be the name of a readable file containing a
+  # chain of X509 certificates in PEM format, with the most-resolved certificate at the
+  # top of the file, successive intermediate certs in the middle, and the root (or CA)
+  # cert at the bottom.
+  # If not set, TLS is disabled. Default value is _null_.
+  # If a relative path is given, it's searched under the tls/ directoy in the OverSIP
+  # configuration directory (typically /etc/oversip/).
+  #
+  public_cert: demo-tls.oversip.net.crt
+
+  # Server TLS private certificate. It must be the name of a readable file containing a
+  # private key in the PEM format.
+  # If not set, TLS is disabled. Default value is _null_.
+  # If a relative path is given, it's searched under the tls/ directoy in the OverSIP
+  # configuration directory (typically /etc/oversip/).
+  # NOTE: The private key MUST NOT require password.
+  #
+  private_cert: demo-tls.oversip.net.key
+
+  # Directory of TLS CAs. It must be the name of a readable directory. Every file in
+  # that directory will be inspected and every X509 certificate in PEM format extracted.
+  # This is useful for storing the list of trusted CAs (i.e. http://curl.haxx.se/ca/cacert.pem)
+  # or CAs not in a standard trust hierarchy.
+  # This is *required* for validating certificates provided by remote peers.
+  # If _null_ this feature is dssabled. Default value is _null_.
+  # If a relative path is given, it's searched under the tls/ directoy in the OverSIP
+  # configuration directory (typically /etc/oversip/).
+  #
+  ca_dir: ca/