ByteDev.PwnedPasswords 2.0.0

.NET Standard library to communicate with Troy Hunt's PwnedPasswords API.

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

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

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

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 client = new PwnedPasswordsClient(new HttpClient());

var result = await client.GetHasBeenPwnedAsync("Password1");

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

Version 2.0 changes

A number of breaking changes were made from version 1.1. to 2.0:

  • PwnedPasswordsClient now takes a simple string for the password (as the API only takes a hash of the password theres no need for the consumer to supply a HashedPassword object)
  • IPwnedPasswordsClient interface now provided
  • PwnedPasswordsClient needs to be provided with an implementation of HttpClient on construction
  • PwnedPasswordsClient.GetHasBeenPwnedAsync method now takes optional CancellationToken

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:

ByteDev.PwnedPasswords

Provides client 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.

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

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

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 client = new PwnedPasswordsClient(new HttpClient());

var result = await client.GetHasBeenPwnedAsync("Password1");

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

Version 2.0 changes

A number of breaking changes were made from version 1.1. to 2.0:

  • PwnedPasswordsClient now takes a simple string for the password (as the API only takes a hash of the password theres no need for the consumer to supply a HashedPassword object)
  • IPwnedPasswordsClient interface now provided
  • PwnedPasswordsClient needs to be provided with an implementation of HttpClient on construction
  • PwnedPasswordsClient.GetHasBeenPwnedAsync method now takes optional CancellationToken

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:

Dependencies

This package has no dependencies.

This package is not used by any popular GitHub repositories.

Version History

Version Downloads Last updated
2.0.0 66 6/30/2019
1.1.0 309 4/30/2018
1.0.1 302 4/9/2018