@keeex/js-fusion-verifier v6.1.0

KeeeX standalone file verifier (@keeex/js-fusion-verifier)

This library provide the core KeeeX verification feature, able to take in any keeexed file, validate all offline information and output all metadata embedded in the file by KeeeX.

It supports a handful of environment and allows providing custom data source for advanced usages.

Installation

This package is available on npmjs:

npm install @keeex/js-fusion-verifier

It also requires a KeeeX cryptographic provider to operate; these needs to be installed and imported separately.

Currently available cryptographic providers are:

• @keeex/crypto-provider-node: for NodeJS
• @keeex/crypto-provider-browser: for web browser environments
• @keeex/crypto-provider-reactnative: for react-native environment (iOS and Android only)

Before using the verifier, you must import one of these, for example:

import "@keeex/crypto-provider-node";

Usage

Input

You can verify the following type of input:

• ArrayBuffer or Uint8Array: use verifyBuffer()
• A file on the filesystem (only in NodeJS): use verifyPath()
• A Blob (only in environment where Blob follows browsers specifications): use verifyBlob()

In addition, it is possible to implement the IKXInput interface to provide custom input from other sources. In that case you can pass an instance of such implementation to verifyInput().

All functions accept a second optional boolean parameter called onlineInfo. Set it to true to retrieve online information about the verified file (if available):

• timestamp information
• digital identity informations

Retrieving online informations is partially based on KeeeX servers. Requests from unauthenticated end users are rate limited to prevent abuse. If you use this library in a context where you have valid KeeeX credentials, you can set them up by calling the setCredentials() function:

import {setCredentials} from "@keeex/js-fusion-verifier/lib/verifier/config.js";

setCredentials("login", "password");

Output

The verify method called always return a suitable output (it should never throw under normal circumstances, including non-keeexed or invalid input).

The full content of the output object is described in the API documentation and available as TypeScript definitions.

Web version

A transpiled version made to support a broader range of web browser is available in the package. Instead of importing @keeex/js-fusion-verifier/lib/verify.js you can import @keeex/js-fusion-verifier/web/verify.js instead.

Short example

import "@keeex/crypto-provider-node";
import verifyPath from "@keeex/js-fusion-verifier/lib/verifier/path.js";

const res = await verifyPath("/tmp/somefile");
console.log("IDX:", res.mainIdx);