ByteDev.Hibp 2.1.0

.NET Standard library to help communicate with the "Have I been Pwned?" API as hosted by Troy Hunt.

Install-Package ByteDev.Hibp -Version 2.1.0
dotnet add package ByteDev.Hibp --version 2.1.0
<PackageReference Include="ByteDev.Hibp" Version="2.1.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add ByteDev.Hibp --version 2.1.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.

Code

The repo can be cloned from git bash:

git clone https://github.com/ByteDev/ByteDev.Hibp

Integration tests are also provided in the solution.

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)

Example

var client = new HibpClient(new HttpClient());

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

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

Further Information

See the following for more general information:

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.

Code

The repo can be cloned from git bash:

git clone https://github.com/ByteDev/ByteDev.Hibp

Integration tests are also provided in the solution.

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)

Example

var client = new HibpClient(new HttpClient());

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

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

Further Information

See the following for more general information:

Dependencies

This package has no dependencies.

This package is not used by any popular GitHub repositories.

Version History

Version Downloads Last updated
2.1.0 53 8/17/2019
2.0.1 52 7/22/2019
2.0.0 51 7/22/2019
1.0.0 131 11/9/2018