DgcReader.RuleValidators.Germany 2.5.5-CI-20230402-112357

.NET 5.0 This package targets .NET 5.0. The package is compatible with this framework or higher. .NET Standard 2.0 This package targets .NET Standard 2.0. The package is compatible with this framework or higher. .NET Framework 4.5.2 This package targets .NET Framework 4.5.2. The package is compatible with this framework or higher.
This is a prerelease version of DgcReader.RuleValidators.Germany.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package DgcReader.RuleValidators.Germany --version 2.5.5-CI-20230402-112357                

                    
                

            
NuGet\Install-Package DgcReader.RuleValidators.Germany -Version 2.5.5-CI-20230402-112357
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="DgcReader.RuleValidators.Germany" Version="2.5.5-CI-20230402-112357" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add DgcReader.RuleValidators.Germany --version 2.5.5-CI-20230402-112357                

                    
                

            
#r "nuget: DgcReader.RuleValidators.Germany, 2.5.5-CI-20230402-112357"
#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 DgcReader.RuleValidators.Germany as a Cake Addin
#addin nuget:?package=DgcReader.RuleValidators.Germany&version=2.5.5-CI-20230402-112357&prerelease

// Install DgcReader.RuleValidators.Germany as a Cake Tool
#tool nuget:?package=DgcReader.RuleValidators.Germany&version=2.5.5-CI-20230402-112357&prerelease

German Rules Validator

DgcReader.RuleValidators.Germany

NuGet version (DgcReader.RuleValidators.Germany) Nuget

Implementation of IRulesValidator for validating Digital Green Certificates using rules provided by the German backend.

This is an unofficial porting of the covpass-sdk included in the Digitaler-Impfnachweis / covpass-android repository.

In addition to German rules, it supports validation for several other European Union countries. You can get a list of supported countries by calling the GetSupportedCountries method.

Usage

In order to use the validator, you can register it as a service or you can instantiate it directly, depending on how your application is designed:

a) Registering as a service:
public void ConfigureServices(IServiceCollection services)
{
   ...
   services.AddDgcReader()
       .AddGermanTrustListProvider()
       .AddGermanRulesValidator(o =>
               {
                   // Optionally, configure the validator with custom options
                   o.RefreshInterval = TimeSpan.FromSeconds(5);
                   o.MinRefreshInterval = TimeSpan.Zero;
                   ...
               });
}
b) Instantiate it directly
...
// You can use the constructor
var rulesValidator = new DgcItalianRulesValidator(httpClient);
...

// Or you can use the DgcItalianRulesValidator.Create facory method
// This will help you to unwrap the IOptions interface when you specify 
// custom options for the provider:
var rulesValidator = DgcGermanRulesValidator.Create(httpClient, 
   new DgcGermanRulesValidatorOptions {
       RefreshInterval = TimeSpan.FromHours(24),
       MinRefreshInterval = TimeSpan.FromHours(1),
   });


// Then you should pass it as a parameter to the DgcReaderService constructor:
var dgcReader = DgcReaderService.Create(
   trustListProvider, 
   null,
   rulesValidator      // <-- The rules validator service
);

Available options

  • RefreshInterval: interval for checking for rules updates from the server. Default value is 24 hours.
  • MinRefreshInterval: if specified, prevents that every validation request causes a refresh attempt when the current rules are expired.
    For example, if the parameter is set to 5 minutes and the remote server is unavailable when the RefreshInterval is expired, subsequent validation requests won't try to download the updated rules for 5 minutes before making a new attempt. Default value is 5 minutes.
  • UseAvailableValuesWhileRefreshing: if true, allows the validator to use the expired rules already loaded in memory, while downloading the updated rules on a background Task.
    This prevents the application to wait that the new rules are downloaded, extending by the time needed for the download the effective validitiy of the rules already loaded.
    As result, the response time of the application will be nearly instantanious, except for the first download or if the rules have reached the MaxFileAge value.
    Otherwise, if the rules are expired, every validation request will wait untill the refresh task completes.
  • TryReloadFromCacheWhenExpired: If true, try to reload values from cache before downloading from the remote server. This can be useful if values are refreshed by a separate process, i.e. when the same valueset cached file is shared by multiple instances for reading. Default value is false.
  • BasePath: base folder where the rules list will be saved. The default value is Directory.GetCurrentDirectory()
  • MaxFileAge: maximum duration of the configuration file before is discarded.
    If a refresh is not possible when the refresh interval expires, the current file can be used until it passes the specified period.
    This allows the application to continue to operate even if the backend is temporary unavailable for any reason. Default value is 15 days.

Forcing the update of the rules

If the application needs to update the rules at a specific time (i.e. by a scheduled task, or when a user press a "Refresh" button), you can simply call the RefreshRulesList function of the validator. This will casue the immediate refresh of the rules from the remote server, regardless of the options specified.

Disclaimer

This library is not an official implementation, therefore its use may be subject to restrictions by some countries regulations.
The author assumes no responsibility for any unauthorized use of the library and no warranties about the correctness of the implementation, as better stated in the License.

Copyright © 2021 Davide Trevisan
Licensed under the Apache License, Version 2.0

Product Compatible and additional computed target framework versions.
.NET net5.0 is compatible.  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 net452 is compatible.  net46 was computed.  net461 was computed.  net462 was computed.  net463 was computed.  net47 is compatible.  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. 
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
2.6.1 235 4/3/2023
2.6.0 214 4/2/2023
2.6.0-CI-20230402-140522 135 4/2/2023
2.5.5 404 6/14/2022
2.5.5-rc1 149 6/14/2022
2.5.5-CI-20230402-112357 104 4/2/2023
2.5.5-CI-20230402-101020 117 4/2/2023
2.5.4 405 5/4/2022
2.5.4-rc2 172 5/4/2022
2.5.4-rc1 166 5/4/2022
2.5.3 927 3/5/2022
2.5.3-rc1 165 3/5/2022
2.5.1 414 2/16/2022
2.5.1-rc1 150 2/15/2022
2.5.0 402 2/14/2022
2.5.0-rc3 148 2/14/2022
2.5.0-rc2 184 2/11/2022
2.5.0-rc1 146 2/11/2022
2.4.0 405 2/6/2022
2.3.0 421 1/28/2022
2.2.1 439 1/21/2022
2.2.0 428 1/16/2022
2.1.0 263 1/6/2022
2.0.0 255 12/27/2021

Aligned rules from official SDK version 1.0.2, check for Sputnik vaccine not from San Marino and UVCI blacklist provider. Implemented standard interfaces IBlacklistProvider and IRulesValidator