WebService::HIBP::Breach - An instance of a breach from the Have I Been Pwned webservice at haveibeenpwned.com
Version 0.11
Check the security of your accounts/email addresses and passwords
use WebService::HIBP(); use v5.10; my $hibp = WebService::HIBP->new(); foreach my $breach (sort { $a->added_date() cmp $b->added_date() } $hibp->breaches()) { say $breach->description(); }
Each breach contains a number of attributes describing the incident. In the future, these attributes may expand without the API being versioned.
A creation method that should only be called by WebService::HIBP.
A camel-cased name representing the breach which is unique across all other breaches. This value never changes and may be used to name dependent assets (such as images) but should not be shown directly to end users (see the title attribute instead).
A descriptive title for the breach suitable for displaying to end users. It's unique across all breaches but individual values may change in the future (i.e. if another breach occurs against an organisation already in the system). If a stable value is required to reference the breach, refer to the name attribute instead.
The domain of the primary website the breach occurred on. This may be used for identifying other assets external systems may have for the site.
The date (with no time) the breach originally occurred on in ISO 8601 format. This is not always accurate - frequently breaches are discovered and reported long after the original incident. Use this attribute as a guide only.
The date and time (precision to the minute) the breach was added to the system in ISO 8601 format.
The date and time (precision to the minute) the breach was modified in ISO 8601 format. This will only differ from the added_date attribute if other attributes represented here are changed or data in the breach itself is changed (i.e. additional data is identified and loaded). It is always either equal to or greater then the added_date attribute, never less than.
The total number of accounts loaded into the system. This is usually less than the total number reported by the media due to duplication or other data integrity issues in the source data.
Contains an overview of the breach represented in HTML markup. The description may include markup such as emphasis and strong tags as well as hyperlinks.
This attribute describes the nature of the data compromised in the breach and contains an alphabetically ordered string list of impacted data classes.
Indicates that the breach is considered unverified. An unverified breach may not have been hacked from the indicated website. An unverified breach is still loaded into HIBP when there's sufficient confidence that a significant portion of the data is legitimate.
Indicates that the breach is considered fabricated. A fabricated breach is unlikely to have been hacked from the indicated website and usually contains a large amount of manufactured data. However, it still contains legitimate email addresses and asserts that the account owners were compromised in the alleged breach.
Indicates if the breach is considered sensitive. The public API will not return any accounts for a breach flagged as sensitive.
Indicates if the breach has been retired. This data has been permanently removed and will not be returned by the API.
Indicates if the breach is considered a spam list. This flag has no impact on any other attributes but it means that the data has not come as a result of a security compromise.
No documentation for this yet. May be removed without notice.
None.
WebService::HIBP::Breach requires no configuration files or environment variables.
WebService::HIBP requires no non-core modules
None reported
Please report any bugs or feature requests to bug-webservice-hibp at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=WebService-HIBP. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
bug-webservice-hibp at rt.cpan.org
David Dick, <ddick at cpan.org>
<ddick at cpan.org>
You can find documentation for this module with the perldoc command.
perldoc WebService::HIBP
You can also look for information at:
RT: CPAN's request tracker (report bugs here)
http://rt.cpan.org/NoAuth/Bugs.html?Dist=WebService-HIBP
AnnoCPAN: Annotated CPAN documentation
http://annocpan.org/dist/WebService-HIBP
CPAN Ratings
http://cpanratings.perl.org/d/WebService-HIBP
Search CPAN
http://search.cpan.org/dist/WebService-HIBP/
Thanks to Troy Hunt for providing the service at https://haveibeenpwned.com
POD was extracted from the API help at https://haveibeenpwned.com/API/v2
Copyright 2019 David Dick.
This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.
See http://dev.perl.org/licenses/ for more information.
To install WebService::HIBP, copy and paste the appropriate command in to your terminal.
cpanm
cpanm WebService::HIBP
CPAN shell
perl -MCPAN -e shell install WebService::HIBP
For more information on module installation, please visit the detailed CPAN module installation guide.