Skip to content

Commit 92543a6

Browse files
authored
Merge pull request #45 from R1sh0bh-1/add-hibp-analyzers-docs
docs: add HibpBreaches and HibpPasswords to usage.md and advanced_usa…
2 parents 38bce8f + bfb755b commit 92543a6

2 files changed

Lines changed: 7 additions & 0 deletions

File tree

docs/IntelOwl/advanced_usage.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -284,6 +284,11 @@ Some analyzers could require a special configuration:
284284
- `waiting_time`: Determines the waiting time for the page to load during the scan (in seconds).
285285
- `private_scan`: When set to `true`, the scan results will not be shared with other `urlDNA.io` users.
286286
- `scanned_from`: Allows selecting the country of origin for the scan using a two-letter country code (ISO 3166-1 alpha-2). This feature is available only to `urlDNA.io` Premium Users.
287+
- `HibpBreaches` and `HibpPasswords` (HaveIBeenPwned family):
288+
- Both use the [HaveIBeenPwned API](https://haveibeenpwned.com/API/v3). HibpBreaches requires an API key (use dummy `00000000000000000000000000000000` for testing); HibpPasswords needs none.
289+
- HibpBreaches supports email (generic) and domain; domain uses public endpoint (limited results — no leaked emails without paid verification).
290+
- Optional params for HibpBreaches: `truncate_response` (less data), `include_unverified` (show unverified breaches).
291+
- HibpPasswords uses privacy-safe k-anonymity (SHA-1 prefix only; full password never sent).
287292
- `MobSF_Service`:
288293
- The `MobSF_Service` analyzer offers various configurable parameters to optimize the automated scanning of the application as per one's requirement.
289294
- `enable_dynamic_analysis`: Set to `True` to enable dynamic analysis though this will increase the scan time.

docs/IntelOwl/usage.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -281,6 +281,8 @@ Some analyzers require details other than just IP, URL, Domain, etc. We classifi
281281
- `Dehashed_Search`: Query any observable/keyword against https://dehashed.com's search API.
282282
- `EmailRep`: search an email address on [emailrep.io](https://emailrep.io)
283283
- `HaveIBeenPwned`: [HaveIBeenPwned](https://haveibeenpwned.com/API/v3) checks if an email address has been involved in a data breach
284+
- `HibpBreaches` : Checks email addresses and domains for data breaches using [HaveIBeenPwned](https://haveibeenpwned.com/API/v3) public API endpoints. Requires API key (test key available). Domain results are limited without paid verification.
285+
- `HibpPasswords` : Checks if a password has been exposed using [HaveIBeenPwned](https://haveibeenpwned.com/API/v3#PwnedPasswords) k-anonymity range search (SHA-1 prefix only). No API key required.
284286
- `IntelX_Intelligent_Search`: [IntelligenceX](https://intelx.io/) is a search engine and data archive. Fetches emails, urls, domains associated with an observable or a generic string.
285287
- `IntelX_Phonebook`: [IntelligenceX](https://intelx.io/) is a search engine and data archive. Fetches emails, urls, domains associated with an observable or a generic string.
286288
- `IPQS_Fraud_And_Risk_Scoring`: Scan an Observable against [IPQualityscore](https://www.ipqualityscore.com/)

0 commit comments

Comments
 (0)