1
|
|
|
<?php |
2
|
|
|
require_once( JETPACK__PLUGIN_DIR . 'modules/sso/class.jetpack-sso-helpers.php' ); |
3
|
|
|
|
4
|
|
|
/** |
5
|
|
|
* Module Name: Single Sign On |
6
|
|
|
* Module Description: Secure user authentication with WordPress.com. |
7
|
|
|
* Jumpstart Description: Lets you log in to all your Jetpack-enabled sites with one click using your WordPress.com account. |
8
|
|
|
* Sort Order: 30 |
9
|
|
|
* Recommendation Order: 5 |
10
|
|
|
* First Introduced: 2.6 |
11
|
|
|
* Requires Connection: Yes |
12
|
|
|
* Auto Activate: No |
13
|
|
|
* Module Tags: Developers |
14
|
|
|
* Feature: Security, Jumpstart |
15
|
|
|
* Additional Search Queries: sso, single sign on, login, log in |
16
|
|
|
*/ |
17
|
|
|
|
18
|
|
|
class Jetpack_SSO { |
19
|
|
|
static $instance = null; |
|
|
|
|
20
|
|
|
|
21
|
|
|
private function __construct() { |
22
|
|
|
|
23
|
|
|
self::$instance = $this; |
24
|
|
|
|
25
|
|
|
add_action( 'admin_init', array( $this, 'maybe_authorize_user_after_sso' ), 1 ); |
26
|
|
|
add_action( 'admin_init', array( $this, 'register_settings' ) ); |
27
|
|
|
add_action( 'login_init', array( $this, 'login_init' ) ); |
28
|
|
|
add_action( 'delete_user', array( $this, 'delete_connection_for_user' ) ); |
29
|
|
|
add_filter( 'jetpack_xmlrpc_methods', array( $this, 'xmlrpc_methods' ) ); |
30
|
|
|
add_action( 'init', array( $this, 'maybe_logout_user' ), 5 ); |
31
|
|
|
add_action( 'jetpack_modules_loaded', array( $this, 'module_configure_button' ) ); |
32
|
|
|
add_action( 'login_form_logout', array( $this, 'store_wpcom_profile_cookies_on_logout' ) ); |
33
|
|
|
add_action( 'wp_login', array( 'Jetpack_SSO', 'clear_wpcom_profile_cookies' ) ); |
34
|
|
|
add_action( 'jetpack_unlinked_user', array( $this, 'delete_connection_for_user') ); |
35
|
|
|
|
36
|
|
|
// Adding this action so that on login_init, the action won't be sanitized out of the $action global. |
37
|
|
|
add_action( 'login_form_jetpack-sso', '__return_true' ); |
38
|
|
|
} |
39
|
|
|
|
40
|
|
|
/** |
41
|
|
|
* Returns the single instance of the Jetpack_SSO object |
42
|
|
|
* |
43
|
|
|
* @since 2.8 |
44
|
|
|
* @return Jetpack_SSO |
45
|
|
|
**/ |
46
|
|
|
public static function get_instance() { |
47
|
|
|
if ( ! is_null( self::$instance ) ) { |
48
|
|
|
return self::$instance; |
49
|
|
|
} |
50
|
|
|
|
51
|
|
|
return self::$instance = new Jetpack_SSO; |
52
|
|
|
} |
53
|
|
|
|
54
|
|
|
/** |
55
|
|
|
* Add configure button and functionality to the module card on the Jetpack screen |
56
|
|
|
**/ |
57
|
|
|
public static function module_configure_button() { |
58
|
|
|
Jetpack::enable_module_configurable( __FILE__ ); |
59
|
|
|
Jetpack::module_configuration_load( __FILE__, array( __CLASS__, 'module_configuration_load' ) ); |
60
|
|
|
Jetpack::module_configuration_head( __FILE__, array( __CLASS__, 'module_configuration_head' ) ); |
61
|
|
|
Jetpack::module_configuration_screen( __FILE__, array( __CLASS__, 'module_configuration_screen' ) ); |
62
|
|
|
} |
63
|
|
|
|
64
|
|
|
public static function module_configuration_load() {} |
65
|
|
|
|
66
|
|
|
public static function module_configuration_head() {} |
67
|
|
|
|
68
|
|
|
public static function module_configuration_screen() { |
69
|
|
|
?> |
70
|
|
|
<form method="post" action="options.php"> |
71
|
|
|
<?php settings_fields( 'jetpack-sso' ); ?> |
72
|
|
|
<?php do_settings_sections( 'jetpack-sso' ); ?> |
73
|
|
|
<?php submit_button(); ?> |
74
|
|
|
</form> |
75
|
|
|
<?php |
76
|
|
|
} |
77
|
|
|
|
78
|
|
|
/** |
79
|
|
|
* When the default login form is hidden, this method is called on the 'authenticate' filter with a priority of 30. |
80
|
|
|
* This method disables the ability to submit the default login form. |
81
|
|
|
* |
82
|
|
|
* @param $user |
83
|
|
|
* |
84
|
|
|
* @return WP_Error |
85
|
|
|
*/ |
86
|
|
|
public function disable_default_login_form( $user ) { |
87
|
|
|
if ( is_wp_error( $user ) ) { |
88
|
|
|
return $user; |
89
|
|
|
} |
90
|
|
|
|
91
|
|
|
/** |
92
|
|
|
* Since we're returning an error that will be shown as a red notice, let's remove the |
93
|
|
|
* informational "blue" notice. |
94
|
|
|
*/ |
95
|
|
|
remove_filter( 'login_message', array( $this, 'msg_login_by_jetpack' ) ); |
96
|
|
|
return new WP_Error( 'jetpack_sso_required', $this->get_sso_required_message() ); |
97
|
|
|
} |
98
|
|
|
|
99
|
|
|
/** |
100
|
|
|
* If jetpack_force_logout == 1 in current user meta the user will be forced |
101
|
|
|
* to logout and reauthenticate with the site. |
102
|
|
|
**/ |
103
|
|
|
public function maybe_logout_user() { |
104
|
|
|
global $current_user; |
105
|
|
|
|
106
|
|
|
if ( 1 == $current_user->jetpack_force_logout ) { |
107
|
|
|
delete_user_meta( $current_user->ID, 'jetpack_force_logout' ); |
108
|
|
|
self::delete_connection_for_user( $current_user->ID ); |
109
|
|
|
wp_logout(); |
110
|
|
|
wp_safe_redirect( wp_login_url() ); |
111
|
|
|
exit; |
|
|
|
|
112
|
|
|
} |
113
|
|
|
} |
114
|
|
|
|
115
|
|
|
/** |
116
|
|
|
* Adds additional methods the WordPress xmlrpc API for handling SSO specific features |
117
|
|
|
* |
118
|
|
|
* @param array $methods |
119
|
|
|
* @return array |
120
|
|
|
**/ |
121
|
|
|
public function xmlrpc_methods( $methods ) { |
122
|
|
|
$methods['jetpack.userDisconnect'] = array( $this, 'xmlrpc_user_disconnect' ); |
123
|
|
|
return $methods; |
124
|
|
|
} |
125
|
|
|
|
126
|
|
|
/** |
127
|
|
|
* Marks a user's profile for disconnect from WordPress.com and forces a logout |
128
|
|
|
* the next time the user visits the site. |
129
|
|
|
**/ |
130
|
|
|
public function xmlrpc_user_disconnect( $user_id ) { |
131
|
|
|
$user_query = new WP_User_Query( |
132
|
|
|
array( |
133
|
|
|
'meta_key' => 'wpcom_user_id', |
134
|
|
|
'meta_value' => $user_id, |
135
|
|
|
) |
136
|
|
|
); |
137
|
|
|
$user = $user_query->get_results(); |
138
|
|
|
$user = $user[0]; |
139
|
|
|
|
140
|
|
|
if ( $user instanceof WP_User ) { |
|
|
|
|
141
|
|
|
$user = wp_set_current_user( $user->ID ); |
142
|
|
|
update_user_meta( $user->ID, 'jetpack_force_logout', '1' ); |
143
|
|
|
self::delete_connection_for_user( $user->ID ); |
144
|
|
|
return true; |
145
|
|
|
} |
146
|
|
|
return false; |
147
|
|
|
} |
148
|
|
|
|
149
|
|
|
/** |
150
|
|
|
* Enqueues scripts and styles necessary for SSO login. |
151
|
|
|
*/ |
152
|
|
|
public function login_enqueue_scripts() { |
153
|
|
|
global $action; |
154
|
|
|
|
155
|
|
|
if ( ! in_array( $action, array( 'jetpack-sso', 'login' ) ) ) { |
156
|
|
|
return; |
157
|
|
|
} |
158
|
|
|
|
159
|
|
|
if ( is_rtl() ) { |
160
|
|
|
wp_enqueue_style( 'jetpack-sso-login', plugins_url( 'modules/sso/jetpack-sso-login-rtl.css', JETPACK__PLUGIN_FILE ), array( 'login', 'genericons' ), JETPACK__VERSION ); |
161
|
|
|
} else { |
162
|
|
|
wp_enqueue_style( 'jetpack-sso-login', plugins_url( 'modules/sso/jetpack-sso-login.css', JETPACK__PLUGIN_FILE ), array( 'login', 'genericons' ), JETPACK__VERSION ); |
163
|
|
|
} |
164
|
|
|
|
165
|
|
|
wp_enqueue_script( 'jetpack-sso-login', plugins_url( 'modules/sso/jetpack-sso-login.js', JETPACK__PLUGIN_FILE ), array( 'jquery' ), JETPACK__VERSION ); |
166
|
|
|
} |
167
|
|
|
|
168
|
|
|
/** |
169
|
|
|
* Adds Jetpack SSO classes to login body |
170
|
|
|
* |
171
|
|
|
* @param array $classes Array of classes to add to body tag |
172
|
|
|
* @return array Array of classes to add to body tag |
173
|
|
|
*/ |
174
|
|
|
public function login_body_class( $classes ) { |
175
|
|
|
global $action; |
176
|
|
|
|
177
|
|
|
if ( ! in_array( $action, array( 'jetpack-sso', 'login' ) ) ) { |
178
|
|
|
return $classes; |
179
|
|
|
} |
180
|
|
|
|
181
|
|
|
// Always add the jetpack-sso class so that we can add SSO specific styling even when the SSO form isn't being displayed. |
182
|
|
|
$classes[] = 'jetpack-sso'; |
183
|
|
|
|
184
|
|
|
/** |
185
|
|
|
* Should we show the SSO login form? |
186
|
|
|
* |
187
|
|
|
* $_GET['jetpack-sso-default-form'] is used to provide a fallback in case JavaScript is not enabled. |
188
|
|
|
* |
189
|
|
|
* The default_to_sso_login() method allows us to dynamically decide whether we show the SSO login form or not. |
190
|
|
|
* The SSO module uses the method to display the default login form if we can not find a user to log in via SSO. |
191
|
|
|
* But, the method could be filtered by a site admin to always show the default login form if that is preferred. |
192
|
|
|
*/ |
193
|
|
|
if ( empty( $_GET['jetpack-sso-show-default-form'] ) && Jetpack_SSO_Helpers::show_sso_login() ) { |
194
|
|
|
$classes[] = 'jetpack-sso-form-display'; |
195
|
|
|
} |
196
|
|
|
|
197
|
|
|
return $classes; |
198
|
|
|
} |
199
|
|
|
|
200
|
|
|
/** |
201
|
|
|
* Adds settings fields to Settings > General > Single Sign On that allows users to |
202
|
|
|
* turn off the login form on wp-login.php |
203
|
|
|
* |
204
|
|
|
* @since 2.7 |
205
|
|
|
**/ |
206
|
|
|
public function register_settings() { |
207
|
|
|
|
208
|
|
|
add_settings_section( |
209
|
|
|
'jetpack_sso_settings', |
210
|
|
|
__( 'Single Sign On' , 'jetpack' ), |
211
|
|
|
'__return_false', |
212
|
|
|
'jetpack-sso' |
213
|
|
|
); |
214
|
|
|
|
215
|
|
|
/* |
216
|
|
|
* Settings > General > Single Sign On |
217
|
|
|
* Require two step authentication |
218
|
|
|
*/ |
219
|
|
|
register_setting( |
220
|
|
|
'jetpack-sso', |
221
|
|
|
'jetpack_sso_require_two_step', |
222
|
|
|
array( $this, 'validate_jetpack_sso_require_two_step' ) |
223
|
|
|
); |
224
|
|
|
|
225
|
|
|
add_settings_field( |
226
|
|
|
'jetpack_sso_require_two_step', |
227
|
|
|
'', // __( 'Require Two-Step Authentication' , 'jetpack' ), |
228
|
|
|
array( $this, 'render_require_two_step' ), |
229
|
|
|
'jetpack-sso', |
230
|
|
|
'jetpack_sso_settings' |
231
|
|
|
); |
232
|
|
|
|
233
|
|
|
/* |
234
|
|
|
* Settings > General > Single Sign On |
235
|
|
|
*/ |
236
|
|
|
register_setting( |
237
|
|
|
'jetpack-sso', |
238
|
|
|
'jetpack_sso_match_by_email', |
239
|
|
|
array( $this, 'validate_jetpack_sso_match_by_email' ) |
240
|
|
|
); |
241
|
|
|
|
242
|
|
|
add_settings_field( |
243
|
|
|
'jetpack_sso_match_by_email', |
244
|
|
|
'', // __( 'Match by Email' , 'jetpack' ), |
245
|
|
|
array( $this, 'render_match_by_email' ), |
246
|
|
|
'jetpack-sso', |
247
|
|
|
'jetpack_sso_settings' |
248
|
|
|
); |
249
|
|
|
} |
250
|
|
|
|
251
|
|
|
/** |
252
|
|
|
* Builds the display for the checkbox allowing user to require two step |
253
|
|
|
* auth be enabled on WordPress.com accounts before login. Displays in Settings > General |
254
|
|
|
* |
255
|
|
|
* @since 2.7 |
256
|
|
|
**/ |
257
|
|
|
public function render_require_two_step() { |
258
|
|
|
?> |
259
|
|
|
<label> |
260
|
|
|
<input |
261
|
|
|
type="checkbox" |
262
|
|
|
name="jetpack_sso_require_two_step" |
263
|
|
|
<?php checked( Jetpack_SSO_Helpers::is_two_step_required() ); ?> |
264
|
|
|
<?php disabled( Jetpack_SSO_Helpers::is_require_two_step_checkbox_disabled() ); ?> |
265
|
|
|
> |
266
|
|
|
<?php esc_html_e( 'Require Two-Step Authentication' , 'jetpack' ); ?> |
267
|
|
|
</label> |
268
|
|
|
<?php |
269
|
|
|
} |
270
|
|
|
|
271
|
|
|
/** |
272
|
|
|
* Validate the require two step checkbox in Settings > General |
273
|
|
|
* |
274
|
|
|
* @since 2.7 |
275
|
|
|
* @return boolean |
276
|
|
|
**/ |
277
|
|
|
public function validate_jetpack_sso_require_two_step( $input ) { |
278
|
|
|
return ( ! empty( $input ) ) ? 1 : 0; |
279
|
|
|
} |
280
|
|
|
|
281
|
|
|
/** |
282
|
|
|
* Builds the display for the checkbox allowing the user to allow matching logins by email |
283
|
|
|
* Displays in Settings > General |
284
|
|
|
* |
285
|
|
|
* @since 2.9 |
286
|
|
|
**/ |
287
|
|
|
public function render_match_by_email() { |
288
|
|
|
?> |
289
|
|
|
<label> |
290
|
|
|
<input |
291
|
|
|
type="checkbox" |
292
|
|
|
name="jetpack_sso_match_by_email" |
293
|
|
|
<?php checked( Jetpack_SSO_Helpers::match_by_email() ); ?> |
294
|
|
|
<?php disabled( Jetpack_SSO_Helpers::is_match_by_email_checkbox_disabled() ); ?> |
295
|
|
|
> |
296
|
|
|
<?php esc_html_e( 'Match by Email', 'jetpack' ); ?> |
297
|
|
|
</label> |
298
|
|
|
<?php |
299
|
|
|
} |
300
|
|
|
|
301
|
|
|
/** |
302
|
|
|
* Validate the match by email check in Settings > General |
303
|
|
|
* |
304
|
|
|
* @since 2.9 |
305
|
|
|
* @return boolean |
306
|
|
|
**/ |
307
|
|
|
public function validate_jetpack_sso_match_by_email( $input ) { |
308
|
|
|
return ( ! empty( $input ) ) ? 1 : 0; |
309
|
|
|
} |
310
|
|
|
|
311
|
|
|
/** |
312
|
|
|
* Checks to determine if the user wants to login on wp-login |
313
|
|
|
* |
314
|
|
|
* This function mostly exists to cover the exceptions to login |
315
|
|
|
* that may exist as other parameters to $_GET[action] as $_GET[action] |
316
|
|
|
* does not have to exist. By default WordPress assumes login if an action |
317
|
|
|
* is not set, however this may not be true, as in the case of logout |
318
|
|
|
* where $_GET[loggedout] is instead set |
319
|
|
|
* |
320
|
|
|
* @return boolean |
321
|
|
|
**/ |
322
|
|
|
private function wants_to_login() { |
323
|
|
|
$wants_to_login = false; |
324
|
|
|
|
325
|
|
|
// Cover default WordPress behavior |
326
|
|
|
$action = isset( $_REQUEST['action'] ) ? $_REQUEST['action'] : 'login'; |
327
|
|
|
|
328
|
|
|
// And now the exceptions |
329
|
|
|
$action = isset( $_GET['loggedout'] ) ? 'loggedout' : $action; |
330
|
|
|
|
331
|
|
|
if ( 'login' == $action ) { |
332
|
|
|
$wants_to_login = true; |
333
|
|
|
} |
334
|
|
|
|
335
|
|
|
return $wants_to_login; |
336
|
|
|
} |
337
|
|
|
|
338
|
|
|
function login_init() { |
339
|
|
|
global $action; |
340
|
|
|
|
341
|
|
|
if ( Jetpack_SSO_Helpers::should_hide_login_form() ) { |
342
|
|
|
/** |
343
|
|
|
* Since the default authenticate filters fire at priority 20 for checking username and password, |
344
|
|
|
* let's fire at priority 30. wp_authenticate_spam_check is fired at priority 99, but since we return a |
345
|
|
|
* WP_Error in disable_default_login_form, then we won't trigger spam processing logic. |
346
|
|
|
*/ |
347
|
|
|
add_filter( 'authenticate', array( $this, 'disable_default_login_form' ), 30 ); |
348
|
|
|
|
349
|
|
|
/** |
350
|
|
|
* Filter the display of the disclaimer message appearing when default WordPress login form is disabled. |
351
|
|
|
* |
352
|
|
|
* @module sso |
353
|
|
|
* |
354
|
|
|
* @since 2.8.0 |
355
|
|
|
* |
356
|
|
|
* @param bool true Should the disclaimer be displayed. Default to true. |
357
|
|
|
*/ |
358
|
|
|
$display_sso_disclaimer = apply_filters( 'jetpack_sso_display_disclaimer', true ); |
359
|
|
|
if ( $display_sso_disclaimer ) { |
360
|
|
|
add_filter( 'login_message', array( $this, 'msg_login_by_jetpack' ) ); |
361
|
|
|
} |
362
|
|
|
} |
363
|
|
|
|
364
|
|
|
/** |
365
|
|
|
* If the user is attempting to logout AND the auto-forward to WordPress.com |
366
|
|
|
* login is set then we need to ensure we do not auto-forward the user and get |
367
|
|
|
* them stuck in an infinite logout loop. |
368
|
|
|
*/ |
369
|
|
|
if ( isset( $_GET['loggedout'] ) && Jetpack_SSO_Helpers::bypass_login_forward_wpcom() ) { |
370
|
|
|
add_filter( 'jetpack_remove_login_form', '__return_true' ); |
371
|
|
|
} |
372
|
|
|
|
373
|
|
|
/** |
374
|
|
|
* Check to see if the site admin wants to automagically forward the user |
375
|
|
|
* to the WordPress.com login page AND that the request to wp-login.php |
376
|
|
|
* is not something other than login (Like logout!) |
377
|
|
|
*/ |
378
|
|
View Code Duplication |
if ( |
379
|
|
|
$this->wants_to_login() |
380
|
|
|
&& Jetpack_SSO_Helpers::bypass_login_forward_wpcom() |
381
|
|
|
) { |
382
|
|
|
add_filter( 'allowed_redirect_hosts', array( 'Jetpack_SSO_Helpers', 'allowed_redirect_hosts' ) ); |
383
|
|
|
$this->maybe_save_cookie_redirect(); |
384
|
|
|
$reauth = ! empty( $_GET['force_reauth'] ); |
385
|
|
|
$sso_url = $this->get_sso_url_or_die( $reauth ); |
386
|
|
|
JetpackTracking::record_user_event( 'sso_login_redirect_bypass_success' ); |
387
|
|
|
wp_safe_redirect( $sso_url ); |
388
|
|
|
exit; |
|
|
|
|
389
|
|
|
} |
390
|
|
|
|
391
|
|
|
if ( 'login' === $action ) { |
392
|
|
|
$this->display_sso_login_form(); |
393
|
|
|
} elseif ( 'jetpack-sso' === $action ) { |
394
|
|
|
if ( isset( $_GET['result'], $_GET['user_id'], $_GET['sso_nonce'] ) && 'success' == $_GET['result'] ) { |
395
|
|
|
$this->handle_login(); |
396
|
|
|
$this->display_sso_login_form(); |
397
|
|
|
} else { |
398
|
|
|
if ( Jetpack::check_identity_crisis() ) { |
399
|
|
|
JetpackTracking::record_user_event( 'sso_login_redirect_failed', array( |
400
|
|
|
'error_message' => 'identity_crisis' |
401
|
|
|
) ); |
402
|
|
|
add_filter( 'login_message', array( $this, 'error_msg_identity_crisis' ) ); |
403
|
|
View Code Duplication |
} else { |
404
|
|
|
$this->maybe_save_cookie_redirect(); |
405
|
|
|
// Is it wiser to just use wp_redirect than do this runaround to wp_safe_redirect? |
406
|
|
|
add_filter( 'allowed_redirect_hosts', array( 'Jetpack_SSO_Helpers', 'allowed_redirect_hosts' ) ); |
407
|
|
|
$reauth = ! empty( $_GET['force_reauth'] ); |
408
|
|
|
$sso_url = $this->get_sso_url_or_die( $reauth ); |
409
|
|
|
JetpackTracking::record_user_event( 'sso_login_redirect_success' ); |
410
|
|
|
wp_safe_redirect( $sso_url ); |
411
|
|
|
exit; |
|
|
|
|
412
|
|
|
} |
413
|
|
|
} |
414
|
|
|
} |
415
|
|
|
} |
416
|
|
|
|
417
|
|
|
/** |
418
|
|
|
* Ensures that we can get a nonce from WordPress.com via XML-RPC before setting |
419
|
|
|
* up the hooks required to display the SSO form. |
420
|
|
|
*/ |
421
|
|
|
public function display_sso_login_form() { |
422
|
|
|
if ( Jetpack::check_identity_crisis() ) { |
423
|
|
|
add_filter( 'login_message', array( $this, 'error_msg_identity_crisis' ) ); |
424
|
|
|
return; |
425
|
|
|
} |
426
|
|
|
|
427
|
|
|
$sso_nonce = self::request_initial_nonce(); |
428
|
|
|
if ( is_wp_error( $sso_nonce ) ) { |
429
|
|
|
return; |
430
|
|
|
} |
431
|
|
|
|
432
|
|
|
add_action( 'login_form', array( $this, 'login_form' ) ); |
433
|
|
|
add_filter( 'login_body_class', array( $this, 'login_body_class' ) ); |
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
|
|
|
public static function maybe_save_cookie_redirect() { |
441
|
|
|
if ( headers_sent() ) { |
442
|
|
|
return new WP_Error( 'headers_sent', __( 'Cannot deal with cookie redirects, as headers are already sent.', 'jetpack' ) ); |
443
|
|
|
} |
444
|
|
|
|
445
|
|
|
if ( ! empty( $_GET['redirect_to'] ) ) { |
446
|
|
|
// If we have something to redirect to |
447
|
|
|
$url = esc_url_raw( $_GET['redirect_to'] ); |
448
|
|
|
setcookie( 'jetpack_sso_redirect_to', $url, time() + HOUR_IN_SECONDS, COOKIEPATH, COOKIE_DOMAIN, false, true ); |
449
|
|
|
|
450
|
|
|
} elseif ( ! empty( $_COOKIE['jetpack_sso_redirect_to'] ) ) { |
451
|
|
|
// Otherwise, if it's already set, purge it. |
452
|
|
|
setcookie( 'jetpack_sso_redirect_to', ' ', time() - YEAR_IN_SECONDS, COOKIEPATH, COOKIE_DOMAIN ); |
453
|
|
|
} |
454
|
|
|
|
455
|
|
|
if ( ! empty( $_GET['rememberme'] ) ) { |
456
|
|
|
setcookie( 'jetpack_sso_remember_me', '1', time() + HOUR_IN_SECONDS, COOKIEPATH, COOKIE_DOMAIN, false, true ); |
457
|
|
|
} elseif ( ! empty( $_COOKIE['jetpack_sso_remember_me'] ) ) { |
458
|
|
|
setcookie( 'jetpack_sso_remember_me', ' ', time() - YEAR_IN_SECONDS, COOKIEPATH, COOKIE_DOMAIN ); |
459
|
|
|
} |
460
|
|
|
} |
461
|
|
|
|
462
|
|
|
/** |
463
|
|
|
* Outputs the Jetpack SSO button and description as well as the toggle link |
464
|
|
|
* for switching between Jetpack SSO and default login. |
465
|
|
|
*/ |
466
|
|
|
function login_form() { |
467
|
|
|
$site_name = get_bloginfo( 'name' ); |
468
|
|
|
if ( ! $site_name ) { |
469
|
|
|
$site_name = get_bloginfo( 'url' ); |
470
|
|
|
} |
471
|
|
|
|
472
|
|
|
$display_name = ! empty( $_COOKIE[ 'jetpack_sso_wpcom_name_' . COOKIEHASH ] ) |
473
|
|
|
? $_COOKIE[ 'jetpack_sso_wpcom_name_' . COOKIEHASH ] |
474
|
|
|
: false; |
475
|
|
|
$gravatar = ! empty( $_COOKIE[ 'jetpack_sso_wpcom_gravatar_' . COOKIEHASH ] ) |
476
|
|
|
? $_COOKIE[ 'jetpack_sso_wpcom_gravatar_' . COOKIEHASH ] |
477
|
|
|
: false; |
478
|
|
|
|
479
|
|
|
?> |
480
|
|
|
<div id="jetpack-sso-wrap"> |
481
|
|
|
<?php if ( $display_name && $gravatar ) : ?> |
482
|
|
|
<div id="jetpack-sso-wrap__user"> |
483
|
|
|
<img width="72" height="72" src="<?php echo esc_html( $gravatar ); ?>" /> |
484
|
|
|
|
485
|
|
|
<h2> |
486
|
|
|
<?php |
487
|
|
|
echo wp_kses( |
488
|
|
|
sprintf( __( 'Log in as <span>%s</span>', 'jetpack' ), esc_html( $display_name ) ), |
489
|
|
|
array( 'span' => true ) |
490
|
|
|
); |
491
|
|
|
?> |
492
|
|
|
</h2> |
493
|
|
|
</div> |
494
|
|
|
|
495
|
|
|
<?php endif; ?> |
496
|
|
|
|
497
|
|
|
|
498
|
|
|
<div id="jetpack-sso-wrap__action"> |
499
|
|
|
<?php echo $this->build_sso_button( array(), 'is_primary' ); ?> |
|
|
|
|
500
|
|
|
|
501
|
|
|
<?php if ( $display_name && $gravatar ) : ?> |
502
|
|
|
<a rel="nofollow" class="jetpack-sso-wrap__reauth" href="<?php echo esc_url( $this->build_sso_button_url( array( 'force_reauth' => '1' ) ) ); ?>"> |
503
|
|
|
<?php esc_html_e( 'Log in as a different WordPress.com user', 'jetpack' ); ?> |
504
|
|
|
</a> |
505
|
|
|
<?php else : ?> |
506
|
|
|
<p> |
507
|
|
|
<?php |
508
|
|
|
echo esc_html( |
509
|
|
|
sprintf( |
510
|
|
|
__( 'You can now save time spent logging in by connecting your WordPress.com account to %s.', 'jetpack' ), |
511
|
|
|
esc_html( $site_name ) |
512
|
|
|
) |
513
|
|
|
); |
514
|
|
|
?> |
515
|
|
|
</p> |
516
|
|
|
<?php endif; ?> |
517
|
|
|
</div> |
518
|
|
|
|
519
|
|
|
<?php if ( ! Jetpack_SSO_Helpers::should_hide_login_form() ) : ?> |
520
|
|
|
<div class="jetpack-sso-or"> |
521
|
|
|
<span><?php esc_html_e( 'Or', 'jetpack' ); ?></span> |
522
|
|
|
</div> |
523
|
|
|
|
524
|
|
|
<a href="<?php echo esc_url( add_query_arg( 'jetpack-sso-show-default-form', '1' ) ); ?>" class="jetpack-sso-toggle wpcom"> |
525
|
|
|
<?php |
526
|
|
|
esc_html_e( 'Log in with username and password', 'jetpack' ) |
527
|
|
|
?> |
528
|
|
|
</a> |
529
|
|
|
|
530
|
|
|
<a href="<?php echo esc_url( add_query_arg( 'jetpack-sso-show-default-form', '0' ) ); ?>" class="jetpack-sso-toggle default"> |
531
|
|
|
<?php |
532
|
|
|
esc_html_e( 'Log in with WordPress.com', 'jetpack' ) |
533
|
|
|
?> |
534
|
|
|
</a> |
535
|
|
|
<?php endif; ?> |
536
|
|
|
</div> |
537
|
|
|
<?php |
538
|
|
|
} |
539
|
|
|
|
540
|
|
|
/** |
541
|
|
|
* Clear the cookies that store the profile information for the last |
542
|
|
|
* WPCOM user to connect. |
543
|
|
|
*/ |
544
|
|
|
static function clear_wpcom_profile_cookies() { |
545
|
|
View Code Duplication |
if ( isset( $_COOKIE[ 'jetpack_sso_wpcom_name_' . COOKIEHASH ] ) ) { |
546
|
|
|
setcookie( |
547
|
|
|
'jetpack_sso_wpcom_name_' . COOKIEHASH, |
548
|
|
|
' ', |
549
|
|
|
time() - YEAR_IN_SECONDS, |
550
|
|
|
COOKIEPATH, |
551
|
|
|
COOKIE_DOMAIN |
552
|
|
|
); |
553
|
|
|
} |
554
|
|
|
|
555
|
|
View Code Duplication |
if ( isset( $_COOKIE[ 'jetpack_sso_wpcom_gravatar_' . COOKIEHASH ] ) ) { |
556
|
|
|
setcookie( |
557
|
|
|
'jetpack_sso_wpcom_gravatar_' . COOKIEHASH, |
558
|
|
|
' ', |
559
|
|
|
time() - YEAR_IN_SECONDS, |
560
|
|
|
COOKIEPATH, |
561
|
|
|
COOKIE_DOMAIN |
562
|
|
|
); |
563
|
|
|
} |
564
|
|
|
} |
565
|
|
|
|
566
|
|
|
static function delete_connection_for_user( $user_id ) { |
567
|
|
|
if ( ! $wpcom_user_id = get_user_meta( $user_id, 'wpcom_user_id', true ) ) { |
568
|
|
|
return; |
569
|
|
|
} |
570
|
|
|
Jetpack::load_xml_rpc_client(); |
571
|
|
|
$xml = new Jetpack_IXR_Client( array( |
572
|
|
|
'wpcom_user_id' => $user_id, |
573
|
|
|
) ); |
574
|
|
|
$xml->query( 'jetpack.sso.removeUser', $wpcom_user_id ); |
575
|
|
|
|
576
|
|
|
if ( $xml->isError() ) { |
577
|
|
|
return false; |
578
|
|
|
} |
579
|
|
|
|
580
|
|
|
// Clean up local data stored for SSO |
581
|
|
|
delete_user_meta( $user_id, 'wpcom_user_id' ); |
582
|
|
|
delete_user_meta( $user_id, 'wpcom_user_data' ); |
583
|
|
|
self::clear_wpcom_profile_cookies(); |
584
|
|
|
|
585
|
|
|
return $xml->getResponse(); |
586
|
|
|
} |
587
|
|
|
|
588
|
|
View Code Duplication |
static function request_initial_nonce() { |
589
|
|
|
Jetpack::load_xml_rpc_client(); |
590
|
|
|
$xml = new Jetpack_IXR_Client( array( |
591
|
|
|
'user_id' => get_current_user_id(), |
592
|
|
|
) ); |
593
|
|
|
$xml->query( 'jetpack.sso.requestNonce' ); |
594
|
|
|
|
595
|
|
|
if ( $xml->isError() ) { |
596
|
|
|
return new WP_Error( $xml->getErrorCode(), $xml->getErrorMessage() ); |
597
|
|
|
} |
598
|
|
|
|
599
|
|
|
return $xml->getResponse(); |
600
|
|
|
} |
601
|
|
|
|
602
|
|
|
/** |
603
|
|
|
* The function that actually handles the login! |
604
|
|
|
*/ |
605
|
|
|
function handle_login() { |
606
|
|
|
$wpcom_nonce = sanitize_key( $_GET['sso_nonce'] ); |
607
|
|
|
$wpcom_user_id = (int) $_GET['user_id']; |
608
|
|
|
|
609
|
|
|
Jetpack::load_xml_rpc_client(); |
610
|
|
|
$xml = new Jetpack_IXR_Client( array( |
611
|
|
|
'user_id' => get_current_user_id(), |
612
|
|
|
) ); |
613
|
|
|
$xml->query( 'jetpack.sso.validateResult', $wpcom_nonce, $wpcom_user_id ); |
614
|
|
|
|
615
|
|
|
$user_data = $xml->isError() ? false : $xml->getResponse(); |
616
|
|
|
if ( empty( $user_data ) ) { |
617
|
|
|
add_filter( 'jetpack_sso_default_to_sso_login', '__return_false' ); |
618
|
|
|
add_filter( 'login_message', array( $this, 'error_invalid_response_data' ) ); |
619
|
|
|
return; |
620
|
|
|
} |
621
|
|
|
|
622
|
|
|
$user_data = (object) $user_data; |
623
|
|
|
$user = null; |
624
|
|
|
|
625
|
|
|
/** |
626
|
|
|
* Fires before Jetpack's SSO modifies the log in form. |
627
|
|
|
* |
628
|
|
|
* @module sso |
629
|
|
|
* |
630
|
|
|
* @since 2.6.0 |
631
|
|
|
* |
632
|
|
|
* @param object $user_data WordPress.com User information. |
633
|
|
|
*/ |
634
|
|
|
do_action( 'jetpack_sso_pre_handle_login', $user_data ); |
635
|
|
|
|
636
|
|
|
if ( Jetpack_SSO_Helpers::is_two_step_required() && 0 === (int) $user_data->two_step_enabled ) { |
637
|
|
|
$this->user_data = $user_data; |
|
|
|
|
638
|
|
|
|
639
|
|
|
JetpackTracking::record_user_event( 'sso_login_failed', array( |
640
|
|
|
'error_message' => 'error_msg_enable_two_step' |
641
|
|
|
) ); |
642
|
|
|
|
643
|
|
|
/** This filter is documented in core/src/wp-includes/pluggable.php */ |
644
|
|
|
do_action( 'wp_login_failed', $user_data->login ); |
645
|
|
|
add_filter( 'login_message', array( $this, 'error_msg_enable_two_step' ) ); |
646
|
|
|
return; |
647
|
|
|
} |
648
|
|
|
|
649
|
|
|
$user_found_with = ''; |
650
|
|
|
if ( empty( $user ) && isset( $user_data->external_user_id ) ) { |
651
|
|
|
$user_found_with = 'external_user_id'; |
652
|
|
|
$user = get_user_by( 'id', intval( $user_data->external_user_id ) ); |
653
|
|
|
if ( $user ) { |
654
|
|
|
update_user_meta( $user->ID, 'wpcom_user_id', $user_data->ID ); |
655
|
|
|
} |
656
|
|
|
} |
657
|
|
|
|
658
|
|
|
// If we don't have one by wpcom_user_id, try by the email? |
659
|
|
|
if ( empty( $user ) && Jetpack_SSO_Helpers::match_by_email() ) { |
660
|
|
|
$user_found_with = 'match_by_email'; |
661
|
|
|
$user = get_user_by( 'email', $user_data->email ); |
662
|
|
|
if ( $user ) { |
663
|
|
|
update_user_meta( $user->ID, 'wpcom_user_id', $user_data->ID ); |
664
|
|
|
} |
665
|
|
|
} |
666
|
|
|
|
667
|
|
|
// If we've still got nothing, create the user. |
668
|
|
|
if ( empty( $user ) && ( get_option( 'users_can_register' ) || Jetpack_SSO_Helpers::new_user_override() ) ) { |
669
|
|
|
/** |
670
|
|
|
* If not matching by email we still need to verify the email does not exist |
671
|
|
|
* or this blows up |
672
|
|
|
* |
673
|
|
|
* If match_by_email is true, we know the email doesn't exist, as it would have |
674
|
|
|
* been found in the first pass. If get_user_by( 'email' ) doesn't find the |
675
|
|
|
* user, then we know that email is unused, so it's safe to add. |
676
|
|
|
*/ |
677
|
|
|
if ( Jetpack_SSO_Helpers::match_by_email() || ! get_user_by( 'email', $user_data->email ) ) { |
678
|
|
|
$user = Jetpack_SSO_Helpers::generate_user( $user_data ); |
679
|
|
|
if ( ! $user ) { |
680
|
|
|
JetpackTracking::record_user_event( 'sso_login_failed', array( |
681
|
|
|
'error_message' => 'could_not_create_username' |
682
|
|
|
) ); |
683
|
|
|
add_filter( 'login_message', array( $this, 'error_unable_to_create_user' ) ); |
684
|
|
|
return; |
685
|
|
|
} |
686
|
|
|
|
687
|
|
|
$user_found_with = Jetpack_SSO_Helpers::new_user_override() |
688
|
|
|
? 'user_created_new_user_override' |
689
|
|
|
: 'user_created_users_can_register'; |
690
|
|
|
} else { |
691
|
|
|
JetpackTracking::record_user_event( 'sso_login_failed', array( |
692
|
|
|
'error_message' => 'error_msg_email_already_exists' |
693
|
|
|
) ); |
694
|
|
|
|
695
|
|
|
$this->user_data = $user_data; |
696
|
|
|
add_action( 'login_message', array( $this, 'error_msg_email_already_exists' ) ); |
697
|
|
|
return; |
698
|
|
|
} |
699
|
|
|
} |
700
|
|
|
|
701
|
|
|
/** |
702
|
|
|
* Fires after we got login information from WordPress.com. |
703
|
|
|
* |
704
|
|
|
* @module sso |
705
|
|
|
* |
706
|
|
|
* @since 2.6.0 |
707
|
|
|
* |
708
|
|
|
* @param array $user Local User information. |
709
|
|
|
* @param object $user_data WordPress.com User Login information. |
710
|
|
|
*/ |
711
|
|
|
do_action( 'jetpack_sso_handle_login', $user, $user_data ); |
712
|
|
|
|
713
|
|
|
if ( $user ) { |
714
|
|
|
// Cache the user's details, so we can present it back to them on their user screen |
715
|
|
|
update_user_meta( $user->ID, 'wpcom_user_data', $user_data ); |
716
|
|
|
|
717
|
|
|
$remember = false; |
718
|
|
View Code Duplication |
if ( ! empty( $_COOKIE['jetpack_sso_remember_me'] ) ) { |
719
|
|
|
$remember = true; |
720
|
|
|
// And then purge it |
721
|
|
|
setcookie( 'jetpack_sso_remember_me', ' ', time() - YEAR_IN_SECONDS, COOKIEPATH, COOKIE_DOMAIN ); |
722
|
|
|
} |
723
|
|
|
/** |
724
|
|
|
* Filter the remember me value. |
725
|
|
|
* |
726
|
|
|
* @module sso |
727
|
|
|
* |
728
|
|
|
* @since 2.8.0 |
729
|
|
|
* |
730
|
|
|
* @param bool $remember Is the remember me option checked? |
731
|
|
|
*/ |
732
|
|
|
$remember = apply_filters( 'jetpack_remember_login', $remember ); |
733
|
|
|
wp_set_auth_cookie( $user->ID, $remember ); |
734
|
|
|
|
735
|
|
|
/** This filter is documented in core/src/wp-includes/user.php */ |
736
|
|
|
do_action( 'wp_login', $user->user_login, $user ); |
737
|
|
|
|
738
|
|
|
wp_set_current_user( $user->ID ); |
739
|
|
|
|
740
|
|
|
$_request_redirect_to = isset( $_REQUEST['redirect_to'] ) ? esc_url_raw( $_REQUEST['redirect_to'] ) : ''; |
741
|
|
|
$redirect_to = user_can( $user, 'edit_posts' ) ? admin_url() : self::profile_page_url(); |
742
|
|
|
|
743
|
|
|
// If we have a saved redirect to request in a cookie |
744
|
|
View Code Duplication |
if ( ! empty( $_COOKIE['jetpack_sso_redirect_to'] ) ) { |
745
|
|
|
// Set that as the requested redirect to |
746
|
|
|
$redirect_to = $_request_redirect_to = esc_url_raw( $_COOKIE['jetpack_sso_redirect_to'] ); |
747
|
|
|
// And then purge it |
748
|
|
|
setcookie( 'jetpack_sso_redirect_to', ' ', time() - YEAR_IN_SECONDS, COOKIEPATH, COOKIE_DOMAIN ); |
749
|
|
|
} |
750
|
|
|
|
751
|
|
|
$is_user_connected = Jetpack::is_user_connected( $user->ID ); |
752
|
|
|
JetpackTracking::record_user_event( 'sso_user_logged_in', array( |
753
|
|
|
'user_found_with' => $user_found_with, |
754
|
|
|
'user_connected' => (bool) $is_user_connected, |
755
|
|
|
'user_role' => Jetpack::translate_current_user_to_role() |
756
|
|
|
) ); |
757
|
|
|
|
758
|
|
|
if ( ! $is_user_connected ) { |
759
|
|
|
$calypso_env = ! empty( $_GET['calypso_env'] ) |
760
|
|
|
? sanitize_key( $_GET['calypso_env'] ) |
761
|
|
|
: ''; |
762
|
|
|
|
763
|
|
|
wp_safe_redirect( |
764
|
|
|
add_query_arg( |
765
|
|
|
array( |
766
|
|
|
'redirect_to' => $redirect_to, |
767
|
|
|
'request_redirect_to' => $_request_redirect_to, |
768
|
|
|
'calypso_env' => $calypso_env, |
769
|
|
|
'jetpack-sso-auth-redirect' => '1', |
770
|
|
|
), |
771
|
|
|
admin_url() |
772
|
|
|
) |
773
|
|
|
); |
774
|
|
|
exit; |
|
|
|
|
775
|
|
|
} |
776
|
|
|
|
777
|
|
|
wp_safe_redirect( |
778
|
|
|
/** This filter is documented in core/src/wp-login.php */ |
779
|
|
|
apply_filters( 'login_redirect', $redirect_to, $_request_redirect_to, $user ) |
780
|
|
|
); |
781
|
|
|
exit; |
|
|
|
|
782
|
|
|
} |
783
|
|
|
|
784
|
|
|
add_filter( 'jetpack_sso_default_to_sso_login', '__return_false' ); |
785
|
|
|
|
786
|
|
|
JetpackTracking::record_user_event( 'sso_login_failed', array( |
787
|
|
|
'error_message' => 'cant_find_user' |
788
|
|
|
) ); |
789
|
|
|
|
790
|
|
|
$this->user_data = $user_data; |
791
|
|
|
/** This filter is documented in core/src/wp-includes/pluggable.php */ |
792
|
|
|
do_action( 'wp_login_failed', $user_data->login ); |
793
|
|
|
add_filter( 'login_message', array( $this, 'cant_find_user' ) ); |
794
|
|
|
} |
795
|
|
|
|
796
|
|
|
static function profile_page_url() { |
797
|
|
|
return admin_url( 'profile.php' ); |
798
|
|
|
} |
799
|
|
|
|
800
|
|
|
/** |
801
|
|
|
* Builds the "Login to WordPress.com" button that is displayed on the login page as well as user profile page. |
802
|
|
|
* |
803
|
|
|
* @param array $args An array of arguments to add to the SSO URL. |
804
|
|
|
* @param boolean $is_primary Should the button have the `button-primary` class? |
805
|
|
|
* @return string Returns the HTML markup for the button. |
806
|
|
|
*/ |
807
|
|
|
function build_sso_button( $args = array(), $is_primary = false ) { |
808
|
|
|
$url = $this->build_sso_button_url( $args ); |
809
|
|
|
$classes = $is_primary |
810
|
|
|
? 'jetpack-sso button button-primary' |
811
|
|
|
: 'jetpack-sso button'; |
812
|
|
|
|
813
|
|
|
return sprintf( |
814
|
|
|
'<a rel="nofollow" href="%1$s" class="%2$s"><span>%3$s %4$s</span></a>', |
815
|
|
|
esc_url( $url ), |
816
|
|
|
$classes, |
817
|
|
|
'<span class="genericon genericon-wordpress"></span>', |
818
|
|
|
esc_html__( 'Log in with WordPress.com', 'jetpack' ) |
819
|
|
|
); |
820
|
|
|
} |
821
|
|
|
|
822
|
|
|
/** |
823
|
|
|
* Builds a URL with `jetpack-sso` action and option args which is used to setup SSO. |
824
|
|
|
* |
825
|
|
|
* @param array $args An array of arguments to add to the SSO URL. |
826
|
|
|
* @return string The URL used for SSO. |
827
|
|
|
*/ |
828
|
|
|
function build_sso_button_url( $args = array() ) { |
829
|
|
|
$defaults = array( |
830
|
|
|
'action' => 'jetpack-sso', |
831
|
|
|
); |
832
|
|
|
|
833
|
|
|
$args = wp_parse_args( $args, $defaults ); |
834
|
|
|
|
835
|
|
|
if ( ! empty( $_GET['redirect_to'] ) ) { |
836
|
|
|
$args['redirect_to'] = urlencode( esc_url_raw( $_GET['redirect_to'] ) ); |
837
|
|
|
} |
838
|
|
|
|
839
|
|
|
return add_query_arg( $args, wp_login_url() ); |
840
|
|
|
} |
841
|
|
|
|
842
|
|
|
/** |
843
|
|
|
* Retrieves a WordPress.com SSO URL with appropriate query parameters or dies. |
844
|
|
|
* |
845
|
|
|
* @param boolean $reauth Should the user be forced to reauthenticate on WordPress.com? |
846
|
|
|
* @param array $args Optional query parameters. |
847
|
|
|
* @return string The WordPress.com SSO URL. |
848
|
|
|
*/ |
849
|
|
|
function get_sso_url_or_die( $reauth = false, $args = array() ) { |
850
|
|
|
if ( empty( $reauth ) ) { |
851
|
|
|
$sso_redirect = $this->build_sso_url( $args ); |
852
|
|
|
} else { |
853
|
|
|
self::clear_wpcom_profile_cookies(); |
854
|
|
|
$sso_redirect = $this->build_reauth_and_sso_url( $args ); |
855
|
|
|
} |
856
|
|
|
|
857
|
|
|
// If there was an error retrieving the SSO URL, then error. |
858
|
|
|
if ( is_wp_error( $sso_redirect ) ) { |
859
|
|
|
$error_message = sanitize_text_field( |
860
|
|
|
sprintf( '%s: %s', $sso_redirect->get_error_code(), $sso_redirect->get_error_message() ) |
|
|
|
|
861
|
|
|
); |
862
|
|
|
JetpackTracking::record_user_event( 'sso_login_redirect_failed', array( |
863
|
|
|
'error_message' => $error_message |
864
|
|
|
) ); |
865
|
|
|
wp_die( $error_message ); |
866
|
|
|
} |
867
|
|
|
|
868
|
|
|
return $sso_redirect; |
869
|
|
|
} |
870
|
|
|
|
871
|
|
|
/** |
872
|
|
|
* Build WordPress.com SSO URL with appropriate query parameters. |
873
|
|
|
* |
874
|
|
|
* @param array $args Optional query parameters. |
875
|
|
|
* @return string WordPress.com SSO URL |
876
|
|
|
*/ |
877
|
|
|
function build_sso_url( $args = array() ) { |
878
|
|
|
$sso_nonce = ! empty( $args['sso_nonce'] ) ? $args['sso_nonce'] : self::request_initial_nonce(); |
879
|
|
|
$defaults = array( |
880
|
|
|
'action' => 'jetpack-sso', |
881
|
|
|
'site_id' => Jetpack_Options::get_option( 'id' ), |
882
|
|
|
'sso_nonce' => $sso_nonce, |
883
|
|
|
'calypso_auth' => '1', |
884
|
|
|
); |
885
|
|
|
|
886
|
|
|
$args = wp_parse_args( $args, $defaults ); |
887
|
|
|
|
888
|
|
|
if ( is_wp_error( $args['sso_nonce'] ) ) { |
889
|
|
|
return $args['sso_nonce']; |
890
|
|
|
} |
891
|
|
|
|
892
|
|
|
return add_query_arg( $args, 'https://wordpress.com/wp-login.php' ); |
893
|
|
|
} |
894
|
|
|
|
895
|
|
|
/** |
896
|
|
|
* Build WordPress.com SSO URL with appropriate query parameters, |
897
|
|
|
* including the parameters necessary to force the user to reauthenticate |
898
|
|
|
* on WordPress.com. |
899
|
|
|
* |
900
|
|
|
* @param array $args Optional query parameters. |
901
|
|
|
* @return string WordPress.com SSO URL |
902
|
|
|
*/ |
903
|
|
|
function build_reauth_and_sso_url( $args = array() ) { |
904
|
|
|
$sso_nonce = ! empty( $args['sso_nonce'] ) ? $args['sso_nonce'] : self::request_initial_nonce(); |
905
|
|
|
$redirect = $this->build_sso_url( array( 'force_auth' => '1', 'sso_nonce' => $sso_nonce ) ); |
906
|
|
|
|
907
|
|
|
if ( is_wp_error( $redirect ) ) { |
908
|
|
|
return $redirect; |
909
|
|
|
} |
910
|
|
|
|
911
|
|
|
$defaults = array( |
912
|
|
|
'action' => 'jetpack-sso', |
913
|
|
|
'site_id' => Jetpack_Options::get_option( 'id' ), |
914
|
|
|
'sso_nonce' => $sso_nonce, |
915
|
|
|
'reauth' => '1', |
916
|
|
|
'redirect_to' => urlencode( $redirect ), |
917
|
|
|
'calypso_auth' => '1', |
918
|
|
|
); |
919
|
|
|
|
920
|
|
|
$args = wp_parse_args( $args, $defaults ); |
921
|
|
|
|
922
|
|
|
if ( is_wp_error( $args['sso_nonce'] ) ) { |
923
|
|
|
return $args['sso_nonce']; |
924
|
|
|
} |
925
|
|
|
|
926
|
|
|
return add_query_arg( $args, 'https://wordpress.com/wp-login.php' ); |
927
|
|
|
} |
928
|
|
|
|
929
|
|
|
/** |
930
|
|
|
* Determines local user associated with a given WordPress.com user ID. |
931
|
|
|
* |
932
|
|
|
* @since 2.6.0 |
933
|
|
|
* |
934
|
|
|
* @param int $wpcom_user_id User ID from WordPress.com |
935
|
|
|
* @return object Local user object if found, null if not. |
936
|
|
|
*/ |
937
|
|
|
static function get_user_by_wpcom_id( $wpcom_user_id ) { |
938
|
|
|
$user_query = new WP_User_Query( array( |
939
|
|
|
'meta_key' => 'wpcom_user_id', |
940
|
|
|
'meta_value' => intval( $wpcom_user_id ), |
941
|
|
|
'number' => 1, |
942
|
|
|
) ); |
943
|
|
|
|
944
|
|
|
$users = $user_query->get_results(); |
945
|
|
|
return $users ? array_shift( $users ) : null; |
946
|
|
|
} |
947
|
|
|
|
948
|
|
|
/** |
949
|
|
|
* Error message displayed on the login form when two step is required and |
950
|
|
|
* the user's account on WordPress.com does not have two step enabled. |
951
|
|
|
* |
952
|
|
|
* @since 2.7 |
953
|
|
|
* @param string $message |
954
|
|
|
* @return string |
955
|
|
|
**/ |
956
|
|
|
public function error_msg_enable_two_step( $message ) { |
957
|
|
|
$error = sprintf( |
958
|
|
|
wp_kses( |
959
|
|
|
__( |
960
|
|
|
'Two-Step Authentication is required to access this site. Please visit your <a href="%1$s" target="_blank">Security Settings</a> to configure <a href="%2$s" target="_blank">Two-step Authentication</a> for your account.', |
961
|
|
|
'jetpack' |
962
|
|
|
), |
963
|
|
|
array( 'a' => array( 'href' => array() ) ) |
964
|
|
|
), |
965
|
|
|
'https://wordpress.com/me/security/two-step', |
966
|
|
|
'https://support.wordpress.com/security/two-step-authentication/' |
967
|
|
|
); |
968
|
|
|
|
969
|
|
|
$message .= sprintf( '<p class="message" id="login_error">%s</p>', $error ); |
970
|
|
|
|
971
|
|
|
return $message; |
972
|
|
|
} |
973
|
|
|
|
974
|
|
|
/** |
975
|
|
|
* Error message displayed when the user tries to SSO, but match by email |
976
|
|
|
* is off and they already have an account with their email address on |
977
|
|
|
* this site. |
978
|
|
|
* |
979
|
|
|
* @param string $message |
980
|
|
|
* @return string |
981
|
|
|
*/ |
982
|
|
|
public function error_msg_email_already_exists( $message ) { |
983
|
|
|
$error = sprintf( |
984
|
|
|
wp_kses( |
985
|
|
|
__( |
986
|
|
|
'You already have an account on this site. Please <a href="%1$s">sign in</a> with your username and password and then connect to WordPress.com.', |
987
|
|
|
'jetpack' |
988
|
|
|
), |
989
|
|
|
array( 'a' => array( 'href' => array() ) ) |
990
|
|
|
), |
991
|
|
|
esc_url_raw( add_query_arg( 'jetpack-sso-show-default-form', '1', wp_login_url() ) ) |
992
|
|
|
); |
993
|
|
|
|
994
|
|
|
$message .= sprintf( '<p class="message" id="login_error">%s</p>', $error ); |
995
|
|
|
|
996
|
|
|
return $message; |
997
|
|
|
} |
998
|
|
|
|
999
|
|
|
/** |
1000
|
|
|
* Error message that is displayed when the current site is in an identity crisis and SSO can not be used. |
1001
|
|
|
* |
1002
|
|
|
* @since 4.4.0 |
1003
|
|
|
* |
1004
|
|
|
* @param $message |
1005
|
|
|
* |
1006
|
|
|
* @return string |
1007
|
|
|
*/ |
1008
|
|
|
public function error_msg_identity_crisis( $message ) { |
1009
|
|
|
$error = esc_html__( 'Logging in with WordPress.com is not currently available because this site is experiencing connection problems.', 'jetpack' ); |
1010
|
|
|
$message .= sprintf( '<p class="message" id="login_error">%s</p>', $error ); |
1011
|
|
|
return $message; |
1012
|
|
|
} |
1013
|
|
|
|
1014
|
|
|
/** |
1015
|
|
|
* Error message that is displayed when we are not able to verify the SSO nonce due to an XML error or |
1016
|
|
|
* failed validation. In either case, we prompt the user to try again or log in with username and password. |
1017
|
|
|
* |
1018
|
|
|
* @since 4.4.0 |
1019
|
|
|
* |
1020
|
|
|
* @param $message |
1021
|
|
|
* |
1022
|
|
|
* @return string |
1023
|
|
|
*/ |
1024
|
|
|
public function error_invalid_response_data( $message ) { |
1025
|
|
|
$error = esc_html__( |
1026
|
|
|
'There was an error logging you in via WordPress.com, please try again or try logging in with your username and password.', |
1027
|
|
|
'jetpack' |
1028
|
|
|
); |
1029
|
|
|
$message .= sprintf( '<p class="message" id="login_error">%s</p>', $error ); |
1030
|
|
|
return $message; |
1031
|
|
|
} |
1032
|
|
|
|
1033
|
|
|
/** |
1034
|
|
|
* Error message that is displayed when we were not able to automatically create an account for a user |
1035
|
|
|
* after a user has logged in via SSO. By default, this message is triggered after trying to create an account 5 times. |
1036
|
|
|
* |
1037
|
|
|
* @since 4.4.0 |
1038
|
|
|
* |
1039
|
|
|
* @param $message |
1040
|
|
|
* |
1041
|
|
|
* @return string |
1042
|
|
|
*/ |
1043
|
|
|
public function error_unable_to_create_user( $message ) { |
1044
|
|
|
$error = esc_html__( |
1045
|
|
|
'There was an error creating a user for you. Please contact the administrator of your site.', |
1046
|
|
|
'jetpack' |
1047
|
|
|
); |
1048
|
|
|
$message .= sprintf( '<p class="message" id="login_error">%s</p>', $error ); |
1049
|
|
|
return $message; |
1050
|
|
|
} |
1051
|
|
|
|
1052
|
|
|
/** |
1053
|
|
|
* Builds the translation ready string that is to be used when the site hides the default login form. |
1054
|
|
|
* |
1055
|
|
|
* @since 4.1.0 |
1056
|
|
|
* @return string |
1057
|
|
|
*/ |
1058
|
|
|
public function get_sso_required_message() { |
1059
|
|
|
$msg = esc_html__( 'A WordPress.com account is required to access this site. Click the button below to sign in or create a free WordPress.com account.', 'jetpack' ); |
1060
|
|
|
|
1061
|
|
|
/** |
1062
|
|
|
* Filter the message displayed when the default WordPress login form is disabled. |
1063
|
|
|
* |
1064
|
|
|
* @module sso |
1065
|
|
|
* |
1066
|
|
|
* @since 2.8.0 |
1067
|
|
|
* |
1068
|
|
|
* @param string $msg Disclaimer when default WordPress login form is disabled. |
1069
|
|
|
*/ |
1070
|
|
|
return apply_filters( 'jetpack_sso_disclaimer_message', $msg ); |
1071
|
|
|
} |
1072
|
|
|
|
1073
|
|
|
/** |
1074
|
|
|
* Message displayed when the site admin has disabled the default WordPress |
1075
|
|
|
* login form in Settings > General > Single Sign On |
1076
|
|
|
* |
1077
|
|
|
* @since 2.7 |
1078
|
|
|
* @param string $message |
1079
|
|
|
* |
1080
|
|
|
* @return string |
1081
|
|
|
**/ |
1082
|
|
|
public function msg_login_by_jetpack( $message ) { |
1083
|
|
|
$msg = $this->get_sso_required_message(); |
1084
|
|
|
|
1085
|
|
|
if ( empty( $msg ) ) { |
1086
|
|
|
return $message; |
1087
|
|
|
} |
1088
|
|
|
|
1089
|
|
|
$message .= sprintf( '<p class="message">%s</p>', $msg ); |
1090
|
|
|
return $message; |
1091
|
|
|
} |
1092
|
|
|
|
1093
|
|
|
/** |
1094
|
|
|
* Message displayed when the user can not be found after approving the SSO process on WordPress.com |
1095
|
|
|
* |
1096
|
|
|
* @param string $message |
1097
|
|
|
* @return string |
1098
|
|
|
*/ |
1099
|
|
|
function cant_find_user( $message ) { |
1100
|
|
|
$error = esc_html__( |
1101
|
|
|
"We couldn't find your account. If you already have an account, make sure you have connected to WordPress.com.", |
1102
|
|
|
'jetpack' |
1103
|
|
|
); |
1104
|
|
|
$message .= sprintf( '<p class="message" id="login_error">%s</p>', $error ); |
1105
|
|
|
|
1106
|
|
|
return $message; |
1107
|
|
|
} |
1108
|
|
|
|
1109
|
|
|
/** |
1110
|
|
|
* When jetpack-sso-auth-redirect query parameter is set, will redirect user to |
1111
|
|
|
* WordPress.com authorization flow. |
1112
|
|
|
* |
1113
|
|
|
* We redirect here instead of in handle_login() because Jetpack::init()->build_connect_url |
1114
|
|
|
* calls menu_page_url() which doesn't work properly until admin menus are registered. |
1115
|
|
|
*/ |
1116
|
|
|
function maybe_authorize_user_after_sso() { |
1117
|
|
|
if ( empty( $_GET['jetpack-sso-auth-redirect'] ) ) { |
1118
|
|
|
return; |
1119
|
|
|
} |
1120
|
|
|
|
1121
|
|
|
$redirect_to = ! empty( $_GET['redirect_to'] ) ? esc_url_raw( $_GET['redirect_to'] ) : admin_url(); |
1122
|
|
|
$request_redirect_to = ! empty( $_GET['request_redirect_to'] ) ? esc_url_raw( $_GET['request_redirect_to'] ) : $redirect_to; |
1123
|
|
|
|
1124
|
|
|
/** This filter is documented in core/src/wp-login.php */ |
1125
|
|
|
$redirect_after_auth = apply_filters( 'login_redirect', $redirect_to, $request_redirect_to, wp_get_current_user() ); |
1126
|
|
|
|
1127
|
|
|
/** |
1128
|
|
|
* Since we are passing this redirect to WordPress.com and therefore can not use wp_safe_redirect(), |
1129
|
|
|
* let's sanitize it here to make sure it's safe. If the redirect is not safe, then use admin_url(). |
1130
|
|
|
*/ |
1131
|
|
|
$redirect_after_auth = wp_sanitize_redirect( $redirect_after_auth ); |
1132
|
|
|
$redirect_after_auth = wp_validate_redirect( $redirect_after_auth, admin_url() ); |
1133
|
|
|
|
1134
|
|
|
/** |
1135
|
|
|
* Return the raw connect URL with our redirect and attribute connection to SSO. |
1136
|
|
|
*/ |
1137
|
|
|
$connect_url = Jetpack::init()->build_connect_url( true, $redirect_after_auth, 'sso' ); |
1138
|
|
|
|
1139
|
|
|
add_filter( 'allowed_redirect_hosts', array( 'Jetpack_SSO_Helpers', 'allowed_redirect_hosts' ) ); |
1140
|
|
|
wp_safe_redirect( $connect_url ); |
1141
|
|
|
exit; |
|
|
|
|
1142
|
|
|
} |
1143
|
|
|
|
1144
|
|
|
/** |
1145
|
|
|
* Cache user's display name and Gravatar so it can be displayed on the login screen. These cookies are |
1146
|
|
|
* stored when the user logs out, and then deleted when the user logs in. |
1147
|
|
|
*/ |
1148
|
|
|
function store_wpcom_profile_cookies_on_logout() { |
1149
|
|
|
if ( ! Jetpack::is_user_connected( get_current_user_id() ) ) { |
1150
|
|
|
return; |
1151
|
|
|
} |
1152
|
|
|
|
1153
|
|
|
$user_data = $this->get_user_data( get_current_user_id() ); |
1154
|
|
|
if ( ! $user_data ) { |
1155
|
|
|
return; |
1156
|
|
|
} |
1157
|
|
|
|
1158
|
|
|
setcookie( |
1159
|
|
|
'jetpack_sso_wpcom_name_' . COOKIEHASH, |
1160
|
|
|
$user_data->display_name, |
1161
|
|
|
time() + WEEK_IN_SECONDS, |
1162
|
|
|
COOKIEPATH, |
1163
|
|
|
COOKIE_DOMAIN |
1164
|
|
|
); |
1165
|
|
|
|
1166
|
|
|
setcookie( |
1167
|
|
|
'jetpack_sso_wpcom_gravatar_' . COOKIEHASH, |
1168
|
|
|
get_avatar_url( |
1169
|
|
|
$user_data->email, |
1170
|
|
|
array( 'size' => 144, 'default' => 'mystery' ) |
1171
|
|
|
), |
1172
|
|
|
time() + WEEK_IN_SECONDS, |
1173
|
|
|
COOKIEPATH, |
1174
|
|
|
COOKIE_DOMAIN |
1175
|
|
|
); |
1176
|
|
|
} |
1177
|
|
|
|
1178
|
|
|
/** |
1179
|
|
|
* Determines if a local user is connected to WordPress.com |
1180
|
|
|
* |
1181
|
|
|
* @since 2.8 |
1182
|
|
|
* @param integer $user_id - Local user id |
1183
|
|
|
* @return boolean |
1184
|
|
|
**/ |
1185
|
|
|
public function is_user_connected( $user_id ) { |
1186
|
|
|
return $this->get_user_data( $user_id ); |
1187
|
|
|
} |
1188
|
|
|
|
1189
|
|
|
/** |
1190
|
|
|
* Retrieves a user's WordPress.com data |
1191
|
|
|
* |
1192
|
|
|
* @since 2.8 |
1193
|
|
|
* @param integer $user_id - Local user id |
1194
|
|
|
* @return mixed null or stdClass |
1195
|
|
|
**/ |
1196
|
|
|
public function get_user_data( $user_id ) { |
1197
|
|
|
return get_user_meta( $user_id, 'wpcom_user_data', true ); |
1198
|
|
|
} |
1199
|
|
|
} |
1200
|
|
|
|
1201
|
|
|
Jetpack_SSO::get_instance(); |
1202
|
|
|
|
The PSR-2 coding standard requires that all properties in a class have their visibility explicitly declared. If you declare a property using
the property is implicitly global.
To learn more about the PSR-2, please see the PHP-FIG site on the PSR-2.