
CLI tool to query the Have I Been Pwned API for breached accounts, pastes, and password exposure, enabling rapid security assessment of compromised credentials.
A command-line tool for querying [Troy Hunt][troy]'s [Have I been pwned?][haveibeenpwned] service using the [hibp][hibp] Node.js module.
[![npm Version][npm-image]][npm-url] [![Build Status][ci-image]][ci-url]
Download and install [Node.js][nodejs], then install pwned globally using npm:
npm install pwned -g
Alternatively, you can run it on-demand using the [npx][npx] package runner:
npx pwned
On July 18th, 2019, the haveibeenpwned.com API moved several services behind authentication,
requiring an API key. See [Troy's blog post][api-key-blog-post] for rationale and a full
explanation. Commands are grouped below by the [HIBP plans][hibp-plans] whose API key unlocks them.
To use a protected command, [get an API key][get-api-key] and run pwned apiKey to configure
pwned.
breach, breaches, dc, dcd, lb, pw
ba, pa, search, subStatus
bd, sd
bar
gdt, se, slbe, slbed, slbwd, vdt
pwned <command>
Commands:
pwned apiKey [key] set the API key to be used for authenticated requests
pwned ba <account|email> get all breaches for an account (username or email address)
pwned bar <email> get all breaches for an email address using k-anonymity
pwned bd <domain> get all breached email addresses for a domain
pwned breach <name> get a single breached site by breach name
pwned breaches get all breaches in the system
pwned dc get all data classes in the system
pwned dcd get all data classes in the system with descriptions
pwned gdt <domain> generate a DNS TXT record value to verify a domain
pwned lb get the most recently added breach
pwned pa <email> get all pastes for an account (email address)
pwned pw <password> securely check a password for public exposure
pwned sd get all subscribed domains for your account
pwned se <domain> <alias> send a domain verification approval email
pwned search <account|email> search breaches and pastes for an account (username or email
address)
pwned slbe <email> get all stealer log domains for an email address
pwned slbed <email-domain> get all stealer log email aliases for an email domain
pwned slbwd <website-domain> get all stealer log email addresses for a website domain
pwned subStatus get the subscription status of your API key
pwned vdt <domain> verify a domain using its published DNS TXT record
Options:
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
Get all breaches for an account:
$ pwned ba [email protected]
✔ Good news — no pwnage found!
Get all breaches in the system, filtering results to just the 'adobe.com' domain:
$ pwned breaches -d adobe.com
-
Title: Adobe
Name: Adobe
Domain: adobe.com
BreachDate: 2013-10-04
AddedDate: 2013-12-04T00:00:00Z
ModifiedDate: 2013-12-04T00:00:00Z
PwnCount: 152445165
Description: In October 2013, 153 million Adobe accounts were breached with each containing an internal ID, username, email, <em>encrypted</em> password and a password hint in plain text. The password cryptography was poorly done and <a href="http://stricture-group.com/files/adobe-top100.txt" target="_blank" rel="noopener">many were quickly resolved back to plain text</a>. The unencrypted hints also <a href="http://www.troyhunt.com/2013/11/adobe-credentials-and-serious.html" target="_blank" rel="noopener">disclosed much about the passwords</a> adding further to the risk that hundreds of millions of Adobe customers already faced.
DataClasses:
- Email addresses
- Password hints
- Passwords
- Usernames
IsVerified: true
IsFabricated: false
IsSensitive: false
IsActive: true
IsRetired: false
IsSpamList: false
LogoType: svg
Get a single breached site by breach name:
$ pwned breach MyCompany
✔ No breach found by that name.
Get all the data classes in the system, returning raw JSON results for external/chained consumption:
$ pwned dc --raw
["Account balances","Address book contacts","Age groups","Ages","Apps installed on devices","Astrological signs","Auth tokens","Avatars","Bank account numbers","Banking PINs","Beauty ratings","Biometric data","Browser user agent details","Buying preferences","Car ownership statuses","Career levels","Cellular network names","Charitable donations","Chat logs","Credit card CVV","Credit cards","Credit status information","Customer feedback","Customer interactions","Dates of birth","Deceased date","Deceased statuses","Device information","Device usage tracking data","Drinking habits","Drug habits","Eating habits","Education levels","Email addresses","Email messages","Employers","Ethnicities","Family members' names","Family plans","Family structure","Financial investments","Financial transactions","Fitness levels","Genders","Geographic locations","Government issued IDs","Health insurance information","Historical passwords","Home ownership statuses","Homepage URLs","IMEI numbers","IMSI numbers","Income levels","Instant messenger identities","IP addresses","Job titles","MAC addresses","Marital statuses","Names","Nationalities","Net worths","Nicknames","Occupations","Parenting plans","Partial credit card data","Passport numbers","Password hints","Passwords","Payment histories","Payment methods","Personal descriptions","Personal health data","Personal interests","Phone numbers","Physical addresses","Physical attributes","Political donations","Political views","Private messages","Professional skills","Profile photos","Purchases","Purchasing habits","Races","Recovery email addresses","Relationship statuses","Religions","Reward program balances","Salutations","School grades (class levels)","Security questions and answers","Sexual fetishes","Sexual orientations","Smoking habits","SMS messages","Social connections","Social media profiles","Spoken languages","Support tickets","Survey results","Time zones","Travel habits","User statuses","User website URLs","Usernames","Utility bills","Vehicle details","Website activity","Work habits","Years of birth","Years of professional experience"]
Get all pastes for an email address: