Issues in class.jetpack-client.php - All Issues - Inspection of "Add Constant so that it is easier for Jetpack to t..." - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — add/rest-api-sandbox-const ( f30538 )

unknown

created 2016-02-15 17:27 UTC

class.jetpack-client.php (3 issues)

Labels

Severity

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?php

class Jetpack_Client {
	const WPCOM_JSON_API_HOST    =  JETPACK__WPCOM_JSON_API_HOST;
	const WPCOM_JSON_API_VERSION = '1.1';

	/**
	 * Makes an authorized remote request using Jetpack_Signature
	 *
	 * @return array|WP_Error WP HTTP response on success
	 */
	public static function remote_request( $args, $body = null ) {
		$defaults = array(
			'url' => '',
			'user_id' => 0,
			'blog_id' => 0,
			'auth_location' => JETPACK_CLIENT__AUTH_LOCATION,
			'method' => 'POST',
			'timeout' => 10,
			'redirection' => 0,
		);

		$args = wp_parse_args( $args, $defaults );

		$args['blog_id'] = (int) $args['blog_id'];

		if ( 'header' != $args['auth_location'] ) {
			$args['auth_location'] = 'query_string';
		}

		$token = Jetpack_Data::get_access_token( $args['user_id'] );
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
		if ( !$token ) {
			return new Jetpack_Error( 'missing_token' );
		}

		$method = strtoupper( $args['method'] );

		$timeout = intval( $args['timeout'] );

		$redirection = $args['redirection'];

		$request = compact( 'method', 'body', 'timeout', 'redirection' );

		@list( $token_key, $secret ) = explode( '.', $token->secret );
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
		if ( empty( $token ) || empty( $secret ) ) {
			return new Jetpack_Error( 'malformed_token' );
		}

		$token_key = sprintf( '%s:%d:%d', $token_key, JETPACK__API_VERSION, $token->external_user_id );

		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-signature.php';

		$time_diff = (int) Jetpack_Options::get_option( 'time_diff' );
		$jetpack_signature = new Jetpack_Signature( $token->secret, $time_diff );

		$timestamp = time() + $time_diff;

		if( function_exists( 'wp_generate_password' ) ) {
			$nonce = wp_generate_password( 10, false );
		} else {
			$nonce = substr( sha1( rand( 0, 1000000 ) ), 0, 10);
		}

		// Kind of annoying.  Maybe refactor Jetpack_Signature to handle body-hashing
		if ( is_null( $body ) ) {
			$body_hash = '';
		} else {
			if ( !is_string( $body ) ) {
				return new Jetpack_Error( 'invalid_body', 'Body is malformed.' );
			}
			$body_hash = jetpack_sha1_base64( $body );
		}

		$auth = array(
			'token' => $token_key,
			'timestamp' => $timestamp,
			'nonce' => $nonce,
			'body-hash' => $body_hash,
		);

		if ( false !== strpos( $args['url'], 'xmlrpc.php' ) ) {
			$url_args = array(
				'for'           => 'jetpack',
				'wpcom_blog_id' => Jetpack_Options::get_option( 'id' ),
			);
		} else {
			$url_args = array();
		}

		if ( 'header' != $args['auth_location'] ) {
			$url_args += $auth;
		}

		$url = add_query_arg( urlencode_deep( $url_args ), $args['url'] );
		$url = Jetpack::fix_url_for_bad_hosts( $url );

		$signature = $jetpack_signature->sign_request( $token_key, $timestamp, $nonce, $body_hash, $method, $url, $body, false );

		if ( !$signature || is_wp_error( $signature ) ) {
			return $signature;
		}

		// Send an Authorization header so various caches/proxies do the right thing
		$auth['signature'] = $signature;
		$auth['version'] = JETPACK__VERSION;
		$header_pieces = array();
		foreach ( $auth as $key => $value ) {
			$header_pieces[] = sprintf( '%s="%s"', $key, $value );
		}

		$request['headers'] = array(
			'Authorization' => "X_JETPACK " . join( ' ', $header_pieces ),
 			'Host'			=> 'public-api.wordpress.com'
		);

		if ( 'header' != $args['auth_location'] ) {
			$url = add_query_arg( 'signature', urlencode( $signature ), $url );
		}

		return Jetpack_Client::_wp_remote_request( $url, $request );
	}

