oneuptime/Common/Types/HashedString.ts

import UUID from "../Utils/UUID";
import DatabaseProperty from "./Database/DatabaseProperty";
import BadDataException from "./Exception/BadDataException";
import BadOperationException from "./Exception/BadOperationException";
import { JSONObject, ObjectType } from "./JSON";
import ObjectID from "./ObjectID";
import CryptoJS from "crypto-js";
import { FindOperator } from "typeorm";

export default class HashedString extends DatabaseProperty {
  private isHashed: boolean = false;

  private _value: string = "";
  public get value(): string {
    return this._value;
  }
  public set value(v: string) {
    this._value = v;
  }

  public constructor(value: string, isValueHashed: boolean = false) {
    super();
    this.value = value;
    this.isHashed = isValueHashed;
  }

  public override toJSON(): JSONObject {
    return {
      _type: ObjectType.HashedString,
      value: (this as HashedString).toString(),
    };
  }

  public static override fromJSON(json: JSONObject): HashedString {
    if (json["_type"] === ObjectType.HashedString) {
      return new HashedString((json["value"] as string) || "");
    }

    throw new BadDataException("Invalid JSON: " + JSON.stringify(json));
  }

  public override toString(): string {
    return this.value;
  }

  public static generate(): HashedString {
    return new this(UUID.generate());
  }

  protected static override toDatabase(
    value: HashedString | FindOperator<HashedString>,
  ): string | null {
    if (value) {
      if (typeof value === "string") {
        value = new HashedString(value);
      }

      return value.toString();
    }

    return null;
  }

  public isValueHashed(): boolean {
    return this.isHashed;
  }

  public async hashValue(encryptionSecret: ObjectID | null): Promise<string> {
    if (!this.value) {
      return "";
    }

    if (this.isHashed) {
      throw new BadOperationException("Value is already hashed");
    }

    const valueToHash: string = (encryptionSecret || "") + this.value;
    this.isHashed = true;

    this.value = CryptoJS.SHA256(valueToHash).toString();
    return this.value;
  }

  public static async hashValue(
    value: string,
    encryptionSecret: ObjectID | null,
  ): Promise<string> {
    const hashstring: HashedString = new HashedString(value, false);
    return await hashstring.hashValue(encryptionSecret);
  }

  protected static override fromDatabase(_value: string): HashedString | null {
    if (_value) {
      return new HashedString(_value, true);
    }

    return null;
  }

  public static fromString(value: string): HashedString {
    return new HashedString(value, false);
  }
}