...
Migration path from version 2 to version 3
The directory structure did not change.Atheos Server must be upgraded for the sequence number.version 3 of the Gateway is not a drop-in replacement for version 2. The actions required to upgrade to this new version:
Atheos Server must be updated to version xx.yy.zz
Update the configuration file
Update the configuration of the component ??????????????????????
Atheos Server must be updated to version xx.yy.zz
This is pretty straight forward. It should be handled the same way as the previous updates. The changes introduced to support version 3 of the Gateway are listed in the Atheos Server release notes.
Update the configuration file
The default configuration distributed with the Gateway version 3 contains many comments. This section contains general information that describes the overall configuration file. The sample configuration file is given at the end of this section.
NOTE: The content of the configuration is case-sensitive.
Currently, the sections defined in the configuration are:
LogFile
MessagesRepositories
Connectivity
ServerSSLCertificate
ServerSSLPrivateKey
Security Provider sections
OpenSSL
Performance
Nexo
PoiConfigurations
LogFile
The log file was defined in previous versions using only the parameter LogFile. It is now a section which contains the following parameters:
Parameter | Previous parameter |
|---|---|
URI | LogFile |
DirectoriesPermissions | n/a |
FilePermissions | n/a |
The URI parameter define the file that will be used for the log file. A fully qualified file name is required. It must comply to the following format: file://fully-qualified-filename. As an example, if the log file to be used is /var/log/amadis/atheosgw.log, the parameter should be:
| Code Block | ||
|---|---|---|
| ||
URI = file:///var/log/amadis/atheosgw.log |
Any missing directories in the log file path will be created with the permissions specified by the parameter DirectoriesPermissions.
The log file permissions will be set to the value of the parameter FilePermissions.
The permission values must be numerical. As an example, the permission rw-r--r shall be given as 0644. The leading zero is important which explicitly qualify an octal value.
Parameters that are no longer in the configuration file
These parameters must be moved into the specific configuration files
MOVED
ASFileUploadSignatureKey
NexoMessagesUploadURL
GatewayId
DELETED
DebugDumpMessages
| Code Block |
|---|
###############################################################################
#
# Atheos Gateway V3 Configuration File
#
# Copyright ©2005-2021 - 9164-4187 QUEBEC INC (“AMADIS”), All Rights Reserved
#
###############################################################################
#
[LogFile]
# Log file location. A fully qualified file name must be supplied.
URI = file:///tmp/agw/var/log/amadis/atheosgw.log
# Directories permissions
DirectoriesPermissions = 0770
# File permissions
FilePermissions = 0640
[MessagesRepositories]
# Base directory where the messages received and sent to the POI are saved.
# Previously FileRepositoryBaseDir
BaseDirectory=/tmp/agw/home/amadis/files
# Directories permissions for the message repositories
DirectoriesPermissions = 0770
# File permissions for the message repositories
FilePermissions = 0640
[Connectivity]
# Server incoming connection port. Previously ServerPort
ListeningPort = 55554
# Address on which the server will bind (listen) to.
BindingAddress = 0.0.0.0
# Server certificate used
[ServerSSLCertificate]
CryptographicProvider = OpenSSL
Type = X509Certificate
Format = PEM
URI = file://server.crt
# Private key for the server certificate. Password protected keys are not
# supported yet.
[ServerSSLPrivateKey]
CryptographicProvider = OpenSSL
Type = PrivateKey
Format = PEM
URI=file://server.unprotected.key
#[ServerSSLPrivateKey]
#CryptographicProvider = hsm1
#Type = PrivateKey
#URI = pkcs11:model=SoftHSM%20v2;manufacturer=SoftHSM%20project;serial=abe6ed66024f38b2;token=claude;id=%40%00;object=serverkey;type=private;pin-value=4321
[hsm1]
# Engine type (internal or HSM)
Type = PKCS11HSM
# Engine ID
ID=pkcs11
# Engine library path
SOPath=/usr/lib/x86_64-linux-gnu/engines-1.1/libpkcs11.so
# Engine module path as required by the engine shared object library.
ModulePath=/usr/lib/softhsm/libsofthsm2.so
# Engine PIN
PIN=4321
[OpenSSL]
Type = OpenSSL
Version = 1.0.0
[Performance]
# Maximum number of concurrent connections the server will handle before
# queuing the other ones.
MaximumConnections = 10
# Pending connections queue length. If MaximumConnections is reached, up to
# PendingConnectionQueueLength connections will be queued before rejecting
# them.
PendingConnectionQueueLength = 200
# Maximium wait time while listening for a new connection in microseconds.
ListeningMaximumWaitTime = 100000
# Time in seconds the server will wait before terminating
# active connections.
ShutdownDelay = 60
# Timeout in seconds of a connection with a POI.
SSLTimeout = 60
# Maximum wait time when waiting for an event on a socket.
SocketSelectMaximumWaitTime = 100000
# Nexo message initial input buffer size in bytes. This value shall not be
# lower than 2000 bytes.
NexoMessageInitialBufferSize = 48000
# Nexo Builder Buffer size in bytes. NexoBuilderErrorMessagesBufferSize bytes
# are reverved as the error message buffer.
NexoBuilderBufferSize = 48000
# How much space to reserve in the Nexo Builder Buffer for error messages.
# It must be lower than 3072.
NexoBuilderErrorMessagesBufferSize = 1024
[Nexo]
# Nexo protocol version included in the Nexo messages
ProtocolVersion = 6.0
# Terminal Manager Id included in the Nexo messages
TerminalManagerId=ATHEOS-TMS01
[PoiConfigurations]
# Base directory root where the configuration files and
# the management plans for the POIs are located.
BaseDirectory = /tmp/agw/home/amadis/poi
# Directories permissions for the message repositories
DirectoriesPermissions = 0770
# User under which the AtheosGW will be running. Should not be root.
User=amadis
# Group under which the AtheosGW will be running. Should not be root.
Group=amadis
#### File containing the server SSL certificate.
###ServerCertificateFile=/etc/amadis/server03.crt
#### File containing the server SSL key. The key shall
#### not be password protected. Its protection must be
#### done using the operating system build in security.
###ServerPrivateKey=/etc/amadis/server.unprotected.key |
old file
| Code Block |
|---|
# User under which the AtheosGW will be running. Should not be root.
User=amadis
# Group under which the AtheosGW will be running. Should not be root.
Group=amadis
# Log file location. A fully qualified file name must be supplied.
LogFile=/var/log/amadis/atheosgw.log
# Address on which the server will bind (listen) to.
BindingAddress=0.0.0.0
# Server incoming connection port.
ServerPort=55554
# Maximum number of connections the server will handle before queuing
# the other ones.
MaxConnections=10
# Incoming connection polling period in microseconds.
ListenPollingPeriod=100000
# Time in seconds the server will wait before terminating
# active connections.
ShutdownDelay=60
# File containing the server SSL certificate.
ServerCertificateFile=/etc/amadis/server03.crt
# File containing the server SSL key. The key shall
# not be password protected. Its protection must be
# done using the operating system build in security.
ServerPrivateKey=/etc/amadis/server.unprotected.key
# Base directory where the files used by the server
# are located which includes the messages received
# and sent to the POIs.
FileRepositoryBaseDir=/home/amadis/files
# Timeout in seconds of a connection with a POI.
SSLTimeout=60000
# Polling period of the read function while waiting
# for some data from a POI.
SSLReadWaitTimeSec=0
SSLReadWaitTimeuSec=100000
# Base directory root where the configuration files and
# management plans for the POIs are located.
POIDataRoot=/home/amadis/poi
# Version of the Nexo TMS protocol handled by the server.
# This value is included in the Nexo messges sent to the
# POIs. Currently, it has no effect of the behavior of
# the server.
NexoTMSProtocolVersion=6.0
# Terminal Manager Id. This value is include in Nexo
# messages sent to the POIs.
TerminalManagerId=ATHEOS-NPS-TMS1
# Pending connections queue length.
# If MaxConnections is reached, up to PendingConnectionQueueLength
# connections will be queued before rejecting them.
PendingConnectionQueueLength=200
|