Class: Maestrano::SSO::Session

Inherits:
Object
  • Object
show all
Includes:
Preset
Defined in:
lib/maestrano/sso/session.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Preset

included

Constructor Details

#initialize(session) ⇒ Session

Returns a new instance of Session.



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/maestrano/sso/session.rb', line 25

def initialize(session)
  self.session = session
  if (self.session = session)
    begin
      if mno_session = (self.session[:maestrano] || self.session['maestrano'])
        decrypted_session = JSON.parse(Base64.decode64(mno_session))
        self.uid = decrypted_session['uid']
        self.session_token = decrypted_session['session']
        self.recheck = Time.iso8601(decrypted_session['session_recheck'])
        self.group_uid = decrypted_session['group_uid']
        self.preset = decrypted_session['preset']
      end
    rescue
    end
  end
end

Instance Attribute Details

#group_uid ⇒ Object

Returns the value of attribute group_uid.



5
6
7
 
# File 'lib/maestrano/sso/session.rb', line 5

def group_uid
  @group_uid
end

#preset ⇒ Object

Returns the value of attribute preset.



5
6
7
 
# File 'lib/maestrano/sso/session.rb', line 5

def preset
  @preset
end

#recheck ⇒ Object

Returns the value of attribute recheck.



5
6
7
 
# File 'lib/maestrano/sso/session.rb', line 5

def recheck
  @recheck
end

#session ⇒ Object

Returns the value of attribute session.



5
6
7
 
# File 'lib/maestrano/sso/session.rb', line 5

def session
  @session
end

#session_token ⇒ Object

Returns the value of attribute session_token.



5
6
7
 
# File 'lib/maestrano/sso/session.rb', line 5

def session_token
  @session_token
end

#uid ⇒ Object

Returns the value of attribute uid.



5
6
7
 
# File 'lib/maestrano/sso/session.rb', line 5

def uid
  @uid
end

Class Method Details

.from_user_auth_hash(session, auth) ⇒ Object

Load a Maestrano::SSO::Session object from a hash generated by Maestrano::SSO::BaseUser#to_hash



9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
 
# File 'lib/maestrano/sso/session.rb', line 9

def self.from_user_auth_hash(session, auth)
  instance = self.new({})
  instance.session = session

  if (extra = (auth[:extra] || auth['extra'])) && (sso_session = (extra[:session] || extra['session']))
    instance.uid = (sso_session[:uid] || sso_session['uid'])
    instance.session_token = (sso_session[:token] || sso_session['token'])
    instance.group_uid = (sso_session[:group_uid] || sso_session['group_uid'])
    instance.preset = self.preset
    if recheck = (sso_session[:recheck] || sso_session['recheck'])
      instance.recheck = recheck
    end
  end
  return instance
end

Instance Method Details

#perform_remote_check ⇒ Object

Check remote maestrano session and update the recheck attribute if the session is still valid Return true if the session is still valid and false otherwise



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/maestrano/sso/session.rb', line 53

def perform_remote_check
  # Get remote session info
  url = Maestrano::SSO[self.preset].session_check_url(self.uid, self.session_token)
  begin
    response = RestClient.get(url)
    response = JSON.parse(response)
  rescue Exception => e
    response = {}
  end

  # Process response
  if response['valid'] && response['recheck']
    self.recheck = Time.iso8601(response['recheck'])
    return true
  end

  return false
end

#remote_check_required? ⇒ Boolean

Returns:

  • (Boolean) 


42
43
44
45
46
47
 
# File 'lib/maestrano/sso/session.rb', line 42

def remote_check_required?
  if self.uid && self.session_token && self.recheck
    return (self.recheck <= Time.now)
  end
  return true
end

#save ⇒ Object 



99
100
101
102
103
104
105
106
107
 
# File 'lib/maestrano/sso/session.rb', line 99

def save
  self.session[:maestrano] = Base64.encode64({
    uid: self.uid,
    session: self.session_token,
    session_recheck: self.recheck.utc.iso8601,
    group_uid: self.group_uid,
    preset: self.preset
  }.to_json)
end

#valid?(opts = {}) ⇒ Boolean

Check whether this mno session is valid or not Return true if SLO is disabled (via sso.slo_enabled config param) Return false if no session defined

opts: if_session: if true then the session will be considered valid if the http session is nil or does not have a maestrano key. Useful when the validity of a session should be restricted to maestrano users only within an application

Returns:

  • (Boolean) 


83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/maestrano/sso/session.rb', line 83

def valid?(opts = {})
  return true unless Maestrano[self.class.preset].param('sso.slo_enabled')
  return true if opts[:if_session] && (!self.session || (!self.session[:maestrano] && !self.session['maestrano']))
  return false unless self.session

  if self.remote_check_required?
    if perform_remote_check
      self.save
      return true
    else
      return false
    end
  end
  return true
end