@shopify/shopify-api 7.1.0 → 7.3.0

package/lib/webhooks/validate.js

@@ -0,0 +1,86 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateFactory = void 0;
+const tslib_1 = require("tslib");
+const http_1 = require("../../runtime/http");
+const crypto_1 = require("../../runtime/crypto");
+const types_1 = require("../../runtime/crypto/types");
+const types_2 = require("../types");
+const safe_compare_1 = require("../auth/oauth/safe-compare");
+const logger_1 = require("../logger");
+const types_3 = require("./types");
+const registry_1 = require("./registry");
+const HANDLER_PROPERTIES = {
+    apiVersion: types_2.ShopifyHeader.ApiVersion,
+    domain: types_2.ShopifyHeader.Domain,
+    hmac: types_2.ShopifyHeader.Hmac,
+    topic: types_2.ShopifyHeader.Topic,
+    webhookId: types_2.ShopifyHeader.WebhookId,
+};
+function validateFactory(config) {
+    return function validate(_a) {
+        var { rawBody } = _a, adapterArgs = tslib_1.__rest(_a, ["rawBody"]);
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            const request = yield (0, http_1.abstractConvertRequest)(adapterArgs);
+            const log = (0, logger_1.logger)(config);
+            const webhookCheck = checkWebhookRequest(rawBody, request.headers);
+            if (!webhookCheck.valid) {
+                yield log.debug('Received malformed webhook request', webhookCheck);
+                return webhookCheck;
+            }
+            const { hmac, valid: _valid } = webhookCheck, loggingContext = tslib_1.__rest(webhookCheck, ["hmac", "valid"]);
+            yield log.debug('Webhook request is well formed', loggingContext);
+            if (yield checkWebhookHmac(config.apiSecretKey, rawBody, hmac)) {
+                yield log.debug('Webhook request is valid', loggingContext);
+                return webhookCheck;
+            }
+            else {
+                yield log.debug('Webhook validation failed', loggingContext);
+                if (config.isCustomStoreApp) {
+                    log.deprecated('8.0.0', "apiSecretKey should be set to the custom store app's API secret key, so that webhook validation succeeds. adminApiAccessToken should be set to the custom store app's Admin API access token");
+                }
+                return {
+                    valid: false,
+                    reason: types_3.WebhookValidationErrorReason.InvalidHmac,
+                };
+            }
+        });
+    };
+}
+exports.validateFactory = validateFactory;
+function checkWebhookRequest(rawBody, headers) {
+    if (!rawBody.length) {
+        return {
+            valid: false,
+            reason: types_3.WebhookValidationErrorReason.MissingBody,
+        };
+    }
+    const missingHeaders = [];
+    const headerValues = Object.entries(HANDLER_PROPERTIES).reduce((acc, [property, headerName]) => {
+        const headerValue = (0, http_1.getHeader)(headers, headerName);
+        if (headerValue) {
+            acc[property] = headerValue;
+        }
+        else {
+            missingHeaders.push(headerName);
+        }
+        return acc;
+    }, {});
+    if (missingHeaders.length) {
+        return {
+            valid: false,
+            reason: types_3.WebhookValidationErrorReason.MissingHeaders,
+            missingHeaders,
+        };
+    }
+    else {
+        return Object.assign(Object.assign({ valid: true }, headerValues), { topic: (0, registry_1.topicForStorage)(headerValues.topic) });
+    }
+}
+function checkWebhookHmac(secret, rawBody, hmac) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        const generatedHash = yield (0, crypto_1.createSHA256HMAC)(secret, rawBody, types_1.HashFormat.Base64);
+        return (0, safe_compare_1.safeCompare)(generatedHash, hmac);
+    });
+}
+//# sourceMappingURL=validate.js.map

