Class: CASClient::Client

138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157

# File 'lib/casclient/client.rb', line 138

def cas_server_is_up?
  uri = URI.parse(login_url)

  log.debug "Checking if CAS server at URI '#{uri}' is up..."

  https = https_connection(uri)

  begin
    raw_res = https.start do |conn|
      conn.get("#{uri.path}?#{uri.query}")
    end
  rescue Errno::ECONNREFUSED => e
    log.warn "CAS server did not respond! (#{e.inspect})"
    return false
  end

  log.debug "CAS server responded with #{raw_res.inspect}:\n#{raw_res.body}"

  return raw_res.kind_of?(Net::HTTPSuccess)
end

15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59

# File 'lib/casclient/client.rb', line 15

def configure(conf)
  #TODO: raise error if conf contains unrecognized cas options (this would help detect user typos in the config)

  raise ArgumentError, "Missing :cas_base_url parameter!" unless conf[:cas_base_url]

  if conf.has_key?("encode_extra_attributes_as")
    unless (conf[:encode_extra_attributes_as] == :json || conf[:encode_extra_attributes_as] == :yaml)
      raise ArgumentError, "Unkown Value for :encode_extra_attributes_as parameter! Allowed options are json or yaml - #{conf[:encode_extra_attributes_as]}"
    end
  end

  @cas_base_url      = conf[:cas_base_url].gsub(/\/$/, '')
  @cas_destination_logout_param_name = conf[:cas_destination_logout_param_name]

  @login_url    = conf[:login_url]
  @logout_url   = conf[:logout_url]
  @validate_url = conf[:validate_url]
  @proxy_url    = conf[:proxy_url]
  @service_url  = conf[:service_url]
  @force_ssl_verification  = conf[:force_ssl_verification]
  @proxy_callback_url  = conf[:proxy_callback_url]

  #proxy server settings
  @proxy_host = conf[:proxy_host]
  @proxy_port = conf[:proxy_port]

  @username_session_key         = conf[:username_session_key] || :cas_user
  @extra_attributes_session_key = conf[:extra_attributes_session_key] || :cas_extra_attributes
  @ticket_store_class = case conf[:ticket_store]
    when :local_dir_ticket_store, nil
      CASClient::Tickets::Storage::LocalDirTicketStore
    when :active_record_ticket_store
      require 'casclient/tickets/storage/active_record_ticket_store'
      CASClient::Tickets::Storage::ActiveRecordTicketStore
    else
      conf[:ticket_store]
  end
  @ticket_store = @ticket_store_class.new conf[:ticket_store_config]
  raise CASException, "The Ticket Store is not a subclass of AbstractTicketStore, it is a #{@ticket_store_class}" unless @ticket_store.kind_of? CASClient::Tickets::Storage::AbstractTicketStore

  @log = CASClient::LoggerWrapper.new
  @log.set_real_logger(conf[:logger]) if conf[:logger]
  @ticket_store.log = @log
  @conf_options = conf
end

161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177

# File 'lib/casclient/client.rb', line 161

def login_to_service(credentials, service)
  lt = request_login_ticket

  data = credentials.merge(
    :lt => lt,
    :service => service
  )

  res = submit_data_to_cas(login_url, data)
  response = CASClient::LoginResponse.new(res)

  if response.is_success?
    log.info("Login was successful for ticket: #{response.ticket.inspect}.")
  end

  return response
end

184
185
186
187
188
189
190
191
192

# File 'lib/casclient/client.rb', line 184

def request_login_ticket
  uri = URI.parse(login_url+'Ticket')
  https = https_connection(uri)
  res = https.post(uri.path, ';')

  raise CASException, res.body unless res.kind_of? Net::HTTPSuccess

  res.body.strip
end

200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215

# File 'lib/casclient/client.rb', line 200

def request_proxy_ticket(pgt, target_service)
  uri = URI.parse(proxy_url)
  h = uri.query ? query_to_hash(uri.query) : {}
  h['pgt'] = pgt.ticket
  h['targetService'] = target_service
  uri.query = hash_to_query(h)

  response = request_cas_response(uri, ProxyResponse)

  pt = ProxyTicket.new(response.proxy_ticket, target_service)
  pt.success = response.is_success?
  pt.failure_code = response.failure_code
  pt.failure_message = response.failure_message

  return pt
end

217
218
219
220
221
222
223

# File 'lib/casclient/client.rb', line 217

def retrieve_proxy_granting_ticket(pgt_iou)
  pgt = @ticket_store.retrieve_pgt(pgt_iou)

  raise CASException, "Couldn't find pgt for pgt_iou #{pgt_iou}" unless pgt

  ProxyGrantingTicket.new(pgt, pgt_iou)
end

115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133

# File 'lib/casclient/client.rb', line 115

def validate_service_ticket(st)
  uri = URI.parse(validate_url)
  h = uri.query ? query_to_hash(uri.query) : {}
  h['service'] = st.service
  h['ticket'] = st.ticket
  h['renew'] = "1" if st.renew
  h['pgtUrl'] = proxy_callback_url if proxy_callback_url
  uri.query = hash_to_query(h)

  response = request_cas_response(uri, ValidationResponse)
  st.user = response.user
  st.extra_attributes = response.extra_attributes
  st.pgt_iou = response.pgt_iou
  st.success = response.is_success?
  st.failure_code = response.failure_code
  st.failure_message = response.failure_message

  return st
end