	/**
	 * Wrapper for wp_remote_request().  Turns off SSL verification for certain SSL errors.
	 * This is lame, but many, many, many hosts have misconfigured SSL.
	 *
	 * When Jetpack is registered, the jetpack_fallback_no_verify_ssl_certs option is set to the current time if:
	 * 1. a certificate error is found AND
	 * 2. not verifying the certificate works around the problem.
	 *
	 * The option is checked on each request.
	 *
	 * @internal
	 * @see Jetpack::fix_url_for_bad_hosts()
	 *
	 * @return array|WP_Error WP HTTP response on success
	 */
	public static function _wp_remote_request( $url, $args, $set_fallback = false ) {
		/**
		 * SSL verification (`sslverify`) for the JetpackClient remote request
		 * defaults to off, use this filter to force it on.
		 *
		 * Return `true` to ENABLE SSL verification, return `false`
		 * to DISABLE SSL verification.
		 *
		 * @since 3.6.0
		 *
		 * @param bool Whether to force `sslverify` or not.
		 */
		if ( apply_filters( 'jetpack_client_verify_ssl_certs', false ) ) {
			return wp_remote_request( $url, $args );
		}

		$fallback = Jetpack_Options::get_option( 'fallback_no_verify_ssl_certs' );
		if ( false === $fallback ) {
			Jetpack_Options::update_option( 'fallback_no_verify_ssl_certs', 0 );
		}

		if ( (int) $fallback ) {
			// We're flagged to fallback
			$args['sslverify'] = false;
		}

		$response = wp_remote_request( $url, $args );

		if (
			!$set_fallback                                     // We're not allowed to set the flag on this request, so whatever happens happens
		||
			isset( $args['sslverify'] ) && !$args['sslverify'] // No verification - no point in doing it again
		||
			!is_wp_error( $response )                          // Let it ride
		) {
			Jetpack_Client::set_time_diff( $response, $set_fallback );
			return $response;
		}

		// At this point, we're not flagged to fallback and we are allowed to set the flag on this request.

		$message = $response->get_error_message();

		// Is it an SSL Certificate verification error?
		if (
			false === strpos( $message, '14090086' ) // OpenSSL SSL3 certificate error
		&&
			false === strpos( $message, '1407E086' ) // OpenSSL SSL2 certificate error
		&&
			false === strpos( $message, 'error setting certificate verify locations' ) // cURL CA bundle not found
		&&
			false === strpos( $message, 'Peer certificate cannot be authenticated with' ) // cURL CURLE_SSL_CACERT: CA bundle found, but not helpful
			                                                                              // different versions of curl have different error messages
			                                                                              // this string should catch them all
		&&
			false === strpos( $message, 'Problem with the SSL CA cert' ) // cURL CURLE_SSL_CACERT_BADFILE: probably access rights
		) {
			// No, it is not.
			return $response;
		}

		// Redo the request without SSL certificate verification.
		$args['sslverify'] = false;
		$response = wp_remote_request( $url, $args );

		if ( !is_wp_error( $response ) ) {
			// The request went through this time, flag for future fallbacks
			Jetpack_Options::update_option( 'fallback_no_verify_ssl_certs', time() );
			Jetpack_Client::set_time_diff( $response, $set_fallback );
		}

		return $response;
	}

	public static function set_time_diff( &$response, $force_set = false ) {
		$code = wp_remote_retrieve_response_code( $response );

		// Only trust the Date header on some responses
		if ( 200 != $code && 304 != $code && 400 != $code && 401 != $code ) {
			return;
		}

		if ( !$date = wp_remote_retrieve_header( $response, 'date' ) ) {
			return;
		}

		if ( 0 >= $time = (int) strtotime( $date ) ) {
			return;
		}

		$time_diff = $time - time();

		if ( $force_set ) { // during register
			Jetpack_Options::update_option( 'time_diff', $time_diff );
		} else { // otherwise
			$old_diff = Jetpack_Options::get_option( 'time_diff' );
			if ( false === $old_diff || abs( $time_diff - (int) $old_diff ) > 10 ) {
				Jetpack_Options::update_option( 'time_diff', $time_diff );
			}
		}
	}

