Completed
Push — update/sso-allow-3rd-party-act... ( ef4bc5...73d615 )
by
unknown
19:00 queued 10:42
created

Jetpack_SSO::save_cookies()   B

Complexity

Conditions 4
Paths 4

Size

Total Lines 24
Code Lines 16

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 4
eloc 16
nc 4
nop 0
dl 0
loc 24
rs 8.6845
c 0
b 0
f 0
1
<?php
2
require_once( JETPACK__PLUGIN_DIR . 'modules/sso/class.jetpack-sso-helpers.php' );
3
require_once( JETPACK__PLUGIN_DIR . 'modules/sso/class.jetpack-sso-notices.php' );
4
5
/**
6
 * Module Name: Single Sign On
7
 * Module Description: Secure user authentication with WordPress.com.
8
 * Jumpstart Description: Lets you log in to all your Jetpack-enabled sites with one click using your WordPress.com account.
9
 * Sort Order: 30
10
 * Recommendation Order: 5
11
 * First Introduced: 2.6
12
 * Requires Connection: Yes
13
 * Auto Activate: No
14
 * Module Tags: Developers
15
 * Feature: Security, Jumpstart
16
 * Additional Search Queries: sso, single sign on, login, log in
17
 */
18
19
class Jetpack_SSO {
20
	static $instance = null;
0 ignored issues
show
Coding Style introduced by
The visibility should be declared for property $instance.

The PSR-2 coding standard requires that all properties in a class have their visibility explicitly declared. If you declare a property using

class A {
    var $property;
}

the property is implicitly global.

To learn more about the PSR-2, please see the PHP-FIG site on the PSR-2.

Loading history...
21
22
	private function __construct() {
23
24
		self::$instance = $this;
25
26
		add_action( 'admin_init',             array( $this, 'maybe_authorize_user_after_sso' ), 1 );
27
		add_action( 'admin_init',             array( $this, 'register_settings' ) );
28
		add_action( 'login_init',             array( $this, 'login_init' ) );
29
		add_action( 'delete_user',            array( $this, 'delete_connection_for_user' ) );
30
		add_filter( 'jetpack_xmlrpc_methods', array( $this, 'xmlrpc_methods' ) );
31
		add_action( 'init',                   array( $this, 'maybe_logout_user' ), 5 );
32
		add_action( 'jetpack_modules_loaded', array( $this, 'module_configure_button' ) );
33
		add_action( 'login_form_logout',      array( $this, 'store_wpcom_profile_cookies_on_logout' ) );
34
		add_action( 'wp_login',               array( 'Jetpack_SSO', 'clear_wpcom_profile_cookies' ) );
35
		add_action( 'jetpack_unlinked_user',  array( $this, 'delete_connection_for_user') );
36
37
		// Adding this action so that on login_init, the action won't be sanitized out of the $action global.
38
		add_action( 'login_form_jetpack-sso', '__return_true' );
39
	}
40
41
	/**
42
	 * Returns the single instance of the Jetpack_SSO object
43
	 *
44
	 * @since 2.8
45
	 * @return Jetpack_SSO
46
	 **/
47
	public static function get_instance() {
48
		if ( ! is_null( self::$instance ) ) {
49
			return self::$instance;
50
		}
51
52
		return self::$instance = new Jetpack_SSO;
53
	}
54
55
	/**
56
	 * Add configure button and functionality to the module card on the Jetpack screen
57
	 **/
58
	public static function module_configure_button() {
59
		Jetpack::enable_module_configurable( __FILE__ );
60
		Jetpack::module_configuration_load( __FILE__, array( __CLASS__, 'module_configuration_load' ) );
61
		Jetpack::module_configuration_head( __FILE__, array( __CLASS__, 'module_configuration_head' ) );
62
		Jetpack::module_configuration_screen( __FILE__, array( __CLASS__, 'module_configuration_screen' ) );
63
	}
64
65
	public static function module_configuration_load() {}
66
67
	public static function module_configuration_head() {}
68
69
	public static function module_configuration_screen() {
70
		?>
71
		<form method="post" action="options.php">
72
			<?php settings_fields( 'jetpack-sso' ); ?>
73
			<?php do_settings_sections( 'jetpack-sso' ); ?>
74
			<?php submit_button(); ?>
75
		</form>
76
		<?php
77
	}
78
79
	/**
80
	 * If jetpack_force_logout == 1 in current user meta the user will be forced
81
	 * to logout and reauthenticate with the site.
82
	 **/
83
	public function maybe_logout_user() {
84
		global $current_user;
85
86
		if ( 1 == $current_user->jetpack_force_logout ) {
87
			delete_user_meta( $current_user->ID, 'jetpack_force_logout' );
88
			self::delete_connection_for_user( $current_user->ID );
89
			wp_logout();
90
			wp_safe_redirect( wp_login_url() );
91
			exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method maybe_logout_user() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
92
		}
93
	}
94
95
	/**
96
	 * Adds additional methods the WordPress xmlrpc API for handling SSO specific features
97
	 *
98
	 * @param array $methods
99
	 * @return array
100
	 **/
101
	public function xmlrpc_methods( $methods ) {
102
		$methods['jetpack.userDisconnect'] = array( $this, 'xmlrpc_user_disconnect' );
103
		return $methods;
104
	}
105
106
	/**
107
	 * Marks a user's profile for disconnect from WordPress.com and forces a logout
108
	 * the next time the user visits the site.
109
	 **/
110
	public function xmlrpc_user_disconnect( $user_id ) {
111
		$user_query = new WP_User_Query(
112
			array(
113
				'meta_key' => 'wpcom_user_id',
114
				'meta_value' => $user_id,
115
			)
116
		);
117
		$user = $user_query->get_results();
118
		$user = $user[0];
119
120
		if ( $user instanceof WP_User ) {
0 ignored issues
show
Bug introduced by
The class WP_User does not exist. Did you forget a USE statement, or did you not list all dependencies?

This error could be the result of:

1. Missing dependencies

PHP Analyzer uses your composer.json file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the composer.json to be in the root folder of your repository.

Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the require or require-dev section?

2. Missing use statement

PHP does not complain about undefined classes in ìnstanceof checks. For example, the following PHP code will work perfectly fine:

if ($x instanceof DoesNotExist) {
    // Do something.
}

If you have not tested against this specific condition, such errors might go unnoticed.

Loading history...
121
			$user = wp_set_current_user( $user->ID );
122
			update_user_meta( $user->ID, 'jetpack_force_logout', '1' );
123
			self::delete_connection_for_user( $user->ID );
124
			return true;
125
		}
126
		return false;
127
	}
128
129
	/**
130
	 * Enqueues scripts and styles necessary for SSO login.
131
	 */
132
	public function login_enqueue_scripts() {
133
		global $action;
134
135
		if ( ! Jetpack_SSO_Helpers::display_sso_form_for_action( $action ) ) {
136
			return;
137
		}
138
139
		if ( is_rtl() ) {
140
			wp_enqueue_style( 'jetpack-sso-login', plugins_url( 'modules/sso/jetpack-sso-login-rtl.css', JETPACK__PLUGIN_FILE ), array( 'login', 'genericons' ), JETPACK__VERSION );
141
		} else {
142
			wp_enqueue_style( 'jetpack-sso-login', plugins_url( 'modules/sso/jetpack-sso-login.css', JETPACK__PLUGIN_FILE ), array( 'login', 'genericons' ), JETPACK__VERSION );
143
		}
144
145
		wp_enqueue_script( 'jetpack-sso-login', plugins_url( 'modules/sso/jetpack-sso-login.js', JETPACK__PLUGIN_FILE ), array( 'jquery' ), JETPACK__VERSION );
146
	}
147
148
	/**
149
	 * Adds Jetpack SSO classes to login body
150
	 *
151
	 * @param  array $classes Array of classes to add to body tag
152
	 * @return array          Array of classes to add to body tag
153
	 */
154
	public function login_body_class( $classes ) {
155
		global $action;
156
157
		if ( ! Jetpack_SSO_Helpers::display_sso_form_for_action( $action ) ) {
158
			return $classes;
159
		}
160
161
		// Always add the jetpack-sso class so that we can add SSO specific styling even when the SSO form isn't being displayed.
162
		$classes[] = 'jetpack-sso';
163
164
		if ( ! Jetpack::is_staging_site() ) {
165
			/**
166
			 * Should we show the SSO login form?
167
			 *
168
			 * $_GET['jetpack-sso-default-form'] is used to provide a fallback in case JavaScript is not enabled.
169
			 *
170
			 * The default_to_sso_login() method allows us to dynamically decide whether we show the SSO login form or not.
171
			 * The SSO module uses the method to display the default login form if we can not find a user to log in via SSO.
172
			 * But, the method could be filtered by a site admin to always show the default login form if that is preferred.
173
			 */
174
			if ( empty( $_GET['jetpack-sso-show-default-form'] ) && Jetpack_SSO_Helpers::show_sso_login() ) {
175
				$classes[] = 'jetpack-sso-form-display';
176
			}
177
		}
178
179
		return $classes;
180
	}
181
182
	public function print_inline_admin_css() {
183
		?>
184
			<style>
185
				.jetpack-sso .message {
186
					margin-top: 20px;
187
				}
188
189
				.jetpack-sso #login .message:first-child,
190
				.jetpack-sso #login h1 + .message {
191
					margin-top: 0;
192
				}
193
			</style>
194
		<?php
195
	}
