PluginProbe
Jetpack – WP Security, Backup, Speed, & Growth / 4.4.5
Jetpack – WP Security, Backup, Speed, & Growth v4.4.5
16.2-beta 12.0.3 12.1.3 12.2.3 12.3.2 12.4.2 12.5.2 12.6.4 12.7.3 12.8.3 12.9.5 13.0.2 13.1.5 13.2.4 13.3.3 13.4.5 13.5.2 13.6.2 13.7.2 13.8.3 13.9.2 14.0.1 14.1.1 14.2.2 14.3.1 All 501 releases
jetpack / modules / sso.php

sso.php in Jetpack – WP Security, Backup, Speed, & Growth 4.4.5, at modules/sso.php

1,017 lines 31.6 KB
No matching file
Up and down to move Enter to open Esc to close
Raw Download Zip
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;
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;
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 ) {
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 ( ! in_array( $action, array( 'jetpack-sso', 'login' ) ) ) {
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 ( ! in_array( $action, array( 'jetpack-sso', 'login' ) ) ) {
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 ( 'login' == $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 /**
371 * Check to see if the site admin wants to automagically forward the user
372 * to the WordPress.com login page AND that the request to wp-login.php
373 * is not something other than login (Like logout!)
374 */
375 if (
376 $this->wants_to_login()
377 && Jetpack_SSO_Helpers::bypass_login_forward_wpcom()
378 ) {
379 add_filter( 'allowed_redirect_hosts', array( 'Jetpack_SSO_Helpers', 'allowed_redirect_hosts' ) );
380 $this->maybe_save_cookie_redirect();
381 $reauth = ! empty( $_GET['force_reauth'] );
382 $sso_url = $this->get_sso_url_or_die( $reauth );
383 JetpackTracking::record_user_event( 'sso_login_redirect_bypass_success' );
384 wp_safe_redirect( $sso_url );
385 exit;
386 }
387
388 if ( 'login' === $action ) {
389 $this->display_sso_login_form();
390 } elseif ( 'jetpack-sso' === $action ) {
391 if ( isset( $_GET['result'], $_GET['user_id'], $_GET['sso_nonce'] ) && 'success' == $_GET['result'] ) {
392 $this->handle_login();
393 $this->display_sso_login_form();
394 } else {
395 if ( Jetpack::is_staging_site() ) {
396 add_filter( 'login_message', array( 'Jetpack_SSO_Notices', 'sso_not_allowed_in_staging' ) );
397 } else {
398 $this->maybe_save_cookie_redirect();
399 // Is it wiser to just use wp_redirect than do this runaround to wp_safe_redirect?
400 add_filter( 'allowed_redirect_hosts', array( 'Jetpack_SSO_Helpers', 'allowed_redirect_hosts' ) );
401 $reauth = ! empty( $_GET['force_reauth'] );
402 $sso_url = $this->get_sso_url_or_die( $reauth );
403 JetpackTracking::record_user_event( 'sso_login_redirect_success' );
404 wp_safe_redirect( $sso_url );
405 exit;
406 }
407 }
408 }
409 }
410
411 /**
412 * Ensures that we can get a nonce from WordPress.com via XML-RPC before setting
413 * up the hooks required to display the SSO form.
414 */
415 public function display_sso_login_form() {
416 add_filter( 'login_body_class', array( $this, 'login_body_class' ) );
417 add_action( 'login_head', array( $this, 'print_inline_admin_css' ) );
418
419 if ( Jetpack::is_staging_site() ) {
420 add_filter( 'login_message', array( 'Jetpack_SSO_Notices', 'sso_not_allowed_in_staging' ) );
421 return;
422 }
423
424 $sso_nonce = self::request_initial_nonce();
425 if ( is_wp_error( $sso_nonce ) ) {
426 return;
427 }
428
429 add_action( 'login_form', array( $this, 'login_form' ) );
430 add_action( 'login_enqueue_scripts', array( $this, 'login_enqueue_scripts' ) );
431 }
432
433 /**
434 * Conditionally save the redirect_to url as a cookie.
435 */
436 public static function maybe_save_cookie_redirect() {
437 if ( headers_sent() ) {
438 return new WP_Error( 'headers_sent', __( 'Cannot deal with cookie redirects, as headers are already sent.', 'jetpack' ) );
439 }
440
441 if ( ! empty( $_GET['redirect_to'] ) ) {
442 // If we have something to redirect to
443 $url = esc_url_raw( $_GET['redirect_to'] );
444 setcookie( 'jetpack_sso_redirect_to', $url, time() + HOUR_IN_SECONDS, COOKIEPATH, COOKIE_DOMAIN, false, true );
445
446 } elseif ( ! empty( $_COOKIE['jetpack_sso_redirect_to'] ) ) {
447 // Otherwise, if it's already set, purge it.
448 setcookie( 'jetpack_sso_redirect_to', ' ', time() - YEAR_IN_SECONDS, COOKIEPATH, COOKIE_DOMAIN );
449 }
450 }
451
452 /**
453 * Outputs the Jetpack SSO button and description as well as the toggle link
454 * for switching between Jetpack SSO and default login.
455 */
456 function login_form() {
457 $site_name = get_bloginfo( 'name' );
458 if ( ! $site_name ) {
459 $site_name = get_bloginfo( 'url' );
460 }
461
462 $display_name = ! empty( $_COOKIE[ 'jetpack_sso_wpcom_name_' . COOKIEHASH ] )
463 ? $_COOKIE[ 'jetpack_sso_wpcom_name_' . COOKIEHASH ]
464 : false;
465 $gravatar = ! empty( $_COOKIE[ 'jetpack_sso_wpcom_gravatar_' . COOKIEHASH ] )
466 ? $_COOKIE[ 'jetpack_sso_wpcom_gravatar_' . COOKIEHASH ]
467 : false;
468
469 ?>
470 <div id="jetpack-sso-wrap">
471 <?php if ( $display_name && $gravatar ) : ?>
472 <div id="jetpack-sso-wrap__user">
473 <img width="72" height="72" src="<?php echo esc_html( $gravatar ); ?>" />
474
475 <h2>
476 <?php
477 echo wp_kses(
478 sprintf( __( 'Log in as <span>%s</span>', 'jetpack' ), esc_html( $display_name ) ),
479 array( 'span' => true )
480 );
481 ?>
482 </h2>
483 </div>
484
485 <?php endif; ?>
486
487
488 <div id="jetpack-sso-wrap__action">
489 <?php echo $this->build_sso_button( array(), 'is_primary' ); ?>
490
491 <?php if ( $display_name && $gravatar ) : ?>
492 <a rel="nofollow" class="jetpack-sso-wrap__reauth" href="<?php echo esc_url( $this->build_sso_button_url( array( 'force_reauth' => '1' ) ) ); ?>">
493 <?php esc_html_e( 'Log in as a different WordPress.com user', 'jetpack' ); ?>
494 </a>
495 <?php else : ?>
496 <p>
497 <?php
498 echo esc_html(
499 sprintf(
500 __( 'You can now save time spent logging in by connecting your WordPress.com account to %s.', 'jetpack' ),
501 esc_html( $site_name )
502 )
503 );
504 ?>
505 </p>
506 <?php endif; ?>
507 </div>
508
509 <?php if ( ! Jetpack_SSO_Helpers::should_hide_login_form() ) : ?>
510 <div class="jetpack-sso-or">
511 <span><?php esc_html_e( 'Or', 'jetpack' ); ?></span>
512 </div>
513
514 <a href="<?php echo esc_url( add_query_arg( 'jetpack-sso-show-default-form', '1' ) ); ?>" class="jetpack-sso-toggle wpcom">
515 <?php
516 esc_html_e( 'Log in with username and password', 'jetpack' )
517 ?>
518 </a>
519
520 <a href="<?php echo esc_url( add_query_arg( 'jetpack-sso-show-default-form', '0' ) ); ?>" class="jetpack-sso-toggle default">
521 <?php
522 esc_html_e( 'Log in with WordPress.com', 'jetpack' )
523 ?>
524 </a>
525 <?php endif; ?>
526 </div>
527 <?php
528 }
529
530 /**
531 * Clear the cookies that store the profile information for the last
532 * WPCOM user to connect.
533 */
534 static function clear_wpcom_profile_cookies() {
535 if ( isset( $_COOKIE[ 'jetpack_sso_wpcom_name_' . COOKIEHASH ] ) ) {
536 setcookie(
537 'jetpack_sso_wpcom_name_' . COOKIEHASH,
538 ' ',
539 time() - YEAR_IN_SECONDS,
540 COOKIEPATH,
541 COOKIE_DOMAIN
542 );
543 }
544
545 if ( isset( $_COOKIE[ 'jetpack_sso_wpcom_gravatar_' . COOKIEHASH ] ) ) {
546 setcookie(
547 'jetpack_sso_wpcom_gravatar_' . COOKIEHASH,
548 ' ',
549 time() - YEAR_IN_SECONDS,
550 COOKIEPATH,
551 COOKIE_DOMAIN
552 );
553 }
554 }
555
556 static function delete_connection_for_user( $user_id ) {
557 if ( ! $wpcom_user_id = get_user_meta( $user_id, 'wpcom_user_id', true ) ) {
558 return;
559 }
560 Jetpack::load_xml_rpc_client();
561 $xml = new Jetpack_IXR_Client( array(
562 'wpcom_user_id' => $user_id,
563 ) );
564 $xml->query( 'jetpack.sso.removeUser', $wpcom_user_id );
565
566 if ( $xml->isError() ) {
567 return false;
568 }
569
570 // Clean up local data stored for SSO
571 delete_user_meta( $user_id, 'wpcom_user_id' );
572 delete_user_meta( $user_id, 'wpcom_user_data' );
573 self::clear_wpcom_profile_cookies();
574
575 return $xml->getResponse();
576 }
577
578 static function request_initial_nonce() {
579 Jetpack::load_xml_rpc_client();
580 $xml = new Jetpack_IXR_Client( array(
581 'user_id' => get_current_user_id(),
582 ) );
583 $xml->query( 'jetpack.sso.requestNonce' );
584
585 if ( $xml->isError() ) {
586 return new WP_Error( $xml->getErrorCode(), $xml->getErrorMessage() );
587 }
588
589 return $xml->getResponse();
590 }
591
592 /**
593 * The function that actually handles the login!
594 */
595 function handle_login() {
596 $wpcom_nonce = sanitize_key( $_GET['sso_nonce'] );
597 $wpcom_user_id = (int) $_GET['user_id'];
598
599 Jetpack::load_xml_rpc_client();
600 $xml = new Jetpack_IXR_Client( array(
601 'user_id' => get_current_user_id(),
602 ) );
603 $xml->query( 'jetpack.sso.validateResult', $wpcom_nonce, $wpcom_user_id );
604
605 $user_data = $xml->isError() ? false : $xml->getResponse();
606 if ( empty( $user_data ) ) {
607 add_filter( 'jetpack_sso_default_to_sso_login', '__return_false' );
608 add_filter( 'login_message', array( 'Jetpack_SSO_Notices', 'error_invalid_response_data' ) );
609 return;
610 }
611
612 $user_data = (object) $user_data;
613 $user = null;
614
615 /**
616 * Fires before Jetpack's SSO modifies the log in form.
617 *
618 * @module sso
619 *
620 * @since 2.6.0
621 *
622 * @param object $user_data WordPress.com User information.
623 */
624 do_action( 'jetpack_sso_pre_handle_login', $user_data );
625
626 if ( Jetpack_SSO_Helpers::is_two_step_required() && 0 === (int) $user_data->two_step_enabled ) {
627 $this->user_data = $user_data;
628
629 JetpackTracking::record_user_event( 'sso_login_failed', array(
630 'error_message' => 'error_msg_enable_two_step'
631 ) );
632
633 /** This filter is documented in core/src/wp-includes/pluggable.php */
634 do_action( 'wp_login_failed', $user_data->login );
635 add_filter( 'login_message', array( 'Jetpack_SSO_Notices', 'error_msg_enable_two_step' ) );
636 return;
637 }
638
639 $user_found_with = '';
640 if ( empty( $user ) && isset( $user_data->external_user_id ) ) {
641 $user_found_with = 'external_user_id';
642 $user = get_user_by( 'id', intval( $user_data->external_user_id ) );
643 if ( $user ) {
644 update_user_meta( $user->ID, 'wpcom_user_id', $user_data->ID );
645 }
646 }
647
648 // If we don't have one by wpcom_user_id, try by the email?
649 if ( empty( $user ) && Jetpack_SSO_Helpers::match_by_email() ) {
650 $user_found_with = 'match_by_email';
651 $user = get_user_by( 'email', $user_data->email );
652 if ( $user ) {
653 update_user_meta( $user->ID, 'wpcom_user_id', $user_data->ID );
654 }
655 }
656
657 // If we've still got nothing, create the user.
658 if ( empty( $user ) && ( get_option( 'users_can_register' ) || Jetpack_SSO_Helpers::new_user_override() ) ) {
659 /**
660 * If not matching by email we still need to verify the email does not exist
661 * or this blows up
662 *
663 * If match_by_email is true, we know the email doesn't exist, as it would have
664 * been found in the first pass. If get_user_by( 'email' ) doesn't find the
665 * user, then we know that email is unused, so it's safe to add.
666 */
667 if ( Jetpack_SSO_Helpers::match_by_email() || ! get_user_by( 'email', $user_data->email ) ) {
668 $user = Jetpack_SSO_Helpers::generate_user( $user_data );
669 if ( ! $user ) {
670 JetpackTracking::record_user_event( 'sso_login_failed', array(
671 'error_message' => 'could_not_create_username'
672 ) );
673 add_filter( 'login_message', array( 'Jetpack_SSO_Notices', 'error_unable_to_create_user' ) );
674 return;
675 }
676
677 $user_found_with = Jetpack_SSO_Helpers::new_user_override()
678 ? 'user_created_new_user_override'
679 : 'user_created_users_can_register';
680 } else {
681 JetpackTracking::record_user_event( 'sso_login_failed', array(
682 'error_message' => 'error_msg_email_already_exists'
683 ) );
684
685 $this->user_data = $user_data;
686 add_action( 'login_message', array( 'Jetpack_SSO_Notices', 'error_msg_email_already_exists' ) );
687 return;
688 }
689 }
690
691 /**
692 * Fires after we got login information from WordPress.com.
693 *
694 * @module sso
695 *
696 * @since 2.6.0
697 *
698 * @param array $user Local User information.
699 * @param object $user_data WordPress.com User Login information.
700 */
701 do_action( 'jetpack_sso_handle_login', $user, $user_data );
702
703 if ( $user ) {
704 // Cache the user's details, so we can present it back to them on their user screen
705 update_user_meta( $user->ID, 'wpcom_user_data', $user_data );
706
707 add_filter( 'auth_cookie_expiration', array( 'Jetpack_SSO_Helpers', 'extend_auth_cookie_expiration_for_sso' ) );
708 wp_set_auth_cookie( $user->ID, true );
709 remove_filter( 'auth_cookie_expiration', array( 'Jetpack_SSO_Helpers', 'extend_auth_cookie_expiration_for_sso' ) );
710
711 /** This filter is documented in core/src/wp-includes/user.php */
712 do_action( 'wp_login', $user->user_login, $user );
713
714 wp_set_current_user( $user->ID );
715
716 $_request_redirect_to = isset( $_REQUEST['redirect_to'] ) ? esc_url_raw( $_REQUEST['redirect_to'] ) : '';
717 $redirect_to = user_can( $user, 'edit_posts' ) ? admin_url() : self::profile_page_url();
718
719 // If we have a saved redirect to request in a cookie
720 if ( ! empty( $_COOKIE['jetpack_sso_redirect_to'] ) ) {
721 // Set that as the requested redirect to
722 $redirect_to = $_request_redirect_to = esc_url_raw( $_COOKIE['jetpack_sso_redirect_to'] );
723 // And then purge it
724 setcookie( 'jetpack_sso_redirect_to', ' ', time() - YEAR_IN_SECONDS, COOKIEPATH, COOKIE_DOMAIN );
725 }
726
727 $is_user_connected = Jetpack::is_user_connected( $user->ID );
728 JetpackTracking::record_user_event( 'sso_user_logged_in', array(
729 'user_found_with' => $user_found_with,
730 'user_connected' => (bool) $is_user_connected,
731 'user_role' => Jetpack::translate_current_user_to_role()
732 ) );
733
734 if ( ! $is_user_connected ) {
735 $calypso_env = ! empty( $_GET['calypso_env'] )
736 ? sanitize_key( $_GET['calypso_env'] )
737 : '';
738
739 wp_safe_redirect(
740 add_query_arg(
741 array(
742 'redirect_to' => $redirect_to,
743 'request_redirect_to' => $_request_redirect_to,
744 'calypso_env' => $calypso_env,
745 'jetpack-sso-auth-redirect' => '1',
746 ),
747 admin_url()
748 )
749 );
750 exit;
751 }
752
753 wp_safe_redirect(
754 /** This filter is documented in core/src/wp-login.php */
755 apply_filters( 'login_redirect', $redirect_to, $_request_redirect_to, $user )
756 );
757 exit;
758 }
759
760 add_filter( 'jetpack_sso_default_to_sso_login', '__return_false' );
761
762 JetpackTracking::record_user_event( 'sso_login_failed', array(
763 'error_message' => 'cant_find_user'
764 ) );
765
766 $this->user_data = $user_data;
767 /** This filter is documented in core/src/wp-includes/pluggable.php */
768 do_action( 'wp_login_failed', $user_data->login );
769 add_filter( 'login_message', array( 'Jetpack_SSO_Notices', 'cant_find_user' ) );
770 }
771
772 static function profile_page_url() {
773 return admin_url( 'profile.php' );
774 }
775
776 /**
777 * Builds the "Login to WordPress.com" button that is displayed on the login page as well as user profile page.
778 *
779 * @param array $args An array of arguments to add to the SSO URL.
780 * @param boolean $is_primary Should the button have the `button-primary` class?
781 * @return string Returns the HTML markup for the button.
782 */
783 function build_sso_button( $args = array(), $is_primary = false ) {
784 $url = $this->build_sso_button_url( $args );
785 $classes = $is_primary
786 ? 'jetpack-sso button button-primary'
787 : 'jetpack-sso button';
788
789 return sprintf(
790 '<a rel="nofollow" href="%1$s" class="%2$s"><span>%3$s %4$s</span></a>',
791 esc_url( $url ),
792 $classes,
793 '<span class="genericon genericon-wordpress"></span>',
794 esc_html__( 'Log in with WordPress.com', 'jetpack' )
795 );
796 }
797
798 /**
799 * Builds a URL with `jetpack-sso` action and option args which is used to setup SSO.
800 *
801 * @param array $args An array of arguments to add to the SSO URL.
802 * @return string The URL used for SSO.
803 */
804 function build_sso_button_url( $args = array() ) {
805 $defaults = array(
806 'action' => 'jetpack-sso',
807 );
808
809 $args = wp_parse_args( $args, $defaults );
810
811 if ( ! empty( $_GET['redirect_to'] ) ) {
812 $args['redirect_to'] = urlencode( esc_url_raw( $_GET['redirect_to'] ) );
813 }
814
815 return add_query_arg( $args, wp_login_url() );
816 }
817
818 /**
819 * Retrieves a WordPress.com SSO URL with appropriate query parameters or dies.
820 *
821 * @param boolean $reauth Should the user be forced to reauthenticate on WordPress.com?
822 * @param array $args Optional query parameters.
823 * @return string The WordPress.com SSO URL.
824 */
825 function get_sso_url_or_die( $reauth = false, $args = array() ) {
826 if ( empty( $reauth ) ) {
827 $sso_redirect = $this->build_sso_url( $args );
828 } else {
829 self::clear_wpcom_profile_cookies();
830 $sso_redirect = $this->build_reauth_and_sso_url( $args );
831 }
832
833 // If there was an error retrieving the SSO URL, then error.
834 if ( is_wp_error( $sso_redirect ) ) {
835 $error_message = sanitize_text_field(
836 sprintf( '%s: %s', $sso_redirect->get_error_code(), $sso_redirect->get_error_message() )
837 );
838 JetpackTracking::record_user_event( 'sso_login_redirect_failed', array(
839 'error_message' => $error_message
840 ) );
841 wp_die( $error_message );
842 }
843
844 return $sso_redirect;
845 }
846
847 /**
848 * Build WordPress.com SSO URL with appropriate query parameters.
849 *
850 * @param array $args Optional query parameters.
851 * @return string WordPress.com SSO URL
852 */
853 function build_sso_url( $args = array() ) {
854 $sso_nonce = ! empty( $args['sso_nonce'] ) ? $args['sso_nonce'] : self::request_initial_nonce();
855 $defaults = array(
856 'action' => 'jetpack-sso',
857 'site_id' => Jetpack_Options::get_option( 'id' ),
858 'sso_nonce' => $sso_nonce,
859 'calypso_auth' => '1',
860 );
861
862 $args = wp_parse_args( $args, $defaults );
863
864 if ( is_wp_error( $args['sso_nonce'] ) ) {
865 return $args['sso_nonce'];
866 }
867
868 return add_query_arg( $args, 'https://wordpress.com/wp-login.php' );
869 }
870
871 /**
872 * Build WordPress.com SSO URL with appropriate query parameters,
873 * including the parameters necessary to force the user to reauthenticate
874 * on WordPress.com.
875 *
876 * @param array $args Optional query parameters.
877 * @return string WordPress.com SSO URL
878 */
879 function build_reauth_and_sso_url( $args = array() ) {
880 $sso_nonce = ! empty( $args['sso_nonce'] ) ? $args['sso_nonce'] : self::request_initial_nonce();
881 $redirect = $this->build_sso_url( array( 'force_auth' => '1', 'sso_nonce' => $sso_nonce ) );
882
883 if ( is_wp_error( $redirect ) ) {
884 return $redirect;
885 }
886
887 $defaults = array(
888 'action' => 'jetpack-sso',
889 'site_id' => Jetpack_Options::get_option( 'id' ),
890 'sso_nonce' => $sso_nonce,
891 'reauth' => '1',
892 'redirect_to' => urlencode( $redirect ),
893 'calypso_auth' => '1',
894 );
895
896 $args = wp_parse_args( $args, $defaults );
897
898 if ( is_wp_error( $args['sso_nonce'] ) ) {
899 return $args['sso_nonce'];
900 }
901
902 return add_query_arg( $args, 'https://wordpress.com/wp-login.php' );
903 }
904
905 /**
906 * Determines local user associated with a given WordPress.com user ID.
907 *
908 * @since 2.6.0
909 *
910 * @param int $wpcom_user_id User ID from WordPress.com
911 * @return object Local user object if found, null if not.
912 */
913 static function get_user_by_wpcom_id( $wpcom_user_id ) {
914 $user_query = new WP_User_Query( array(
915 'meta_key' => 'wpcom_user_id',
916 'meta_value' => intval( $wpcom_user_id ),
917 'number' => 1,
918 ) );
919
920 $users = $user_query->get_results();
921 return $users ? array_shift( $users ) : null;
922 }
923
924 /**
925 * When jetpack-sso-auth-redirect query parameter is set, will redirect user to
926 * WordPress.com authorization flow.
927 *
928 * We redirect here instead of in handle_login() because Jetpack::init()->build_connect_url
929 * calls menu_page_url() which doesn't work properly until admin menus are registered.
930 */
931 function maybe_authorize_user_after_sso() {
932 if ( empty( $_GET['jetpack-sso-auth-redirect'] ) ) {
933 return;
934 }
935
936 $redirect_to = ! empty( $_GET['redirect_to'] ) ? esc_url_raw( $_GET['redirect_to'] ) : admin_url();
937 $request_redirect_to = ! empty( $_GET['request_redirect_to'] ) ? esc_url_raw( $_GET['request_redirect_to'] ) : $redirect_to;
938
939 /** This filter is documented in core/src/wp-login.php */
940 $redirect_after_auth = apply_filters( 'login_redirect', $redirect_to, $request_redirect_to, wp_get_current_user() );
941
942 /**
943 * Since we are passing this redirect to WordPress.com and therefore can not use wp_safe_redirect(),
944 * let's sanitize it here to make sure it's safe. If the redirect is not safe, then use admin_url().
945 */
946 $redirect_after_auth = wp_sanitize_redirect( $redirect_after_auth );
947 $redirect_after_auth = wp_validate_redirect( $redirect_after_auth, admin_url() );
948
949 /**
950 * Return the raw connect URL with our redirect and attribute connection to SSO.
951 */
952 $connect_url = Jetpack::init()->build_connect_url( true, $redirect_after_auth, 'sso' );
953
954 add_filter( 'allowed_redirect_hosts', array( 'Jetpack_SSO_Helpers', 'allowed_redirect_hosts' ) );
955 wp_safe_redirect( $connect_url );
956 exit;
957 }
958
959 /**
960 * Cache user's display name and Gravatar so it can be displayed on the login screen. These cookies are
961 * stored when the user logs out, and then deleted when the user logs in.
962 */
963 function store_wpcom_profile_cookies_on_logout() {
964 if ( ! Jetpack::is_user_connected( get_current_user_id() ) ) {
965 return;
966 }
967
968 $user_data = $this->get_user_data( get_current_user_id() );
969 if ( ! $user_data ) {
970 return;
971 }
972
973 setcookie(
974 'jetpack_sso_wpcom_name_' . COOKIEHASH,
975 $user_data->display_name,
976 time() + WEEK_IN_SECONDS,
977 COOKIEPATH,
978 COOKIE_DOMAIN
979 );
980
981 setcookie(
982 'jetpack_sso_wpcom_gravatar_' . COOKIEHASH,
983 get_avatar_url(
984 $user_data->email,
985 array( 'size' => 144, 'default' => 'mystery' )
986 ),
987 time() + WEEK_IN_SECONDS,
988 COOKIEPATH,
989 COOKIE_DOMAIN
990 );
991 }
992
993 /**
994 * Determines if a local user is connected to WordPress.com
995 *
996 * @since 2.8
997 * @param integer $user_id - Local user id
998 * @return boolean
999 **/
1000 public function is_user_connected( $user_id ) {
1001 return $this->get_user_data( $user_id );
1002 }
1003
1004 /**
1005 * Retrieves a user's WordPress.com data
1006 *
1007 * @since 2.8
1008 * @param integer $user_id - Local user id
1009 * @return mixed null or stdClass
1010 **/
1011 public function get_user_data( $user_id ) {
1012 return get_user_meta( $user_id, 'wpcom_user_data', true );
1013 }
1014 }
1015
1016 Jetpack_SSO::get_instance();
1017