@freedomofpress/webcat
    Preparing search index...

    Variable WebcatErrorCodeConst

    WebcatErrorCode: {
        Bundle: {
            ENROLLMENT_MISSING: "ERR_WEBCAT_BUNDLE_MISSING_ENROLLMENT";
            MALFORMED: "ERR_WEBCAT_BUNDLE_MALFORMED";
            MANIFEST_MISSING: "ERR_WEBCAT_BUNDLE_MISSING_MANIFEST";
            SIGNATURES_MISSING: "ERR_WEBCAT_BUNDLE_MISSING_SIGNATURES";
        };
        CSP: { MISMATCH: "ERR_WEBCAT_CSP_MISMATCH" };
        Enrollment: {
            CLAIMS_EMPTY: "ERR_WEBCAT_ENROLLMENT_CLAIMS_EMPTY";
            CLAIMS_MALFORMED: "ERR_WEBCAT_ENROLLMENT_CLAIMS_MALFORMED";
            CLAIMS_MISSING: "ERR_WEBCAT_ENROLLMENT_CLAIMS_MISSING";
            LOGS_MALFORMED: "ERR_WEBCAT_ENROLLMENT_LOGS_MALFORMED";
            MAX_AGE_MALFORMED: "ERR_WEBCAT_ENROLLMENT_MAX_AGE_MALFORMED";
            MISMATCH: "ERR_WEBCAT_ENROLLMENT_MISMATCH";
            POLICY_LENGTH: "ERR_WEBCAT_ENROLLMENT_POLICY_LENGTH";
            POLICY_MALFORMED: "ERR_WEBCAT_ENROLLMENT_POLICY_MALFORMED";
            SIGNERS_EMPTY: "ERR_WEBCAT_ENROLLMENT_SIGNERS_EMPTY";
            SIGNERS_KEY_MALFORMED: "ERR_WEBCAT_ENROLLMENT_SIGNERS_KEY_MALFORMED";
            SIGNERS_MALFORMED: "ERR_WEBCAT_ENROLLMENT_SIGNERS_MALFORMED";
            THRESHOLD_IMPOSSIBLE: "ERR_WEBCAT_ENROLLMENT_THRESHOLD_IMPOSSIBLE";
            THRESHOLD_MALFORMED: "ERR_WEBCAT_ENROLLMENT_THRESHOLD_MALFORMED";
            TRUSTED_ROOT_MISSING: "ERR_WEBCAT_ENROLLMENT_TRUSTED_ROOT_MISSING";
            TYPE_INVALID: "ERR_WEBCAT_ENROLLMENT_TYPE_INVALID";
        };
        Fetch: { FETCH_ERROR: "ERR_WEBCAT_BUNDLE_FETCH_ERROR" };
        File: {
            MISMATCH: "ERR_WEBCAT_FILE_MISMATCH";
            MISSING: "ERR_WEBCAT_FILE_MISSING";
        };
        FrameIsolation: {
            OAC_UNAVAILABLE: "ERR_WEBCAT_FRAME_ISOLATION_OAC_UNAVAILABLE";
        };
        Headers: {
            DUPLICATE: "ERR_WEBCAT_HEADERS_DUPLICATE";
            ENROLLMENT_MALFORMED: "ERR_WEBCAT_HEADERS_ENROLLMENT_MALFORMED";
            FORBIDDEN: "ERR_WEBCAT_HEADERS_FORBIDDEN";
            LOCATION_EXTERNAL: "ERR_WEBCAT_HEADERS_LOCATION_EXTERNAL";
            LOCATION_SUBRESOURCE: "ERR_WEBCAT_HEADERS_LOCATION_SUBRESOURCE";
            MISSING: "ERR_WEBCAT_HEADERS_MISSING";
            MISSING_CRITICAL: "ERR_WEBCAT_HEADERS_MISSING_CRITICAL";
        };
        Manifest: {
            DEFAULT_CSP_INVALID: "ERR_WEBCAT_MANIFEST_DEFAULT_CSP_INVALID";
            DEFAULT_CSP_MISSING: "ERR_WEBCAT_MANIFEST_DEFAULT_CSP_MISSING";
            DEFAULT_FALLBACK_MISSING: "ERR_WEBCAT_MANIFEST_DEFAULT_FALLBACK_MISSING";
            DEFAULT_FALLBACK_MISSING_FILE: "ERR_WEBCAT_MANIFEST_DEFAULT_FALLBACK_MISSING_FILE";
            DEFAULT_INDEX_MISSING: "ERR_WEBCAT_MANIFEST_DEFAULT_INDEX_MISSING";
            DEFAULT_INDEX_MISSING_FILE: "ERR_WEBCAT_MANIFEST_DEFAULT_INDEX_MISSING_FILE";
            EXPIRED: "ERR_WEBCAT_MANIFEST_EXPIRED";
            EXTRA_CSP_INVALID: "ERR_WEBCAT_MANIFEST_EXTRA_CSP_INVALID";
            EXTRA_CSP_MALFORMED: "ERR_WEBCAT_MANIFEST_EXTRA_CSP_MALFORMED";
            FILES_MALFORMED: "ERR_WEBCAT_MANIFEST_FILES_MALFORMED";
            FILES_MISSING: "ERR_WEBCAT_MANIFEST_FILES_MISSING";
            THRESHOLD_UNSATISFIED: "ERR_WEBCAT_MANIFEST_THRESHOLD_UNSATISFIED";
            TIMESTAMP_MISSING: "ERR_WEBCAT_MANIFEST_MISSING_TIMESTAMP";
            TIMESTAMP_VERIFY_FAILED: "ERR_WEBCAT_MANIFEST_TIMESTAMP_VERIFY_FAILED";
            VERIFY_FAILED: "ERR_WEBCAT_MANIFEST_VERIFY_FAILED";
            WASM_MISSING: "ERR_WEBCAT_MANIFEST_WASM_MISSING";
        };
        URL: { UNSUPPORTED: "ERR_WEBCAT_URL_UNSUPPORTED" };
    } = ...

    All user-facing error codes.

    Type Declaration

    • ReadonlyBundle: {
          ENROLLMENT_MISSING: "ERR_WEBCAT_BUNDLE_MISSING_ENROLLMENT";
          MALFORMED: "ERR_WEBCAT_BUNDLE_MALFORMED";
          MANIFEST_MISSING: "ERR_WEBCAT_BUNDLE_MISSING_MANIFEST";
          SIGNATURES_MISSING: "ERR_WEBCAT_BUNDLE_MISSING_SIGNATURES";
      }

      Error codes related to bundle validation.

      • ENROLLMENT_MISSING: "ERR_WEBCAT_BUNDLE_MISSING_ENROLLMENT"

        The bundle is missing the enrollment object.

      • MALFORMED: "ERR_WEBCAT_BUNDLE_MALFORMED"

        The bundle is invalid JSON.

      • MANIFEST_MISSING: "ERR_WEBCAT_BUNDLE_MISSING_MANIFEST"

        The bundle is missing the manifest object.

      • SIGNATURES_MISSING: "ERR_WEBCAT_BUNDLE_MISSING_SIGNATURES"

        The bundle is missing its signatures.

    • ReadonlyCSP: { MISMATCH: "ERR_WEBCAT_CSP_MISMATCH" }

      Error codes related to CSP validation.

      • MISMATCH: "ERR_WEBCAT_CSP_MISMATCH"

        The CSP returned by the server did not match any of the CSPs declared on the manifest.

    • ReadonlyEnrollment: {
          CLAIMS_EMPTY: "ERR_WEBCAT_ENROLLMENT_CLAIMS_EMPTY";
          CLAIMS_MALFORMED: "ERR_WEBCAT_ENROLLMENT_CLAIMS_MALFORMED";
          CLAIMS_MISSING: "ERR_WEBCAT_ENROLLMENT_CLAIMS_MISSING";
          LOGS_MALFORMED: "ERR_WEBCAT_ENROLLMENT_LOGS_MALFORMED";
          MAX_AGE_MALFORMED: "ERR_WEBCAT_ENROLLMENT_MAX_AGE_MALFORMED";
          MISMATCH: "ERR_WEBCAT_ENROLLMENT_MISMATCH";
          POLICY_LENGTH: "ERR_WEBCAT_ENROLLMENT_POLICY_LENGTH";
          POLICY_MALFORMED: "ERR_WEBCAT_ENROLLMENT_POLICY_MALFORMED";
          SIGNERS_EMPTY: "ERR_WEBCAT_ENROLLMENT_SIGNERS_EMPTY";
          SIGNERS_KEY_MALFORMED: "ERR_WEBCAT_ENROLLMENT_SIGNERS_KEY_MALFORMED";
          SIGNERS_MALFORMED: "ERR_WEBCAT_ENROLLMENT_SIGNERS_MALFORMED";
          THRESHOLD_IMPOSSIBLE: "ERR_WEBCAT_ENROLLMENT_THRESHOLD_IMPOSSIBLE";
          THRESHOLD_MALFORMED: "ERR_WEBCAT_ENROLLMENT_THRESHOLD_MALFORMED";
          TRUSTED_ROOT_MISSING: "ERR_WEBCAT_ENROLLMENT_TRUSTED_ROOT_MISSING";
          TYPE_INVALID: "ERR_WEBCAT_ENROLLMENT_TYPE_INVALID";
      }

      Error codes related to enrollment validation

      • CLAIMS_EMPTY: "ERR_WEBCAT_ENROLLMENT_CLAIMS_EMPTY"

        The enrollment claims array is empty. Sigstore-specific.

      • CLAIMS_MALFORMED: "ERR_WEBCAT_ENROLLMENT_CLAIMS_MALFORMED"

        The enrollment claims are not in the expected format. Sigstore-specific.

      • CLAIMS_MISSING: "ERR_WEBCAT_ENROLLMENT_CLAIMS_MISSING"

        The enrollment is missing the claims property. Sigstore-specific.

      • LOGS_MALFORMED: "ERR_WEBCAT_ENROLLMENT_LOGS_MALFORMED"

        The logs are not in the expected format. Sigsum-specific.

      • MAX_AGE_MALFORMED: "ERR_WEBCAT_ENROLLMENT_MAX_AGE_MALFORMED"

        The enrollment max age is not in the expected format.

      • MISMATCH: "ERR_WEBCAT_ENROLLMENT_MISMATCH"

        The enrollment object does not match its published hash.

      • POLICY_LENGTH: "ERR_WEBCAT_ENROLLMENT_POLICY_LENGTH"

        The policy on the enrollment is either empty or too long. Sigsum-specific.

      • POLICY_MALFORMED: "ERR_WEBCAT_ENROLLMENT_POLICY_MALFORMED"

        The policy on the enrollment does not match the expected format. Sigsum-specific.

      • SIGNERS_EMPTY: "ERR_WEBCAT_ENROLLMENT_SIGNERS_EMPTY"

        The signers array is empty. Sigsum-specific.

      • SIGNERS_KEY_MALFORMED: "ERR_WEBCAT_ENROLLMENT_SIGNERS_KEY_MALFORMED"

        The signer keys are not in the expected format. Sigsum-specific.

      • SIGNERS_MALFORMED: "ERR_WEBCAT_ENROLLMENT_SIGNERS_MALFORMED"

        The value of the signers property is not an array. Sigsum-specific.

      • THRESHOLD_IMPOSSIBLE: "ERR_WEBCAT_ENROLLMENT_THRESHOLD_IMPOSSIBLE"

        The signers threshold is higher than the number of signers and, hence, unreachable. Sigsum-specific.

      • THRESHOLD_MALFORMED: "ERR_WEBCAT_ENROLLMENT_THRESHOLD_MALFORMED"

        The signature threshold is not in the expected format. Sigsum-specific.

      • TRUSTED_ROOT_MISSING: "ERR_WEBCAT_ENROLLMENT_TRUSTED_ROOT_MISSING"

        The enrollment is missing the trusted_root property. Sigstore-specific.

      • TYPE_INVALID: "ERR_WEBCAT_ENROLLMENT_TYPE_INVALID"

        The enrollment is not of one of the supported enrollment types.

    • ReadonlyFetch: { FETCH_ERROR: "ERR_WEBCAT_BUNDLE_FETCH_ERROR" }

      Error codes related to bundle fetching.

      • FETCH_ERROR: "ERR_WEBCAT_BUNDLE_FETCH_ERROR"

        The fetch API call failed. Potential causes include network errors or misconfigured bundle paths.

    • ReadonlyFile: { MISMATCH: "ERR_WEBCAT_FILE_MISMATCH"; MISSING: "ERR_WEBCAT_FILE_MISSING" }

      Error codes related to file content validation.

      • MISMATCH: "ERR_WEBCAT_FILE_MISMATCH"

        The file contents do not match the hash on the manifest.

      • MISSING: "ERR_WEBCAT_FILE_MISSING"

        The file is not present on the manifest.

    • ReadonlyFrameIsolation: { OAC_UNAVAILABLE: "ERR_WEBCAT_FRAME_ISOLATION_OAC_UNAVAILABLE" }

      {@inheritDoc WebcatErrorFrameIsolation}

    • ReadonlyHeaders: {
          DUPLICATE: "ERR_WEBCAT_HEADERS_DUPLICATE";
          ENROLLMENT_MALFORMED: "ERR_WEBCAT_HEADERS_ENROLLMENT_MALFORMED";
          FORBIDDEN: "ERR_WEBCAT_HEADERS_FORBIDDEN";
          LOCATION_EXTERNAL: "ERR_WEBCAT_HEADERS_LOCATION_EXTERNAL";
          LOCATION_SUBRESOURCE: "ERR_WEBCAT_HEADERS_LOCATION_SUBRESOURCE";
          MISSING: "ERR_WEBCAT_HEADERS_MISSING";
          MISSING_CRITICAL: "ERR_WEBCAT_HEADERS_MISSING_CRITICAL";
      }

      Error codes related to header validation.

      • DUPLICATE: "ERR_WEBCAT_HEADERS_DUPLICATE"

        The server returned a duplicate critical header.

      • ENROLLMENT_MALFORMED: "ERR_WEBCAT_HEADERS_ENROLLMENT_MALFORMED"

        An enrollment header did not match the expected format.

      • FORBIDDEN: "ERR_WEBCAT_HEADERS_FORBIDDEN"

        The server returned a forbidden header.

      • LOCATION_EXTERNAL: "ERR_WEBCAT_HEADERS_LOCATION_EXTERNAL"

        A redirection to an external origin was attempted via a location header.

      • LOCATION_SUBRESOURCE: "ERR_WEBCAT_HEADERS_LOCATION_SUBRESOURCE"

        A subresource request was redirected via a location header.

      • MISSING: "ERR_WEBCAT_HEADERS_MISSING"

        Response headers are unavailable for inspection.

      • MISSING_CRITICAL: "ERR_WEBCAT_HEADERS_MISSING_CRITICAL"

        A critical header was missing from the response.

    • ReadonlyManifest: {
          DEFAULT_CSP_INVALID: "ERR_WEBCAT_MANIFEST_DEFAULT_CSP_INVALID";
          DEFAULT_CSP_MISSING: "ERR_WEBCAT_MANIFEST_DEFAULT_CSP_MISSING";
          DEFAULT_FALLBACK_MISSING: "ERR_WEBCAT_MANIFEST_DEFAULT_FALLBACK_MISSING";
          DEFAULT_FALLBACK_MISSING_FILE: "ERR_WEBCAT_MANIFEST_DEFAULT_FALLBACK_MISSING_FILE";
          DEFAULT_INDEX_MISSING: "ERR_WEBCAT_MANIFEST_DEFAULT_INDEX_MISSING";
          DEFAULT_INDEX_MISSING_FILE: "ERR_WEBCAT_MANIFEST_DEFAULT_INDEX_MISSING_FILE";
          EXPIRED: "ERR_WEBCAT_MANIFEST_EXPIRED";
          EXTRA_CSP_INVALID: "ERR_WEBCAT_MANIFEST_EXTRA_CSP_INVALID";
          EXTRA_CSP_MALFORMED: "ERR_WEBCAT_MANIFEST_EXTRA_CSP_MALFORMED";
          FILES_MALFORMED: "ERR_WEBCAT_MANIFEST_FILES_MALFORMED";
          FILES_MISSING: "ERR_WEBCAT_MANIFEST_FILES_MISSING";
          THRESHOLD_UNSATISFIED: "ERR_WEBCAT_MANIFEST_THRESHOLD_UNSATISFIED";
          TIMESTAMP_MISSING: "ERR_WEBCAT_MANIFEST_MISSING_TIMESTAMP";
          TIMESTAMP_VERIFY_FAILED: "ERR_WEBCAT_MANIFEST_TIMESTAMP_VERIFY_FAILED";
          VERIFY_FAILED: "ERR_WEBCAT_MANIFEST_VERIFY_FAILED";
          WASM_MISSING: "ERR_WEBCAT_MANIFEST_WASM_MISSING";
      }

      Error codes related to manifest validation.

      • DEFAULT_CSP_INVALID: "ERR_WEBCAT_MANIFEST_DEFAULT_CSP_INVALID"

        The default CSP is invalid. See validateCSP.

      • DEFAULT_CSP_MISSING: "ERR_WEBCAT_MANIFEST_DEFAULT_CSP_MISSING"

        No default CSP is present on the manifest.

      • DEFAULT_FALLBACK_MISSING: "ERR_WEBCAT_MANIFEST_DEFAULT_FALLBACK_MISSING"

        No default fallback is present on the manifest.

      • DEFAULT_FALLBACK_MISSING_FILE: "ERR_WEBCAT_MANIFEST_DEFAULT_FALLBACK_MISSING_FILE"

        The default fallback does not match any file in the file list.

      • DEFAULT_INDEX_MISSING: "ERR_WEBCAT_MANIFEST_DEFAULT_INDEX_MISSING"

        No default index is present on the manifest.

      • DEFAULT_INDEX_MISSING_FILE: "ERR_WEBCAT_MANIFEST_DEFAULT_INDEX_MISSING_FILE"

        The default index does not match any file in the file list.

      • EXPIRED: "ERR_WEBCAT_MANIFEST_EXPIRED"

        The manifest has expired.

      • EXTRA_CSP_INVALID: "ERR_WEBCAT_MANIFEST_EXTRA_CSP_INVALID"

        An extra CSP is invalid. See validateCSP.

      • EXTRA_CSP_MALFORMED: "ERR_WEBCAT_MANIFEST_EXTRA_CSP_MALFORMED"

        The extra CSP object is not in the expected format.

      • FILES_MALFORMED: "ERR_WEBCAT_MANIFEST_FILES_MALFORMED"

        A file hash is not in the expected format: the unpadded base64url encoding of a SHA-256 digest.

      • FILES_MISSING: "ERR_WEBCAT_MANIFEST_FILES_MISSING"

        No file list is present on the manifest, or the file list is empty.

      • THRESHOLD_UNSATISFIED: "ERR_WEBCAT_MANIFEST_THRESHOLD_UNSATISFIED"

        The number of valid signatures did not satisfy the threshold specified on the enrollment. Sigsum-specific.

      • TIMESTAMP_MISSING: "ERR_WEBCAT_MANIFEST_MISSING_TIMESTAMP"

        The timestamp property is missing from the manifest. Sigsum-specific.

      • TIMESTAMP_VERIFY_FAILED: "ERR_WEBCAT_MANIFEST_TIMESTAMP_VERIFY_FAILED"

        The timestamp value could not be verified. Sigsum-specific.

      • VERIFY_FAILED: "ERR_WEBCAT_MANIFEST_VERIFY_FAILED"

        The manifest could not be verified against the signatures.

      • WASM_MISSING: "ERR_WEBCAT_MANIFEST_WASM_MISSING"

        No wasm property is present on the manifest.

    • ReadonlyURL: { UNSUPPORTED: "ERR_WEBCAT_URL_UNSUPPORTED" }

      Error codes related to request URL validation.

      • UNSUPPORTED: "ERR_WEBCAT_URL_UNSUPPORTED"

        A request was issued with an unsupported protocol or port.