Currently, only A and B scenarios are supported. There will be more scenarios in the future.
...
Scenario A (typical)
Terminals connect to Server via application’s the server via the CAS application's built-in OpenVPN client’s secure channel.
This is
...
Scenario B
Terminals connect to Server via VPN that is being provided by additional hardware such as router. This scenario is considered as more secure then A as the VPN configuration is NOT distributed by CAS.
More Notes
Gate service
Listens for terminal’s pairing requests. In case of successful pairing gate service sends terminal VPN configuration including the information on where to connect to master service.
Master service
Listens to terminal’s requests. Answers only terminal requests that are coming from trusted ( paired ) devices.
Admin service
...
the default implementation for Operators.
No dedicated VPN routers required/deployed for network attached BATMs.
The OpenVPN software is configured via batm-manage.
...
Scenario B (dedicated hardware)
Terminals connect to the server via a VPN provided by additional hardware, such as a router.
The VPN configuration is not distributed by CAS.
This scenario is considered more secure than Scenario A.
...
Scenario “B” Requirements
Set the variable
batm.vpn-skip
totrue
in the file/batm/config/gate.properties
This change disables VPN distribution via the Gate service.
Delete the
/batm/config/vpn
file to prevent VPN implementation.Connect your BATMs to the hardware VPN.
Connect your hardware VPN to your CAS server (or server-side VPN).
The BATMs must be able to communicate with
the Gate service on the port 7741, and
the Master service on the port 7741.
The Gate and Master services use their specific IP addresses, and
the Gate service must be able to communicate with the Master service (via port 7747).
...
Notes
Gate service
The Gate service listens for your terminals' pairing requests. After a successful pairing, the Gate service sends the terminal the VPN configuration, including information on how to connect to the Master service.
Prior to pairing, the terminal's VPN configuration must (normally) already have been generated.
The Gate service uses the batmgate
unix user, which is a member of the batm
group. The Gate service listens on port 7741. The Master service uses the same port - but on a different interface.
Info |
---|
The Gate service’s TCP port 7741 should be temporarily accessible from the Internet only when performing a pairing. For security reasons - don’t leave it open. Leaving it open will encourage attackers to focus on your server. |
Note |
---|
The Gate service is only compatible with terminals running on version 20230801 and newer!
|
The Gate service configuration file is fully described here: https://generalbytes.atlassian.net/wiki/x/CYBtz
Master service
The Master service communicates with your BATMs. It replies only to BATMs/terminals that are coming from trusted ( paired ) terminals.
The Master service uses
batmmaster
unix user, which is a member of thebatm
group.The Master service listens on port 7741.
Please note that the same port uses Gate service but on a different interface.
Note |
---|
The Master service should never be exposed to the Internet. |
Admin service
The Admin service listens for users' browser requests. It enables CAS users to configure ATMs remotely and inspect processed transactions.
The Admin service uses
batmadmin
unix user, which is a member of thebatm
group.The Admin service listens on port 7777.
Note |
---|
The Admin service should never be exposed to the Internet. |
Extensions
Very A very powerful way how to extend existing server’s functionality. More can be read here.for extending the existing functionality of the server.
More about extensions: