NZ COVID Pass

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

• .NET 6.0

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