sip_digest_auth 0.0.2

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZTY0YjU1NTExNzI0ZTA2NjBmZDFkZjI3NmRmZjYyOTQ1MjY0NWUxNw==
+  data.tar.gz: !binary |-
+    ZTMzNDY4MjIxYzhmYjZlZTA2MzY2YjcyMzM3NmQ2ZjgxOTkzNDVlMw==
+SHA512:
+  metadata.gz: !binary |-
+    NjU0YjljMjUyYjFmNTk0OWJkODY5YjNiMjc0MTViMzIzOGM1MWFkOGZjOTVm
+    MDYzNDA4NjY3MjI5NzJhM2ZhNWQ3MTYzYWVlNWU0YzBhMzAxOTViMTY1NmJh
+    ZTIzM2M5NTE1NzNmNmQ4NzNkOGNlNTQ5MWM5NDYwMWQ2YmVmM2Y=
+  data.tar.gz: !binary |-
+    ZDIwOTNhODdhYTFiZGY2MTlkYjhjNjVhYWU2Y2Q0MGU3MTdjMTgzYzhlZGM2
+    Y2JiYmI3MzAxMTQwZTMwYWJmMWE3YmFjZjM5YjE3MWIxM2JkNzc4MjhjZGVj
+    MGJlZTE4OTZkMGMwZjVkNWJkNTRlNTVmODdjNDAyOGFhYjIwOGQ=

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.ruby-version
+/.idea

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sip_digest_auth.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Daniel Jabbour
+
+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,29 @@
+# SipDigestAuth
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sip_digest_auth'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sip_digest_auth
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*.rb'
+end

data/lib/sip_digest_auth.rb

@@ -0,0 +1,38 @@
+require 'sip_digest_auth/util'
+require 'sip_digest_auth/session'
+require 'sip_digest_auth/version'
+
+module SipDigestAuth
+  extend self
+
+  def challenge(session)
+    header_name = session.proxy ? 'proxy-authenticate' : 'www-authenticate'
+
+    header_values = [
+      "Digest",
+      "realm: #{q(session.realm)}",
+      "qop: #{q(session.qop)}",
+      "algorithm: #{q(session.algorithm)}",
+      "nonce: #{q(session.nonce)}",
+      "opaque: #{q(session.opaque)}"
+    ]
+
+    [header_name, header_values.join(', ')]
+  end
+
+  # Credentials are optional if the session is established. When specified, it is a hash containing
+  # either :user & :password OR the key :hash. Required on the first call to cache h1 in session.
+  def authenticate_request(session, request, credentials=nil)
+    #TODO: Implement
+  end
+
+  protected
+
+  def q(str)
+    if str && str[0] != '"'
+      str = "\"#{str}\""
+    end
+    str
+  end
+
+end

data/lib/sip_digest_auth/session.rb

@@ -0,0 +1,35 @@
+require 'hashie/dash'
+
+module SipDigestAuth
+  class Session < ::Hashie::Dash
+    # Realm *must* be set, and is the only required field when creating a session for the first time
+    property :realm, required: true
+
+    # The nonce should stay the same for a single session, and will be generated if not provided on
+    # initialization. Subsequent requests within the same session should ensure nonce is set
+    property :nonce, default: Util.generate_nonce
+
+    # Opaque doesn't seem to be mandated and I'm a little confused as to why it's necessary with a
+    # nonce. Rfc2617 specifies: "A string of data, specified by the server, which should be returned
+    # by the client unchanged in the Authorization header of subsequent requests with URIs in the
+    # same protection space." In this case, I'm going to leave it up to the caller to specify it.
+    property :opaque, default: ''
+
+    # The ha1 is generated during authentication. HA1 = MD5(username:realm:password)
+    property :ha1
+
+    # When true, assume a proxy of some kind to an upstream SIP provider. This has subtle effects on
+    # how authentication takes place (for example, changing the name of the challenge headers)
+    property :proxy, default: false
+
+    # These are internal and probably not going to change, but it's possible to build more support
+    # into the library later, and they really belong in the session:
+    property :qop, default: 'auth,auth-int'
+    property :algorithm, default: 'md5'
+    property :nc, default: 0
+
+    def increment_nc!
+      self.nc = self.nc + 1
+    end
+  end
+end

data/lib/sip_digest_auth/util.rb

@@ -0,0 +1,18 @@
+require 'base64'
+
+module SipDigestAuth
+  # Utility functions for our library
+  module Util
+    extend self
+
+    # args is an array of crap
+    def create_digest(*args)
+      ::Digest::MD5.hexdigest(args.join(":"))
+    end
+
+    def generate_nonce(secret_key = rand.to_s, time = Time.now)
+      t = time.to_i
+      create_digest(t, secret_key)
+    end
+  end
+end

data/lib/sip_digest_auth/version.rb

@@ -0,0 +1,3 @@
+module SipDigestAuth
+  VERSION = "0.0.2"
+end

data/sip_digest_auth.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sip_digest_auth/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sip_digest_auth"
+  spec.version       = SipDigestAuth::VERSION
+  spec.authors       = ["Daniel Jabbour"]
+  spec.email         = ["sayhi@amoe.ba"]
+  spec.description   = "Implementation of SIP Digest Authentication as specified in RFC3261"
+  spec.summary       = "This gem is to be used with a SIP server to implement Digest Authentication, like HTTP authentication (specified in RFC2617)"
+  spec.homepage      = "http://github.com/AmoebaLabs/sip_digest_auth"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "hashie"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest", "~> 5.2.0"
+end