package/lib/webhooks/validate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate.js","sourceRoot":"","sources":["validate.ts"],"names":[],"mappings":";;;;AAAA,6CAK4B;AAC5B,iDAAsD;AACtD,sDAAsD;AACtD,oCAAuC;AAEvC,6DAAuD;AACvD,sCAAiC;AAEjC,mCAKiB;AACjB,yCAA2C;AAE3C,MAAM,kBAAkB,GAEpB;IACF,UAAU,EAAE,qBAAa,CAAC,UAAU;IACpC,MAAM,EAAE,qBAAa,CAAC,MAAM;IAC5B,IAAI,EAAE,qBAAa,CAAC,IAAI;IACxB,KAAK,EAAE,qBAAa,CAAC,KAAK;IAC1B,SAAS,EAAE,qBAAa,CAAC,SAAS;CACnC,CAAC;AAEF,SAAgB,eAAe,CAAC,MAAuB;IACrD,OAAO,SAAe,QAAQ,CAAC,EAGP;YAHO,EAC7B,OAAO,OAEe,EADnB,WAAW,sBAFe,WAG9B,CADe;;YAEd,MAAM,OAAO,GAAsB,MAAM,IAAA,6BAAsB,EAC7D,WAAW,CACZ,CAAC;YAEF,MAAM,GAAG,GAAG,IAAA,eAAM,EAAC,MAAM,CAAC,CAAC;YAE3B,MAAM,YAAY,GAAG,mBAAmB,CAAC,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;YACnE,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE;gBACvB,MAAM,GAAG,CAAC,KAAK,CAAC,oCAAoC,EAAE,YAAY,CAAC,CAAC;gBACpE,OAAO,YAAY,CAAC;aACrB;YAED,MAAM,EAAC,IAAI,EAAE,KAAK,EAAE,MAAM,KAAuB,YAAY,EAA9B,cAAc,kBAAI,YAAY,EAAvD,iBAAwC,CAAe,CAAC;YAC9D,MAAM,GAAG,CAAC,KAAK,CAAC,gCAAgC,EAAE,cAAc,CAAC,CAAC;YAElE,IAAI,MAAM,gBAAgB,CAAC,MAAM,CAAC,YAAY,EAAE,OAAO,EAAE,IAAI,CAAC,EAAE;gBAC9D,MAAM,GAAG,CAAC,KAAK,CAAC,0BAA0B,EAAE,cAAc,CAAC,CAAC;gBAC5D,OAAO,YAAY,CAAC;aACrB;iBAAM;gBACL,MAAM,GAAG,CAAC,KAAK,CAAC,2BAA2B,EAAE,cAAc,CAAC,CAAC;gBAC7D,IAAI,MAAM,CAAC,gBAAgB,EAAE;oBAC3B,GAAG,CAAC,UAAU,CACZ,OAAO,EACP,8LAA8L,CAC/L,CAAC;iBACH;gBACD,OAAO;oBACL,KAAK,EAAE,KAAK;oBACZ,MAAM,EAAE,oCAA4B,CAAC,WAAW;iBACjD,CAAC;aACH;;KACF,CAAC;AACJ,CAAC;AArCD,0CAqCC;AAED,SAAS,mBAAmB,CAC1B,OAAe,EACf,OAAgB;IAEhB,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE;QACnB,OAAO;YACL,KAAK,EAAE,KAAK;YACZ,MAAM,EAAE,oCAA4B,CAAC,WAAW;SACjD,CAAC;KACH;IAED,MAAM,cAAc,GAAoB,EAAE,CAAC;IAC3C,MAAM,YAAY,GAAkB,MAAM,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC,MAAM,CAC3E,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,UAAU,CAAuC,EAAE,EAAE;QACpE,MAAM,WAAW,GAAG,IAAA,gBAAS,EAAC,OAAO,EAAE,UAAU,CAAC,CAAC;QACnD,IAAI,WAAW,EAAE;YACf,GAAG,CAAC,QAAQ,CAAC,GAAG,WAAW,CAAC;SAC7B;aAAM;YACL,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;SACjC;QAED,OAAO,GAAG,CAAC;IACb,CAAC,EACD,EAAmB,CACpB,CAAC;IAEF,IAAI,cAAc,CAAC,MAAM,EAAE;QACzB,OAAO;YACL,KAAK,EAAE,KAAK;YACZ,MAAM,EAAE,oCAA4B,CAAC,cAAc;YACnD,cAAc;SACf,CAAC;KACH;SAAM;QACL,qCACE,KAAK,EAAE,IAAI,IACR,YAAY,KACf,KAAK,EAAE,IAAA,0BAAe,EAAC,YAAY,CAAC,KAAK,CAAC,IAC1C;KACH;AACH,CAAC;AAED,SAAe,gBAAgB,CAC7B,MAAc,EACd,OAAe,EACf,IAAY;;QAEZ,MAAM,aAAa,GAAG,MAAM,IAAA,yBAAgB,EAC1C,MAAM,EACN,OAAO,EACP,kBAAU,CAAC,MAAM,CAClB,CAAC;QAEF,OAAO,IAAA,0BAAW,EAAC,aAAa,EAAE,IAAI,CAAC,CAAC;IAC1C,CAAC;CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shopify/shopify-api",
-  "version": "7.1.0",
+  "version": "7.3.0",
   "description": "Shopify API Library for Node - accelerate development with support for authentication, graphql proxy, webhooks",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",