Matching results

    MQTT security

    Initializing Table Of Contents...

    Security Modes

    This page explains how to secure your communication to AirVantage when using MQTT. Three methods are supported:

    • MQTT with user/password: Authentication with MQTT user/password, no encryption and no server authentication (not to be used in production). Port: 1883
    • MQTT/TLS (one-way authentication): Secure channel over TLS 1.2 (Server authentication and encryption) based on user/password to authenticate the device, and the AirVantage’s certificate to authenticate the server. Port: 8883
    • MQTT/TLS (mutual authentication): Mutual certificate-based authentication (server and device) & encryption. Port: 8883

    When the mutual authentication with certificates is used, the user/password authentication mechanism will not be taken into account here.

    Key generation

    Key generation

    Certificates are issued based on authentication of public keys, and must be signed by a Certification Authority (CA).

    Key-pair generation

    At the factory, the device generates a key-pair: one public key and one private key.

    These keys will be used to authenticate the client during handshake with AirVantage.

    About Certificates validation chain & revocation...

    A certificate can be signed by an intermediate CA, which can be itself signed by another intermediate CA - and so forth, until a trusted root CA is reached.

    By following the CA chain, the identity and validity of a certificate owner can be verified and trusted.

    AirVantage manages the certificate revocation.

    Username/Password Configuration

    In order to configure the device’s “username” and password in AirVantage, follow the tutorial below:

    In this case, the application model must include this security parameter:

    <protocol comm-id="SERIAL" type="MQTT" >
        <parameter name="mqtt-security" value="user-password"/>

    TLS Configuration

    AirVantage Certificate

    The AirVantage root CA is goDaddy. Get the AirVantage root CA certificate . The AirVantage CA ROOT certificate has to be stored in the hardware memory in order to validate AirVantage identity.

    Device Certificate

    Upload your root CA certificate to AirVantage (Contact the support team to upload this certificate).

    Your certificate must include the following requirements:

    • Certificate Common Name (CN) has to be the « communication ID », that is to say the IMEI or any Serial Number (according to what has been configured in the application model ).
    • The hardware certificate has really been signed by customer’s PKI, using customer’s CA root certificate configured in the customer’s company,
    • The MQTT topic path where the data will be pushed, really corresponds to the communication ID (IMEI, Serial number, …) declared in the certificate CN.
    In this case, the application model must include this security parameter:

    <protocol comm-id="SERIAL" type="MQTT" >
        <parameter name="mqtt-security" value="x509"/>

    Supported Cipher suites

    AirVantage supports TLS 1.2 and the following cipher suites:


    An AirVantage public key is signed with a RSA key. As a consequence a cipher suite based on this mechanism has to be selected.


    Data integrity can be guaranteed by the embedded application by adding a signature of the data in each JSON message. This signature must be in the DATA section of the JSON format. Thus the signature will be taken as an additional datapoint of the solution.


    {"14037939309874": {   
    "dongle.serial": "11111111111",    
    "vehicle.tire.pressure": "2.2",    
    "signature" : "AADDFE3245"}


    AirVantage expects the MQTT client to :

    • have access to a certificate from its Root CA
    • connect to a MQTTS endpoint (eg “mqtts://”) corresponding to its Root CA
    • send its TLS certificate (option “tls.RequireAndVerifyClientCert” will be set on the server side)
    • use its “MQTT Comm Id” as the “CommonName” field
    • set the “server_name” TLS extension properly

    Here’s an example of a SWIR client connecting using a certificate issued by ClientCA”:

    var mqtt = require('mqtt');
    var fs = require("fs");
    var rootCA = fs.readFileSync("~/secu/SSLCA/root/rootca.crt");
    var clientCert = fs.readFileSync("~/secu/client.crt");
    var clientKey = fs.readFileSync("~/secu/client.key");
    var client  = mqtt.connect('mqtts://', {
        ca : [rootCA],
        cert : clientCert,
        key :  clientKey,
        servername : ""

    And here’s the corresponding client connecting with a certificate issued by the customer’s CA:

    #!/usr/bin/env node
    var mqtt = require('mqtt');
    var fs = require("fs");
    var rootCA = fs.readFileSync("~/secu/SSLCA/root2/rootca2.crt");
    var clientCert = fs.readFileSync("~/secu/customer-client.crt");
    var clientKey = fs.readFileSync("~/secu/customer-client.key");
    // Note that the client is using the customer's URL
    var client  = mqtt.connect('mqtts://', {
        ca : [rootCA],
        cert : clientCert,
        key :  clientKey,
        servername : ""