	/**
	 * Query the WordPress.com REST API using the blog token
	 *
	 * @param string  $path
	 * @param string  $version
	 * @param array   $args
	 * @param string  $body

	 * @return array|WP_Error $response Data.
	 */
	static function wpcom_json_api_request_as_blog( $path, $version = self::WPCOM_JSON_API_VERSION, $args = array(), $body = null ) {
		$filtered_args = array_intersect_key( $args, array(
			'method'      => 'string',
			'timeout'     => 'int',
			'redirection' => 'int',
		) );

		/**
		 * Determines whether Jetpack can send outbound https requests to the WPCOM api.
		 *
		 * @since 3.6.0
		 *
		 * @param bool $proto Defaults to true.
		 */
		$proto = apply_filters( 'jetpack_can_make_outbound_https', true ) ? 'https' : 'http';

		// unprecedingslashit
		$_path = preg_replace( '/^\//', '', $path );

		// Use GET by default whereas `remote_request` uses POST
		if ( isset( $filtered_args['method'] ) && strtoupper( $filtered_args['method'] === 'POST' ) ) {
			$request_method = 'POST';
		} else {
			$request_method = 'GET';
		}

		$validated_args = array_merge( $filtered_args, array(
			'url'     => sprintf( '%s://%s/rest/v%s/%s', $proto, self::WPCOM_JSON_API_HOST, $version, $_path ),
			'blog_id' => (int) Jetpack_Options::get_option( 'id' ),
			'method'  => $request_method,
		) );

		return Jetpack_Client::remote_request( $validated_args, $body );
	}

}


