/wp-content/plugins/woocommerce/includes/api/v1/class-wc-api-authentication.php
PHP | 357 lines | 147 code | 79 blank | 131 comment | 25 complexity | 442cd1ae09a872720960577a7a5f6d3b MD5 | raw file
Possible License(s): LGPL-3.0, Apache-2.0
- <?php
- /**
- * WooCommerce API Authentication Class
- *
- * @author WooThemes
- * @category API
- * @package WooCommerce/API
- * @since 2.1
- * @version 2.1
- */
- if ( ! defined( 'ABSPATH' ) ) {
- exit; // Exit if accessed directly
- }
- class WC_API_Authentication {
- /**
- * Setup class
- *
- * @since 2.1
- * @return WC_API_Authentication
- */
- public function __construct() {
- // to disable authentication, hook into this filter at a later priority and return a valid WP_User
- add_filter( 'woocommerce_api_check_authentication', array( $this, 'authenticate' ), 0 );
- }
- /**
- * Authenticate the request. The authentication method varies based on whether the request was made over SSL or not.
- *
- * @since 2.1
- * @param WP_User $user
- * @return null|WP_Error|WP_User
- */
- public function authenticate( $user ) {
- // allow access to the index by default
- if ( '/' === WC()->api->server->path )
- return new WP_User(0);
- try {
- if ( is_ssl() )
- $user = $this->perform_ssl_authentication();
- else
- $user = $this->perform_oauth_authentication();
- // check API key-specific permission
- $this->check_api_key_permissions( $user );
- } catch ( Exception $e ) {
- $user = new WP_Error( 'woocommerce_api_authentication_error', $e->getMessage(), array( 'status' => $e->getCode() ) );
- }
- return $user;
- }
- /**
- * SSL-encrypted requests are not subject to sniffing or man-in-the-middle
- * attacks, so the request can be authenticated by simply looking up the user
- * associated with the given consumer key and confirming the consumer secret
- * provided is valid
- *
- * @since 2.1
- * @return WP_User
- * @throws Exception
- */
- private function perform_ssl_authentication() {
- $params = WC()->api->server->params['GET'];
- // get consumer key
- if ( ! empty( $_SERVER['PHP_AUTH_USER'] ) ) {
- // should be in HTTP Auth header by default
- $consumer_key = $_SERVER['PHP_AUTH_USER'];
- } elseif ( ! empty( $params['consumer_key'] ) ) {
- // allow a query string parameter as a fallback
- $consumer_key = $params['consumer_key'];
- } else {
- throw new Exception( __( 'Consumer Key is missing', 'woocommerce' ), 404 );
- }
- // get consumer secret
- if ( ! empty( $_SERVER['PHP_AUTH_PW'] ) ) {
- // should be in HTTP Auth header by default
- $consumer_secret = $_SERVER['PHP_AUTH_PW'];
- } elseif ( ! empty( $params['consumer_secret'] ) ) {
- // allow a query string parameter as a fallback
- $consumer_secret = $params['consumer_secret'];
- } else {
- throw new Exception( __( 'Consumer Secret is missing', 'woocommerce' ), 404 );
- }
- $user = $this->get_user_by_consumer_key( $consumer_key );
- if ( ! $this->is_consumer_secret_valid( $user, $consumer_secret ) ) {
- throw new Exception( __( 'Consumer Secret is invalid', 'woocommerce' ), 401 );
- }
- return $user;
- }
- /**
- * Perform OAuth 1.0a "one-legged" (http://oauthbible.com/#oauth-10a-one-legged) authentication for non-SSL requests
- *
- * This is required so API credentials cannot be sniffed or intercepted when making API requests over plain HTTP
- *
- * This follows the spec for simple OAuth 1.0a authentication (RFC 5849) as closely as possible, with two exceptions:
- *
- * 1) There is no token associated with request/responses, only consumer keys/secrets are used
- *
- * 2) The OAuth parameters are included as part of the request query string instead of part of the Authorization header,
- * This is because there is no cross-OS function within PHP to get the raw Authorization header
- *
- * @link http://tools.ietf.org/html/rfc5849 for the full spec
- * @since 2.1
- * @return WP_User
- * @throws Exception
- */
- private function perform_oauth_authentication() {
- $params = WC()->api->server->params['GET'];
- $param_names = array( 'oauth_consumer_key', 'oauth_timestamp', 'oauth_nonce', 'oauth_signature', 'oauth_signature_method' );
- // check for required OAuth parameters
- foreach ( $param_names as $param_name ) {
- if ( empty( $params[ $param_name ] ) )
- throw new Exception( sprintf( __( '%s parameter is missing', 'woocommerce' ), $param_name ), 404 );
- }
- // fetch WP user by consumer key
- $user = $this->get_user_by_consumer_key( $params['oauth_consumer_key'] );
- // perform OAuth validation
- $this->check_oauth_signature( $user, $params );
- $this->check_oauth_timestamp_and_nonce( $user, $params['oauth_timestamp'], $params['oauth_nonce'] );
- // authentication successful, return user
- return $user;
- }
- /**
- * Return the user for the given consumer key
- *
- * @since 2.1
- * @param string $consumer_key
- * @return WP_User
- * @throws Exception
- */
- private function get_user_by_consumer_key( $consumer_key ) {
- $user_query = new WP_User_Query(
- array(
- 'meta_key' => 'woocommerce_api_consumer_key',
- 'meta_value' => $consumer_key,
- )
- );
- $users = $user_query->get_results();
- if ( empty( $users[0] ) )
- throw new Exception( __( 'Consumer Key is invalid', 'woocommerce' ), 401 );
- return $users[0];
- }
- /**
- * Check if the consumer secret provided for the given user is valid
- *
- * @since 2.1
- * @param WP_User $user
- * @param string $consumer_secret
- * @return bool
- */
- private function is_consumer_secret_valid( WP_User $user, $consumer_secret ) {
- return $user->woocommerce_api_consumer_secret === $consumer_secret;
- }
- /**
- * Verify that the consumer-provided request signature matches our generated signature, this ensures the consumer
- * has a valid key/secret
- *
- * @param WP_User $user
- * @param array $params the request parameters
- * @throws Exception
- */
- private function check_oauth_signature( $user, $params ) {
- $http_method = strtoupper( WC()->api->server->method );
- $base_request_uri = rawurlencode( untrailingslashit( get_woocommerce_api_url( '' ) ) . WC()->api->server->path );
- // get the signature provided by the consumer and remove it from the parameters prior to checking the signature
- $consumer_signature = rawurldecode( $params['oauth_signature'] );
- unset( $params['oauth_signature'] );
- // remove filters and convert them from array to strings to void normalize issues
- if ( isset( $params['filter'] ) ) {
- $filters = $params['filter'];
- unset( $params['filter'] );
- foreach ( $filters as $filter => $filter_value ) {
- $params['filter[' . $filter . ']'] = $filter_value;
- }
- }
- // normalize parameter key/values
- $params = $this->normalize_parameters( $params );
- // sort parameters
- if ( ! uksort( $params, 'strcmp' ) ) {
- throw new Exception( __( 'Invalid Signature - failed to sort parameters', 'woocommerce' ), 401 );
- }
- // form query string
- $query_params = array();
- foreach ( $params as $param_key => $param_value ) {
- $query_params[] = $param_key . '%3D' . $param_value; // join with equals sign
- }
- $query_string = implode( '%26', $query_params ); // join with ampersand
- $string_to_sign = $http_method . '&' . $base_request_uri . '&' . $query_string;
- if ( $params['oauth_signature_method'] !== 'HMAC-SHA1' && $params['oauth_signature_method'] !== 'HMAC-SHA256' ) {
- throw new Exception( __( 'Invalid Signature - signature method is invalid', 'woocommerce' ), 401 );
- }
- $hash_algorithm = strtolower( str_replace( 'HMAC-', '', $params['oauth_signature_method'] ) );
- $signature = base64_encode( hash_hmac( $hash_algorithm, $string_to_sign, $user->woocommerce_api_consumer_secret, true ) );
- if ( $signature !== $consumer_signature ) {
- throw new Exception( __( 'Invalid Signature - provided signature does not match', 'woocommerce' ), 401 );
- }
- }
- /**
- * Normalize each parameter by assuming each parameter may have already been
- * encoded, so attempt to decode, and then re-encode according to RFC 3986
- *
- * Note both the key and value is normalized so a filter param like:
- *
- * 'filter[period]' => 'week'
- *
- * is encoded to:
- *
- * 'filter%5Bperiod%5D' => 'week'
- *
- * This conforms to the OAuth 1.0a spec which indicates the entire query string
- * should be URL encoded
- *
- * @since 2.1
- * @see rawurlencode()
- * @param array $parameters un-normalized pararmeters
- * @return array normalized parameters
- */
- private function normalize_parameters( $parameters ) {
- $normalized_parameters = array();
- foreach ( $parameters as $key => $value ) {
- // percent symbols (%) must be double-encoded
- $key = str_replace( '%', '%25', rawurlencode( rawurldecode( $key ) ) );
- $value = str_replace( '%', '%25', rawurlencode( rawurldecode( $value ) ) );
- $normalized_parameters[ $key ] = $value;
- }
- return $normalized_parameters;
- }
- /**
- * Verify that the timestamp and nonce provided with the request are valid. This prevents replay attacks where
- * an attacker could attempt to re-send an intercepted request at a later time.
- *
- * - A timestamp is valid if it is within 15 minutes of now
- * - A nonce is valid if it has not been used within the last 15 minutes
- *
- * @param WP_User $user
- * @param int $timestamp the unix timestamp for when the request was made
- * @param string $nonce a unique (for the given user) 32 alphanumeric string, consumer-generated
- * @throws Exception
- */
- private function check_oauth_timestamp_and_nonce( $user, $timestamp, $nonce ) {
- $valid_window = 15 * 60; // 15 minute window
- if ( ( $timestamp < time() - $valid_window ) || ( $timestamp > time() + $valid_window ) )
- throw new Exception( __( 'Invalid timestamp', 'woocommerce' ) );
- $used_nonces = $user->woocommerce_api_nonces;
- if ( empty( $used_nonces ) )
- $used_nonces = array();
- if ( in_array( $nonce, $used_nonces ) )
- throw new Exception( __( 'Invalid nonce - nonce has already been used', 'woocommerce' ), 401 );
- $used_nonces[ $timestamp ] = $nonce;
- // remove expired nonces
- foreach( $used_nonces as $nonce_timestamp => $nonce ) {
- if ( $nonce_timestamp < ( time() - $valid_window ) )
- unset( $used_nonces[ $nonce_timestamp ] );
- }
- update_user_meta( $user->ID, 'woocommerce_api_nonces', $used_nonces );
- }
- /**
- * Check that the API keys provided have the proper key-specific permissions to either read or write API resources
- *
- * @param WP_User $user
- * @throws Exception if the permission check fails
- */
- public function check_api_key_permissions( $user ) {
- $key_permissions = $user->woocommerce_api_key_permissions;
- switch ( WC()->api->server->method ) {
- case 'HEAD':
- case 'GET':
- if ( 'read' !== $key_permissions && 'read_write' !== $key_permissions ) {
- throw new Exception( __( 'The API key provided does not have read permissions', 'woocommerce' ), 401 );
- }
- break;
- case 'POST':
- case 'PUT':
- case 'PATCH':
- case 'DELETE':
- if ( 'write' !== $key_permissions && 'read_write' !== $key_permissions ) {
- throw new Exception( __( 'The API key provided does not have write permissions', 'woocommerce' ), 401 );
- }
- break;
- }
- }
- }