Class: RSence::SessionManager

Inherits:
SessionStorage show all
Includes:
Digest
Defined in:
lib/rsence/sessionmanager.rb

Overview

SessionManager does session creation, validation, expiration and storage duties.

Instance Attribute Summary collapse

Attributes inherited from SessionStorage

#accept_requests, #db

Instance Method Summary collapse

Methods inherited from SessionStorage

#create_session_table, #create_uploads_table, #create_version_table, #db_close, #db_init, #db_open, #db_test, #expire_session, #expire_sessions, #new_ses_id, #reset_sessions, #restore_sessions, #shutdown, #store_sessions, #table_version

Constructor Details

#initialize(transporter) ⇒ SessionManager

Makes everything ready to run



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/rsence/sessionmanager.rb', line 35

def initialize( transporter )

  super()

  @transporter = transporter

  @valuemanager = @transporter.valuemanager

  @plugins = @transporter.plugins

  ## 'Unique' Random String generator for ses_key:s and cookie_key:s
  @randgen   = RandGen.new( @config[:key_length] )

  # regex to match ipv4 addresses
  @ipv4_reg = /^([1][0-9][0-9]|[2][0-5][0-9]|[1-9][0-9]|[1-9])\.([1][0-9][0-9]|[2][0-5][0-9]|[1-9][0-9]|[0-9])\.([1][0-9][0-9]|[2][0-5][0-9]|[1-9][0-9]|[0-9])\.([1][0-9][0-9]|[2][0-5][0-9]|[1-9][0-9]|[0-9])$/

end

Instance Attribute Details

#randgen ⇒ Object (readonly)

Returns the value of attribute randgen.



32
33
34
 
# File 'lib/rsence/sessionmanager.rb', line 32

def randgen
  @randgen
end

Instance Method Details

Checks / Sets cookies



316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
 
# File 'lib/rsence/sessionmanager.rb', line 316

def check_cookie( msg, ses_seed )

  # default to no cookie key found:
  cookie_key = false

  # gets the cookie array from the request object
  cookie_raw = msg.request.cookies

  # checks, if a cookie named 'ses_key' is found
  if cookie_raw.has_key?('ses_key')
  
    # gets just the data itself (discards comment, domain, expiration etc)
    cookie_key = cookie_raw['ses_key'].split(';')[0]
  
  end

  # if a cookie key is found (non-false), checks if it's valid
  if cookie_key
  
    # checks for validity by looking the key up in @session_cookie_keys
    cookie_key_exist = @session_cookie_keys.has_key?( cookie_key )
  
    # sets the cookie key to false, if it doesn't exist
    cookie_key = false unless cookie_key_exist
  
  end

  # at this point, the cookie key seems valid:
  if cookie_key and cookie_key_exist
  
    # get the session identifier
    ses_id = @session_cookie_keys[ cookie_key ]
  
    # get the last session key from session data
    ses_key = @sessions[ses_id][:ses_key]
  
    # make additional checks on the session validity (expiry etc)
    (ses_status, ses_cloned) = check_ses( msg, ses_key, ses_seed )
  
    if ses_status and ses_cloned
      ses_id = msg.ses_id
      ses_key = msg.session[:ses_key]
      cookie_key = msg.session[:cookie_key]
      @valuemanager.resend_session_values( msg )
    elsif ses_status

      unless @sessions[ses_id].has_key?(:_msg_unused)
        # delete the old cookie key:
        @session_cookie_keys.delete( cookie_key )
      
        # get a new cookie key
        cookie_key = @randgen.gen_many(@config[:cookie_key_multiplier]).join('')
      
        # map the new cookie key to the old session identifier
        @session_cookie_keys[ cookie_key ] = ses_id
      
        # binds the new cookie key to the old session data
        @sessions[ses_id][:cookie_key] = cookie_key
      end
      
      msg.session[:plugin_incr] = @plugins.incr
    
      # Sets the restored_session flag of msg to true
      # It signals plugins to re-set data
      msg.restored_session = true
    
      # Sets the new_session flag of msg to false
      # It signals plugins to not create new server-side values
      msg.new_session = false
    
      # tells ValueManager to re-send client-side HValue objects
      # with data to the client
      @valuemanager.resend_session_values( msg )
  
    # if the session is not valid, make sure to mark the
    # cookie key as invalid (false)
    else
      cookie_key = false
    end
  end

  # if the cookie key failed validation in the
  # tests above, create a new session instead
  unless cookie_key
    cookie_key = init_ses( msg, ses_seed )
    ses_status = true
  end

  renew_cookie( msg, cookie_key )

  ## Return the session status. Actually,
  ## the value is always true, but future
  ## versions might not accept invalid
  ## cookies as new sessions.
  return ses_status
