CredoID

Knowledge Base

Collection of common articles

Firewall exceptions

For CredoID to be able to Discover and communicate with controllers - firewall inbound rule must be created.

Default ports used by devices

Default ports can be changed in additional-settings.

How to create Windows firewall inbound rule

To create a firewall inbound rule - open Windows Defender Firewall with Advanced Security.

  1. Click Inbound Rules.

  1. On the right side of window in Actions section click New Rule….

  1. Select Rule Type - Port and click Next. 

  1. Select Protocol - TCP and Specific local ports: 3001, 3002, 4050, 4070 (Mercury, Aero and VertX) and click Next.

  1. Select Action - Allow the connection and click Next.

  1. Select which network profiles this rule will be applied to and click Next.

  1. Enter name of the Inbound Rule and click Finish. 

Admin password reset

Service has to be stopped before resetting password.

To stop the service - open "Task manager", navigate to "Services", find "CredoID Service", right click on it and select "Stop".

Click start, type cmd, right click on "Command Prompt" and select "Run as administrator".

cmd.png

Navigate to "C:\Program Files\Midpoint-Security\CredoID\Service" in Command Prompt by typing:

cd C:\Program Files\Midpoint-Security\CredoID\Service

Then type:

MDP.SID.Launcher.exe /AdminPasswordReset=true

It will start the service with default admin:admin password.

After service has initialized with default password - you can close "Command prompt" and resume service via task manager.

ASB Musdo Security PSTN Module

pstn_module.png

This expander can be used to transmit PSTN alarm messages to the alarm receiver center.
Only 1 CCS3800 Mbus PSTN module can be placed on the CCS7000/5000 system.

Connection

MBus

4-wire connection on Mbus. Daisy chain setup.
The Mbus is connected to the connection terminals +Vin, GND, A and B.

Tamper

TMP connection can be used to connect the tamper switch. This input is configured as NC(Normally closed).

Phone Line

In on-premises wiring the first or only pair of inside wiring and jacks are color-coded in green for the tip conductor, and red for the ring side.

I/O Linker rules for VertX devices

Used in CredoID v4, placed in Devices → Select device → IOLinkers.

I/O Linker Rules

Purpose: Defines rules which link output action or event messages to a Boolean expression composed of physical, schedule, or logical inputs.
Structure: Each rule is composed of three parts: a Left-Hand Side (LHS) expression, a Boolean operator, and a Right-Hand Side (RHS) expression.

Sample Listing

# IO Linker Rules configuration file
# O(IF,nn) - Output (set/clear type)
#
# = I(IF,ii)
# = L(logid) - Logical Bit
#
# where IF = interface board (IF=32 for Local IO)
# nn = function code
# ii = input status bit

Interface units reference table

VertX V100 nn VertX v200 ii VertX v300 nn
Aux Relay 1 Relay #1 0 (nn) Relay # 1 0
Aux 2 Relay 17 Relay #2 1 (nn) Relay # 2 1
Door 1 - Door Switch 12 (ii) Input 1 16 Relay # 3 2
Door 2 - Door Switch 14 (ii) Input 2 18 Relay # 4 3
Input 3 20 Relay # 5 4
Input 4 22 Relay # 6 5
Input 5 24 Relay # 7 6
Input 6 26 Relay # 8 7
Input 7 28 Relay # 9 8
Input 8 30 Relay # 10 9
Input 9 32 Relay # 11 10
Input 10 34 Relay # 12 11
Input 11 36 Input Point 1 0 (ii)
Input 12 38 Input Point 2 1 (ii)
Input 13 40
Input 14 42
Input 15 44
Input 16 46

Examples

Set initial output state during a start or a cold restart:
SET L(1) FALSE
Turn on Aux relay 1 on V100 (module IF=14) when the doors are open (door switch 1) on reader 1:
O(14,1) = L(1) | I(14,12)

