radiusrb 1.0.0.pre

data/Gemfile

@@ -0,0 +1,11 @@
+source "http://rubygems.org"
+
+gem 'ipaddr_extensions'
+
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+  gem "rdoc", ">= 2.4.2"
+end

data/Gemfile.lock

@@ -0,0 +1,30 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    ipaddr_extensions (2012.1.13)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    json (1.6.5)
+    rake (0.9.2.2)
+    rcov (1.0.0)
+    rdoc (3.12)
+      json (~> 1.4)
+    shoulda (3.0.1)
+      shoulda-context (~> 1.0.0)
+      shoulda-matchers (~> 1.0.0)
+    shoulda-context (1.0.0)
+    shoulda-matchers (1.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  ipaddr_extensions
+  jeweler (~> 1.6.4)
+  rcov
+  rdoc (>= 2.4.2)
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,15 @@
+Copyright (c) 2011 Davide Guerri <davide.guerri@gmail.com>
+
+This program is free software; you can redistribute it and/or
+modify it under the terms of the GNU General Public License
+as published by the Free Software Foundation; either version 3
+of the License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

data/RADIUS/default-radius.dict

@@ -0,0 +1,207 @@
+#
+#	This file contains dictionary translations for parsing
+#	requests and generating responses.  All transactions are
+#	composed of Attribute/Value Pairs.  The value of each attribute
+#	is specified as one of 4 data types.  Valid data types are:
+#
+#	string - 0-253 octets
+#	ipaddr - 4 octets in network byte order
+#	integer - 32 bit value in big endian order (high byte first)
+#	date - 32 bit value in big endian order - seconds since
+#					00:00:00 GMT,  Jan.  1,	 1970
+#
+#	Enumerated values are stored in the user file with dictionary
+#	VALUE translations for easy administration.
+#
+#	Example:
+#
+#	ATTRIBUTE	  VALUE
+#	---------------	  -----
+#	Framed-Protocol = PPP
+#	7		= 1	(integer encoding)
+#
+
+
+
+#
+# Proper names for everything - use this instead of the above
+#
+ATTRIBUTE	User-Name		1	string
+ATTRIBUTE	User-Password		2	string
+ATTRIBUTE	CHAP-Password		3	string
+ATTRIBUTE	NAS-IP-Address		4	ipaddr
+ATTRIBUTE	NAS-Port		5	integer
+ATTRIBUTE	Service-Type		6	integer
+ATTRIBUTE	Framed-Protocol		7	integer
+ATTRIBUTE	Framed-IP-Address	8	ipaddr
+ATTRIBUTE	Framed-IP-Netmask	9	ipaddr
+ATTRIBUTE	Framed-Routing		10	integer
+ATTRIBUTE	Filter-Id		11	string
+ATTRIBUTE	Framed-MTU		12	integer
+ATTRIBUTE	Framed-Compression	13	integer
+ATTRIBUTE	Login-IP-Host		14	ipaddr
+ATTRIBUTE	Login-Service		15	integer
+ATTRIBUTE	Login-TCP-Port		16	integer
+ATTRIBUTE	Reply-Message		18	string
+ATTRIBUTE	Callback-Number		19	string
+ATTRIBUTE	Callback-Id		20	string
+ATTRIBUTE	Expiration		21	date
+ATTRIBUTE	Framed-Route		22	string
+ATTRIBUTE	Framed-IPX-Network	23	ipaddr
+ATTRIBUTE	State			24	string
+ATTRIBUTE	Session-Timeout		27	integer
+ATTRIBUTE	Idle-Timeout		28	integer
+ATTRIBUTE	Termination-Action	29	integer
+ATTRIBUTE	Called-Station-Id	30	string
+ATTRIBUTE	Calling-Station-Id	31	string
+ATTRIBUTE	Acct-Status-Type	40	integer
+ATTRIBUTE	Acct-Delay-Time		41	integer
+ATTRIBUTE	Acct-Input-Octets	42	integer
+ATTRIBUTE	Acct-Output-Octets	43	integer
+ATTRIBUTE	Acct-Session-Id		44	string
+ATTRIBUTE	Acct-Authentic		45	integer
+ATTRIBUTE	Acct-Session-Time	46	integer
+ATTRIBUTE	Acct-Terminate-Cause	49	integer
+ATTRIBUTE	NAS-Port-Type		61	integer
+ATTRIBUTE	Port-Limit		62	integer
+
+
+#
+#	Integer Translations
+#
+
+#	User Types
+
+VALUE		Service-Type	Login-User		1
+VALUE		Service-Type	Framed-User		2
+VALUE		Service-Type	Callback-Login-User	3
+VALUE		Service-Type	Callback-Framed-User	4
+VALUE		Service-Type	Outbound-User		5
+VALUE		Service-Type	Administrative-User	6
+VALUE		Service-Type	NAS-Prompt-User		7
+
+#	Framed Protocols
+
+VALUE		Framed-Protocol		PPP			1
+VALUE		Framed-Protocol		SLIP			2
+
+#	Framed Routing Values
+
+VALUE		Framed-Routing		None			0
+VALUE		Framed-Routing		Broadcast		1
+VALUE		Framed-Routing		Listen			2
+VALUE		Framed-Routing		Broadcast-Listen	3
+
+#	Framed Compression Types
+
+VALUE		Framed-Compression	None			0
+VALUE		Framed-Compression	Van-Jacobson-TCP-IP	1
+
+#	Login Services
+
+VALUE		Login-Service		Telnet			0
+VALUE		Login-Service		Rlogin			1
+VALUE		Login-Service		TCP-Clear		2
+VALUE		Login-Service		PortMaster		3
+
+#	Status Types
+
+VALUE		Acct-Status-Type	Start			1
+VALUE		Acct-Status-Type	Stop			2
+
+#	Authentication Types
+
+VALUE		Acct-Authentic		RADIUS			1
+VALUE		Acct-Authentic		Local			2
+VALUE		Acct-Authentic		PowerLink128		100
+
+#	Termination Options
+
+VALUE		Termination-Action	Default			0
+VALUE		Termination-Action	RADIUS-Request		1
+
+#	NAS Port Types, available in ComOS 3.3.1 and later
+
+VALUE		NAS-Port-Type		Async			0
+VALUE		NAS-Port-Type		Sync			1
+VALUE		NAS-Port-Type		ISDN			2
+VALUE		NAS-Port-Type		ISDN-V120		3
+VALUE		NAS-Port-Type		ISDN-V110		4
+
+#	Acct Terminate Causes, available in ComOS 3.3.2 and later
+
+VALUE		Acct-Terminate-Cause	User-Request		1
+VALUE		Acct-Terminate-Cause	Lost-Carrier		2
+VALUE		Acct-Terminate-Cause	Lost-Service		3
+VALUE		Acct-Terminate-Cause	Idle-Timeout		4
+VALUE		Acct-Terminate-Cause	Session-Timeout		5
+VALUE		Acct-Terminate-Cause	Admin-Reset		6
+VALUE		Acct-Terminate-Cause	Admin-Reboot		7
+VALUE		Acct-Terminate-Cause	Port-Error		8
+VALUE		Acct-Terminate-Cause	NAS-Error		9
+VALUE		Acct-Terminate-Cause	NAS-Request		10
+VALUE		Acct-Terminate-Cause	NAS-Reboot		11
+VALUE		Acct-Terminate-Cause	Port-Unneeded		12
+VALUE		Acct-Terminate-Cause	Port-Preempted		13
+VALUE		Acct-Terminate-Cause	Port-Suspended		14
+VALUE		Acct-Terminate-Cause	Service-Unavailable	15
+VALUE		Acct-Terminate-Cause	Callback		16
+VALUE		Acct-Terminate-Cause	User-Error		17
+VALUE		Acct-Terminate-Cause	Host-Request		18
+
+
+#
+# Obsolete names for backwards compatibility with older users files
+# If you want RADIUS accounting logs to use the new names instead of
+# these, move this section to the beginning of the dictionary file
+# and kill and restart radiusd
+# If you don't have a RADIUS 1.16 users file that you're still using,
+# you can delete or ignore this section.
+#
+ATTRIBUTE	Client-Id		4	ipaddr
+ATTRIBUTE	Client-Port-Id		5	integer
+ATTRIBUTE	User-Service-Type	6	integer
+ATTRIBUTE	Framed-Address		8	ipaddr
+ATTRIBUTE	Framed-Netmask		9	ipaddr
+ATTRIBUTE	Framed-Filter-Id	11	string
+ATTRIBUTE	Login-Host		14	ipaddr
+ATTRIBUTE	Login-Port		16	integer
+ATTRIBUTE	Old-Password		17	string
+ATTRIBUTE	Port-Message		18	string
+ATTRIBUTE	Dialback-No		19	string
+ATTRIBUTE	Dialback-Name		20	string
+ATTRIBUTE	Challenge-State		24	string
+VALUE		Service-Type		Dialback-Login-User	3
+VALUE		Service-Type		Dialback-Framed-User	4
+VALUE		Service-Type		Shell-User		6
+VALUE		Framed-Compression	Van-Jacobsen-TCP-IP	1
+#VALUE		Auth-Type		Unix			1
+#
+# END of obsolete names for backwards compatibility
+#
+
+#
+#	Configuration Values
+#	uncomment out these two lines to turn account expiration on
+#
+
+#VALUE		Server-Config		Password-Expiration	30
+#VALUE		Server-Config		Password-Warning	5
+
+##
+## VENDOR SPECIFIC ATTRIBUTES
+##
+## The following entries demonstrate the use of VSAs
+##
+
+# cisco-avpair is used for various functions by cisco IOS. Most
+# notably, it's used to create VPDN tunnels.
+#
+VENDORATTR	9	cisco-avpair	1	string
+
+# This is a fake attribute to demonstrate how to write named-value
+# attributes.
+VENDORATTR	1	ibm-enum	254	integer
+VENDORVALUE	1	ibm-enum	value-1	1
+VENDORVALUE	1	ibm-enum	value-2	2
+VENDORVALUE	1	ibm-enum	value-3	3

data/README.rdoc

@@ -0,0 +1,74 @@
+= RadiusRB
+
+A ruby RADIUS client library that supports:
+
+* Authentication
+* Accounting
+* Custom dictionaries
+* Vendor Specific Attributes (Thanks to James Harton aka jamesotron)
+
+RadiusRB is derived from from PJ Davis's Radiustar library (https://github.com/pjdavis/radiustar).
+
+= Installation
+
+    # git clone git://github.com/dguerri/radiusrb.git
+    # cd radiusrb
+    # bundle install
+    # rake install
+
+= Usage
+
+  require 'rubygems'
+  require 'radiusrb'
+
+  # Load dictionaries from freeradius directory
+  dict = RadiusRB::Dictionary.new('/usr/share/freeradius/')
+
+  # Lets get authenticated
+  auth_custom_attr = {
+    'Framed-Address'  => '127.0.0.1',
+    'NAS-Port'        => 0,
+    'NAS-Port-Type'   => 'Ethernet'
+  }
+
+  req = RadiusRB::Request.new('127.0.0.1', { :dict => dict })
+  reply = req.authenticate('John Doe', 'hello', 'testing123', auth_custom_attr)
+
+  if reply[:code] == 'Access-Accept'
+    req = RadiusRB::Request.new('127.0.0.1:1813', { :dict => dict })
+
+    acct_custom_attr = {
+      'Framed-Address'  => '127.0.0.1',
+      'NAS-Port'        => 0,
+      'NAS-Port-Type'   => 'Ethernet',
+      'Acct-Session-Time' => 0
+    }
+
+    timings = Time.now
+    reply = req.accounting_start('John Doe', 'testing123', '123456', acct_custom_attr)
+
+    sleep(rand 5)
+    acct_custom_attr['Acct-Session-Time'] = Time.now - timings
+    reply = req.accounting_update('John Doe', 'testing123', '123456', acct_custom_attr)
+
+    sleep(rand 5)
+    acct_custom_attr['Acct-Session-Time'] = Time.now - timings
+    reply = req.accounting_stop('John Doe', 'testing123', '123456', acct_custom_attr)
+
+  end
+
+== Contributing to RadiusRB
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Davide Guerri <davide.guerri@gmail.com>.
+See LICENSE.txt for further details.
+

data/Rakefile

@@ -0,0 +1,55 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+require './lib/radiusrb/version.rb'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "radiusrb"
+  gem.homepage = "http://github.com/dguerri/radiusrb"
+  gem.license = "GPLv3"
+  gem.summary = %Q{RadiusRB, a ruby RADIUS client library}
+  gem.description = %Q{RadiusRB, a ruby RADIUS client library that supports: Authentication, Accounting, Custom dictionaries and Vendor Specific Attributes.}
+  gem.email = "davide.guerri@gmail.com"
+  gem.authors = ["Davide Guerri"]
+  gem.version = RadiusRB::Version::STRING
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rdoc/task'
+RDoc::Task.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "netflowfu #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/radiusrb/dictionary/attributes.rb

@@ -0,0 +1,77 @@
+module RadiusRB
+
+  class AttributesCollection < Array
+
+    attr_accessor :vendor
+
+    def initialize vendor=nil
+      @collection = {}
+      @revcollection = {}
+      @vendor = vendor if vendor
+    end
+
+    def add(name, id, type)
+      if vendor?
+        @collection[name] ||= Attribute.new(name, id.to_i, type, @vendor)
+      else
+        @collection[name] ||= Attribute.new(name, id.to_i, type)
+      end
+      @revcollection[id.to_i] ||= @collection[name]
+      self << @collection[name]
+    end
+
+    def find_by_name(name)
+      @collection[name]
+    end
+
+    def find_by_id(id)
+      @revcollection[id]
+    end
+
+    def vendor?
+      !!@vendor
+    end
+
+  end
+
+  class Attribute
+
+    include RadiusRB
+
+    attr_reader :name, :id, :type, :vendor
+
+    def initialize(name, id, type, vendor=nil)
+      @values = ValuesCollection.new
+      @name = name
+      @id = id.to_i
+      @type = type
+      @vendor = vendor if vendor
+    end
+
+    def add_value(name, id)
+      @values.add(name, id.to_i)
+    end
+
+    def find_values_by_name(name)
+      @values.find_by_name(name)
+    end
+
+    def find_values_by_id(id)
+      @values.find_by_id(id.to_i)
+    end
+
+    def has_values?
+      !@values.empty?
+    end
+
+    def values
+      @values
+    end
+
+    def vendor?
+      !!@vendor
+    end
+
+  end
+
+end

data/lib/radiusrb/dictionary/values.rb

@@ -0,0 +1,43 @@
+module RadiusRB
+
+  class ValuesCollection < Array
+
+    def initialize
+      @collection = {}
+      @revcollection = {}
+    end
+
+    def add(name, id)
+      @collection[name] ||= Value.new(name, id)
+      @revcollection[id.to_i] ||= @collection[name]
+      self << @collection[name]
+    end
+
+    def find_by_name(name)
+      @collection[name]
+    end
+
+    def find_by_id(id)
+      @revcollection[id]
+    end
+
+    def empty?
+      @collection.empty?
+    end
+
+  end
+
+  class Value
+
+    include RadiusRB
+
+    attr_accessor :name, :id
+
+    def initialize(name, id)
+      @name = name
+      @id = id.to_i
+    end
+
+  end
+
+end

data/lib/radiusrb/dictionary.rb

@@ -0,0 +1,157 @@
+# This file is part of the RadiusRB library for Ruby.
+# Copyright (C) 2011 Davide Guerri <davide.guerri@gmail.com>
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 3
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+
+module RadiusRB
+
+  class Dictionary
+
+    include RadiusRB
+
+    DEFAULT_DICTIONARIES_PATH = ::File.join(::File.dirname(__FILE__), '..', '..', 'templates')
+
+    def initialize(initial_path = nil)
+      @attributes = AttributesCollection.new
+      @vendors = VendorCollection.new
+
+      read_files initial_path if initial_path
+    end
+
+    def read_files(path)
+      dict_files = File.join(path, "*")
+      Dir.glob(dict_files) { |file|
+        read_attributes(file)
+      }
+      Dir.glob(dict_files) { |file|
+        read_values(file)
+      }
+    end
+    
+    def find_attribute_by_name(name)
+      @attributes.find_by_name(name)
+    end
+
+    def find_attribute_by_id(id)
+      @attributes.find_by_id(id)
+    end
+
+    def attribute_name_defined?(name)
+      !@attributes.find_by_name(name).nil?
+    end
+
+    def attribute_id_defined?(id)
+      !@attributes.find_by_id(id).nil?
+    end
+
+    def vendors
+      @vendors
+    end
+
+    def attributes
+      @attributes
+    end
+
+    def name
+      "Dictionary"
+    end
+
+    class << self
+
+      def default
+        new DEFAULT_DICTIONARIES_PATH
+      end
+
+    end
+
+    protected
+    
+    def read_attributes(path)
+      file = File.open(path) do |f|
+        current_vendor = nil
+        f.each_line do |line|
+          next if line =~ /^\#/	# discard comments
+          split_line = line.split(/\s+/)
+          next if split_line == []
+          case split_line.first.upcase
+          when "ATTRIBUTE"
+            current_vendor.nil? ? set_attr(split_line) : set_vendor_attr(current_vendor, split_line)
+          when "VENDOR"
+            add_vendor(split_line)
+          when "BEGIN-VENDOR"
+            current_vendor = set_vendor(split_line)
+          when "END-VENDOR"
+            current_vendor = nil
+          end
+        end
+      end
+    end
+
+    def read_values(path)
+      file = File.open(path) do |f|
+        current_vendor = nil
+        f.each_line do |line|
+          next if line =~ /^\#/	# discard comments
+          split_line = line.split(/\s+/)
+          next if split_line == []
+          case split_line.first.upcase
+          when "VALUE"
+            if current_vendor.nil?
+              set_value(split_line)
+            else
+              begin
+                set_vendor_value(current_vendor, split_line)
+              rescue
+                set_value(split_line)
+              end
+            end
+          when "BEGIN-VENDOR"
+            current_vendor = set_vendor(split_line)
+          when "END-VENDOR"
+            current_vendor = nil
+          end
+        end
+      end
+    end
+
+    private
+
+    def set_attr(line)
+      @attributes.add(line[1], line[2], line[3])
+    end
+
+    def set_value(line)
+      @attributes.find_by_name(line[1]).add_value(line[2], line[3])
+    end
+
+    def add_vendor(line)
+      @vendors.add(line[2], line[1])
+    end
+
+    def set_vendor(line)
+      @vendors.find_by_name(line[1])
+    end
+
+    def set_vendor_attr(vendor, line)
+      vendor.add_attribute(line[1], line[2], line[3])
+    end
+
+    def set_vendor_value(vendor, line)
+      vendor.find_attribute_by_name(line[1]).add_value(line[2], line[3])
+    end
+
+  end
+
+end