metadefender
TypeScript icon, indicating that this package has built-in type declarations

1.2.5 • Public • Published

node-metadefender npm bundle size GitHub package.json version NPM

FOSSA Status

Metadefender wrapper for node js

Metadefender is a cloud-based data sanitization (Content Disarm & Reconstruction), vulnerability detection and multi-scanning with options for free and commercial users.

It is a product of opswat

Requirements

  • Nodejs > 8
  • npm (bundled with nodejs)

Dependencies

"request""^2.88.0"

How to setup

For developers

npm i --save metadefender

For contributors

  1. Clone the repo https://github.com/tbhaxor/node-metadefender.git

    git clone https://github.com/tbhaxor/node-metadefender.git
  2. Change the directory

    cd node-metadefender
  3. Install the development dependencies

    npm i -g grunt-cli
  4. Install the project dependencies

    npm install

Implementation

After you got the api key look the following example

Demonstrating hash lookup example

let { HashLookup } = require('metadefender');
 
let scanner = new HashLookup('YOUR API KEY');
 
scanner
    .hashLookup('HASH TO SCAN')
    .then(data => {
        console.log(data);
    })
    .catch(err => {
        console.error(err);
    });

Note: Every method returns a Promise like object

Documentation

The documentation is already provided on the metadefender help site

The following are the endpoints current supported by node-metadefender

  1. Apikey
  2. File Scanning
  3. Hash Lookups
  4. Reputation Service
  5. Application Information
  6. Malware sample sharing
  7. Threat Intelligence Feed
  8. Status endpoints
  9. Dynamic analysis

Contribution

Feel free to open new pull requests for the repository

Note: Before contributing to the repo, make sure you have gone through Contributing.md

License

node-metadefender is licensed under GPL-3.0

FOSSA Status

Package Sidebar

Install

npm i metadefender

Weekly Downloads

1

Version

1.2.5

License

GPL-3.0

Unpacked Size

84.1 kB

Total Files

13

Last publish

Collaborators

  • tbhaxor