BioClient.Web configuration

BioClient.Web service configuration

To configure, edit appsettings.json of the service

DefaultConfigFile defines the location of the default BioClient configuration file.

BioClient configuration

BioClient.Web settings

BioClient.Web settings are found in the section of the BioClient configuration file.

In the case the server or service fails listening on the WebSocket address, determine port use

The <IsHttps> tag determines if the service is listening on an HTTP or HTTPS port. Even though the service will typically only be used for local traffic on your workstation, HTTPS is recommended.
```
<IsHttps value="true" />
```
The <RateLimit> tag limits the transaction rate to the service. This is useful to prevent denial of service attacks.
```
<RateLimit value="500" />
```
The <RateLimitPeriod> tag limits the transaction rate to the service. It determines the time period over which the setting applies This is useful to prevent denial of service attacks.
```
<RateLimitPeriod value="1" />
```
The <Certificate> tag defines the certificate which is used as SSL certificate for HTTPS traffic. The certificate must have a private key, and the service account running the service must have access to this certificate.
```
<Certificate value="store=my|location=LocalMachine|serial=6425642" />
```
The <IsRequireAuthentication> tag determines of the service requires authentication. Typically, authentication will not be required as the service will typically only be used for local traffic on your workstation.
```
<IsRequireAuthentication value="false" />
```
The <IsRequireAuthorisation> tag determines of the service requires authorisation. Typically, authorisation will not be required as the service will typically only be used for local traffic on your workstation.
```
<IsRequireAuthorisation value="false" />
```
The <PermittedOrigins> tag determines which websites are authorised to use the service. This implements a form of client authorisation. Multiple URLs are separated by pipe (|).
```
<PermittedOrigins value="http://localhost:4036|https://localhost:44383" />
```
The <UnauthenticatedPrivileges> tag determines which biometric operations are permitted without authenrication.
```
<UnauthenticatedPrivileges value="a=true,p=79,s=BO.Capture|a=true,p=79,s=BO.Extract" />
```
The <BiometricExtension> tag allows injection of an extension, which provides for client-specific biometric verbs and commands.
```
<BiometricExtension value="BioClient.Web.YourExtensions, YourCompany" />
```

BioClient settings

BioClient settings define which biometric adapters are used for sensors, engines, and stores, and define their property and behaviors.

The <KnownSensorFactories> section lists which sensor factories are used to obtain sensor adapters. Multiple sensor adapters can be loaded and used at the same time.
The <KnownEngineFactories> section lists which sensor factories are used to obtain engine adapters. Only one engine adapter is loaded at any point in time.
The <KnownSensorFactories> section lists which sensor factories are used to obtain store adapters. Multiple store adapters can be loaded and used at the same time.
The <Profiles> section lists configuration profiles. Currently only one profile, the default profile, is supported.

BioClient configuration profiles

The <LastAdapters> section lists currently used adapters. The <UniqueName> tag specifies the unique name of the adapter, and is matched against adapter names provided by adapter factories. See the documentation of biometric adapters to obtain the unique names which they provide.
The <Sensor> section defines standard settings, which are applied to all sensors.
The <Engine> section defines standard settings, which are applied to all engines.
The <Store> section defines standard settings, which are applied to all stores.
The <KnownAdapters> section defines both standard and custom settings, which are applied specifically to an individual adapter.

BioClient known adapter settings

Within every known adapter profile, both standard and custom settings can be set for this biometric adapter.

The <Sensor> , <Engine>, or <Store> sections define standard settings for this adapter.
The <KnownAdapterSettings> section defines custom settings for this adapter. See the documentation of biometric adapters to obtain names and required values of their custom settings.