tickets.rb

require 'rubycas-server-core/util'

module RubyCAS
  module Server
    module Core
      module Tickets

        # One time login ticket for given client
        def self.generate_login_ticket(client)
          lt = LoginTicket.new
          lt.ticket = "LT-" + Util.random_string
          lt.client_hostname = client
          if lt.save!
            $LOG.debug("Login ticket '#{lt.ticket} has been created for '#{lt.client_hostname}'")
            return lt
          else
            return nil
          end
        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 self.generate_ticket_granting_ticket(
          username,
          client,
          remember_me = false,
          extra_attributes = {}
        )
          tgt = TicketGrantingTicket.new
          tgt.ticket = "TGC-" + Util.random_string
          tgt.username = username
          tgt.remember_me = remember_me
          tgt.extra_attributes = extra_attributes.to_s
          tgt.client_hostname = client
          if tgt.save!
            $LOG.debug("Generated ticket granting ticket '#{tgt.ticket}' for user" +
              " '#{tgt.username}' at '#{tgt.client_hostname}'" +
              (extra_attributes.empty? ? "" : " with extra attributes #{extra_attributes.inspect}"))
            return tgt
          else
            return nil
          end
        end

        def self.generate_service_ticket(service, username, tgt, client)
          st = tgt.service_tickets.new
          st.ticket = "ST-" + Util.random_string
          st.service = service
          st.username = username
          st.ticket_granting_ticket = tgt
          st.client_hostname = client
          if st.save
            $LOG.debug("Generated service ticket '#{st.ticket}' for service '#{st.service}'" +
              " for user '#{st.username}' at '#{st.client_hostname}'")
            return st
          else
            return nil
          end
        end

        def self.generate_proxy_ticket(target_service, pgt, client)
          raise NotImplementedError
        end

        def self.generate_proxy_granting_ticket(pgt_url, st, client)
          raise NotImplementedError
        end
      end
    end
  end
end