HaveIBeenPwned.Client.PollyExtensions 8.0.2

dotnet add package HaveIBeenPwned.Client.PollyExtensions --version 8.0.2
NuGet\Install-Package HaveIBeenPwned.Client.PollyExtensions -Version 8.0.2
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="HaveIBeenPwned.Client.PollyExtensions" Version="8.0.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add HaveIBeenPwned.Client.PollyExtensions --version 8.0.2
#r "nuget: HaveIBeenPwned.Client.PollyExtensions, 8.0.2"
#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 HaveIBeenPwned.Client.PollyExtensions as a Cake Addin
#addin nuget:?package=HaveIBeenPwned.Client.PollyExtensions&version=8.0.2

// Install HaveIBeenPwned.Client.PollyExtensions as a Cake Tool
#tool nuget:?package=HaveIBeenPwned.Client.PollyExtensions&version=8.0.2

';-- have i been pwned? — .NET HTTP client.

build code analysis NuGet nuget downloads

HaveIBeenPwned.Client is a .NET HTTP client for the "have i been pwned" API service from Troy Hunt. This library is comprised of three NuGet packages:

Consumers of the API can use the abstractions for the models returned from the API, while server APIs can consume and wrap the client.

Getting started

Install from the .NET CLI:

dotnet add package HaveIBeenPwned.Client

Alternatively add manually to your consuming .csproj:

<PackageReference Include="HaveIBeenPwned.Client" Version="{VersionNumber}" />

Or, install using the NuGet Package Manager:

Install-Package HaveIBeenPwned.Client

Dependency injection

To add all of the services to the dependency injection container, call one of the AddPwnedServices overloads. From Minimal APIs for example, with using a named configuration section:

builder.Services.AddPwnedServices(
    builder.Configuration.GetSection(nameof(HibpOptions)));

From a ConfigureServices method, with an IConfiguration instance:

services.AddPwnedServices(options =>
    {
        options.ApiKey = _configuration["HibpOptions:ApiKey"];
        options.UserAgent = _configuration["HibpOptions:UserAgent"];
    });

Then you can require any of the available DI-ready types:

  • IPwnedBreachesClient: Breaches API.
  • IPwnedPastesClient: Pastes API.
  • IPwnedPasswordsClient: Pwned Passwords API.
  • IPwnedClient: Marker interface, for conveniently injecting all of the above clients into a single client.

Without dependency injection

If you're not using the DI approach, simply instaniate PwnedClient with your API key and use it as you see fit.

IPwnedClient client = new PwnedClient("<API Key>");
// TODO: Use client...

Example Minimal APIs

Minimal APIs example code.

Configuration

To configure the HaveIBeenPwned.Client, the following table identifies the well-known configuration object:

Well-known keys

Depending on the .NET configuration provider your app is using, there are several well-known keys that map to the HibpOptions that configure your usage of the HTTP client. When using environment variables, such as those in Azure App Service configuration or Azure Key Vault secrets, the following keys map to the HibpOption instance:

Key Data type Default value
HibpOptions__ApiKey string null
HibpOptions__UserAgent string ".NET HIBP Client/{AssemblyFileVersion}"

The ApiKey is required, to get one — sign up here: https://haveibeenpwned.com/api/key

Example appsettings.json

{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft": "Warning",
      "Microsoft.Hosting.Lifetime": "Information"
    }
  },
  "AllowedHosts": "*",
  "HibpOptions": {
    "ApiKey": "<YourApiKey>",
    "UserAgent": "<YourUserAgent>"
  }
}

For more information, see JSON configuration provider.

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories (1)

Showing the top 1 popular GitHub repositories that depend on HaveIBeenPwned.Client.PollyExtensions:

Repository Stars
IEvangelist/learning-blazor
The application for the "Learning Blazor: Build Single Page Apps with WebAssembly and C#" O'Reilly Media book by David Pine.
Version Downloads Last updated
8.0.2 73 5/2/2024
8.0.1 250 2/8/2024
8.0.0 440 11/16/2023
7.0.0 791 1/19/2023
2.0.2 2,847 3/11/2022
2.0.1 821 3/5/2022
2.0.0 3,948 11/25/2021