quaff 0.3.4 → 0.4.0

data/lib/auth.rb

@@ -1,3 +1,5 @@
+require 'base64'
+
 module Quaff
   module Auth
     def Auth.gen_nonce auth_pairs, username, passwd, method, sip_uri
@@ -9,6 +11,17 @@ module Quaff
       return digest
     end
 
+    def Auth.extract_rand auth_line
+      # Split auth line on commas
+      auth_pairs = {}
+      auth_line.sub("Digest ", "").split(",") .each do |pair|
+        key, value = pair.split "="
+        auth_pairs[key.gsub(" ", "")] = value.gsub("\"", "").gsub(" ", "")
+      end
+      # First 128 bits are the RAND
+      return Base64.decode64(auth_pairs["nonce"])[0..15]
+    end
+
     def Auth.gen_auth_header auth_line, username, passwd, method, sip_uri
       # Split auth line on commas
       auth_pairs = {}

data/lib/call.rb

@@ -5,21 +5,21 @@ require_relative './auth.rb'
 require_relative './message.rb'
 
 module Quaff
-class CSeq # :nodoc:
-  def initialize cseq_str
-    @num, @method = cseq_str.split
-    @num = @num.to_i
-  end
-
-  def increment
-    @num = @num + 1
-    to_s
-  end
+  class CSeq # :nodoc:
+    attr_reader :num
+    def initialize cseq_str
+      @num, @method = cseq_str.split
+      @num = @num.to_i
+    end
 
-  def to_s
-    "#{@num.to_s} #{@method}"
-  end
+    def increment
+      @num = @num + 1
+      to_s
+    end
 
+    def to_s
+      "#{@num.to_s} #{@method}"
+    end
 end
 
 class Call
@@ -49,8 +49,15 @@ class Call
     @cxn.add_call_id @cid
   end
 
-  def update_branch
-    @last_Via = "SIP/2.0/#{@cxn.transport} #{Quaff::Utils.local_ip}:#{@cxn.local_port};rport;branch=#{Quaff::Utils::new_branch}"
+  def update_branch via_hdr=nil
+    via_hdr ||= get_new_via_hdr
+    @last_Via = via_hdr
+  end
+
+  alias_method :new_transaction, :update_branch
+
+  def get_new_via_hdr
+    "SIP/2.0/#{@cxn.transport} #{Quaff::Utils.local_ip}:#{@cxn.local_port};rport;branch=#{Quaff::Utils::new_branch}"
   end
 
   def create_dialog msg
@@ -72,36 +79,46 @@ class Call
     end
   end
 
-  def recv_request(method)
+  def recv_request(method, dialog_creating=true)
     begin
-      data = recv_something
+      msg = recv_something
     rescue
       raise "#{ @uri } timed out waiting for #{ method }"
     end
-    unless data["message"].type == :request \
-      and Regexp.new(method) =~ data["message"].method
-      raise((data['message'].to_s || "Message is nil!"))
+    unless msg.type == :request \
+      and Regexp.new(method) =~ msg.method
+      raise((msg.to_s || "Message is nil!"))
     end
-    unless data['message'].all_headers("Record-Route").nil?
-      @routeset = data['message'].all_headers("Record-Route")
+    if dialog_creating
+      set_callee msg.first_header("Contact")
+      unless msg.all_headers("Record-Route").nil?
+        @routeset = msg.all_headers("Record-Route")
+      end
     end
-    data
+    msg
   end
 
-  def recv_response(code)
+  def recv_response(code, dialog_creating=false)
     begin
-      data = recv_something
+      msg = recv_something
     rescue
       raise "#{ @uri } timed out waiting for #{ code }"
     end
-    unless data["message"].type == :response \
-      and Regexp.new(code) =~ data["message"].status_code
-      raise "Expected #{ code}, got #{data["message"].status_code || data['message']}"
+    unless msg.type == :response \
+      and Regexp.new(code) =~ msg.status_code
+      raise "Expected #{ code}, got #{msg.status_code || msg}"
     end
-    unless data['message'].all_headers("Record-Route").nil?
-      @routeset = data['message'].all_headers("Record-Route").reverse
+    if dialog_creating
+      set_callee msg.first_header("Contact")
+      unless msg.all_headers("Record-Route").nil?
+        @routeset = msg.all_headers("Record-Route").reverse
+      end
     end
-    data
+    msg
+  end
+
+  def recv_response_and_create_dialog(code)
+    recv_response code, true
   end
 
   def send_response(code, phrase, body="", retrans=nil, headers={})
@@ -119,7 +136,6 @@ class Call
     @cxn.mark_call_dead @cid
   end
 
-
   def clear_tag str
     str
   end
@@ -143,22 +159,22 @@ class Call
 
   private
   def recv_something
-    data = @cxn.get_new_message @cid
+    msg = @cxn.get_new_message @cid
     @retrans = nil
-    @src = data['source']
-    @last_To = data["message"].header("To")
-    @last_From = data["message"].header("From")
-    set_callee data["message"].header("From")
-    @last_Via = data["message"].headers["Via"]
-    @last_CSeq = CSeq.new(data["message"].header("CSeq"))
-    data
+    @src = msg.source
+    @last_To = msg.header("To")
+    @last_From = msg.header("From")
+    set_callee msg.header("From")
+    @last_Via = msg.headers["Via"]
+    @last_CSeq = CSeq.new(msg.header("CSeq"))
+    msg
   end
 
   def calculate_cseq type, method
     if (type == :response)
       @last_CSeq.to_s
     elsif (method == "ACK")
-      @last_CSeq.to_s
+      "#{@last_CSeq.num} ACK"
     else
       @cseq_number = @cseq_number + 1
       "#{@cseq_number} #{method}"

data/lib/endpoint.rb

@@ -4,12 +4,19 @@ require 'thread'
 require 'timeout'
 require 'resolv'
 require 'digest/md5'
+#require 'milenage'
 require_relative './sip_parser.rb'
 require_relative './sources.rb'
 
 module Quaff
   class BaseEndpoint
-    attr_accessor :msg_trace, :uri
+    attr_accessor :msg_trace, :uri, :sdp_port, :sdp_socket
+
+    def setup_sdp
+      @sdp_socket = UDPSocket.new
+      @sdp_socket.bind('0.0.0.0', 0)
+      @sdp_port = @sdp_socket.addr[1]
+    end
 
     def generate_call_id
       digest = Digest::MD5.hexdigest(rand(60000).to_s)
@@ -33,13 +40,23 @@ module Quaff
       Call.new(self, call_id, @uri, @outbound_connection, to_uri)
     end
 
+    def create_client(uri, username, password, outbound_proxy, outbound_port=5060)
+    end
+
+    def create_server(uri, local_port=5060, outbound_proxy=nil, outbound_port=5060)
+
+    end
+
+    def create_aka_client(uri, username, key, op, outbound_proxy, outbound_port=5060)
+    end
+
     def initialize(uri, username, password, local_port, outbound_proxy=nil, outbound_port=5060)
       @uri = uri
       @resolver = Resolv::DNS.new
       @username = username
       @password = password
       @lport = local_port
-      initialize_connection @lport
+      initialize_connection
       if outbound_proxy
         @outbound_connection = new_connection(outbound_proxy, outbound_port)
       end
@@ -75,18 +92,28 @@ module Quaff
         source.send_msg(@cxn, data)
     end
 
-    def register expires="3600"
+    def set_aka_credentials key, op
+      @kernel = Milenage.Kernel key
+      @kernel.op = op
+    end
+
+    def register expires="3600", aka=false
       call = outgoing_call(@uri)
       call.send_request("REGISTER", "", { "Expires" => expires.to_s })
       response_data = call.recv_response("401|200")