196
197
	/**
198
	 * Adds settings fields to Settings > General > Single Sign On that allows users to
199
	 * turn off the login form on wp-login.php
200
	 *
201
	 * @since 2.7
202
	 **/
203
	public function register_settings() {
204
205
		add_settings_section(
206
			'jetpack_sso_settings',
207
			__( 'Single Sign On' , 'jetpack' ),
208
			'__return_false',
209
			'jetpack-sso'
210
		);
211
212
		/*
213
		 * Settings > General > Single Sign On
214
		 * Require two step authentication
215
		 */
216
		register_setting(
217
			'jetpack-sso',
218
			'jetpack_sso_require_two_step',
219
			array( $this, 'validate_jetpack_sso_require_two_step' )
220
		);
221
222
		add_settings_field(
223
			'jetpack_sso_require_two_step',
224
			'', // __( 'Require Two-Step Authentication' , 'jetpack' ),
225
			array( $this, 'render_require_two_step' ),
226
			'jetpack-sso',
227
			'jetpack_sso_settings'
228
		);
229
230
		/*
231
		 * Settings > General > Single Sign On
232
		 */
233
		register_setting(
234
			'jetpack-sso',
235
			'jetpack_sso_match_by_email',
236
			array( $this, 'validate_jetpack_sso_match_by_email' )
237
		);
238
239
		add_settings_field(
240
			'jetpack_sso_match_by_email',
241
			'', // __( 'Match by Email' , 'jetpack' ),
242
			array( $this, 'render_match_by_email' ),
243
			'jetpack-sso',
244
			'jetpack_sso_settings'
245
		);
246
	}
247
248
	/**
249
	 * Builds the display for the checkbox allowing user to require two step
250
	 * auth be enabled on WordPress.com accounts before login. Displays in Settings > General
251
	 *
252
	 * @since 2.7
253
	 **/
254
	public function render_require_two_step() {
255
		?>
256
		<label>
257
			<input
258
				type="checkbox"
259
				name="jetpack_sso_require_two_step"
260
				<?php checked( Jetpack_SSO_Helpers::is_two_step_required() ); ?>
261
				<?php disabled( Jetpack_SSO_Helpers::is_require_two_step_checkbox_disabled() ); ?>
262
			>
263
			<?php esc_html_e( 'Require Two-Step Authentication' , 'jetpack' ); ?>
264
		</label>
265
		<?php
266
	}
