sip-capture 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8f1ce52ec65ab8dd5a45b34f5d0750c9a621d41f
+  data.tar.gz: c3b49a8abd7b189d8b3ad40c195750b96c70b025
+SHA512:
+  metadata.gz: '0866b47fe93414c5cf21c45cc7b008eea982c8d0160b370efda7766c31cb37f6fa38654b0a8b4a9aff1b6be8de6aac1a649070cd33db8f8da54195b896257c5e'
+  data.tar.gz: fe742dfa939c425dbd5bf488f17877974085672ef1aa77837c5a605516f2f7f6cbd95388ad6bb3034d2158dc84e29e40ac2cda700ef648c0c6fcf1b1fc0f148e

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.7
+before_install: gem install bundler -v 1.16.2

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in sip-capture.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,22 @@
+PATH
+  remote: .
+  specs:
+    sip-capture (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.11.3)
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  minitest (~> 5.0)
+  rake (~> 10.0)
+  sip-capture!
+
+BUNDLED WITH
+   1.16.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 ukolovda
+
+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,53 @@
+# Sip::Capture
+
+This gem user in capture-server for FreeSwitch and other SIP servers with HEP3 logging
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sip-capture'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sip-capture
+
+## Usage
+
+```ruby
+Sip::Capture::Hep3.capture_all('127.0.0.1', 9060) do |item|
+  puts item.inspect 
+  # => {"ip_protocol_family":2,
+  #     "ip_protocol_id":6,
+  #     "protocol_type":1,
+  #     "ipv4_source_address":"169.254.0.2",
+  #     "protocol_source_port":33620,
+  #     "ipv4_destination_address":"169.254.0.2",
+  #     "protocol_destination_port":4443,
+  #     "timestamp_sec":1534916954,
+  #     "timestamp_usec":433421,
+  #     "capture_agent_id":114163712,
+  #     "payload":"BYE sip:0011@169.254.0.2:5060;transport=udp SIP/2.0\r\nVia: SIP/2.0/WSS df7jal...."}
+  
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ukolovda/sip-capture.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sip/capture"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/sip/capture/hep3.rb

@@ -0,0 +1,118 @@
+require 'socket'
+require 'json'
+
+module Sip
+  module Capture
+    
+    class Hep3
+
+      SIGNATURE = "HEP3"
+      GENERIC_VENDOR_ID = 0
+
+      def self.capture_all(host, port, &block)
+        h = Hep3.new
+        h.bind(host, port)
+        h.capture_all(&block)
+      end
+
+      def bind(host, port)
+        @socket = UDPSocket.new
+        @socket.bind(host, port)
+      end
+
+      def process_data(data)
+        if (item = parse(data))
+          yield item if block_given?
+        end
+      end
+
+      def capture_all(&block)
+        @in_loop = true
+        while @in_loop do
+          begin
+            data = @socket.recvfrom_nonblock(65535)  #=> ["aaa", ["AF_INET", 33302, "localhost.localdomain", "127.0.0.1"]]
+            process_data data[0], &block
+          rescue IO::WaitReadable
+            IO.select([s1], [], [], 10)
+            retry
+          end
+        end
+      end
+
+      def stop
+        @in_loop = false
+      end
+      
+      private
+
+      HEP3_FIELDS = {
+          1 => [:ip_protocol_family, :uint8],
+          2 => [:ip_protocol_id, :uint8],
+          3 => [:ipv4_source_address, :ipv4],
+          4 => [:ipv4_destination_address, :ipv4],
+          5 => [:ipv6_source_address, :ipv6],
+          6 => [:ipv6_destination_address, :ipv6],
+          7 => [:protocol_source_port, :uint16],
+          8 => [:protocol_destination_port, :uint16],
+          9 => [:timestamp_sec, :uint32],
+          10=> [:timestamp_usec, :uint32],
+          11=> [:protocol_type, :uint8],
+          12=> [:capture_agent_id, :uint32],
+          13=> [:keep_alive_timer, :uint16],
+          14=> [:authenticate_key, :str],
+          15=> [:payload, :str]
+      }
+
+      def parse(data)
+        # See https://github.com/sipcapture/HEP
+        if hep3?(data)
+          item = {}
+          length = data[4..5].unpack("S>").first
+          pos = 6
+          while pos < length do
+            vendor_id, type_id, chunk_length = data[pos..pos+5].unpack("S>S>S>")
+            payload = data[pos+6...pos+chunk_length]
+            if vendor_id == GENERIC_VENDOR_ID
+              if (info = HEP3_FIELDS[type_id])
+                name, parse_method = info
+                item[name] = send(:"parse_#{parse_method}", payload)
+              end
+            end
+            pos += chunk_length
+          end
+          item
+        end
+      end
+
+      def hep3?(data)
+        data[0..3] == SIGNATURE
+      end
+
+      def parse_uint8(payload)
+        payload.unpack("C").first
+      end
+
+      def parse_uint16(payload)
+        payload.unpack("S>").first
+      end
+
+      def parse_uint32(payload)
+        payload.unpack("L>").first
+      end
+
+      def parse_ipv4(payload)
+        payload.unpack("CCCC").join(".")
+      end
+
+      def parse_ipv6(payload)
+    #    payload.unpack("CCCCCC").map{}.join(".")
+        nil
+      end
+
+      def parse_str(payload)
+        payload.force_encoding('UTF-8')
+      end
+    end
+
+  end
+end

data/lib/sip/capture/version.rb

@@ -0,0 +1,5 @@
+module Sip
+  module Capture
+    VERSION = "0.1.0"
+  end
+end

data/lib/sip/capture.rb

@@ -0,0 +1,8 @@
+require "sip/capture/hep3"
+require "sip/capture/version"
+
+module Sip
+  module Capture
+    # Your code goes here...
+  end
+end

data/sip-capture.gemspec

@@ -0,0 +1,40 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "sip/capture/version"
+
+Gem::Specification.new do |spec|
+  spec.required_ruby_version = '>= 2.0.0'
+
+  spec.name          = "sip-capture"
+  spec.version       = Sip::Capture::VERSION
+  spec.authors       = ["ukolovda"]
+  spec.email         = ["udmitry@mail.ru"]
+
+  spec.summary       = %q{SIP capture library.}
+  spec.description   = %q{SIP capture library (now process HEP3).}
+  spec.homepage      = "https://github.com/ukolovda/sip-capture"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: sip-capture
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ukolovda
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-08-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: SIP capture library (now process HEP3).
+email:
+- udmitry@mail.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sip/capture.rb
+- lib/sip/capture/hep3.rb
+- lib/sip/capture/version.rb
+- sip-capture.gemspec
+homepage: https://github.com/ukolovda/sip-capture
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: SIP capture library.
+test_files: []