@adobe/helix-config 2.18.1 → 3.0.0

package/CHANGELOG.md

@@ -1,3 +1,22 @@
+# [3.0.0](https://github.com/adobe/helix-config/compare/v2.18.2...v3.0.0) (2024-05-16)
+
+
+### Features
+
+* remove unused option and enforce scope ([#86](https://github.com/adobe/helix-config/issues/86)) ([4c9d26d](https://github.com/adobe/helix-config/commit/4c9d26d5579b289adb593b2ccfeae97d5ff5e3b6))
+
+
+### BREAKING CHANGES
+
+* ConfigContext.withFetch() was removed
+
+## [2.18.2](https://github.com/adobe/helix-config/compare/v2.18.1...v2.18.2) (2024-05-13)
+
+
+### Bug Fixes
+
+* use webcrypto for better support ([#82](https://github.com/adobe/helix-config/issues/82)) ([0eb3a5b](https://github.com/adobe/helix-config/commit/0eb3a5b3ddba9a809c617e09d40f7d6ba98e0663))
+
 ## [2.18.1](https://github.com/adobe/helix-config/compare/v2.18.0...v2.18.1) (2024-05-09)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-config",
-  "version": "2.18.1",
+  "version": "3.0.0",
   "description": "Helix Config",
   "main": "src/index.js",
   "types": "src/index.d.ts",
@@ -36,18 +36,11 @@
     "reporter": "mocha-multi-reporters",
     "reporter-options": "configFile=.mocha-multi.json"
   },
-  "imports": {
-    "#crypto": {
-      "node": "./src/crypto.node.js",
-      "browser": "./src/crypto.worker.js",
-      "worker": "./src/crypto.worker.js"
-    }
-  },
   "devDependencies": {
     "@adobe/eslint-config-helix": "2.0.6",
     "@semantic-release/changelog": "6.0.3",
     "@semantic-release/git": "10.0.1",
-    "@semantic-release/npm": "12.0.0",
+    "@semantic-release/npm": "12.0.1",
     "c8": "9.1.0",
     "eslint": "8.57.0",
     "husky": "9.0.11",
@@ -58,7 +51,7 @@
     "mocha-multi-reporters": "1.5.1",
     "mocha-suppress-logs": "0.5.1",
     "nock": "13.5.4",
-    "semantic-release": "23.0.8"
+    "semantic-release": "23.1.1"
   },
   "lint-staged": {
     "*.js": "eslint",
@@ -68,10 +61,10 @@
     "@adobe/fetch": "4.1.2",
     "@adobe/helix-shared-config": "10.4.4",
     "@adobe/helix-shared-git": "3.0.9",
-    "@adobe/helix-shared-storage": "1.0.0",
+    "@adobe/helix-shared-storage": "1.0.1",
     "@adobe/helix-shared-utils": "3.0.2",
     "ajv": "8.13.0",
     "ajv-formats": "3.0.1",
-    "jose": "5.2.4"
+    "jose": "5.3.0"
   }
 }

package/src/ConfigContext.d.ts

@@ -11,8 +11,6 @@
  */
 import {S3Loader} from "./S3Loader";
 
-type Fetch = (url: string|Request, options?: RequestOptions) => Promise<Response>;
-
 export declare enum ConfigScope {
   delivery = 'delivery',
   pipeline = 'pipeline',
@@ -24,6 +22,5 @@ export declare class ConfigContext {
   withLog(log: Console): ConfigContext;
   withEnv(env: object): ConfigContext;
   withS3Loader(loader: S3Loader): ConfigContext;
-  withFetch(fetch: Fetch): ConfigContext;
 }
 

package/src/ConfigContext.js

@@ -39,7 +39,6 @@ export const SCOPE_RAW = 'raw';
  * Public / Custom Configs: Sidekick, Production Host, Custom Preview Page / Live Host, Custom JSON.
  * @type {string}
  */
-// eslint-disable-next-line no-unused-vars
 export const SCOPE_PUBLIC = 'public';
 
 /**
@@ -68,9 +67,4 @@ export class ConfigContext {
     this.loader = loader;
     return this;
   }
-
-  withFetch(fetch) {
-    this.fetch = fetch;
-    return this;
-  }
 }

package/src/config-view.js

@@ -12,13 +12,12 @@
 import { ModifiersConfig } from '@adobe/helix-shared-config/modifiers';
 import { computeSurrogateKey } from '@adobe/helix-shared-utils';
 // eslint-disable-next-line import/no-unresolved
-import cryptoImpl from '#crypto';
 import { PipelineResponse } from './PipelineResponse.js';
 import {
   SCOPE_ADMIN,
   SCOPE_PIPELINE,
   SCOPE_DELIVERY,
-  SCOPE_RAW,
+  SCOPE_RAW, SCOPE_PUBLIC,
 } from './ConfigContext.js';
 import { resolveLegacyConfig, fetchRobotsTxt, toArray } from './config-legacy.js';
 import { getMergedConfig } from './config-merge.js';
@@ -48,6 +47,14 @@ const HELIX_CONFIG_BUS = 'helix-config-bus';
 
 const HELIX_CONTENT_BUS = 'helix-content-bus';
 
+const VALID_SCOPES = [
+  SCOPE_ADMIN,
+  SCOPE_PIPELINE,
+  SCOPE_DELIVERY,
+  SCOPE_RAW,
+  SCOPE_PUBLIC,
+];
+
 /**
  * Creates a string representation of the given array that is suitable for substring matching by
  * delimiting each entry with `,` eg: ,foo@adobe.com,bar@adobe.com,
@@ -69,23 +76,35 @@ export function canonicalArrayString(root, partition, prop) {
  * Returns the hash of the global delivery token if defined.
  * @param ctx
  * @param rso
- * @returns {string|null}
+ * @returns {Promise<string|null>}
  */
-function getGlobalTokenHash(ctx, rso) {
+async function getGlobalTokenHash(ctx, rso) {
   if (!ctx.env.HLX_GLOBAL_DELIVERY_TOKEN) {
     return null;
   }
-  return cryptoImpl
-    .createHmac('sha512', rso.org)
-    .update(ctx.env.HLX_GLOBAL_DELIVERY_TOKEN, 'utf-8')
-    .digest()
-    .toString('base64url');
+  // use webcrypto for better support for cloudflare workers
+  const enc = new TextEncoder('utf-8');
+  const key = await crypto.subtle.importKey(
+    'raw',
+    enc.encode(rso.org),
+    {
+      name: 'HMAC',
+      hash: { name: 'SHA-512' },
+    },
+    false,
+    ['sign', 'verify'],
+  );
+  const buffer = await crypto.subtle.sign('HMAC', key, enc.encode(ctx.env.HLX_GLOBAL_DELIVERY_TOKEN));
+  return btoa(String.fromCharCode(...new Uint8Array(buffer)))
+    .replaceAll('/', '_')
+    .replaceAll('+', '-')
+    .replaceAll('=', '');
 }
 
 /**
  * Returns the normalized access configuration for the give partition.
  */
-export function getAccessConfig(ctx, config, partition, rso) {
+export async function getAccessConfig(ctx, config, partition, rso) {
   const { access, tokens = {} } = config;
   const apiKeyId = toArray(access[partition]?.apiKeyId ?? access.apiKeyId);
   const allow = toArray(access[partition]?.allow ?? access.allow);
@@ -107,7 +126,7 @@ export function getAccessConfig(ctx, config, partition, rso) {
   // if an apiKeyId is defined but no tokenHash, create a fake one so that auth is still enforced.
   if (cfg.apiKeyId.length) {
     // add global token hash if defined and needed
-    const globalTokenHash = getGlobalTokenHash(ctx, rso);
+    const globalTokenHash = await getGlobalTokenHash(ctx, rso);
     if (cfg.tokenHash.length && globalTokenHash) {
       // augment the list of hashes with the global one if exists
       cfg.tokenHash.push(globalTokenHash);
@@ -252,6 +271,15 @@ export async function getConfigResponse(ctx, opts) {
   const {
     ref, site, org, scope,
   } = opts;
+  if (!VALID_SCOPES.includes(scope)) {
+    return new PipelineResponse('', {
+      status: 400,
+      headers: {
+        'x-error': 'invalid scope',
+      },
+    });
+  }
+
   const rso = { ref, site, org };
   const config = await resolveConfig(ctx, rso, scope);
   const surrogateHeaders = {
@@ -279,8 +307,8 @@ export async function getConfigResponse(ctx, opts) {
     // normalize access config
     const { admin = {} } = config.access;
     config.access = {
-      preview: getAccessConfig(ctx, config, 'preview', rso),
-      live: getAccessConfig(ctx, config, 'live', rso),
+      preview: await getAccessConfig(ctx, config, 'preview', rso),
+      live: await getAccessConfig(ctx, config, 'live', rso),
       // access.require.repository ?
     };
     if (opts.scope === SCOPE_ADMIN || opts.scope === SCOPE_RAW) {

package/src/crypto.node.js

@@ -1,16 +0,0 @@
-/*
- * Copyright 2018 Adobe. All rights reserved.
- * This file is licensed to you under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License. You may obtain a copy
- * of the License at http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software distributed under
- * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
- * OF ANY KIND, either express or implied. See the License for the specific language
- * governing permissions and limitations under the License.
- */
-
-// node runtime
-import cryptoImpl from 'node:crypto';
-
-export default cryptoImpl;

package/src/crypto.worker.js

@@ -1,15 +0,0 @@
-/*
- * Copyright 2018 Adobe. All rights reserved.
- * This file is licensed to you under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License. You may obtain a copy
- * of the License at http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software distributed under
- * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
- * OF ANY KIND, either express or implied. See the License for the specific language
- * governing permissions and limitations under the License.
- */
-
-// browser/worker runtime
-// eslint-disable-next-line no-undef
-export default crypto;