267
268
	/**
269
	 * Validate the require  two step checkbox in Settings > General
270
	 *
271
	 * @since 2.7
272
	 * @return boolean
273
	 **/
274
	public function validate_jetpack_sso_require_two_step( $input ) {
275
		return ( ! empty( $input ) ) ? 1 : 0;
276
	}
277
278
	/**
279
	 * Builds the display for the checkbox allowing the user to allow matching logins by email
280
	 * Displays in Settings > General
281
	 *
282
	 * @since 2.9
283
	 **/
284
	public function render_match_by_email() {
285
		?>
286
			<label>
287
				<input
288
					type="checkbox"
289
					name="jetpack_sso_match_by_email"
290
					<?php checked( Jetpack_SSO_Helpers::match_by_email() ); ?>
291
					<?php disabled( Jetpack_SSO_Helpers::is_match_by_email_checkbox_disabled() ); ?>
292
				>
293
				<?php esc_html_e( 'Match by Email', 'jetpack' ); ?>
294
			</label>
295
		<?php
296
	}
297
298
	/**
299
	 * Validate the match by email check in Settings > General
300
	 *
301
	 * @since 2.9
302
	 * @return boolean
303
	 **/
304
	public function validate_jetpack_sso_match_by_email( $input ) {
305
		return ( ! empty( $input ) ) ? 1 : 0;
306
	}
307
308
	/**
309
	 * Checks to determine if the user wants to login on wp-login
310
	 *
311
	 * This function mostly exists to cover the exceptions to login
312
	 * that may exist as other parameters to $_GET[action] as $_GET[action]
313
	 * does not have to exist. By default WordPress assumes login if an action
314
	 * is not set, however this may not be true, as in the case of logout
315
	 * where $_GET[loggedout] is instead set
316
	 *
317
	 * @return boolean
318
	 **/
319
	private function wants_to_login() {
320
		$wants_to_login = false;
321
322
		// Cover default WordPress behavior
323
		$action = isset( $_REQUEST['action'] ) ? $_REQUEST['action'] : 'login';
324
325
		// And now the exceptions
326
		$action = isset( $_GET['loggedout'] ) ? 'loggedout' : $action;
327
328
		if ( Jetpack_SSO_Helpers::display_sso_form_for_action( $action ) ) {
329
			$wants_to_login = true;
330
		}
331
332
		return $wants_to_login;
333
	}
334
335
	function login_init() {
336
		global $action;
337
338
		if ( Jetpack_SSO_Helpers::should_hide_login_form() ) {
339
			/**
340
			 * Since the default authenticate filters fire at priority 20 for checking username and password,
341
			 * let's fire at priority 30. wp_authenticate_spam_check is fired at priority 99, but since we return a
342
			 * WP_Error in disable_default_login_form, then we won't trigger spam processing logic.
343
			 */
344
			add_filter( 'authenticate', array( 'Jetpack_SSO_Notices', 'disable_default_login_form' ), 30 );
345
346
			/**
347
			 * Filter the display of the disclaimer message appearing when default WordPress login form is disabled.
348
			 *
349
			 * @module sso
350
			 *
351
			 * @since 2.8.0
352
			 *
353
			 * @param bool true Should the disclaimer be displayed. Default to true.
354
			 */
355
			$display_sso_disclaimer = apply_filters( 'jetpack_sso_display_disclaimer', true );
356
			if ( $display_sso_disclaimer ) {
357
				add_filter( 'login_message', array( 'Jetpack_SSO_Notices', 'msg_login_by_jetpack' ) );
358
			}
359
		}
360
361
		/**
362
		 * If the user is attempting to logout AND the auto-forward to WordPress.com
363
		 * login is set then we need to ensure we do not auto-forward the user and get
364
		 * them stuck in an infinite logout loop.
365
		 */
366
		if ( isset( $_GET['loggedout'] ) && Jetpack_SSO_Helpers::bypass_login_forward_wpcom() ) {
367
			add_filter( 'jetpack_remove_login_form', '__return_true' );
368
		}
369
370
		if ( $this->wants_to_login() ) {
371
372
			// Save cookies so we can handle redirects after SSO
373
			$this->save_cookies();
374
375
			if ( 'jetpack_json_api_authorization' == $action ) {
376
				Jetpack::init()->verify_json_api_authorization_request();
377
			}
378
379
			/**
380
			 * Check to see if the site admin wants to automagically forward the user
381
			 * to the WordPress.com login page AND  that the request to wp-login.php
382
			 * is not something other than login (Like logout!)
383
			 */
384 View Code Duplication
			if ( Jetpack_SSO_Helpers::bypass_login_forward_wpcom() ) {
385
				add_filter( 'allowed_redirect_hosts', array( 'Jetpack_SSO_Helpers', 'allowed_redirect_hosts' ) );
386
				$reauth = ! empty( $_GET['force_reauth'] );
387
				$sso_url = $this->get_sso_url_or_die( $reauth );
388
				JetpackTracking::record_user_event( 'sso_login_redirect_bypass_success' );
389
				wp_safe_redirect( $sso_url );
390
				exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method login_init() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
391
			}
392
393
			$this->display_sso_login_form();
394
395
		} elseif ( 'jetpack-sso' === $action ) {
396
			if ( isset( $_GET['result'], $_GET['user_id'], $_GET['sso_nonce'] ) && 'success' == $_GET['result'] ) {
397
				$this->handle_login();
398
				$this->display_sso_login_form();
399
			} else {
400
				if ( Jetpack::is_staging_site() ) {
401
					add_filter( 'login_message', array( 'Jetpack_SSO_Notices', 'sso_not_allowed_in_staging' ) );
402 View Code Duplication
				} else {
403
					// Is it wiser to just use wp_redirect than do this runaround to wp_safe_redirect?
404
					add_filter( 'allowed_redirect_hosts', array( 'Jetpack_SSO_Helpers', 'allowed_redirect_hosts' ) );
405
					$reauth = ! empty( $_GET['force_reauth'] );
406
					$sso_url = $this->get_sso_url_or_die( $reauth );
407
					JetpackTracking::record_user_event( 'sso_login_redirect_success' );
408
					wp_safe_redirect( $sso_url );
409
					exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method login_init() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
410
				}
411
			}
412
		}
413
	}
