Rev 1281 | Rev 1283 | Go to most recent revision | Only display areas with differences | Regard whitespace | Details | Blame | Last modification | View Log | RSS feed
Rev 1281 | Rev 1282 | ||
---|---|---|---|
1 | <?php |
1 | <?php |
2 | 2 | ||
3 | /* |
3 | /* |
4 | * OIDplus 2.0 |
4 | * OIDplus 2.0 |
5 | * Copyright 2019 - 2023 Daniel Marschall, ViaThinkSoft |
5 | * Copyright 2019 - 2023 Daniel Marschall, ViaThinkSoft |
6 | * |
6 | * |
7 | * Licensed under the Apache License, Version 2.0 (the "License"); |
7 | * Licensed under the Apache License, Version 2.0 (the "License"); |
8 | * you may not use this file except in compliance with the License. |
8 | * you may not use this file except in compliance with the License. |
9 | * You may obtain a copy of the License at |
9 | * You may obtain a copy of the License at |
10 | * |
10 | * |
11 | * http://www.apache.org/licenses/LICENSE-2.0 |
11 | * http://www.apache.org/licenses/LICENSE-2.0 |
12 | * |
12 | * |
13 | * Unless required by applicable law or agreed to in writing, software |
13 | * Unless required by applicable law or agreed to in writing, software |
14 | * distributed under the License is distributed on an "AS IS" BASIS, |
14 | * distributed under the License is distributed on an "AS IS" BASIS, |
15 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
15 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
16 | * See the License for the specific language governing permissions and |
16 | * See the License for the specific language governing permissions and |
17 | * limitations under the License. |
17 | * limitations under the License. |
18 | */ |
18 | */ |
19 | 19 | ||
20 | namespace ViaThinkSoft\OIDplus; |
20 | namespace ViaThinkSoft\OIDplus; |
21 | 21 | ||
22 | // phpcs:disable PSR1.Files.SideEffects |
22 | // phpcs:disable PSR1.Files.SideEffects |
23 | \defined('INSIDE_OIDPLUS') or die; |
23 | \defined('INSIDE_OIDPLUS') or die; |
24 | // phpcs:enable PSR1.Files.SideEffects |
24 | // phpcs:enable PSR1.Files.SideEffects |
25 | 25 | ||
26 | class OIDplusAuthContentStoreJWT extends OIDplusAuthContentStoreDummy { |
26 | class OIDplusAuthContentStoreJWT extends OIDplusAuthContentStoreDummy { |
27 | 27 | ||
28 | /** |
28 | /** |
29 | * Cookie name for the JWT auth token |
29 | * Cookie name for the JWT auth token |
30 | */ |
30 | */ |
31 | const COOKIE_NAME = 'OIDPLUS_AUTH_JWT'; |
31 | const COOKIE_NAME = 'OIDPLUS_AUTH_JWT'; |
32 | 32 | ||
33 | /** |
33 | /** |
34 | * "Automated AJAX" plugin |
34 | * "Automated AJAX" plugin |
35 | */ |
35 | */ |
36 | const JWT_GENERATOR_AJAX = 10; |
36 | const JWT_GENERATOR_AJAX = 10; |
37 | /** |
37 | /** |
38 | * "REST API" plugin |
38 | * "REST API" plugin |
39 | */ |
39 | */ |
40 | const JWT_GENERATOR_REST = 20; |
40 | const JWT_GENERATOR_REST = 20; |
41 | /** |
41 | /** |
42 | * "Remember me" login method |
42 | * "Remember me" login method |
43 | */ |
43 | */ |
44 | const JWT_GENERATOR_LOGIN = 40; |
44 | const JWT_GENERATOR_LOGIN = 40; |
45 | /** |
45 | /** |
46 | * "Manually crafted" JWT tokens |
46 | * "Manually crafted" JWT tokens |
47 | */ |
47 | */ |
48 | const JWT_GENERATOR_MANUAL = 80; |
48 | const JWT_GENERATOR_MANUAL = 80; |
49 | 49 | ||
50 | /** |
50 | /** |
51 | * @param int $gen OIDplusAuthContentStoreJWT::JWT_GENERATOR_... |
51 | * @param int $gen OIDplusAuthContentStoreJWT::JWT_GENERATOR_... |
52 | * @param string $sub |
52 | * @param string $sub |
53 | * @return string |
53 | * @return string |
54 | */ |
54 | */ |
55 | private static function jwtGetBlacklistConfigKey(int $gen, string $sub): string { |
55 | private static function jwtGetBlacklistConfigKey(int $gen, string $sub): string { |
56 | // Note: Needs to be <= 50 characters! If $gen is 2 chars, then the config key is 49 chars long |
56 | // Note: Needs to be <= 50 characters! If $gen is 2 chars, then the config key is 49 chars long |
57 | return 'jwt_blacklist_gen('.$gen.')_sub('.trim(base64_encode(md5($sub,true)),'=').')'; |
57 | return 'jwt_blacklist_gen('.$gen.')_sub('.trim(base64_encode(md5($sub,true)),'=').')'; |
58 | } |
58 | } |
59 | 59 | ||
60 | /** |
60 | /** |
61 | * @param int $gen |
61 | * @param int $gen |
62 | */ |
62 | */ |
63 | private static function generatorName($gen) { |
63 | private static function generatorName($gen) { |
64 | // Note: The strings are not translated, because the name is used in config keys or logs |
64 | // Note: The strings are not translated, because the name is used in config keys or logs |
65 | if ($gen === self::JWT_GENERATOR_AJAX) return 'Automated AJAX calls'; |
65 | if ($gen === self::JWT_GENERATOR_AJAX) return 'Automated AJAX calls'; |
66 | if ($gen === self::JWT_GENERATOR_REST) return 'REST API'; |
66 | if ($gen === self::JWT_GENERATOR_REST) return 'REST API'; |
67 | if ($gen === self::JWT_GENERATOR_LOGIN) return 'Login ("Remember me")'; |
67 | if ($gen === self::JWT_GENERATOR_LOGIN) return 'Login ("Remember me")'; |
68 | if ($gen === self::JWT_GENERATOR_MANUAL) return 'Manually created'; |
68 | if ($gen === self::JWT_GENERATOR_MANUAL) return 'Manually created'; |
69 | return 'Unknown generator'; |
69 | return 'Unknown generator'; |
70 | } |
70 | } |
71 | 71 | ||
72 | /** |
72 | /** |
73 | * @param int $gen OIDplusAuthContentStoreJWT::JWT_GENERATOR_... |
73 | * @param int $gen OIDplusAuthContentStoreJWT::JWT_GENERATOR_... |
74 | * @param string $sub |
74 | * @param string $sub |
75 | * @return void |
75 | * @return void |
76 | * @throws OIDplusException |
76 | * @throws OIDplusException |
77 | */ |
77 | */ |
78 | public static function jwtBlacklist(int $gen, string $sub) { |
78 | public static function jwtBlacklist(int $gen, string $sub) { |
79 | $cfg = self::jwtGetBlacklistConfigKey($gen, $sub); |
79 | $cfg = self::jwtGetBlacklistConfigKey($gen, $sub); |
80 | $bl_time = time()-1; |
80 | $bl_time = time()-1; |
81 | 81 | ||
82 | $gen_desc = self::generatorName($gen); |
82 | $gen_desc = self::generatorName($gen); |
83 | 83 | ||
84 | OIDplus::config()->prepareConfigKey($cfg, 'Revoke timestamp of all JWT tokens for $sub with generator $gen ($gen_desc)', "$bl_time", OIDplusConfig::PROTECTION_HIDDEN, function($value) {}); |
84 | OIDplus::config()->prepareConfigKey($cfg, 'Revoke timestamp of all JWT tokens for $sub with generator $gen ($gen_desc)', "$bl_time", OIDplusConfig::PROTECTION_HIDDEN, function($value) {}); |
85 | OIDplus::config()->setValue($cfg, $bl_time); |
85 | OIDplus::config()->setValue($cfg, $bl_time); |
86 | } |
86 | } |
87 | 87 | ||
88 | /** |
88 | /** |
89 | * @param int $gen OIDplusAuthContentStoreJWT::JWT_GENERATOR_... |
89 | * @param int $gen OIDplusAuthContentStoreJWT::JWT_GENERATOR_... |
90 | * @param string $sub |
90 | * @param string $sub |
91 | * @return int |
91 | * @return int |
92 | * @throws OIDplusException |
92 | * @throws OIDplusException |
93 | */ |
93 | */ |
94 | public static function jwtGetBlacklistTime(int $gen, string $sub): int { |
94 | public static function jwtGetBlacklistTime(int $gen, string $sub): int { |
95 | $cfg = self::jwtGetBlacklistConfigKey($gen, $sub); |
95 | $cfg = self::jwtGetBlacklistConfigKey($gen, $sub); |
96 | return (int)OIDplus::config()->getValue($cfg,0); |
96 | return (int)OIDplus::config()->getValue($cfg,0); |
97 | } |
97 | } |
98 | 98 | ||
99 | /** |
99 | /** |
100 | * Do various checks if the token is allowed and not blacklisted |
100 | * Do various checks if the token is allowed and not blacklisted |
101 | * @param OIDplusAuthContentStore $contentProvider |
101 | * @param OIDplusAuthContentStore $contentProvider |
102 | * @param int|null $validGenerators Bitmask which generators to allow (null = allow all) |
102 | * @param int|null $validGenerators Bitmask which generators to allow (null = allow all) |
103 | * @return void |
103 | * @return void |
104 | * @throws OIDplusException |
104 | * @throws OIDplusException |
105 | */ |
105 | */ |
106 | private static function jwtSecurityCheck(OIDplusAuthContentStore $contentProvider, int $validGenerators=null) { |
106 | private static function jwtSecurityCheck(OIDplusAuthContentStore $contentProvider, int $validGenerators=null) { |
107 | // Check if the token is intended for us |
107 | // Check if the token is intended for us |
108 | if ($contentProvider->getValue('aud','') !== OIDplus::getEditionInfo()['jwtaud']) { |
108 | if ($contentProvider->getValue('aud','') !== OIDplus::getEditionInfo()['jwtaud']) { |
109 | throw new OIDplusException(_L('Token has wrong audience')); |
109 | throw new OIDplusException(_L('Token has wrong audience')); |
110 | } |
110 | } |
111 | $gen = $contentProvider->getValue('oidplus_generator', -1); |
111 | $gen = $contentProvider->getValue('oidplus_generator', -1); |
112 | 112 | ||
113 | $has_admin = $contentProvider->isAdminLoggedIn(); |
113 | $has_admin = $contentProvider->isAdminLoggedIn(); |
114 | $has_ra = $contentProvider->raNumLoggedIn() > 0; |
114 | $has_ra = $contentProvider->raNumLoggedIn() > 0; |
115 | 115 | ||
116 | // Check if the token generator is allowed |
116 | // Check if the token generator is allowed |
117 | if ($gen === self::JWT_GENERATOR_AJAX) { |
117 | if ($gen === self::JWT_GENERATOR_AJAX) { |
118 | if (($has_admin) && !OIDplus::baseConfig()->getValue('JWT_ALLOW_AJAX_ADMIN', true)) { |
118 | if (($has_admin) && !OIDplus::baseConfig()->getValue('JWT_ALLOW_AJAX_ADMIN', true)) { |
119 | // Generator: plugins/viathinksoft/adminPages/910_automated_ajax_calls/OIDplusPageAdminAutomatedAJAXCalls.class.php |
119 | // Generator: plugins/viathinksoft/adminPages/910_automated_ajax_calls/OIDplusPageAdminAutomatedAJAXCalls.class.php |
120 | throw new OIDplusException(_L('The administrator has disabled this feature. (Base configuration setting %1).','JWT_ALLOW_AJAX_ADMIN')); |
120 | throw new OIDplusException(_L('The administrator has disabled this feature. (Base configuration setting %1).','JWT_ALLOW_AJAX_ADMIN')); |
121 | } |
121 | } |
122 | if (($has_ra) && !OIDplus::baseConfig()->getValue('JWT_ALLOW_AJAX_USER', true)) { |
122 | if (($has_ra) && !OIDplus::baseConfig()->getValue('JWT_ALLOW_AJAX_USER', true)) { |
123 | // Generator: plugins/viathinksoft/raPages/910_automated_ajax_calls/OIDplusPageRaAutomatedAJAXCalls.class.php |
123 | // Generator: plugins/viathinksoft/raPages/910_automated_ajax_calls/OIDplusPageRaAutomatedAJAXCalls.class.php |
124 | throw new OIDplusException(_L('The administrator has disabled this feature. (Base configuration setting %1).','JWT_ALLOW_AJAX_USER')); |
124 | throw new OIDplusException(_L('The administrator has disabled this feature. (Base configuration setting %1).','JWT_ALLOW_AJAX_USER')); |
125 | } |
125 | } |
126 | } |
126 | } |
127 | else if ($gen === self::JWT_GENERATOR_REST) { |
127 | else if ($gen === self::JWT_GENERATOR_REST) { |
128 | if (($has_admin) && !OIDplus::baseConfig()->getValue('JWT_ALLOW_REST_ADMIN', true)) { |
128 | if (($has_admin) && !OIDplus::baseConfig()->getValue('JWT_ALLOW_REST_ADMIN', true)) { |
129 | // Generator: plugins/viathinksoft/adminPages/911_rest_api/OIDplusPageAdminRestApi.class.php |
129 | // Generator: plugins/viathinksoft/adminPages/911_rest_api/OIDplusPageAdminRestApi.class.php |
130 | throw new OIDplusException(_L('The administrator has disabled this feature. (Base configuration setting %1).','JWT_ALLOW_REST_ADMIN')); |
130 | throw new OIDplusException(_L('The administrator has disabled this feature. (Base configuration setting %1).','JWT_ALLOW_REST_ADMIN')); |
131 | } |
131 | } |
132 | if (($has_ra) && !OIDplus::baseConfig()->getValue('JWT_ALLOW_REST_USER', true)) { |
132 | if (($has_ra) && !OIDplus::baseConfig()->getValue('JWT_ALLOW_REST_USER', true)) { |
133 | // Generator: plugins/viathinksoft/raPages/911_rest_api/OIDplusPageRaRestApi.class.php |
133 | // Generator: plugins/viathinksoft/raPages/911_rest_api/OIDplusPageRaRestApi.class.php |
134 | throw new OIDplusException(_L('The administrator has disabled this feature. (Base configuration setting %1).','JWT_ALLOW_REST_USER')); |
134 | throw new OIDplusException(_L('The administrator has disabled this feature. (Base configuration setting %1).','JWT_ALLOW_REST_USER')); |
135 | } |
135 | } |
136 | } |
136 | } |
137 | else if ($gen === self::JWT_GENERATOR_LOGIN) { |
137 | else if ($gen === self::JWT_GENERATOR_LOGIN) { |
138 | // Used for feature "Remember me" (use JWT token in a cookie as alternative to PHP session): |
138 | // Used for feature "Remember me" (use JWT token in a cookie as alternative to PHP session): |
139 | // - No PHP session will be used |
139 | // - No PHP session will be used |
140 | // - Session will not be bound to IP address (therefore, you can switch between mobile/WiFi for example) |
140 | // - Session will not be bound to IP address (therefore, you can switch between mobile/WiFi for example) |
141 | // - No server-side session needed |
141 | // - No server-side session needed |
142 | if (($has_admin) && !OIDplus::baseConfig()->getValue('JWT_ALLOW_LOGIN_ADMIN', true)) { |
142 | if (($has_admin) && !OIDplus::baseConfig()->getValue('JWT_ALLOW_LOGIN_ADMIN', true)) { |
143 | throw new OIDplusException(_L('The administrator has disabled this feature. (Base configuration setting %1).','JWT_ALLOW_LOGIN_ADMIN')); |
143 | throw new OIDplusException(_L('The administrator has disabled this feature. (Base configuration setting %1).','JWT_ALLOW_LOGIN_ADMIN')); |
144 | } |
144 | } |
145 | if (($has_ra) && !OIDplus::baseConfig()->getValue('JWT_ALLOW_LOGIN_USER', true)) { |
145 | if (($has_ra) && !OIDplus::baseConfig()->getValue('JWT_ALLOW_LOGIN_USER', true)) { |
146 | throw new OIDplusException(_L('The administrator has disabled this feature. (Base configuration setting %1).','JWT_ALLOW_LOGIN_USER')); |
146 | throw new OIDplusException(_L('The administrator has disabled this feature. (Base configuration setting %1).','JWT_ALLOW_LOGIN_USER')); |
147 | } |
147 | } |
148 | } |
148 | } |
149 | else if ($gen === self::JWT_GENERATOR_MANUAL) { |
149 | else if ($gen === self::JWT_GENERATOR_MANUAL) { |
150 | // Generator 2 are "hand-crafted" tokens |
150 | // Generator 2 are "hand-crafted" tokens |
151 | if (!OIDplus::baseConfig()->getValue('JWT_ALLOW_MANUAL', false)) { |
151 | if (!OIDplus::baseConfig()->getValue('JWT_ALLOW_MANUAL', false)) { |
152 | throw new OIDplusException(_L('The administrator has disabled this feature. (Base configuration setting %1).','JWT_ALLOW_MANUAL')); |
152 | throw new OIDplusException(_L('The administrator has disabled this feature. (Base configuration setting %1).','JWT_ALLOW_MANUAL')); |
153 | } |
153 | } |
154 | } else { |
154 | } else { |
155 | throw new OIDplusException(_L('Token generator %1 not recognized',$gen)); |
155 | throw new OIDplusException(_L('Token generator %1 not recognized',$gen)); |
156 | } |
156 | } |
157 | 157 | ||
158 | // Make sure that the IAT (issued at time) isn't in a blacklisted timeframe |
158 | // Make sure that the IAT (issued at time) isn't in a blacklisted timeframe |
159 | // When an user believes that a token was compromised, then they can blacklist the tokens identified by their "iat" ("Issued at") property |
159 | // When an user believes that a token was compromised, then they can blacklist the tokens identified by their "iat" ("Issued at") property |
160 | // When a user logs out of a "remember me" session, the JWT token will be blacklisted as well |
160 | // When a user logs out of a "remember me" session, the JWT token will be blacklisted as well |
161 | // Small side effect: All "remember me" sessions of that user will be revoked then |
161 | // Small side effect: All "remember me" sessions of that user will be revoked then |
162 | $iat = $contentProvider->getValue('iat',0); |
162 | $iat = $contentProvider->getValue('iat',0); |
163 | if (($iat-120/*leeway 2min*/) > time()) { |
163 | if (($iat-120/*leeway 2min*/) > time()) { |
164 | // Token was created in the future. Something is wrong! |
164 | // Token was created in the future. Something is wrong! |
165 | throw new OIDplusException(_L('JWT Token cannot be verified because the server time is wrong')); |
165 | throw new OIDplusException(_L('JWT Token cannot be verified because the server time is wrong')); |
166 | } |
166 | } |
167 | $sublist = $contentProvider->loggedInRaList(); |
167 | $sublist = $contentProvider->loggedInRaList(); |
168 | $usernames = array(); |
168 | $usernames = array(); |
169 | foreach ($sublist as $sub) { |
169 | foreach ($sublist as $sub) { |
170 | $usernames[] = $sub->raEmail(); |
170 | $usernames[] = $sub->raEmail(); |
171 | } |
171 | } |
172 | if ($has_admin) $usernames[] = 'admin'; |
172 | if ($has_admin) $usernames[] = 'admin'; |
173 | foreach ($usernames as $username) { |
173 | foreach ($usernames as $username) { |
174 | $bl_time = self::jwtGetBlacklistTime($gen, $username); |
174 | $bl_time = self::jwtGetBlacklistTime($gen, $username); |
175 | if ($iat <= $bl_time) { |
175 | if ($iat <= $bl_time) { |
176 | // Token is blacklisted (it was created before the last blacklist time) |
176 | // Token is blacklisted (it was created before the last blacklist time) |
177 | throw new OIDplusException(_L('The JWT token was blacklisted on %1. Please generate a new one',date('d F Y, H:i:s',$bl_time))); |
177 | throw new OIDplusException(_L('The JWT token was blacklisted on %1. Please generate a new one',date('d F Y, H:i:s',$bl_time))); |
178 | } |
178 | } |
179 | } |
179 | } |
180 | 180 | ||
181 | // Optional feature: Limit the JWT to a specific IP address |
181 | // Optional feature: Limit the JWT to a specific IP address |
182 | // Currently not used in OIDplus |
182 | // Currently not used in OIDplus |
183 | $ip = $contentProvider->getValue('ip',''); |
183 | $ip = $contentProvider->getValue('ip',''); |
184 | if ($ip !== '') { |
184 | if ($ip !== '') { |
185 | if (isset($_SERVER['REMOTE_ADDR']) && ($ip !== $_SERVER['REMOTE_ADDR'])) { |
185 | if (isset($_SERVER['REMOTE_ADDR']) && ($ip !== $_SERVER['REMOTE_ADDR'])) { |
186 | throw new OIDplusException(_L('Your IP address is not allowed to use this token')); |
186 | throw new OIDplusException(_L('Your IP address is not allowed to use this token')); |
187 | } |
187 | } |
188 | } |
188 | } |
189 | 189 | ||
190 | // Checks if JWT are dependent on the generator |
190 | // Checks if JWT are dependent on the generator |
191 | if (!is_null($validGenerators)) { |
191 | if (!is_null($validGenerators)) { |
192 | if (($gen & $validGenerators) === 0) { |
192 | if (($gen & $validGenerators) === 0) { |
193 | throw new OIDplusException(_L('This kind of JWT token (%1) cannot be used in this request type', self::generatorName($gen))); |
193 | throw new OIDplusException(_L('This kind of JWT token (%1) cannot be used in this request type', self::generatorName($gen))); |
194 | } |
194 | } |
195 | } |
195 | } |
196 | } |
196 | } |
197 | 197 | ||
198 | // Override abstract functions |
198 | // Override abstract functions |
199 | 199 | ||
200 | /** |
200 | /** |
201 | * @return void |
201 | * @return void |
202 | */ |
202 | */ |
203 | public function activate() { |
203 | public function activate() { |
204 | // Send cookie at the end of the HTTP request, in case there are multiple activate() calls |
204 | // Send cookie at the end of the HTTP request, in case there are multiple activate() calls |
205 | OIDplus::register_shutdown_function(array($this,'activateNow')); |
205 | OIDplus::register_shutdown_function(array($this,'activateNow')); |
206 | } |
206 | } |
207 | 207 | ||
208 | /** |
208 | /** |
209 | * @return void |
209 | * @return void |
210 | * @throws OIDplusException |
210 | * @throws OIDplusException |
211 | */ |
211 | */ |
212 | public function activateNow() { |
212 | public function activateNow() { |
213 | $token = $this->getJWTToken(); |
213 | $token = $this->getJWTToken(); |
214 | $exp = $this->getValue('exp',0); |
214 | $exp = $this->getValue('exp',0); |
215 | OIDplus::cookieUtils()->setcookie(self::COOKIE_NAME, $token, $exp, false); |
215 | OIDplus::cookieUtils()->setcookie(self::COOKIE_NAME, $token, $exp, false); |
216 | } |
216 | } |
217 | 217 | ||
218 | /** |
218 | /** |
219 | * @return void |
219 | * @return void |
220 | * @throws OIDplusException |
220 | * @throws OIDplusException |
221 | */ |
221 | */ |
222 | public function destroySession() { |
222 | public function destroySession() { |
223 | OIDplus::cookieUtils()->unsetcookie(self::COOKIE_NAME); |
223 | OIDplus::cookieUtils()->unsetcookie(self::COOKIE_NAME); |
224 | } |
224 | } |
225 | 225 | ||
226 | /** |
226 | /** |
227 | * @param string $email |
227 | * @param string $email |
228 | * @return void |
228 | * @return void |
229 | * @throws OIDplusException |
229 | * @throws OIDplusException |
230 | */ |
230 | */ |
231 | public function raLogout(string $email) { |
231 | public function raLogout(string $email) { |
232 | $gen = $this->getValue('oidplus_generator', -1); |
232 | $gen = $this->getValue('oidplus_generator', -1); |
233 | if ($gen >= 0) self::jwtBlacklist($gen, $email); |
233 | if ($gen >= 0) self::jwtBlacklist($gen, $email); |
234 | parent::raLogout($email); |
234 | parent::raLogout($email); |
235 | } |
235 | } |
236 | 236 | ||
237 | /** |
237 | /** |
238 | * @param string $email |
238 | * @param string $email |
239 | * @param string $loginfo |
239 | * @param string $loginfo |
240 | * @return void |
240 | * @return void |
241 | * @throws OIDplusException |
241 | * @throws OIDplusException |
242 | */ |
242 | */ |
243 | public function raLogoutEx(string $email, string &$loginfo) { |
243 | public function raLogoutEx(string $email, string &$loginfo) { |
244 | $this->raLogout($email); |
244 | $this->raLogout($email); |
245 | $loginfo = 'from JWT session'; |
245 | $loginfo = 'from JWT session'; |
246 | } |
246 | } |
247 | 247 | ||
248 | /** |
248 | /** |
249 | * @return void |
249 | * @return void |
250 | * @throws OIDplusException |
250 | * @throws OIDplusException |
251 | */ |
251 | */ |
252 | public function adminLogout() { |
252 | public function adminLogout() { |
253 | $gen = $this->getValue('oidplus_generator', -1); |
253 | $gen = $this->getValue('oidplus_generator', -1); |
254 | if ($gen >= 0) self::jwtBlacklist($gen, 'admin'); |
254 | if ($gen >= 0) self::jwtBlacklist($gen, 'admin'); |
255 | parent::adminLogout(); |
255 | parent::adminLogout(); |
256 | } |
256 | } |
257 | 257 | ||
258 | /** |
258 | /** |
259 | * @param string $loginfo |
259 | * @param string $loginfo |
260 | * @return void |
260 | * @return void |
261 | * @throws OIDplusException |
261 | * @throws OIDplusException |
262 | */ |
262 | */ |
263 | public function adminLogoutEx(string &$loginfo) { |
263 | public function adminLogoutEx(string &$loginfo) { |
264 | $this->adminLogout(); |
264 | $this->adminLogout(); |
265 | $loginfo = 'from JWT session'; |
265 | $loginfo = 'from JWT session'; |
266 | } |
266 | } |
267 | 267 | ||
268 | private static $contentProvider = null; |
268 | private static $contentProvider = null; |
269 | 269 | ||
270 | /** |
270 | /** |
271 | * @return OIDplusAuthContentStore|null |
271 | * @return OIDplusAuthContentStore|null |
272 | * @throws OIDplusException |
272 | * @throws OIDplusException |
273 | */ |
273 | */ |
274 | public static function getActiveProvider()/*: ?OIDplusAuthContentStore*/ { |
274 | public static function getActiveProvider()/*: ?OIDplusAuthContentStore*/ { |
275 | if (!self::$contentProvider) { |
275 | if (!self::$contentProvider) { |
276 | 276 | ||
277 | $tmp = null; |
277 | $tmp = null; |
278 | $silent_error = false; |
278 | $silent_error = false; |
279 | 279 | ||
280 | try { |
280 | try { |
281 | 281 | ||
282 | $rel_url = substr($_SERVER['REQUEST_URI'], strlen(OIDplus::webpath(null, OIDplus::PATH_RELATIVE_TO_ROOT))); |
282 | $rel_url = substr($_SERVER['REQUEST_URI'], strlen(OIDplus::webpath(null, OIDplus::PATH_RELATIVE_TO_ROOT))); |
283 | if (str_starts_with($rel_url, 'rest/')) { // <== TODO: Find a way how to move this into the plugin, since REST does not belong to the core. |
283 | if (str_starts_with($rel_url, 'rest/')) { // <== TODO: Find a way how to move this into the plugin, since REST does not belong to the core. |
284 | 284 | ||
285 | // REST may only use Bearer Authentication |
285 | // REST may only use Bearer Authentication |
286 | $bearer = getBearerToken(); |
286 | $bearer = getBearerToken(); |
287 | if (!is_null($bearer)) { |
287 | if (!is_null($bearer)) { |
288 | $silent_error = false; |
288 | $silent_error = false; |
289 | $tmp = new OIDplusAuthContentStoreJWT(); |
289 | $tmp = new OIDplusAuthContentStoreJWT(); |
290 | $tmp->loadJWT($bearer); |
290 | $tmp->loadJWT($bearer); |
291 | self::jwtSecurityCheck($tmp, self::JWT_GENERATOR_REST | self::JWT_GENERATOR_MANUAL); |
291 | self::jwtSecurityCheck($tmp, self::JWT_GENERATOR_REST | self::JWT_GENERATOR_MANUAL); |
292 | } |
292 | } |
293 | 293 | ||
294 | } else { |
294 | } else { |
295 | 295 | ||
296 | // A web-visitor (HTML and AJAX, but not REST) can use a JWT "remember me" Cookie |
296 | // A web-visitor (HTML and AJAX, but not REST) can use a JWT "remember me" Cookie |
297 | if (isset($_COOKIE[self::COOKIE_NAME])) { |
297 | if (isset($_COOKIE[self::COOKIE_NAME])) { |
298 | $silent_error = true; |
298 | $silent_error = true; |
299 | $tmp = new OIDplusAuthContentStoreJWT(); |
299 | $tmp = new OIDplusAuthContentStoreJWT(); |
300 | $tmp->loadJWT($_COOKIE[self::COOKIE_NAME]); |
300 | $tmp->loadJWT($_COOKIE[self::COOKIE_NAME]); |
301 | self::jwtSecurityCheck($tmp, self::JWT_GENERATOR_LOGIN | self::JWT_GENERATOR_MANUAL); |
301 | self::jwtSecurityCheck($tmp, self::JWT_GENERATOR_LOGIN | self::JWT_GENERATOR_MANUAL); |
302 | } |
302 | } |
303 | 303 | ||
304 | // AJAX may additionally use GET/POST automated AJAX (in addition to the normal JWT "remember me" Cookie) |
304 | // AJAX may additionally use GET/POST automated AJAX (in addition to the normal JWT "remember me" Cookie) |
305 | if (isset($_SERVER['SCRIPT_FILENAME']) && (strtolower(basename($_SERVER['SCRIPT_FILENAME'])) !== 'ajax.php')) { |
305 | if (isset($_SERVER['SCRIPT_FILENAME']) && (strtolower(basename($_SERVER['SCRIPT_FILENAME'])) !== 'ajax.php')) { |
306 | if (isset($_POST[self::COOKIE_NAME])) { |
306 | if (isset($_POST[self::COOKIE_NAME])) { |
307 | $silent_error = false; |
307 | $silent_error = false; |
308 | $tmp = new OIDplusAuthContentStoreJWT(); |
308 | $tmp = new OIDplusAuthContentStoreJWT(); |
309 | $tmp->loadJWT($_POST[self::COOKIE_NAME]); |
309 | $tmp->loadJWT($_POST[self::COOKIE_NAME]); |
310 | self::jwtSecurityCheck($tmp, self::JWT_GENERATOR_AJAX | self::JWT_GENERATOR_MANUAL); |
310 | self::jwtSecurityCheck($tmp, self::JWT_GENERATOR_AJAX | self::JWT_GENERATOR_MANUAL); |
311 | } |
311 | } |
312 | if (isset($_GET[self::COOKIE_NAME])) { |
312 | if (isset($_GET[self::COOKIE_NAME])) { |
313 | $silent_error = false; |
313 | $silent_error = false; |
314 | $tmp = new OIDplusAuthContentStoreJWT(); |
314 | $tmp = new OIDplusAuthContentStoreJWT(); |
315 | $tmp->loadJWT($_GET[self::COOKIE_NAME]); |
315 | $tmp->loadJWT($_GET[self::COOKIE_NAME]); |
316 | self::jwtSecurityCheck($tmp, self::JWT_GENERATOR_AJAX | self::JWT_GENERATOR_MANUAL); |
316 | self::jwtSecurityCheck($tmp, self::JWT_GENERATOR_AJAX | self::JWT_GENERATOR_MANUAL); |
317 | } |
317 | } |
318 | } |
318 | } |
319 | 319 | ||
320 | } |
320 | } |
321 | 321 | ||
322 | } catch (\Exception $e) { |
322 | } catch (\Exception $e) { |
323 | if (!$silent_error) { |
323 | if (!$silent_error) { |
324 | // Most likely an AJAX request. We can throw an Exception |
324 | // Most likely an AJAX request. We can throw an Exception |
325 | throw new OIDplusException(_L('The JWT token was rejected: %1',$e->getMessage())); |
325 | throw new OIDplusException(_L('The JWT token was rejected: %1',$e->getMessage())); |
326 | } else { |
326 | } else { |
327 | // Most likely an expired Cookie/Login session. We must not throw an Exception, otherwise we will break jsTree |
327 | // Most likely an expired Cookie/Login session. We must not throw an Exception, otherwise we will break jsTree |
328 | OIDplus::cookieUtils()->unsetcookie(self::COOKIE_NAME); |
328 | OIDplus::cookieUtils()->unsetcookie(self::COOKIE_NAME); |
329 | return null; |
329 | return null; |
330 | } |
330 | } |
331 | } |
331 | } |
332 | 332 | ||
333 | self::$contentProvider = $tmp; |
333 | self::$contentProvider = $tmp; |
334 | } |
334 | } |
335 | 335 | ||
336 | return self::$contentProvider; |
336 | return self::$contentProvider; |
337 | } |
337 | } |
338 | 338 | ||
339 | /** |
339 | /** |
340 | * @param string $email |
340 | * @param string $email |
341 | * @param string $loginfo |
341 | * @param string $loginfo |
342 | * @return void |
342 | * @return void |
343 | * @throws OIDplusException |
343 | * @throws OIDplusException |
344 | */ |
344 | */ |
345 | public function raLoginEx(string $email, string &$loginfo) { |
345 | public function raLoginEx(string $email, string &$loginfo) { |
346 | if (is_null(self::getActiveProvider())) { |
346 | if (is_null(self::getActiveProvider())) { |
347 | $this->raLogin($email); |
347 | $this->raLogin($email); |
348 | $loginfo = 'into new JWT session'; |
348 | $loginfo = 'into new JWT session'; |
349 | self::$contentProvider = $this; |
349 | self::$contentProvider = $this; |
350 | } else { |
350 | } else { |
351 | $gen = $this->getValue('oidplus_generator',-1); |
351 | $gen = $this->getValue('oidplus_generator',-1); |
352 | switch ($gen) { |
352 | switch ($gen) { |
353 | case OIDplusAuthContentStoreJWT::JWT_GENERATOR_AJAX : |
353 | case OIDplusAuthContentStoreJWT::JWT_GENERATOR_AJAX : |
354 | case OIDplusAuthContentStoreJWT::JWT_GENERATOR_REST : |
354 | case OIDplusAuthContentStoreJWT::JWT_GENERATOR_REST : |
355 | case OIDplusAuthContentStoreJWT::JWT_GENERATOR_MANUAL : |
355 | case OIDplusAuthContentStoreJWT::JWT_GENERATOR_MANUAL : |
356 | throw new OIDplusException(_L('This kind of JWT token cannot be altered. Therefore you cannot do this action.')); |
356 | throw new OIDplusException(_L('This kind of JWT token cannot be altered. Therefore you cannot do this action.')); |
357 | case OIDplusAuthContentStoreJWT::JWT_GENERATOR_LOGIN : |
357 | case OIDplusAuthContentStoreJWT::JWT_GENERATOR_LOGIN : |
358 | if (!OIDplus::baseConfig()->getValue('JWT_ALLOW_LOGIN_USER', true)) { |
358 | if (!OIDplus::baseConfig()->getValue('JWT_ALLOW_LOGIN_USER', true)) { |
359 | throw new OIDplusException(_L('You cannot add this login credential to your existing "remember me" session. You need to log-out first.')); |
359 | throw new OIDplusException(_L('You cannot add this login credential to your existing "remember me" session. You need to log-out first.')); |
360 | } |
360 | } |
361 | break; |
361 | break; |
362 | default: |
362 | default: |
363 | assert(false); // This cannot happen because jwtSecurityCheck will check for unknown generators |
363 | assert(false); // This cannot happen because jwtSecurityCheck will check for unknown generators |
364 | break; |
364 | break; |
365 | } |
365 | } |
366 | $this->raLogin($email); |
366 | $this->raLogin($email); |
367 | $loginfo = 'into existing JWT session'; |
367 | $loginfo = 'into existing JWT session'; |
368 | } |
368 | } |
369 | } |
369 | } |
370 | 370 | ||
371 | /** |
371 | /** |
372 | * @param string $loginfo |
372 | * @param string $loginfo |
373 | * @return void |
373 | * @return void |
374 | * @throws OIDplusException |
374 | * @throws OIDplusException |
375 | */ |
375 | */ |
376 | public function adminLoginEx(string &$loginfo) { |
376 | public function adminLoginEx(string &$loginfo) { |
377 | if (is_null(self::getActiveProvider())) { |
377 | if (is_null(self::getActiveProvider())) { |
378 | $this->adminLogin(); |
378 | $this->adminLogin(); |
379 | $loginfo = 'into new JWT session'; |
379 | $loginfo = 'into new JWT session'; |
380 | self::$contentProvider = $this; |
380 | self::$contentProvider = $this; |
381 | } else { |
381 | } else { |
382 | $gen = $this->getValue('oidplus_generator',-1); |
382 | $gen = $this->getValue('oidplus_generator',-1); |
383 | switch ($gen) { |
383 | switch ($gen) { |
384 | case OIDplusAuthContentStoreJWT::JWT_GENERATOR_AJAX : |
384 | case OIDplusAuthContentStoreJWT::JWT_GENERATOR_AJAX : |
385 | case OIDplusAuthContentStoreJWT::JWT_GENERATOR_REST : |
385 | case OIDplusAuthContentStoreJWT::JWT_GENERATOR_REST : |
386 | case OIDplusAuthContentStoreJWT::JWT_GENERATOR_MANUAL : |
386 | case OIDplusAuthContentStoreJWT::JWT_GENERATOR_MANUAL : |
387 | throw new OIDplusException(_L('This kind of JWT token cannot be altered. Therefore you cannot do this action.')); |
387 | throw new OIDplusException(_L('This kind of JWT token cannot be altered. Therefore you cannot do this action.')); |
388 | case OIDplusAuthContentStoreJWT::JWT_GENERATOR_LOGIN : |
388 | case OIDplusAuthContentStoreJWT::JWT_GENERATOR_LOGIN : |
389 | if (!OIDplus::baseConfig()->getValue('JWT_ALLOW_LOGIN_ADMIN', true)) { |
389 | if (!OIDplus::baseConfig()->getValue('JWT_ALLOW_LOGIN_ADMIN', true)) { |
390 | throw new OIDplusException(_L('You cannot add this login credential to your existing "remember me" session. You need to log-out first.')); |
390 | throw new OIDplusException(_L('You cannot add this login credential to your existing "remember me" session. You need to log-out first.')); |
391 | } |
391 | } |
392 | break; |
392 | break; |
393 | default: |
393 | default: |
394 | assert(false); // This cannot happen because jwtSecurityCheck will check for unknown generators |
394 | assert(false); // This cannot happen because jwtSecurityCheck will check for unknown generators |
395 | break; |
395 | break; |
396 | } |
396 | } |
397 | $this->adminLogin(); |
397 | $this->adminLogin(); |
398 | $loginfo = 'into existing JWT session'; |
398 | $loginfo = 'into existing JWT session'; |
399 | } |
399 | } |
400 | } |
400 | } |
401 | 401 | ||
402 | // Individual functions |
402 | // Individual functions |
403 | 403 | ||
404 | /** |
404 | /** |
405 | * Decode the JWT. In this step, the signature as well as EXP/NBF times will be checked |
405 | * Decode the JWT. In this step, the signature as well as EXP/NBF times will be checked |
406 | * @param string $jwt |
406 | * @param string $jwt |
407 | * @return void |
407 | * @return void |
408 | * @throws OIDplusException |
408 | * @throws OIDplusException |
409 | */ |
409 | */ |
410 | public function loadJWT(string $jwt) { |
410 | public function loadJWT(string $jwt) { |
411 | \Firebase\JWT\JWT::$leeway = 60; // leeway in seconds |
411 | \Firebase\JWT\JWT::$leeway = 60; // leeway in seconds |
412 | if (OIDplus::getPkiStatus()) { |
412 | if (OIDplus::getPkiStatus()) { |
413 | $pubKey = OIDplus::getSystemPublicKey(); |
413 | $pubKey = OIDplus::getSystemPublicKey(); |
414 | $k = new \Firebase\JWT\Key($pubKey, 'RS256'); // RSA+SHA256 ist hardcoded in getPkiStatus() generation |
414 | $k = new \Firebase\JWT\Key($pubKey, 'RS256'); // RSA+SHA256 ist hardcoded in getPkiStatus() generation |
415 | $this->content = (array) \Firebase\JWT\JWT::decode($jwt, $k); |
415 | $this->content = (array) \Firebase\JWT\JWT::decode($jwt, $k); |
416 | } else { |
416 | } else { |
417 | $key = OIDplus::baseConfig()->getValue('SERVER_SECRET', '').'/OIDplusAuthContentStoreJWT'; |
417 | $key = OIDplus::authUtils()->makeSecret('0be35e52-f4ef-11ed-b67e-3c4a92df8582'); |
418 | $key = hash_pbkdf2('sha512', $key, '', 10000, 32/*256bit*/, false); |
418 | $key = hash_pbkdf2('sha512', $key, '', 10000, 32/*256bit*/, false); |
419 | $k = new \Firebase\JWT\Key($key, 'HS512'); // HMAC+SHA512 is hardcoded here |
419 | $k = new \Firebase\JWT\Key($key, 'HS512'); // HMAC+SHA512 is hardcoded here |
420 | $this->content = (array) \Firebase\JWT\JWT::decode($jwt, $k); |
420 | $this->content = (array) \Firebase\JWT\JWT::decode($jwt, $k); |
421 | } |
421 | } |
422 | } |
422 | } |
423 | 423 | ||
424 | /** |
424 | /** |
425 | * @return string |
425 | * @return string |
426 | * @throws OIDplusException |
426 | * @throws OIDplusException |
427 | */ |
427 | */ |
428 | public function getJWTToken(): string { |
428 | public function getJWTToken(): string { |
429 | $payload = $this->content; |
429 | $payload = $this->content; |
430 | $payload["iss"] = OIDplus::getEditionInfo()['jwtaud']; |
430 | $payload["iss"] = OIDplus::getEditionInfo()['jwtaud']; |
431 | $payload["aud"] = OIDplus::getEditionInfo()['jwtaud']; |
431 | $payload["aud"] = OIDplus::getEditionInfo()['jwtaud']; |
432 | $payload["jti"] = gen_uuid(); |
432 | $payload["jti"] = gen_uuid(); |
433 | $payload["iat"] = time(); |
433 | $payload["iat"] = time(); |
434 | 434 | ||
435 | if (OIDplus::getPkiStatus()) { |
435 | if (OIDplus::getPkiStatus()) { |
436 | $privKey = OIDplus::getSystemPrivateKey(); |
436 | $privKey = OIDplus::getSystemPrivateKey(); |
437 | return \Firebase\JWT\JWT::encode($payload, $privKey, 'RS256'); // RSA+SHA256 ist hardcoded in getPkiStatus() generation |
437 | return \Firebase\JWT\JWT::encode($payload, $privKey, 'RS256'); // RSA+SHA256 ist hardcoded in getPkiStatus() generation |
438 | } else { |
438 | } else { |
439 | $key = OIDplus::baseConfig()->getValue('SERVER_SECRET', '').'/OIDplusAuthContentStoreJWT'; |
439 | $key = OIDplus::authUtils()->makeSecret('0be35e52-f4ef-11ed-b67e-3c4a92df8582'); |
440 | $key = hash_pbkdf2('sha512', $key, '', 10000, 32/*256bit*/, false); |
440 | $key = hash_pbkdf2('sha512', $key, '', 10000, 32/*256bit*/, false); |
441 | return \Firebase\JWT\JWT::encode($payload, $key, 'HS512'); // HMAC+SHA512 is hardcoded here |
441 | return \Firebase\JWT\JWT::encode($payload, $key, 'HS512'); // HMAC+SHA512 is hardcoded here |
442 | } |
442 | } |
443 | } |
443 | } |
444 | 444 | ||
445 | } |
445 | } |
446 | 446 |