end

#check_ses(msg, ses_key, ses_seed = false) ⇒ Object

Returns the current session data, if the session is valid. Otherwise stops the client and returns false.



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/rsence/sessionmanager.rb', line 234

def check_ses( msg, ses_key, ses_seed=false )

  # first, check if the session key exists (sync)
  if @session_keys.has_key?( ses_key )
  
    # get the session's id based on its key
    ses_id   = @session_keys[ ses_key ]
  
    # get the session's data based on its id
    ses_data = @sessions[ ses_id ]
  
    if not ses_data.has_key?(:_msg_unused) and @config[:clone_cookie_sessions] and ses_seed
      clone_ses( msg, ses_data, ses_id, ses_key, ses_seed )
      return [true, true]
    else
      refresh_ses( msg, ses_data, ses_id, ses_key, ses_seed )
      return [true, false]
    end
  
  ## The session was either faked or expired:
  elsif RSence.args[:debug]

    ### Tells the client to stop connecting with its session key and reload instead to get a new one.
    stop_client_with_message( msg,
      @config[:messages][:invalid_session][:title],
      @config[:messages][:invalid_session][:descr],
      @config[:messages][:invalid_session][:uri]
    )
  
    ## Return failure
    return [false, false]

  else

    msg.error_msg( [
      "COMM.Transporter.stop = true;",
      "setTimeout(function(){window.location.reload(true);},3000);",
      "COMM.Transporter.setInterruptAnim('Session failure, reloading in 3 seconds..','#039');",
      "setTimeout(function(){COMM.Transporter.setInterruptAnim('Reloading...');},2500);",
      "setTimeout(function(){COMM.Transporter.setInterruptAnim('Session failure, reloading in 1 seconds..');},2000);",
      "setTimeout(function(){COMM.Transporter.setInterruptAnim('Session failure, reloading in 2 seconds..');},1000);",
    ] )
    return [ false, false ]
  end

end

#clone_ses(msg, old_data, old_id, old_key, ses_seed) ⇒ Object 



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/rsence/sessionmanager.rb', line 183

def clone_ses( msg, old_data, old_id, old_key, ses_seed )
  if @plugins
    @plugins.delegate( :dump_ses, old_data )
    @plugins.delegate( :dump_ses_id, old_id )
  end
  begin
    old_dump = Marshal.dump( old_data )
    if @plugins
      @plugins.delegate( :load_ses_id, old_id )
      @plugins.delegate( :load_ses, old_data )
    end
    ses_data = Marshal.load( old_dump )
  rescue => e
    warn "Unable to clone session #{old_id}, because: #{e.message}"
    init_ses( msg, ses_seed )
    return
  end
  old_data[:timeout] = Time.now.to_i + @config[:cloned_session_expires_in]
  timeout = Time.now.to_i + @config[:timeout_secs]
  cookie_key = @randgen.gen_many(@config[:cookie_key_multiplier]).join('')
  ses_key = @randgen.gen
  ses_sha = SHA1.hexdigest(ses_key+ses_seed)
  ses_data[:timeout] = timeout
  ses_data[:ses_key] = ses_key
  ses_data[:cookie_key] = cookie_key
  ses_data[:plugin_incr] = @plugins.incr
  ses_id = new_ses_id( cookie_key, ses_key, timeout )
  ses_data[:ses_id] = ses_id
  @sessions[ ses_id ] = ses_data
  @session_keys[ ses_sha ] = ses_id
  @session_cookie_keys.delete( old_data[:cookie_key] )
  @session_cookie_keys[ cookie_key ] = ses_id
  msg.ses_key = ses_key
  msg.session = ses_data
  if @plugins
    @plugins.delegate( :load_ses_id, ses_id )
    @plugins.delegate( :load_ses, ses_data )
  end
  if @clone_targets.has_key? old_id
    @clone_targets[ old_id ].push( ses_id )
  else
    @clone_targets[ old_id ] = [ ses_id ]
  end
  @clone_sources[ ses_id ] = old_id
  msg.cloned_source = old_data
  msg.new_session = false
  msg.restored_session = true
