ByteDev.Hibp 4.0.0

There is a newer version of this package available.
See the version list below for details.
dotnet add package ByteDev.Hibp --version 4.0.0
NuGet\Install-Package ByteDev.Hibp -Version 4.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<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
#r "nuget: ByteDev.Hibp, 4.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. 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

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:

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

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.1 453 6/29/2022
4.0.0 375 7/15/2021
3.0.0 497 7/24/2020
2.2.0 513 1/29/2020
2.1.0 562 8/17/2019
2.0.1 517 7/22/2019
2.0.0 548 7/22/2019
1.0.0 713 11/9/2018