apache_authtkt 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 30514640ce14fbe685c0c66f4516d21f7e448e39
+  data.tar.gz: 943fbebbb53196bed4472d76c929d86ba3cd0619
+SHA512:
+  metadata.gz: 4688616bc933b0732e9be7c0067994a85d0d855ad691641db49ffcefb19cb4bc8c7c3e367104af4c5a330b9217b1b0232755890c2df178a82879b1dfb2f8210d
+  data.tar.gz: 1858437c036dfbb33be18c09ac37f6b7c0876f3fdaaebc2dcdb08d4de270b2bcc0d44676c3a23e169531b3abdfb644a91477a603586c1aa7cbe0c8e066efa497

data/lib/apache_authtkt.rb

@@ -0,0 +1,205 @@
+# ApacheAuthTkt is a Ruby client
+# for mod_auth_tkt (http://www.openfusion.com.au/labs/mod_auth_tkt/)
+#
+# Copyright 2014 American Public Media Group
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# dependencies
+require 'rubygems'
+require 'base64'
+require 'digest'
+
+class ApacheAuthTkt
+
+   attr_accessor :secret
+   attr_accessor :ipaddr
+   attr_accessor :digest_type
+   attr_accessor :conf_file
+   attr_accessor :error
+   attr_accessor :base64encode
+   attr_accessor :lifetime
+
+   def initialize(args)
+
+      #puts args.inspect
+
+      # set defaults
+      if (args.has_key? :ipaddr)
+         @ipaddr = args[:ipaddr]
+      else
+         @ipaddr = '0.0.0.0'
+      end
+
+      if (args.has_key? :secret)
+         @secret = args[:secret]
+      elsif (args.has_key? :conf_file)
+         @secret = _get_secret(args[:conf_file])
+         if (!@secret.length)
+            raise "Can't parse secret from " + args[:conf_file]
+         end
+      else
+         raise "Must pass 'secret' or 'conf_file'"
+      end
+
+      if (args[:digest_type])
+         @digest_type = args[:digest_type]
+      else
+         @digest_type = 'md5'
+      end
+
+      if (args.has_key? :base64encode)
+         @base64encode = args[:base64encode]
+      else
+         @base64encode = true
+      end
+
+      if (args.has_key? :lifetime)
+         @lifetime = args[:lifetime]
+      else
+         # 8 hours.
+         @lifetime = 28800
+      end
+
+   end
+
+   def _get_secret(filename)
+      # based on http://meso.net/mod_auth_tkt
+      if (!File.file? filename)
+         raise "#{filename} is not a file"
+      end
+      secret_str = ''
+      open(filename) do |file|
+         file.each do |line|
+            if line.include? 'TKTAuthSecret'
+               secret_str = line.gsub('TKTAuthSecret', '').strip.gsub("\"", '').gsub("'",'')
+               break
+            end
+         end
+      end
+      return secret_str
+   end
+
+   # from http://meso.net/mod_auth_tkt
+   # function adapted according to php: generates an IPv4 Internet network address
+   # from its Internet standard format (dotted string) representation.
+   def ip2long(ip)
+      long = 0
+      ip.split( /\./ ).reverse.each_with_index do |x, i|
+         long += x.to_i << ( i * 8 )
+      end
+      long
+   end
+
+   # based on http://meso.net/mod_auth_tkt
+   def create_ticket(user_opts={})
+      options = {
+         :user       => 'guest',
+         :tokens     => '',
+         :user_data  => '',
+         :ignore_ip  => false,
+         :ts         => Time.now.to_i
+      }.merge(user_opts)
+
+      timestamp  = options[:ts]
+      ip_address = options[:ignore_ip] ? '0.0.0.0' : @ipaddr
+      digest = get_digest(timestamp, ip_address, options[:user], options[:tokens], options[:user_data])
+      tkt = sprintf("%s%08x%s!%s!%s", digest, timestamp, options[:user], options[:tokens], options[:user_data])
+
+      if (@base64encode)
+         tkt = Base64.encode64(tkt).gsub("\n", '').strip
+      end
+
+      return tkt
+
+   end
+
+   def get_digest(ts, ipaddr, user, tokens, data)
+      ipts = [ip2long(ipaddr), ts].pack("NN")
+      digest0 = nil
+      digest  = nil
+      raw     = ipts + @secret + user + "\0" + tokens + "\0" + data
+      if (@digest_type == 'md5')
+         digest0 = Digest::MD5.hexdigest(raw)
+         digest  = Digest::MD5.hexdigest(digest0 + @secret)
+      elsif (@digest_type == 'sha256')
+         digest0 = Digest::SHA256.hexdigest(raw)
+         digest  = Digest::SHA256.hexdigest(digest0 + @secret)
+      else
+         raise "unsupported digest type: " + @digest_type
+      end
+      return digest
+   end
+
+   def validate_ticket(tkt, ipaddr='0.0.0.0')
+      parsed = parse_ticket(tkt)
+      if (!parsed)
+         return false
+      end
+      expected_digest = get_digest(parsed[:ts], ipaddr, parsed[:user], parsed[:tokens], parsed[:data])
+      if (expected_digest == parsed[:digest])
+         return parsed
+      else
+         return false
+      end
+   end
+
+   def parse_ticket(tkt)
+      # strip possible lead/trail quotes
+      tkt = tkt.gsub(/^"|"$/,'')
+
+      # test if base64 encoded before decoding
+      if (@base64encode && tkt.length % 4 == 0 && tkt =~ /^[A-Za-z0-9+\/=]+\Z/)
+         tkt = Base64.decode64(tkt)
+      end
+
+      # sanity checks
+      if (tkt.length < 40)
+         @error = "ticket string too short"
+         return false
+      end
+      if (!tkt.index('!'))
+         @error = "ticket missing !"
+         return false
+      end
+
+      # parse it
+      parts = tkt.split(/\!/)
+      parsed = {:tokens => '', :data => ''}
+      if (packed = parts[0].match('^(.{32})(.{8})(.+)$'))
+         parsed[:digest] = packed[1]
+         parsed[:ts]     = packed[2].hex
+         parsed[:user]    = packed[3]
+         if (parts.length == 3)
+            parsed[:tokens] = parts[1]
+            parsed[:data]   = parts[2]
+         elsif (parts.length == 2)
+            parsed[:tokens] = parts[1]
+         end
+      else
+         @error = "invalid ticket pattern"
+         return false
+      end
+      return parsed
+   end
+
+   def expired?(tkt)
+      return false if @lifetime.nil?
+      parsed = self.parse_ticket(tkt)
+      if (!parsed)
+         return false
+      end
+      !(parsed[:ts] + @lifetime >= Time.now.to_i)
+   end
+
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: apache_authtkt
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- William Johnston
+- Peter Karman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-29 00:00:00.000000000 Z
+dependencies:
+- !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: rspec
+  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'
+description: Ruby client for mod_auth_tkt. See http://www.openfusion.com.au/labs/mod_auth_tkt/
+email: wjohnston@mpr.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/apache_authtkt.rb
+homepage: https://github.com/APMG/apache-authtkt-ruby
+licenses:
+- Apache v2
+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: nowarning
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Ruby client for mod_auth_tkt
+test_files: []
+has_rdoc: