@milaboratories/pl-drivers 1.6.12 → 1.7.0

package/src/drivers/{download_blob_url → urls}/url.test.ts

@@ -1,9 +1,9 @@
 import path from 'path';
 import { describe, test, expect } from 'vitest';
-import { isFolderURL, getPathForFolderURL } from './url';
+import { getPathForBlockUIURL, getPathForFolderURL } from './url';
 import type { Signer } from '@milaboratories/ts-helpers';
 import { HmacSha256Signer } from '@milaboratories/ts-helpers';
-import { FolderURL } from '@milaboratories/pl-model-common';
+import { FolderURL, isFolderURL } from '@milaboratories/pl-model-common';
 
 describe('isFolderURL', () => {
   test('should return true for a valid URL', () => {
@@ -25,7 +25,6 @@ describe('isFolderURL', () => {
 describe('getPathForFolderURL', () => {
   const signer: Signer = {
     sign: (data: string | Uint8Array) => 'signature',
-
     verify: (data: string | Uint8Array, signature: string, validationErrorMessage?: string) => null,
   };
 
@@ -37,3 +36,27 @@ describe('getPathForFolderURL', () => {
     expect(result).toBe(path.join('/test/dir/subfolder_tgz/path/to/resource.html'));
   });
 });
+
+describe('getPathForBlockUIURL', () => {
+  const signer: Signer = {
+    sign: (data: string | Uint8Array) => 'signature',
+    verify: (data: string | Uint8Array, signature: string, validationErrorMessage?: string) => null,
+  };
+
+  test('should be ok', () => {
+    const blockUIURL = 'block-ui://signature.blockUIDir.uidir/path/to/resource.html';
+
+    const result = getPathForBlockUIURL(signer, blockUIURL, '/test/dir');
+
+    expect(result).toBe(path.join('/test/dir/blockUIDir/path/to/resource.html'));
+  });
+
+  /** The function should decode url-encoded whitespaces. */
+  test('should be ok with whitespaces', () => {
+    const blockUIURL = 'block-ui://signature.blockUIDir.uidir/path/to%20whitespaces%20/resource.html';
+
+    const result = getPathForBlockUIURL(signer, blockUIURL, '/test/dir');
+
+    expect(result).toBe(path.join('/test/dir/blockUIDir/path/to whitespaces /resource.html'));
+  });
+});

package/src/drivers/urls/url.ts

@@ -0,0 +1,68 @@
+import type { FolderURL, BlockUIURL } from '@milaboratories/pl-model-common';
+import type { Signer } from '@milaboratories/ts-helpers';
+import path from 'path';
+
+/** Creates a new plblob+folder URL. */
+export function newFolderURL(signer: Signer, saveDir: string, fPath: string): FolderURL {
+  const p = path.relative(saveDir, fPath);
+  const sign = signer.sign(p);
+
+  return `plblob+folder://${sign}.${p}.blob`;
+}
+
+/** Creates a new block-ui URL. */
+export function newBlockUIURL(signer: Signer, saveDir: string, fPath: string): BlockUIURL {
+  const p = path.relative(saveDir, fPath);
+  const sign = signer.sign(p);
+
+  return `block-ui://${sign}.${p}.uidir`;
+}
+
+/** Checks the signature and path injections.
+ * @returns the path to the file inside the root directory. */
+export function getPathForFolderURL(signer: Signer, url: FolderURL, rootDir: string): string {
+  return getPath(signer, url, rootDir);
+}
+
+/** Checks the signature and path injections.
+ * @returns the path to the file inside the root directory. */
+export function getPathForBlockUIURL(signer: Signer, url: BlockUIURL, rootDir: string): string {
+  return getPath(signer, url, rootDir);
+}
+
+/** Parses URL,
+ * checks the signature,
+ * gets the absolute path by the given root directory.
+ * If the path is empty, it returns the index.html file.
+ * @returns an absolute path for the user. */
+function getPath(signer: Signer, url: string, rootDir: string): string {
+  const parsed = new URL(url);
+  const [sign, subfolder, _] = parsed.host.split('.');
+
+  signer.verify(subfolder, sign, `signature verification failed for url: ${url}, subfolder: ${subfolder}`);
+
+  // Decoding changes '%20' to ' ' for example.
+  const pathname = decodeURIComponent(parsed.pathname.slice(1));
+
+  let fPath = parseNestedPathNoEscape(path.join(rootDir, `${subfolder}`), pathname);
+
+  if (parsed.pathname == '' || parsed.pathname == '/') {
+    fPath = path.join(fPath, 'index.html');
+  }
+
+  return path.resolve(fPath);
+}
+
+/** Checks that the userInputPath is in baseDir.
+ * @returns an absolute path for the user. */
+function parseNestedPathNoEscape(baseDir: string, userInputPath: string): string {
+  const absolutePath = path.resolve(baseDir, userInputPath);
+
+  const normalizedBase = path.resolve(baseDir);
+
+  if (!absolutePath.startsWith(normalizedBase)) {
+    throw new Error('Path validation failed.');
+  }
+
+  return absolutePath;
+}

package/src/index.ts

@@ -12,7 +12,7 @@ export * from './drivers/upload';
 export * from './drivers/upload_task';
 export * from './drivers/logs_stream';
 export * from './drivers/logs';
-export * from './drivers/download_url';
+export * from './drivers/download_url/driver';
 export * from './drivers/ls';
 export * from './drivers/virtual_storages';
 export * from './drivers/helpers/helpers';

package/dist/drivers/download_url.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"download_url.d.ts","sourceRoot":"","sources":["../../src/drivers/download_url.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAC;AACzE,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAC;AACtE,OAAO,KAAK,EACV,QAAQ,EAAE,MAAM,4BAA4B,CAAC;AAC/C,OAAO,EACL,cAAc,EAMf,MAAM,4BAA4B,CAAC;AAOpC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AACzC,OAAO,EAAmB,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAI5E,MAAM,WAAW,qBAAqB;IACpC;;sEAEkE;IAClE,OAAO,CAAC,GAAG,EAAE,GAAG,GAAG,UAAU,CAAC,UAAU,GAAG,SAAS,CAAC,CAAC;CACvD;AAED,MAAM,WAAW,UAAU;IACzB,iFAAiF;IACjF,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,4DAA4D;IAC5D,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,MAAM,oBAAoB,GAAG;IACjC,kBAAkB,EAAE,MAAM,CAAC;IAC3B,UAAU,EAAE,OAAO,CAAC;IACpB,oBAAoB,EAAE,MAAM,CAAC;CAC9B,CAAC;AAEF;qCACqC;AACrC,qBAAa,iBAAkB,YAAW,qBAAqB;IAW3D,OAAO,CAAC,QAAQ,CAAC,MAAM;IAEvB,OAAO,CAAC,QAAQ,CAAC,OAAO;IACxB,OAAO,CAAC,QAAQ,CAAC,IAAI;IAbvB,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAuB;IAEtD,OAAO,CAAC,aAAa,CAA6C;IAClE,OAAO,CAAC,aAAa,CAAgB;IAErC;mCAC+B;IAC/B,OAAO,CAAC,KAAK,CAAgC;gBAG1B,MAAM,EAAE,QAAQ,EACjC,UAAU,EAAE,UAAU,EACL,OAAO,EAAE,MAAM,EACf,IAAI,GAAE,oBAItB;IAOH,2DAA2D;IAC3D,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,aAAa,GAAG,UAAU,GAAG,SAAS;IAE7D,4CAA4C;IAC5C,OAAO,CAAC,GAAG,EAAE,GAAG,GAAG,UAAU,CAAC,UAAU,GAAG,SAAS,CAAC;IAuBrD,YAAY,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM;IAkBnD,wEAAwE;IAClE,WAAW,CAAC,IAAI,EAAE,iBAAiB,EAAE,QAAQ,EAAE,MAAM;IAM3D;mCAC+B;IACzB,WAAW,CAAC,GAAG,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IA+B5D,2CAA2C;IACrC,UAAU;IAgBhB,OAAO,CAAC,UAAU;IAQlB,OAAO,CAAC,UAAU;IAMlB,OAAO,CAAC,WAAW;CAIpB;AAED,wDAAwD;AACxD,cAAM,iBAAiB;IASnB,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,QAAQ,CAAC,IAAI,EAAE,MAAM;IACrB,QAAQ,CAAC,GAAG,EAAE,GAAG;IAVnB,QAAQ,CAAC,OAAO,iBAAwB;IACxC,QAAQ,CAAC,MAAM,eAAsB;IACrC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAyB;IACnD,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,IAAI,UAAS;IACb,IAAI,SAAK;gBAGU,MAAM,EAAE,QAAQ,EACxB,IAAI,EAAE,MAAM,EACZ,GAAG,EAAE,GAAG;IAGZ,IAAI;;;;;;;IAUX,MAAM,CAAC,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM;IAK7B,QAAQ,CAAC,cAAc,EAAE,oBAAoB,EAAE,UAAU,EAAE,OAAO;YAkB1D,gBAAgB;IA4B9B,OAAO,IAAI,UAAU,GAAG,SAAS;IAQjC,OAAO,CAAC,OAAO;IAKf,OAAO,CAAC,QAAQ;IAIhB,KAAK,CAAC,MAAM,EAAE,MAAM;CAGrB"}