-      if response_data['message'].status_code == "401"
-        call.send_request("ACK")
-        auth_hdr = Quaff::Auth.gen_auth_header response_data['message'].header("WWW-Authenticate"), @username, @password, "REGISTER", @uri
+      if response_data.status_code == "401"
+        if aka
+          rand = Quaff::Auth.extract_rand response_data.header("WWW-Authenticate")
+          password = @kernel.f3 rand
+        else
+          password = @password
+        end
+        auth_hdr = Quaff::Auth.gen_auth_header response_data.header("WWW-Authenticate"), @username, @password, "REGISTER", @uri
         call.update_branch
         call.send_request("REGISTER", "", {"Authorization" =>  auth_hdr, "Expires" => expires.to_s, "CSeq" => "2 REGISTER"})
-        call.recv_response("200")
+        response_data = call.recv_response("200")
       end
-      return true
+      return response_data # always the 200 OK
     end
 
     def unregister
@@ -110,27 +137,32 @@ module Quaff
     end
 
     def queue_msg(msg, source)
-        puts "Endpoint on #{@lport} received #{msg} from #{source.inspect}" if @msg_trace
-        cid = @parser.message_identifier msg
-        if cid and not @dead_calls.has_key? cid then
-            unless @messages.has_key? cid then
-
-                add_call_id cid
-                @call_ids.enq cid
-            end
-        @messages[cid].enq({"message" => msg, "source" => source})
+      puts "Endpoint on #{@lport} received #{msg} from
+                          ##{source.inspect}" if @msg_trace
+      msg.source = source
+      cid = @parser.message_identifier msg
+      if cid and not @dead_calls.has_key? cid then
+        unless @messages.has_key? cid then
+          add_call_id cid
+          @call_ids.enq cid
         end
+        @messages[cid].enq(msg)
+      end
     end
-
   end
 
   class TCPSIPEndpoint < BaseEndpoint
     attr_accessor :sockets
 
-    def initialize_connection(lport)
-        @cxn = TCPServer.new(lport)
-        @parser = SipParser.new
-        @sockets = []
+    def initialize_connection
+      if @lport != :anyport
+        @cxn = TCPServer.new(@lport)
+      else
+        @cxn = TCPServer.new(0)
+        @lport = @cxn.addr[1]
+      end
+      @parser = SipParser.new
+      @sockets = []
     end
 
     def transport
@@ -201,11 +233,16 @@ module Quaff
     alias_method :new_connection, :new_source
 
     private
-    def initialize_connection(lport)
-        @cxn = UDPSocket.new
-        @cxn.bind('0.0.0.0', lport)
-        @sockets = []
-        @parser = SipParser.new
+    def initialize_connection
+      @cxn = UDPSocket.new
+      if @lport != :anyport
+        @cxn.bind('0.0.0.0', @lport)
+      else
+        @cxn.bind('0.0.0.0', 0)
+        @lport = @cxn.addr[1]
+      end
+      @sockets = []
+      @parser = SipParser.new
     end
 
     def recv_msg

data/lib/message.rb

@@ -1,6 +1,6 @@
 module Quaff
 class SipMessage
-  attr_accessor :method, :requri, :reason, :status_code, :headers
+  attr_accessor :method, :requri, :reason, :status_code, :headers, :source
   attr_reader :body
 
   def initialize method=nil, status_code=nil, reason=nil,
@@ -11,6 +11,14 @@ class SipMessage
     @headers['Content-Length'] = [body.length]
   end
 
+  def [] key
+    if key == "message"
+      self
+    elsif key == "source"
+      @source
+    end
+  end
+
   def type
     if @method
       :request

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: quaff
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-17 00:00:00.000000000 Z
+date: 2013-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: facter
@@ -27,6 +27,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.7.3
+- !ruby/object:Gem::Dependency
+  name: milenage
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.1.0
 description: A Ruby library for writing SIP test scenarios
 email: rkd@rkd.me.uk
 executables: []