414
415
	/**
416
	 * Ensures that we can get a nonce from WordPress.com via XML-RPC before setting
417
	 * up the hooks required to display the SSO form.
418
	 */
419
	public function display_sso_login_form() {
420
		add_filter( 'login_body_class', array( $this, 'login_body_class' ) );
421
		add_action( 'login_head',       array( $this, 'print_inline_admin_css' ) );
422
423
		if ( Jetpack::is_staging_site() ) {
424
			add_filter( 'login_message', array( 'Jetpack_SSO_Notices', 'sso_not_allowed_in_staging' ) );
425
			return;
426
		}
427
428
		$sso_nonce = self::request_initial_nonce();
429
		if ( is_wp_error( $sso_nonce ) ) {
430
			return;
431
		}
432
433
		add_action( 'login_form',            array( $this, 'login_form' ) );
434
		add_action( 'login_enqueue_scripts', array( $this, 'login_enqueue_scripts' ) );
435
	}
436
437
	/**
438
	 * Conditionally save the redirect_to url as a cookie.
439
	 *
440
	 * @since 4.6.0 Renamed to save_cookies from maybe_save_redirect_cookies
441
	 */
442
	public static function save_cookies() {
443
		if ( headers_sent() ) {
444
			return new WP_Error( 'headers_sent', __( 'Cannot deal with cookie redirects, as headers are already sent.', 'jetpack' ) );
445
		}
446
447
		setcookie(
448
			'jetpack_sso_original_request',
449
			esc_url_raw( set_url_scheme( $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] ) ),
450
			time() + HOUR_IN_SECONDS,
451
			COOKIEPATH,
452
			COOKIE_DOMAIN,
453
			false,
454
			true
455
		);
456
457
		if ( ! empty( $_GET['redirect_to'] ) ) {
458
			// If we have something to redirect to
459
			$url = esc_url_raw( $_GET['redirect_to'] );
460
			setcookie( 'jetpack_sso_redirect_to', $url, time() + HOUR_IN_SECONDS, COOKIEPATH, COOKIE_DOMAIN, false, true );
461
		} elseif ( ! empty( $_COOKIE['jetpack_sso_redirect_to'] ) ) {
462
			// Otherwise, if it's already set, purge it.
463
			setcookie( 'jetpack_sso_redirect_to', ' ', time() - YEAR_IN_SECONDS, COOKIEPATH, COOKIE_DOMAIN );
464
		}
465
	}
466
467
	/**
468
	 * Outputs the Jetpack SSO button and description as well as the toggle link
469
	 * for switching between Jetpack SSO and default login.
470
	 */
471
	function login_form() {
472
		$site_name = get_bloginfo( 'name' );
473
		if ( ! $site_name ) {
474
			$site_name = get_bloginfo( 'url' );
475
		}
476
477
		$display_name = ! empty( $_COOKIE[ 'jetpack_sso_wpcom_name_' . COOKIEHASH ] )
478
			? $_COOKIE[ 'jetpack_sso_wpcom_name_' . COOKIEHASH ]
479
			: false;
480
		$gravatar = ! empty( $_COOKIE[ 'jetpack_sso_wpcom_gravatar_' . COOKIEHASH ] )
481
			? $_COOKIE[ 'jetpack_sso_wpcom_gravatar_' . COOKIEHASH ]
482
			: false;
483
484
		?>
485
		<div id="jetpack-sso-wrap">
486
			<?php if ( $display_name && $gravatar ) : ?>
487
				<div id="jetpack-sso-wrap__user">
488
					<img width="72" height="72" src="<?php echo esc_html( $gravatar ); ?>" />
489
490
					<h2>
491
						<?php
492
							echo wp_kses(
493
								sprintf( __( 'Log in as <span>%s</span>', 'jetpack' ), esc_html( $display_name ) ),
494
								array( 'span' => true )
495
							);
496
						?>
497
					</h2>
498
				</div>
499
500
			<?php endif; ?>
501
502
503
			<div id="jetpack-sso-wrap__action">
504
				<?php echo $this->build_sso_button( array(), 'is_primary' ); ?>
0 ignored issues
show
Documentation introduced by
'is_primary' is of type string, but the function expects a boolean.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
505
506
				<?php if ( $display_name && $gravatar ) : ?>
507
					<a rel="nofollow" class="jetpack-sso-wrap__reauth" href="<?php echo esc_url( $this->build_sso_button_url( array( 'force_reauth' => '1' ) ) ); ?>">
508
						<?php esc_html_e( 'Log in as a different WordPress.com user', 'jetpack' ); ?>
509
					</a>
510
				<?php else : ?>
511
					<p>
512
						<?php
513
							echo esc_html(
514
								sprintf(
515
									__( 'You can now save time spent logging in by connecting your WordPress.com account to %s.', 'jetpack' ),
516
									esc_html( $site_name )
517
								)
518
							);
519
						?>
520
					</p>
521
				<?php endif; ?>
522
			</div>
523
524
			<?php if ( ! Jetpack_SSO_Helpers::should_hide_login_form() ) : ?>
525
				<div class="jetpack-sso-or">
526
					<span><?php esc_html_e( 'Or', 'jetpack' ); ?></span>
527
				</div>
528
529
				<a href="<?php echo esc_url( add_query_arg( 'jetpack-sso-show-default-form', '1' ) ); ?>" class="jetpack-sso-toggle wpcom">
530
					<?php
531
						esc_html_e( 'Log in with username and password', 'jetpack' )
532
					?>
533
				</a>
534
535
				<a href="<?php echo esc_url( add_query_arg( 'jetpack-sso-show-default-form', '0' ) ); ?>" class="jetpack-sso-toggle default">
536
					<?php
537
						esc_html_e( 'Log in with WordPress.com', 'jetpack' )
538
					?>
539
				</a>
540
			<?php endif; ?>
541
		</div>
542
		<?php
543
	}
