synapse-rubycas-server 1.1.4 → 1.1.5.pre

data/config/recipes/templates/nginx.erb

@@ -0,0 +1,43 @@
+upstream <%= application %> {
+  server unix:<%= shared_path %>/sockets/<%= application %>-puma.sock fail_timeout=0;
+}
+
+server {
+  listen 80;
+  server_name <%= server_name %>;
+  rewrite ^ https://$server_name$request_uri? permanent;
+}
+
+server {
+  listen 443;
+  server_name <%= server_name %>;
+  root <%= current_path %>/public;
+
+  ssl on;
+  ssl_certificate /etc/ssl/cert_wildcard.crt;
+  ssl_certificate_key /etc/ssl/key_wildcard.key;
+
+  if (-f $document_root/maintenance.html) {
+    rewrite  ^(.*)$  /maintenance.html last;
+    break;
+  }
+
+  location / {
+    try_files $uri $uri/index.html $uri @<%= application %>;
+  }
+
+
+  location @<%= application %> {
+    proxy_redirect off;
+    proxy_set_header      X-FORWARDED_PROTO https;
+    proxy_set_header      Host              $http_host;
+    proxy_set_header      X-Real-IP         $remote_addr;
+    proxy_read_timeout    300;
+    proxy_connect_timeout 300;
+    proxy_pass http://<%= application %>;
+  }
+
+  error_page 500 502 503 504 /500.html;
+  client_max_body_size 4G;
+  keepalive_timeout 10;
+}

data/config/recipes/templates/puma.erb

@@ -0,0 +1,13 @@
+environment '<%= stage %>' || 'development'
+
+threads 3,3
+
+bind  "unix:///<%= puma_sock %>"
+pidfile "<%= puma_pid %>"
+state_path "<%= puma_state %>"
+
+daemonize true
+
+stdout_redirect '<%= shared_path %>/log/puma.stdout.log', '<%= shared_path %>/log/puma.stderror.log', true
+
+activate_control_app "unix:///<%= puma_ctl_sock %>"

data/config/recipes/templates/rubycas.erb

@@ -0,0 +1,114 @@
+# MANAGED BY CAPISTRANO
+
+
+##### DATABASE #################################################################
+
+database:
+  adapter: mysql2
+  database: casserver_dev
+  username: casserver_user
+  password: DaDLw7a7oXZVWz
+  host: core-internal.cg3ywao0k1nv.us-west-2.rds.amazonaws.com
+  reconnect: true
+
+#disable_auto_migrations: true
+
+##### AUTHENTICATION ###########################################################
+
+authenticator:
+ class: CASServer::Authenticators::ActiveDirectoryLDAP
+ ldap:
+   host: core-dc-1.synapsedev.com
+   port: 389
+   base: OU=SBSUsers,OU=Users,OU=MyBusiness,DC=synapsedev,DC=com
+   filter: (&(objectCategory=person)(objectClass=user))
+   auth_user: SYNAPSEDEV\~svcProvisioningConf
+   auth_password: IZE6CgJhIZZYbKfyW4Po
+ extra_attributes: name, mail, memberOf, synapseRecursiveGroups, synapseExtendedAttributes, givenname, sn, pinNumber, department, company, l, synapseAccessCardNumber
+
+theme: simple
+
+organization: Synapse
+
+infoline: Powered by <a href="http://code.google.com/p/rubycas-server/">RubyCAS-Server</a>
+
+# Custom views directory. If set, this will be used instead of 'lib/casserver/views'.
+custom_views: <%= deploy_to %>/current/lib/casserver/views
+
+# Custom public directory. If set, static content (css, etc.) will be served from here rather
+# than from rubycas-server's internal 'public' directory (but be mindful of any overriding
+# settings you may have in your web server's config).
+public_dir: <%= deploy_to %>/current/public
+
+default_locale: en
+
+##### LOGGING ##################################################################
+
+log:
+  file: <%= shared_path %>/log/casserver.log
+  level: DEBUG
+
+
+# If you want full database logging, uncomment this next section.
+# Every SQL query will be logged here. This is useful for debugging database
+# problems.
+
+#db_log:
+#  file: /var/log/casserver_db.log
+
+
+# Setting the following option to true will disable CLI output to stdout.
+# i.e. this will get rid of messages like ">>> Redirecting RubyCAS-Server log..."
+# This is useful when, for example, you're running rspecs.
+
+#quiet: true
+
+
+##### SINGLE SIGN-OUT ##########################################################
+
+# When a user logs in to a CAS-enabled client application, that application
+# generally opens its own local user session. When the user then logs out
+# through the CAS server, each of the CAS-enabled client applications need
+# to be notified so that they can close their own local sessions for that user.
+#
+# Up until recently this was not possible within CAS. However, a method for
+# performing this notification was recently added to the protocol (in CAS 3.1).
+# This works exactly as described above -- when the user logs out, the CAS
+# server individually contacts each client service and notifies it of the
+# logout. Currently not all client applications support this, so this
+# behaviour is disabled by default. To enable it, uncomment the following
+# configuration line. Note that currently it is not possible to enable
+# or disable single-sign-out on a per-service basis, but this functionality
+# is planned for a future release.
+
+enable_single_sign_out: true
+
+
+##### OTHER ####################################################################
+
+# You can set various ticket expiry times (specify the value in seconds).
+
+# Unused login and service tickets become unusable this many seconds after
+# they are created. (Defaults to 5 minutes)
+
+#maximum_unused_login_ticket_lifetime: 300
+#maximum_unused_service_ticket_lifetime: 300
+
+# The server must periodically delete old tickets (login tickets, service tickets
+# proxy-granting tickets, and ticket-granting tickets) to prevent buildup of
+# stale data. This effectively limits the maximum length of a CAS session to
+# the lifetime given here (in seconds). (Defaults to 48 hours)
+#
+# Note that this limit is not enforced on the client side; it refers only to the
+# the maximum lifetime of tickets on the CAS server.
+
+#maximum_session_lifetime: 172800
+
+
+# If you want the usernames entered on the login page to be automatically
+# downcased (converted to lowercase), enable the following option. When this
+# option is set to true, if the user enters "JSmith" as their username, the
+# system will automatically
+# convert this to "jsmith".
+
+downcase_username: true

