Connect.php
14.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
<?php
/**
* Connect.
*
* @copyright (c) 2023, Code Atlantic LLC.
*
* @package ContentControl
*/
namespace ContentControl\Plugin;
use function ContentControl\plugin;
defined( 'ABSPATH' ) || exit;
/**
* Connection management.
*
* NOTE: For wordpress.org admins: This is not called in the free, hosted version. This is only used if:
* - The user explicitly entered a license key.
* - This then opens a window to our site allowing the user to authorize the connection & installation of pro.
*
* @package ContentControl
*/
class Connect {
const API_URL = 'https://upgrade.contentcontrolplugin.com/';
const TOKEN_OPTION_NAME = 'content_control_connect_token';
const NONCE_OPTION_NAME = 'content_control_connect_nonce';
const ERROR_REFERRER = 1;
const ERROR_AUTHENTICATION = 2;
const ERROR_USER_AGENT = 3;
const ERROR_SIGNATURE = 4;
const ERROR_NONCE = 5;
const ERROR_WEBHOOK_ARGS = 6;
/**
* Container.
*
* @var \ContentControl\Base\Container
*/
private $c;
/**
* Initialize license management.
*
* @param \ContentControl\Base\Container $c Container.
*/
public function __construct( $c ) {
$this->c = $c;
}
/**
* Check if debug mode is enabled.
*
* @return bool
*/
public function debug_mode_enabled() {
return defined( '\WP_DEBUG' ) && \WP_DEBUG;
}
/**
* Generate a new authorizatin token.
*
* @return string
*/
public function generate_token() {
$token = hash( 'sha512', (string) wp_rand() );
\set_site_transient( self::TOKEN_OPTION_NAME, $token, HOUR_IN_SECONDS );
return $token;
}
/**
* Get the current token.
*
* @return string|false
*/
public function get_access_token() {
return \get_site_transient( self::TOKEN_OPTION_NAME );
}
/**
* Get the current nonce.
*
* @param string $token Token.
*
* @return string|false
*/
public function get_nonce_name( $token ) {
return self::NONCE_OPTION_NAME . '_' . $token;
}
/**
* Log a message to the debug log if enabled.
*
* Here to prevent constant conditional checks for the debug mode.
*
* @param string $message Message.
* @param string $type Type.
*
* @return void
*/
public function debug_log( $message, $type = 'INFO' ) {
if ( $this->debug_mode_enabled() ) {
plugin( 'logging' )->log( "Plugin\Connect.$type: $message" );
}
}
/**
* Get header Authorization
*
* @return null|string
*/
public function get_request_authorization_header() {
$headers = null;
if ( isset( $_SERVER['Authorization'] ) ) {
$headers = trim( sanitize_text_field( wp_unslash( $_SERVER['Authorization'] ) ) );
} elseif ( isset( $_SERVER['HTTP_AUTHORIZATION'] ) ) { // Nginx or fast CGI.
$headers = trim( sanitize_text_field( wp_unslash( $_SERVER['HTTP_AUTHORIZATION'] ) ) );
} elseif ( function_exists( 'apache_request_headers' ) ) {
$request_headers = apache_request_headers();
// Server-side fix for bug in old Android versions (a nice side-effect of this fix means we don't care about capitalization for Authorization).
$request_headers = array_combine( array_map( 'ucwords', array_keys( $request_headers ) ), array_values( $request_headers ) );
if ( isset( $request_headers['Authorization'] ) ) {
$headers = trim( $request_headers['Authorization'] );
}
}
return $headers;
}
/**
* Get access token from header.
*
* @return string|null
*/
public function get_request_token() {
$headers = $this->get_request_authorization_header();
// HEADER: Get the access token from the header.
if ( ! empty( $headers ) ) {
if ( preg_match( '/Bearer\s(\S+)/', $headers, $matches ) ) {
return trim( $matches[1], ', ' );
}
}
return null;
}
/**
* Get nonce from header.
*
* @return string|null
*/
public function get_request_nonce() {
$headers = $this->get_request_authorization_header();
// HEADER: Get the nonce from the header.
if ( ! empty( $headers ) ) {
if ( preg_match( '/Nonce\s(\S+)/', $headers, $matches ) ) {
return trim( $matches[1], ', ' );
}
}
return null;
}
/**
* Get the OAuth connect URL.
*
* @param string $license_key License key.
*
* @return array{url:string,back_url:string}
*/
public function get_connect_info( $license_key ) {
$token = $this->generate_token();
$nonce = wp_create_nonce( $this->get_nonce_name( $token ) );
$webhook = admin_url( 'admin-ajax.php' );
$redirect = add_query_arg(
[
'page' => 'content-control-settings',
'view' => 'upgrade',
'tab' => 'general',
],
admin_url( 'options-general.php' )
);
$url = add_query_arg(
[
'key' => $license_key,
'token' => $token,
'nonce' => $nonce,
'webhook' => $webhook,
'version' => plugin( 'version' ),
'siteurl' => admin_url(),
'homeurl' => home_url(),
// phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.obfuscation_base64_encode
'redirect' => rawurldecode( base64_encode( $redirect ) ),
],
self::API_URL
);
$this->debug_log( 'Generated new connection.' );
$this->debug_log( 'Token: ' . $token );
$this->debug_log( 'Nonce: ' . $nonce );
return [
'url' => $url,
'back_url' => add_query_arg(
[
'action' => 'content_control_connect',
'token' => $token,
],
$webhook
),
];
}
/**
* Kill the connection with no permission.
*
* @param int $error_no Error number.
* @param string|false $message Error message.
*
* @return void
*/
public function kill_connection( $error_no = self::ERROR_REFERRER, $message = false ) {
$this->debug_log( "Killing connection with error ($error_no) message: " . $message, 'ERROR' );
wp_die(
esc_html(
$this->debug_mode_enabled() && $message ?
$message :
__( 'Sorry, You Are Not Allowed to Access This Page.', 'content-control' )
),
esc_attr( (string) $error_no ),
[ 'response' => 403 ]
);
}
/**
* Verify the user agent.
*
* @return void
*/
public function verify_user_agent() {
// Check user agent matches Content Control Upgrader.
if ( ! isset( $_SERVER['HTTP_USER_AGENT'] ) || 'ContentControlUpgrader' !== $_SERVER['HTTP_USER_AGENT'] ) {
$this->kill_connection( self::ERROR_USER_AGENT, 'User agent invalid.' );
}
}
/**
* Verify the referrer.
*
* @return void
*/
public function verify_referrer() {
$referer = isset( $_SERVER['HTTP_X_SENDING_DOMAIN'] ) ? sanitize_text_field( wp_unslash( $_SERVER['HTTP_X_SENDING_DOMAIN'] ) ) : '';
if ( ! $referer ) {
// Mimic the default you don't have permission to do that screen from WordPress.
$this->kill_connection( self::ERROR_REFERRER, 'Missing referrer' );
}
$referer_host = wp_parse_url( $referer, PHP_URL_HOST );
if ( ! $referer_host ) {
$this->kill_connection( self::ERROR_REFERRER, 'Invalid referrer' );
}
$allowed_hosts = [
'contentcontrolplugin.com',
'upgrade.contentcontrolplugin.com',
];
if ( ! in_array( $referer_host, $allowed_hosts, true ) ) {
$this->debug_log( 'Referrer mismatch: ' . $referer_host, 'DEBUG' );
$this->kill_connection( self::ERROR_REFERRER, 'Referrer doesn\'t match' );
}
}
/**
* Verify the nonce.
*
* @deprecated 2.0.0 Don't use, it doesn't work as its a separate server making request.
*
* @return void
*/
public function verify_nonce() {
$token = $this->get_access_token();
$nonce = $this->get_request_nonce();
if ( ! $nonce ) {
$this->kill_connection( self::ERROR_NONCE, 'Missing nonce' );
}
if ( false === wp_verify_nonce( $nonce, $this->get_nonce_name( $token ) ) ) {
$this->debug_log( 'Nonce mismatch: ' . $nonce, 'DEBUG' );
$this->debug_log( 'Nonce Name: ' . $this->get_nonce_name( $token ) );
$this->kill_connection( self::ERROR_NONCE, 'Invalid nonce' );
}
}
/**
* Verify the authentication token.
*
* @return void
*/
public function verify_authentication() {
// Get token from header Bearer.
$token = $this->get_access_token();
$auth_token = $this->get_request_token();
if ( ! $token || ! $auth_token ) {
$this->kill_connection( self::ERROR_AUTHENTICATION, 'Missing authentication' );
}
// Verify hashes match.
if ( ! hash_equals( $token, $auth_token ) ) {
$this->debug_log( 'Token mismatch: ' . $auth_token, 'DEBUG' );
$this->kill_connection( self::ERROR_AUTHENTICATION, 'Invalid authentiction' );
}
}
/**
* Generate signature hash.
*
* This must match the hash generated on the server.
*
* @see \ontentControlUpgrader\App::generate_hash()
*
* @param array<string,mixed>|string $data Data to hash.
* @param string $token Token to hash with.
* @return string
*/
public function generate_hash( $data, $token ) {
// Convert boolean values to their string representation.
array_walk_recursive($data, function ( &$value ) {
if ( is_bool( $value ) ) {
$value = $value ? '1' : '0';
}
});
if ( ! is_string( $data ) ) {
// Sort the array before encoding it as JSON.
ksort( $data );
// Ignored due to wp_json_encode stripping slashes and breaking hashes.
// phpcs:ignore WordPress.WP.AlternativeFunctions.json_encode_json_encode
$data = json_encode( $data, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE );
}
// Generate the hash binary.
$hash = hash_hmac( 'sha256', $data, $token, true );
// The only deviation from ServerSide is that we optionally log the hash if debug mode is enabled.
$this->debug_log( 'Hash: ' . $hash, 'DEBUG' );
$this->debug_log( 'Data: ' . $data, 'DEBUG' );
// Encode the hash in base64 to make it URL safe.
// phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.obfuscation_base64_encode
return base64_encode( $hash );
}
/**
* Verify the signature of the requester.
*
* @return void
*/
public function verify_signature() {
if ( ! isset( $_SERVER['HTTP_X_CONTENTCONTROL_SIGNATURE'] ) ) {
return;
}
// Verify the webhook signature.
$signature = sanitize_text_field( wp_unslash( $_SERVER['HTTP_X_CONTENTCONTROL_SIGNATURE'] ) );
// Calculate the expected signature.
// phpcs:ignore WordPress.Security.NonceVerification.Missing
$expected_signature = $this->generate_hash( $_POST, $this->get_access_token() );
// Compare the expected signature to the received signature.
if ( ! hash_equals( $expected_signature, $signature ) ) {
$this->debug_log( "Signature mismatch: \r\n - Webhook: " . $signature . "\r\n - Calculated: " . $expected_signature, 'DEBUG' );
$this->kill_connection( self::ERROR_SIGNATURE, 'Invalid signature' );
}
}
/**
* Validate the connection.
*
* @return void
*/
public function validate_connection() {
$this->debug_log( 'Validating connection...', 'DEBUG' );
$this->verify_user_agent();
// If production, verify the referrer.
if ( 'production' === wp_get_environment_type() ) {
$this->verify_referrer();
}
$this->verify_authentication();
$this->verify_signature();
$this->debug_log( 'Connection validated', 'DEBUG' );
}
/**
* Verify the connection.
*
* @return void
*/
public function process_verify_connection() {
$this->validate_connection();
wp_send_json_success();
}
/**
* Get the webhook args.
*
* @return array{file:string,type:string,slug:string,force:boolean}
*/
public function get_webhook_args() {
$args = [
// phpcs:disable WordPress.Security.NonceVerification.Recommended
'file' => ! empty( $_REQUEST['file'] ) ? esc_url_raw( wp_unslash( $_REQUEST['file'] ) ) : '',
'type' => ! empty( $_REQUEST['type'] ) ? sanitize_text_field( wp_unslash( $_REQUEST['type'] ) ) : 'plugin',
'slug' => ! empty( $_REQUEST['slug'] ) ? sanitize_text_field( wp_unslash( $_REQUEST['slug'] ) ) : '',
'force' => ! empty( $_REQUEST['force'] ) ? (bool) $_REQUEST['force'] : false,
// phpcs:enable WordPress.Security.NonceVerification.Recommended
];
$this->verify_webhook_args( $args );
return $args;
}
/**
* Verify and return webhook args.
*
* @param array{file:string,type:string,slug:string,force:bool} $args The webhook args.
*
* @return void
*/
public function verify_webhook_args( $args ) {
$file_url = ! empty( $args['file'] ) ? $args['file'] : false;
$file_type = ! empty( $args['type'] ) ? $args['type'] : false;
$file_slug = ! empty( $args['slug'] ) ? $args['slug'] : false;
$force = ! empty( $args['force'] ) ? (bool) $args['force'] : false;
if ( ! $file_url || ! $file_type || ! $file_slug ) {
$this->kill_connection( self::ERROR_WEBHOOK_ARGS, 'Missing webhook args' );
}
if ( ! in_array( $file_type, [ 'plugin', 'theme' ], true ) ) {
$this->kill_connection( self::ERROR_WEBHOOK_ARGS, 'Invalid webhook args' );
}
}
/**
* Listen for incoming secure webhooks from the API server.
*
* @return void
*/
public function process_webhook() {
// 1. Validate the connection is secure & from the API server.
$this->validate_connection();
$error = esc_html__( 'There was an error while installing an upgrade. Please download the plugin from contentcontrolplugin.com and install it manually.', 'content-control' );
// 2. Get the webhook data.
$args = $this->get_webhook_args();
// 3. Validate license key.
if ( ! plugin( 'license' )->is_license_active() ) {
$this->debug_log( 'License not active', 'DEBUG' );
wp_send_json_error( $error );
}
// Set the current screen to avoid undefined notices.
set_current_screen( 'settings_page_content-control-settings' );
// 4. Install the plugin.
switch ( $args['type'] ) {
case 'plugin':
$this->install_plugin( $args );
break;
}
// 5. Delete the token to prevent abuse. Doing so last means it should be possible to retry if something goes wrong.
if ( ! $this->debug_mode_enabled() ) {
$this->debug_log( 'Deleting token', 'DEBUG' );
\delete_site_transient( self::TOKEN_OPTION_NAME );
}
}
/**
* Install a plugin.
*
* @param array{file:string,type:string,slug:string,force:bool} $args The file args.
* @return void
*/
public function install_plugin( $args ) {
$this->debug_log( 'Installing plugin...', 'DEBUG' );
// If not forcing, and already active, return success.
if ( ! $args['force'] && is_plugin_active( "{$args['slug']}/{$args['slug']}.php" ) ) {
$this->debug_log( 'Plugin already installed & active.', 'DEBUG' );
wp_send_json_success( esc_html__( 'Plugin installed & activated.', 'content-control' ) );
}
// Get the upgrader.
$upgrader = $this->c->get( 'upgrader' );
// Install the plugin. (if installed already, this will replace it using upgrade).
$installed = $upgrader->install_plugin( $args['file'] );
if ( ! is_wp_error( $installed ) ) {
$this->debug_log( 'Plugin installed & activated successfully.', 'DEBUG' );
wp_send_json_success( esc_html__( 'Plugin installed & activated.', 'content-control' ) );
}
switch ( $installed->get_error_code() ) {
default:
$error = $installed->get_error_message();
}
if ( empty( $error ) ) {
$error = esc_html__( 'There was an error while installing an upgrade. Please download the plugin from contentcontrolplugin.com and install it manually.', 'content-control' );
}
$this->debug_log( 'Plugin install failed: ' . $error, 'DEBUG' );
wp_send_json_error( $installed->get_error_message() );
}
}