544
545
	/**
546
	 * Clear the cookies that store the profile information for the last
547
	 * WPCOM user to connect.
548
	 */
549
	static function clear_wpcom_profile_cookies() {
550 View Code Duplication
		if ( isset( $_COOKIE[ 'jetpack_sso_wpcom_name_' . COOKIEHASH ] ) ) {
551
			setcookie(
552
				'jetpack_sso_wpcom_name_' . COOKIEHASH,
553
				' ',
554
				time() - YEAR_IN_SECONDS,
555
				COOKIEPATH,
556
				COOKIE_DOMAIN
557
			);
558
		}
559
560 View Code Duplication
		if ( isset( $_COOKIE[ 'jetpack_sso_wpcom_gravatar_' . COOKIEHASH ] ) ) {
561
			setcookie(
562
				'jetpack_sso_wpcom_gravatar_' . COOKIEHASH,
563
				' ',
564
				time() - YEAR_IN_SECONDS,
565
				COOKIEPATH,
566
				COOKIE_DOMAIN
567
			);
568
		}
569
	}
570
571
	static function delete_connection_for_user( $user_id ) {
572
		if ( ! $wpcom_user_id = get_user_meta( $user_id, 'wpcom_user_id', true ) ) {
573
			return;
574
		}
575
		Jetpack::load_xml_rpc_client();
576
		$xml = new Jetpack_IXR_Client( array(
577
			'wpcom_user_id' => $user_id,
578
		) );
579
		$xml->query( 'jetpack.sso.removeUser', $wpcom_user_id );
580
581
		if ( $xml->isError() ) {
582
			return false;
583
		}
584
585
		// Clean up local data stored for SSO
586
		delete_user_meta( $user_id, 'wpcom_user_id' );
587
		delete_user_meta( $user_id, 'wpcom_user_data'  );
588
		self::clear_wpcom_profile_cookies();
589
590
		return $xml->getResponse();
591
	}
592
593 View Code Duplication
	static function request_initial_nonce() {
594
		Jetpack::load_xml_rpc_client();
595
		$xml = new Jetpack_IXR_Client( array(
596
			'user_id' => get_current_user_id(),
597
		) );
598
		$xml->query( 'jetpack.sso.requestNonce' );
599
600
		if ( $xml->isError() ) {
601
			return new WP_Error( $xml->getErrorCode(), $xml->getErrorMessage() );
602
		}
603
604
		return $xml->getResponse();
605
	}
606
607
	/**
608
	 * The function that actually handles the login!
609
	 */