data/config/unicorn/development.rb

@@ -0,0 +1,14 @@
+# MANAGED BY PUPPET
+# Module:: rubycas
+#
+
+worker_processes 2
+user 'vagrant', 'vagrant'
+working_directory "/home/vagrant/rubycas-server/current"
+
+pid "/home/vagrant/rubycas-server/shared/pids/unicorn.pid"
+
+listen 8001
+
+stderr_path "/home/vagrant/rubycas-server/current/log/unicorn.stderr.log"
+stdout_path "/home/vagrant/rubycas-server/current/log/unicorn.stdout.log"

data/config/unicorn/production.rb

@@ -0,0 +1,14 @@
+# MANAGED BY PUPPET
+# Module:: rubycas
+#
+
+worker_processes 2
+user 'rubycas-server', 'rubycas-server'
+working_directory "/home/rubycas-server/rubycas-server/current"
+
+pid "/home/rubycas-server/rubycas-server/shared/pids/unicorn.pid"
+
+listen 8001
+
+stderr_path "/home/rubycas-server/rubycas-server/current/log/unicorn.stderr.log"
+stdout_path "/home/rubycas-server/rubycas-server/current/log/unicorn.stdout.log"

data/config/unicorn/staging.rb

@@ -0,0 +1,14 @@
+# MANAGED BY PUPPET
+# Module:: rubycas
+#
+
+worker_processes 2
+user 'rubycas', 'rubycas'
+working_directory "/home/rubycas/rubycas-server/current"
+preload_app true
+pid "/home/rubycas/rubycas-server/shared/pids/unicorn.pid"
+
+listen 8001
+
+stderr_path "/home/rubycas/rubycas-server/current/log/unicorn.stderr.log"
+stdout_path "/home/rubycas/rubycas-server/current/log/unicorn.stdout.log"

data/lib/casserver.rb

@@ -3,9 +3,10 @@ module CASServer; end
 require 'active_record'
 require 'active_support'
 require 'sinatra/base'
-require 'casserver/core_ext/directory_user'
 require 'builder' # for XML views
 require 'logger'
+require 'net/ldap'
+require 'casserver/core_ext/directory_user'
 $LOG = Logger.new(STDOUT)
 
 require 'casserver/authenticators/base'

data/lib/casserver/cas.rb

@@ -34,6 +34,332 @@ module CASServer::CAS
     tgt.ticket = "TGC-" + String.random
     tgt.username = username
     tgt.extra_attributes = extra_attributes
+    tgt.expires = (Time.now + 2.weeks).strftime("%a, %d-%b-%Y %H:%M:%S GMT")
+    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}' with expiration of '#{tgt.expires}'" +
+      (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-" + String.random
+    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-" + String.random
+    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-" + String.random(60)
+      pgt.iou = "PGTIOU-" + String.random(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 = t.error.no_login_ticket
+      $LOG.warn "Missing login ticket."
+    elsif lt = LoginTicket.find_by_ticket(ticket)
+      if lt.consumed?
+        error = t.error.login_ticket_already_used
+        $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 = t.error.login_timeout
+        $LOG.warn "Expired login ticket '#{ticket}'"
+      end
+    else
+      error = t.error.invalid_login_ticket
+      $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[:maximum_session_lifetime] && Time.now - tgt.created_on > settings.config[:maximum_session_lifetime]
+	tgt.destroy
+        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)
+    uri.path = '/' if uri.path.empty?
+    time = Time.now
+    rand = String.random
+    path = uri.path
+    req = Net::HTTP::Post.new(path)
+    req.set_form_data('logoutRequest' => %{<samlp:LogoutRequest xmlns:samlp="urn:oasis:names:tc:SAML:2.0:protocol" xmlns:saml="urn:oasis:names:tc:SAML:2.0:assertion" ID="#{rand}" Version="2.0" IssueInstant="#{time.rfc2822}">
+ <saml:NameID></saml:NameID>
+ <samlp:SessionIndex>#{st.ticket}</samlp:SessionIndex>
+ </samlp:LogoutRequest>})
+
+    begin
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true if uri.scheme =='https'
+
+      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
+require 'uri'
+require 'net/https'
+
+require 'casserver/model'
+require 'casserver/core_ext'
+
+# 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-" + String.random
+
+    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-" + String.random
+    tgt.username = username
+    tgt.extra_attributes = extra_attributes
+    # tgt.expires = (Time.now + 2.weeks).strftime("%a, %d-%b-%Y %H:%M:%S GMT")
     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" +
@@ -87,7 +413,7 @@ module CASServer::CAS
     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-" + String.random(60)
       pgt.iou = "PGTIOU-" + String.random(57)
@@ -102,7 +428,7 @@ module CASServer::CAS
       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!
@@ -251,11 +577,11 @@ module CASServer::CAS
  <saml:NameID></saml:NameID>
  <samlp:SessionIndex>#{st.ticket}</samlp:SessionIndex>
  </samlp:LogoutRequest>})
- 
+
     begin
       http = Net::HTTP.new(uri.host, uri.port)
       http.use_ssl = true if uri.scheme =='https'
-      
+
       http.start do |conn|
         response = conn.request(req)
         if response.kind_of? Net::HTTPSuccess