uchouhan-rubycas-server 1.0.a

data/lib/casserver/authenticators/tacc.rb

@@ -0,0 +1,67 @@
+require 'casserver/authenticators/base'
+require 'activeresource'
+  
+require 'openssl'
+require 'digest/sha2'
+require 'base64'
+
+module TaccEncryption
+
+  KEY = Digest::SHA256.hexdigest('T4CcUs3R-C3|\|TR41A|_|Th')
+
+  def self.encrypt(text)
+    Base64.encode64(aes(:encrypt, KEY, text))
+  end
+
+  def self.decrypt(crypted_text)
+    aes(:decrypt, KEY, Base64.decode64(crypted_text))
+  end
+
+  private
+
+    def self.aes(m,k,t)
+      (aes = OpenSSL::Cipher::Cipher.new('aes-256-cbc').send(m)).key = Digest::SHA256.digest(k)
+      aes.update(t) << aes.final
+    end
+
+end
+
+class TaccUser < ActiveResource::Base
+  self.collection_name = 'users'
+  self.timeout = 5
+  
+  def self.find_by_email(email)
+    if u = self.find(:all, :params => { :email => email }).first
+      return self.find(u.id)
+    else
+      return nil
+    end
+  end
+  
+  def authenticate(password)
+    begin
+      return true if self.put(:authenticate, :password => TaccEncryption.encrypt(password))
+    rescue
+      return false
+    end
+  end
+  
+end
+
+class CASServer::Authenticators::Tacc < CASServer::Authenticators::Base
+
+  def validate(credentials)
+    raise CASServer::AuthenticatorError, "Cannot validate credentials because the authenticator hasn't been configured" unless @options
+    
+    TaccUser.site = @options[:site]
+    
+    read_standard_credentials(credentials) # Sets @username and @password
+    
+    @user = TaccUser.find_by_email(@username)
+    raise CASServer::AuthenticatorError, "User not found" if @user.nil?
+    
+    return @user.authenticate(@password)
+    
+  end
+end
+

data/lib/casserver/authenticators/test.rb

@@ -0,0 +1,21 @@
+require 'casserver/authenticators/base'
+
+# Dummy authenticator used for testing.
+# Accepts any username as valid as long as the password is "testpassword"; otherwise authentication fails.
+# Raises an AuthenticationError when username is "do_error" (this is useful to test the Exception
+# handling functionality).
+class CASServer::Authenticators::Test < CASServer::Authenticators::Base
+  def validate(credentials)
+    read_standard_credentials(credentials)
+
+    raise CASServer::AuthenticatorError, "Username is 'do_error'!" if @username == 'do_error'
+
+    @extra_attributes[:test_string] = "testing!"
+    @extra_attributes[:test_numeric] = 123.45
+    @extra_attributes[:test_serialized] = {:foo => 'bar', :alpha => [1,2,3]}
+
+    valid_password = options[:password] || "testpassword"
+
+    return @password == valid_password
+  end
+end

data/lib/casserver/cas.rb

