ByteDev.PwnedPasswords
2.0.3
dotnet add package ByteDev.PwnedPasswords --version 2.0.3
NuGet\Install-Package ByteDev.PwnedPasswords -Version 2.0.3
<PackageReference Include="ByteDev.PwnedPasswords" Version="2.0.3" />
paket add ByteDev.PwnedPasswords --version 2.0.3
#r "nuget: ByteDev.PwnedPasswords, 2.0.3"
// 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 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. |
-
.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
|