610
	function handle_login() {
611
		$wpcom_nonce   = sanitize_key( $_GET['sso_nonce'] );
612
		$wpcom_user_id = (int) $_GET['user_id'];
613
614
		Jetpack::load_xml_rpc_client();
615
		$xml = new Jetpack_IXR_Client( array(
616
			'user_id' => get_current_user_id(),
617
		) );
618
		$xml->query( 'jetpack.sso.validateResult', $wpcom_nonce, $wpcom_user_id );
619
620
		$user_data = $xml->isError() ? false : $xml->getResponse();
621
		if ( empty( $user_data ) ) {
622
			add_filter( 'jetpack_sso_default_to_sso_login', '__return_false' );
623
			add_filter( 'login_message', array( 'Jetpack_SSO_Notices', 'error_invalid_response_data' ) );
624
			return;
625
		}
626
627
		$user_data = (object) $user_data;
628
		$user = null;
629
630
		/**
631
		 * Fires before Jetpack's SSO modifies the log in form.
632
		 *
633
		 * @module sso
634
		 *
635
		 * @since 2.6.0
636
		 *
637
		 * @param object $user_data WordPress.com User information.
638
		 */
639
		do_action( 'jetpack_sso_pre_handle_login', $user_data );
640
641
		if ( Jetpack_SSO_Helpers::is_two_step_required() && 0 === (int) $user_data->two_step_enabled ) {
642
			$this->user_data = $user_data;
0 ignored issues
show
Bug introduced by
The property user_data does not exist. Did you maybe forget to declare it?

In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code:

class MyClass { }

$x = new MyClass();
$x->foo = true;

Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion:

class MyClass {
    public $foo;
}

$x = new MyClass();
$x->foo = true;
Loading history...
643
644
			JetpackTracking::record_user_event( 'sso_login_failed', array(
645
				'error_message' => 'error_msg_enable_two_step'
646
			) );
647
648
			/** This filter is documented in core/src/wp-includes/pluggable.php */
649
			do_action( 'wp_login_failed', $user_data->login );
650
			add_filter( 'login_message', array( 'Jetpack_SSO_Notices', 'error_msg_enable_two_step' ) );
651
			return;
652
		}
653
654
		$user_found_with = '';
655
		if ( empty( $user ) && isset( $user_data->external_user_id ) ) {
656
			$user_found_with = 'external_user_id';
657
			$user = get_user_by( 'id', intval( $user_data->external_user_id ) );
658
			if ( $user ) {
659
				update_user_meta( $user->ID, 'wpcom_user_id', $user_data->ID );
660
			}
661
		}
662
663
		// If we don't have one by wpcom_user_id, try by the email?
664
		if ( empty( $user ) && Jetpack_SSO_Helpers::match_by_email() ) {
665
			$user_found_with = 'match_by_email';
666
			$user = get_user_by( 'email', $user_data->email );
667
			if ( $user ) {
668
				update_user_meta( $user->ID, 'wpcom_user_id', $user_data->ID );
669
			}
670
		}
671
672
		// If we've still got nothing, create the user.
673
		$new_user_override_role = false;
674
		if ( empty( $user ) && ( get_option( 'users_can_register' ) || ( $new_user_override_role = Jetpack_SSO_Helpers::new_user_override( $user_data ) ) ) ) {
675
			/**
676
			 * If not matching by email we still need to verify the email does not exist
677
			 * or this blows up
678
			 *
679
			 * If match_by_email is true, we know the email doesn't exist, as it would have
680
			 * been found in the first pass.  If get_user_by( 'email' ) doesn't find the
681
			 * user, then we know that email is unused, so it's safe to add.
682
			 */
683
			if ( Jetpack_SSO_Helpers::match_by_email() || ! get_user_by( 'email', $user_data->email ) ) {
684
				
685
				if ( $new_user_override_role ) {
686
					$user_data->role = $new_user_override_role;
687
				}
688
689
				$user = Jetpack_SSO_Helpers::generate_user( $user_data );
690
				if ( ! $user ) {
691
					JetpackTracking::record_user_event( 'sso_login_failed', array(
692
						'error_message' => 'could_not_create_username'
693
					) );
694
					add_filter( 'login_message', array( 'Jetpack_SSO_Notices', 'error_unable_to_create_user' ) );
695
					return;
696
				}
697
698
				$user_found_with = $new_user_override_role
699
					? 'user_created_new_user_override'
700
					: 'user_created_users_can_register';
701
			} else {
702
				JetpackTracking::record_user_event( 'sso_login_failed', array(
703
					'error_message' => 'error_msg_email_already_exists'
704
				) );
705
706
				$this->user_data = $user_data;
707
				add_action( 'login_message', array( 'Jetpack_SSO_Notices', 'error_msg_email_already_exists' ) );
708
				return;
709
			}
710
		}
711
712
		/**
713
		 * Fires after we got login information from WordPress.com.
714
		 *
715
		 * @module sso
716
		 *
717
		 * @since 2.6.0
718
		 *
719
		 * @param array  $user      Local User information.
720
		 * @param object $user_data WordPress.com User Login information.
721
		 */
722
		do_action( 'jetpack_sso_handle_login', $user, $user_data );
723
724
		if ( $user ) {
725
			// Cache the user's details, so we can present it back to them on their user screen
726
			update_user_meta( $user->ID, 'wpcom_user_data', $user_data );
727
728
			add_filter( 'auth_cookie_expiration',    array( 'Jetpack_SSO_Helpers', 'extend_auth_cookie_expiration_for_sso' ) );
729
			wp_set_auth_cookie( $user->ID, true );
730
			remove_filter( 'auth_cookie_expiration', array( 'Jetpack_SSO_Helpers', 'extend_auth_cookie_expiration_for_sso' ) );
731
732
			/** This filter is documented in core/src/wp-includes/user.php */
733
			do_action( 'wp_login', $user->user_login, $user );
734
735
			wp_set_current_user( $user->ID );
736
737
			$_request_redirect_to = isset( $_REQUEST['redirect_to'] ) ? esc_url_raw( $_REQUEST['redirect_to'] ) : '';
738
			$redirect_to = user_can( $user, 'edit_posts' ) ? admin_url() : self::profile_page_url();
739
740
			// If we have a saved redirect to request in a cookie
741
			if ( ! empty( $_COOKIE['jetpack_sso_redirect_to'] ) ) {
742
				// Set that as the requested redirect to
743
				$redirect_to = $_request_redirect_to = esc_url_raw( $_COOKIE['jetpack_sso_redirect_to'] );
744
				// And then purge it
745
				setcookie( 'jetpack_sso_redirect_to', ' ', time() - YEAR_IN_SECONDS, COOKIEPATH, COOKIE_DOMAIN );
746
			}
747
748
			$original_request = ! empty( $_COOKIE['jetpack_sso_original_request'] )
749
				? esc_url_raw( $_COOKIE['jetpack_sso_original_request'] )
750
				: false;
751
752
			$is_json_api_auth = Jetpack_SSO_Helpers::is_sso_for_json_api_auth( $original_request );
753
			$is_user_connected = Jetpack::is_user_connected( $user->ID );
754
			JetpackTracking::record_user_event( 'sso_user_logged_in', array(
755
				'user_found_with'  => $user_found_with,
756
				'user_connected'   => (bool) $is_user_connected,
757
				'user_role'        => Jetpack::translate_current_user_to_role(),
758
				'is_json_api_auth' => (bool) $is_json_api_auth,
759
			) );
760
761
			if ( $is_json_api_auth ) {
762
				add_filter( 'login_redirect', array( Jetpack::init(), 'add_token_to_login_redirect_json_api_authorization' ), 10, 3 );
763
764
				Jetpack_SSO_Helpers::set_superglobal_values_for_json_api_auth( $original_request );
765
				Jetpack::init()->verify_json_api_authorization_request();
766
				Jetpack_SSO_Helpers::reset_superglobal_values_after_json_api_auth();
767
			} else if ( ! $is_user_connected ) {
768
				$calypso_env = ! empty( $_GET['calypso_env'] )
769
					? sanitize_key( $_GET['calypso_env'] )
770
					: '';
771
772
				wp_safe_redirect(
773
					add_query_arg(
774
						array(
775
							'redirect_to'               => $redirect_to,
776
							'request_redirect_to'       => $_request_redirect_to,
777
							'calypso_env'               => $calypso_env,
778
							'jetpack-sso-auth-redirect' => '1',
779
						),
780
						admin_url()
781
					)
782
				);
783
				exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method handle_login() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
784
			}
785
786
			add_filter( 'allowed_redirect_hosts', array( 'Jetpack_SSO_Helpers', 'allowed_redirect_hosts' ) );
787
			wp_safe_redirect(
788
				/** This filter is documented in core/src/wp-login.php */
789
				apply_filters( 'login_redirect', $redirect_to, $_request_redirect_to, $user )
790
			);
791
			exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method handle_login() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
792
		}
793
794
		add_filter( 'jetpack_sso_default_to_sso_login', '__return_false' );
795
796
		JetpackTracking::record_user_event( 'sso_login_failed', array(
797
			'error_message' => 'cant_find_user'
798
		) );
799
800
		$this->user_data = $user_data;
801
		/** This filter is documented in core/src/wp-includes/pluggable.php */
802
		do_action( 'wp_login_failed', $user_data->login );
803
		add_filter( 'login_message', array( 'Jetpack_SSO_Notices', 'cant_find_user' ) );
804
	}
