Custom Authentication Module

This section provides instructions for developers who intend to build or integrate their own authentication method of their users into MetaDefender Kiosk. We recommend that you have a strong understanding of C/C++ before reading this section.

The bundled code included in this section is a sample of how the authentication module can be implemented. You should modify the contents in each method described in this section to accommodate your integration needs. You can remove any additional methods in the sample code not described in this section if not needed.

System requirements

The system requirements for implementing custom authentication are as follows:

• MetaDefender Kiosk 3.2.0 or later

• Visual Studio 2017 or later

• .NET 4.5 or later for running the sample UI in the Custom Authentication Sample (optional)

Steps to deploy custom authentication

The steps necessary to deploy custom authentication are as follows:

1. Obtain a custom authentication template package from the My OPSWAT downloads

2. Implement the custom authentication interface & build the custom authentication module (authenticationModule.dll)

3. Deploy the custom authentication module

4. Configure MetaDefender Kiosk to use the custom authentication

Enabling custom authentication

After successfully building the custom authentication module, you can enable the module.

1. Place the module (authenticationModule.dll) in the expected directory (e.g., <Kiosk Install Directory>\Client\Authentication)

2. Open the MetaDefender Kiosk Management Console and go to the Workflows tab

3. Within the Employee Workflows section, click on User Authentication Method

4. Select Custom Authentication and click Apply

Custom authentication template

The following section describes the C++ code in the custom authentication template.

Init

This is the first method called when the Kiosk service starts up and loads the authentication module. Any dependencies necessary to initialize for the module should go here.

Verify

This method initiates the authentication process to run. The return value is not a result of the user passing authentication. It indicates if the authentication process was successful or not.

Deinit

This method is called when the Kiosk is stopped. Any resources acquired by your module should be released and any unsaved data should be stored.

Cancel

This method is called when the user tries to cancel while verification is running.

FreeString

This method is called to free allocated memory for wchar_t **. Kiosk calls this function when finished with the values allocated by your functionality.

Using the Custom Authentication Tester

The custom authentication testing package includes a file called TestCustomAuthentication.exe that lets you test and troubleshoot your authentication module before using it with MetaDefender Kiosk.

TestCustomAuthentication.exe behaves similarly to the component MetaDefender Kiosk uses to load the authentication module. Since MetaDefender Kiosk runs under a SYSTEM context, you should also run the authentication module under SYSTEM. Attempting to run the authentication module as any other user may invalidate the module's results. You must run TestCustomAuthenticationModule.exe under SYSTEM to properly load authenticationModule.dll and test the methods.

You can use Windows Sysinternals to run the tool as SYSTEM.

To run the custom authentication tester:

1. Download PsExec

2. Open a command prompt (as an administrator) to where PsExec is installed and enter PsExec.exe -s cmd.exe

3. Navigate to the <Kiosk Install Directory>\Client\Authentication directory

4. Run TestCustomAuthentication.exe. At all points of method testing, the tester pauses and allows you to control when to move on to the next test

5. A PASSED or FAILED result will be displayed

pcProx Plus RFID Reader Custom Authentication Module

• Overview of Module

• Required Components

• Configuration

  • Reader Configuration

  • • pcProxConfig Installation

  • Adding pcProx Custom Authentication Module to MetaDefender Kiosk

  • Using the pcProx Custom Authentication Module

Overview of Module

This documentation describes usage of the pcProx Plus RFID Reader custom authentication module. This authentication module can be used to allow RFID cards to be used for MetaDefender Kiosk authentication.

Required Components

• Installed MetaDefender Kiosk

• pcProx Plus RFID Reader

  • https://www.rfideas.com/support/product-support/pcprox-plus

• pcProxConfig reader configuration tool

  • Download available at https://www.rfideas.com/support/product-support/pcprox-plus

  • Documentation available at https://www.rfideas.com/files/downloads/manuals/Enroll_Plus_Wiegand_Manual.pdf

• pcProx Plus RFID Reader Custom Authentication Module

  • Compiled binaries and source available on My OPSWAT

Reader Configuration

pcProxConfig Installation

1. Download the pcProxConfig installer from https://www.rfideas.com/support/product-support/pcprox-plus

2. Run the installer to install the pcProxConfig configuration tool

3. Connect the pcProx reader to the Metadefender Kiosk system and wait for the driver to be installed. The LED on the reader will turn red

4. Launch the pcProxConfig tool, the device should be automatically detected

5. If the reader is not automatically detected you can click on the Connect button to detect the reader

6. The reader should be shown in the device list

7. Select Card Analyzer from the menu

6. Click 'Learn Card'

   1. Click Start Scan, and when prompted put the RFID card that you want the device to learn on the scanner. The card will need to stay on the reader until the scanning is complete.

3.

7. Click the 'Auto Config>' button

8. Select the Configuration # to set and click the 'Write' button

9. After the configuration has been written click 'Exit' to close the Card Analyzer dialog or click the 'Learn Card' button to learn another card type

10. Confirm that the configuration has the 'High priority' checkbox selected

2. If two configurations are saved make sure this is selected for both

11. Select the 'Format' tab. On the 'Data Format' subtab do the following.

    1. Confirm the 'Send ID' checkbox is selected

    2. OPSWAT recommends that the 'Send FAC' checkbox is also selected

12. 
    

12. On the 'Delimiters' subtab, do the following

    1. Confirm the Pre-data delimiter is set to <NONE>

3. Confirm the Post-data delimiter is set to <NONE>

4. Confirm the Termination Keystroke is set to <ENTER>

13. Click the 'Write Active' button to save the configuration. If there are two configurations set this needs to be done for both configurations.

14. Test the configuration by opening the Notepad application and scanning a card. The card ID should be written into Notepad.

Adding the pcProx Custom Authentication Module to MetaDefender Kiosk

1. Copy the following files from the custom authentication module download package into your C:\Program Files (x86)\OPSWAT\Metadefender Kiosk\Client\Authentication directory

   1. authenticationModule.dll

   2. CustomAuthExample.exe

   3. omsConfig_CAM.ini

   4. db

2. If you would like to restrict users to the RFID cards that are listed in the database

   1. Set the property validate_ID=1 in omsConfig_CAM.ini

   2. Open the 'db' file with a text editor, such as Notepad. Update/add the valid card IDs (can be read by pcProxConfig tool, step 14) with the corresponding user names in the format <Card ID>:<Name>. Only card IDs that are listed in this file can be used for authentication.

3. In the MetaDefender Kiosk Management Console, enable Custom Authentication. Configuration → User Authentication → View and configure user authentication → User Authentication → Custom Authentication

2. Click the 'Apply' button

Using the pcProx Custom Authentication Module

1. Users will be prompted to scan their RFID badge

2. The ID from the card will be saved as the user ID for the session

   1. In the session log viewable through the Management Console

2. On the scan receipt

3. In the saved text log file