ByteDev.PwnedPasswords 1.0.1

.NET Standard 2.0
There is a newer version of this package available.
See the version list below for details. 
dotnet add package ByteDev.PwnedPasswords --version 1.0.1
NuGet\Install-Package ByteDev.PwnedPasswords -Version 1.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.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
#r "nuget: ByteDev.PwnedPasswords, 1.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.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

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:

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
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 9,883 7/24/2020
2.0.2 464 7/2/2020
2.0.1 784 12/2/2019
2.0.0 629 6/30/2019
1.1.0 1,109 4/30/2018
1.0.1 1,018 4/9/2018