805
806
	static function profile_page_url() {
807
		return admin_url( 'profile.php' );
808
	}
809
810
	/**
811
	 * Builds the "Login to WordPress.com" button that is displayed on the login page as well as user profile page.
812
	 *
813
	 * @param  array   $args       An array of arguments to add to the SSO URL.
814
	 * @param  boolean $is_primary Should the button have the `button-primary` class?
815
	 * @return string              Returns the HTML markup for the button.
816
	 */
817
	function build_sso_button( $args = array(), $is_primary = false ) {
818
		$url = $this->build_sso_button_url( $args );
819
		$classes = $is_primary
820
			? 'jetpack-sso button button-primary'
821
			: 'jetpack-sso button';
822
823
		return sprintf(
824
			'<a rel="nofollow" href="%1$s" class="%2$s"><span>%3$s %4$s</span></a>',
825
			esc_url( $url ),
826
			$classes,
827
			'<span class="genericon genericon-wordpress"></span>',
828
			esc_html__( 'Log in with WordPress.com', 'jetpack' )
829
		);
830
	}
831
832
	/**
833
	 * Builds a URL with `jetpack-sso` action and option args which is used to setup SSO.
834
	 *
835
	 * @param  array  $args An array of arguments to add to the SSO URL.
836
	 * @return string       The URL used for SSO.
837
	 */
838
	function build_sso_button_url( $args = array() ) {
839
		$defaults = array(
840
			'action'  => 'jetpack-sso',
841
		);
842
843
		$args = wp_parse_args( $args, $defaults );
844
845
		if ( ! empty( $_GET['redirect_to'] ) ) {
846
			$args['redirect_to'] = urlencode( esc_url_raw( $_GET['redirect_to'] ) );
847
		}
848
849
		return add_query_arg( $args, wp_login_url() );
850
	}
851
852
	/**
853
	 * Retrieves a WordPress.com SSO URL with appropriate query parameters or dies.
854
	 *
855
	 * @param  boolean  $reauth  Should the user be forced to reauthenticate on WordPress.com?
856
	 * @param  array    $args    Optional query parameters.
857
	 * @return string            The WordPress.com SSO URL.
858
	 */
859
	function get_sso_url_or_die( $reauth = false, $args = array() ) {
860
		global $action;
861
		if ( 'jetpack_json_api_authorization' == $action ) {
862
			Jetpack::init()->verify_json_api_authorization_request();
863
		}
864
865
		if ( empty( $reauth ) ) {
866
			$sso_redirect = $this->build_sso_url( $args );
867
		} else {
868
			self::clear_wpcom_profile_cookies();
869
			$sso_redirect = $this->build_reauth_and_sso_url( $args );
870
		}
871
872
		// If there was an error retrieving the SSO URL, then error.
873
		if ( is_wp_error( $sso_redirect ) ) {
874
			$error_message = sanitize_text_field(
875
				sprintf( '%s: %s', $sso_redirect->get_error_code(), $sso_redirect->get_error_message() )
0 ignored issues
show
Bug introduced by
The method get_error_code cannot be called on $sso_redirect (of type string).

Methods can only be called on objects. This check looks for methods being called on variables that have been inferred to never be objects.

Loading history...
Bug introduced by
The method get_error_message cannot be called on $sso_redirect (of type string).

Methods can only be called on objects. This check looks for methods being called on variables that have been inferred to never be objects.

Loading history...
876
			);
877
			JetpackTracking::record_user_event( 'sso_login_redirect_failed', array(
878
				'error_message' => $error_message
879
			) );
880
			wp_die( $error_message );
881
		}
882
883
		return $sso_redirect;
884
	}
885
886
	/**
887
	 * Build WordPress.com SSO URL with appropriate query parameters.
888
	 *
889
	 * @param  array  $args Optional query parameters.
890
	 * @return string       WordPress.com SSO URL
891
	 */
892
	function build_sso_url( $args = array() ) {
893
		$sso_nonce = ! empty( $args['sso_nonce'] ) ? $args['sso_nonce'] : self::request_initial_nonce();
894
		$defaults = array(
895
			'action'       => 'jetpack-sso',
896
			'site_id'      => Jetpack_Options::get_option( 'id' ),
897
			'sso_nonce'    => $sso_nonce,
898
			'calypso_auth' => '1',
899
		);
900
901
		$args = wp_parse_args( $args, $defaults );
902
903
		if ( is_wp_error( $args['sso_nonce'] ) ) {
904
			return $args['sso_nonce'];
905
		}
906
907
		return add_query_arg( $args, 'https://wordpress.com/wp-login.php' );
908
	}
909
910
	/**
911
	 * Build WordPress.com SSO URL with appropriate query parameters,
912
	 * including the parameters necessary to force the user to reauthenticate
913
	 * on WordPress.com.
914
	 *
915
	 * @param  array  $args Optional query parameters.
916
	 * @return string       WordPress.com SSO URL
917
	 */
