NzCovidPass.Core
0.5.0
See the version list below for details.
dotnet add package NzCovidPass.Core --version 0.5.0
NuGet\Install-Package NzCovidPass.Core -Version 0.5.0
<PackageReference Include="NzCovidPass.Core" Version="0.5.0" />
paket add NzCovidPass.Core --version 0.5.0
#r "nuget: NzCovidPass.Core, 0.5.0"
// Install NzCovidPass.Core as a Cake Addin #addin nuget:?package=NzCovidPass.Core&version=0.5.0 // Install NzCovidPass.Core as a Cake Tool #tool nuget:?package=NzCovidPass.Core&version=0.5.0
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
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 | Versions 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. |
-
net6.0
- Microsoft.Extensions.Caching.Abstractions (>= 6.0.0)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 6.0.0)
- Microsoft.Extensions.Http (>= 6.0.0)
- Microsoft.Extensions.Logging.Abstractions (>= 6.0.0)
- Microsoft.Extensions.Options (>= 6.0.0)
- Microsoft.IdentityModel.Tokens (>= 6.14.1)
- System.Formats.Cbor (>= 6.0.0)
- System.Text.Json (>= 6.0.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.