https://github.com/fvdm/nodejs-haveibeenpwned
API methods for HaveIBeenPwnd.com (unofficial)
https://github.com/fvdm/nodejs-haveibeenpwned
api-client breaches haveibeenpwned infosec leaks nodejs unlicense
Last synced: 5 months ago
JSON representation
API methods for HaveIBeenPwnd.com (unofficial)
- Host: GitHub
- URL: https://github.com/fvdm/nodejs-haveibeenpwned
- Owner: fvdm
- License: unlicense
- Created: 2016-06-07T16:55:56.000Z (almost 9 years ago)
- Default Branch: develop
- Last Pushed: 2021-10-22T15:50:54.000Z (over 3 years ago)
- Last Synced: 2024-11-15T18:39:51.395Z (5 months ago)
- Topics: api-client, breaches, haveibeenpwned, infosec, leaks, nodejs, unlicense
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/haveibeenpwned
- Size: 95.7 KB
- Stars: 17
- Watchers: 4
- Forks: 5
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# haveibeenpwned
API methods for Have I been pwned (unofficial)
[](https://github.com/fvdm/nodejs-haveibeenpwned/blob/master/CHANGELOG.md)
[](https://travis-ci.com/github/fvdm/nodejs-haveibeenpwned)
[](https://coveralls.io/github/fvdm/nodejs-haveibeenpwned?branch=master)
* [Node.js](https://nodejs.org)
* [Have I been pwned](https://haveibeenpwned.com)
* [API documentation](https://haveibeenpwned.com/API/v2)
# Example
```js
const hibp = require ('haveibeenpwned') ();
hibp.breachedAccount ('[email protected]', (err, data) => {
if (err) {
return console.log (err);
}
console.log (data);
});
```
# Installation
`npm i haveibeenpwned`
# Configuration
name | type | required | default | description
:-------|:-------|:---------|:--------|:--------------------------
timeout | number | no | 5000 | Request wait timeout in ms
```js
const pwned = require ('haveibeenpwned') ({
timeout: 10000
});
```
# Have I Been Pwned
Below are the methods for the main Have I Been Pwned API.
For simplicity no error handling is included in the callback examples.
It's straightforward: when there is a problem `err` is an instance of
_Error_ and `data` is _undefined_, otherwise `err` is _null_ and
`data` is set to the result.
## .breachedAccount
**( account, [params], callback )**
All breaches for an account.
argument | type | required | description
:--------|:---------|:---------|:--------------------------------
account | string | yes | Email or username to check
params | object | no | Additional parameters to include
callback | function | yes | `function (err, data) {}`
```js
hibp.breachedAccount ('[email protected]', yourCallback);
```
[Example output](https://haveibeenpwned.com/api/v2/breachedaccount/[email protected])
## .breaches
**( [params], callback )**
All breaches in the system.
argument | type | required | description
:--------|:---------|:---------|:--------------------------------
params | object | no | Additional parameters to include
callback | function | yes | `function (err, data) {}`
```js
hibp.breaches (yourCallback);
```
[Example output](https://haveibeenpwned.com/api/v2/breaches)
## .breach
**( name, [params], callback )**
A single breached site.
argument | type | required | description
:--------|:---------|:---------|:-----------------------------------
name | string | yes | Site name to check, i.e. `linkedin`
params | object | no | Additional parameters to include
callback | function | yes | `function (err, data) {}`
```js
hibp.breach ('Adobe', yourCallback);
```
[Example output](https://haveibeenpwned.com/api/v2/breach/Adobe)
## .pasteAccount
**( account, callback )**
All pastes for an account.
argument | type | required | description
:--------|:---------|:---------|:--------------------------
account | string | yes | Email or username to check
callback | function | yes | `function (err, data) {}`
```js
hibp.pasteAccount ('[email protected]', yourCallback);
```
[Example output](https://haveibeenpwned.com/api/v2/pasteaccount/[email protected])
## .dataclasses
**( callback )**
All pastes for an account.
argument | type | required | description
:--------|:---------|:---------|:-------------------------
callback | function | yes | `function (err, data) {}`
```js
hibp.dataclasses (yourCallback);
```
[Example output](https://haveibeenpwned.com/api/v2/dataclasses)
# Pwned Passwords
Below are the methods for the Pwned Passwords API.
## .pwnedpasswords.byPassword
**( password, [hashed], callback )**
Check if a password was leaked.
The `data` is `0` (int) when none were found.
argument | type | default | description
:--------|:---------|:--------|:---------------------
password | string | | The password to check
hashed | bool | false | Is the password already SHA-1 hashed
callback | function | | `(err, data)`
```js
hibp.pwnedpasswords.byPassword ('secret', (err, count) => {
if (!count) {
console.log ('Great! Password is not found.');
} else {
console.log ('Oops! Password was found ' + count + ' times!');
}
});
// -> Oops! Password was found 195263 times!
```
## .pwnedpasswords.byRange
**( hash, [sort], callback )**
Get password hashes similar to the first 5 characters of the SHA-1 hash
provided. The callback `data` is an *object* where the keys are the
lowercase hashes and the values are the number of times they were used.
When nothing is found `data` is `0` (int).
A hash longer then 5 characters is truncated before being sent to the API
and can be in uppercase or lowercase.
argument | type | default | description
:--------|:---------|:--------|:-----------------------
hash | string | | The SHA-1 hash to check
sort | bool | false | Sort by counts in descending order
callback | function | | `(err, data)`
### Sorted by key (default)
```js
hibp.pwnedpasswords.byRange ('abcdef', (err, data) => {
for (sha in data) {
console.log ('%s %i x', sha, data[sha]);
}
});
```
### Sorted by use counts
```js
hibp.pwnedpasswords.byRange ('abcdef', true, (err, data) => {
const count = Object.keys (data).length;
let i = 1;
console.log ('Found %i matches', count);
console.log ('Top 3:');
for (sha in data) {
console.log ('%i %s %i x', i, sha, data[sha]);
// stop after 3
if (i === 3) { break; }
i++;
}
});
// ->
// Found 511 matches
// Top 3:
// 1 3b8a55c2b3bf42b83e41f0f95a4149043f6 336 x
// 2 6a7fc410810db77855d9dfe5b94b95196f7 304 x
// 3 73a1a21a7b13b50536df19fd586abdf3145 193 x
```
# Unicense
This is free and unencumbered software released into the public domain.
Anyone is free to copy, modify, publish, use, compile, sell, or
distribute this software, either in source code form or as a compiled
binary, for any purpose, commercial or non-commercial, and by any
means.
In jurisdictions that recognize copyright laws, the author or authors
of this software dedicate any and all copyright interest in the
software to the public domain. We make this dedication for the benefit
of the public at large and to the detriment of our heirs and
successors. We intend this dedication to be an overt act of
relinquishment in perpetuity of all present and future rights to this
software under copyright law.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
For more information, please refer to
# Author
[Franklin](https://fvdm.com)
| [Buy me a coffee](https://fvdm.com/donating/)