end

#expire_ses_by_req(req, res) ⇒ Object 



480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
 
# File 'lib/rsence/sessionmanager.rb', line 480

def expire_ses_by_req( req, res )
  
  cookie_raw = req.cookies
  
  # checks, if a cookie named 'ses_key' is found
  if cookie_raw.has_key?('ses_key')
    
    # gets just the data itself (discards comment, domain, expiration etc)
    cookie_key = cookie_raw['ses_key'].split(';')[0]
    
  end
  
  # if a cookie key is found (non-false), checks if it's valid
  if cookie_key
    
    # checks for validity by looking the key up in @session_cookie_keys
    cookie_key_exist = @session_cookie_keys.has_key?( cookie_key )
    
    # sets the cookie key to false, if it doesn't exist
    cookie_key = false unless cookie_key_exist
    
  end
  
  # at this point, the cookie key seems valid:
  if cookie_key and cookie_key_exist
    
    # get the session identifier
    ses_id = @session_cookie_keys[ cookie_key ]
    
    # Expire the session
    expire_session( ses_id )
    
    return true
    
  end
  
  return false
end

#init_msg(request, response, options = { :cookies => false, :servlet => false }) ⇒ Object

Creates a message and checks the session



520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
 
# File 'lib/rsence/sessionmanager.rb', line 520

def init_msg( request, response, options = { :cookies => false, :servlet => false } )
  
  cookies = options[:cookies]
  
  if options.has_key?(:query)
    query = options[:query]
  else
    query = request.query
  end
  
  ## Perform old-session cleanup on all sync:s
  expire_sessions
  
  ## The 'ses_id' request query key is required.
  ## The client defaults to '0', which means the
  ## client needs to be initialized.
  ## The client's ses_id is the server's ses_key.
  if not options.has_key?( :ses_key )
    return Message.new( @transporter, request, response, options )
  else
    
    ## get the ses_key from the request query:
    ses_key = options[:ses_key]

    ## The message object binds request, response
    ## and all user/session -related data to one
    ## object, which is passed around where
    ## request/response/user/session -related
    ## data is needed.
    msg = Message.new( @transporter, request, response, options )
    
    ## The client tells that its ses_key is '0',
    ## until the server tells it otherwise.
    (req_num, ses_seed) = ses_key.split(':.o.:')
    
    if req_num == '0'
      
      # If Broker encounters a '/hello' request, it
      # sets cookies to true.
      #
      # It means that a session should have its cookies
      # checked.
      #
      if cookies
        ses_status = check_cookie( msg, ses_seed )
      # Otherwise, a new session is created:
      else
        init_ses( msg, ses_seed )
        ses_status = true
      end
      
    # for non-'0' ses_keys:
    else
      
      ## Validate the session key
      ses_status = check_ses( msg, ses_seed )[0]
      
      ## Renew the cookie even when the request is a "x" (not "hello")
      if @config[:session_cookies] and ses_status
        renew_cookie( msg, msg.session[:cookie_key] )
      end
    
    end # /ses_key
    
    ## msg.ses_valid is false by default, meaning
    ## it's not valid or hasn't been initialized.
    msg.ses_valid = ses_status
    
    return msg
  end # /ses_key
end

#init_ses(msg = nil, ses_seed = false) ⇒ Object

