File Editor
Directories:
.. (Back)
calypsoify
carousel
comment-likes
comments
contact-form
custom-css
custom-post-types
geo-location
google-analytics
gravatar
infinite-scroll
likes
markdown
masterbar
memberships
photon
photon-cdn
plugin-search
post-by-email
protect
publicize
pwa
related-posts
scan
search
seo-tools
sharedaddy
shortcodes
simple-payments
site-icon
sitemaps
sso
subscriptions
theme-tools
tiled-gallery
verification-tools
videopress
widget-visibility
widgets
woocommerce-analytics
wordads
wpcom-block-editor
wpcom-tos
Files:
.eslintrc.js
after-the-deadline.php
carousel.php
comment-likes.php
comments.php
contact-form.php
copy-post.php
custom-content-types.php
custom-css.php
enhanced-distribution.php
geo-location.php
google-analytics.php
gravatar-hovercards.php
infinite-scroll.php
json-api.php
latex.php
lazy-images.php
likes.php
markdown.php
masterbar.php
minileven.php
mobile-push.php
module-extras.php
module-headings.php
module-info.php
monitor.php
notes.php
photon-cdn.php
photon.php
plugin-search.php
post-by-email.php
protect.php
publicize.php
pwa.php
related-posts.php
search.php
seo-tools.php
sharedaddy.php
shortcodes.php
shortlinks.php
sitemaps.php
sso.php
stats.php
subscriptions.php
theme-tools.php
tiled-gallery.php
vaultpress.php
verification-tools.php
videopress.php
widget-visibility.php
widgets.php
woocommerce-analytics.php
wordads.php
wpgroho.js
Create New File
Create
Edit File: sso.php
<?php use Automattic\Jetpack\Roles; use Automattic\Jetpack\Status; use Automattic\Jetpack\Tracking; use Automattic\Jetpack\Redirect; require_once( JETPACK__PLUGIN_DIR . 'modules/sso/class.jetpack-sso-helpers.php' ); require_once( JETPACK__PLUGIN_DIR . 'modules/sso/class.jetpack-sso-notices.php' ); /** * Module Name: Secure Sign On * Module Description: Allow users to log in to this site using WordPress.com accounts * Sort Order: 30 * Recommendation Order: 5 * First Introduced: 2.6 * Requires Connection: Yes * Auto Activate: No * Module Tags: Developers * Feature: Security * Additional Search Queries: sso, single sign on, login, log in, 2fa, two-factor */ class Jetpack_SSO { static $instance = null; private function __construct() { self::$instance = $this; add_action( 'admin_init', array( $this, 'maybe_authorize_user_after_sso' ), 1 ); add_action( 'admin_init', array( $this, 'register_settings' ) ); add_action( 'login_init', array( $this, 'login_init' ) ); add_action( 'delete_user', array( $this, 'delete_connection_for_user' ) ); add_filter( 'jetpack_xmlrpc_methods', array( $this, 'xmlrpc_methods' ) ); add_action( 'init', array( $this, 'maybe_logout_user' ), 5 ); add_action( 'jetpack_modules_loaded', array( $this, 'module_configure_button' ) ); add_action( 'login_form_logout', array( $this, 'store_wpcom_profile_cookies_on_logout' ) ); add_action( 'jetpack_unlinked_user', array( $this, 'delete_connection_for_user') ); add_action( 'wp_login', array( 'Jetpack_SSO', 'clear_cookies_after_login' ) ); // Adding this action so that on login_init, the action won't be sanitized out of the $action global. add_action( 'login_form_jetpack-sso', '__return_true' ); } /** * Returns the single instance of the Jetpack_SSO object * * @since 2.8 * @return Jetpack_SSO **/ public static function get_instance() { if ( ! is_null( self::$instance ) ) { return self::$instance; } return self::$instance = new Jetpack_SSO; } /** * Add configure button and functionality to the module card on the Jetpack screen **/ public static function module_configure_button() { Jetpack::enable_module_configurable( __FILE__ ); } /** * If jetpack_force_logout == 1 in current user meta the user will be forced * to logout and reauthenticate with the site. **/ public function maybe_logout_user() { global $current_user; if ( 1 == $current_user->jetpack_force_logout ) { delete_user_meta( $current_user->ID, 'jetpack_force_logout' ); self::delete_connection_for_user( $current_user->ID ); wp_logout(); wp_safe_redirect( wp_login_url() ); exit; } } /** * Adds additional methods the WordPress xmlrpc API for handling SSO specific features * * @param array $methods * @return array **/ public function xmlrpc_methods( $methods ) { $methods['jetpack.userDisconnect'] = array( $this, 'xmlrpc_user_disconnect' ); return $methods; } /** * Marks a user's profile for disconnect from WordPress.com and forces a logout * the next time the user visits the site. **/ public function xmlrpc_user_disconnect( $user_id ) { $user_query = new WP_User_Query( array( 'meta_key' => 'wpcom_user_id', 'meta_value' => $user_id, ) ); $user = $user_query->get_results(); $user = $user[0]; if ( $user instanceof WP_User ) { $user = wp_set_current_user( $user->ID ); update_user_meta( $user->ID, 'jetpack_force_logout', '1' ); self::delete_connection_for_user( $user->ID ); return true; } return false; } /** * Enqueues scripts and styles necessary for SSO login. */ public function login_enqueue_scripts() { global $action; if ( ! Jetpack_SSO_Helpers::display_sso_form_for_action( $action ) ) { return; } if ( is_rtl() ) { wp_enqueue_style( 'jetpack-sso-login', plugins_url( 'modules/sso/jetpack-sso-login-rtl.css', JETPACK__PLUGIN_FILE ), array( 'login', 'genericons' ), JETPACK__VERSION ); } else { wp_enqueue_style( 'jetpack-sso-login', plugins_url( 'modules/sso/jetpack-sso-login.css', JETPACK__PLUGIN_FILE ), array( 'login', 'genericons' ), JETPACK__VERSION ); } wp_enqueue_script( 'jetpack-sso-login', plugins_url( 'modules/sso/jetpack-sso-login.js', JETPACK__PLUGIN_FILE ), array( 'jquery' ), JETPACK__VERSION ); } /** * Adds Jetpack SSO classes to login body * * @param array $classes Array of classes to add to body tag * @return array Array of classes to add to body tag */ public function login_body_class( $classes ) { global $action; if ( ! Jetpack_SSO_Helpers::display_sso_form_for_action( $action ) ) { return $classes; } // Always add the jetpack-sso class so that we can add SSO specific styling even when the SSO form isn't being displayed. $classes[] = 'jetpack-sso'; if ( ! ( new Status() )->is_staging_site() ) { /** * Should we show the SSO login form? * * $_GET['jetpack-sso-default-form'] is used to provide a fallback in case JavaScript is not enabled. * * The default_to_sso_login() method allows us to dynamically decide whether we show the SSO login form or not. * The SSO module uses the method to display the default login form if we can not find a user to log in via SSO. * But, the method could be filtered by a site admin to always show the default login form if that is preferred. */ if ( empty( $_GET['jetpack-sso-show-default-form'] ) && Jetpack_SSO_Helpers::show_sso_login() ) { $classes[] = 'jetpack-sso-form-display'; } } return $classes; } public function print_inline_admin_css() { ?> <style> .jetpack-sso .message { margin-top: 20px; } .jetpack-sso #login .message:first-child, .jetpack-sso #login h1 + .message { margin-top: 0; } </style> <?php } /** * Adds settings fields to Settings > General > Secure Sign On that allows users to * turn off the login form on wp-login.php * * @since 2.7 **/ public function register_settings() { add_settings_section( 'jetpack_sso_settings', __( 'Secure Sign On' , 'jetpack' ), '__return_false', 'jetpack-sso' ); /* * Settings > General > Secure Sign On * Require two step authentication */ register_setting( 'jetpack-sso', 'jetpack_sso_require_two_step', array( $this, 'validate_jetpack_sso_require_two_step' ) ); add_settings_field( 'jetpack_sso_require_two_step', '', // __( 'Require Two-Step Authentication' , 'jetpack' ), array( $this, 'render_require_two_step' ), 'jetpack-sso', 'jetpack_sso_settings' ); /* * Settings > General > Secure Sign On */ register_setting( 'jetpack-sso', 'jetpack_sso_match_by_email', array( $this, 'validate_jetpack_sso_match_by_email' ) ); add_settings_field( 'jetpack_sso_match_by_email', '', // __( 'Match by Email' , 'jetpack' ), array( $this, 'render_match_by_email' ), 'jetpack-sso', 'jetpack_sso_settings' ); } /** * Builds the display for the checkbox allowing user to require two step * auth be enabled on WordPress.com accounts before login. Displays in Settings > General * * @since 2.7 **/ public function render_require_two_step() { ?> <label> <input type="checkbox" name="jetpack_sso_require_two_step" <?php checked( Jetpack_SSO_Helpers::is_two_step_required() ); ?> <?php disabled( Jetpack_SSO_Helpers::is_require_two_step_checkbox_disabled() ); ?> > <?php esc_html_e( 'Require Two-Step Authentication' , 'jetpack' ); ?> </label> <?php } /** * Validate the require two step checkbox in Settings > General * * @since 2.7 * @return boolean **/ public function validate_jetpack_sso_require_two_step( $input ) { return ( ! empty( $input ) ) ? 1 : 0; } /** * Builds the display for the checkbox allowing the user to allow matching logins by email * Displays in Settings > General * * @since 2.9 **/ public function render_match_by_email() { ?> <label> <input type="checkbox" name="jetpack_sso_match_by_email" <?php checked( Jetpack_SSO_Helpers::match_by_email() ); ?> <?php disabled( Jetpack_SSO_Helpers::is_match_by_email_checkbox_disabled() ); ?> > <?php esc_html_e( 'Match by Email', 'jetpack' ); ?> </label> <?php } /** * Validate the match by email check in Settings > General * * @since 2.9 * @return boolean **/ public function validate_jetpack_sso_match_by_email( $input ) { return ( ! empty( $input ) ) ? 1 : 0; } /** * Checks to determine if the user wants to login on wp-login * * This function mostly exists to cover the exceptions to login * that may exist as other parameters to $_GET[action] as $_GET[action] * does not have to exist. By default WordPress assumes login if an action * is not set, however this may not be true, as in the case of logout * where $_GET[loggedout] is instead set * * @return boolean **/ private function wants_to_login() { $wants_to_login = false; // Cover default WordPress behavior $action = isset( $_REQUEST['action'] ) ? $_REQUEST['action'] : 'login'; // And now the exceptions $action = isset( $_GET['loggedout'] ) ? 'loggedout' : $action; if ( Jetpack_SSO_Helpers::display_sso_form_for_action( $action ) ) { $wants_to_login = true; } return $wants_to_login; } function login_init() { global $action; $tracking = new Tracking(); if ( Jetpack_SSO_Helpers::should_hide_login_form() ) { /** * Since the default authenticate filters fire at priority 20 for checking username and password, * let's fire at priority 30. wp_authenticate_spam_check is fired at priority 99, but since we return a * WP_Error in disable_default_login_form, then we won't trigger spam processing logic. */ add_filter( 'authenticate', array( 'Jetpack_SSO_Notices', 'disable_default_login_form' ), 30 ); /** * Filter the display of the disclaimer message appearing when default WordPress login form is disabled. * * @module sso * * @since 2.8.0 * * @param bool true Should the disclaimer be displayed. Default to true. */ $display_sso_disclaimer = apply_filters( 'jetpack_sso_display_disclaimer', true ); if ( $display_sso_disclaimer ) { add_filter( 'login_message', array( 'Jetpack_SSO_Notices', 'msg_login_by_jetpack' ) ); } } if ( 'jetpack-sso' === $action ) { if ( isset( $_GET['result'], $_GET['user_id'], $_GET['sso_nonce'] ) && 'success' == $_GET['result'] ) { $this->handle_login(); $this->display_sso_login_form(); } else { if ( ( new Status() )->is_staging_site() ) { add_filter( 'login_message', array( 'Jetpack_SSO_Notices', 'sso_not_allowed_in_staging' ) ); } else { // Is it wiser to just use wp_redirect than do this runaround to wp_safe_redirect? add_filter( 'allowed_redirect_hosts', array( 'Jetpack_SSO_Helpers', 'allowed_redirect_hosts' ) ); $reauth = ! empty( $_GET['force_reauth'] ); $sso_url = $this->get_sso_url_or_die( $reauth ); $tracking->record_user_event( 'sso_login_redirect_success' ); wp_safe_redirect( $sso_url ); exit; } } } else if ( Jetpack_SSO_Helpers::display_sso_form_for_action( $action ) ) { // Save cookies so we can handle redirects after SSO $this->save_cookies(); /** * Check to see if the site admin wants to automagically forward the user * to the WordPress.com login page AND that the request to wp-login.php * is not something other than login (Like logout!) */ if ( Jetpack_SSO_Helpers::bypass_login_forward_wpcom() && $this->wants_to_login() ) { add_filter( 'allowed_redirect_hosts', array( 'Jetpack_SSO_Helpers', 'allowed_redirect_hosts' ) ); $reauth = ! empty( $_GET['force_reauth'] ); $sso_url = $this->get_sso_url_or_die( $reauth ); $tracking->record_user_event( 'sso_login_redirect_bypass_success' ); wp_safe_redirect( $sso_url ); exit; } $this->display_sso_login_form(); } } /** * Ensures that we can get a nonce from WordPress.com via XML-RPC before setting * up the hooks required to display the SSO form. */ public function display_sso_login_form() { add_filter( 'login_body_class', array( $this, 'login_body_class' ) ); add_action( 'login_head', array( $this, 'print_inline_admin_css' ) ); if ( ( new Status() )->is_staging_site() ) { add_filter( 'login_message', array( 'Jetpack_SSO_Notices', 'sso_not_allowed_in_staging' ) ); return; } $sso_nonce = self::request_initial_nonce(); if ( is_wp_error( $sso_nonce ) ) { return; } add_action( 'login_form', array( $this, 'login_form' ) ); add_action( 'login_enqueue_scripts', array( $this, 'login_enqueue_scripts' ) ); } /** * Conditionally save the redirect_to url as a cookie. * * @since 4.6.0 Renamed to save_cookies from maybe_save_redirect_cookies */ public static function save_cookies() { if ( headers_sent() ) { return new WP_Error( 'headers_sent', __( 'Cannot deal with cookie redirects, as headers are already sent.', 'jetpack' ) ); } setcookie( 'jetpack_sso_original_request', esc_url_raw( set_url_scheme( $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] ) ), time() + HOUR_IN_SECONDS, COOKIEPATH, COOKIE_DOMAIN, is_ssl(), true ); if ( ! empty( $_GET['redirect_to'] ) ) { // If we have something to redirect to $url = esc_url_raw( $_GET['redirect_to'] ); setcookie( 'jetpack_sso_redirect_to', $url, time() + HOUR_IN_SECONDS, COOKIEPATH, COOKIE_DOMAIN, is_ssl(), true ); } elseif ( ! empty( $_COOKIE['jetpack_sso_redirect_to'] ) ) { // Otherwise, if it's already set, purge it. setcookie( 'jetpack_sso_redirect_to', ' ', time() - YEAR_IN_SECONDS, COOKIEPATH, COOKIE_DOMAIN ); } } /** * Outputs the Jetpack SSO button and description as well as the toggle link * for switching between Jetpack SSO and default login. */ function login_form() { $site_name = get_bloginfo( 'name' ); if ( ! $site_name ) { $site_name = get_bloginfo( 'url' ); } $display_name = ! empty( $_COOKIE[ 'jetpack_sso_wpcom_name_' . COOKIEHASH ] ) ? $_COOKIE[ 'jetpack_sso_wpcom_name_' . COOKIEHASH ] : false; $gravatar = ! empty( $_COOKIE[ 'jetpack_sso_wpcom_gravatar_' . COOKIEHASH ] ) ? $_COOKIE[ 'jetpack_sso_wpcom_gravatar_' . COOKIEHASH ] : false; ?> <div id="jetpack-sso-wrap"> <?php /** * Allow extension above Jetpack's SSO form. * * @module sso * * @since 8.6.0 */ do_action( 'jetpack_sso_login_form_above_wpcom' ); if ( $display_name && $gravatar ) : ?> <div id="jetpack-sso-wrap__user"> <img width="72" height="72" src="<?php echo esc_html( $gravatar ); ?>" /> <h2> <?php echo wp_kses( sprintf( __( 'Log in as <span>%s</span>', 'jetpack' ), esc_html( $display_name ) ), array( 'span' => true ) ); ?> </h2> </div> <?php endif; ?> <div id="jetpack-sso-wrap__action"> <?php echo $this->build_sso_button( array(), 'is_primary' ); ?> <?php if ( $display_name && $gravatar ) : ?> <a rel="nofollow" class="jetpack-sso-wrap__reauth" href="<?php echo esc_url( $this->build_sso_button_url( array( 'force_reauth' => '1' ) ) ); ?>"> <?php esc_html_e( 'Log in as a different WordPress.com user', 'jetpack' ); ?> </a> <?php else : ?> <p> <?php echo esc_html( sprintf( __( 'You can now save time spent logging in by connecting your WordPress.com account to %s.', 'jetpack' ), esc_html( $site_name ) ) ); ?> </p> <?php endif; ?> </div> <?php /** * Allow extension below Jetpack's SSO form. * * @module sso * * @since 8.6.0 */ do_action( 'jetpack_sso_login_form_below_wpcom' ); if ( ! Jetpack_SSO_Helpers::should_hide_login_form() ) : ?> <div class="jetpack-sso-or"> <span><?php esc_html_e( 'Or', 'jetpack' ); ?></span> </div> <a href="<?php echo esc_url( add_query_arg( 'jetpack-sso-show-default-form', '1' ) ); ?>" class="jetpack-sso-toggle wpcom"> <?php esc_html_e( 'Log in with username and password', 'jetpack' ) ?> </a> <a href="<?php echo esc_url( add_query_arg( 'jetpack-sso-show-default-form', '0' ) ); ?>" class="jetpack-sso-toggle default"> <?php esc_html_e( 'Log in with WordPress.com', 'jetpack' ) ?> </a> <?php endif; ?> </div> <?php } /** * Clear the cookies that store the profile information for the last * WPCOM user to connect. */ static function clear_wpcom_profile_cookies() { if ( isset( $_COOKIE[ 'jetpack_sso_wpcom_name_' . COOKIEHASH ] ) ) { setcookie( 'jetpack_sso_wpcom_name_' . COOKIEHASH, ' ', time() - YEAR_IN_SECONDS, COOKIEPATH, COOKIE_DOMAIN, is_ssl() ); } if ( isset( $_COOKIE[ 'jetpack_sso_wpcom_gravatar_' . COOKIEHASH ] ) ) { setcookie( 'jetpack_sso_wpcom_gravatar_' . COOKIEHASH, ' ', time() - YEAR_IN_SECONDS, COOKIEPATH, COOKIE_DOMAIN, is_ssl() ); } } /** * Clear cookies that are no longer needed once the user has logged in. * * @since 4.8.0 */ static function clear_cookies_after_login() { self::clear_wpcom_profile_cookies(); if ( isset( $_COOKIE[ 'jetpack_sso_nonce' ] ) ) { setcookie( 'jetpack_sso_nonce', ' ', time() - YEAR_IN_SECONDS, COOKIEPATH, COOKIE_DOMAIN, is_ssl() ); } if ( isset( $_COOKIE[ 'jetpack_sso_original_request' ] ) ) { setcookie( 'jetpack_sso_original_request', ' ', time() - YEAR_IN_SECONDS, COOKIEPATH, COOKIE_DOMAIN, is_ssl() ); } if ( isset( $_COOKIE[ 'jetpack_sso_redirect_to' ] ) ) { setcookie( 'jetpack_sso_redirect_to', ' ', time() - YEAR_IN_SECONDS, COOKIEPATH, COOKIE_DOMAIN, is_ssl() ); } } static function delete_connection_for_user( $user_id ) { if ( ! $wpcom_user_id = get_user_meta( $user_id, 'wpcom_user_id', true ) ) { return; } $xml = new Jetpack_IXR_Client( array( 'wpcom_user_id' => $user_id, ) ); $xml->query( 'jetpack.sso.removeUser', $wpcom_user_id ); if ( $xml->isError() ) { return false; } // Clean up local data stored for SSO delete_user_meta( $user_id, 'wpcom_user_id' ); delete_user_meta( $user_id, 'wpcom_user_data' ); self::clear_wpcom_profile_cookies(); return $xml->getResponse(); } static function request_initial_nonce() { $nonce = ! empty( $_COOKIE[ 'jetpack_sso_nonce' ] ) ? $_COOKIE[ 'jetpack_sso_nonce' ] : false; if ( ! $nonce ) { $xml = new Jetpack_IXR_Client(); $xml->query( 'jetpack.sso.requestNonce' ); if ( $xml->isError() ) { return new WP_Error( $xml->getErrorCode(), $xml->getErrorMessage() ); } $nonce = $xml->getResponse(); setcookie( 'jetpack_sso_nonce', $nonce, time() + ( 10 * MINUTE_IN_SECONDS ), COOKIEPATH, COOKIE_DOMAIN, is_ssl() ); } return sanitize_key( $nonce ); } /** * The function that actually handles the login! */ function handle_login() { $wpcom_nonce = sanitize_key( $_GET['sso_nonce'] ); $wpcom_user_id = (int) $_GET['user_id']; $xml = new Jetpack_IXR_Client(); $xml->query( 'jetpack.sso.validateResult', $wpcom_nonce, $wpcom_user_id ); $user_data = $xml->isError() ? false : $xml->getResponse(); if ( empty( $user_data ) ) { add_filter( 'jetpack_sso_default_to_sso_login', '__return_false' ); add_filter( 'login_message', array( 'Jetpack_SSO_Notices', 'error_invalid_response_data' ) ); return; } $user_data = (object) $user_data; $user = null; /** * Fires before Jetpack's SSO modifies the log in form. * * @module sso * * @since 2.6.0 * * @param object $user_data WordPress.com User information. */ do_action( 'jetpack_sso_pre_handle_login', $user_data ); $tracking = new Tracking(); if ( Jetpack_SSO_Helpers::is_two_step_required() && 0 === (int) $user_data->two_step_enabled ) { $this->user_data = $user_data; $tracking->record_user_event( 'sso_login_failed', array( 'error_message' => 'error_msg_enable_two_step' ) ); $error = new WP_Error( 'two_step_required', __( 'You must have Two-Step Authentication enabled on your WordPress.com account.', 'jetpack' ) ); /** This filter is documented in core/src/wp-includes/pluggable.php */ do_action( 'wp_login_failed', $user_data->login, $error ); add_filter( 'login_message', array( 'Jetpack_SSO_Notices', 'error_msg_enable_two_step' ) ); return; } $user_found_with = ''; if ( empty( $user ) && isset( $user_data->external_user_id ) ) { $user_found_with = 'external_user_id'; $user = get_user_by( 'id', (int) $user_data->external_user_id ); if ( $user ) { $expected_id = get_user_meta( $user->ID, 'wpcom_user_id', true ); if ( $expected_id && $expected_id != $user_data->ID ) { // phpcs:ignore WordPress.PHP.StrictComparisons.LooseComparison $error = new WP_Error( 'expected_wpcom_user', __( 'Something got a little mixed up and an unexpected WordPress.com user logged in.', 'jetpack' ) ); /** This filter is documented in core/src/wp-includes/pluggable.php */ do_action( 'wp_login_failed', $user_data->login, $error ); add_filter( 'login_message', array( 'Jetpack_SSO_Notices', 'error_invalid_response_data' ) ); // @todo Need to have a better notice. This is only for the sake of testing the validation. return; } update_user_meta( $user->ID, 'wpcom_user_id', $user_data->ID ); } } // If we don't have one by wpcom_user_id, try by the email? if ( empty( $user ) && Jetpack_SSO_Helpers::match_by_email() ) { $user_found_with = 'match_by_email'; $user = get_user_by( 'email', $user_data->email ); if ( $user ) { update_user_meta( $user->ID, 'wpcom_user_id', $user_data->ID ); } } // If we've still got nothing, create the user. $new_user_override_role = false; if ( empty( $user ) && ( get_option( 'users_can_register' ) || ( $new_user_override_role = Jetpack_SSO_Helpers::new_user_override( $user_data ) ) ) ) { /** * If not matching by email we still need to verify the email does not exist * or this blows up * * If match_by_email is true, we know the email doesn't exist, as it would have * been found in the first pass. If get_user_by( 'email' ) doesn't find the * user, then we know that email is unused, so it's safe to add. */ if ( Jetpack_SSO_Helpers::match_by_email() || ! get_user_by( 'email', $user_data->email ) ) { if ( $new_user_override_role ) { $user_data->role = $new_user_override_role; } $user = Jetpack_SSO_Helpers::generate_user( $user_data ); if ( ! $user ) { $tracking->record_user_event( 'sso_login_failed', array( 'error_message' => 'could_not_create_username' ) ); add_filter( 'login_message', array( 'Jetpack_SSO_Notices', 'error_unable_to_create_user' ) ); return; } $user_found_with = $new_user_override_role ? 'user_created_new_user_override' : 'user_created_users_can_register'; } else { $tracking->record_user_event( 'sso_login_failed', array( 'error_message' => 'error_msg_email_already_exists' ) ); $this->user_data = $user_data; add_action( 'login_message', array( 'Jetpack_SSO_Notices', 'error_msg_email_already_exists' ) ); return; } } /** * Fires after we got login information from WordPress.com. * * @module sso * * @since 2.6.0 * * @param WP_User|false|null $user Local User information. * @param object $user_data WordPress.com User Login information. */ do_action( 'jetpack_sso_handle_login', $user, $user_data ); if ( $user ) { // Cache the user's details, so we can present it back to them on their user screen update_user_meta( $user->ID, 'wpcom_user_data', $user_data ); add_filter( 'auth_cookie_expiration', array( 'Jetpack_SSO_Helpers', 'extend_auth_cookie_expiration_for_sso' ) ); wp_set_auth_cookie( $user->ID, true ); remove_filter( 'auth_cookie_expiration', array( 'Jetpack_SSO_Helpers', 'extend_auth_cookie_expiration_for_sso' ) ); /** This filter is documented in core/src/wp-includes/user.php */ do_action( 'wp_login', $user->user_login, $user ); wp_set_current_user( $user->ID ); $_request_redirect_to = isset( $_REQUEST['redirect_to'] ) ? esc_url_raw( $_REQUEST['redirect_to'] ) : ''; $redirect_to = user_can( $user, 'edit_posts' ) ? admin_url() : self::profile_page_url(); // If we have a saved redirect to request in a cookie if ( ! empty( $_COOKIE['jetpack_sso_redirect_to'] ) ) { // Set that as the requested redirect to $redirect_to = $_request_redirect_to = esc_url_raw( $_COOKIE['jetpack_sso_redirect_to'] ); } $json_api_auth_environment = Jetpack_SSO_Helpers::get_json_api_auth_environment(); $is_json_api_auth = ! empty( $json_api_auth_environment ); $is_user_connected = Jetpack::is_user_connected( $user->ID ); $roles = new Roles(); $tracking->record_user_event( 'sso_user_logged_in', array( 'user_found_with' => $user_found_with, 'user_connected' => (bool) $is_user_connected, 'user_role' => $roles->translate_current_user_to_role(), 'is_json_api_auth' => (bool) $is_json_api_auth, ) ); if ( $is_json_api_auth ) { Jetpack::init()->verify_json_api_authorization_request( $json_api_auth_environment ); Jetpack::init()->store_json_api_authorization_token( $user->user_login, $user ); } else if ( ! $is_user_connected ) { wp_safe_redirect( add_query_arg( array( 'redirect_to' => $redirect_to, 'request_redirect_to' => $_request_redirect_to, 'calypso_env' => Jetpack::get_calypso_env(), 'jetpack-sso-auth-redirect' => '1', ), admin_url() ) ); exit; } add_filter( 'allowed_redirect_hosts', array( 'Jetpack_SSO_Helpers', 'allowed_redirect_hosts' ) ); wp_safe_redirect( /** This filter is documented in core/src/wp-login.php */ apply_filters( 'login_redirect', $redirect_to, $_request_redirect_to, $user ) ); exit; } add_filter( 'jetpack_sso_default_to_sso_login', '__return_false' ); $tracking->record_user_event( 'sso_login_failed', array( 'error_message' => 'cant_find_user' ) ); $this->user_data = $user_data; $error = new WP_Error( 'account_not_found', __( 'Account not found. If you already have an account, make sure you have connected to WordPress.com.', 'jetpack' ) ); /** This filter is documented in core/src/wp-includes/pluggable.php */ do_action( 'wp_login_failed', $user_data->login, $error ); add_filter( 'login_message', array( 'Jetpack_SSO_Notices', 'cant_find_user' ) ); } static function profile_page_url() { return admin_url( 'profile.php' ); } /** * Builds the "Login to WordPress.com" button that is displayed on the login page as well as user profile page. * * @param array $args An array of arguments to add to the SSO URL. * @param boolean $is_primary Should the button have the `button-primary` class? * @return string Returns the HTML markup for the button. */ function build_sso_button( $args = array(), $is_primary = false ) { $url = $this->build_sso_button_url( $args ); $classes = $is_primary ? 'jetpack-sso button button-primary' : 'jetpack-sso button'; return sprintf( '<a rel="nofollow" href="%1$s" class="%2$s"><span>%3$s %4$s</span></a>', esc_url( $url ), $classes, '<span class="genericon genericon-wordpress"></span>', esc_html__( 'Log in with WordPress.com', 'jetpack' ) ); } /** * Builds a URL with `jetpack-sso` action and option args which is used to setup SSO. * * @param array $args An array of arguments to add to the SSO URL. * @return string The URL used for SSO. */ function build_sso_button_url( $args = array() ) { $defaults = array( 'action' => 'jetpack-sso', ); $args = wp_parse_args( $args, $defaults ); if ( ! empty( $_GET['redirect_to'] ) ) { $args['redirect_to'] = urlencode( esc_url_raw( $_GET['redirect_to'] ) ); } return add_query_arg( $args, wp_login_url() ); } /** * Retrieves a WordPress.com SSO URL with appropriate query parameters or dies. * * @param boolean $reauth Should the user be forced to reauthenticate on WordPress.com? * @param array $args Optional query parameters. * @return string The WordPress.com SSO URL. */ function get_sso_url_or_die( $reauth = false, $args = array() ) { if ( empty( $reauth ) ) { $sso_redirect = $this->build_sso_url( $args ); } else { self::clear_wpcom_profile_cookies(); $sso_redirect = $this->build_reauth_and_sso_url( $args ); } // If there was an error retrieving the SSO URL, then error. if ( is_wp_error( $sso_redirect ) ) { $error_message = sanitize_text_field( sprintf( '%s: %s', $sso_redirect->get_error_code(), $sso_redirect->get_error_message() ) ); $tracking = new Tracking(); $tracking->record_user_event( 'sso_login_redirect_failed', array( 'error_message' => $error_message ) ); wp_die( $error_message ); } return $sso_redirect; } /** * Build WordPress.com SSO URL with appropriate query parameters. * * @param array $args Optional query parameters. * @return string WordPress.com SSO URL */ public function build_sso_url( $args = array() ) { $sso_nonce = ! empty( $args['sso_nonce'] ) ? $args['sso_nonce'] : self::request_initial_nonce(); $defaults = array( 'action' => 'jetpack-sso', 'site_id' => Jetpack_Options::get_option( 'id' ), 'sso_nonce' => $sso_nonce, 'calypso_auth' => '1', ); $args = wp_parse_args( $args, $defaults ); if ( is_wp_error( $args['sso_nonce'] ) ) { return $args['sso_nonce']; } $query = add_query_arg( $args, '' ); $query = trim( $query, '?' ); $url = Redirect::get_url( 'wpcom-login', array( 'query' => $query, ) ); return $url; } /** * Build WordPress.com SSO URL with appropriate query parameters, * including the parameters necessary to force the user to reauthenticate * on WordPress.com. * * @param array $args Optional query parameters. * @return string WordPress.com SSO URL */ public function build_reauth_and_sso_url( $args = array() ) { $sso_nonce = ! empty( $args['sso_nonce'] ) ? $args['sso_nonce'] : self::request_initial_nonce(); $redirect = $this->build_sso_url( array( 'force_auth' => '1', 'sso_nonce' => $sso_nonce ) ); if ( is_wp_error( $redirect ) ) { return $redirect; } $defaults = array( 'action' => 'jetpack-sso', 'site_id' => Jetpack_Options::get_option( 'id' ), 'sso_nonce' => $sso_nonce, 'reauth' => '1', 'redirect_to' => urlencode( $redirect ), 'calypso_auth' => '1', ); $args = wp_parse_args( $args, $defaults ); if ( is_wp_error( $args['sso_nonce'] ) ) { return $args['sso_nonce']; } $query = add_query_arg( $args, '' ); $query = trim( $query, '?' ); $url = Redirect::get_url( 'wpcom-login', array( 'query' => $query, ) ); return $url; } /** * Determines local user associated with a given WordPress.com user ID. * * @since 2.6.0 * * @param int $wpcom_user_id User ID from WordPress.com * @return object Local user object if found, null if not. */ static function get_user_by_wpcom_id( $wpcom_user_id ) { $user_query = new WP_User_Query( array( 'meta_key' => 'wpcom_user_id', 'meta_value' => (int) $wpcom_user_id, 'number' => 1, ) ); $users = $user_query->get_results(); return $users ? array_shift( $users ) : null; } /** * When jetpack-sso-auth-redirect query parameter is set, will redirect user to * WordPress.com authorization flow. * * We redirect here instead of in handle_login() because Jetpack::init()->build_connect_url * calls menu_page_url() which doesn't work properly until admin menus are registered. */ function maybe_authorize_user_after_sso() { if ( empty( $_GET['jetpack-sso-auth-redirect'] ) ) { return; } $redirect_to = ! empty( $_GET['redirect_to'] ) ? esc_url_raw( $_GET['redirect_to'] ) : admin_url(); $request_redirect_to = ! empty( $_GET['request_redirect_to'] ) ? esc_url_raw( $_GET['request_redirect_to'] ) : $redirect_to; /** This filter is documented in core/src/wp-login.php */ $redirect_after_auth = apply_filters( 'login_redirect', $redirect_to, $request_redirect_to, wp_get_current_user() ); /** * Since we are passing this redirect to WordPress.com and therefore can not use wp_safe_redirect(), * let's sanitize it here to make sure it's safe. If the redirect is not safe, then use admin_url(). */ $redirect_after_auth = wp_sanitize_redirect( $redirect_after_auth ); $redirect_after_auth = wp_validate_redirect( $redirect_after_auth, admin_url() ); /** * Return the raw connect URL with our redirect and attribute connection to SSO. */ $connect_url = Jetpack::init()->build_connect_url( true, $redirect_after_auth, 'sso' ); add_filter( 'allowed_redirect_hosts', array( 'Jetpack_SSO_Helpers', 'allowed_redirect_hosts' ) ); wp_safe_redirect( $connect_url ); exit; } /** * Cache user's display name and Gravatar so it can be displayed on the login screen. These cookies are * stored when the user logs out, and then deleted when the user logs in. */ function store_wpcom_profile_cookies_on_logout() { if ( ! Jetpack::is_user_connected( get_current_user_id() ) ) { return; } $user_data = $this->get_user_data( get_current_user_id() ); if ( ! $user_data ) { return; } setcookie( 'jetpack_sso_wpcom_name_' . COOKIEHASH, $user_data->display_name, time() + WEEK_IN_SECONDS, COOKIEPATH, COOKIE_DOMAIN, is_ssl() ); setcookie( 'jetpack_sso_wpcom_gravatar_' . COOKIEHASH, get_avatar_url( $user_data->email, array( 'size' => 144, 'default' => 'mystery' ) ), time() + WEEK_IN_SECONDS, COOKIEPATH, COOKIE_DOMAIN, is_ssl() ); } /** * Determines if a local user is connected to WordPress.com * * @since 2.8 * @param integer $user_id - Local user id * @return boolean **/ public function is_user_connected( $user_id ) { return $this->get_user_data( $user_id ); } /** * Retrieves a user's WordPress.com data * * @since 2.8 * @param integer $user_id - Local user id * @return mixed null or stdClass **/ public function get_user_data( $user_id ) { return get_user_meta( $user_id, 'wpcom_user_data', true ); } } Jetpack_SSO::get_instance();
Save Changes
Rename File
Rename