Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: #2487 removing duplicated files #3007

Merged
merged 1 commit into from
Nov 16, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
72 changes: 72 additions & 0 deletions docs/script-catalog/person_authentication/other/bioid/README.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
# BioID Web Service
## Overview
[BioID Web Service](https://www.bioid.com) is a "Biometrics as a service" provider. This document will explain how to use Gluu's [BioID interception script](https://github.com/GluuFederation/oxAuth/blob/master/Server/integrations/bioID/BioIDExternalAuthenticator.py) to configure the Gluu Server for a two-step authentication process with username and password as the first step, and BioID's biometric authentication as the second step.

In order to use this authentication mechanism your organization will need to register for a BioID account.

## Prerequisitesm
- A Gluu Server ([installation instructions](../installation-guide/index.md));
- [BioID interception script](https://github.com/GluuFederation/oxAuth/blob/master/Server/integrations/bioID/BioIDExternalAuthenticator.py) (included in the default Gluu Server distribution);
- An account with [BioID](https://bwsportal.bioid.com/register).

## Properties
The mandatory properties in the BioID authentication script are as follows
| Property | Description | Example |
|-----------------------|-------------------------------|---------------|
|ENDPOINT |URL of the BioID Web Service|`https://bws.bioid.com/extension/`|
|APP_IDENTIFIER |API key |`c20b04cc-776a-45ed-7a1f-06347f8edf6c`|
|APP_SECRET |API secret |`sTGB4n4HAkvc2BnJp6KeNUTk`|
|STORAGE |The storage name assigned by BioID depending on the type of contract you have. |`bws`|
|PARTITION |A number assigned to your company by BioID. |`12345`|



## Configure BioID Account

1. [Sign up](https://bwsportal.bioid.com/register) for a BioID account.

2. Upon registration, you will recieve an email with the instance name (listed as STORAGE in Gluu's BioID authentication script), partition number(listed as PARTITION in Gluu's BioID authentication script).

3. As the owner of this instance, you are entitled to access BWS Portal at https://bwsportal.bioid.com using the account associated with your email.
With the BWS Portal, you can do the following:
a. View your trial information such as your credentials (e.g. your client certificate), enrolled classes, BWS logs and more.
b. Create your App ID and App secret, under "Web API keys".

## BioID Documentation

You can find all API reference at https://developer.bioid.com/bwsreference.
Lots of useful information about BWS is available at https://developer.bioid.com/blog.
If you intend to use liveness detection, you will find information about motion trigger helpful: https://developer.bioid.com/app-developer-guide/bioid-motion-detection

## Configure oxTrust

Follow the steps below to configure the BioID module in the oxTrust Admin GUI.

1. Navigate to `Configuration` > `Person Authentication Scripts`.
1. Scroll down to the BioID authentication script
![bioid-script](../img/admin-guide/multi-factor/bioid-script.png)

1. Configure the properties, all of which are mandatory, according to your API

1. Enable the script by ticking the check box
![enable](../img/admin-guide/enable.png)

Now BioID's biometric authentication is available as an authentication mechanism for your Gluu Server. This means that, using OpenID Connect `acr_values`, applications can now request BioID biometric authentication for users.

!!! Note
To make sure BioID has been enabled successfully, you can check your Gluu Server's OpenID Connect configuration by navigating to the following URL: `https://<hostname>/.well-known/openid-configuration`. Find `"acr_values_supported":` and you should see `"bioid"`.

## Make BioID the Default Authentication Mechanism

Now applications can request BioID's biometric authentication. To make BioID biometic authentication your default authentication mechanism, follow these instructions:

1. Navigate to `Configuration` > `Manage Authentication`.
2. Select the `Default Authentication Method` tab.
3. In the Default Authentication Method window you will see two options: `Default acr` and `oxTrust acr`.

- The `oxTrust acr` field controls the authentication mechanism that is presented to access the oxTrust dashboard GUI (the application you are in).
- The `Default acr` field controls the default authentication mechanism that is presented to users from all applications that leverage your Gluu Server for authentication.

You can change one or both fields to BioID authentication as you see fit. If you want BioID to be the default authentication mechanism for access to oxTrust and all other applications that leverage your Gluu Server, change both fields to bioid.

![BioID](../img/admin-guide/multi-factor/bioID.png)

This file was deleted.

Loading