@mui/x-license 7.0.0-beta.2

package/verifyLicense/verifyLicense.js

@@ -0,0 +1,159 @@
+import { base64Decode, base64Encode } from '../encoding/base64';
+import { md5 } from '../encoding/md5';
+import { LICENSE_STATUS } from '../utils/licenseStatus';
+import { LICENSE_SCOPES } from '../utils/licenseScope';
+import { LICENSING_MODELS } from '../utils/licensingModel';
+const getDefaultReleaseDate = () => {
+  const today = new Date();
+  today.setHours(0, 0, 0, 0);
+  return today;
+};
+export function generateReleaseInfo(releaseDate = getDefaultReleaseDate()) {
+  return base64Encode(releaseDate.getTime().toString());
+}
+const expiryReg = /^.*EXPIRY=([0-9]+),.*$/;
+/**
+ * Format: ORDER:${orderNumber},EXPIRY=${expiryTimestamp},KEYVERSION=1
+ */
+const decodeLicenseVersion1 = license => {
+  let expiryTimestamp;
+  try {
+    expiryTimestamp = parseInt(license.match(expiryReg)[1], 10);
+    if (!expiryTimestamp || Number.isNaN(expiryTimestamp)) {
+      expiryTimestamp = null;
+    }
+  } catch (err) {
+    expiryTimestamp = null;
+  }
+  return {
+    scope: 'pro',
+    licensingModel: 'perpetual',
+    expiryTimestamp
+  };
+};
+
+/**
+ * Format: O=${orderNumber},E=${expiryTimestamp},S=${scope},LM=${licensingModel},KV=2`;
+ */
+const decodeLicenseVersion2 = license => {
+  const licenseInfo = {
+    scope: null,
+    licensingModel: null,
+    expiryTimestamp: null
+  };
+  license.split(',').map(token => token.split('=')).filter(el => el.length === 2).forEach(([key, value]) => {
+    if (key === 'S') {
+      licenseInfo.scope = value;
+    }
+    if (key === 'LM') {
+      licenseInfo.licensingModel = value;
+    }
+    if (key === 'E') {
+      const expiryTimestamp = parseInt(value, 10);
+      if (expiryTimestamp && !Number.isNaN(expiryTimestamp)) {
+        licenseInfo.expiryTimestamp = expiryTimestamp;
+      }
+    }
+  });
+  return licenseInfo;
+};
+
+/**
+ * Decode the license based on its key version and return a version-agnostic `MuiLicense` object.
+ */
+const decodeLicense = encodedLicense => {
+  const license = base64Decode(encodedLicense);
+  if (license.includes('KEYVERSION=1')) {
+    return decodeLicenseVersion1(license);
+  }
+  if (license.includes('KV=2')) {
+    return decodeLicenseVersion2(license);
+  }
+  return null;
+};
+export function verifyLicense({
+  releaseInfo,
+  licenseKey,
+  acceptedScopes
+}) {
+  if (!releaseInfo) {
+    throw new Error('MUI X: The release information is missing. Not able to validate license.');
+  }
+  if (!licenseKey) {
+    return {
+      status: LICENSE_STATUS.NotFound
+    };
+  }
+  const hash = licenseKey.substr(0, 32);
+  const encoded = licenseKey.substr(32);
+  if (hash !== md5(encoded)) {
+    return {
+      status: LICENSE_STATUS.Invalid
+    };
+  }
+  const license = decodeLicense(encoded);
+  if (license == null) {
+    console.error('MUI X: Error checking license. Key version not found!');
+    return {
+      status: LICENSE_STATUS.Invalid
+    };
+  }
+  if (license.licensingModel == null || !LICENSING_MODELS.includes(license.licensingModel)) {
+    console.error('MUI X: Error checking license. Licensing model not found or invalid!');
+    return {
+      status: LICENSE_STATUS.Invalid
+    };
+  }
+  if (license.expiryTimestamp == null) {
+    console.error('MUI X: Error checking license. Expiry timestamp not found or invalid!');
+    return {
+      status: LICENSE_STATUS.Invalid
+    };
+  }
+  if (license.licensingModel === 'perpetual' || process.env.NODE_ENV === 'production') {
+    const pkgTimestamp = parseInt(base64Decode(releaseInfo), 10);
+    if (Number.isNaN(pkgTimestamp)) {
+      throw new Error('MUI X: The release information is invalid. Not able to validate license.');
+    }
+    if (license.expiryTimestamp < pkgTimestamp) {
+      return {
+        status: LICENSE_STATUS.ExpiredVersion
+      };
+    }
+  } else if (license.licensingModel === 'subscription' || license.licensingModel === 'annual') {
+    if (new Date().getTime() > license.expiryTimestamp) {
+      if (
+      // 30 days grace
+      new Date().getTime() < license.expiryTimestamp + 1000 * 3600 * 24 * 30 || process.env.NODE_ENV !== 'development') {
+        return {
+          status: LICENSE_STATUS.ExpiredAnnualGrace,
+          meta: {
+            expiryTimestamp: license.expiryTimestamp,
+            licenseKey
+          }
+        };
+      }
+      return {
+        status: LICENSE_STATUS.ExpiredAnnual,
+        meta: {
+          expiryTimestamp: license.expiryTimestamp,
+          licenseKey
+        }
+      };
+    }
+  }
+  if (license.scope == null || !LICENSE_SCOPES.includes(license.scope)) {
+    console.error('Error checking license. scope not found or invalid!');
+    return {
+      status: LICENSE_STATUS.Invalid
+    };
+  }
+  if (!acceptedScopes.includes(license.scope)) {
+    return {
+      status: LICENSE_STATUS.OutOfScope
+    };
+  }
+  return {
+    status: LICENSE_STATUS.Valid
+  };
+}