@oneuptime/common 12.0.6 → 12.0.7

package/Server/Types/Domain.ts

@@ -4,8 +4,49 @@ import { PromiseRejectErrorFunction } from "../../Types/FunctionTypes";
 import dns from "dns";
 import CaptureSpan from "../Utils/Telemetry/CaptureSpan";
 import BadDataException from "../../Types/Exception/BadDataException";
+import HTTPErrorResponse from "../../Types/API/HTTPErrorResponse";
+import HTTPResponse from "../../Types/API/HTTPResponse";
+import { JSONObject } from "../../Types/JSON";
+import URL from "../../Types/API/URL";
+import API from "../../Utils/API";
+import DataSourceEgressGuard from "../Utils/DataSource/EgressGuard";
 
 export default class Domain extends DomainCommon {
+  /*
+   * GET a domain-verification URL built from a tenant-supplied domain.
+   *
+   * Both the status page and the dashboard build these URLs by interpolating
+   * a customer domain into a string, and the certificate cron re-fetches them
+   * unattended every 15 minutes — so the target has to be validated on every
+   * call, not just when the row was written. The address that was validated
+   * is pinned into the socket, and redirects are refused so a 3xx cannot
+   * bounce the request to a host that was never checked. (The callers try
+   * http first and https second, so the ordinary http→https redirect a
+   * customer proxy emits is still covered by the https attempt.)
+   *
+   * Private ranges stay reachable on self-hosted installs, where a status page
+   * domain legitimately resolves inside the corporate network.
+   */
+  @CaptureSpan()
+  public static async getForDomainVerification(data: {
+    url: string;
+    targetLabel: string;
+  }): Promise<HTTPErrorResponse | HTTPResponse<JSONObject>> {
+    const { httpAgent, httpsAgent } =
+      await DataSourceEgressGuard.assertUrlAllowedAndPin(data.url, {
+        targetLabel: data.targetLabel,
+      });
+
+    return API.get<JSONObject>({
+      url: URL.fromString(data.url),
+      options: {
+        doNotFollowRedirects: true,
+        httpAgent,
+        httpsAgent,
+      },
+    });
+  }
+
   @CaptureSpan()
   public static getCnameRecords(data: { domain: string }): Promise<string[]> {
     return new Promise(

package/Server/Types/Workflow/Components/API/Delete.ts

@@ -37,7 +37,7 @@ export default class ApiDelete extends ComponentCode {
     options: RunOptions,
   ): Promise<RunReturnType> {
     const result: { args: JSONObject; successPort: Port; errorPort: Port } =
-      ApiComponentUtils.sanitizeArgs(this.getMetadata(), args, options);
+      await ApiComponentUtils.sanitizeArgs(this.getMetadata(), args, options);
 
     let apiResult: HTTPResponse<JSONObject> | HTTPErrorResponse | null = null;
 
@@ -46,6 +46,7 @@ export default class ApiDelete extends ComponentCode {
         url: args["url"] as URL,
         data: args["request-body"] as JSONObject,
         headers: args["request-headers"] as Dictionary<string>,
+        options: ApiComponentUtils.requestOptions,
       });
 
       /*

package/Server/Types/Workflow/Components/API/Get.ts

@@ -37,7 +37,7 @@ export default class ApiGet extends ComponentCode {
     options: RunOptions,
   ): Promise<RunReturnType> {
     const result: { args: JSONObject; successPort: Port; errorPort: Port } =
-      ApiComponentUtils.sanitizeArgs(this.getMetadata(), args, options);
+      await ApiComponentUtils.sanitizeArgs(this.getMetadata(), args, options);
 
     let apiResult: HTTPResponse<JSONObject> | HTTPErrorResponse | null = null;
 
@@ -46,6 +46,7 @@ export default class ApiGet extends ComponentCode {
         url: args["url"] as URL,
         data: args["request-body"] as JSONObject,
         headers: args["request-headers"] as Dictionary<string>,
+        options: ApiComponentUtils.requestOptions,
       });
 
       /*

package/Server/Types/Workflow/Components/API/Patch.ts

@@ -37,7 +37,7 @@ export default class ApiPut extends ComponentCode {
     options: RunOptions,
   ): Promise<RunReturnType> {
     const result: { args: JSONObject; successPort: Port; errorPort: Port } =
-      ApiComponentUtils.sanitizeArgs(this.getMetadata(), args, options);
+      await ApiComponentUtils.sanitizeArgs(this.getMetadata(), args, options);
 
     let apiResult: HTTPResponse<JSONObject> | HTTPErrorResponse | null = null;
 
@@ -46,6 +46,7 @@ export default class ApiPut extends ComponentCode {
         url: args["url"] as URL,
         data: args["request-body"] as JSONObject,
         headers: args["request-headers"] as Dictionary<string>,
+        options: ApiComponentUtils.requestOptions,
       });
 
       /*

package/Server/Types/Workflow/Components/API/Post.ts

@@ -38,7 +38,7 @@ export default class ApiPost extends ComponentCode {
     options: RunOptions,
   ): Promise<RunReturnType> {
     const result: { args: JSONObject; successPort: Port; errorPort: Port } =
-      ApiComponentUtils.sanitizeArgs(this.getMetadata(), args, options);
+      await ApiComponentUtils.sanitizeArgs(this.getMetadata(), args, options);
 
     let apiResult: HTTPResponse<JSONObject> | HTTPErrorResponse | null = null;
 
@@ -77,6 +77,7 @@ export default class ApiPost extends ComponentCode {
         url: args["url"] as URL,
         data: args["request-body"] as JSONObject,
         headers: args["request-headers"] as Dictionary<string>,
+        options: ApiComponentUtils.requestOptions,
       });
 
       logger.debug("API Post Component is done.", workflowLogAttributes);

package/Server/Types/Workflow/Components/API/Put.ts

@@ -37,7 +37,7 @@ export default class ApiPut extends ComponentCode {
     options: RunOptions,
   ): Promise<RunReturnType> {
     const result: { args: JSONObject; successPort: Port; errorPort: Port } =
-      ApiComponentUtils.sanitizeArgs(this.getMetadata(), args, options);
+      await ApiComponentUtils.sanitizeArgs(this.getMetadata(), args, options);
 
     let apiResult: HTTPResponse<JSONObject> | HTTPErrorResponse | null = null;
 
@@ -46,6 +46,7 @@ export default class ApiPut extends ComponentCode {
         url: args["url"] as URL,
         data: args["request-body"] as JSONObject,
         headers: args["request-headers"] as Dictionary<string>,
+        options: ApiComponentUtils.requestOptions,
       });
 
       /*

package/Server/Types/Workflow/Components/API/Utils.ts

@@ -3,14 +3,27 @@ import HTTPErrorResponse from "../../../../../Types/API/HTTPErrorResponse";
 import HTTPResponse from "../../../../../Types/API/HTTPResponse";
 import URL from "../../../../../Types/API/URL";
 import BadDataException from "../../../../../Types/Exception/BadDataException";
+import Exception from "../../../../../Types/Exception/Exception";
 import { JSONObject } from "../../../../../Types/JSON";
 import JSONFunctions from "../../../../../Types/JSONFunctions";
 import ComponentMetadata, {
   Port,
 } from "../../../../../Types/Workflow/Component";
+import { RequestOptions } from "../../../../../Utils/API";
+import SSRFProtection from "../../../../Utils/SSRFProtection";
 import CaptureSpan from "../../../../Utils/Telemetry/CaptureSpan";
 
 export class ApiComponentUtils {
+  /*
+   * Every API component sends its request with these. Redirects MUST stay off:
+   * sanitizeArgs validates the URL before the request is dispatched, and a
+   * validated public host that answers 302 -> http://169.254.169.254/ would
+   * otherwise walk the server straight past that check.
+   */
+  public static readonly requestOptions: RequestOptions = {
+    doNotFollowRedirects: true,
+  };
+
   @CaptureSpan()
   public static getReturnValues(
     response: HTTPResponse<JSONObject> | HTTPErrorResponse,
@@ -33,11 +46,11 @@ export class ApiComponentUtils {
   }
 
   @CaptureSpan()
-  public static sanitizeArgs(
+  public static async sanitizeArgs(
     metadata: ComponentMetadata,
     args: JSONObject,
     options: RunOptions,
-  ): { args: JSONObject; successPort: Port; errorPort: Port } {
+  ): Promise<{ args: JSONObject; successPort: Port; errorPort: Port }> {
     const successPort: Port | undefined = metadata.outPorts.find((p: Port) => {
       return p.id === "success";
     });
@@ -77,6 +90,32 @@ export class ApiComponentUtils {
       throw options.onError(new BadDataException("URL is not type of string"));
     }
 
+    /*
+     * The URL is authored by whoever built the workflow - i.e. any member of
+     * any project - and the request goes out from the server, which sits
+     * inside the cluster and next to the cloud metadata endpoint. Without this
+     * check the API components are an authenticated request proxy into the
+     * private network: GET http://169.254.169.254/latest/meta-data/iam/... and
+     * the credentials come back in the component's "response-body" return
+     * value, in plain sight in the workflow log. Resolve and blocklist the
+     * target the same way outbound webhooks already do.
+     *
+     * Validate the RAW string, before URL.fromString - that parser defaults an
+     * unrecognized scheme to https, so "file:///etc/passwd" would reach the
+     * check already rewritten as host "file".
+     */
+    try {
+      await SSRFProtection.validateWebhookTargetIsSafe(args["url"] as string);
+    } catch (err) {
+      throw options.onError(
+        new BadDataException(
+          err instanceof Exception
+            ? err.message
+            : "URL points to an address that is not allowed.",
+        ),
+      );
+    }
+
     args["url"] = URL.fromString(args["url"] as string);
 
     return { args, successPort, errorPort };

package/Server/Types/Workflow/Components/BaseModel/CreateManyBaseModel.ts

@@ -10,6 +10,7 @@ import ComponentMetadata, {
 } from "../../../../../Types/Workflow/Component";
 import BaseModelComponents from "../../../../../Types/Workflow/Components/BaseModel";
 import CaptureSpan from "../../../../Utils/Telemetry/CaptureSpan";
+import { applyTenantColumn } from "./ModelArguments";
 
 export default class CreateManyBaseModel<
   TBaseModel extends BaseModel,
@@ -91,25 +92,30 @@ export default class CreateManyBaseModel<
 
       const array: Array<TBaseModel> = [];
 
-      if (this.modelService.getModel().getTenantColumn()) {
-        for (const item of args["json-array"]) {
-          (item as JSONObject)[
-            this.modelService.getModel().getTenantColumn() as string
-          ] = options.projectId;
-
-          array.push(
-            (await this.modelService.create({
-              data: BaseModel.fromJSON<TBaseModel>(
-                (item as JSONObject) || {},
-                this.modelService.modelType,
-              ) as TBaseModel,
-              props: {
-                isRoot: true,
-                tenantId: options.projectId,
-              },
-            })) as TBaseModel,
-          );
-        }
+      /*
+       * This loop used to sit inside an `if (getTenantColumn())` check that
+       * was only meant to guard the projectId stamping, so a model without a
+       * tenant column created nothing at all and still reported success.
+       */
+      for (const item of args["json-array"]) {
+        const json: JSONObject = applyTenantColumn(
+          (item as JSONObject) || {},
+          this.modelService.getModel(),
+          options.projectId,
+        );
+
+        array.push(
+          (await this.modelService.create({
+            data: BaseModel.fromJSON<TBaseModel>(
+              json,
+              this.modelService.modelType,
+            ) as TBaseModel,
+            props: {
+              isRoot: true,
+              tenantId: options.projectId,
+            },
+          })) as TBaseModel,
+        );
       }
 
       return {

package/Server/Types/Workflow/Components/BaseModel/CreateOneBaseModel.ts

@@ -12,6 +12,7 @@ import ComponentMetadata, {
 } from "../../../../../Types/Workflow/Component";
 import BaseModelComponents from "../../../../../Types/Workflow/Components/BaseModel";
 import CaptureSpan from "../../../../Utils/Telemetry/CaptureSpan";
+import { applyTenantColumn } from "./ModelArguments";
 
 export default class CreateOneBaseModel<
   TBaseModel extends BaseModel,
@@ -90,11 +91,11 @@ export default class CreateOneBaseModel<
         );
       }
 
-      if (this.modelService.getModel().getTenantColumn()) {
-        (args["json"] as JSONObject)[
-          this.modelService.getModel().getTenantColumn() as string
-        ] = options.projectId;
-      }
+      args["json"] = applyTenantColumn(
+        args["json"] as JSONObject,
+        this.modelService.getModel(),
+        options.projectId,
+      );
 
       const model: TBaseModel = (await this.modelService.create({
         data: BaseModel.fromJSON<TBaseModel>(

package/Server/Types/Workflow/Components/BaseModel/DeleteManyBaseModel.ts

@@ -12,6 +12,8 @@ import ComponentMetadata, {
   Port,
 } from "../../../../../Types/Workflow/Component";
 import BaseModelComponents from "../../../../../Types/Workflow/Components/BaseModel";
+import { normalizeModelKeys } from "./ModelArguments";
+import logComponentError from "./LogComponentError";
 
 export default class DeleteManyBaseModel<
   TBaseModel extends BaseModel,
@@ -114,22 +116,26 @@ export default class DeleteManyBaseModel<
         args["limit"] = LIMIT_PER_PROJECT;
       }
 
+      const query: Query<TBaseModel> = JSONFunctions.deserialize(
+        normalizeModelKeys(
+          args["query"] as JSONObject,
+          this.modelService.getModel(),
+        ),
+      ) as Query<TBaseModel>;
+
+      /*
+       * The tenant column goes on the deserialized query, not on args["query"]
+       * - JSONFunctions.deserialize returns a new object, so anything written
+       * to args after it runs never reaches the database.
+       */
       if (this.modelService.getModel().getTenantColumn()) {
-        (args["query"] as JSONObject)[
+        (query as JSONObject)[
           this.modelService.getModel().getTenantColumn() as string
         ] = options.projectId;
       }
 
-      let query: Query<TBaseModel> = args["query"] as Query<TBaseModel>;
-
-      if (query) {
-        query = JSONFunctions.deserialize(
-          args["query"] as JSONObject,
-        ) as Query<TBaseModel>;
-      }
-
-      await this.modelService.deleteBy({
-        query: query || {},
+      const itemsDeleted: number = await this.modelService.deleteBy({
+        query: query,
         limit: new PositiveNumber(args["limit"] as number),
         skip: new PositiveNumber(args["skip"] as number),
         props: {
@@ -138,13 +144,25 @@ export default class DeleteManyBaseModel<
         },
       });
 
+      options.log(
+        `Deleted ${itemsDeleted} ${
+          this.modelService.getModel().singularName || "record"
+        }(s).`,
+      );
+
       return {
-        returnValues: {},
+        returnValues: {
+          "items-deleted": itemsDeleted,
+        },
         executePort: successPort,
       };
     } catch (err: any) {
-      options.log("Error running component");
-      options.log(err.message ? err.message : JSON.stringify(err, null, 2));
+      logComponentError({
+        error: err,
+        model: this.modelService?.getModel() || null,
+        log: options.log,
+      });
+
       return {
         returnValues: {},
         executePort: errorPort,

package/Server/Types/Workflow/Components/BaseModel/DeleteOneBaseModel.ts

@@ -11,6 +11,8 @@ import ComponentMetadata, {
 } from "../../../../../Types/Workflow/Component";
 import BaseModelComponents from "../../../../../Types/Workflow/Components/BaseModel";
 import CaptureSpan from "../../../../Utils/Telemetry/CaptureSpan";
+import { normalizeModelKeys } from "./ModelArguments";
+import logComponentError from "./LogComponentError";
 
 export default class DeleteOneBaseModel<
   TBaseModel extends BaseModel,
@@ -89,35 +91,51 @@ export default class DeleteOneBaseModel<
         );
       }
 
-      let query: Query<TBaseModel> = args["query"] as Query<TBaseModel>;
-
-      if (query) {
-        query = JSONFunctions.deserialize(
+      const query: Query<TBaseModel> = JSONFunctions.deserialize(
+        normalizeModelKeys(
           args["query"] as JSONObject,
-        ) as Query<TBaseModel>;
-      }
-
+          this.modelService.getModel(),
+        ),
+      ) as Query<TBaseModel>;
+
+      /*
+       * The tenant column goes on the deserialized query, not on args["query"]
+       * - JSONFunctions.deserialize returns a new object, so anything written
+       * to args after it runs never reaches the database.
+       */
       if (this.modelService.getModel().getTenantColumn()) {
-        (args["query"] as JSONObject)[
+        (query as JSONObject)[
           this.modelService.getModel().getTenantColumn() as string
         ] = options.projectId;
       }
 
-      await this.modelService.deleteOneBy({
-        query: (query as Query<TBaseModel>) || {},
+      const itemsDeleted: number = await this.modelService.deleteOneBy({
+        query: query,
         props: {
           isRoot: true,
           tenantId: options.projectId,
         },
       });
 
+      options.log(
+        `Deleted ${itemsDeleted} ${
+          this.modelService.getModel().singularName || "record"
+        }(s).`,
+      );
+
       return {
-        returnValues: {},
+        returnValues: {
+          "items-deleted": itemsDeleted,
+        },
         executePort: successPort,
       };
     } catch (err: any) {
-      options.log("Error running component");
-      options.log(err.message ? err.message : JSON.stringify(err, null, 2));
+      logComponentError({
+        error: err,
+        model: this.modelService?.getModel() || null,
+        log: options.log,
+      });
+
       return {
         returnValues: {},
         executePort: errorPort,

package/Server/Types/Workflow/Components/BaseModel/FindManyBaseModel.ts

@@ -14,6 +14,8 @@ import ComponentMetadata, {
 } from "../../../../../Types/Workflow/Component";
 import BaseModelComponents from "../../../../../Types/Workflow/Components/BaseModel";
 import CaptureSpan from "../../../../Utils/Telemetry/CaptureSpan";
+import { normalizeModelKeys } from "./ModelArguments";
+import logComponentError from "./LogComponentError";
 
 export default class FindManyBaseModel<
   TBaseModel extends BaseModel,
@@ -92,12 +94,6 @@ export default class FindManyBaseModel<
         );
       }
 
-      if (this.modelService.getModel().getTenantColumn()) {
-        (args["query"] as JSONObject)[
-          this.modelService.getModel().getTenantColumn() as string
-        ] = options.projectId;
-      }
-
       if (!args["select"]) {
         throw options.onError(
           new BadDataException("Select Fields is undefined."),
@@ -139,24 +135,33 @@ export default class FindManyBaseModel<
         args["limit"] = LIMIT_PER_PROJECT;
       }
 
-      let query: Query<TBaseModel> = args["query"] as Query<TBaseModel>;
-
-      if (query) {
-        query = JSONFunctions.deserialize(
+      const query: Query<TBaseModel> = JSONFunctions.deserialize(
+        normalizeModelKeys(
           args["query"] as JSONObject,
-        ) as Query<TBaseModel>;
+          this.modelService.getModel(),
+        ),
+      ) as Query<TBaseModel>;
+
+      /*
+       * The tenant column goes on the deserialized query, not on args["query"]
+       * - JSONFunctions.deserialize returns a new object, so anything written
+       * to args after it runs never reaches the database.
+       */
+      if (this.modelService.getModel().getTenantColumn()) {
+        (query as JSONObject)[
+          this.modelService.getModel().getTenantColumn() as string
+        ] = options.projectId;
       }
 
-      let select: Select<TBaseModel> = args["select"] as Select<TBaseModel>;
-
-      if (select) {
-        select = JSONFunctions.deserialize(
+      const select: Select<TBaseModel> = JSONFunctions.deserialize(
+        normalizeModelKeys(
           args["select"] as JSONObject,
-        ) as Select<TBaseModel>;
-      }
+          this.modelService.getModel(),
+        ),
+      ) as Select<TBaseModel>;
 
       const models: Array<TBaseModel> = await this.modelService.findBy({
-        query: query || {},
+        query: query,
         select: select,
         limit: new PositiveNumber(args["limit"] as number),
         skip: new PositiveNumber(args["skip"] as number),
@@ -173,8 +178,12 @@ export default class FindManyBaseModel<
         executePort: successPort,
       };
     } catch (err: any) {
-      options.log("Error running component");
-      options.log(err.message ? err.message : JSON.stringify(err, null, 2));
+      logComponentError({
+        error: err,
+        model: this.modelService?.getModel() || null,
+        log: options.log,
+      });
+
       return {
         returnValues: {},
         executePort: errorPort,

package/Server/Types/Workflow/Components/BaseModel/FindOneBaseModel.ts

@@ -12,6 +12,8 @@ import ComponentMetadata, {
 } from "../../../../../Types/Workflow/Component";
 import BaseModelComponents from "../../../../../Types/Workflow/Components/BaseModel";
 import CaptureSpan from "../../../../Utils/Telemetry/CaptureSpan";
+import { normalizeModelKeys } from "./ModelArguments";
+import logComponentError from "./LogComponentError";
 
 export default class FindOneBaseModel<
   TBaseModel extends BaseModel,
@@ -90,12 +92,6 @@ export default class FindOneBaseModel<
         );
       }
 
-      if (this.modelService.getModel().getTenantColumn()) {
-        (args["query"] as JSONObject)[
-          this.modelService.getModel().getTenantColumn() as string
-        ] = options.projectId;
-      }
-
       if (!args["select"]) {
         throw options.onError(
           new BadDataException("Select Fields is undefined."),
@@ -112,24 +108,33 @@ export default class FindOneBaseModel<
         );
       }
 
-      let query: Query<TBaseModel> = args["query"] as Query<TBaseModel>;
-
-      if (query) {
-        query = JSONFunctions.deserialize(
+      const query: Query<TBaseModel> = JSONFunctions.deserialize(
+        normalizeModelKeys(
           args["query"] as JSONObject,
-        ) as Query<TBaseModel>;
+          this.modelService.getModel(),
+        ),
+      ) as Query<TBaseModel>;
+
+      /*
+       * The tenant column goes on the deserialized query, not on args["query"]
+       * - JSONFunctions.deserialize returns a new object, so anything written
+       * to args after it runs never reaches the database.
+       */
+      if (this.modelService.getModel().getTenantColumn()) {
+        (query as JSONObject)[
+          this.modelService.getModel().getTenantColumn() as string
+        ] = options.projectId;
       }
 
-      let select: Select<TBaseModel> = args["select"] as Select<TBaseModel>;
-
-      if (select) {
-        select = JSONFunctions.deserialize(
+      const select: Select<TBaseModel> = JSONFunctions.deserialize(
+        normalizeModelKeys(
           args["select"] as JSONObject,
-        ) as Select<TBaseModel>;
-      }
+          this.modelService.getModel(),
+        ),
+      ) as Select<TBaseModel>;
 
       const model: TBaseModel | null = await this.modelService.findOneBy({
-        query: query || {},
+        query: query,
         select: select,
         props: {
           isRoot: true,
@@ -146,9 +151,11 @@ export default class FindOneBaseModel<
         executePort: successPort,
       };
     } catch (err: any) {
-      options.log("Error running component");
-
-      options.log(err.message ? err.message : JSON.stringify(err, null, 2));
+      logComponentError({
+        error: err,
+        model: this.modelService?.getModel() || null,
+        log: options.log,
+      });
 
       return {
         returnValues: {},