ByteDev.Hibp 4.0.0

Install-Package ByteDev.Hibp -Version 4.0.0
dotnet add package ByteDev.Hibp --version 4.0.0
<PackageReference Include="ByteDev.Hibp" Version="4.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add ByteDev.Hibp --version 4.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: ByteDev.Hibp, 4.0.0"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install ByteDev.Hibp as a Cake Addin
#addin nuget:?package=ByteDev.Hibp&version=4.0.0

// Install ByteDev.Hibp as a Cake Tool
#tool nuget:?package=ByteDev.Hibp&version=4.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

ByteDev.Hibp

Provides simple client to talk to the "Have I been Pwned?" API as hosted by Troy Hunt.

Installation

ByteDev.Hibp has been written as a .NET Standard 2.0 library, so you can consume it from a .NET Core or .NET Framework 4.6.1 (or greater) application.

ByteDev.Hibp is hosted as a package on nuget.org. To install from the Package Manager Console in Visual Studio run:

Install-Package ByteDev.Hibp

Further details can be found on the nuget page.

Release Notes

Releases follow semantic versioning.

Full details of the release notes can be viewed on GitHub.

Usage

The HibpClient class currently has a number of public methods:

  • GetAccountBreachesAsync(string emailAddress, HibpRequestOptions options = null)
  • GetBreachedSitesAsync(string domain = null)
  • GetBreachSiteByNameAsync(string breachName)
  • GetDataClassesAsync()
  • GetAccountPastesAsync(string emailAddress)

Note: Methods GetAccountBreachesAsync and GetAccountPastesAsync require a valid API key be provided (via the HibpClient constructor).

Example

var options = new HibpClientOptions
{
    ApiKey = "someApiKey",
    RetryOnRateLimitExceeded = true
};

IHibpClient client = new HibpClient(new HttpClient(), options);

var result = await client.GetAccountBreachesAsync("johnsmith@gmail.com");

Console.WriteLine($"Number of breaches: {result.Count()}");

Glossary

Account = Represented by an email address.

Breach = An instance of a system having been compromised by an attacker and the data disclosed.

Data Class = An attribute of a record compromised in a breach. For example, many breaches expose data classes such as "Email addresses" and "Passwords". A complete list of all data classes can be obtained by calling the GetDataClassesAsync method.

Pastes = Text pasted onto a website whereupon it receives its own unique URL so that it can then be shared with others who may want to view the paste.

Further Information

See the following for more general information:

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
4.0.0 83 7/15/2021
3.0.0 222 7/24/2020
2.2.0 232 1/29/2020
2.1.0 290 8/17/2019
2.0.1 259 7/22/2019
2.0.0 255 7/22/2019
1.0.0 392 11/9/2018