Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Recommending using Stripe restricted keys #3151

Merged
merged 2 commits into from
Oct 2, 2024
Merged

Recommending using Stripe restricted keys #3151

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
38f34a4
Reccomending using Stripe restricted keys
dparker1005 Oct 1, 2024
87f50cb
Update classes/gateways/class.pmprogateway_stripe.php
dparker1005 Oct 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion adminpages/wizard/save-steps.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ function pmpro_init_save_wizard_data() {

// If Stripe is not already set up, and the user wants to use Stripe, then redirect them to Stripe Connect.
$environment = apply_filters( 'pmpro_wizard_stripe_environment', 'live' );
if ( ! empty( $_REQUEST['gateway'] ) && 'stripe' === sanitize_text_field( $_REQUEST['gateway'] ) && ! PMProGateway_Stripe::has_connect_credentials( $environment ) && ! PMProGateway_Stripe::using_legacy_keys() ) {
if ( ! empty( $_REQUEST['gateway'] ) && 'stripe' === sanitize_text_field( $_REQUEST['gateway'] ) && ! PMProGateway_Stripe::has_connect_credentials( $environment ) && ! PMProGateway_Stripe::using_api_keys() ) {
$connect_url_base = apply_filters( 'pmpro_stripe_connect_url', 'https://connect.paidmembershipspro.com' );
$connect_url = add_query_arg(
array(
Expand Down
6 changes: 6 additions & 0 deletions classes/class-pmpro-site-health.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -244,13 +244,19 @@ public function get_gateway() {
$stripe = new PMProGateway_stripe();

$legacy = $stripe->using_legacy_keys();
$api = $stripe->using_api_keys();
$connect = $stripe->has_connect_credentials();

if ( $legacy ) {
$gateway_text .= ' (' . __( 'Legacy Keys', 'paid-memberships-pro' ) . ')';
return $gateway_text . ' [' . $gateway . ':legacy-keys]';
}

if ( $api ) {
$gateway_text .= ' (' . __( 'API Keys', ' paid-memberships-pro' ) . ')';
return $gateway_text . ' [' . $gateway . ':api-keys ]';
}

if ( $connect ) {
$gateway_text .= ' (' . __( 'Stripe Connect', 'paid-memberships-pro' ) . ')';
return $gateway_text . ' [' . $gateway . ':stripe-connect]';
Expand Down
7 changes: 6 additions & 1 deletion classes/class-pmpro-wisdom-integration.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -392,6 +392,7 @@ public function get_gateway_info() {

// Get Stripe gateway info for other stats below.
$stripe_using_legacy_keys = PMProGateway_stripe::using_legacy_keys();
$stripe_using_api_keys = PMProGateway_stripe::using_api_keys();
$stripe_has_connect_credentials = PMProGateway_stripe::has_connect_credentials( 'live' ) || PMProGateway_stripe::has_connect_credentials( 'sandbox' );

// Append the Stripe gateway qualifiers.
Expand All @@ -401,6 +402,10 @@ public function get_gateway_info() {
$stats['pmpro_gateway'] .= ' (' . __( 'Legacy Keys', 'paid-memberships-pro' ) . ')';
}

if ( $stripe_using_api_keys ) {
$stats['pmpro_gateway'] .= ' (' . __( 'API Keys', 'paid-memberships-pro' ) . ')';
}

// Add Stripe Connect text if using Stripe Connect.
if ( $stripe_has_connect_credentials ) {
$stats['pmpro_gateway'] .= ' (' . __( 'Stripe Connect', 'paid-memberships-pro' ) . ')';
Expand All @@ -418,7 +423,7 @@ public function get_gateway_info() {
'paypal' => get_option( 'pmpro_apiusername' ),
'paypalexpress' => get_option( 'paypalexpress_skip_confirmation' ),
'paypalstandard' => get_option( 'gateway_email' ),
'stripe' => $stripe_using_legacy_keys || $stripe_has_connect_credentials,
'stripe' => $stripe_using_legacy_keys || $stripe_using_api_keys || $stripe_has_connect_credentials,
'stripe_sandbox' => get_option( 'sandbox_stripe_connect_user_id' ),
'twocheckout' => get_option( 'twocheckout_accountnumber' ),
];
Expand Down
68 changes: 37 additions & 31 deletions classes/gateways/class.pmprogateway_stripe.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -308,11 +308,11 @@ public static function pmpro_payment_option_fields( $values, $gateway ) {
<tr class="pmpro_settings_divider gateway gateway_stripe" <?php if ( $gateway != "stripe" ) { ?>style="display: none;"<?php } ?>>
<td colspan="2">
<hr />
<h2 class="pmpro_stripe_legacy_keys" <?php if( ! $stripe->show_legacy_keys_settings() ) {?>style="display: none;"<?php }?>><?php esc_html_e( 'Stripe API Settings (Legacy)', 'paid-memberships-pro' ); ?></h2>
<h2 class="pmpro_stripe_legacy_keys" <?php if( ! $stripe->show_legacy_keys_settings() ) {?>style="display: none;"<?php }?>><?php esc_html_e( 'Stripe API Settings', 'paid-memberships-pro' ); ?></h2>
<?php if( ! $stripe->show_legacy_keys_settings() ) {?>
<p>
<?php esc_html_e( 'Having trouble connecting through the button above or otherwise need to use your own API keys?', 'paid-memberships-pro' );?>
<a id="pmpro_stripe_legacy_keys_toggle" href="javascript:void(0);"><?php esc_html_e( 'Click here to use the legacy API settings.', 'paid-memberships-pro' );?></a>
<a id="pmpro_stripe_legacy_keys_toggle" href="javascript:void(0);"><?php esc_html_e( 'Click here to connect via API settings.', 'paid-memberships-pro' );?></a>
</p>
<script>
// Toggle to show the Stripe legacy keys settings.
Expand Down Expand Up @@ -591,10 +591,6 @@ public static function pmpro_payment_option_fields( $values, $gateway ) {
);
if ( empty($_SERVER['HTTPS']) || $_SERVER['HTTPS'] === "off" ) {
$payment_request_error_escaped = sprintf( wp_kses( __( 'This webpage is being served over HTTP, but the Stripe Payment Request Button will only work on pages being served over HTTPS. To resolve this, you must <a target="_blank" href="%s" title="Configuring WordPress to Always Use HTTPS/SSL">set up WordPress to always use HTTPS</a>.', 'paid-memberships-pro' ), $allowed_payment_request_error_html ), 'https://www.paidmembershipspro.com/configuring-wordpress-always-use-httpsssl/?utm_source=plugin&utm_medium=pmpro-paymentsettings&utm_campaign=blog&utm_content=configure-https' );
} elseif ( self::using_legacy_keys() && substr( $values['stripe_publishablekey'], 0, 8 ) !== "pk_live_" && substr( $values['stripe_publishablekey'], 0, 8 ) !== "pk_test_" ) {
$payment_request_error_escaped = sprintf( wp_kses( __( 'It looks like you are using an older Stripe publishable key. In order to use the Payment Request Button feature, you will need to update your API key, which will be prefixed with "pk_live_" or "pk_test_". <a target="_blank" href="%s" title="Stripe Dashboard API Key Settings">Log in to your Stripe Dashboard to roll your publishable key</a>.', 'paid-memberships-pro' ), $allowed_payment_request_error_html ), 'https://dashboard.stripe.com/account/apikeys' );
} elseif ( self::using_legacy_keys() && substr( $values['stripe_secretkey'], 0, 8 ) !== "sk_live_" && substr( $values['stripe_secretkey'], 0, 8 ) !== "sk_test_" ) {
$payment_request_error_escaped = sprintf( wp_kses( __( 'It looks like you are using an older Stripe secret key. In order to use the Payment Request Button feature, you will need to update your API key, which will be prefixed with "sk_live_" or "sk_test_". <a target="_blank" href="%s" title="Stripe Dashboard API Key Settings">Log in to your Stripe Dashboard to roll your secret key</a>.', 'paid-memberships-pro' ), $allowed_payment_request_error_html ), 'https://dashboard.stripe.com/account/apikeys' );
} elseif ( ! $stripe->pmpro_does_apple_pay_domain_exist() ) {
$payment_request_error_escaped = sprintf( wp_kses( __( 'Your domain could not be registered with Apple to enable Apple Pay. Please try <a target="_blank" href="%s" title="Apple Pay Settings Page in Stripe">registering your domain manually from the Apple Pay settings page in Stripe</a>.', 'paid-memberships-pro' ), $allowed_payment_request_error_html ), 'https://dashboard.stripe.com/settings/payments/apple_pay' );
}
Expand Down Expand Up @@ -1385,6 +1381,24 @@ public static function show_set_up_webhooks_popup() {
* @return bool Whether the site is using legacy Stripe keys.
*/
public static function using_legacy_keys() {
// If the site is not using API keys, it is not using legacy keys.
if ( ! self::using_api_keys() ) {
return false;
}

// Get the secret key being used.
$secret_key = get_option( 'pmpro_stripe_secretkey' );

// If the key begins with "sk_", it is a legacy key.
return strpos( $secret_key, 'sk_' ) === 0;
}

/**
* Determine whether the site is using API keys to authenticate with Stripe.
*
* @return bool Whether the site is using API keys to authenticate with Stripe.
*/
public static function using_api_keys() {
$r = ! empty( get_option( 'pmpro_stripe_secretkey' ) ) && ! empty( get_option( 'pmpro_stripe_publishablekey' ) );
return $r;
}
Expand Down Expand Up @@ -2261,15 +2275,11 @@ public function get_customer_portal_url( $customer_id ) {
private function show_connect_payment_option_fields( $livemode, $values, $gateway ) {
$gateway_environment = $this->gateway_environment;

$stripe_legacy_key = $values['stripe_publishablekey'];
$stripe_legacy_secret = $values['stripe_secretkey'];
$stripe_is_legacy_setup = ( self::using_legacy_keys() && ! empty( $stripe_legacy_key ) && ! empty( $stripe_legacy_secret ) );

$environment = $livemode ? 'live' : 'sandbox';
$environment2 = $livemode ? 'live' : 'test'; // For when 'test' is used instead of 'sandbox'.

// Determine if the gateway is connected in live mode and set var.
if ( self::has_connect_credentials( $environment ) || $stripe_is_legacy_setup ) {
if ( self::has_connect_credentials( $environment ) || self::using_api_keys() ) {
$connection_selector = 'pmpro_gateway-mode-connected';
} else {
$connection_selector = 'pmpro_gateway-mode-not-connected';
Expand All @@ -2285,8 +2295,10 @@ private function show_connect_payment_option_fields( $livemode, $values, $gatewa
<span class="pmpro_gateway-mode pmpro_gateway-mode-<?php echo esc_attr( $environment2 ); ?> <?php echo esc_attr( $connection_selector ); ?>">
<?php
echo ( $livemode ? esc_html__( 'Live Mode:', 'paid-memberships-pro' ) : esc_html__( 'Test Mode:', 'paid-memberships-pro' ) ) . ' ';
if ( $stripe_is_legacy_setup ) {
if ( self::using_legacy_keys() ) {
esc_html_e( 'Connected with Legacy Keys', 'paid-memberships-pro' );
} elseif ( self::using_api_keys() ) {
esc_html_e( 'Connected with API Keys', 'paid-memberships-pro' );
} elseif( self::has_connect_credentials( $environment ) ) {
esc_html_e( 'Connected', 'paid-memberships-pro' );
} else {
Expand All @@ -2299,22 +2311,15 @@ private function show_connect_payment_option_fields( $livemode, $values, $gatewa
<div class="notice notice-large notice-warning inline">
<p class="pmpro_stripe_webhook_notice">
<strong><?php esc_html_e( 'Your site is using legacy API keys to authenticate with Stripe.', 'paid-memberships-pro' ); ?></strong><br />
<?php esc_html_e( 'You can continue to use the legacy API keys or choose to upgrade to our new Stripe Connect solution below.', 'paid-memberships-pro' ); ?><br />
<?php
if ( $livemode ) {
esc_html_e( 'Use the "Connect with Stripe" button below to securely authenticate with your Stripe account using Stripe Connect. Log in with the current Stripe account used for this site so that existing subscriptions are not affected by the update.', 'paid-memberships-pro' );
} else {
esc_html_e( 'Use the "Connect with Stripe" button below to securely authenticate with your Stripe account using Stripe Connect in test mode.', 'paid-memberships-pro' );
}
?>
<?php esc_html_e( 'Legacy API keys will eventually no longer be supported. To continue processing payments with Stripe, you may connect via Stripe Connect below or connect using a restricted API key.', 'paid-memberships-pro' ); ?><br />
dparker1005 marked this conversation as resolved.
Show resolved Hide resolved
<a href="https://www.paidmembershipspro.com/gateway/stripe/switch-legacy-to-connect/?utm_source=plugin&utm_medium=pmpro-paymentsettings&utm_campaign=documentation&utm_content=switch-to-connect" target="_blank"><?php esc_html_e( 'Read the documentation on switching to Stripe Connect', 'paid-memberships-pro' ); ?></a>
</p>
</div>
<?php } elseif ( self::using_legacy_keys() ) { ?>
<?php } elseif ( self::using_api_keys() && self::has_connect_credentials( $environment ) ) { ?>
<div class="notice notice-large notice-warning inline">
<p class="pmpro_stripe_webhook_notice">
<strong><?php esc_html_e( 'Your site is using legacy API keys to authenticate with Stripe.', 'paid-memberships-pro' ); ?></strong><br />
<?php esc_html_e( 'In order to complete the transition to using Stripe legacy API keys, please click the "Disconnect from Stripe" button below.', 'paid-memberships-pro' ); ?><br />
<strong><?php esc_html_e( 'Your site is using API keys to authenticate with Stripe.', 'paid-memberships-pro' ); ?></strong><br />
<?php esc_html_e( 'In order to complete the transition to using Stripe API keys, please click the "Disconnect from Stripe" button below.', 'paid-memberships-pro' ); ?><br />
</p>
</div>
<?php } ?>
Expand Down Expand Up @@ -2930,7 +2935,7 @@ private function create_subscription_for_customer_from_order( $customer_id, $ord
'pending_setup_intent.payment_method',
),
);
if ( ! self::using_legacy_keys() ) {
if ( ! self::using_api_keys() ) {
$params['application_fee_percent'] = $this->get_application_fee_percentage();
}
$subscription_params = apply_filters( 'pmpro_stripe_create_subscription_array', $subscription_params );
Expand Down Expand Up @@ -3590,7 +3595,7 @@ private function get_account_country() {
* @return int percentage to charge for application fee.
*/
private function get_application_fee_percentage() {
if ( self::using_legacy_keys() ) {
if ( self::using_api_keys() ) {
return 0;
}

Expand Down Expand Up @@ -3629,7 +3634,7 @@ private function get_application_fee_percentage() {
* @return array params with application fee if applicable.
*/
private function add_application_fee_amount( $params ) {
if ( empty( $params['amount'] ) || self::using_legacy_keys() ) {
if ( empty( $params['amount'] ) || self::using_api_keys() ) {
return $params;
}
$amount = $params['amount'];
Expand All @@ -3648,9 +3653,10 @@ private function add_application_fee_amount( $params ) {
* @since 2.6
* @since 2.7 Deprecated for public use.
* @since 3.0 Updated to private non-static.
* @since 3.2 This now controls showing all API key settings, not just legacy keys.
*/
private function show_legacy_keys_settings() {
$r = self::using_legacy_keys();
$r = self::using_api_keys();
$r = apply_filters( 'pmpro_stripe_show_legacy_keys_settings', $r );
return $r;
}
Expand All @@ -3665,7 +3671,7 @@ private function show_legacy_keys_settings() {
*/
private function get_secretkey() {
$secretkey = '';
if ( self::using_legacy_keys() ) {
if ( self::using_api_keys() ) {
$secretkey = get_option( 'pmpro_stripe_secretkey' );
} else {
$secretkey = get_option( 'pmpro_gateway_environment' ) === 'live'
Expand All @@ -3685,7 +3691,7 @@ private function get_secretkey() {
*/
private function get_publishablekey() {
$publishablekey = '';
if ( self::using_legacy_keys() ) {
if ( self::using_api_keys() ) {
$publishablekey = get_option( 'pmpro_stripe_publishablekey' );
} else {
$publishablekey = get_option( 'pmpro_gateway_environment' ) === 'live'
Expand Down Expand Up @@ -3825,8 +3831,8 @@ public static function process_refund( $success, $order ) {

$secretkey = get_option( 'pmpro_stripe_secretkey' );

// If they are not using legacy keys, get Stripe Connect keys for the relevant environment.
if ( ! self::using_legacy_keys() && empty( $secretkey ) ) {
// If they are not using API keys, get Stripe Connect keys for the relevant environment.
if ( ! self::using_api_keys() && empty( $secretkey ) ) {
if ( get_option( 'pmpro_gateway_environment' ) === 'live' ) {
$secretkey = get_option( 'pmpro_live_stripe_connect_secretkey' );
} else {
Expand Down
2 changes: 1 addition & 1 deletion services/stripe-webhook.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@
}

try {
if ( PMProGateway_stripe::using_legacy_keys() ) {
if ( PMProGateway_stripe::using_api_keys() ) {
$secret_key = get_option( "pmpro_stripe_secretkey" );
} elseif ( $livemode ) {
$secret_key = get_option( 'pmpro_live_stripe_connect_secretkey' );
Expand Down