1
2
3
4
5
6
7
8
9
10
11
12
13
14
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
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
135
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
182
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
|
<?php
/**
*
* This file is part of the phpBB Forum Software package.
*
* @copyright (c) phpBB Limited <https://www.phpbb.com>
* @license GNU General Public License, version 2 (GPL-2.0)
*
* For full copyright and license information, please see
* the docs/CREDITS.txt file.
*
*/
use OAuth\OAuth2\Token\StdOAuth2Token;
class phpbb_auth_provider_oauth_token_storage_test extends phpbb_database_test_case
{
protected $db;
protected $service_name;
protected $session_id;
protected $token_storage;
protected $token_storage_table;
protected $user;
protected function setup()
{
parent::setUp();
global $phpbb_root_path, $phpEx;
$this->db = $this->new_dbal();
$this->user = $this->getMock('\phpbb\user');
$this->service_name = 'auth.provider.oauth.service.testing';
$this->token_storage_table = 'phpbb_oauth_tokens';
// Give the user a session_id that we will remember
$this->session_id = '12345';
$this->user->data['session_id'] = $this->session_id;
// Set the user id to anonymous
$this->user->data['user_id'] = ANONYMOUS;
$this->token_storage = new \phpbb\auth\provider\oauth\token_storage($this->db, $this->user, $this->token_storage_table);
}
public function getDataSet()
{
return $this->createXMLDataSet(dirname(__FILE__).'/fixtures/oauth_tokens.xml');
}
public static function retrieveAccessToken_data()
{
return array(
array(new StdOAuth2Token('access', 'refresh', StdOAuth2Token::EOL_NEVER_EXPIRES, array('extra' => 'param')), null),
array(null, 'OAuth\Common\Storage\Exception\TokenNotFoundException'),
);
}
/**
* @dataProvider retrieveAccessToken_data
*/
public function test_retrieveAccessToken($cache_token, $exception)
{
if ($cache_token)
{
$this->token_storage->storeAccessToken($this->service_name, $cache_token);
$token = $cache_token;
}
$this->setExpectedException($exception);
$stored_token = $this->token_storage->retrieveAccessToken($this->service_name);
$this->assertEquals($token, $stored_token);
}
public function test_retrieveAccessToken_from_db()
{
$expected_token = new StdOAuth2Token('access', 'refresh', StdOAuth2Token::EOL_NEVER_EXPIRES);
// Store a token in the database
$temp_storage = new \phpbb\auth\provider\oauth\token_storage($this->db, $this->user, $this->token_storage_table);
$temp_storage->storeAccessToken($this->service_name, $expected_token);
unset($temp_storage);
// Test to see if the token can be retrieved
$stored_token = $this->token_storage->retrieveAccessToken($this->service_name);
$this->assertEquals($expected_token, $stored_token);
}
/**
* @dataProvider retrieveAccessToken_data
*/
public function test_retrieve_access_token_by_session($cache_token, $exception)
{
if ($cache_token)
{
$this->token_storage->storeAccessToken($this->service_name, $cache_token);
$token = $cache_token;
}
$this->setExpectedException($exception);
$stored_token = $this->token_storage->retrieve_access_token_by_session($this->service_name);
$this->assertEquals($token, $stored_token);
}
public function test_retrieve_access_token_by_session_from_db()
{
$expected_token = new StdOAuth2Token('access', 'refresh', StdOAuth2Token::EOL_NEVER_EXPIRES);
// Store a token in the database
$temp_storage = new \phpbb\auth\provider\oauth\token_storage($this->db, $this->user, $this->token_storage_table);
$temp_storage->storeAccessToken($this->service_name, $expected_token);
unset($temp_storage);
// Test to see if the token can be retrieved
$stored_token = $this->token_storage->retrieve_access_token_by_session($this->service_name);
$this->assertEquals($expected_token, $stored_token);
}
public function test_storeAccessToken()
{
$token = new StdOAuth2Token('access', 'refresh', StdOAuth2Token::EOL_NEVER_EXPIRES, array('extra' => 'param') );
$this->token_storage->storeAccessToken($this->service_name, $token);
// Confirm that the token is cached
$extraParams = $this->token_storage->retrieveAccessToken($this->service_name)->getExtraParams();
$this->assertEquals( 'param', $extraParams['extra'] );
$this->assertEquals( 'access', $this->token_storage->retrieveAccessToken($this->service_name)->getAccessToken() );
$row = $this->get_token_row_by_session_id($this->session_id);
// The token is serialized before stored in the database
$this->assertEquals($this->token_storage->json_encode_token($token), $row['oauth_token']);
}
public static function hasAccessToken_data()
{
return array(
array(null, false),
array(new StdOAuth2Token('access', 'refresh', StdOAuth2Token::EOL_NEVER_EXPIRES, array('extra' => 'param') ), true),
);
}
/**
* @dataProvider hasAccessToken_data
*/
public function test_hasAccessToken($token, $expected)
{
if ($token)
{
$this->token_storage->storeAccessToken($this->service_name, $token);
}
$has_access_token = $this->token_storage->hasAccessToken($this->service_name);
$this->assertEquals($expected, $has_access_token);
}
/**
* @dataProvider hasAccessToken_data
*/
public function test_has_access_token_by_session($token, $expected)
{
if ($token)
{
$this->token_storage->storeAccessToken($this->service_name, $token);
}
$has_access_token = $this->token_storage->has_access_token_by_session($this->service_name);
$this->assertEquals($expected, $has_access_token);
}
public function test_clearToken()
{
$token = new StdOAuth2Token('access', 'refresh', StdOAuth2Token::EOL_NEVER_EXPIRES, array('extra' => 'param') );
$this->token_storage->storeAccessToken($this->service_name, $token);
$this->token_storage->clearToken($this->service_name);
// Check that the database has been cleared
$row = $this->get_token_row_by_session_id($this->session_id);
$this->assertFalse($row);
// Check that the token is no longer in memory
$this->assertFalse($this->token_storage->hasAccessToken($this->service_name));
}
public function test_set_user_id()
{
$token = new StdOAuth2Token('access', 'refresh', StdOAuth2Token::EOL_NEVER_EXPIRES, array('extra' => 'param') );
$this->token_storage->storeAccessToken($this->service_name, $token);
$new_user_id = ANONYMOUS + 1;
$this->token_storage->set_user_id($new_user_id);
$row = $this->get_token_row_by_session_id($this->session_id);
$this->assertEquals($new_user_id, $row['user_id']);
}
protected function get_token_row_by_session_id($session_id)
{
// Test that the token is stored in the database
$sql = 'SELECT * FROM phpbb_oauth_tokens
WHERE session_id = \'' . $this->db->sql_escape($session_id) . '\'';
$result = $this->db->sql_query($sql);
$row = $this->db->sql_fetchrow($result);
$this->db->sql_freeresult($result);
return $row;
}
}
|