Turn on Aux relay 2 on V100 (module IF=14) when the doors are open (door switch 2) on reader 2:
O(14,17) = L(1) | I(14,14)

Turn on Relay #5 on v300 (module IF=4) when input 5 is triggered on v200 (module IF=2):
O(4,4) = L(1) | I(2,24)

Turn on Relay #1 on v200 (module IF=6) when input 12 is triggered on v200 (module IF=6):
O(6,0) = L(1) | I(6,38)

Turn on Relay #9 on v300 (module IF=3) when input 2 is triggered on v300 (module IF=3):
O(3,8) = L(1) | I(3,2)

Open Supervised Device Protocol (OSDP)

OSDP is an access control communications standard developed by the Security Industry Association (SIA) to improve interoperability among access control and security products.

OSDP describes the communication protocol for interfacing one or more readers to a controller. The OSDP specification describes the protocol implementation over a two-wire RS-485 multi-drop serial communication channel. Nevertheless, this protocol can be used to transfer secure data over any physical channel.

OSDP enables bi-directional communication between reader and controller. Refer to your controller documentation for required configuration.

Secure channel

Secure Channel is the encryption and authentication scheme used by OSDP V2 compliant devices to protect communication between controllers and readers. Secure Channel creates a secure session by using various initialization messages, which perform mutual authentication and establish a set of keys that are used in controller to reader communication.

Enabling secure channel disables install mode.

Setting up readers to use secure channel

To set up HID Readers you need to have "HID Reader Manager" mobile application or a configuration card.

To use secure channel - reader should use OSDP and has to be in install mode before full synchronization with controller. To set up reader through "HID Reader Manager" application:

  1. Open "HID Reader Manager".
  2. Press "Scan for readers".
  3. Select your reader.
  4. Press "Inspect reader".
  5. Press "Detailed configuration".
  6. Press "Communication protocol".
  7. Enable OSDP and Install mode.
  8. Scroll down to the bottom of menu, press "Add to the template".
  9. Press "Apply Selected Items".

Some readers may require to cycle power after step 5.

Communication protocol screen should look like this:

osdp.jpg


To enable secure channel in "CredoID":

  1. Go to device list which can be found in "Hardware" -> "Devices".
  2. Select device that your reader is connected to.
  3. Go to "Device modules" tab on the right side of the screen.
  4. Click on module that your reader is connected to.
  5. Scroll down to whatever port your reader is connected to, check mark "OSDP" and "Enable secure channel".
  6. Check if OSDP reader address and Baud Rate is correct.
  7. Click "Save".
  8. Synchronize your controller.

osdpsecure.png

Secure Channel Session

A Secure Channel session is initiated with a handshake that involves 2 command-reply transactions between the controller and reader. A session once established can be kept active endlessly until either party decides to discard it or until a timeout occurs.

Reader modes

In install mode the default secure channel key can be used.

In secure mode, only commands sent over secure channel are accepted.

Modes are only applicable for OSDP V2.

Amico Readers Face Recognition via OSDP Integration

Face enrollment is always performed on the Amico device.

The Amico device can operate in several output modes:

Each mode determines what data is sent to the controller.

Configuration guide

1. Install and connect the Amico device to a controller according to HID documentation:

Configuration must match how the device is wired. Otherwise OSDP connection will not be available.

Ensure the Amico device is connected to the network and reachable via its IP address before continuing with the guide.

2. Add the controller device to CredoID:

devices-page-credo.png

3. Add doors and connect them with the controller in CredoID.

4. Configure OSDP settings on Amico web interface:

After logging in, navigate to Settings page.


OSDP settings:

osdp-settings.png


Wiegand settings:

wiegand-settings.png


Identification mode:

identification-settings.png


HID settings:

PACS and Wiegand ensures the controller receives a valid, predictable credential (card number) from the reader via OSDP.

hid-settings-page.png

5. Create a user in Amico Web Interface

enroll-user_amico.png

6. Add a user in CredoID

Make sure the card format is enabled in CredoID. You can do that in Settings > Enable Card Format.

access-grant.png

Face and other identifications are stored on the device and not in CredoID.

Sync error issue with controllers

This might happen when updating CredoID from older version to newer one. After update, launch CredoID, wait until devices come online. If they come back in state "Sync error", select all and Synchronize. Devices will come back in "Completed" state after few minutes.

CredoID Docker container

You can obtain the latest build of CredoID Docker container from Docker hub:
https://hub.docker.com/r/midpointdev/credoid

Docker Pull Command: docker pull midpointdev/credoid

For license please contact Midpoint Security support or order one through our partner network.

Duress PIN

A duress code is a covert distress signal used by an individual who is being coerced by one or more hostile persons. It is used to warn others that they are being forced to do something against their will.

CredoID has a Duress PIN feature - if duress pin is used, access is granted as it would normally be, but event with reason „Duress code used“ is generated which can be used to trigger certain actions.

Duress pin code support is currently always enabled without any additional configuration. The default behavior functions only when the reader is in the „Card & PIN“ mode.

To use „Duress PIN“ with „CredoID“ - when entering pin you just have to add 1 to the last digit of your pin, for example if your pin is "1234" you'll have to enter "1235", if it ends with „9“ switch it to „0“.

„Duress PIN“ feature is implemented in „CredoID“ since version 4.10.221

Migration tool

Migration is possible only from CredoID v.4.11.288.
If you are running Microsft SQL, you have to update current version to 4.11.288 and run migration tool. Database will be converted to PostgreSQL. Install 4.12.0 and run it on converted PostgreSQL database.

This tool is used to migrate database from Microsoft SQL Server to a PostgreSQL Server.
CredoID supports PostgreSQL version 14.0 and above
It is also possible to order migration service from us, let us know by e-mail sales@midpoint-security.com

Preparation for migration

Before migrating:

It's best to install PostgreSQL database from embedded installer in CredoID setup.
Another option is official standalone installer from PostgreSQL website .

To install PostgreSQL DB if you already have CredoID v4.11.288 installed - run CredoID setup again and select "Pre-configured Postgre database server" and click "Modify".
PostgreSQL installation.

installer_w_pg_2.png

Migration process

Download migration tool from CredoID repository. Current tool version is migration-tool-1.0.28.

After downloading and extracting the contents:

  1. Open "Migration tool" folder.
  2. Open "appsettings.json" file with any text editor.
  3. Find "SourceDatabase" and "DestinationDatabase" in .json file, both of them has "ConnectionString" parameters.
  "SourceDatabase": {
    "ConnectionString": "Server=.\\SQLEXPRESS;Database=CredoID_MSSQL;User Id=sa;Password=CredoIDPassword1; MultipleActiveResultSets=true;"
  },
  "DestinationDatabase": {
    "ConnectionString": "Server=localhost;Database=CredoID_PG;User Id=postgres;Password=CredoIDPassword1;"
  },

Connection string parameters for "SourceDatabase" can be copied from your current "config.json" file which is located in "C:\ProgramData\Midpoint-Security\CredoID Service"

"MultipleActiveResultSets=true;" is a required parameter for source database "Connection String", you might need to remove it from "config.json" file after migration.

  1. Edit connection details for the source SQL Server.
  2. Edit connection details for the destination PostgreSQL Server.
  3. Run MDP.SID.Database.Migration.Tool.exe.

cmdtool.png

  1. Update and run CredoID after migration is done, you should be presented with "Database setup" page.

If you get "The given key was not present in the dictionary." message - you will need to remove "MultipleActiveResultSets= true;" from "config.json" in "C:\ProgramData\Midpoint-Security\CredoID Service".

db_setup_screen.png

  1. Enter your "PostgreSQL" database details and click "Update settings".

NOTE: Please check the destination database for errors. Don't forget to fully synchronize devices.

MR-50-S3B Jumper J602

The MR-50-S3B introduces a new jumper next to the reader port labeled J602. This is a 120Ø termination jumper used for OSDP connections.

If using a non-OSDP reader this jumper should be open.

If using OSDP, then this jumper should be terminated.

Remove WRN logs from Windows Event viewer

To remove event log messages from being logged in Windows Event viewer add config section below to "C:\ProgramData\Midpoint-Security\CredoID Service\config.log.json" :

 "Logging": {
    "EventLog": {
      "LogLevel": {
        "Default": "None"
      }
    }
  }

Aperio AH40 IP Hub offline after migrating to 2.0+

When using an AH40 Aperio IP Communication hub and communicating using TLS, the device will be offline after a firmware migration from 1.x to 2.x due to a mismatch of certificates. To resolve, the following steps must be taken:

Reset database Password For postgres User

For some reason, after installing PostgreSQL, you may forget the password of the postgres user. In such cases, you need to know how to reset the password to regain access to the PostgreSQL server.

PostgreSQL uses the pg_hba.conf configuration file stored in the database data directory (e.g., C:\Program Files\PostgreSQL\16\data on Windows) to control the client authentication. The hba in pg_hba.conf means host-based authentication.

To reset the password for the postgres user, you need to follow these steps:

The following steps show you how to reset a password for the postgres user:

  1. Backup the pg_hba.conf file by copying it to a different location or rename it to pg_hba.conf.bk

  2. Edit the pg_dba.conf file and change all local connections from scram-sha-256 to trust. By doing this, you can log in to the PostgreSQL database server without using a password.

# TYPE  DATABASE        USER            ADDRESS                 METHOD

# IPv4 local connections:
host    all             all             127.0.0.1/32            trust
# IPv6 local connections:
host    all             all             ::1/128                 trust
# Allow replication connections from localhost, by a user with the
# replication privilege.
host    replication     all             127.0.0.1/32            trust
host    replication     all             ::1/128                 trust
  1. Restart the PostgreSQL server. If you are on Windows, you can restart the PostgreSQL from Services.

Alternatively, you can run the following command from the Command Prompt (notice that you need to run the Command Prompt as the Administrator):

pg_ctl -D "C:\Program Files\PostgreSQL\16\data" restart

The "C:\Program Files\PostgreSQL\16\data" is the data directory.

  1. Connect to PostgreSQL database server using any tool such as psql or pgAdmin:
psql -U postgres

PostgreSQL will not require a password to log in.

  1. Execute the following command to set a new password for the postgres user.
postgres=# ALTER USER postgres WITH PASSWORD 'new_password';
  1. Restore the pg_dba.conf file, restart the PostgreSQL database server, and connect to the PostgreSQL database server with the new password.

Original source - Reset Forgotten Password For postgres User.

Using HID Omnikey to enroll user credentials

HID Omnikey is a USB desktop reader. To use it with CredoID for credential enrollment - reader operation mode must be set to “Keyboard wedge” (KBW) - to set OMNIKEY readers' mode to Keyboard Wedge we recommend using “OMNIKEY workbench tool”.

kbw.png

If reader is set to KBW mode and connected to the PC when entering credentials in CredoID - select "Card data" field, present a card to the reader and card data will be entered into the selected field.

How to power a door strike from POE+ using dry contact relay

poe_dry_contact.png

Updating Aero/Mercury firmware (1.31.x -> 2.x)

Before updating to 2.x make sure your controller it at least on v1.31.x FW, otherwise update to v1.31.x first.

Follow guide to Update FW via CredoID

or

  1. Navigate to controllers web UI, log in.
  2. Navigate to "Diagnostic" menu.
  3. Click "Choose File" and select firmware file.
  4. Click "Load File" and wait until the board reboots.

fwupdate.png

Mercury MP series controllers with non-OSDP readers

Mercury MP1501 panels come with J1202 OSDP termination jumpers installed. If you're using non-OSDP readers you have to remove J1202 jumper.