@@ -0,0 +1,327 @@
+require 'uri'
+require 'net/https'
+
+require 'casserver/model'
+
+# Encapsulates CAS functionality. This module is meant to be included in
+# the CASServer::Controllers module.
+module CASServer::CAS
+
+  include CASServer::Model
+
+  def generate_login_ticket
+    # 3.5 (login ticket)
+    lt = LoginTicket.new
+    lt.ticket = "LT-" + CASServer::Utils.random_string
+
+    lt.client_hostname = @env['HTTP_X_FORWARDED_FOR'] || @env['REMOTE_HOST'] || @env['REMOTE_ADDR']
+    lt.save!
+    $LOG.debug("Generated login ticket '#{lt.ticket}' for client" +
+      " at '#{lt.client_hostname}'")
+    lt
+  end
+
+  # Creates a TicketGrantingTicket for the given username. This is done when the user logs in
+  # for the first time to establish their SSO session (after their credentials have been validated).
+  #
+  # The optional 'extra_attributes' parameter takes a hash of additional attributes
+  # that will be sent along with the username in the CAS response to subsequent
+  # validation requests from clients.
+  def generate_ticket_granting_ticket(username, extra_attributes = {})
+    # 3.6 (ticket granting cookie/ticket)
+    tgt = TicketGrantingTicket.new
+    tgt.ticket = "TGC-" + CASServer::Utils.random_string
+    tgt.username = username
+    tgt.extra_attributes = extra_attributes
+    tgt.client_hostname = @env['HTTP_X_FORWARDED_FOR'] || @env['REMOTE_HOST'] || @env['REMOTE_ADDR']
+    tgt.save!
+    $LOG.debug("Generated ticket granting ticket '#{tgt.ticket}' for user" +
+      " '#{tgt.username}' at '#{tgt.client_hostname}'" +
+      (extra_attributes.blank? ? "" : " with extra attributes #{extra_attributes.inspect}"))
+    tgt
+  end
+
+  def generate_service_ticket(service, username, tgt)
+    # 3.1 (service ticket)
+    st = ServiceTicket.new
+    st.ticket = "ST-" + CASServer::Utils.random_string
+    st.service = service
+    st.username = username
+    st.granted_by_tgt_id = tgt.id
+    st.client_hostname = @env['HTTP_X_FORWARDED_FOR'] || @env['REMOTE_HOST'] || @env['REMOTE_ADDR']
+    st.save!
+    $LOG.debug("Generated service ticket '#{st.ticket}' for service '#{st.service}'" +
+      " for user '#{st.username}' at '#{st.client_hostname}'")
+    st
+  end
+
+  def generate_proxy_ticket(target_service, pgt)
+    # 3.2 (proxy ticket)
+    pt = ProxyTicket.new
+    pt.ticket = "PT-" + CASServer::Utils.random_string
+    pt.service = target_service
+    pt.username = pgt.service_ticket.username
+    pt.granted_by_pgt_id = pgt.id
+    pt.granted_by_tgt_id = pgt.service_ticket.granted_by_tgt.id
+    pt.client_hostname = @env['HTTP_X_FORWARDED_FOR'] || @env['REMOTE_HOST'] || @env['REMOTE_ADDR']
+    pt.save!
+    $LOG.debug("Generated proxy ticket '#{pt.ticket}' for target service '#{pt.service}'" +
+      " for user '#{pt.username}' at '#{pt.client_hostname}' using proxy-granting" +
+      " ticket '#{pgt.ticket}'")
+    pt
+  end
+
+  def generate_proxy_granting_ticket(pgt_url, st)
+    uri = URI.parse(pgt_url)
+    https = Net::HTTP.new(uri.host,uri.port)
+    https.use_ssl = true
+
+    # Here's what's going on here:
+    #
+    #   1. We generate a ProxyGrantingTicket (but don't store it in the database just yet)
+    #   2. Deposit the PGT and it's associated IOU at the proxy callback URL.
+    #   3. If the proxy callback URL responds with HTTP code 200, store the PGT and return it;
+    #      otherwise don't save it and return nothing.
+    #
+    https.start do |conn|
+      path = uri.path.empty? ? '/' : uri.path
+      path += '?' + uri.query unless (uri.query.nil? || uri.query.empty?)
+      
+      pgt = ProxyGrantingTicket.new
+      pgt.ticket = "PGT-" + CASServer::Utils.random_string(60)
+      pgt.iou = "PGTIOU-" + CASServer::Utils.random_string(57)
+      pgt.service_ticket_id = st.id
+      pgt.client_hostname = @env['HTTP_X_FORWARDED_FOR'] || @env['REMOTE_HOST'] || @env['REMOTE_ADDR']
+
+      # FIXME: The CAS protocol spec says to use 'pgt' as the parameter, but in practice
+      #         the JA-SIG and Yale server implementations use pgtId. We'll go with the
+      #         in-practice standard.
+      path += (uri.query.nil? || uri.query.empty? ? '?' : '&') + "pgtId=#{pgt.ticket}&pgtIou=#{pgt.iou}"
+
+      response = conn.request_get(path)
+      # TODO: follow redirects... 2.5.4 says that redirects MAY be followed
+      # NOTE: The following response codes are valid according to the JA-SIG implementation even without following redirects
+      
+      if %w(200 202 301 302 304).include?(response.code)
+        # 3.4 (proxy-granting ticket IOU)
+        pgt.save!
+        $LOG.debug "PGT generated for pgt_url '#{pgt_url}': #{pgt.inspect}"
+        pgt
+      else
+        $LOG.warn "PGT callback server responded with a bad result code '#{response.code}'. PGT will not be stored."
+        nil
+      end
+    end
+  end
+
+  def validate_login_ticket(ticket)
+    $LOG.debug("Validating login ticket '#{ticket}'")
+
+    success = false
+    if ticket.nil?
+      error = _("Your login request did not include a login ticket. There may be a problem with the authentication system.")
+      $LOG.warn "Missing login ticket."
+    elsif lt = LoginTicket.find_by_ticket(ticket)
+      if lt.consumed?
+        error = _("The login ticket you provided has already been used up. Please try logging in again.")
+        $LOG.warn "Login ticket '#{ticket}' previously used up"
+      elsif Time.now - lt.created_on < settings.config[:maximum_unused_login_ticket_lifetime]
+        $LOG.info "Login ticket '#{ticket}' successfully validated"
+      else
+        error = _("You took too long to enter your credentials. Please try again.")
+        $LOG.warn "Expired login ticket '#{ticket}'"
+      end
+    else
+      error = _("The login ticket you provided is invalid. There may be a problem with the authentication system.")
+      $LOG.warn "Invalid login ticket '#{ticket}'"
+    end
+
+    lt.consume! if lt
+
+    error
+  end
+
+  def validate_ticket_granting_ticket(ticket)
+    $LOG.debug("Validating ticket granting ticket '#{ticket}'")
+
+    if ticket.nil?
+      error = "No ticket granting ticket given."
+      $LOG.debug error
+    elsif tgt = TicketGrantingTicket.find_by_ticket(ticket)
+      if settings.config[:expire_sessions] && Time.now - tgt.created_on > settings.config[:ticket_granting_ticket_expiry]
+        error = "Your session has expired. Please log in again."
+        $LOG.info "Ticket granting ticket '#{ticket}' for user '#{tgt.username}' expired."
+      else
+        $LOG.info "Ticket granting ticket '#{ticket}' for user '#{tgt.username}' successfully validated."
+      end
+    else
+      error = "Invalid ticket granting ticket '#{ticket}' (no matching ticket found in the database)."
+      $LOG.warn(error)
+    end
+
+    [tgt, error]
+  end
+
+  def validate_service_ticket(service, ticket, allow_proxy_tickets = false)
+    $LOG.debug "Validating service/proxy ticket '#{ticket}' for service '#{service}'"
+
+    if service.nil? or ticket.nil?
+      error = Error.new(:INVALID_REQUEST, "Ticket or service parameter was missing in the request.")
+      $LOG.warn "#{error.code} - #{error.message}"
+    elsif st = ServiceTicket.find_by_ticket(ticket)
+      if st.consumed?
+        error = Error.new(:INVALID_TICKET, "Ticket '#{ticket}' has already been used up.")
+        $LOG.warn "#{error.code} - #{error.message}"
+      elsif st.kind_of?(CASServer::Model::ProxyTicket) && !allow_proxy_tickets
+        error = Error.new(:INVALID_TICKET, "Ticket '#{ticket}' is a proxy ticket, but only service tickets are allowed here.")
+        $LOG.warn "#{error.code} - #{error.message}"
+      elsif Time.now - st.created_on > settings.config[:maximum_unused_service_ticket_lifetime]
+        error = Error.new(:INVALID_TICKET, "Ticket '#{ticket}' has expired.")
+        $LOG.warn "Ticket '#{ticket}' has expired."
+      elsif !st.matches_service? service
+        error = Error.new(:INVALID_SERVICE, "The ticket '#{ticket}' belonging to user '#{st.username}' is valid,"+
+          " but the requested service '#{service}' does not match the service '#{st.service}' associated with this ticket.")
+        $LOG.warn "#{error.code} - #{error.message}"
+      else
+        $LOG.info("Ticket '#{ticket}' for service '#{service}' for user '#{st.username}' successfully validated.")
+      end
+    else
+      error = Error.new(:INVALID_TICKET, "Ticket '#{ticket}' not recognized.")
+      $LOG.warn("#{error.code} - #{error.message}")
+    end
+
+    if st
+      st.consume!
+    end
+
+
+    [st, error]
+  end
+
+  def validate_proxy_ticket(service, ticket)
+    pt, error = validate_service_ticket(service, ticket, true)
+
+    if pt.kind_of?(CASServer::Model::ProxyTicket) && !error
+      if not pt.granted_by_pgt
+        error = Error.new(:INTERNAL_ERROR, "Proxy ticket '#{pt}' belonging to user '#{pt.username}' is not associated with a proxy granting ticket.")
+      elsif not pt.granted_by_pgt.service_ticket
+        error = Error.new(:INTERNAL_ERROR, "Proxy granting ticket '#{pt.granted_by_pgt}'"+
+          " (associated with proxy ticket '#{pt}' and belonging to user '#{pt.username}' is not associated with a service ticket.")
+      end
+    end
+
+    [pt, error]
+  end
+
+  def validate_proxy_granting_ticket(ticket)
+    if ticket.nil?
+      error = Error.new(:INVALID_REQUEST, "pgt parameter was missing in the request.")
+      $LOG.warn("#{error.code} - #{error.message}")
+    elsif pgt = ProxyGrantingTicket.find_by_ticket(ticket)
+      if pgt.service_ticket
+        $LOG.info("Proxy granting ticket '#{ticket}' belonging to user '#{pgt.service_ticket.username}' successfully validated.")
+      else
+        error = Error.new(:INTERNAL_ERROR, "Proxy granting ticket '#{ticket}' is not associated with a service ticket.")
+        $LOG.error("#{error.code} - #{error.message}")
+      end
+    else
+      error = Error.new(:BAD_PGT, "Invalid proxy granting ticket '#{ticket}' (no matching ticket found in the database).")
+      $LOG.warn("#{error.code} - #{error.message}")
+    end
+
+    [pgt, error]
+  end
+
+  # Takes an existing ServiceTicket object (presumably pulled from the database)
+  # and sends a POST with logout information to the service that the ticket
+  # was generated for.
+  #
+  # This makes possible the "single sign-out" functionality added in CAS 3.1.
+  # See http://www.ja-sig.org/wiki/display/CASUM/Single+Sign+Out
+  def send_logout_notification_for_service_ticket(st)
+    uri = URI.parse(st.service)
+    http = Net::HTTP.new(uri.host, uri.port)
+    #http.use_ssl = true if uri.scheme = 'https'
+
+    time = Time.now
+    rand = CASServer::Utils.random_string
+
+    path = uri.path
+    path = '/' if path.empty?
+
+    req = Net::HTTP::Post.new(path)
+    req.set_form_data(
+      'logoutRequest' => %{<samlp:LogoutRequest ID="#{rand}" Version="2.0" IssueInstant="#{time.rfc2822}">
+<saml:NameID></saml:NameID>
+<samlp:SessionIndex>#{st.ticket}</samlp:SessionIndex>
+</samlp:LogoutRequest>}
+    )
+
+    begin
+      http.start do |conn|
+        response = conn.request(req)
+
+        if response.kind_of? Net::HTTPSuccess
+          $LOG.info "Logout notification successfully posted to #{st.service.inspect}."
+          return true
+        else
+          $LOG.error "Service #{st.service.inspect} responed to logout notification with code '#{response.code}'!"
+          return false
+        end
+      end
+    rescue Exception => e
+      $LOG.error "Failed to send logout notification to service #{st.service.inspect} due to #{e}"
+          return false
+    end
+  end
+
+  def service_uri_with_ticket(service, st)
+    raise ArgumentError, "Second argument must be a ServiceTicket!" unless st.kind_of? CASServer::Model::ServiceTicket
+
+    # This will choke with a URI::InvalidURIError if service URI is not properly URI-escaped...
+    # This exception is handled further upstream (i.e. in the controller).
+    service_uri = URI.parse(service)
+
+    if service.include? "?"
+      if service_uri.query.empty?
+        query_separator = ""
+      else
+        query_separator = "&"
+      end
+    else
+      query_separator = "?"
+    end
+
+    service_with_ticket = service + query_separator + "ticket=" + st.ticket
+    service_with_ticket
+  end
+
+  # Strips CAS-related parameters from a service URL and normalizes it,
+  # removing trailing / and ?. Also converts any spaces to +.
+  #
+  # For example, "http://google.com?ticket=12345" will be returned as
+  # "http://google.com". Also, "http://google.com/" would be returned as
+  # "http://google.com".
+  #
+  # Note that only the first occurance of each CAS-related parameter is
+  # removed, so that "http://google.com?ticket=12345&ticket=abcd" would be
+  # returned as "http://google.com?ticket=abcd".
+  def clean_service_url(dirty_service)
+    return dirty_service if dirty_service.blank?
+    clean_service = dirty_service.dup
+    ['service', 'ticket', 'gateway', 'renew'].each do |p|
+      clean_service.sub!(Regexp.new("&?#{p}=[^&]*"), '')
+    end
+
+    clean_service.gsub!(/[\/\?&]$/, '') # remove trailing ?, /, or &
+    clean_service.gsub!('?&', '?')
+    clean_service.gsub!(' ', '+')
+
+    $LOG.debug("Cleaned dirty service URL #{dirty_service.inspect} to #{clean_service.inspect}") if
+      dirty_service != clean_service
+
+    return clean_service
+  end
+  module_function :clean_service_url
+
+end

