NzCovidPass.Core 0.5.2

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

// Install NzCovidPass.Core as a Cake Tool
#tool nuget:?package=NzCovidPass.Core&version=0.5.2

NZ COVID Pass

nuget build code-coverage

About

Provides the ability to ability to verify New Zealand COVID Pass payloads in .NET.

Usage

var services = new ServiceCollection();

services.AddMemoryCache();
services.AddNzCovidPassVerifier();

var provider = services.BuildServiceProvider();

var verifier = provider.GetRequiredService<PassVerifier>();

var result = await verifier.VerifyAsync("...");

if (result.HasSucceeded)
{
    // Pass successfully verified
    Console.WriteLine($"NZ COVID Pass subject details: {result.Pass.FamilyName}, {result.Pass.GivenName} - {result.Pass.DateOfBirth}");
}
else
{    
    // Invalid pass
    Console.WriteLine($"Verification failed: {string.Join(", ", result.FailureReasons.Select(fr => fr.Code))}");
}

Full examples of usage can be found in the demos folder.

Advanced usage

Logging

The PassVerifier logs message via the Microsoft.extensions.Logging.ILogger<TCategoryName> abstraction. See the .NET documentation for more details.

Customising verifier options
services.AddNzCovidPassVerifier(options =>
{
    var validIssuers = PassVerifierOptions.Defaults.ValidIssuers.ToHashSet();

    // Add test issuer
    validIssuers.Add("did:web:nzcp.covid19.health.nz");

    options.ValidIssuers = validIssuers;    
});
Custom verification keys

With the default configuration, verification keys are resolved via HTTP from the DID document associated with the issuer and key ID contained in the pass payload.

If you wish to use a static key (e.g. to support offline usage) or for testing purposes, a custom IVerificationKeyProvider can be registered:

services.Replace(ServiceDescriptor.Singleton<IVerificationKeyProvider, CustomVerificationKeyProvider>());

Development

Following the instructions below to get started with the project in a local development environment.

Prerequisites

Building

After cloning the source code to a destination of your choice, run the following command to build the solution:

dotnet build

Tests

The test suite can be run using the following command:

dotnet test
Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  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. 
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

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
0.5.2 1,474 12/21/2021
0.5.1 583 11/29/2021
0.5.0 849 11/20/2021
0.4.1 584 11/19/2021
0.4.0 574 11/18/2021
0.3.0 581 11/15/2021
0.2.0 617 11/14/2021
0.1.1 632 11/14/2021
0.1.0 635 11/14/2021