Thank you for purchasing the AirID FIDO. Before using AirID, please take the time to read this user manual, to learn about all the features and capabilities of your new AirID.
Table of Content
Intended Use
Questions / Support
For more information about our products & services, please visit our website: https://airid.com/en/ For technical assistance & support, please visit https://airid.com/service-portal Or create a support ticket here: create a support request
certgate GmbH
46045 Oberhausen
Germany
Tel.: +49 (0) 911 93523 0
Email: [email protected]
Website: https://airid.com/
AirID GmbH 2023, All rights reserved
1. About This Guide
This guide provides step-by-step instructions to help customers using the AirID on different platforms and contains also all the necessary information for application developers needed to use certgate's AirID Bluetooth reader with their apps.
1.1. Typographical Conventions
Warning
Warnings mark situations where loss of data or misconfiguration of the device is possible if the instructions are not obeyed
Note
Notes provide additional information on a topic and emphasize important facts and considerations
Tip
Tips provide best practices and recommendations
Code and or command line examples
Parameter and attribute names
2. Device Layout
2.1. Overview
Device Description
Bluetooth Connected Mode Usage
With the AirID it is possible to protect Apps with FIDO2 based security keys via Bluetooth Low Energy (BLE).
Note: Because of the sandbox architecture of iOS and Android, the AirID driver needs to be integrated into an app to use AirID with this specific app.
Examples of apps with AirID integration:
- your company specific apps*
*contact your company administrator!
If you would like to integrate AirID into your app, contact our support at [email protected] and get our AirID SDKs for iOS and Android at the Download Center.
USB Connected Mode Usage
AirID can be used as a standard USB CCID reader on all most all PCs with a common operating system supporting the CCID standard (Windows, OS X and Linux etc.).
2.2. Package Contents
2.3. Hardware Features
3. Menu Layout
In the AirID device menu, you can configure various settings and get status information about your AirID device. You can access the different menu entries by navigating with the control element.
3.1.
Connection
3.2. Pairing Menu
3.3. Settings
3.4. AirID Info
3.5.
Preferred Device
| Text | Anzeige | Bedeutung |
|---|---|---|
| None |
|
If no device is selected, a BLE connection to any of the surrounding devices is possible. |
| New |
|
Select the option New to connect AirID to a new device, if already connected devices are nearby. All other devices paired with AirID will be ignored. |
| "device name" |
|
If your AirID is already paired with one or more devices, you can choose the device name to select which device the AirID should preferably be connected to in the future. All other devices will be ignored. |
The pairing information with up to 10 different devices can be stored at the same time.
4. Firmware Update
certgate is constantly working to make AirID even more reliable and faster. Therefore we provide firmware updates for our AirID product family under Download Center from time to time. Please install a firmware update as soon as it is available as it improves the reliability of the reader.
The AirID firmware can be updated via USB on Windows or MacOS PCs. Download the latest firmware from our website and unzip the file. Below, you will find the necessary steps for the update.
- Use the control element of the AirID to navigate to Settings → Update Firmware → Confirm: Yes
- The AirID should display: "Send update or unpower to exit"
With a Windows PC - Connect your AirID with the USB-cable to a Windows computer or Mac.
- Open the folder with the extracted firmware and run the "winusb-flash-device.exe" file
- once the AirID restarts, the update is finished
With a MacOS - Open the folder with the firmware and run the "flash-airid.command" file
- After a successful update the AirID will reboot automatically and can be used as usual
- once the AirID restarts, the update is finished
If the update fails, the update process is intrerrupted or the AirID doesn't start anymore, go to step 1 and repeat the process.
5. Using AirID
AirID FIDO supports various operating systems like Windows, MacOS (planned), Linux, iOS and Android. The basic requirement is the Bluetooth Low Energy functionality of the device. When AirID is successfully paired and the driver is installed, the FIDO Security Key is available to be used for cryptographic operations such as authentication or data encryption.
The AirID software consists of two components:
- AirID drivers, which ensures the communication between the AirID and the operating system, must be installed additionally depending on the platform or is already integrated in the Apps and solutions of third party vendors.
- AirID Central App - a management software for your AirID forming the basis for usage of the device. The tool provides you with information and setting options for your AirID when your reader is connected to your device.
AirID can be used with different terminals and platforms, but not in parallel operation.
5.1. Windows
With Windows, there is a system-wide smart card support using AirID.
Internal
TODO
Beyond this point no information are present currenty
5.1.1. AirID system requirements
For workstations without built in Bluetooth Low Energy 4.0/4.2 capabilities, a USB Bluetooth Donlge or the AirID Bridge - an USB Bluetooth connector - MUST be used to provide connectivity.
Since Windows 7 doesn't support the Bluetooth Low Energy standard, a AirID Bridge is required additionally.
5.1.2. Installation and Pairing
Installer Download
Download the latest Windows installer - a zipped .exe file - for Windows at the Download Center.
Driver and App Installation
Unzip and double click on the .exe installer file.
Follow the instructions in the installation wizard to install the AirID Windows driver and the AirID Central App.
Bluetooth Pairing
- Power on your smart card reader
- Make sure that Bluetooth is activated at your reader by pressing the AirID control element. AirID should display:
- Open Windows "Settings → Devices → Bluetooth" and make sure, that Bluetooth is activated.
- Click "Add a Bluetooth device" and your AirID should be listed with its serial number. Select the reader you want to connect with.
- For secure pairing, compare the displayed code on AirID with the code displayed on the host system and confirm the pairing code by pressing the jog dial on your AirID.
After successful pairing, "Your device is ready to go!" and the AirID serial number will be displayed on the Windows system and the device name of the paired device will be displayed on the AirID.
If there are any problems with the pairing process, restart the process. If necessary, delete the stored pairing information (see Remove the Pairing)
After the driver has been successfully installed and paired, AirID is displayed as follows under Device Manager. AirID is detected as "Microsoft USBCCID Smartcard Reader" if it is connected via USB.
5.1.3. Silent Installation of the Driver
To perform a silent install using the ZIP format driver, extract the ZIP file, then run the AirID Installer .EXE program for the driver with the following comand line switch:
"<Filename>.exe" /install /quiet /log "<Filename for Logfile.txt>"
Any problem can be found in the log file.
The command to uninstall the software package is as follows:
"<Filename>.exe" /uninstall /quiet /log "<Filename for Logfile.txt>"
The optional parameter are:
| Optional Parameter | Description |
|---|---|
/help |
Help and short overview of the parameters |
/install | /repair | /uninstall | /layout |
Installs, repairs, uninstalls or creates a copy of the installation package |
/passive | /quiet |
The user interface is displayed, but no user intervention is required. No user interface is displayed during installation. |
/norestart |
If this option is specified, commands with --passive or --quiet will not automatically restart the computer. |
/log log.txt |
The logs are written to a specific log.txt file. By default, a log file is created under %TEMP%. |
5.1.4. Remove the Pairing
The pairing information are stored on both, the Windows system and AirID. To terminate the connection completely, the information on both sides must be removed.
On Windows
- Open the Bluetooth settings on Windows (Settings → Devices → Bluetooth)
- Select the corresponding AirID using the displayed serial number and click on "Remove Device"
- Click "Yes" to confirm the removal of the device.
On AirID
To remove all stored pairing information from AirID, use the control element to select Settings → Remove Pairing → Remove all.
Remove specific pairing information
To remove specific pairing information from AirID, use the control element to select Settings → Remove Pairing → Remove "device name".
The pairing information can also be removed via AirID Central App. To do this, go to the paired devices view, select the corresponding device from the list and click Delete.
iOS
With iOS, a system-wide support of smart cards and card readers is not possible. In order to use AirID with a specific app, the AirID driver needs to be integrated into this app.
The connection to the iOS device is only active when the app in foreground is open. As soon as the app goes into the background, the Bluetooth connection to the AirID is released again.
AirID system requirements
In order to use AirID with your iOS device, the iOS version 10.3.3 upwards is required.
AirID Integration
- Complete integration of AirID driver and AirID Central functionality into the third party app
- Only integration of AirID driver into the third party app and usage of AirID Central app in addition (interaction of the apps via keychain)
Depending on the form of integration, the Bluetooth pairing process will be done within the third party app (1.) or within the AirID Central app (2.).
For both option a smart card middleware within the third party app is required to use the smart card provided by AirID.
Do you want to integrate AirID to your app? Please contact us at: [email protected]
Pairing
- Power on your smart card reader
- Make sure that Bluetooth is activated at your reader by pressing the AirID control element. AirID should display:
- Open the third party app / AirID Central app and add your AirID. Your AirID should be listed with its serial number. Select the reader you want to connect with.
- Follow the displayed instructions to pair the devices
After succesful pairing, "Your device is ready to go!" and the device name of the paired device will be displayed on your AirID.
If you already paired AirID with another device that are switched on and close to you, please navigate to "Prefer Device" in the AirID menu press the control element and choose "New". Then press the control element again to confirm.
Remove the Pairing
The pairing information are stored on both, the iOS device and AirID. To terminate the connection completely, the information on both sides must be removed.
On iOS
- To remove the device information from the third party app / AirID Central App, forget the stored AirID within the app
- Then, open the Bluetooth system settings on your mobile device (Settings → Bluetooth)
- Select the AirID from the list by its serial number
- Ignore / Forget the selected device to remove the pairing information
On AirID
To remove all stored pairing information from AirID, use the control element to select Settings → Remove Pairing → Remove all.
Remove specific pairing information
To remove specific pairing information from AirID, use the control element to select Settings → Remove Pairing → Remove "device name".
The pairing information can also be removed via AirID Central App. To do this, go to the paired devices view, select the corresponding device from the list and click Delete.
5.3 Android
With Android, a system-wide support of smart cards and card readers is not possible. In order to use AirID with a specific app, the AirID driver needs to be integrated into this app.
The connection to the Android device is only active when the app in foreground is open. As soon as the app goes into the background, the Bluetooth connection to the AirID is released again.
AirID System Requirements
In order to use AirID FIDO with your devices the following requirements must be metOperating System Version (minimal) Function Windows 10 20H4 FIDO (BLE/Driverless) Windows 10 2004 FIDO (BLE) MacOS 11.1 + FIDO (USB)
| Operating System | Version (minimal) | Function |
|---|---|---|
| Windows 10 | 20H4 | FIDO (BLE/Driverless) |
| Windows 10 | 2004 | FIDO (BLE) |
| MacOS | 11.1 + | FIDO (USB) |
AirID Integration
There are two possible options for integration of AirID which can be used:- Complete integration of AirID driver and AirID Central functionality into the third party app
- Only integration of AirID driver into the third party app and usage of AirID Central app in addition (interaction of the apps via keychain)
Depending on the form of integration, the Bluetooth pairing process will be done within the third party app (1.) or within the AirID Central app (2.).
For both option a smart card middleware within the third party app is required to use the smart card provided by AirID.
Do you want to integrate AirID to your app? Please contact us at: [email protected]
- Complete integration of AirID driver and AirID Central functionality into the third party app
- Only integration of AirID driver into the third party app and usage of AirID Central app in addition (interaction of the apps via keychain)
Depending on the form of integration, the Bluetooth pairing process will be done within the third party app (1.) or within the AirID Central app (2.).
For both option a smart card middleware within the third party app is required to use the smart card provided by AirID.
Do you want to integrate AirID to your app? Please contact us at: [email protected]
Pairing
- Power on your smart card reader
- Make sure that Bluetooth is activated at your reader by pressing the AirID control element. AirID should display:
- Open the third party app / AirID Central app and add your AirID. Your AirID should be listed with its serial number. Select the reader you want to connect with.
- Follow the displayed instructions to pair the devices
After succesful pairing, "Your device is ready to go!" and the device name of the paired device will be displayed on your AirID.
If you already paired AirID with another device that are switched on and close to you, please navigate to "Prefer Device" in the AirID menu press the control element and choose "New". Then press the control element again to confirm.
- Power on your smart card reader
- Make sure that Bluetooth is activated at your reader by pressing the AirID control element. AirID should display:
- Open the third party app / AirID Central app and add your AirID. Your AirID should be listed with its serial number. Select the reader you want to connect with.
- Follow the displayed instructions to pair the devices
After succesful pairing, "Your device is ready to go!" and the device name of the paired device will be displayed on your AirID.
If you already paired AirID with another device that are switched on and close to you, please navigate to "Prefer Device" in the AirID menu press the control element and choose "New". Then press the control element again to confirm.
Remove the Pairing
The pairing information are stored on both, the iOS device and AirID. To terminate the connection completely, the information on both sides must be removed.
On Android
- To remove the device information from the third party app / AirID Central App, forget the stored AirID within the app
- Then, open the Bluetooth system settings on your mobile device (Settings → Bluetooth)
- Select the AirID from the list by its serial number
- Ignore / Forget the selected device to remove the pairing information
On AirID
Remove all pairing informationTo remove all stored pairing information from AirID, use the control element to select Settings → Remove Pairing → Remove all.
Remove specific pairing information
To remove specific pairing information from AirID, use the control element to select Settings → Remove Pairing → Remove "device name".
The pairing information can also be removed via AirID Central App. To do this, go to the paired devices view, select the corresponding device from the list and click Delete.
To remove all stored pairing information from AirID, use the control element to select Settings → Remove Pairing → Remove all.
Remove specific pairing information
To remove specific pairing information from AirID, use the control element to select Settings → Remove Pairing → Remove "device name".
The pairing information can also be removed via AirID Central App. To do this, go to the paired devices view, select the corresponding device from the list and click Delete.
5.4 macOS
At the moment, we are developing a native driver for macOS to enable a system-wide smart card support using AirID. The first version of native support is planned to be available in Q4 / 2019.To already use AirID with macOS today, the AirID Bridge as a connector between both devices is required.
QUICK TIPS
For more information about our products & services, please visit our website: https://airid.com/en/
For technical assistance & support, please visit https://airid.com/service-portal
Or create a support ticket here: create a support request
To already use AirID with macOS today, the AirID Bridge as a connector between both devices is required.
QUICK TIPS
For more information about our products & services, please visit our website: https://airid.com/en/
For technical assistance & support, please visit https://airid.com/service-portal
Or create a support ticket here: create a support request
5.5 AirID Central Application
T.B.A
6. Technical Specification
7. Safety Instructions
Environment Temperature Range:
| Status | Min. Temperature | Max. Temperature |
|---|---|---|
| While operating | -10°C | +60°C |
| While charging | 0°C | +45°C |
8. Disposal and Recycling
B2B equipment must be returned to the manufacturer.
9. Maintenance and Care
Clean the device only with a soft, clean and dry cloth. Do not expose the device to harsh chemicals, cleaning solutions or strong cleaning agents. Do not allow liquid to penetrate the product.
10. Warranty/ License/ Technical Support
Please note that only customer with a valid support and maintenance agreement are authorized to get free support services.