data/lib/casserver/localization.rb

@@ -0,0 +1,91 @@
+require "gettext"
+require "gettext/cgi"
+require 'active_support'
+
+module CASServer
+  module Localization
+    def self.included(mod)
+      mod.module_eval do
+        include GetText
+      end
+    end
+
+    include GetText
+    bindtextdomain("rubycas-server", :path => File.join(File.dirname(File.expand_path(__FILE__)), "../../locale"))
+
+    def determine_locale(request)
+      source = nil
+      lang = case
+      when !request.params['lang'].blank?
+        source = "'lang' request variable"
+        request.cookies['lang'] = request.params['lang']
+        request.params['lang']
+      when !request.cookies['lang'].blank?
+        source = "'lang' cookie"
+        request.cookies['lang']
+      when !request.env['HTTP_ACCEPT_LANGUAGE'].blank?
+        source = "'HTTP_ACCEPT_LANGUAGE' header"
+        lang = request.env['HTTP_ACCEPT_LANGUAGE']
+      when !request.env['HTTP_USER_AGENT'].blank? && request.env['HTTP_USER_AGENT'] =~ /[^a-z]([a-z]{2}(-[a-z]{2})?)[^a-z]/i
+        source = "'HTTP_USER_AGENT' header"
+        $~[1]
+#      when !$CONF['default_locale'].blank?
+#        source = "'default_locale' config option"
+#        $CONF[:default_locale]
+      else
+        source = "default"
+        "en"
+      end
+
+      $LOG.debug "Detected locale is #{lang.inspect} (from #{source})"
+
+      lang.gsub!('_','-')
+
+      # TODO: Need to confirm that this method of splitting the accepted
+      #       language string is correct.
+      if lang =~ /[,;\|]/
+        langs = lang.split(/[,;\|]/)
+      else
+        langs = [lang]
+      end
+
+      # TODO: This method of selecting the desired language might not be
+      #       standards-compliant. For example, http://www.w3.org/TR/ltli/
+      #       suggests that de-de and de-*-DE might be acceptable identifiers
+      #       for selecting various wildcards. The algorithm below does not
+      #       currently support anything like this.
+
+      available = available_locales
+
+      if available.length == 1
+        $LOG.warn "Only the #{available.first.inspect} localization is available. You should run `rake localization:mo` to compile support for additional languages!"
+      elsif available.length == 0 # this should never actually happen
+        $LOG.error "No localizations available! Run `rake localization:mo` to compile support for additional languages."
+      end
+
+      # Try to pick a locale exactly matching the desired identifier, otherwise
+      # fall back to locale without region (i.e. given "en-US; de-DE", we would
+      # first look for "en-US", then "en", then "de-DE", then "de").
+
+      chosen_lang = nil
+      langs.each do |l|
+        a = available.find{ |a| a =~ Regexp.new("\\A#{l}\\Z", 'i') ||
+                                a =~ Regexp.new("#{l}-\w*",   'i')    }
+        if a
+          chosen_lang = a
+          break
+        end
+      end
+
+      chosen_lang = "en" if chosen_lang.blank?
+
+      $LOG.debug "Chosen locale is #{chosen_lang.inspect}"
+
+      return chosen_lang
+    end
+
+    def available_locales
+      (Dir.glob(File.join(File.dirname(File.expand_path(__FILE__)), "../../locale/[a-z]*")).map{|path| File.basename(path)} << "en").uniq.collect{|l| l.gsub('_','-')}
+    end
+  end
+end