Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/b4dnewz/node-censys
A unofficial node wrapper for the Censys.io API.
https://github.com/b4dnewz/node-censys
censys censys-api censys-client information-gathering javascript-client javascript-wrapper node-client osint
Last synced: about 2 months ago
JSON representation
A unofficial node wrapper for the Censys.io API.
- Host: GitHub
- URL: https://github.com/b4dnewz/node-censys
- Owner: b4dnewz
- License: mit
- Created: 2018-01-18T13:20:21.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2020-09-10T20:15:17.000Z (about 4 years ago)
- Last Synced: 2024-05-02T02:15:19.514Z (5 months ago)
- Topics: censys, censys-api, censys-client, information-gathering, javascript-client, javascript-wrapper, node-client, osint
- Language: TypeScript
- Homepage: https://censys.io/api
- Size: 972 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# node-censys
> An unofficial javascript wrapper for Censys.io API
[![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][daviddm-image]][daviddm-url] [![Coverage percentage][coveralls-image]][coveralls-url]
If you are interested to see the official documentation visit the [Censys.io](https://censys.io/api) API page.
## Installation
Install it locally to your project to use it as a node module:
```
npm install censys.io
```
Or globally to use it as a cli tool:
```
npm install --global censys.io
```
Than you should have __censys__ command available on your path, try it out with the _--help_ menu.
```
$ censys --help
```
On the command line tool you can specify the API id and secret as an option before the commands or you can setup environment variables called __CENSYS_ID__ and __CENSYS_SECRET__ that will be used by default.
## Usage
The censys client is promise based and must be instanciated with the API __id__ and __secret__ obtained from the Censys website, like the example below.
```js
import Censys from 'censys.io'
const instance = new Censys({
apiID: '',
apiSecret: ''
})
const data = await instance.search('certificates', {
query: '80.http.get.headers.server: nginx'
})
```
This project is __typescript__ based and provides the module definitions for a better experience.
## Methods
#### [search](https://censys.io/api/v1/docs/search)
The search endpoint allows searches against the current data in the IPv4, Top Million Websites, and Certificates indexes using the same search syntax as the primary site. The endpoint returns a paginated result set of hosts (or websites or certificates) that match the search. Data should be posted as a JSON request document.
```js
const data = await censys.search('ipv4', {
query: '8.8.8.8'
});
console.log(data);
```
#### [view](https://censys.io/api/v1/docs/view)
The view endpoint fetches the structured data we have about a specific host, website, or certificate once you know the host's IP address, website's domain, or certificate's SHA-256 fingerprint.
report
```js
const data = await censys.view('websites', 'google.com');
console.log(data);
```
#### [report](https://censys.io/api/v1/docs/report)
The report endpoint allows you to determine the aggregate breakdown of a value for the results a query, similar to the "Build Report" functionality available in the primary search interface. For example, if you wanted to determine the breakdown of cipher suites selected by all websites in the Top Million.
```js
const data = censys.report('ipv4', {
query: '80.http.get.headers.server: nginx',
field: 'location.country_code'
});
console.log(data);
```
#### [data](https://censys.io/api/v1/docs/data)
The Get Series endpoint returns a data on the types of scans we regularly perform ("series").
```js
const data = await censys.data();
console.log(data);
```
#### [account](https://censys.io/api/v1/docs/account)
The account endpoint returns information about your Censys account.
```js
const data = await censys.account();
console.log(data);
```
---
## License
MIT © [Filippo Conti](https://b4dnewz.github.io/)
[npm-image]: https://badge.fury.io/js/censys.io.svg
[npm-url]: https://npmjs.org/package/censys.io
[travis-image]: https://travis-ci.org/b4dnewz/node-censys.svg?branch=master
[travis-url]: https://travis-ci.org/b4dnewz/node-censys
[daviddm-image]: https://david-dm.org/b4dnewz/node-censys.svg?theme=shields.io
[daviddm-url]: https://david-dm.org/b4dnewz/node-censys
[coveralls-image]: https://coveralls.io/repos/b4dnewz/node-censys/badge.svg
[coveralls-url]: https://coveralls.io/r/b4dnewz/node-censys