| 1 |
<?php |
| 2 |
/** |
| 3 |
* Auth. |
| 4 |
* |
| 5 |
* @package WCPOS\WooCommercePOS |
| 6 |
*/ |
| 7 |
|
| 8 |
namespace WCPOS\WooCommercePOS\Services; |
| 9 |
|
| 10 |
use Exception; |
| 11 |
use WCPOS\Vendor\Firebase\JWT\JWT; |
| 12 |
use WCPOS\Vendor\Firebase\JWT\Key; |
| 13 |
use WCPOS\WooCommercePOS\Logger; |
| 14 |
use WCPOS\WooCommercePOS\Services\Settings\Access_Section; |
| 15 |
use WP_Error; |
| 16 |
use WP_User; |
| 17 |
use const DAY_IN_SECONDS; |
| 18 |
use const HOUR_IN_SECONDS; |
| 19 |
use const MINUTE_IN_SECONDS; |
| 20 |
|
| 21 |
/** |
| 22 |
* Auth Service class. |
| 23 |
*/ |
| 24 |
class Auth { |
| 25 |
/** |
| 26 |
* Maximum number of refresh-token sessions retained per user. |
| 27 |
* |
| 28 |
* Refresh tokens live for weeks and every entry carries a user agent plus parsed |
| 29 |
* device info, so without a cap the `_woocommerce_pos_refresh_tokens` row grows until |
| 30 |
* `get_user_meta()` can no longer unserialize it inside the PHP memory limit. |
| 31 |
* |
| 32 |
* This is a ceiling on ACCUMULATED CLUTTER, never a limit on how many devices may be |
| 33 |
* signed in at once: `evict_oldest_sessions()` only ever removes sessions that have |
| 34 |
* been idle for SESSION_EVICTION_IDLE_SECONDS, and lets the count exceed this number |
| 35 |
* rather than log a live device out. Two hundred covers a large merchant's real |
| 36 |
* devices with room to spare, and 200 entries serialize to roughly a hundred |
| 37 |
* kilobytes. |
| 38 |
*/ |
| 39 |
public const MAX_SESSIONS_PER_USER = 200; |
| 40 |
|
| 41 |
/** |
| 42 |
* How long a session must have gone unseen before eviction may remove it. |
| 43 |
* |
| 44 |
* The cap alone is not a safe eviction rule. A client that authenticates |
| 45 |
* programmatically mints sessions far faster than a merchant does, so "the oldest of |
| 46 |
* N" can be a session created minutes ago and still in use — and evicting it |
| 47 |
* blacklists its access token, logging a working device out mid-request. That is |
| 48 |
* exactly what happened on the shared E2E cashier after #1798 shipped a 50-session |
| 49 |
* cap. A week of silence is a long time for a till: a device seen inside that window |
| 50 |
* is treated as live and is never a candidate, whatever the count. |
| 51 |
*/ |
| 52 |
public const SESSION_EVICTION_IDLE_SECONDS = 7 * DAY_IN_SECONDS; |
| 53 |
|
| 54 |
/** |
| 55 |
* How stale a session's `last_active` may get before an authenticated request rewrites it. |
| 56 |
* |
| 57 |
* `last_active` decides what eviction may touch, so it has to reflect USE, not just |
| 58 |
* token refreshes — before this, only `refresh_access_token()` moved it, and a device |
| 59 |
* happily working through a 30-minute access token looked idle the whole time. Every |
| 60 |
* authenticated request now refreshes it, throttled to one write per session per five |
| 61 |
* minutes so the POS's request volume does not turn into a write per call. |
| 62 |
*/ |
| 63 |
private const SESSION_ACTIVITY_REFRESH_SECONDS = 5 * MINUTE_IN_SECONDS; |
| 64 |
|
| 65 |
/** |
| 66 |
* Transient prefix for the per-session "last seen" record. |
| 67 |
* |
| 68 |
* Activity is recorded OUTSIDE the session row on purpose. Writing it into the row |
| 69 |
* meant every authenticated request did a read-modify-write of the whole |
| 70 |
* `_woocommerce_pos_refresh_tokens` array, which is neither atomic nor cheap: a |
| 71 |
* request overlapping a login, logout or revoke for the same user could write back a |
| 72 |
* stale copy and erase the concurrent change — losing a session that had just been |
| 73 |
* issued, so the new client worked until its access token expired and was then refused |
| 74 |
* a refresh. Four parallel E2E shards on one cashier do exactly that. A per-session key |
| 75 |
* cannot collide with another session's write, and reading it costs no row load at all. |
| 76 |
*/ |
| 77 |
private const SESSION_SEEN_TRANSIENT_PREFIX = 'wcpos_session_seen_'; |
| 78 |
|
| 79 |
/** |
| 80 |
* Byte ceiling on the stored session row before it is discarded UNREAD. |
| 81 |
* |
| 82 |
* This is a LAST RESORT for a row no longer safe to load, not a tidy-up threshold — |
| 83 |
* discarding it signs every one of that user's devices out at once. The bar is set |
| 84 |
* from measurement rather than caution: a 9,216,730-byte row (17,000 sessions) read |
| 85 |
* fine under the 128 MB limit that produced the #1776 fatal — `get_user_meta()` cost |
| 86 |
* ~26 MB to fetch and ~38 MB with the unserialize, and it was the WRITE-BACK, at ~42 |
| 87 |
* MB more, that exhausted the request. Six megabytes therefore sits below anything |
| 88 |
* measured to be unreadable while still catching a row heading for that fatal. The |
| 89 |
* first release of this guard used one megabyte, which is comfortably readable and |
| 90 |
* threw away rows that eviction could simply have trimmed. |
| 91 |
*/ |
| 92 |
public const MAX_SESSIONS_ROW_BYTES = 6291456; |
| 93 |
|
| 94 |
/** |
| 95 |
* The single instance of the class. |
| 96 |
* |
| 97 |
* @var null|Auth |
| 98 |
*/ |
| 99 |
private static $instance = null; |
| 100 |
|
| 101 |
/** |
| 102 |
* Constructor is private to prevent direct instantiation. |
| 103 |
* Or Auth::instance() instead. |
| 104 |
*/ |
| 105 |
public function __construct() { |
| 106 |
} |
| 107 |
|
| 108 |
/** |
| 109 |
* Gets the singleton instance. |
| 110 |
* |
| 111 |
* @return Auth |
| 112 |
*/ |
| 113 |
public static function instance(): self { |
| 114 |
if ( null === self::$instance ) { |
| 115 |
self::$instance = new self(); |
| 116 |
} |
| 117 |
|
| 118 |
return self::$instance; |
| 119 |
} |
| 120 |
|
| 121 |
/** |
| 122 |
* Extract a WCPOS token from an authorization value. |
| 123 |
* |
| 124 |
* @param mixed $auth_value Authorization value. |
| 125 |
* |
| 126 |
* @return null|string |
| 127 |
*/ |
| 128 |
public function extract_token( $auth_value ): ?string { |
| 129 |
if ( ! \is_string( $auth_value ) || '' === $auth_value ) { |
| 130 |
return null; |
| 131 |
} |
| 132 |
|
| 133 |
// Match the old sscanf( 'Bearer %s' ) semantics exactly: any run of |
| 134 |
// whitespace after the scheme, token = the next non-whitespace run. |
| 135 |
if ( 1 === preg_match( '/^Bearer\s+(\S+)/', $auth_value, $matches ) ) { |
| 136 |
return $matches[1]; |
| 137 |
} |
| 138 |
|
| 139 |
return 1 === preg_match( '/^[A-Za-z0-9_-]+\.[A-Za-z0-9_-]+\.[A-Za-z0-9_-]+$/', $auth_value ) ? $auth_value : null; |
| 140 |
} |
| 141 |
|
| 142 |
/** |
| 143 |
* Authenticate the current request from its WCPOS token. |
| 144 |
* |
| 145 |
* @return false|int|WP_Error User ID, validation error, or false when no WCPOS token is present. |
| 146 |
*/ |
| 147 |
public function authenticate_request() { |
| 148 |
$auth_header = $this->get_auth_header(); |
| 149 |
$token = $this->extract_token( $auth_header ); |
| 150 |
if ( null === $token ) { |
| 151 |
return false; |
| 152 |
} |
| 153 |
|
| 154 |
$decoded_token = $this->validate_token( $token ); |
| 155 |
if ( is_wp_error( $decoded_token ) ) { |
| 156 |
return $decoded_token; |
| 157 |
} |
| 158 |
|
| 159 |
return absint( $decoded_token->data->user->id ); |
| 160 |
} |
| 161 |
|
| 162 |
/** |
| 163 |
* Get authorization header/param value. |
| 164 |
* |
| 165 |
* Checks multiple sources for the authorization token: |
| 166 |
* 1. HTTP_AUTHORIZATION server variable (standard) |
| 167 |
* 2. REDIRECT_HTTP_AUTHORIZATION (Apache CGI workaround) |
| 168 |
* 3. authorization query parameter (for servers that strip auth headers) |
| 169 |
* |
| 170 |
* @return false|string The authorization value or false if not found. |
| 171 |
*/ |
| 172 |
public function get_auth_header() { |
| 173 |
// Check HTTP_AUTHORIZATION (not empty - htaccess SetEnvIf can set empty value). |
| 174 |
if ( ! empty( $_SERVER['HTTP_AUTHORIZATION'] ) ) { |
| 175 |
return sanitize_text_field( wp_unslash( $_SERVER['HTTP_AUTHORIZATION'] ) ); |
| 176 |
} |
| 177 |
|
| 178 |
// Check REDIRECT_HTTP_AUTHORIZATION (Apache CGI). |
| 179 |
if ( ! empty( $_SERVER['REDIRECT_HTTP_AUTHORIZATION'] ) ) { |
| 180 |
return sanitize_text_field( wp_unslash( $_SERVER['REDIRECT_HTTP_AUTHORIZATION'] ) ); |
| 181 |
} |
| 182 |
|
| 183 |
// Check authorization query param. |
| 184 |
if ( ! empty( $_GET['authorization'] ) ) { |
| 185 |
return sanitize_text_field( wp_unslash( $_GET['authorization'] ) ); |
| 186 |
} |
| 187 |
|
| 188 |
return false; |
| 189 |
} |
| 190 |
|
| 191 |
/** |
| 192 |
* Generate a secret key if it doesn't exist, or return the existing one. |
| 193 |
* |
| 194 |
* @return string |
| 195 |
*/ |
| 196 |
public function get_secret_key(): string { |
| 197 |
$secret_key = get_option( 'woocommerce_pos_secret_key' ); |
| 198 |
if ( false === $secret_key || empty( $secret_key ) ) { |
| 199 |
$secret_key = wp_generate_password( 64, true, true ); |
| 200 |
update_option( 'woocommerce_pos_secret_key', $secret_key ); |
| 201 |
} |
| 202 |
|
| 203 |
return $secret_key; |
| 204 |
} |
| 205 |
|
| 206 |
/** |
| 207 |
* Get refresh token secret key (separate from access token key for security). |
| 208 |
* |
| 209 |
* @return string |
| 210 |
*/ |
| 211 |
public function get_refresh_secret_key(): string { |
| 212 |
$secret_key = get_option( 'woocommerce_pos_refresh_secret_key' ); |
| 213 |
if ( false === $secret_key || empty( $secret_key ) ) { |
| 214 |
$secret_key = wp_generate_password( 64, true, true ); |
| 215 |
update_option( 'woocommerce_pos_refresh_secret_key', $secret_key ); |
| 216 |
} |
| 217 |
|
| 218 |
return $secret_key; |
| 219 |
} |
| 220 |
|
| 221 |
/** |
| 222 |
* Validate the provided JWT token. |
| 223 |
* |
| 224 |
* @param string $token The JWT token. |
| 225 |
* @param string $token_type The token type: 'access' or 'refresh'. |
| 226 |
* |
| 227 |
* @return object|WP_Error |
| 228 |
*/ |
| 229 |
public function validate_token( $token = '', $token_type = 'access' ) { |
| 230 |
try { |
| 231 |
$secret_key = 'refresh' === $token_type ? $this->get_refresh_secret_key() : $this->get_secret_key(); |
| 232 |
$decoded_token = JWT::decode( $token, new Key( $secret_key, 'HS256' ) ); // @phpstan-ignore-line |
| 233 |
|
| 234 |
// The Token is decoded now validate the iss. |
| 235 |
if ( get_bloginfo( 'url' ) != $decoded_token->iss ) { |
| 236 |
// The iss do not match, return error. |
| 237 |
return new WP_Error( |
| 238 |
'woocommmerce_pos_auth_bad_iss', |
| 239 |
'The iss do not match with this server', |
| 240 |
array( 'status' => 403 ) |
| 241 |
); |
| 242 |
} |
| 243 |
|
| 244 |
// Validate token type. |
| 245 |
if ( ! isset( $decoded_token->type ) || $decoded_token->type !== $token_type ) { |
| 246 |
return new WP_Error( |
| 247 |
'woocommmerce_pos_auth_invalid_token_type', |
| 248 |
'Invalid token type', |
| 249 |
array( 'status' => 403 ) |
| 250 |
); |
| 251 |
} |
| 252 |
|
| 253 |
// So far so good, validate the user id in the token. |
| 254 |
if ( ! isset( $decoded_token->data->user->id ) ) { |
| 255 |
// No user id in the token, abort!! |
| 256 |
return new WP_Error( |
| 257 |
'woocommmerce_pos_auth_bad_request', |
| 258 |
'User ID not found in the token', |
| 259 |
array( |
| 260 |
'status' => 403, |
| 261 |
) |
| 262 |
); |
| 263 |
} |
| 264 |
|
| 265 |
// Check if access token is blacklisted (for instant revocation) |
| 266 |
// We check both the access token's own JTI and its parent refresh_jti. |
| 267 |
if ( 'access' === $token_type ) { |
| 268 |
// Check if this specific access token is blacklisted. |
| 269 |
if ( isset( $decoded_token->jti ) && $this->is_token_blacklisted( $decoded_token->jti ) ) { |
| 270 |
return new WP_Error( |
| 271 |
'woocommerce_pos_auth_token_revoked', |
| 272 |
'Access token has been revoked', |
| 273 |
array( 'status' => 403 ) |
| 274 |
); |
| 275 |
} |
| 276 |
|
| 277 |
// Check if the parent session (refresh token) is blacklisted |
| 278 |
// This catches ALL access tokens for a revoked session. |
| 279 |
if ( isset( $decoded_token->refresh_jti ) && $this->is_token_blacklisted( $decoded_token->refresh_jti ) ) { |
| 280 |
return new WP_Error( |
| 281 |
'woocommerce_pos_auth_session_revoked', |
| 282 |
'Session has been revoked', |
| 283 |
array( 'status' => 403 ) |
| 284 |
); |
| 285 |
} |
| 286 |
|
| 287 |
// The session is live: record that, so eviction can tell a device that is |
| 288 |
// working right now from one that has not been seen in a week. |
| 289 |
if ( isset( $decoded_token->refresh_jti ) ) { |
| 290 |
$this->touch_session_activity( |
| 291 |
absint( $decoded_token->data->user->id ), |
| 292 |
(string) $decoded_token->refresh_jti |
| 293 |
); |
| 294 |
} |
| 295 |
} |
| 296 |
|
| 297 |
// Everything looks good return the decoded token. |
| 298 |
return $decoded_token; |
| 299 |
} catch ( Exception $e ) { |
| 300 |
// Something is wrong trying to decode the token, send back the error. |
| 301 |
return new WP_Error( |
| 302 |
'woocommmerce_pos_auth_invalid_token', |
| 303 |
$e->getMessage(), |
| 304 |
array( |
| 305 |
'status' => 403, |
| 306 |
) |
| 307 |
); |
| 308 |
} |
| 309 |
} |
| 310 |
|
| 311 |
/** |
| 312 |
* Generate an access token for the provided user (short-lived). |
| 313 |
* |
| 314 |
* @param WP_User $user The user object. |
| 315 |
* @param string $refresh_jti Optional refresh token JTI to link access token to session. |
| 316 |
* |
| 317 |
* @return string|WP_Error |
| 318 |
*/ |
| 319 |
public function generate_access_token( WP_User $user, string $refresh_jti = '' ) { |
| 320 |
$token_data = $this->generate_access_token_data( $user, $refresh_jti ); |
| 321 |
|
| 322 |
if ( is_wp_error( $token_data ) ) { |
| 323 |
return $token_data; |
| 324 |
} |
| 325 |
|
| 326 |
return $token_data['token']; |
| 327 |
} |
| 328 |
|
| 329 |
/** |
| 330 |
* Generate an access token and return the token metadata used by callers. |
| 331 |
* |
| 332 |
* @param WP_User $user The user object. |
| 333 |
* @param string $refresh_jti Optional refresh token JTI to link access token to session. |
| 334 |
* |
| 335 |
* @return array|WP_Error |
| 336 |
*/ |
| 337 |
private function generate_access_token_data( WP_User $user, string $refresh_jti = '' ) { |
| 338 |
// First thing, check the secret key if not exist return a error. |
| 339 |
if ( ! $this->get_secret_key() ) { |
| 340 |
return new WP_Error( |
| 341 |
'woocommerce_pos_jwt_auth_bad_config', |
| 342 |
__( 'JWT is not configured properly, please contact the admin', 'woocommerce-pos' ), |
| 343 |
array( |
| 344 |
'status' => 403, |
| 345 |
) |
| 346 |
); |
| 347 |
} |
| 348 |
|
| 349 |
/** Valid credentials, the user exists create the according Token */ |
| 350 |
$issued_at = time(); |
| 351 |
$expire = $this->get_access_token_expire( $issued_at ); |
| 352 |
|
| 353 |
// Generate unique JTI for access token. |
| 354 |
$jti = wp_generate_uuid4(); |
| 355 |
|
| 356 |
$token = array( |
| 357 |
'iss' => get_bloginfo( 'url' ), |
| 358 |
'iat' => $issued_at, |
| 359 |
'exp' => $expire, |
| 360 |
'jti' => $jti, |
| 361 |
'type' => 'access', |
| 362 |
'data' => array( |
| 363 |
'user' => array( |
| 364 |
'id' => $user->data->ID, |
| 365 |
), |
| 366 |
), |
| 367 |
); |
| 368 |
|
| 369 |
// Link to refresh token if provided. |
| 370 |
if ( ! empty( $refresh_jti ) ) { |
| 371 |
$token['refresh_jti'] = $refresh_jti; |
| 372 |
} |
| 373 |
|
| 374 |
/* |
| 375 |
* Let the user modify the access token data before the sign. |
| 376 |
* |
| 377 |
* @param {array} $token |
| 378 |
* @param {WP_User} $user |
| 379 |
* |
| 380 |
* @returns {array} Token |
| 381 |
* |
| 382 |
* @since 1.8.0 |
| 383 |
* |
| 384 |
* @hook woocommerce_pos_jwt_access_token_before_sign |
| 385 |
*/ |
| 386 |
$payload = apply_filters( 'woocommerce_pos_jwt_access_token_before_sign', $token, $user ); |
| 387 |
$token = JWT::encode( $payload, $this->get_secret_key(), 'HS256' ); |
| 388 |
|
| 389 |
$expires_at = $this->get_payload_claim( $payload, 'exp' ); |
| 390 |
$access_jti = $this->get_payload_claim( $payload, 'jti' ); |
| 391 |
$linked_refresh_jti = $this->get_payload_claim( $payload, 'refresh_jti' ); |
| 392 |
|
| 393 |
$expires_at = null === $expires_at ? $expire : (int) $expires_at; |
| 394 |
$access_jti = null === $access_jti ? $jti : (string) $access_jti; |
| 395 |
|
| 396 |
if ( null !== $linked_refresh_jti ) { |
| 397 |
$linked_refresh_jti = (string) $linked_refresh_jti; |
| 398 |
$this->store_access_token_expiry( $user->ID, $linked_refresh_jti, $expires_at ); |
| 399 |
} |
| 400 |
|
| 401 |
return array( |
| 402 |
'token' => $token, |
| 403 |
'expires_at' => $expires_at, |
| 404 |
'jti' => $access_jti, |
| 405 |
'refresh_jti' => $linked_refresh_jti, |
| 406 |
); |
| 407 |
} |
| 408 |
|
| 409 |
/** |
| 410 |
* Generate a refresh token for the provided user (long-lived). |
| 411 |
* |
| 412 |
* @param WP_User $user The user object. |
| 413 |
* |
| 414 |
* @return string|WP_Error |
| 415 |
*/ |
| 416 |
public function generate_refresh_token( WP_User $user ) { |
| 417 |
// First thing, check the secret key if not exist return a error. |
| 418 |
if ( ! $this->get_refresh_secret_key() ) { |
| 419 |
return new WP_Error( |
| 420 |
'woocommerce_pos_jwt_auth_bad_config', |
| 421 |
__( 'JWT is not configured properly, please contact the admin', 'woocommerce-pos' ), |
| 422 |
array( |
| 423 |
'status' => 403, |
| 424 |
) |
| 425 |
); |
| 426 |
} |
| 427 |
|
| 428 |
/** Valid credentials, the user exists create the according Token */ |
| 429 |
$issued_at = time(); |
| 430 |
$expire = $this->get_refresh_token_expire( $issued_at ); |
| 431 |
|
| 432 |
// Generate unique JTI (JWT ID) for refresh token tracking. |
| 433 |
$jti = wp_generate_uuid4(); |
| 434 |
|
| 435 |
$token = array( |
| 436 |
'iss' => get_bloginfo( 'url' ), |
| 437 |
'iat' => $issued_at, |
| 438 |
'exp' => $expire, |
| 439 |
'jti' => $jti, |
| 440 |
'type' => 'refresh', |
| 441 |
'data' => array( |
| 442 |
'user' => array( |
| 443 |
'id' => $user->data->ID, |
| 444 |
), |
| 445 |
), |
| 446 |
); |
| 447 |
|
| 448 |
/** |
| 449 |
* Let the user modify the refresh token data before the sign. |
| 450 |
* |
| 451 |
* @param array $token |
| 452 |
* @param WP_User $user |
| 453 |
* |
| 454 |
* @returns array Token |
| 455 |
* |
| 456 |
* @since 1.8.0 |
| 457 |
* |
| 458 |
* @hook woocommerce_pos_jwt_refresh_token_before_sign |
| 459 |
*/ |
| 460 |
$token = JWT::encode( apply_filters( 'woocommerce_pos_jwt_refresh_token_before_sign', $token, $user ), $this->get_refresh_secret_key(), 'HS256' ); |
| 461 |
|
| 462 |
// Store refresh token JTI for potential revocation. |
| 463 |
$this->store_refresh_token_jti( $user->ID, $jti, $expire ); |
| 464 |
|
| 465 |
return $token; |
| 466 |
} |
| 467 |
|
| 468 |
/** |
| 469 |
* Generate both access and refresh tokens. |
| 470 |
* |
| 471 |
* @param WP_User $user The user object. |
| 472 |
* |
| 473 |
* @return array|WP_Error |
| 474 |
*/ |
| 475 |
public function generate_token_pair( WP_User $user ) { |
| 476 |
// Generate refresh token first to get its JTI. |
| 477 |
$refresh_token = $this->generate_refresh_token( $user ); |
| 478 |
if ( is_wp_error( $refresh_token ) ) { |
| 479 |
return $refresh_token; |
| 480 |
} |
| 481 |
|
| 482 |
// Decode to get the JTI. |
| 483 |
$decoded_refresh = $this->validate_token( $refresh_token, 'refresh' ); |
| 484 |
if ( is_wp_error( $decoded_refresh ) ) { |
| 485 |
return $decoded_refresh; |
| 486 |
} |
| 487 |
|
| 488 |
// Generate access token with link to refresh token. |
| 489 |
$access_token_data = $this->generate_access_token_data( $user, $decoded_refresh->jti ?? '' ); |
| 490 |
if ( is_wp_error( $access_token_data ) ) { |
| 491 |
return $access_token_data; |
| 492 |
} |
| 493 |
|
| 494 |
return array( |
| 495 |
'access_token' => $access_token_data['token'], |
| 496 |
'refresh_token' => $refresh_token, |
| 497 |
'token_type' => 'Bearer', |
| 498 |
'expires_at' => (int) $access_token_data['expires_at'], |
| 499 |
); |
| 500 |
} |
| 501 |
|
| 502 |
/** |
| 503 |
* Legacy method for backward compatibility. |
| 504 |
* |
| 505 |
* @deprecated Use generate_access_token() instead |
| 506 |
* |
| 507 |
* @param WP_User $user The user object. |
| 508 |
* |
| 509 |
* @return string|WP_Error |
| 510 |
*/ |
| 511 |
public function generate_token( WP_User $user ) { |
| 512 |
return $this->generate_access_token( $user ); |
| 513 |
} |
| 514 |
|
| 515 |
/** |
| 516 |
* Get user's data (minimal set for security). |
| 517 |
* |
| 518 |
* @param WP_User $user The user object. |
| 519 |
* @param bool $is_web_frontend Whether this is the web frontend context. |
| 520 |
* When true, manages web session cookie to prevent |
| 521 |
* session proliferation on page refresh. |
| 522 |
* |
| 523 |
* @return array |
| 524 |
*/ |
| 525 |
public function get_user_data( WP_User $user, bool $is_web_frontend = false ): array { |
| 526 |
// For web frontend, revoke previous session to prevent proliferation on page refresh. |
| 527 |
if ( $is_web_frontend ) { |
| 528 |
$this->cleanup_previous_web_session( $user->ID ); |
| 529 |
} |
| 530 |
|
| 531 |
$tokens = $this->generate_token_pair( $user ); |
| 532 |
if ( is_wp_error( $tokens ) ) { |
| 533 |
return array(); |
| 534 |
} |
| 535 |
|
| 536 |
// For web frontend, store the new session JTI in a cookie for cleanup on next page load. |
| 537 |
if ( $is_web_frontend ) { |
| 538 |
$this->set_web_session_cookie( $tokens['refresh_token'] ); |
| 539 |
} |
| 540 |
|
| 541 |
return array( |
| 542 |
'uuid' => Cashier::instance()->get_cashier_uuid( $user ), |
| 543 |
'id' => $user->ID, |
| 544 |
'username' => $user->user_login, |
| 545 |
'email' => $user->user_email, |
| 546 |
'first_name' => $user->user_firstname, |
| 547 |
'last_name' => $user->user_lastname, |
| 548 |
'nice_name' => $user->user_nicename, |
| 549 |
'display_name' => $user->display_name, |
| 550 |
'roles' => array_values( $user->roles ), |
| 551 |
// The helper reports effective grants, including role-editor denies. |
| 552 |
'capabilities' => Access_Section::effective_capabilities( $user ), |
| 553 |
'avatar_url' => get_avatar_url( $user->ID ), |
| 554 |
// Token data. |
| 555 |
'access_token' => $tokens['access_token'], |
| 556 |
'refresh_token' => $tokens['refresh_token'], |
| 557 |
'token_type' => $tokens['token_type'], |
| 558 |
'expires_at' => $tokens['expires_at'], |
| 559 |
); |
| 560 |
} |
| 561 |
|
| 562 |
/** |
| 563 |
* Get minimal user data for redirect (security-focused). |
| 564 |
* |
| 565 |
* @param WP_User $user The user object. |
| 566 |
* |
| 567 |
* @return array |
| 568 |
*/ |
| 569 |
public function get_redirect_data( WP_User $user ): array { |
| 570 |
$tokens = $this->generate_token_pair( $user ); |
| 571 |
if ( is_wp_error( $tokens ) ) { |
| 572 |
return array(); |
| 573 |
} |
| 574 |
|
| 575 |
// Only return essential data for redirect URL. |
| 576 |
return array( |
| 577 |
'access_token' => $tokens['access_token'], |
| 578 |
'refresh_token' => $tokens['refresh_token'], |
| 579 |
'token_type' => $tokens['token_type'], |
| 580 |
'expires_at' => $tokens['expires_at'], |
| 581 |
// Get basic user data for display, other data will be fetched from the server. |
| 582 |
'uuid' => Cashier::instance()->get_cashier_uuid( $user ), |
| 583 |
'id' => $user->ID, |
| 584 |
'display_name' => $user->display_name, |
| 585 |
); |
| 586 |
} |
| 587 |
|
| 588 |
/** |
| 589 |
* Refresh an access token using a valid refresh token. |
| 590 |
* |
| 591 |
* @param string $refresh_token The refresh token. |
| 592 |
* |
| 593 |
* @return array|WP_Error |
| 594 |
*/ |
| 595 |
public function refresh_access_token( string $refresh_token ) { |
| 596 |
$decoded = $this->validate_token( $refresh_token, 'refresh' ); |
| 597 |
if ( is_wp_error( $decoded ) ) { |
| 598 |
return $decoded; |
| 599 |
} |
| 600 |
|
| 601 |
/* |
| 602 |
* Before the first row read on this path. A refresh loads the whole session row — |
| 603 |
* `is_refresh_token_valid()` below, then `update_session_activity()` — so it needs |
| 604 |
* the same protection a login has against a row too large to read (#1776). |
| 605 |
* Validating an ACCESS token needs no such guard: it no longer touches the row. |
| 606 |
*/ |
| 607 |
$this->discard_oversized_session_row( absint( $decoded->data->user->id ) ); |
| 608 |
|
| 609 |
// Check if refresh token is still valid (not revoked). |
| 610 |
if ( ! $this->is_refresh_token_valid( $decoded->data->user->id, $decoded->jti ?? '' ) ) { |
| 611 |
return new WP_Error( |
| 612 |
'woocommerce_pos_auth_refresh_token_revoked', |
| 613 |
'Refresh token has been revoked', |
| 614 |
array( 'status' => 403 ) |
| 615 |
); |
| 616 |
} |
| 617 |
|
| 618 |
$user = get_user_by( 'id', $decoded->data->user->id ); |
| 619 |
if ( ! $user ) { |
| 620 |
return new WP_Error( |
| 621 |
'woocommerce_pos_auth_user_not_found', |
| 622 |
'User not found', |
| 623 |
array( 'status' => 404 ) |
| 624 |
); |
| 625 |
} |
| 626 |
|
| 627 |
// Update last_active timestamp for this session. |
| 628 |
$this->update_session_activity( $decoded->data->user->id, $decoded->jti ?? '' ); |
| 629 |
|
| 630 |
// Generate new access token with link to refresh token (refresh token stays the same). |
| 631 |
$new_access_token_data = $this->generate_access_token_data( $user, $decoded->jti ?? '' ); |
| 632 |
if ( is_wp_error( $new_access_token_data ) ) { |
| 633 |
return $new_access_token_data; |
| 634 |
} |
| 635 |
|
| 636 |
return array( |
| 637 |
'access_token' => $new_access_token_data['token'], |
| 638 |
'token_type' => 'Bearer', |
| 639 |
'expires_at' => (int) $new_access_token_data['expires_at'], |
| 640 |
); |
| 641 |
} |
| 642 |
|
| 643 |
/** |
| 644 |
* Revoke JWT Token by JTI. |
| 645 |
* |
| 646 |
* @param int $user_id The user ID. |
| 647 |
* @param string $jti The token JTI. |
| 648 |
* |
| 649 |
* @return bool |
| 650 |
*/ |
| 651 |
public function revoke_refresh_token( int $user_id, string $jti ): bool { |
| 652 |
$refresh_tokens = get_user_meta( $user_id, '_woocommerce_pos_refresh_tokens', true ); |
| 653 |
if ( ! \is_array( $refresh_tokens ) ) { |
| 654 |
return false; |
| 655 |
} |
| 656 |
|
| 657 |
if ( isset( $refresh_tokens[ $jti ] ) ) { |
| 658 |
unset( $refresh_tokens[ $jti ] ); |
| 659 |
update_user_meta( $user_id, '_woocommerce_pos_refresh_tokens', $refresh_tokens ); |
| 660 |
$this->forget_session_activity( $jti ); |
| 661 |
|
| 662 |
return true; |
| 663 |
} |
| 664 |
|
| 665 |
return false; |
| 666 |
} |
| 667 |
|
| 668 |
/** |
| 669 |
* Revoke all refresh tokens for a user. |
| 670 |
* |
| 671 |
* @param int $user_id The user ID. |
| 672 |
* |
| 673 |
* @return bool |
| 674 |
*/ |
| 675 |
/** |
| 676 |
* Revoke all refresh tokens for a user with blacklisting. |
| 677 |
* |
| 678 |
* @param int $user_id The user ID. |
| 679 |
* |
| 680 |
* @return bool |
| 681 |
*/ |
| 682 |
public function revoke_all_refresh_tokens( int $user_id ): bool { |
| 683 |
$refresh_tokens = get_user_meta( $user_id, '_woocommerce_pos_refresh_tokens', true ); |
| 684 |
|
| 685 |
// Blacklist all sessions for instant access token invalidation. |
| 686 |
if ( \is_array( $refresh_tokens ) ) { |
| 687 |
$issued_at = time(); |
| 688 |
$access_expire = $this->get_access_token_expire( $issued_at ); |
| 689 |
|
| 690 |
foreach ( $refresh_tokens as $jti => $token_data ) { |
| 691 |
$ttl = $this->get_access_token_blacklist_ttl( $token_data, $issued_at, $access_expire ); |
| 692 |
$this->blacklist_token( $jti, $ttl ); |
| 693 |
$this->forget_session_activity( (string) $jti ); |
| 694 |
} |
| 695 |
} |
| 696 |
|
| 697 |
return delete_user_meta( $user_id, '_woocommerce_pos_refresh_tokens' ); |
| 698 |
} |
| 699 |
|
| 700 |
/** |
| 701 |
* Get all active sessions for a user. |
| 702 |
* |
| 703 |
* @param int $user_id The user ID. |
| 704 |
* |
| 705 |
* @return array |
| 706 |
*/ |
| 707 |
public function get_user_sessions( int $user_id ): array { |
| 708 |
$refresh_tokens = get_user_meta( $user_id, '_woocommerce_pos_refresh_tokens', true ); |
| 709 |
if ( ! \is_array( $refresh_tokens ) ) { |
| 710 |
return array(); |
| 711 |
} |
| 712 |
|
| 713 |
$sessions = array(); |
| 714 |
$current_time = time(); |
| 715 |
|
| 716 |
foreach ( $refresh_tokens as $jti => $token_data ) { |
| 717 |
// Skip expired sessions. |
| 718 |
if ( $token_data['expires'] <= $current_time ) { |
| 719 |
continue; |
| 720 |
} |
| 721 |
|
| 722 |
$sessions[] = array( |
| 723 |
'jti' => $jti, |
| 724 |
'created' => $token_data['created'] ?? $current_time, |
| 725 |
'last_active' => $token_data['last_active'] ?? $token_data['created'] ?? $current_time, |
| 726 |
'expires' => $token_data['expires'], |
| 727 |
'ip_address' => $token_data['ip_address'] ?? '', |
| 728 |
'user_agent' => $token_data['user_agent'] ?? '', |
| 729 |
'device_info' => $token_data['device_info'] ?? array(), |
| 730 |
); |
| 731 |
} |
| 732 |
|
| 733 |
// Sort by last_active descending (most recent first). |
| 734 |
usort( |
| 735 |
$sessions, |
| 736 |
function ( $a, $b ) { |
| 737 |
return $b['last_active'] - $a['last_active']; |
| 738 |
} |
| 739 |
); |
| 740 |
|
| 741 |
return $sessions; |
| 742 |
} |
| 743 |
|
| 744 |
/** |
| 745 |
* Revoke a specific session by JTI (alias for revoke_refresh_token for clarity). |
| 746 |
* |
| 747 |
* @param int $user_id The user ID. |
| 748 |
* @param string $jti The token JTI. |
| 749 |
* |
| 750 |
* @return bool |
| 751 |
*/ |
| 752 |
public function revoke_session( int $user_id, string $jti ): bool { |
| 753 |
return $this->revoke_refresh_token( $user_id, $jti ); |
| 754 |
} |
| 755 |
|
| 756 |
/** |
| 757 |
* Revoke all sessions except the current one. |
| 758 |
* |
| 759 |
* @param int $user_id The user ID. |
| 760 |
* @param string $current_jti The current token JTI. |
| 761 |
* |
| 762 |
* @return bool |
| 763 |
*/ |
| 764 |
/** |
| 765 |
* Revoke all sessions except the current one, with blacklisting. |
| 766 |
* |
| 767 |
* @param int $user_id The user ID. |
| 768 |
* @param string $current_jti The current token JTI. |
| 769 |
* |
| 770 |
* @return bool |
| 771 |
*/ |
| 772 |
public function revoke_all_sessions_except( int $user_id, string $current_jti ): bool { |
| 773 |
$refresh_tokens = get_user_meta( $user_id, '_woocommerce_pos_refresh_tokens', true ); |
| 774 |
if ( ! \is_array( $refresh_tokens ) ) { |
| 775 |
return false; |
| 776 |
} |
| 777 |
|
| 778 |
// Blacklist all sessions except current for instant access token invalidation. |
| 779 |
$issued_at = time(); |
| 780 |
$access_expire = $this->get_access_token_expire( $issued_at ); |
| 781 |
|
| 782 |
foreach ( $refresh_tokens as $jti => $token_data ) { |
| 783 |
if ( $jti !== $current_jti ) { |
| 784 |
$ttl = $this->get_access_token_blacklist_ttl( $token_data, $issued_at, $access_expire ); |
| 785 |
$this->blacklist_token( $jti, $ttl ); |
| 786 |
$this->forget_session_activity( (string) $jti ); |
| 787 |
} |
| 788 |
} |
| 789 |
|
| 790 |
// Keep only the current session in user meta. |
| 791 |
$refresh_tokens = array_filter( |
| 792 |
$refresh_tokens, |
| 793 |
function ( $_token, $jti ) use ( $current_jti ) { |
| 794 |
return $jti === $current_jti; |
| 795 |
}, |
| 796 |
ARRAY_FILTER_USE_BOTH |
| 797 |
); |
| 798 |
|
| 799 |
return update_user_meta( $user_id, '_woocommerce_pos_refresh_tokens', $refresh_tokens ); |
| 800 |
} |
| 801 |
|
| 802 |
/** |
| 803 |
* Update last_active timestamp for a session. |
| 804 |
* |
| 805 |
* @param int $user_id The user ID. |
| 806 |
* @param string $jti The token JTI. |
| 807 |
* |
| 808 |
* @return bool |
| 809 |
*/ |
| 810 |
public function update_session_activity( int $user_id, string $jti ): bool { |
| 811 |
// Public surface: any caller reaching the row goes through the size guard first. |
| 812 |
$this->discard_oversized_session_row( $user_id ); |
| 813 |
|
| 814 |
$refresh_tokens = get_user_meta( $user_id, '_woocommerce_pos_refresh_tokens', true ); |
| 815 |
if ( ! \is_array( $refresh_tokens ) || ! isset( $refresh_tokens[ $jti ] ) ) { |
| 816 |
return false; |
| 817 |
} |
| 818 |
|
| 819 |
$refresh_tokens[ $jti ]['last_active'] = time(); |
| 820 |
|
| 821 |
return update_user_meta( $user_id, '_woocommerce_pos_refresh_tokens', $refresh_tokens ); |
| 822 |
} |
| 823 |
|
| 824 |
/** |
| 825 |
* Refresh a session's `last_active`, at most once every few minutes. |
| 826 |
* |
| 827 |
* Called from token validation, so it runs on EVERY authenticated request. The |
| 828 |
* throttle is what makes that affordable: the value only has to be accurate to within |
| 829 |
* minutes for a rule that asks whether a session has been unseen for a week, and the |
| 830 |
* read is already in the user's meta cache by this point. |
| 831 |
* |
| 832 |
* @param int $user_id The user ID. |
| 833 |
* @param string $jti Refresh token JTI (session identifier). |
| 834 |
*/ |
| 835 |
private function touch_session_activity( int $user_id, string $jti ): void { |
| 836 |
if ( 0 === $user_id || '' === $jti ) { |
| 837 |
return; |
| 838 |
} |
| 839 |
|
| 840 |
$key = self::SESSION_SEEN_TRANSIENT_PREFIX . $jti; |
| 841 |
$seen = get_transient( $key ); |
| 842 |
|
| 843 |
// The throttle reads the transient, never the session row: this runs on every |
| 844 |
// authenticated request, and the row is the one thing this path must not touch. |
| 845 |
if ( is_numeric( $seen ) && time() - (int) $seen < self::SESSION_ACTIVITY_REFRESH_SECONDS ) { |
| 846 |
return; |
| 847 |
} |
| 848 |
|
| 849 |
// The TTL IS the idle window, so a missing transient means "not seen in a week". |
| 850 |
set_transient( $key, time(), self::SESSION_EVICTION_IDLE_SECONDS ); |
| 851 |
} |
| 852 |
|
| 853 |
/** |
| 854 |
* Forget a session's recorded activity. |
| 855 |
* |
| 856 |
* @param string $jti Refresh token JTI (session identifier). |
| 857 |
*/ |
| 858 |
private function forget_session_activity( string $jti ): void { |
| 859 |
if ( '' !== $jti ) { |
| 860 |
delete_transient( self::SESSION_SEEN_TRANSIENT_PREFIX . $jti ); |
| 861 |
} |
| 862 |
} |
| 863 |
|
| 864 |
/** |
| 865 |
* Check if the current user can manage sessions for the target user. |
| 866 |
* |
| 867 |
* @param int $target_user_id The target user ID. |
| 868 |
* |
| 869 |
* @return bool |
| 870 |
*/ |
| 871 |
public function can_manage_user_sessions( int $target_user_id ): bool { |
| 872 |
$current_user_id = get_current_user_id(); |
| 873 |
|
| 874 |
// User can manage their own sessions. |
| 875 |
if ( $current_user_id === $target_user_id ) { |
| 876 |
return true; |
| 877 |
} |
| 878 |
|
| 879 |
// Administrators can manage anyone's sessions. |
| 880 |
if ( current_user_can( 'manage_options' ) ) { |
| 881 |
return true; |
| 882 |
} |
| 883 |
|
| 884 |
// Shop managers can manage anyone's sessions. |
| 885 |
if ( current_user_can( 'manage_woocommerce' ) ) { |
| 886 |
return true; |
| 887 |
} |
| 888 |
|
| 889 |
return false; |
| 890 |
} |
| 891 |
|
| 892 |
/** |
| 893 |
* Blacklist a token JTI (for instant revocation). |
| 894 |
* |
| 895 |
* Can be used for access token JTIs or refresh token JTIs (session). |
| 896 |
* When a refresh_jti is blacklisted, all access tokens linked to it |
| 897 |
* become invalid. |
| 898 |
* |
| 899 |
* @param string $jti Token JTI to blacklist. |
| 900 |
* @param int $ttl Time to live in seconds. |
| 901 |
* |
| 902 |
* @return bool |
| 903 |
*/ |
| 904 |
public function blacklist_token( string $jti, int $ttl ): bool { |
| 905 |
if ( empty( $jti ) ) { |
| 906 |
return false; |
| 907 |
} |
| 908 |
|
| 909 |
// Use transient with TTL matching token expiration. |
| 910 |
return set_transient( "wcpos_blacklist_{$jti}", true, $ttl ); |
| 911 |
} |
| 912 |
|
| 913 |
/** |
| 914 |
* Revoke session and blacklist it for instant access token invalidation. |
| 915 |
* |
| 916 |
* By blacklisting the refresh_jti, ALL access tokens linked to this session |
| 917 |
* become immediately invalid (they contain refresh_jti in their payload). |
| 918 |
* |
| 919 |
* @param int $user_id The user ID. |
| 920 |
* @param string $refresh_jti Refresh token JTI (session identifier). |
| 921 |
* |
| 922 |
* @return bool |
| 923 |
*/ |
| 924 |
public function revoke_session_with_blacklist( int $user_id, string $refresh_jti ): bool { |
| 925 |
$refresh_tokens = get_user_meta( $user_id, '_woocommerce_pos_refresh_tokens', true ); |
| 926 |
$session_data = \is_array( $refresh_tokens ) && isset( $refresh_tokens[ $refresh_jti ] ) ? $refresh_tokens[ $refresh_jti ] : array(); |
| 927 |
$ttl = $this->get_access_token_blacklist_ttl( $session_data ); |
| 928 |
|
| 929 |
// Revoke the refresh token (session) from user meta. |
| 930 |
$revoked = $this->revoke_session( $user_id, $refresh_jti ); |
| 931 |
|
| 932 |
if ( $revoked ) { |
| 933 |
// Blacklist the session JTI - this invalidates ALL access tokens for this session |
| 934 |
// TTL covers the current policy and any access token expiry recorded for the session. |
| 935 |
$this->blacklist_token( $refresh_jti, $ttl ); |
| 936 |
} |
| 937 |
|
| 938 |
return $revoked; |
| 939 |
} |
| 940 |
|
| 941 |
/** |
| 942 |
* Store refresh token JTI for tracking/revocation. |
| 943 |
* |
| 944 |
* @param int $user_id The user ID. |
| 945 |
* @param string $jti The token JTI. |
| 946 |
* @param int $expires The expiration timestamp. |
| 947 |
* @param null|Session_Context $context Request state the session is recorded |
| 948 |
* against. Defaults to the current request. |
| 949 |
*/ |
| 950 |
private function store_refresh_token_jti( int $user_id, string $jti, int $expires, ?Session_Context $context = null ): void { |
| 951 |
$context = null === $context ? Session_Context::from_request() : $context; |
| 952 |
|
| 953 |
// BEFORE the read: a pre-cap row can be too large to load, and this is the first |
| 954 |
// point in the login flow where WCPOS knows the user id. |
| 955 |
$this->discard_oversized_session_row( $user_id ); |
| 956 |
|
| 957 |
$refresh_tokens = get_user_meta( $user_id, '_woocommerce_pos_refresh_tokens', true ); |
| 958 |
if ( ! \is_array( $refresh_tokens ) ) { |
| 959 |
$refresh_tokens = array(); |
| 960 |
} |
| 961 |
|
| 962 |
// Clean up expired tokens. |
| 963 |
$refresh_tokens = array_filter( |
| 964 |
$refresh_tokens, |
| 965 |
function ( $token ) { |
| 966 |
return $token['expires'] > time(); |
| 967 |
} |
| 968 |
); |
| 969 |
|
| 970 |
// Capture session metadata. |
| 971 |
$current_time = time(); |
| 972 |
$ip_address = $context->get_ip(); |
| 973 |
$user_agent = $context->get_user_agent(); |
| 974 |
$device_info = $this->parse_user_agent( $user_agent ); |
| 975 |
|
| 976 |
// Check for explicit platform declaration from native apps (passed as a param in the auth request). |
| 977 |
$platform = $context->get_platform(); |
| 978 |
$version = $context->get_version(); |
| 979 |
$build = $context->get_build(); |
| 980 |
|
| 981 |
// Override app_type if platform was explicitly provided by the client. |
| 982 |
if ( \in_array( $platform, array( 'ios', 'android', 'electron', 'web' ), true ) ) { |
| 983 |
$device_info['app_type'] = 'web' === $platform ? 'web' : $platform . '_app'; |
| 984 |
|
| 985 |
// Set appropriate device type based on platform. |
| 986 |
if ( 'ios' === $platform || 'android' === $platform ) { |
| 987 |
$device_info['device_type'] = 'tablet'; // Default to tablet for mobile apps. |
| 988 |
} elseif ( 'electron' === $platform ) { |
| 989 |
$device_info['device_type'] = 'desktop'; |
| 990 |
} |
| 991 |
|
| 992 |
// Use version from param if provided. |
| 993 |
if ( ! empty( $version ) ) { |
| 994 |
$device_info['browser_version'] = $version; |
| 995 |
} |
| 996 |
|
| 997 |
// Store build number if provided. |
| 998 |
if ( ! empty( $build ) ) { |
| 999 |
$device_info['build'] = $build; |
| 1000 |
} |
| 1001 |
|
| 1002 |
// Set browser to WooCommerce POS for native apps. |
| 1003 |
if ( 'web' !== $platform ) { |
| 1004 |
$device_info['browser'] = 'WooCommerce POS'; |
| 1005 |
} |
| 1006 |
} |
| 1007 |
|
| 1008 |
// Add new token with metadata. |
| 1009 |
$refresh_tokens[ $jti ] = array( |
| 1010 |
'expires' => $expires, |
| 1011 |
'created' => $current_time, |
| 1012 |
'last_active' => $current_time, |
| 1013 |
'ip_address' => $ip_address, |
| 1014 |
'user_agent' => $user_agent, |
| 1015 |
'device_info' => $device_info, |
| 1016 |
); |
| 1017 |
|
| 1018 |
// Cap the number of stored sessions so programmatic clients cannot grow the row without bound. |
| 1019 |
$refresh_tokens = $this->evict_oldest_sessions( $refresh_tokens, $jti ); |
| 1020 |
|
| 1021 |
update_user_meta( $user_id, '_woocommerce_pos_refresh_tokens', $refresh_tokens ); |
| 1022 |
} |
| 1023 |
|
| 1024 |
/** |
| 1025 |
* Drop the least recently active sessions until the per-user cap is met. |
| 1026 |
* |
| 1027 |
* Evicted sessions are blacklisted the same way revoke_all_sessions_except() does, so the |
| 1028 |
* device that lost its slot is cleanly logged out instead of keeping a working access token |
| 1029 |
* for the remainder of that token's life. |
| 1030 |
* |
| 1031 |
* @param array $refresh_tokens Stored sessions keyed by refresh token JTI. |
| 1032 |
* @param string $protected_jti JTI that must never be evicted (the session being stored). |
| 1033 |
* |
| 1034 |
* @return array The sessions to persist. |
| 1035 |
*/ |
| 1036 |
private function evict_oldest_sessions( array $refresh_tokens, string $protected_jti ): array { |
| 1037 |
$evict_count = \count( $refresh_tokens ) - self::MAX_SESSIONS_PER_USER; |
| 1038 |
if ( $evict_count <= 0 ) { |
| 1039 |
return $refresh_tokens; |
| 1040 |
} |
| 1041 |
|
| 1042 |
$issued_at = time(); |
| 1043 |
$idle_before = $issued_at - self::SESSION_EVICTION_IDLE_SECONDS; |
| 1044 |
|
| 1045 |
/* |
| 1046 |
* Order eviction candidates oldest-first. The insertion index breaks ties explicitly |
| 1047 |
* because usort() is not stable before PHP 8.0 and bulk logins share a timestamp. |
| 1048 |
* |
| 1049 |
* A session seen within SESSION_EVICTION_IDLE_SECONDS is NOT a candidate at any |
| 1050 |
* count. Being the oldest of N says nothing about being unused when N sessions were |
| 1051 |
* minted in an hour, and evicting a live one blacklists a working device's access |
| 1052 |
* token. The cap yields to that: a user whose sessions are all recent keeps them |
| 1053 |
* all, and the row stays bounded by MAX_SESSIONS_ROW_BYTES instead. |
| 1054 |
*/ |
| 1055 |
$candidates = array(); |
| 1056 |
$index = 0; |
| 1057 |
foreach ( $refresh_tokens as $candidate_jti => $token_data ) { |
| 1058 |
$position = $index++; |
| 1059 |
if ( (string) $candidate_jti === $protected_jti ) { |
| 1060 |
continue; |
| 1061 |
} |
| 1062 |
|
| 1063 |
// The ROW timestamp is the cheap filter. It is authoritative when it says a |
| 1064 |
// session is live, because login and refresh both write it; when it says idle |
| 1065 |
// the activity transient still gets the final word, below. |
| 1066 |
$activity = $this->session_row_last_seen( $token_data ); |
| 1067 |
if ( $activity > $idle_before ) { |
| 1068 |
continue; |
| 1069 |
} |
| 1070 |
|
| 1071 |
$candidates[] = array( |
| 1072 |
'jti' => (string) $candidate_jti, |
| 1073 |
'activity' => $activity, |
| 1074 |
'index' => $position, |
| 1075 |
); |
| 1076 |
} |
| 1077 |
|
| 1078 |
usort( |
| 1079 |
$candidates, |
| 1080 |
function ( $a, $b ) { |
| 1081 |
if ( $a['activity'] === $b['activity'] ) { |
| 1082 |
return $a['index'] <=> $b['index']; |
| 1083 |
} |
| 1084 |
|
| 1085 |
return $a['activity'] <=> $b['activity']; |
| 1086 |
} |
| 1087 |
); |
| 1088 |
|
| 1089 |
foreach ( $candidates as $candidate ) { |
| 1090 |
if ( $evict_count <= 0 ) { |
| 1091 |
break; |
| 1092 |
} |
| 1093 |
|
| 1094 |
// Checked only for rows already stale, so this costs a handful of transient |
| 1095 |
// reads rather than one per stored session. |
| 1096 |
if ( $this->session_last_seen( $candidate['jti'], $refresh_tokens[ $candidate['jti'] ] ) > $idle_before ) { |
| 1097 |
continue; |
| 1098 |
} |
| 1099 |
|
| 1100 |
/* |
| 1101 |
* Blacklist ONLY a session that can still hold a live access token. An eviction |
| 1102 |
* is not a revoke: clearing a bloated row can drop thousands of long-dead |
| 1103 |
* sessions at once, and a transient for each would guard nothing — an expired |
| 1104 |
* access token is already rejected on its own `exp` claim, and the refresh token |
| 1105 |
* dies with the meta entry (`is_refresh_token_valid()` requires the entry). This |
| 1106 |
* also bounds each transient this path writes to one access-token lifetime, |
| 1107 |
* rather than the refresh-token expiry `get_access_token_blacklist_ttl()` falls |
| 1108 |
* back to for a session with no recorded access-token expiry. |
| 1109 |
*/ |
| 1110 |
$horizon = $this->access_token_horizon( $refresh_tokens[ $candidate['jti'] ] ); |
| 1111 |
if ( $horizon > $issued_at ) { |
| 1112 |
$this->blacklist_token( $candidate['jti'], $horizon - $issued_at ); |
| 1113 |
} |
| 1114 |
|
| 1115 |
$this->forget_session_activity( $candidate['jti'] ); |
| 1116 |
unset( $refresh_tokens[ $candidate['jti'] ] ); |
| 1117 |
--$evict_count; |
| 1118 |
} |
| 1119 |
|
| 1120 |
return $refresh_tokens; |
| 1121 |
} |
| 1122 |
|
| 1123 |
/** |
| 1124 |
* When a session was last seen, taking the later of the row and the activity record. |
| 1125 |
* |
| 1126 |
* The row is rewritten by login and refresh; the transient is written by ordinary |
| 1127 |
* authenticated requests. Neither alone is the whole picture — a device working through |
| 1128 |
* a long-lived access token has an old row timestamp and a fresh transient, and a |
| 1129 |
* session that has not been used at all has the reverse. |
| 1130 |
* |
| 1131 |
* @param string $jti Refresh token JTI (session identifier). |
| 1132 |
* @param array $token_data Stored session record. |
| 1133 |
* |
| 1134 |
* @return int Unix timestamp; 0 when neither source carries a usable timestamp. |
| 1135 |
*/ |
| 1136 |
private function session_last_seen( string $jti, array $token_data ): int { |
| 1137 |
$row_seen = $this->session_row_last_seen( $token_data ); |
| 1138 |
$seen = '' === $jti ? false : get_transient( self::SESSION_SEEN_TRANSIENT_PREFIX . $jti ); |
| 1139 |
|
| 1140 |
return is_numeric( $seen ) ? max( $row_seen, (int) $seen ) : $row_seen; |
| 1141 |
} |
| 1142 |
|
| 1143 |
/** |
| 1144 |
* When the stored record itself says a session was last seen. |
| 1145 |
* |
| 1146 |
* Login and refresh both rewrite `last_active` in the row, so this stays accurate for |
| 1147 |
* everything except the stretch between refreshes — which is what the activity |
| 1148 |
* transient covers. |
| 1149 |
* |
| 1150 |
* @param array $token_data Stored session record. |
| 1151 |
* |
| 1152 |
* @return int Unix timestamp; 0 when the record carries no usable timestamp. |
| 1153 |
*/ |
| 1154 |
private function session_row_last_seen( array $token_data ): int { |
| 1155 |
if ( isset( $token_data['last_active'] ) ) { |
| 1156 |
return (int) $token_data['last_active']; |
| 1157 |
} |
| 1158 |
|
| 1159 |
if ( isset( $token_data['created'] ) ) { |
| 1160 |
return (int) $token_data['created']; |
| 1161 |
} |
| 1162 |
|
| 1163 |
return 0; |
| 1164 |
} |
| 1165 |
|
| 1166 |
/** |
| 1167 |
* The last moment an access token minted against a session can still validate. |
| 1168 |
* |
| 1169 |
* @param array $token_data Stored session record. |
| 1170 |
* |
| 1171 |
* @return int Unix timestamp; 0 when the session carries no usable timestamp at all. |
| 1172 |
*/ |
| 1173 |
private function access_token_horizon( array $token_data ): int { |
| 1174 |
if ( isset( $token_data['access_expires'] ) ) { |
| 1175 |
return (int) $token_data['access_expires']; |
| 1176 |
} |
| 1177 |
|
| 1178 |
// Rows written before `access_expires` was recorded. The newest access token such a |
| 1179 |
// session can hold was minted no later than its last recorded activity, so one |
| 1180 |
// access-token lifetime past that moment is the outside limit. |
| 1181 |
$last_seen = $this->session_row_last_seen( $token_data ); |
| 1182 |
|
| 1183 |
return $last_seen > 0 ? $this->get_access_token_expire( $last_seen ) : 0; |
| 1184 |
} |
| 1185 |
|
| 1186 |
/** |
| 1187 |
* Drop the stored session row when it is too large to be read safely. |
| 1188 |
* |
| 1189 |
* A LAST RESORT, not a tidy-up: discarding the row signs every one of that user's |
| 1190 |
* devices out at once, so the ceiling is set above anything measured to be readable |
| 1191 |
* (see MAX_SESSIONS_ROW_BYTES) and everything below it is TRIMMED by |
| 1192 |
* `evict_oldest_sessions()` on the same write instead. What this catches is the one |
| 1193 |
* case trimming cannot: a row so large that reading it exhausts the request before any |
| 1194 |
* of the code below runs, which — because that read happens on every login — locks the |
| 1195 |
* user out permanently (#1776). `LENGTH()` lets MySQL answer with a number instead of |
| 1196 |
* the value, so the size is checked without paying for the row. |
| 1197 |
* |
| 1198 |
* @param int $user_id The user ID. |
| 1199 |
*/ |
| 1200 |
private function discard_oversized_session_row( int $user_id ): void { |
| 1201 |
global $wpdb; |
| 1202 |
|
| 1203 |
$rows = $wpdb->get_results( |
| 1204 |
$wpdb->prepare( |
| 1205 |
"SELECT umeta_id, LENGTH(meta_value) AS meta_bytes FROM {$wpdb->usermeta} WHERE user_id = %d AND meta_key = %s", |
| 1206 |
$user_id, |
| 1207 |
'_woocommerce_pos_refresh_tokens' |
| 1208 |
) |
| 1209 |
); |
| 1210 |
|
| 1211 |
if ( empty( $rows ) ) { |
| 1212 |
return; |
| 1213 |
} |
| 1214 |
|
| 1215 |
$bytes = 0; |
| 1216 |
foreach ( $rows as $row ) { |
| 1217 |
$bytes += (int) $row->meta_bytes; |
| 1218 |
} |
| 1219 |
|
| 1220 |
if ( $bytes <= self::MAX_SESSIONS_ROW_BYTES ) { |
| 1221 |
return; |
| 1222 |
} |
| 1223 |
|
| 1224 |
foreach ( $rows as $row ) { |
| 1225 |
$wpdb->delete( $wpdb->usermeta, array( 'umeta_id' => (int) $row->umeta_id ), array( '%d' ) ); |
| 1226 |
} |
| 1227 |
|
| 1228 |
// The row may already be sitting in the user's meta cache from an earlier |
| 1229 |
// `get_user_meta()` in this request; without this the next read serves the value |
| 1230 |
// that was just deleted. |
| 1231 |
wp_cache_delete( $user_id, 'user_meta' ); |
| 1232 |
|
| 1233 |
Logger::warning( |
| 1234 |
sprintf( |
| 1235 |
'Discarded an unreadable WCPOS session row for user %d (%d bytes, ceiling %d). The row was too large to load safely, so every POS session for this user has been logged out once; it is rebuilt, capped, on this login.', |
| 1236 |
$user_id, |
| 1237 |
$bytes, |
| 1238 |
self::MAX_SESSIONS_ROW_BYTES |
| 1239 |
) |
| 1240 |
); |
| 1241 |
} |
| 1242 |
|
| 1243 |
/** |
| 1244 |
* Filters the JWT access token expire time. |
| 1245 |
* Default: 30 minutes for access tokens. |
| 1246 |
* |
| 1247 |
* @param int $issued_at Token issued timestamp. |
| 1248 |
* |
| 1249 |
* @return int Expire time. |
| 1250 |
* |
| 1251 |
* @since 1.8.0 |
| 1252 |
* |
| 1253 |
* @hook woocommerce_pos_jwt_access_token_expire |
| 1254 |
*/ |
| 1255 |
private function get_access_token_expire( int $issued_at ): int { |
| 1256 |
return (int) apply_filters( 'woocommerce_pos_jwt_access_token_expire', $issued_at + ( HOUR_IN_SECONDS / 2 ), $issued_at ); |
| 1257 |
} |
| 1258 |
|
| 1259 |
/** |
| 1260 |
* Filters the JWT refresh token expire time. |
| 1261 |
* Default: 30 days for refresh tokens. |
| 1262 |
* |
| 1263 |
* @param int $issued_at Token issued timestamp. |
| 1264 |
* |
| 1265 |
* @return int Expire time. |
| 1266 |
* |
| 1267 |
* @since 1.8.0 |
| 1268 |
* |
| 1269 |
* @hook woocommerce_pos_jwt_refresh_token_expire |
| 1270 |
*/ |
| 1271 |
private function get_refresh_token_expire( int $issued_at ): int { |
| 1272 |
return (int) apply_filters( 'woocommerce_pos_jwt_refresh_token_expire', $issued_at + ( DAY_IN_SECONDS * 30 ), $issued_at ); |
| 1273 |
} |
| 1274 |
|
| 1275 |
/** |
| 1276 |
* Read a top-level claim from a JWT payload array/object. |
| 1277 |
* |
| 1278 |
* @param mixed $payload The filtered JWT payload. |
| 1279 |
* @param string $claim The claim name. |
| 1280 |
* |
| 1281 |
* @return mixed|null |
| 1282 |
*/ |
| 1283 |
private function get_payload_claim( $payload, string $claim ) { |
| 1284 |
if ( \is_array( $payload ) && array_key_exists( $claim, $payload ) ) { |
| 1285 |
return $payload[ $claim ]; |
| 1286 |
} |
| 1287 |
|
| 1288 |
if ( \is_object( $payload ) && isset( $payload->{$claim} ) ) { |
| 1289 |
return $payload->{$claim}; |
| 1290 |
} |
| 1291 |
|
| 1292 |
return null; |
| 1293 |
} |
| 1294 |
|
| 1295 |
/** |
| 1296 |
* Record the latest access token expiry linked to a refresh-token session. |
| 1297 |
* |
| 1298 |
* @param int $user_id The user ID. |
| 1299 |
* @param string $refresh_jti Refresh token JTI. |
| 1300 |
* @param int $access_expires Access token expiry timestamp. |
| 1301 |
* |
| 1302 |
* @return bool |
| 1303 |
*/ |
| 1304 |
private function store_access_token_expiry( int $user_id, string $refresh_jti, int $access_expires ): bool { |
| 1305 |
if ( empty( $refresh_jti ) || $access_expires <= 0 ) { |
| 1306 |
return false; |
| 1307 |
} |
| 1308 |
|
| 1309 |
$refresh_tokens = get_user_meta( $user_id, '_woocommerce_pos_refresh_tokens', true ); |
| 1310 |
if ( ! \is_array( $refresh_tokens ) || ! isset( $refresh_tokens[ $refresh_jti ] ) ) { |
| 1311 |
return false; |
| 1312 |
} |
| 1313 |
|
| 1314 |
$current_access_expires = isset( $refresh_tokens[ $refresh_jti ]['access_expires'] ) ? (int) $refresh_tokens[ $refresh_jti ]['access_expires'] : 0; |
| 1315 |
if ( $access_expires <= $current_access_expires ) { |
| 1316 |
return true; |
| 1317 |
} |
| 1318 |
|
| 1319 |
$refresh_tokens[ $refresh_jti ]['access_expires'] = $access_expires; |
| 1320 |
|
| 1321 |
return update_user_meta( $user_id, '_woocommerce_pos_refresh_tokens', $refresh_tokens ); |
| 1322 |
} |
| 1323 |
|
| 1324 |
/** |
| 1325 |
* Calculate blacklist TTL for a session. |
| 1326 |
* |
| 1327 |
* @param array $session_data Session metadata. |
| 1328 |
* @param null|int $issued_at Current timestamp. |
| 1329 |
* @param null|int $access_expire Current access token expiry policy value. |
| 1330 |
* |
| 1331 |
* @return int |
| 1332 |
*/ |
| 1333 |
private function get_access_token_blacklist_ttl( |
| 1334 |
array $session_data = array(), |
| 1335 |
?int $issued_at = null, |
| 1336 |
?int $access_expire = null |
| 1337 |
): int { |
| 1338 |
$issued_at = null === $issued_at ? time() : $issued_at; |
| 1339 |
$access_expire = null === $access_expire ? $this->get_access_token_expire( $issued_at ) : $access_expire; |
| 1340 |
|
| 1341 |
if ( isset( $session_data['access_expires'] ) ) { |
| 1342 |
$access_expire = max( $access_expire, (int) $session_data['access_expires'] ); |
| 1343 |
} elseif ( isset( $session_data['expires'] ) ) { |
| 1344 |
$access_expire = max( $access_expire, (int) $session_data['expires'] ); |
| 1345 |
} |
| 1346 |
|
| 1347 |
return max( 0, $access_expire - $issued_at ); |
| 1348 |
} |
| 1349 |
|
| 1350 |
/** |
| 1351 |
* Check if refresh token is still valid (not revoked). |
| 1352 |
* |
| 1353 |
* @param int $user_id The user ID. |
| 1354 |
* @param string $jti The token JTI. |
| 1355 |
* |
| 1356 |
* @return bool |
| 1357 |
*/ |
| 1358 |
private function is_refresh_token_valid( int $user_id, string $jti ): bool { |
| 1359 |
$refresh_tokens = get_user_meta( $user_id, '_woocommerce_pos_refresh_tokens', true ); |
| 1360 |
if ( ! \is_array( $refresh_tokens ) ) { |
| 1361 |
return false; |
| 1362 |
} |
| 1363 |
|
| 1364 |
return isset( $refresh_tokens[ $jti ] ) && $refresh_tokens[ $jti ]['expires'] > time(); |
| 1365 |
} |
| 1366 |
|
| 1367 |
/** |
| 1368 |
* Parse user agent string to extract device information. |
| 1369 |
* |
| 1370 |
* @param string $user_agent The user agent string. |
| 1371 |
* |
| 1372 |
* @return array |
| 1373 |
*/ |
| 1374 |
private function parse_user_agent( string $user_agent ): array { |
| 1375 |
$device_info = array( |
| 1376 |
'device_type' => 'unknown', |
| 1377 |
'browser' => 'unknown', |
| 1378 |
'browser_version' => '', |
| 1379 |
'os' => 'unknown', |
| 1380 |
'app_type' => 'web', // web, ios_app, android_app, electron_app. |
| 1381 |
); |
| 1382 |
|
| 1383 |
if ( empty( $user_agent ) ) { |
| 1384 |
return $device_info; |
| 1385 |
} |
| 1386 |
|
| 1387 |
// Detect WooCommerce POS apps first (custom identifiers) |
| 1388 |
// Check for Electron app (including just "WooCommercePOS" in user agent with Electron). |
| 1389 |
if ( preg_match( '/Electron/i', $user_agent ) && preg_match( '/WooCommercePOS|WCPOS/i', $user_agent ) ) { |
| 1390 |
$device_info['app_type'] = 'electron_app'; |
| 1391 |
$device_info['browser'] = 'WooCommerce POS'; |
| 1392 |
$device_info['device_type'] = 'desktop'; |
| 1393 |
// Try to extract WooCommercePOS version. |
| 1394 |
if ( preg_match( '/WooCommercePOS[\/\s]([0-9.]+)/i', $user_agent, $matches ) ) { |
| 1395 |
$device_info['browser_version'] = $matches[1]; |
| 1396 |
} elseif ( preg_match( '/WCPOS[\/\s]([0-9.]+)/i', $user_agent, $matches ) ) { |
| 1397 |
$device_info['browser_version'] = $matches[1]; |
| 1398 |
} |
| 1399 |
} elseif ( preg_match( '/WCPOS[-_]?iOS|WooCommercePOS[-_]?iOS/i', $user_agent ) ) { |
| 1400 |
$device_info['app_type'] = 'ios_app'; |
| 1401 |
$device_info['browser'] = 'WooCommerce POS'; |
| 1402 |
// Default to tablet unless explicitly detected as phone. |
| 1403 |
$device_info['device_type'] = preg_match( '/iphone|ipod/i', $user_agent ) ? 'mobile' : 'tablet'; |
| 1404 |
if ( preg_match( '/WCPOS[-_]?iOS[\/\s]([0-9.]+)/i', $user_agent, $matches ) ) { |
| 1405 |
$device_info['browser_version'] = $matches[1]; |
| 1406 |
} elseif ( preg_match( '/WooCommercePOS[\/\s]([0-9.]+)/i', $user_agent, $matches ) ) { |
| 1407 |
$device_info['browser_version'] = $matches[1]; |
| 1408 |
} |
| 1409 |
} elseif ( preg_match( '/WCPOS[-_]?Android|WooCommercePOS[-_]?Android/i', $user_agent ) ) { |
| 1410 |
$device_info['app_type'] = 'android_app'; |
| 1411 |
$device_info['browser'] = 'WooCommerce POS'; |
| 1412 |
// Default to tablet unless explicitly detected as mobile. |
| 1413 |
$device_info['device_type'] = preg_match( '/mobile/i', $user_agent ) && ! preg_match( '/tablet/i', $user_agent ) ? 'mobile' : 'tablet'; |
| 1414 |
if ( preg_match( '/WCPOS[-_]?Android[\/\s]([0-9.]+)/i', $user_agent, $matches ) ) { |
| 1415 |
$device_info['browser_version'] = $matches[1]; |
| 1416 |
} elseif ( preg_match( '/WooCommercePOS[\/\s]([0-9.]+)/i', $user_agent, $matches ) ) { |
| 1417 |
$device_info['browser_version'] = $matches[1]; |
| 1418 |
} |
| 1419 |
} |
| 1420 |
|
| 1421 |
// Detect standard device type (if not already set by app detection). |
| 1422 |
if ( 'web' === $device_info['app_type'] ) { |
| 1423 |
if ( preg_match( '/mobile|android|iphone|ipod|blackberry|iemobile|opera mini/i', $user_agent ) ) { |
| 1424 |
$device_info['device_type'] = 'mobile'; |
| 1425 |
} elseif ( preg_match( '/tablet|ipad|playbook|silk/i', $user_agent ) ) { |
| 1426 |
$device_info['device_type'] = 'tablet'; |
| 1427 |
} else { |
| 1428 |
$device_info['device_type'] = 'desktop'; |
| 1429 |
} |
| 1430 |
} |
| 1431 |
|
| 1432 |
// Detect browser (skip if we already detected a WCPOS app). |
| 1433 |
if ( 'WooCommerce POS' !== $device_info['browser'] ) { |
| 1434 |
if ( preg_match( '/MSIE|Trident/i', $user_agent ) ) { |
| 1435 |
$device_info['browser'] = 'Internet Explorer'; |
| 1436 |
if ( preg_match( '/MSIE ([0-9.]+)/', $user_agent, $matches ) ) { |
| 1437 |
$device_info['browser_version'] = $matches[1]; |
| 1438 |
} |
| 1439 |
} elseif ( preg_match( '/Edge\/([0-9.]+)/i', $user_agent, $matches ) ) { |
| 1440 |
$device_info['browser'] = 'Edge'; |
| 1441 |
$device_info['browser_version'] = $matches[1]; |
| 1442 |
} elseif ( preg_match( '/Edg\/([0-9.]+)/i', $user_agent, $matches ) ) { |
| 1443 |
$device_info['browser'] = 'Edge'; |
| 1444 |
$device_info['browser_version'] = $matches[1]; |
| 1445 |
} elseif ( preg_match( '/Firefox\/([0-9.]+)/i', $user_agent, $matches ) ) { |
| 1446 |
$device_info['browser'] = 'Firefox'; |
| 1447 |
$device_info['browser_version'] = $matches[1]; |
| 1448 |
} elseif ( preg_match( '/Chrome\/([0-9.]+)/i', $user_agent, $matches ) ) { |
| 1449 |
$device_info['browser'] = 'Chrome'; |
| 1450 |
$device_info['browser_version'] = $matches[1]; |
| 1451 |
} elseif ( preg_match( '/Safari\/([0-9.]+)/i', $user_agent, $matches ) ) { |
| 1452 |
// Safari should be checked after Chrome because Chrome also contains Safari. |
| 1453 |
if ( ! preg_match( '/Chrome/i', $user_agent ) ) { |
| 1454 |
$device_info['browser'] = 'Safari'; |
| 1455 |
$device_info['browser_version'] = $matches[1]; |
| 1456 |
} |
| 1457 |
} elseif ( preg_match( '/Opera\/([0-9.]+)/i', $user_agent, $matches ) ) { |
| 1458 |
$device_info['browser'] = 'Opera'; |
| 1459 |
$device_info['browser_version'] = $matches[1]; |
| 1460 |
} |
| 1461 |
} |
| 1462 |
|
| 1463 |
// Detect OS. |
| 1464 |
if ( preg_match( '/Windows NT ([0-9.]+)/i', $user_agent, $matches ) ) { |
| 1465 |
$device_info['os'] = 'Windows'; |
| 1466 |
} elseif ( preg_match( '/Mac OS X ([0-9_]+)/i', $user_agent, $matches ) ) { |
| 1467 |
$device_info['os'] = 'macOS'; |
| 1468 |
} elseif ( preg_match( '/Android ([0-9.]+)/i', $user_agent, $matches ) ) { |
| 1469 |
$device_info['os'] = 'Android'; |
| 1470 |
} elseif ( preg_match( '/iPhone OS ([0-9_]+)/i', $user_agent, $matches ) ) { |
| 1471 |
$device_info['os'] = 'iOS'; |
| 1472 |
} elseif ( preg_match( '/iPad.*OS ([0-9_]+)/i', $user_agent, $matches ) ) { |
| 1473 |
$device_info['os'] = 'iPadOS'; |
| 1474 |
} elseif ( preg_match( '/Linux/i', $user_agent ) ) { |
| 1475 |
$device_info['os'] = 'Linux'; |
| 1476 |
} |
| 1477 |
|
| 1478 |
return $device_info; |
| 1479 |
} |
| 1480 |
|
| 1481 |
/** |
| 1482 |
* Check if a token JTI is blacklisted. |
| 1483 |
* |
| 1484 |
* Works for both access token JTIs and refresh token JTIs (sessions). |
| 1485 |
* |
| 1486 |
* @param string $jti Token JTI to check. |
| 1487 |
* |
| 1488 |
* @return bool |
| 1489 |
*/ |
| 1490 |
private function is_token_blacklisted( string $jti ): bool { |
| 1491 |
if ( empty( $jti ) ) { |
| 1492 |
return false; |
| 1493 |
} |
| 1494 |
|
| 1495 |
// Check transient. |
| 1496 |
return false !== get_transient( "wcpos_blacklist_{$jti}" ); |
| 1497 |
} |
| 1498 |
|
| 1499 |
/** |
| 1500 |
* Clean up previous web session to prevent session proliferation. |
| 1501 |
* |
| 1502 |
* The web application generates new tokens on every page load. This method |
| 1503 |
* revokes the previous session (stored in a cookie) so only one web session |
| 1504 |
* exists per browser at a time. |
| 1505 |
* |
| 1506 |
* @param int $user_id The user ID. |
| 1507 |
*/ |
| 1508 |
private function cleanup_previous_web_session( int $user_id ): void { |
| 1509 |
$cookie_name = 'wcpos_web_session_jti'; |
| 1510 |
|
| 1511 |
if ( ! isset( $_COOKIE[ $cookie_name ] ) ) { |
| 1512 |
return; |
| 1513 |
} |
| 1514 |
|
| 1515 |
$previous_jti = sanitize_text_field( wp_unslash( $_COOKIE[ $cookie_name ] ) ); |
| 1516 |
|
| 1517 |
if ( empty( $previous_jti ) ) { |
| 1518 |
return; |
| 1519 |
} |
| 1520 |
|
| 1521 |
// Revoke the previous session (silently - don't care if it fails). |
| 1522 |
$this->revoke_session( $user_id, $previous_jti ); |
| 1523 |
} |
| 1524 |
|
| 1525 |
/** |
| 1526 |
* Set a cookie to track the current web session JTI. |
| 1527 |
* |
| 1528 |
* @param string $refresh_token The refresh token to extract JTI from. |
| 1529 |
*/ |
| 1530 |
private function set_web_session_cookie( string $refresh_token ): void { |
| 1531 |
$decoded = $this->validate_token( $refresh_token, 'refresh' ); |
| 1532 |
|
| 1533 |
if ( is_wp_error( $decoded ) || empty( $decoded->jti ) ) { |
| 1534 |
return; |
| 1535 |
} |
| 1536 |
|
| 1537 |
$cookie_name = 'wcpos_web_session_jti'; |
| 1538 |
$jti = $decoded->jti; |
| 1539 |
$expires = $decoded->exp ?? ( time() + DAY_IN_SECONDS * 30 ); |
| 1540 |
|
| 1541 |
// Set cookie with same expiry as refresh token |
| 1542 |
// Use httponly for security, but not secure flag as POS may run on localhost. |
| 1543 |
setcookie( |
| 1544 |
$cookie_name, |
| 1545 |
$jti, |
| 1546 |
array( |
| 1547 |
'expires' => $expires, |
| 1548 |
'path' => \defined( 'COOKIEPATH' ) ? COOKIEPATH : '/', // @phpstan-ignore-line |
| 1549 |
'domain' => \defined( 'COOKIE_DOMAIN' ) ? COOKIE_DOMAIN : '', // @phpstan-ignore-line |
| 1550 |
'secure' => is_ssl(), |
| 1551 |
'httponly' => true, |
| 1552 |
'samesite' => 'Lax', |
| 1553 |
) |
| 1554 |
); |
| 1555 |
} |
| 1556 |
} |
| 1557 |
|