data/test/sip_digest_auth/session_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+
+describe SipDigestAuth::Session do
+  before do
+    @session = SipDigestAuth::Session.new(realm: "test")
+  end
+
+  it "lets you pass all arguments on initializer" do
+    session = SipDigestAuth::Session.new({
+      realm: 'test',
+      nonce: 'test',
+      opaque: 'test',
+      ha1: 'test',
+      proxy: true
+    })
+
+    %w(realm nonce opaque ha1).each do |field|
+      session.send(field).must_equal 'test'
+    end
+    session.proxy.must_equal true
+  end
+
+  it "requires a realm" do
+    proc {
+      session = SipDigestAuth::Session.new
+    }.must_raise ArgumentError
+  end
+
+  it "has a nonce by default" do
+    @session.nonce.wont_be_empty
+  end
+
+  it "has a blank opaque by default" do
+    @session.opaque.must_be_empty
+  end
+
+  it "has no default ha1" do
+    @session.ha1.must_be_nil
+  end
+
+  it "lets you set a ha1" do
+    @session.ha1 = "test"
+    @session.ha1.must_equal "test"
+  end
+
+  it "defaults to no proxy mode" do
+    @session.proxy.must_equal false
+  end
+
+  it "lets you set the proxy" do
+    @session.proxy = true
+    @session.proxy.must_equal true
+  end
+
+  it "deafults qop properly" do
+    @session.qop.must_equal 'auth,auth-int'
+  end
+
+  it "defaults algorithm property" do
+    @session.algorithm.must_equal 'md5'
+  end
+
+  it "has a nc of 0 by default" do
+    @session.nc.must_equal 0
+  end
+
+  it "can increment nc" do
+    nc = @session.nc
+    @session.increment_nc!
+    @session.nc.must_equal nc+1
+  end
+
+
+end

data/test/sip_digest_auth/util_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+require 'base64'
+
+describe SipDigestAuth::Util do
+  describe "#create_digest" do
+    it "can make a digest with arguments" do
+      args = ['1', '2']
+      SipDigestAuth::Util.create_digest(*args).must_equal ::Digest::MD5.hexdigest(args.join(":"))
+    end
+
+    it "can make a digest with an array" do
+      args = ['1', '2']
+      SipDigestAuth::Util.create_digest(args).must_equal ::Digest::MD5.hexdigest(args.join(":"))
+    end
+  end
+
+  describe "#generate_nonce" do
+    it "generates a 32 character string" do
+      SipDigestAuth::Util.generate_nonce.length.must_equal 32
+    end
+
+    it "lets you specify the secret_key and time" do
+      time = Time.now
+      nonce = SipDigestAuth::Util.generate_nonce("secret", time)
+      nonce.must_equal SipDigestAuth::Util.create_digest(time.to_i, "secret")
+    end
+  end
+
+end

data/test/sip_digest_auth_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe SipDigestAuth do
+  describe "#challenge" do
+    before do
+      @session = SipDigestAuth::Session.new(realm: 'test', qop: 'test', algorithm: 'test', nonce: 'test', opaque: '')
+    end
+
+    it "returns proxy-authenticate when session.proxy" do
+      @session.proxy = true
+      SipDigestAuth.challenge(@session)[0].must_equal 'proxy-authenticate'
+    end
+
+    it "returns www-authenticate when not session.proxy" do
+      @session.proxy = false
+      SipDigestAuth.challenge(@session)[0].must_equal 'www-authenticate'
+    end
+
+    it "contains the accurate session values in its return header" do
+      SipDigestAuth.challenge(@session)[1].must_equal [
+        'Digest',
+        "realm: \"#{@session.realm}\"",
+        "qop: \"#{@session.qop}\"",
+        "algorithm: \"#{@session.algorithm}\"",
+        "nonce: \"#{@session.nonce}\"",
+        "opaque: \"#{@session.opaque}\""
+      ].join(', ')
+    end
+  end
+end

data/test/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'minitest/autorun'
+require 'sip_digest_auth'

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: sip_digest_auth
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Daniel Jabbour
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+description: Implementation of SIP Digest Authentication as specified in RFC3261
+email:
+- sayhi@amoe.ba
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sip_digest_auth.rb
+- lib/sip_digest_auth/session.rb
+- lib/sip_digest_auth/util.rb
+- lib/sip_digest_auth/version.rb
+- sip_digest_auth.gemspec
+- test/sip_digest_auth/session_spec.rb
+- test/sip_digest_auth/util_spec.rb
+- test/sip_digest_auth_spec.rb
+- test/spec_helper.rb
+homepage: http://github.com/AmoebaLabs/sip_digest_auth
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.1
+signing_key: 
+specification_version: 4
+summary: This gem is to be used with a SIP server to implement Digest Authentication,
+  like HTTP authentication (specified in RFC2617)
+test_files:
+- test/sip_digest_auth/session_spec.rb
+- test/sip_digest_auth/util_spec.rb
+- test/sip_digest_auth_spec.rb
+- test/spec_helper.rb