ByteDev.Hibp 4.0.1

.NET Standard 2.0
dotnet add package ByteDev.Hibp --version 4.0.1
NuGet\Install-Package ByteDev.Hibp -Version 4.0.1
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.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add ByteDev.Hibp --version 4.0.1
#r "nuget: ByteDev.Hibp, 4.0.1"
#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.1

// Install ByteDev.Hibp as a Cake Tool
#tool nuget:?package=ByteDev.Hibp&version=4.0.1

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.

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 Versions
.NET net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows net7.0 net7.0-android net7.0-ios net7.0-maccatalyst net7.0-macos net7.0-tvos net7.0-windows
.NET Core netcoreapp2.0 netcoreapp2.1 netcoreapp2.2 netcoreapp3.0 netcoreapp3.1
.NET Standard netstandard2.0 netstandard2.1
.NET Framework net461 net462 net463 net47 net471 net472 net48 net481
MonoAndroid monoandroid
MonoMac monomac
MonoTouch monotouch
Tizen tizen40 tizen60
Xamarin.iOS xamarinios
Xamarin.Mac xamarinmac
Xamarin.TVOS xamarintvos
Xamarin.WatchOS xamarinwatchos
Compatible target framework(s)
Additional computed target framework(s)
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 296 6/29/2022
4.0.0 283 7/15/2021
3.0.0 393 7/24/2020
2.2.0 406 1/29/2020
2.1.0 459 8/17/2019
2.0.1 429 7/22/2019
2.0.0 436 7/22/2019
1.0.0 581 11/9/2018