Variable SecureModeConst

Type Declaration

• decompressionLimit: function

  • decompressionLimit(this: void): number | undefined

    The maximum number of bytes decompressing a project file may yield, undefined (no limit) outside the secure mode.

    Parameters

    • this: void

    Returns number | undefined

• enable: function

  • enable(this: void): void

    Enables the secure mode for the rest of the process's lifetime (there is no way back).

    Parameters

    • this: void

    Returns void

• EnvVar: "FLOWR_SECURE_MODE"

  Environment variable that enables SecureMode when flowR is loaded.

• guard: function

  • guard(this: void, operation: SecureModeOperation, detail?: string): void

    Call this right before performing the given operation.

    Parameters

    • this: void
    • operation: SecureModeOperation
    • Optionaldetail: string

    Returns void

    Throws

    a SecureModeError if the secure mode is enabled

• isEnabled: function

  • isEnabled(this: void): boolean

    Whether the secure mode is enabled.

    Parameters

    • this: void

    Returns boolean

• ReadonlyMaxDecompressedBytes: number

  In secure mode, decompressing a file of the analyzed project must not yield more than this many bytes, so a decompression bomb cannot exhaust the memory. Use SecureMode.decompressionLimit.