ByteDev.PwnedPasswords 1.1.0

There is a newer version of this package available.
See the version list below for details.
Install-Package ByteDev.PwnedPasswords -Version 1.1.0
dotnet add package ByteDev.PwnedPasswords --version 1.1.0
<PackageReference Include="ByteDev.PwnedPasswords" Version="1.1.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add ByteDev.PwnedPasswords --version 1.1.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: ByteDev.PwnedPasswords, 1.1.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.PwnedPasswords as a Cake Addin
#addin nuget:?package=ByteDev.PwnedPasswords&version=1.1.0

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

ByteDev.PwnedPasswords

Provides client functionality to talk to the 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.

Code

The repo can be cloned from git bash:

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

Unit tests and integration tests are also provided in the solution.

Usage

The PwnedPasswordsClient class has (since v1.1) only one public method:

  • GetHasBeenPwnedAsync(HashedPassword hashedPassword)

This 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.

Example

var hashedPassword = new HashedPassword("12345");

var client = new PwnedPasswordsClient();

var result = await client.GetHasBeenPwnedAsync(hashedPassword);

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

Changes in v1.1

There used to be 3 different ways you could call the API:

  1. Search with clear text password
  2. Search with SHA1 hash of password
  3. Search with partial SHA1 hash of password

However, as of 1st June 2018 the API will be changed to only support option 3 (partial hash). Version 1.1 of this project now only supports partial hash searches.

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:

  • .NETStandard 2.0

    • No dependencies.

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
2.0.3 1,389 7/24/2020
2.0.2 249 7/2/2020
2.0.1 540 12/2/2019
2.0.0 369 6/30/2019
1.1.0 764 4/30/2018
1.0.1 684 4/9/2018