# exploitsearch

> A library for accessing ExploitSearch.net API, http://www.exploitsearch.net/

Latest version **2.0.3** (published 2017-03-05) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install exploitsearch
pnpm add exploitsearch
yarn add exploitsearch
bun add exploitsearch
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 2.0.3 |
| Published | 2017-03-05 |
| First published | 2014-01-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=6 |
| Dependencies | 4 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 5 |
| Author | Jesus Perez |
| Maintainers | jesusprubio |
| Keywords | node, exploitsearch, exploit, bug, vulnerability, 0day, API, client |

## Links

- npm: https://www.npmjs.com/package/exploitsearch
- Repository: https://github.com/jesusprubio/node-exploitsearch-client/exploitsearch.js
- npm.io page: https://npm.io/package/exploitsearch

## Dependencies (4)

- [faker](https://npm.io/package/faker.md) ^3.1.0
- [lodash](https://npm.io/package/lodash.md) ^4.17.4
- [request](https://npm.io/package/request.md) ^2.74.0
- [request-promise-native](https://npm.io/package/request-promise-native.md) ^1.0.3

## Alternatives

- [launchdarkly-js-client-sdk](https://npm.io/package/launchdarkly-js-client-sdk.md) — 2.5M weekly downloads
- [@elastic/elasticsearch](https://npm.io/package/@elastic/elasticsearch.md) — 2.1M weekly downloads
- [@c8y/client](https://npm.io/package/@c8y/client.md) — 15.3K weekly downloads
- [@signaldb/maverickjs](https://npm.io/package/@signaldb/maverickjs.md) — 1.7K weekly downloads
- [@bbc/http-transport-cache](https://npm.io/package/@bbc/http-transport-cache.md) — 1.2K weekly downloads

## Recent versions

- 2.0.3 (latest) — 2017-03-05
- 2.0.2 — 2017-01-04
- 2.0.0 — 2016-09-05
- 1.1.6 — 2015-12-22
- 1.1.5 — 2015-12-16
- 1.1.3 — 2015-12-13
- 1.1.2 — 2015-12-13
- 1.1.1 — 2015-12-13
- 1.1.0 — 2015-10-18
- 1.0.14 — 2015-07-27
- 1.0.13 — 2015-07-27
- 1.0.12 — 2015-07-27
- 1.0.11 — 2015-07-26
- 1.0.10 — 2015-07-26
- 1.0.9 — 2015-02-12
- … 11 more at https://npm.io/package/exploitsearch/versions

## README

# exploitsearch.js

[![Build Status](https://travis-ci.org/jesusprubio/exploitsearch.js.svg?branch=master)](https://travis-ci.org/jesusprubio/exploitsearch.js)

A [Node.js](https://nodejs.org) library for accessing the [Exploitsearch.net](http://www.exploitsearch.net/) site API.

![Demo](https://raw.githubusercontent.com/jesusprubio/node-exploitsearch-client/master/artifacts/demo.gif)


## Use

```javascript
const search = require('exploitsearch');

const opts = {
  timeout: 10000,
  exploits: true,
};

// With callbacks.
search('freepbx', opts, (err, res) => {
  if (err) {
    console.log('Error:');
    console.log(err);

    process.exit(1);
  } else {
    console.log('Response:');
    console.log(res);
  }
});

// As a promise.
search('asterisk', opts)
.then(res => {
  console.log('Response (promise):');
  console.log(res);
})
.catch(err => {
  console.log('Error (promise):');
  console.log(err);

  process.exit(1);
});
```

More examples are included in the [**tests**](./test) folder.


## API
If the callback is ommited a promise is returned.

### `search(queryString, opts, callback)`
Make a request to the API.
- `queryString` (String): The string to make the search.
- `opts` (Object): The options of the method:
 - `exploits` - Only return vulnerabilities with public exploits. (default: false)
 - `timeout` (number): Time to wait for a response. (default: 5000)
- `callback` - We follow the [Error-first callback](http://thenodeway.io/posts/understanding-error-first-callbacks/) paradigm.


## Developer guide

- Start coding with one of the actual modules similar to the new one as a boilerplate.
- Use [GitHub pull requests](https://help.github.com/articles/using-pull-requests).

### Conventions:
- We use [ESLint](http://eslint.org/) and [Airbnb](https://github.com/airbnb/javascript) style guide.
- Please run to be sure your code fits with it and the tests keep passing:
```sh
npm run-script cont-int
```

### Commit messages rules:
- It should be formed by a one-line subject, followed by one line of white space. Followed by one or more descriptive paragraphs, each separated by one line of white space. All of them finished by a dot.
- If it fixes an issue, it should include a reference to the issue ID in the first line of the commit.
- It should provide enough information for a reviewer to understand the changes and their relation to the rest of the code.

---
_Source: https://npm.io/package/exploitsearch · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._