j1202osdp_jumper.png

Mercury MP1502 panels come with J1501/J1502 OSDP jumpers installed (a jumper for each reader port). If you're using non-OSDP readers you have to remove J1202 jumper.

j1501_1502_osdp_jumpers.png

Using non-OSDP readers without removing termination jumpers usually causes card data to be read incorrectly.

Search fails with lowercase non-ASCII characters

When performing searches containing lowercase non-ASCII characters (e.g., š, ū, ž, ą, ė, ñ, ä), search results are incomplete or return no matches.

This issue only affects search queries containing lowercase non-ASCII characters. Searches using uppercase non-ASCII characters or standard ASCII letters function as expected.

Cause

This behavior is caused by the database collation settings configured in earlier versions. The default collation was set to basic byte ordering / ASCII-only collation, which prevents database string functions (such as UPPER() or LOWER()) from properly recognizing non-ASCII character transformations.

Solution

The database initialization and backup scripts have been updated with proper Unicode (UTF-8) collation settings in the upcoming release.

Backup files generated by the new release automatically include the updated collation settings.

Step-by-step resolution for existing databases

To apply the fix to an existing environment:

  1. Update CredoID to the latest release version.
  2. Create a backup.
  3. Restore the backup created in Step 2.
  4. Verify that searches containing lowercase non-ASCII characters work as expected.

Windows SSO — Setup Guide (non-domain / workgroup machine)

Placeholder What it is How to find yours
<COMPUTER_NAME> Windows computer name of the machine whose account you log in with Run hostname in a terminal
<WINDOWS_USERNAME> Your local Windows account name Run whoami — output is <COMPUTER_NAME>\<WINDOWS_USERNAME>
<GROUP_NAME> A local Windows group you create to control who gets CredoID access (e.g. CredoID-Admins) You choose this name
<CREDOID_ROLE> An existing CredoID role name, spelled exactly. Built-ins: System administrator, User administrator CredoID UI (Roles section) or GET /api/roles

Windows only presents groups from the machine that authenticates you.
On a workgroup (non-domain) setup, the group must exist on the machine
whose account you log in with.

Step 1 — Create a local group and add your account

On <COMPUTER_NAME>, in an elevated PowerShell (Run as administrator):

net localgroup "<GROUP_NAME>" /add
net localgroup "<GROUP_NAME>" <WINDOWS_USERNAME> /add

Step 2 — Sign out of Windows and back in

Group memberships are baked into your Windows logon token at
sign-in, so the new group is invisible to CredoID until you sign out and back
in (a reboot also works).

Verify with:

whoami /groups

The list must now contain <COMPUTER_NAME>\<GROUP_NAME>.

Step 3 — Edit the CredoID config

CredoID service configuration JSON is located at
C:\ProgramData\Midpoint-Security\CredoID Service\config.additional.json

In the CredoID service configuration JSON (config.additional.json) , add or update:

"AuthenticationSettings": {
  "Windows": {
    "IsEnabled": true,
    "AutoCreateOperator": true,
    "AutoCreateOnlyWithRoles": true,
    "RoleMap": {
      "<COMPUTER_NAME>\\<GROUP_NAME>": [ "<CREDOID_ROLE>" ]
    }
  }
}

Details that matter:

Step 4 — Restart the CredoID service

The config is read at startup. Restart the service, then log in using "Windows authentication".
windowsauthlogin.png

What happens on login

  1. Windows authenticates you and hands CredoID your group list.
  2. CredoID looks up each group in RoleMap.
  3. If at least one matches: the operator <COMPUTER_NAME>\<WINDOWS_USERNAME>
    is auto-created (if new) and receives the mapped roles. Roles are re-synced
    from the map on every login, so map changes apply automatically.
  4. If none match: login is rejected with "No mapped roles" — check for a
    typo in the map key, or a missing sign-out/sign-in after Step 1.