Configuration files in Protocol Gateway

This article includes updates for CM 8.11.

This article describes the configuration files and folders that come with Protocol Gateway.

Each enrollment protocol is configured in a separate <protocol>.properties file and determines the following:

The flag to enable the protocol.
The names of the enrollment token procedures in CM server.
The name and location of any device RA token.
Any protocol specific configuration.

It is possible to override the cmHost and officer parameters specified in cmgateway.properties. on a protocol and/or handler level. This makes it possible for different protocols and handlers to connect to different CF instances. See below for an example on how to configure cmHost and officer for a handler:

Example: How to configure cmHost and officer for a handler

handler.20.filter = certificates/[a-z0-9A-Z]+/details
handler.20.format = api/certificates-details
handler.20.cmhost = cf-host-ip
handler.20.officer.keyfile = protocol-gateway-vro-cf-host-ip.p12
handler.20.officer.password = <...>

<configroot> path

The <protocol>.properties file are stored in the <configroot> path.

<configroot> corresponds to the following paths:

Windows <configroot>

%ALLUSERSPROFILE%/Nexus/cm-gateway/

Linux <configroot>

/var/cm-gateway/

Configuration files

These are the standard configuration files in <configroot>/conf:

Configuration files and folders	Description

Configuration files and folders	Description
acme.properties	Contains configuration for the ACME service.
api.properties	Contains configuration for the CM REST API service.
auth.properties	Contains configuration for the CM WEB UI authorization service.
cmgateway.properties	Defines network parameters and service definitions.
cmc.properties	Contains configuration for the CMC service.
cmp.properties	Contains configuration for the CMP service.
dc.properties	Contains configuration for the Distribution Center service.
dp.properties	Contains configuration for the Distribution Point service.
est.properties	Contains configuration for the EST service.
itss.properties	Contains configurations for ETSI Intelligent Transportation System Stations. See also Upgrade Protocol Gateway.
logging.properties	Contains configuration for logging.
ping.properties	Contains configuration for the Ping service.
scep.properties	Contains configuration for the SCEP service.
sdkproxy.properties	Contains configuration for the SDK Proxy service.
winep.properties	Contains configuration for the WinEP service.
certdir	The certdir folder contains the trusted issuer certificates of the TLS server certificate of the CM server.

Configure verifications of certificate requests

For more information, see Certificate request verifications in Protocol Gateway.