npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@basis-theory/shopify-js

v1.0.1

Published

Basis Theory utility for decrypting Shopify Payment App Session payload

Downloads

80

Readme

Basis Theory Shopify JS

Version GitHub Workflow Status (with event) License

Utility library for decrypting Shopify Payment App credit card payload.

Features

  • Shopify Payment App decryption: Securely decrypt user payment method (credit card) data using easy-to-interact interfaces.
  • Private Key rotation: Map your decryption keys by certificate fingerprint for easy rotation.

Shopify Payment App Setup

Follow the steps in Shopify Payments App documentation to create a Payments App and Credit Card Payments App Extension.

Installation

Install the package using NPM:

npm install @basis-theory/shopify-js --save

Or Yarn:

yarn add @basis-theory/shopify-js

Usage

The credit card payment app extension requires a Payment Session URL, where the Payment Session payload is posted to, containing encrypted credit card data.

The examples below show how to load the private key from the File System into a Buffer, using samples from this repository. But you can load them from you KMS, secret manager, configuration, etc.

⚠️ Decrypting the Shopify Payment Session payload must be done in a PCI DSS compliant environment.

If you need help understanding the risks associated with decrypting and manipulating the various forms of cardholder data in your own systems, reach out to us.

import { ShopifyPaymentSessionContext } from '@basis-theory/shopify-js';
import * as fs from 'fs';
import paymentSession from './test/fixtures/paymentSession.json';

// load private key into buffer
const privateKeyPem = fs.readFileSync(
  './test/fixtures/certificates/private_key.pem'
);

// create decryption context
const context = new ShopifyPaymentSessionContext({
  privateKeyPem,
});

// decrypt the payment method
console.log(context.decrypt(paymentSession.payment_method));

Or using key rotation:

import { ShopifyPaymentSessionContext } from '@basis-theory/shopify-js';
import * as fs from 'fs';
import paymentSession from './test/fixtures/paymentSession.json';

// load private keys into buffer
const privateKeyPemA = fs.readFileSync(
  './test/fixtures/certificates/private_key_a.pem'
);
const privateKeyPemB = fs.readFileSync(
  './test/fixtures/certificates/private_key_b.pem'
);

// create decryption context
const context = new ShopifyPaymentSessionContext({
  privateKeyPem: {
    // get the certificate fingerprint in Shopify payment app certificates dashboard
    '23f3812e093737252e98d47aa790ba5e607188837ec9aea797c0dde8ed7ef674':
      privateKeyPemA,
    '84d14a26c7d80e4975ed646f8ba8484a5ee8de970a04f1cf61b775aa7cbdc9cf':
      privateKeyPemB,
  },
});

// decrypt the payment method
console.log(context.decrypt(paymentSession.payment_method));

Reactors

This package is available to use in Reactors context. This enables you to perform decryption and tokenization of the credit card data in an outsourced cardholder data environment hosted by Basis Theory.

Contact us to understand how to set up Proxy with mTLS support to listen to Shopify Payment Session request and decrypt it at an isolated environment.

Proxy Request Transform code example:

const { ShopifyPaymentSessionContext } = require('@basis-theory/shopify-js');

module.exports = async function (req) {
  const {
    bt,
    args: {
      headers,
      body: { payment_method, ...body },
    },
    configuration: { PRIVATE_KEY_A, PRIVATE_KEY_B },
  } = req;

  const context = new ShopifyPaymentSessionContext({
    privateKeyPem: {
      // get the certificate fingerprint in Shopify payment app certificates dashboard
      '23f3812e093737252e98d47aa790ba5e607188837ec9aea797c0dde8ed7ef674':
        PRIVATE_KEY_A,
      '84d14a26c7d80e4975ed646f8ba8484a5ee8de970a04f1cf61b775aa7cbdc9cf':
        PRIVATE_KEY_B,
    },
  });

  const {
    data: { full_name, pan, month, year, verification_value },
  } = context.decrypt(payment_method);

  const token = await bt.tokens.create({
    type: 'card',
    data: {
      number: pan,
      expiration_month: month,
      expiration_year: year,
      cvc: verification_value,
    },
  });

  return {
    headers,
    body: {
      ...body,
      payment_method: token,
    },
  };
};