Creates a new session



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/rsence/sessionmanager.rb', line 54

def init_ses( msg=nil, ses_seed=false )

  if ses_seed == false
    ses_seed = @randgen.gen
  end

  ## Assigns new timeout for the session
  time_now = Time.now.to_i # seconds since epoch
  timeout  = time_now + @config[:timeout_secs]

  ## Creates a new session key
  ses_key    = @randgen.gen

  ## Creates a new cookie key
  cookie_key = @randgen.gen_many(@config[:cookie_key_multiplier]).join('')

  ## Makes a new database row for the session, returns its id
  ses_id     = new_ses_id( cookie_key, ses_key, timeout )

  ses_sha = SHA1.hexdigest(ses_key+ses_seed)

  ### Default session data structure,
  ### Please don't mess with it, unless you know exactly what you are doing.
  ses_data = {
  
    # the time, when the session will time out
    :timeout    =>  timeout,
    
    :plugin_incr => @plugins.incr,
    
    # session id, used internally
    :ses_id     =>  ses_id,
  
    # session key, used externally (client sync)
    :ses_key    =>  ses_sha,
  
    # session key, used externally (client cookies)
    :cookie_key =>  cookie_key,
  
    # user id, map to your own user management code
    :user_id    =>  0,

    # unused in msg context:
    :_msg_unused => true,
    
    # user info, map to your own user management code
    :user_info  => {},
  
    # valuemanager data
    :values     => {
      :sync  => [],  # value id's to sync to client
      :check => [],  # value id's to validate in server (from client)
      :by_id => {}   # values by id
    }
  }

  # bind the session data to @sessions by its id
  @sessions[ ses_id ] = ses_data

  # map the key back to the id
  @session_keys[ ses_sha ] = ses_id

  # map the ses_id to cookie key
  @session_cookie_keys[ cookie_key ] = ses_id
  
  if msg
    ### Tell the client what the new key is
    msg.ses_key = ses_key
  
    ### Set the session data and id to the message object
    msg.session = ses_data
  
    # Flag the session as new, so associated
    # plugins know when to create new data
    msg.new_session = true
  end

  # Returns the cookie key, so it can be sent in the response header
  return cookie_key

end

#js_str(str) ⇒ Object 



281
282
283
 
# File 'lib/rsence/sessionmanager.rb', line 281

def js_str( str )
  return str.to_json.gsub('<','&lt;').gsub('>','&gt;').gsub(/\[\[(.*?)\]\]/,'<\1>')
end

#refresh_ses(msg, ses_data, ses_id, ses_key, ses_seed) ⇒ Object 



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/rsence/sessionmanager.rb', line 136

def refresh_ses( msg, ses_data, ses_id, ses_key, ses_seed )
  # new time-out
  ses_data[:timeout] = Time.now.to_i + @config[:timeout_secs]

  # re-generates the ses_key for each sync
  if @config[:disposable_keys]
  
    # disposes the old (current) ses_key:
    @session_keys.delete( ses_key )
  
    unless ses_seed
      ses_seed = ses_key
    end
  
    # gets a new ses_key:
    ses_key = @randgen.gen
  
    ses_sha = SHA1.hexdigest(ses_key+ses_seed)
  
    # re-maps the session id to the new key
    @session_keys[ses_sha] = ses_id
  
    # changes the session key in the session data
    ses_data[:ses_key] = ses_sha
  
    # tell the client what its new session key is
    msg.ses_key = ses_key
  end
  
  if @config[:clone_cookie_sessions] and @clone_targets.has_key? ses_id
    targets = []
    @clone_targets[ ses_id ].length.times do |n|
      target_id  = @clone_targets[ ses_id ].shift
      target_ses = @sessions[ target_id ]
      if @sessions.has_key?( target_id ) and @sessions[ target_id ].class == Hash
        targets.push( target_ses )
      end
    end
    @clone_targets.delete( ses_id ) if @clone_targets[ ses_id ].empty?
    msg.cloned_targets = targets unless targets.empty?
  end

  ### Bind the session data and id to the message object
  msg.session = ses_data

