2 namespace Shaarli\Security
;
4 require_once 'tests/utils/FakeConfigManager.php';
5 use \PHPUnit\Framework\TestCase
;
8 * Test coverage for LoginManager
10 class LoginManagerTest
extends TestCase
12 /** @var \FakeConfigManager Configuration Manager instance */
13 protected $configManager = null;
15 /** @var LoginManager Login Manager instance */
16 protected $loginManager = null;
18 /** @var SessionManager Session Manager instance */
19 protected $sessionManager = null;
21 /** @var string Banned IP filename */
22 protected $banFile = 'sandbox/ipbans.php';
24 /** @var string Log filename */
25 protected $logFile = 'sandbox/shaarli.log';
27 /** @var array Simulates the $_COOKIE array */
28 protected $cookie = [];
30 /** @var array Simulates the $GLOBALS array */
31 protected $globals = [];
33 /** @var array Simulates the $_SERVER array */
34 protected $server = [];
36 /** @var array Simulates the $_SESSION array */
37 protected $session = [];
39 /** @var string Advertised client IP address */
40 protected $clientIpAddress = '10.1.47.179';
42 /** @var string Local client IP address */
43 protected $ipAddr = '127.0.0.1';
45 /** @var string Trusted proxy IP address */
46 protected $trustedProxy = '10.1.1.100';
48 /** @var string User login */
49 protected $login = 'johndoe';
51 /** @var string User password */
52 protected $password = 'IC4nHazL0g1n?';
54 /** @var string Hash of the salted user password */
55 protected $passwordHash = '';
57 /** @var string Salt used by hash functions */
58 protected $salt = '669e24fa9c5a59a613f98e8e38327384504a4af2';
61 * Prepare or reset test resources
63 public function setUp()
65 if (file_exists($this->banFile
)) {
66 unlink($this->banFile
);
69 $this->passwordHash
= sha1($this->password
. $this->login
. $this->salt
);
71 $this->configManager
= new \
FakeConfigManager([
72 'credentials.login' => $this->login
,
73 'credentials.hash' => $this->passwordHash
,
74 'credentials.salt' => $this->salt
,
75 'resource.ban_file' => $this->banFile
,
76 'resource.log' => $this->logFile
,
77 'security.ban_after' => 4,
78 'security.ban_duration' => 3600,
79 'security.trusted_proxies' => [$this->trustedProxy
],
84 $this->globals
= &$GLOBALS;
85 unset($this->globals
['IPBANS']);
89 $this->sessionManager
= new SessionManager($this->session
, $this->configManager
);
90 $this->loginManager
= new LoginManager($this->globals
, $this->configManager
, $this->sessionManager
);
91 $this->server
['REMOTE_ADDR'] = $this->ipAddr
;
97 public function tearDown()
99 unset($this->globals
['IPBANS']);
103 * Instantiate a LoginManager and load ban records
105 public function testReadBanFile()
109 "<?php\n\$GLOBALS['IPBANS']=array('FAILURES' => array('127.0.0.1' => 99));\n?>"
111 new LoginManager($this->globals
, $this->configManager
, null);
112 $this->assertEquals(99, $this->globals
['IPBANS']['FAILURES']['127.0.0.1']);
116 * Record a failed login attempt
118 public function testHandleFailedLogin()
120 $this->loginManager
->handleFailedLogin($this->server
);
121 $this->assertEquals(1, $this->globals
['IPBANS']['FAILURES'][$this->ipAddr
]);
123 $this->loginManager
->handleFailedLogin($this->server
);
124 $this->assertEquals(2, $this->globals
['IPBANS']['FAILURES'][$this->ipAddr
]);
128 * Record a failed login attempt - IP behind a trusted proxy
130 public function testHandleFailedLoginBehindTrustedProxy()
133 'REMOTE_ADDR' => $this->trustedProxy
,
134 'HTTP_X_FORWARDED_FOR' => $this->ipAddr
,
136 $this->loginManager
->handleFailedLogin($server);
137 $this->assertEquals(1, $this->globals
['IPBANS']['FAILURES'][$this->ipAddr
]);
139 $this->loginManager
->handleFailedLogin($server);
140 $this->assertEquals(2, $this->globals
['IPBANS']['FAILURES'][$this->ipAddr
]);
144 * Record a failed login attempt - IP behind a trusted proxy but not forwarded
146 public function testHandleFailedLoginBehindTrustedProxyNoIp()
149 'REMOTE_ADDR' => $this->trustedProxy
,
151 $this->loginManager
->handleFailedLogin($server);
152 $this->assertFalse(isset($this->globals
['IPBANS']['FAILURES'][$this->ipAddr
]));
154 $this->loginManager
->handleFailedLogin($server);
155 $this->assertFalse(isset($this->globals
['IPBANS']['FAILURES'][$this->ipAddr
]));
159 * Record a failed login attempt and ban the IP after too many failures
161 public function testHandleFailedLoginBanIp()
163 $this->loginManager
->handleFailedLogin($this->server
);
164 $this->assertEquals(1, $this->globals
['IPBANS']['FAILURES'][$this->ipAddr
]);
165 $this->assertTrue($this->loginManager
->canLogin($this->server
));
167 $this->loginManager
->handleFailedLogin($this->server
);
168 $this->assertEquals(2, $this->globals
['IPBANS']['FAILURES'][$this->ipAddr
]);
169 $this->assertTrue($this->loginManager
->canLogin($this->server
));
171 $this->loginManager
->handleFailedLogin($this->server
);
172 $this->assertEquals(3, $this->globals
['IPBANS']['FAILURES'][$this->ipAddr
]);
173 $this->assertTrue($this->loginManager
->canLogin($this->server
));
175 $this->loginManager
->handleFailedLogin($this->server
);
176 $this->assertEquals(4, $this->globals
['IPBANS']['FAILURES'][$this->ipAddr
]);
177 $this->assertFalse($this->loginManager
->canLogin($this->server
));
179 // handleFailedLogin is not supposed to be called at this point:
180 // - no login form should be displayed once an IP has been banned
181 // - yet this could happen when using custom templates / scripts
182 $this->loginManager
->handleFailedLogin($this->server
);
183 $this->assertEquals(5, $this->globals
['IPBANS']['FAILURES'][$this->ipAddr
]);
184 $this->assertFalse($this->loginManager
->canLogin($this->server
));
190 public function testHandleSuccessfulLogin()
192 $this->assertTrue($this->loginManager
->canLogin($this->server
));
194 $this->loginManager
->handleSuccessfulLogin($this->server
);
195 $this->assertTrue($this->loginManager
->canLogin($this->server
));
199 * Erase failure records after successfully logging in from this IP
201 public function testHandleSuccessfulLoginAfterFailure()
203 $this->loginManager
->handleFailedLogin($this->server
);
204 $this->loginManager
->handleFailedLogin($this->server
);
205 $this->assertEquals(2, $this->globals
['IPBANS']['FAILURES'][$this->ipAddr
]);
206 $this->assertTrue($this->loginManager
->canLogin($this->server
));
208 $this->loginManager
->handleSuccessfulLogin($this->server
);
209 $this->assertTrue($this->loginManager
->canLogin($this->server
));
210 $this->assertFalse(isset($this->globals
['IPBANS']['FAILURES'][$this->ipAddr
]));
211 $this->assertFalse(isset($this->globals
['IPBANS']['BANS'][$this->ipAddr
]));
215 * The IP is not banned
217 public function testCanLoginIpNotBanned()
219 $this->assertTrue($this->loginManager
->canLogin($this->server
));
225 public function testCanLoginIpBanned()
227 // ban the IP for an hour
228 $this->globals
['IPBANS']['FAILURES'][$this->ipAddr
] = 10;
229 $this->globals
['IPBANS']['BANS'][$this->ipAddr
] = time() +
3600;
231 $this->assertFalse($this->loginManager
->canLogin($this->server
));
235 * The IP is banned, and the ban duration is over
237 public function testCanLoginIpBanExpired()
239 // ban the IP for an hour
240 $this->globals
['IPBANS']['FAILURES'][$this->ipAddr
] = 10;
241 $this->globals
['IPBANS']['BANS'][$this->ipAddr
] = time() +
3600;
242 $this->assertFalse($this->loginManager
->canLogin($this->server
));
245 $this->globals
['IPBANS']['BANS'][$this->ipAddr
] = time() - 3600;
246 $this->assertTrue($this->loginManager
->canLogin($this->server
));
250 * Generate a token depending on the user credentials and client IP
252 public function testGenerateStaySignedInToken()
254 $this->loginManager
->generateStaySignedInToken($this->clientIpAddress
);
257 sha1($this->passwordHash
. $this->clientIpAddress
. $this->salt
),
258 $this->loginManager
->getStaySignedInToken()
263 * Check user login - Shaarli has not yet been configured
265 public function testCheckLoginStateNotConfigured()
267 $configManager = new \
FakeConfigManager([
268 'resource.ban_file' => $this->banFile
,
270 $loginManager = new LoginManager($this->globals
, $configManager, null);
271 $loginManager->checkLoginState([], '');
273 $this->assertFalse($loginManager->isLoggedIn());
277 * Check user login - the client cookie does not match the server token
279 public function testCheckLoginStateStaySignedInWithInvalidToken()
281 // simulate a previous login
283 'ip' => $this->clientIpAddress
,
284 'expires_on' => time() +
100,
286 $this->loginManager
->generateStaySignedInToken($this->clientIpAddress
);
287 $this->cookie
[LoginManager
::$STAY_SIGNED_IN_COOKIE] = 'nope';
289 $this->loginManager
->checkLoginState($this->cookie
, $this->clientIpAddress
);
291 $this->assertTrue($this->loginManager
->isLoggedIn());
292 $this->assertTrue(empty($this->session
['username']));
296 * Check user login - the client cookie matches the server token
298 public function testCheckLoginStateStaySignedInWithValidToken()
300 $this->loginManager
->generateStaySignedInToken($this->clientIpAddress
);
301 $this->cookie
[LoginManager
::$STAY_SIGNED_IN_COOKIE] = $this->loginManager
->getStaySignedInToken();
303 $this->loginManager
->checkLoginState($this->cookie
, $this->clientIpAddress
);
305 $this->assertTrue($this->loginManager
->isLoggedIn());
306 $this->assertEquals($this->login
, $this->session
['username']);
307 $this->assertEquals($this->clientIpAddress
, $this->session
['ip']);
311 * Check user login - the session has expired
313 public function testCheckLoginStateSessionExpired()
315 $this->loginManager
->generateStaySignedInToken($this->clientIpAddress
);
316 $this->session
['expires_on'] = time() - 100;
318 $this->loginManager
->checkLoginState($this->cookie
, $this->clientIpAddress
);
320 $this->assertFalse($this->loginManager
->isLoggedIn());
324 * Check user login - the remote client IP has changed
326 public function testCheckLoginStateClientIpChanged()
328 $this->loginManager
->generateStaySignedInToken($this->clientIpAddress
);
330 $this->loginManager
->checkLoginState($this->cookie
, '10.7.157.98');
332 $this->assertFalse($this->loginManager
->isLoggedIn());
336 * Check user credentials - wrong login supplied
338 public function testCheckCredentialsWrongLogin()
341 $this->loginManager
->checkCredentials('', '', 'b4dl0g1n', $this->password
)
346 * Check user credentials - wrong password supplied
348 public function testCheckCredentialsWrongPassword()
351 $this->loginManager
->checkCredentials('', '', $this->login
, 'b4dp455wd')
356 * Check user credentials - wrong login and password supplied
358 public function testCheckCredentialsWrongLoginAndPassword()
361 $this->loginManager
->checkCredentials('', '', 'b4dl0g1n', 'b4dp455wd')
366 * Check user credentials - correct login and password supplied
368 public function testCheckCredentialsGoodLoginAndPassword()
371 $this->loginManager
->checkCredentials('', '', $this->login
, $this->password
)