Using Mutual TLS for Agents

Configure protocol-mapper agents to authenticate with Connectware over mutual TLS (mTLS) using client and CA certificates.

You can configure protocol-mapper agents to use mutual TLS (mTLS) for secure communication with Connectware. In the following example setup, the agent connects via MQTT over a secure TLS connection (port 8883), requiring both client and CA certificates for mutual authentication. This approach ensures that both the server and the client verify each other's identities, adding an extra layer of security.

Setting CYBUS_USE_MUTUAL_TLS to true switches CYBUS_DATAPLANE_SCHEME to mqtts and CYBUS_DATAPLANE_PORT to 8883, so the example does not set them. Set them explicitly only if your Connectware instance uses a different scheme or port. See Environment Variables.

The example also mounts the client certificate and the CA certificate as Docker volumes.

services:
  protocol-mapper-agent:
    image: registry.cybus.io/cybus/protocol-mapper:${IMAGE_TAG}
    environment:
      CYBUS_AGENT_MODE: distributed
      CYBUS_AGENT_NAME: myAgent
      CYBUS_HOSTNAME_INGRESS: connectware.example.com
      CYBUS_USE_MUTUAL_TLS: true
    volumes:
      - protocol-mapper-agent:/data
      - /mycerts:/connectware/certs/client
      - /myca:/connectware/certs/ca
    restart: unless-stopped
    network_mode: bridge
    hostname: <some-suitable-hostname>
volumes:
  protocol-mapper-agent:

Replace ${IMAGE_TAG} with the protocol-mapper agent image version that matches your Connectware version, and connectware.example.com with the address of your Connectware server.

The example uses network_mode: bridge so that several agents can run on the same host. See Network Mode.