end

#renew_cookie(msg, cookie_key) ⇒ Object 



413
414
415
 
# File 'lib/rsence/sessionmanager.rb', line 413

def renew_cookie( msg, cookie_key )
  renew_cookie_req_res( msg.request, msg.response, cookie_key )
end

#renew_cookie_req_res(request, response, cookie_key, ses_cookie_path = nil) ⇒ Object 



417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
 
# File 'lib/rsence/sessionmanager.rb', line 417

def renew_cookie_req_res( request, response, cookie_key, ses_cookie_path=nil )
  # Uses a cookie comment to tell the user what the
  # cookie is for, change it to anything valid in the
  # configuration.
  ses_cookie_comment = @config[:ses_cookie_comment]

  ## mod_rewrite changes the host header to x-forwarded-host:
  if request.header.has_key?('x-forwarded-host')
    domain = request.header['x-forwarded-host']
  
  ## direct access just uses host (at least mongrel
  ## does mod_rewrite header translation):
  else
    domain = request.host
  end

  if domain == 'localhost'
    warn "Warning: Cookies won't be set for 'localhost'. Use '127.0.0.1' instead." if RSence.args[:debug]
    return
  end

  server_port = request.port

  ## if the host address is a real domain
  ## (not just hostname or 'localhost'),
  ## but not an ip-address, prepend it with
  ## a dot to accept wildcards (useful for
  ## dns-load-balanced server configurations)
  if not @ipv4_reg.match(domain) and domain.include?('.')
    ses_cookie_domain  = ".#{domain}"
  ## Otherwise, use the domain as-is
  else
    ses_cookie_domain  = domain
  end

  ## uses the timeout to declare the max age
  ## of the cookie, allows the browser to delete
  ## it, when it expires.
  ses_cookie_max_age = @config[:timeout_secs]

  ## Only match the handshaking address of rsence,
  ## prevents unnecessary cookie-juggling in sync's
  if @config[:trust_cookies]
    ses_cookie_path    = '/'
  elsif ses_cookie_path == nil
    ses_cookie_path    = RSence.config[:broker_urls][:hello]
  end

  ## Formats the cookie to string
  ## (through array, to keep it readable in the source)
  ses_cookie_arr = [
    "ses_key=#{cookie_key}",
    "Path=#{ses_cookie_path}",
    "Port=#{server_port}",
    "Max-Age=#{ses_cookie_max_age}",
    "Comment=#{ses_cookie_comment}",
    "Domain=#{ses_cookie_domain}"
  ]

  ### Sets the set-cookie header
  response['Set-Cookie'] = ses_cookie_arr.join('; ')
end

#servlet_cookie_ses(request, response) ⇒ Object 



298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/rsence/sessionmanager.rb', line 298

def servlet_cookie_ses( request, response )
  cookie_raw = request.cookies
  if cookie_raw.has_key?('ses_key')
    cookie_key = cookie_raw['ses_key'].split(';')[0]
  else
    cookie_key = nil
  end
  unless @session_cookie_keys.has_key?( cookie_key )
    cookie_key = init_ses
  end
  ses_id = @session_cookie_keys[ cookie_key ]
  ses_data = @sessions[ ses_id ]
  ses_data[:timeout] = Time.now.to_i + @config[:timeout_secs]
  renew_cookie_req_res( request, response, cookie_key, request.fullpath )
  return ses_data
end

#stop_client_with_message(msg, title = 'Unknown Issue', descr = 'No issue description given.', uri = ) ⇒ Object

Displays error message and stops the client



286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/rsence/sessionmanager.rb', line 286

def stop_client_with_message( msg,
                              title = 'Unknown Issue',
                              descr = 'No issue description given.',
                              uri = RSence.config[:index_html][:respond_address] )
  msg.error_msg( [
    "jsLoader.load('default_theme');",
    "jsLoader.load('controls');",
    "jsLoader.load('servermessage');",
    "ReloadApp.nu( #{js_str(title)}, #{js_str(descr)}, #{js_str(uri)}  );"
  ] )
end