hibp

## Functions <dl> <dt><a href="#breach">breach(breachName, [options])</a> ⇒ <code><a href="#breach--object">Promise.<Breach></a></code> | <code>Promise.<null></code></dt> <dd>Fetches data for a specific breach event. </dd> <dt><a href="#breachedAccount">breachedAccount(account, [options])</a> ⇒ <code><a href="#breach--object">Promise.<Array.<Breach>></a></code> | <code>Promise.<null></code></dt> <dd>Fetches breach data for a specific account. 🔑 <code>haveibeenpwned.com</code> requires an API key from <a href="https://haveibeenpwned.com/API/Key">https://haveibeenpwned.com/API/Key</a> for the <code>breachedaccount</code> endpoint. The <code>apiKey</code> option here is not explicitly required, but direct requests made without it will fail (unless you specify a <code>baseUrl</code> to a proxy that inserts a valid API key on your behalf). </dd> <dt><a href="#breaches">breaches([options])</a> ⇒ <code><a href="#breach--object">Promise.<Array.<Breach>></a></code></dt> <dd>Fetches all breach events in the system. </dd> <dt><a href="#dataClasses">dataClasses([options])</a> ⇒ <code>Promise.<Array.<string>></code> | <code>Promise.<null></code></dt> <dd>Fetches all data classes in the system. </dd> <dt><a href="#pasteAccount">pasteAccount(email, [options])</a> ⇒ <code><a href="#paste--object">Promise.<Array.<Paste>></a></code> | <code>Promise.<null></code></dt> <dd>Fetches paste data for a specific account (email address). 🔑 <code>haveibeenpwned.com</code> requires an API key from <a href="https://haveibeenpwned.com/API/Key">https://haveibeenpwned.com/API/Key</a> for the <code>pasteaccount</code> endpoint. The <code>apiKey</code> option here is not explicitly required, but direct requests made without it will fail (unless you specify a <code>baseUrl</code> to a proxy that inserts a valid API key on your behalf). </dd> <dt><a href="#pwnedPasswordRange">pwnedPasswordRange(prefix, [options])</a> ⇒ <code><a href="#PwnedPasswordSuffixes">Promise.<PwnedPasswordSuffixes></a></code></dt> <dd>Fetches the SHA-1 or NTLM hash suffixes for the given 5-character hash prefix. When a password hash with the same first 5 characters is found in the Pwned Passwords repository, the API will respond with an HTTP 200 and include the suffix of every hash beginning with the specified prefix, followed by a count of how many times it appears in the data set. This function parses the response and returns a more structured format. </dd> <dt><a href="#pwnedPassword">pwnedPassword(password, [options])</a> ⇒ <code>Promise.<number></code></dt> <dd>Fetches the number of times the the given password has been exposed in a breach (0 indicating no exposure). The password is given in plain text, but only the first 5 characters of its SHA-1 hash will be submitted to the API. </dd> <dt><a href="#search">search(account, [options])</a> ⇒ <code><a href="#SearchResults">Promise.<SearchResults></a></code></dt> <dd>Fetches all breaches and all pastes associated with the provided account (email address or username). Note that the remote API does not support querying pastes by username (only email addresses), so in the event the provided account is not a valid email address, only breach data is queried and the "pastes" field of the resulting object will always be null. This is exactly how searching via the current web interface behaves, which this convenience method is designed to mimic. 🔑 <code>haveibeenpwned.com</code> requires an API key from <a href="https://haveibeenpwned.com/API/Key">https://haveibeenpwned.com/API/Key</a> for the <code>breachedaccount</code> and <code>pasteaccount</code> endpoints. The <code>apiKey</code> option here is not explicitly required, but direct requests made without it will fail (unless you specify a <code>baseUrl</code> to a proxy that inserts a valid API key on your behalf). </dd> <dt><a href="#subscriptionStatus">subscriptionStatus([options])</a> ⇒ <code><a href="#subscriptionstatus--object">Promise.<SubscriptionStatus></a></code></dt> <dd>Fetches the current status of your HIBP subscription (API key). 🔑 <code>haveibeenpwned.com</code> requires an API key from <a href="https://haveibeenpwned.com/API/Key">https://haveibeenpwned.com/API/Key</a> for the <code>subscription/status</code> endpoint. The <code>apiKey</code> option here is not explicitly required, but direct requests made without it will fail (unless you specify a <code>baseUrl</code> to a proxy that inserts a valid API key on your behalf). </dd> </dl> ## Typedefs <dl> <dt><a href="#breach--object">Breach</a> : <code>object</code></dt> <dd>An object representing a breach. </dd> <dt><a href="#Paste">Paste</a> : <code>object</code></dt> <dd>An object representing a paste. </dd> <dt><a href="#PwnedPasswordSuffixes">PwnedPasswordSuffixes</a> : <code>Object.<string, number></code></dt> <dd>An object mapping an exposed password hash suffix (corresponding to a given hash prefix) to how many times it occurred in the Pwned Passwords repository. </dd> <dt><a href="#SearchResults">SearchResults</a> : <code>object</code></dt> <dd>An object representing search results. </dd> <dt><a href="#subscriptionstatus--object">SubscriptionStatus</a> : <code>object</code></dt> <dd>An object representing the status of your HIBP subscription. </dd> </dl> <a name="breach"></a> ## breach(breachName, [options]) ⇒ [<code>Promise.<Breach></code>](#breach--object) \| <code>Promise.<null></code> Fetches data for a specific breach event. **Kind**: global function **Returns**: [<code>Promise.<Breach></code>](#breach--object) \| <code>Promise.<null></code> - a Promise which resolves to an object representing a breach (or null if no breach was found), or rejects with an Error | Param | Type | Description | | --- | --- | --- | | breachName | <code>string</code> | the name of a breach in the system | | [options] | <code>object</code> | a configuration object | | [options.baseUrl] | <code>string</code> | a custom base URL for the haveibeenpwned.com API endpoints (default: `https://haveibeenpwned.com/api/v3`) | | [options.timeoutMs] | <code>number</code> | timeout for the request in milliseconds (default: none) | | [options.userAgent] | <code>string</code> | a custom string to send as the User-Agent field in the request headers (default: `hibp <version>`) | **Example** ```js try { const data = await breach("Adobe"); if (data) { // ... } else { // ... } } catch (err) { // ... } ``` <a name="breachedAccount"></a> ## breachedAccount(account, [options]) ⇒ <code><a href="#breach--object">Promise.<Array.<Breach>></a></code> \| <code>Promise.<null></code> Fetches breach data for a specific account. 🔑 `haveibeenpwned.com` requires an API key from https://haveibeenpwned.com/API/Key for the `breachedaccount` endpoint. The `apiKey` option here is not explicitly required, but direct requests made without it will fail (unless you specify a `baseUrl` to a proxy that inserts a valid API key on your behalf). **Kind**: global function **Returns**: <code><a href="#breach--object">Promise.<Array.<Breach>></a></code> \| <code>Promise.<null></code> - a Promise which resolves to an array of breach objects (or null if no breaches were found), or rejects with an Error | Param | Type | Description | | --- | --- | --- | | account | <code>string</code> | a username or email address | | [options] | <code>object</code> | a configuration object | | [options.apiKey] | <code>string</code> | an API key from https://haveibeenpwned.com/API/Key (default: undefined) | | [options.domain] | <code>string</code> | a domain by which to filter the results (default: all domains) | | [options.includeUnverified] | <code>boolean</code> | include "unverified" breaches in the results (default: true) | | [options.timeoutMs] | <code>number</code> | timeout for the request in milliseconds (default: none) | | [options.truncate] | <code>boolean</code> | truncate the results to only include the name of each breach (default: true) | | [options.baseUrl] | <code>string</code> | a custom base URL for the haveibeenpwned.com API endpoints (default: `https://haveibeenpwned.com/api/v3`) | | [options.userAgent] | <code>string</code> | a custom string to send as the User-Agent field in the request headers (default: `hibp <version>`) | **Example** ```js try { const data = await breachedAccount("foo", { apiKey: "my-api-key" }); if (data) { // ... } else { // ... } } catch (err) { // ... } ``` **Example** ```js try { const data = await breachedAccount("bar", { includeUnverified: false, baseUrl: "https://my-hibp-proxy:8080", }); if (data) { // ... } else { // ... } } catch (err) { // ... } ``` **Example** ```js try { const data = await breachedAccount("baz", { apiKey: "my-api-key", domain: "adobe.com", truncate: false, userAgent: "my-app 1.0", }); if (data) { // ... } else { // ... } } catch (err) { // ... } ``` <a name="breaches"></a> ## breaches([options]) ⇒ <code><a href="#breach--object">Promise.<Array.<Breach>></a></code> Fetches all breach events in the system. **Kind**: global function **Returns**: <code><a href="#breach--object">Promise.<Array.<Breach>></a></code> - a Promise which resolves to an array of breach objects (an empty array if no breaches were found), or rejects with an Error | Param | Type | Description | | --- | --- | --- | | [options] | <code>object</code> | a configuration object | | [options.domain] | <code>string</code> | a domain by which to filter the results (default: all domains) | | [options.baseUrl] | <code>string</code> | a custom base URL for the haveibeenpwned.com API endpoints (default: `https://haveibeenpwned.com/api/v3`) | | [options.timeoutMs] | <code>number</code> | timeout for the request in milliseconds (default: none) | | [options.userAgent] | <code>string</code> | a custom string to send as the User-Agent field in the request headers (default: `hibp <version>`) | **Example** ```js try { const data = await breaches(); if (data) { // ... } else { // ... } } catch (err) { // ... } ``` **Example** ```js try { const data = await breaches({ domain: "adobe.com" }); if (data) { // ... } else { // ... } } catch (err) { // ... } ``` <a name="dataClasses"></a> ## dataClasses([options]) ⇒ <code>Promise.<Array.<string>></code> \| <code>Promise.<null></code> Fetches all data classes in the system. **Kind**: global function **Returns**: <code>Promise.<Array.<string>></code> \| <code>Promise.<null></code> - a Promise which resolves to an array of strings (or null if no data classes were found), or rejects with an Error | Param | Type | Description | | --- | --- | --- | | [options] | <code>object</code> | a configuration object | | [options.baseUrl] | <code>string</code> | a custom base URL for the haveibeenpwned.com API endpoints (default: `https://haveibeenpwned.com/api/v3`) | | [options.timeoutMs] | <code>number</code> | timeout for the request in milliseconds (default: none) | | [options.userAgent] | <code>string</code> | a custom string to send as the User-Agent field in the request headers (default: `hibp <version>`) | **Example** ```js try { const data = await dataClasses(); if (data) { // ... } else { // ... } } catch (err) { // ... } ``` <a name="pasteAccount"></a> ## pasteAccount(email, [options]) ⇒ <code><a href="#paste--object">Promise.<Array.<Paste>></a></code> \| <code>Promise.<null></code> Fetches paste data for a specific account (email address). 🔑 `haveibeenpwned.com` requires an API key from https://haveibeenpwned.com/API/Key for the `pasteaccount` endpoint. The `apiKey` option here is not explicitly required, but direct requests made without it will fail (unless you specify a `baseUrl` to a proxy that inserts a valid API key on your behalf). **Kind**: global function **Returns**: <code><a href="#paste--object">Promise.<Array.<Paste>></a></code> \| <code>Promise.<null></code> - a Promise which resolves to an array of paste objects (or null if no pastes were found), or rejects with an Error | Param | Type | Description | | --- | --- | --- | | email | <code>string</code> | the email address to query | | [options] | <code>object</code> | a configuration object | | [options.apiKey] | <code>string</code> | an API key from https://haveibeenpwned.com/API/Key (default: undefined) | | [options.baseUrl] | <code>string</code> | a custom base URL for the haveibeenpwned.com API endpoints (default: `https://haveibeenpwned.com/api/v3`) | | [options.timeoutMs] | <code>number</code> | timeout for the request in milliseconds (default: none) | | [options.userAgent] | <code>string</code> | a custom string to send as the User-Agent field in the request headers (default: `hibp <version>`) | **Example** ```js try { const data = await pasteAccount("foo@bar.com", { apiKey: "my-api-key" }); if (data) { // ... } else { // ... } } catch (err) { // ... } ``` **Example** ```js try { const data = await pasteAccount("foo@bar.com", { baseUrl: "https://my-hibp-proxy:8080", }); if (data) { // ... } else { // ... } } catch (err) { // ... } ``` <a name="pwnedPasswordRange"></a> ## pwnedPasswordRange(prefix, [options]) ⇒ [<code>Promise.<PwnedPasswordSuffixes></code>](#PwnedPasswordSuffixes) Fetches the SHA-1 or NTLM hash suffixes for the given 5-character hash prefix. When a password hash with the same first 5 characters is found in the Pwned Passwords repository, the API will respond with an HTTP 200 and include the suffix of every hash beginning with the specified prefix, followed by a count of how many times it appears in the data set. This function parses the response and returns a more structured format. **Kind**: global function **Returns**: [<code>Promise.<PwnedPasswordSuffixes></code>](#PwnedPasswordSuffixes) - a Promise which resolves to an object mapping the `suffix` that when matched with the prefix composes the complete hash, to the `count` of how many times it appears in the breached password data set, or rejects with an Error **See**: https://haveibeenpwned.com/api/v3#SearchingPwnedPasswordsByRange | Param | Type | Description | | --- | --- | --- | | prefix | <code>string</code> | the first 5 characters of a password hash (case insensitive) | | [options] | <code>object</code> | a configuration object | | [options.addPadding] | <code>boolean</code> | ask the remote API to add padding to the response to obscure the password prefix (default: `false`) | | [options.mode] | <code>'sha1'</code> \| <code>'ntlm'</code> | return SHA-1 or NTLM hashes (default: `sha1`) | | [options.baseUrl] | <code>string</code> | a custom base URL for the pwnedpasswords.com API endpoints (default: `https://api.pwnedpasswords.com`) | | [options.timeoutMs] | <code>number</code> | timeout for the request in milliseconds (default: none) | | [options.userAgent] | <code>string</code> | a custom string to send as the User-Agent field in the request headers (default: `hibp <version>`) | **Example** ```js try { const results = await pwnedPasswordRange("5BAA6"); // results will have the following shape: // { // "003D68EB55068C33ACE09247EE4C639306B": 3, // "012C192B2F16F82EA0EB9EF18D9D539B0DD": 1, // ... // } } catch (err) { // ... } ``` **Example** ```js try { const suffix = "1E4C9B93F3F0682250B6CF8331B7EE68FD8"; const results = await pwnedPasswordRange("5BAA6"); const numPwns = results[suffix] || 0; } catch (err) { // ... } ``` <a name="pwnedPassword"></a> ## pwnedPassword(password, [options]) ⇒ <code>Promise.<number></code> Fetches the number of times the the given password has been exposed in a breach (0 indicating no exposure). The password is given in plain text, but only the first 5 characters of its SHA-1 hash will be submitted to the API. **Kind**: global function **Returns**: <code>Promise.<number></code> - a Promise which resolves to the number of times the password has been exposed in a breach, or rejects with an Error **See**: https://haveibeenpwned.com/api/v3#PwnedPasswords | Param | Type | Description | | --- | --- | --- | | password | <code>string</code> | a password in plain text | | [options] | <code>object</code> | a configuration object | | [options.addPadding] | <code>boolean</code> | ask the remote API to add padding to the response to obscure the password prefix (default: `false`) | | [options.baseUrl] | <code>string</code> | a custom base URL for the pwnedpasswords.com API endpoints (default: `https://api.pwnedpasswords.com`) | | [options.timeoutMs] | <code>number</code> | timeout for the request in milliseconds (default: none) | | [options.userAgent] | <code>string</code> | a custom string to send as the User-Agent field in the request headers (default: `hibp <version>`) | **Example** ```js try { const numPwns = await pwnedPassword("f00b4r"); // truthy check or numeric condition if (numPwns) { // ... } else { // ... } } catch (err) { // ... } ``` <a name="search"></a> ## search(account, [options]) ⇒ [<code>Promise.<SearchResults></code>](#SearchResults) Fetches all breaches and all pastes associated with the provided account (email address or username). Note that the remote API does not support querying pastes by username (only email addresses), so in the event the provided account is not a valid email address, only breach data is queried and the "pastes" field of the resulting object will always be null. This is exactly how searching via the current web interface behaves, which this convenience method is designed to mimic. 🔑 `haveibeenpwned.com` requires an API key from https://haveibeenpwned.com/API/Key for the `breachedaccount` and `pasteaccount` endpoints. The `apiKey` option here is not explicitly required, but direct requests made without it will fail (unless you specify a `baseUrl` to a proxy that inserts a valid API key on your behalf). **Kind**: global function **Returns**: [<code>Promise.<SearchResults></code>](#SearchResults) - a Promise which resolves to an object containing a "breaches" key (which can be null or an array of breach objects) and a "pastes" key (which can be null or an array of paste objects), or rejects with an Error **See**: https://haveibeenpwned.com/ | Param | Type | Description | | --- | --- | --- | | account | <code>string</code> | an email address or username | | [options] | <code>object</code> | a configuration object | | [options.apiKey] | <code>string</code> | an API key from https://haveibeenpwned.com/API/Key (default: undefined) | | [options.domain] | <code>string</code> | a domain by which to filter the breach results (default: all domains) | | [options.truncate] | <code>boolean</code> | truncate the breach results to only include the name of each breach (default: true) | | [options.baseUrl] | <code>string</code> | a custom base URL for the haveibeenpwned.com API endpoints (default: `https://haveibeenpwned.com/api/v3`) | | [options.timeoutMs] | <code>number</code> | timeout for the request in milliseconds (default: none) | | [options.userAgent] | <code>string</code> | a custom string to send as the User-Agent field in the request headers (default: `hibp <version>`) | **Example** ```js try { const data = await search("foo", { apiKey: "my-api-key" }); if (data.breaches || data.pastes) { // ... } else { // ... } } catch (err) { // ... } ``` **Example** ```js try { const data = await search("nobody@nowhere.com", { baseUrl: "https://my-hibp-proxy:8080", truncate: false, }); if (data.breaches || data.pastes) { // ... } else { // ... } } catch (err) { // ... } ``` <a name="subscriptionStatus"></a> ## subscriptionStatus([options]) ⇒ [<code>Promise.<SubscriptionStatus></code>](#subscriptionstatus--object) Fetches the current status of your HIBP subscription (API key). 🔑 `haveibeenpwned.com` requires an API key from https://haveibeenpwned.com/API/Key for the `subscription/status` endpoint. The `apiKey` option here is not explicitly required, but direct requests made without it will fail (unless you specify a `baseUrl` to a proxy that inserts a valid API key on your behalf). **Kind**: global function **Returns**: [<code>Promise.<SubscriptionStatus></code>](#subscriptionstatus--object) - a Promise which resolves to a subscription status object, or rejects with an Error | Param | Type | Description | | --- | --- | --- | | [options] | <code>object</code> | a configuration object | | [options.apiKey] | <code>string</code> | an API key from https://haveibeenpwned.com/API/Key (default: undefined) | | [options.baseUrl] | <code>string</code> | a custom base URL for the haveibeenpwned.com API endpoints (default: `https://haveibeenpwned.com/api/v3`) | | [options.timeoutMs] | <code>number</code> | timeout for the request in milliseconds (default: none) | | [options.userAgent] | <code>string</code> | a custom string to send as the User-Agent field in the request headers (default: `hibp <version>`) | **Example** ```js try { const data = await subscriptionStatus({ apiKey: "my-api-key" }); // ... } catch (err) { // ... } ``` **Example** ```js try { const data = await subscriptionStatus({ baseUrl: "https://my-hibp-proxy:8080", }); // ... } catch (err) { // ... } ``` <a name="Breach"></a> ## Breach : <code>object</code> An object representing a breach. **Kind**: global typedef **Properties** | Name | Type | | --- | --- | | Name | <code>string</code> | | Title | <code>string</code> | | Domain | <code>string</code> | | BreachDate | <code>string</code> | | AddedDate | <code>string</code> | | ModifiedDate | <code>string</code> | | PwnCount | <code>number</code> | | Description | <code>string</code> | | DataClasses | <code>Array.<string></code> | | IsVerified | <code>boolean</code> | | IsFabricated | <code>boolean</code> | | IsSensitive | <code>boolean</code> | | IsRetired | <code>boolean</code> | | IsSpamList | <code>boolean</code> | | IsMalware | <code>boolean</code> | | IsSubscriptionFree | <code>boolean</code> | | LogoPath | <code>string</code> | <a name="Paste"></a> ## Paste : <code>object</code> An object representing a paste. **Kind**: global typedef **Properties** | Name | Type | | --- | --- | | Id | <code>string</code> | | Source | <code>string</code> | | Title | <code>string</code> | | Date | <code>string</code> | | EmailCount | <code>number</code> | <a name="PwnedPasswordSuffixes"></a> ## PwnedPasswordSuffixes : <code>Object.<string, number></code> An object mapping an exposed password hash suffix (corresponding to a given hash prefix) to how many times it occurred in the Pwned Passwords repository. **Kind**: global typedef <a name="SearchResults"></a> ## SearchResults : <code>object</code> An object representing search results. **Kind**: global typedef **Properties** | Name | Type | | --- | --- | | breaches | [<code>Array.<Breach></code>](#breach--object) \| <code>null</code> | | pastes | [<code>Array.<Paste></code>](#Paste) \| <code>null</code> | <a name="SubscriptionStatus"></a> ## SubscriptionStatus : <code>object</code> An object representing the status of your HIBP subscription. **Kind**: global typedef **Properties** | Name | Type | | --- | --- | | SubscriptionName | <code>string</code> | | Description | <code>string</code> | | SubscribedUntil | <code>string</code> | | Rpm | <code>number</code> | | DomainSearchMaxBreachedAccounts | <code>number</code> |