ByteDev.PwnedPasswords 2.0.3

.NET Standard 2.0
dotnet add package ByteDev.PwnedPasswords --version 2.0.3
NuGet\Install-Package ByteDev.PwnedPasswords -Version 2.0.3
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.PwnedPasswords" Version="2.0.3" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add ByteDev.PwnedPasswords --version 2.0.3
#r "nuget: ByteDev.PwnedPasswords, 2.0.3"
#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.PwnedPasswords as a Cake Addin
#addin nuget:?package=ByteDev.PwnedPasswords&version=2.0.3

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

ByteDev.PwnedPasswords

.NET Standard library that provides client SDK functionality to talk to Troy Hunt's Pwnedpasswords API and check whether a particular password has been pwned and if so how many occurrences there have been.

Installation

ByteDev.PwnedPasswords 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.PwnedPasswords is hosted as a package on nuget.org. To install from the Package Manager Console in Visual Studio run:

Install-Package ByteDev.PwnedPasswords

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 PwnedPasswordsClient class has two public methods:

  • GetHasBeenPwnedAsync(string password)
  • GetHasBeenPwnedAsync(string password, CancellationToken cancellationToken)

These methods will return a PwnedPasswordResponse object containing details of whether the password has been pwned and a count of how many times.

If the PwnedPasswordsClient class has any problems getting the details for a password it will throw an PwnedPasswordsClientException.

IPwnedPasswordsClient client = new PwnedPasswordsClient(new HttpClient());

PwnedPasswordResponse response = await client.GetHasBeenPwnedAsync("Password1");

Console.WriteLine($"Has Password been pwned: {response.IsPwned}.");
Console.WriteLine($"Password has been pwned {response.Count} times.");

Further information

See the following for more general information:

See the following to changes to the API to only support partial hash (range) only searches:

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
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.
  • .NETStandard 2.0

    • No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories (1)

Showing the top 1 popular GitHub repositories that depend on ByteDev.PwnedPasswords:

Repository Stars
johnstaveley/SecurityEssentials
Raise your baseline in security by using this as your template instead of default Mvc project. Keep your app secure by continuously applying Security rules
Version Downloads Last updated
2.0.3 4,731 7/24/2020
2.0.2 341 7/2/2020
2.0.1 643 12/2/2019
2.0.0 486 6/30/2019
1.1.0 937 4/30/2018
1.0.1 847 4/9/2018