1		<?php
2
3		class Jetpack_Client {
4		const WPCOM_JSON_API_HOST = JETPACK__WPCOM_JSON_API_HOST;
5		const WPCOM_JSON_API_VERSION = '1.1';
6
7		/**
8		* Makes an authorized remote request using Jetpack_Signature
9		*
10		* @return array\|WP_Error WP HTTP response on success
11		*/
12		public static function remote_request( $args, $body = null ) {
13		$defaults = array(
14		'url' => '',
15		'user_id' => 0,
16		'blog_id' => 0,
17		'auth_location' => JETPACK_CLIENT__AUTH_LOCATION,
18		'method' => 'POST',
19		'timeout' => 10,
20		'redirection' => 0,
21		);
22
23		$args = wp_parse_args( $args, $defaults );
24
25		$args['blog_id'] = (int) $args['blog_id'];
26
27		if ( 'header' != $args['auth_location'] ) {
28		$args['auth_location'] = 'query_string';
29		}
30
31		$token = Jetpack_Data::get_access_token( $args['user_id'] );
		0 ignored issues – show Documentation introduced 2015-11-20 23:03 UTC by Report Bug Copy Issue Report Show Similar Issues like this `$args['user_id']` is of type `integer\|string`, but the function expects a `boolean`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
32		if ( !$token ) {
33		return new Jetpack_Error( 'missing_token' );
34		}
35
36		$method = strtoupper( $args['method'] );
37
38		$timeout = intval( $args['timeout'] );
39
40		$redirection = $args['redirection'];
41
42		$request = compact( 'method', 'body', 'timeout', 'redirection' );
43
44		@list( $token_key, $secret ) = explode( '.', $token->secret );
		0 ignored issues – show Security Best Practice introduced 2015-11-20 23:03 UTC by Report Bug Copy Issue Report Show Similar Issues like this It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended. If you suppress an error, we recommend checking for the error condition explicitly: // For example instead of @mkdir($dir); // Better use if (@mkdir($dir) === false) { throw new \RuntimeException('The directory '.$dir.' could not be created.'); } Loading history...
45		if ( empty( $token ) \|\| empty( $secret ) ) {
46		return new Jetpack_Error( 'malformed_token' );
47		}
48
49		$token_key = sprintf( '%s:%d:%d', $token_key, JETPACK__API_VERSION, $token->external_user_id );
50
51		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-signature.php';
52
53		$time_diff = (int) Jetpack_Options::get_option( 'time_diff' );
54		$jetpack_signature = new Jetpack_Signature( $token->secret, $time_diff );
55
56		$timestamp = time() + $time_diff;
57
58		if( function_exists( 'wp_generate_password' ) ) {
59		$nonce = wp_generate_password( 10, false );
60		} else {
61		$nonce = substr( sha1( rand( 0, 1000000 ) ), 0, 10);
62		}
63
64		// Kind of annoying. Maybe refactor Jetpack_Signature to handle body-hashing
65	View Code Duplication	if ( is_null( $body ) ) {
66		$body_hash = '';
67		} else {
68		if ( !is_string( $body ) ) {
69		return new Jetpack_Error( 'invalid_body', 'Body is malformed.' );
70		}
71		$body_hash = jetpack_sha1_base64( $body );
72		}
73
74		$auth = array(
75		'token' => $token_key,
76		'timestamp' => $timestamp,
77		'nonce' => $nonce,
78		'body-hash' => $body_hash,
79		);
80
81		if ( false !== strpos( $args['url'], 'xmlrpc.php' ) ) {
82		$url_args = array(
83		'for' => 'jetpack',
84		'wpcom_blog_id' => Jetpack_Options::get_option( 'id' ),
85		);
86		} else {
87		$url_args = array();
88		}
89
90		if ( 'header' != $args['auth_location'] ) {
91		$url_args += $auth;
92		}
93
94		$url = add_query_arg( urlencode_deep( $url_args ), $args['url'] );
95		$url = Jetpack::fix_url_for_bad_hosts( $url );
96
97		$signature = $jetpack_signature->sign_request( $token_key, $timestamp, $nonce, $body_hash, $method, $url, $body, false );
98
99		if ( !$signature \|\| is_wp_error( $signature ) ) {
100		return $signature;
101		}
102
103		// Send an Authorization header so various caches/proxies do the right thing
104		$auth['signature'] = $signature;
105		$auth['version'] = JETPACK__VERSION;
106		$header_pieces = array();
107		foreach ( $auth as $key => $value ) {
108		$header_pieces[] = sprintf( '%s="%s"', $key, $value );
109		}
110
111		$request['headers'] = array(
112		'Authorization' => "X_JETPACK " . join( ' ', $header_pieces ),
113		'Host' => 'public-api.wordpress.com'
114		);
115
116		if ( 'header' != $args['auth_location'] ) {
117		$url = add_query_arg( 'signature', urlencode( $signature ), $url );
118		}
119
120		return Jetpack_Client::_wp_remote_request( $url, $request );
121		}
122
123		/**
124		* Wrapper for wp_remote_request(). Turns off SSL verification for certain SSL errors.
125		* This is lame, but many, many, many hosts have misconfigured SSL.
126		*
127		* When Jetpack is registered, the jetpack_fallback_no_verify_ssl_certs option is set to the current time if:
128		* 1. a certificate error is found AND
129		* 2. not verifying the certificate works around the problem.
130		*
131		* The option is checked on each request.
132		*
133		* @internal
134		* @see Jetpack::fix_url_for_bad_hosts()
135		*
136		* @return array\|WP_Error WP HTTP response on success
137		*/
138		public static function _wp_remote_request( $url, $args, $set_fallback = false ) {
139		/**
140		* SSL verification (`sslverify`) for the JetpackClient remote request
141		* defaults to off, use this filter to force it on.
142		*
143		* Return `true` to ENABLE SSL verification, return `false`
144		* to DISABLE SSL verification.
145		*
146		* @since 3.6.0
147		*
148		* @param bool Whether to force `sslverify` or not.
149		*/
150		if ( apply_filters( 'jetpack_client_verify_ssl_certs', false ) ) {
151		return wp_remote_request( $url, $args );
152		}
153
154		$fallback = Jetpack_Options::get_option( 'fallback_no_verify_ssl_certs' );
155		if ( false === $fallback ) {
156		Jetpack_Options::update_option( 'fallback_no_verify_ssl_certs', 0 );
157		}
158
159		if ( (int) $fallback ) {
160		// We're flagged to fallback
161		$args['sslverify'] = false;
162		}
163
164		$response = wp_remote_request( $url, $args );
165
166		if (
167		!$set_fallback // We're not allowed to set the flag on this request, so whatever happens happens
168		\|\|
169		isset( $args['sslverify'] ) && !$args['sslverify'] // No verification - no point in doing it again
170		\|\|
171		!is_wp_error( $response ) // Let it ride
172		) {
173		Jetpack_Client::set_time_diff( $response, $set_fallback );
174		return $response;
175		}
176
177		// At this point, we're not flagged to fallback and we are allowed to set the flag on this request.
178
179		$message = $response->get_error_message();
180
181		// Is it an SSL Certificate verification error?
182		if (
183		false === strpos( $message, '14090086' ) // OpenSSL SSL3 certificate error
184		&&
185		false === strpos( $message, '1407E086' ) // OpenSSL SSL2 certificate error
186		&&
187		false === strpos( $message, 'error setting certificate verify locations' ) // cURL CA bundle not found
188		&&
189		false === strpos( $message, 'Peer certificate cannot be authenticated with' ) // cURL CURLE_SSL_CACERT: CA bundle found, but not helpful
190		// different versions of curl have different error messages
191		// this string should catch them all
192		&&
193		false === strpos( $message, 'Problem with the SSL CA cert' ) // cURL CURLE_SSL_CACERT_BADFILE: probably access rights
194		) {
195		// No, it is not.
196		return $response;
197		}
198
199		// Redo the request without SSL certificate verification.
200		$args['sslverify'] = false;
201		$response = wp_remote_request( $url, $args );
202
203		if ( !is_wp_error( $response ) ) {
204		// The request went through this time, flag for future fallbacks
205		Jetpack_Options::update_option( 'fallback_no_verify_ssl_certs', time() );
206		Jetpack_Client::set_time_diff( $response, $set_fallback );
207		}
208
209		return $response;
210		}
211
212		public static function set_time_diff( &$response, $force_set = false ) {
213		$code = wp_remote_retrieve_response_code( $response );
214
215		// Only trust the Date header on some responses
216		if ( 200 != $code && 304 != $code && 400 != $code && 401 != $code ) {
217		return;
218		}
219
220		if ( !$date = wp_remote_retrieve_header( $response, 'date' ) ) {
221		return;
222		}
223
224		if ( 0 >= $time = (int) strtotime( $date ) ) {
225		return;
226		}
227
228		$time_diff = $time - time();
229
230		if ( $force_set ) { // during register
231		Jetpack_Options::update_option( 'time_diff', $time_diff );
232		} else { // otherwise
233		$old_diff = Jetpack_Options::get_option( 'time_diff' );
234		if ( false === $old_diff \|\| abs( $time_diff - (int) $old_diff ) > 10 ) {
235		Jetpack_Options::update_option( 'time_diff', $time_diff );
236		}
237		}
238		}
239
240		/**
241		* Query the WordPress.com REST API using the blog token
242		*
243		* @param string $path
244		* @param string $version
245		* @param array $args
246		* @param string $body
		0 ignored issues – show Documentation introduced 2015-11-20 23:03 UTC by Report Bug Copy Issue Report Show Similar Issues like this Should the type for parameter `$body` not be `string\|null`? This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
247		* @return array\|WP_Error $response Data.
248		*/
249		static function wpcom_json_api_request_as_blog( $path, $version = self::WPCOM_JSON_API_VERSION, $args = array(), $body = null ) {
250		$filtered_args = array_intersect_key( $args, array(
251		'method' => 'string',
252		'timeout' => 'int',
253		'redirection' => 'int',
254		) );
255
256		/**
257		* Determines whether Jetpack can send outbound https requests to the WPCOM api.
258		*
259		* @since 3.6.0
260		*
261		* @param bool $proto Defaults to true.
262		*/
263		$proto = apply_filters( 'jetpack_can_make_outbound_https', true ) ? 'https' : 'http';
264
265		// unprecedingslashit
266		$_path = preg_replace( '/^\//', '', $path );
267
268		// Use GET by default whereas `remote_request` uses POST
269		if ( isset( $filtered_args['method'] ) && strtoupper( $filtered_args['method'] === 'POST' ) ) {
270		$request_method = 'POST';
271		} else {
272		$request_method = 'GET';
273		}
274
275		$validated_args = array_merge( $filtered_args, array(
276		'url' => sprintf( '%s://%s/rest/v%s/%s', $proto, self::WPCOM_JSON_API_HOST, $version, $_path ),
277		'blog_id' => (int) Jetpack_Options::get_option( 'id' ),
278		'method' => $request_method,
279		) );
280
281		return Jetpack_Client::remote_request( $validated_args, $body );
282		}
283
284		}
285

Automattic / jetpack

Push — add/rest-api-sandbox-const ( f30538 )

class.jetpack-client.php (3 issues)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like