|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
namespace SilverStripe\Security\MemberAuthenticator; |
|
4
|
|
|
|
|
5
|
|
|
use SilverStripe\Control\Cookie; |
|
6
|
|
|
use SilverStripe\Control\Director; |
|
7
|
|
|
use SilverStripe\Control\HTTPRequest; |
|
8
|
|
|
use SilverStripe\Control\Session; |
|
9
|
|
|
use SilverStripe\Security\AuthenticationHandler; |
|
10
|
|
|
use SilverStripe\Security\Member; |
|
11
|
|
|
|
|
12
|
|
|
/** |
|
13
|
|
|
* Authenticate a member pased on a session cookie |
|
14
|
|
|
*/ |
|
15
|
|
|
class SessionAuthenticationHandler implements AuthenticationHandler |
|
16
|
|
|
{ |
|
17
|
|
|
/** |
|
18
|
|
|
* @var string |
|
19
|
|
|
*/ |
|
20
|
|
|
private $sessionVariable; |
|
21
|
|
|
|
|
22
|
|
|
/** |
|
23
|
|
|
* Get the session variable name used to track member ID |
|
24
|
|
|
* |
|
25
|
|
|
* @return string |
|
26
|
|
|
*/ |
|
27
|
|
|
public function getSessionVariable() |
|
28
|
|
|
{ |
|
29
|
|
|
return $this->sessionVariable; |
|
30
|
|
|
} |
|
31
|
|
|
|
|
32
|
|
|
/** |
|
33
|
|
|
* Set the session variable name used to track member ID |
|
34
|
|
|
* |
|
35
|
|
|
* @param string $sessionVariable |
|
36
|
|
|
*/ |
|
37
|
|
|
public function setSessionVariable($sessionVariable) |
|
38
|
|
|
{ |
|
39
|
|
|
$this->sessionVariable = $sessionVariable; |
|
40
|
|
|
} |
|
41
|
|
|
|
|
42
|
|
|
/** |
|
43
|
|
|
* @param HTTPRequest $request |
|
44
|
|
|
* @return Member |
|
45
|
|
|
*/ |
|
46
|
|
|
public function authenticateRequest(HTTPRequest $request) |
|
47
|
|
|
{ |
|
48
|
|
|
// If ID is a bad ID it will be treated as if the user is not logged in, rather than throwing a |
|
49
|
|
|
// ValidationException |
|
50
|
|
|
$id = Session::get($this->getSessionVariable()); |
|
51
|
|
|
if (!$id) { |
|
52
|
|
|
return null; |
|
53
|
|
|
} |
|
54
|
|
|
/** @var Member $member */ |
|
55
|
|
|
$member = Member::get()->byID($id); |
|
56
|
|
|
return $member; |
|
57
|
|
|
} |
|
58
|
|
|
|
|
59
|
|
|
/** |
|
60
|
|
|
* @param Member $member |
|
61
|
|
|
* @param bool $persistent |
|
62
|
|
|
* @param HTTPRequest $request |
|
63
|
|
|
*/ |
|
64
|
|
|
public function logIn(Member $member, $persistent = false, HTTPRequest $request = null) |
|
65
|
|
|
{ |
|
66
|
|
|
static::regenerateSessionId(); |
|
67
|
|
|
Session::set($this->getSessionVariable(), $member->ID); |
|
68
|
|
|
|
|
69
|
|
|
// This lets apache rules detect whether the user has logged in |
|
70
|
|
|
// @todo make this a setting on the authentication handler |
|
71
|
|
|
if (Member::config()->get('login_marker_cookie')) { |
|
72
|
|
|
Cookie::set(Member::config()->get('login_marker_cookie'), 1, 0); |
|
73
|
|
|
} |
|
74
|
|
|
} |
|
75
|
|
|
|
|
76
|
|
|
/** |
|
77
|
|
|
* Regenerate the session_id. |
|
78
|
|
|
*/ |
|
79
|
|
|
protected static function regenerateSessionId() |
|
80
|
|
|
{ |
|
81
|
|
|
if (!Member::config()->get('session_regenerate_id')) { |
|
82
|
|
|
return; |
|
83
|
|
|
} |
|
84
|
|
|
|
|
85
|
|
|
// This can be called via CLI during testing. |
|
86
|
|
|
if (Director::is_cli()) { |
|
87
|
|
|
return; |
|
88
|
|
|
} |
|
89
|
|
|
|
|
90
|
|
|
$file = ''; |
|
91
|
|
|
$line = ''; |
|
92
|
|
|
|
|
93
|
|
|
// @ is to supress win32 warnings/notices when session wasn't cleaned up properly |
|
94
|
|
|
// There's nothing we can do about this, because it's an operating system function! |
|
95
|
|
|
if (!headers_sent($file, $line)) { |
|
96
|
|
|
@session_regenerate_id(true); |
|
|
|
|
|
|
97
|
|
|
} |
|
98
|
|
|
} |
|
99
|
|
|
|
|
100
|
|
|
/** |
|
101
|
|
|
* @param HTTPRequest $request |
|
102
|
|
|
*/ |
|
103
|
|
|
public function logOut(HTTPRequest $request = null) |
|
104
|
|
|
{ |
|
105
|
|
|
Session::clear($this->getSessionVariable()); |
|
106
|
|
|
} |
|
107
|
|
|
} |
|
108
|
|
|
|
silverstripe /
silverstripe-framework
If you suppress an error, we recommend checking for the error condition explicitly: