ByteDev.PwnedPasswords 1.0.1

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

// Install ByteDev.PwnedPasswords as a Cake Tool
#tool nuget:?package=ByteDev.PwnedPasswords&version=1.0.1
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.

Code

Clone the git repository:

git clone https://bytedev@bitbucket.org/bytedev/bytedev.pwnedpasswords.git

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.

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

Usage

Once you have a reference to ByteDev.PwnedPasswords there are 3 ways to search for a password:

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

The PwnedPasswordsClient class has two public methods to provide the functionality above:

  • GetHasBeenPwnedAsync(string password): Use to search by clear password
  • GetHasBeenPwnedAsync(HashedPassword hashedPassword, bool sendPrefixOnly = false): Use to search by SHA1 hash. To search only by the prefix of the hash pass in true for the sendPrefixOnly parameter.

Both of 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.

Further usage examples can be seen in the integration tests project (ByteDev.PwnedPasswords.IntTests).

Further information

See the following for more information:

  • .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,387 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