918
	function build_reauth_and_sso_url( $args = array() ) {
919
		$sso_nonce = ! empty( $args['sso_nonce'] ) ? $args['sso_nonce'] : self::request_initial_nonce();
920
		$redirect = $this->build_sso_url( array( 'force_auth' => '1', 'sso_nonce' => $sso_nonce ) );
921
922
		if ( is_wp_error( $redirect ) ) {
923
			return $redirect;
924
		}
925
926
		$defaults = array(
927
			'action'       => 'jetpack-sso',
928
			'site_id'      => Jetpack_Options::get_option( 'id' ),
929
			'sso_nonce'    => $sso_nonce,
930
			'reauth'       => '1',
931
			'redirect_to'  => urlencode( $redirect ),
932
			'calypso_auth' => '1',
933
		);
934
935
		$args = wp_parse_args( $args, $defaults );
936
937
		if ( is_wp_error( $args['sso_nonce'] ) ) {
938
			return $args['sso_nonce'];
939
		}
940
941
		return add_query_arg( $args, 'https://wordpress.com/wp-login.php' );
942
	}
943
944
	/**
945
	 * Determines local user associated with a given WordPress.com user ID.
946
	 *
947
	 * @since 2.6.0
948
	 *
949
	 * @param int $wpcom_user_id User ID from WordPress.com
950
	 * @return object Local user object if found, null if not.
951
	 */
952
	static function get_user_by_wpcom_id( $wpcom_user_id ) {
953
		$user_query = new WP_User_Query( array(
954
			'meta_key'   => 'wpcom_user_id',
955
			'meta_value' => intval( $wpcom_user_id ),
956
			'number'     => 1,
957
		) );
958
959
		$users = $user_query->get_results();
960
		return $users ? array_shift( $users ) : null;
961
	}
962
963
	/**
964
	 * When jetpack-sso-auth-redirect query parameter is set, will redirect user to
965
	 * WordPress.com authorization flow.
966
	 *
967
	 * We redirect here instead of in handle_login() because Jetpack::init()->build_connect_url
968
	 * calls menu_page_url() which doesn't work properly until admin menus are registered.
969
	 */
970
	function maybe_authorize_user_after_sso() {
971
		if ( empty( $_GET['jetpack-sso-auth-redirect'] ) ) {
972
			return;
973
		}
974
975
		$redirect_to = ! empty( $_GET['redirect_to'] ) ? esc_url_raw( $_GET['redirect_to'] ) : admin_url();
976
		$request_redirect_to = ! empty( $_GET['request_redirect_to'] ) ? esc_url_raw( $_GET['request_redirect_to'] ) : $redirect_to;
977
978
		/** This filter is documented in core/src/wp-login.php */
979
		$redirect_after_auth = apply_filters( 'login_redirect', $redirect_to, $request_redirect_to, wp_get_current_user() );
980
981
		/**
982
		 * Since we are passing this redirect to WordPress.com and therefore can not use wp_safe_redirect(),
983
		 * let's sanitize it here to make sure it's safe. If the redirect is not safe, then use admin_url().
984
		 */
985
		$redirect_after_auth = wp_sanitize_redirect( $redirect_after_auth );
986
		$redirect_after_auth = wp_validate_redirect( $redirect_after_auth, admin_url() );
987
988
		/**
989
		 * Return the raw connect URL with our redirect and attribute connection to SSO.
990
		 */
991
		$connect_url = Jetpack::init()->build_connect_url( true, $redirect_after_auth, 'sso' );
992
993
		add_filter( 'allowed_redirect_hosts', array( 'Jetpack_SSO_Helpers', 'allowed_redirect_hosts' ) );
994
		wp_safe_redirect( $connect_url );
995
		exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method maybe_authorize_user_after_sso() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
996
	}
997
998
	/**
999
	 * Cache user's display name and Gravatar so it can be displayed on the login screen. These cookies are
1000
	 * stored when the user logs out, and then deleted when the user logs in.
1001
	 */
1002
	function store_wpcom_profile_cookies_on_logout() {
1003
		if ( ! Jetpack::is_user_connected( get_current_user_id() ) ) {
1004
			return;
1005
		}
1006
1007
		$user_data = $this->get_user_data( get_current_user_id() );
1008
		if ( ! $user_data ) {
1009
			return;
1010
		}
1011
1012
		setcookie(
1013
			'jetpack_sso_wpcom_name_' . COOKIEHASH,
1014
			$user_data->display_name,
1015
			time() + WEEK_IN_SECONDS,
1016
			COOKIEPATH,
1017
			COOKIE_DOMAIN
1018
		);
1019
1020
		setcookie(
1021
			'jetpack_sso_wpcom_gravatar_' . COOKIEHASH,
1022
			get_avatar_url(
1023
				$user_data->email,
1024
				array( 'size' => 144, 'default' => 'mystery' )
1025
			),
1026
			time() + WEEK_IN_SECONDS,
1027
			COOKIEPATH,
1028
			COOKIE_DOMAIN
1029
		);
1030
	}
1031
1032
	/**
1033
	 * Determines if a local user is connected to WordPress.com
1034
	 *
1035
	 * @since 2.8
1036
	 * @param integer $user_id - Local user id
1037
	 * @return boolean
1038
	 **/
1039
	public function is_user_connected( $user_id ) {
1040
		return $this->get_user_data( $user_id );
1041
	}
1042
1043
	/**
1044
	 * Retrieves a user's WordPress.com data
1045
	 *
1046
	 * @since 2.8
1047
	 * @param integer $user_id - Local user id
1048
	 * @return mixed null or stdClass
1049
	 **/
1050
	public function get_user_data( $user_id ) {
1051
		return get_user_meta( $user_id, 'wpcom_user_data', true );
1052
	}
1053
}
1054
1055
Jetpack_SSO::get_instance();
1056