Skip to content

Latest commit

 

History

History
266 lines (140 loc) · 12.2 KB

README.md

File metadata and controls

266 lines (140 loc) · 12.2 KB
Raw

Cloud Connector

The repository contains the cloud connector component used in the Eclipse Leda stack.

Build

Build prerequisites

  • Go 1.17 (or higher) needs to be available on the build host.
  • Set the GOOS & GOARCH environment variables to build the cloud connector for a specific platform.

Supported Go platforms

The build process supports the following Golang platforms:

  • linux/arm
  • linux/arm64
  • linux/amd64
  • windows/amd64

Manual build

Navigate to <root_level>/cmd where <root_level> is the root of the repo and execute:

Linux:

go build -ldflags="-s -w -X "main.version=$CLOUD_CONNECTOR_VERSION"" -trimpath -mod=readonly -o target/cloudconnector

Windows:

go build -ldflags="-s -w -X "main.version=$CLOUD_CONNECTOR_VERSION"" -trimpath -mod=readonly -o target/cloudconnector.exe

Where $CLOUD_CONNECTOR_VERSION has to be replaced with a required, custom version of the cloud connector.

The build process produces a binary with name cloudconnector or cloudconnector.exe, located in target subfolder.

By executing a shell script

Navigate to <root_level>/cmd/build.sh where <root_level> is the root of the repo and execute: sudo .\build.sh <version> where <version> and things are optional. If provided, <version> has to be replaced with a required, custom version of the cloud connector.

The build process produces a separate tarball archive per platform, located in target subfolder and additionally an aggregated assembly archive that packs all platform-specific assemblies.

The naming convention of a platform assembly is cloud_connector-$GOOS-$GOARCH.tar.gz, where $GOOS and $GOARCH represents respectively the Golang platform OS and architecture.

Each generated assembly packs the cloud connector binary, the root CA certificate, the cloud connector start/stop scripts for the specific platform and optionally the required static resources and configuration files.

Run

Supported options to get device connection info

There are several options how the cloud connector obtains its connection info:

  • Device connection string is provided in cloud connector config (either with SharedAccessKey or device key+certificate) – in this case cloud connector directly uses the provided data and tries to connect to Azure IoT Hub. Device should be already registered in Azure IoT Hub.
  • Configuration includes device key+certificate and idScope parameter – in this case the cloud connector connects to Azure DPS in order to register the device to an IoT Hub. Device should be pre-enrolled in Azure DPS.

Configuration parameters

The cloud connector supports the following configuration parameters:

  • Connection string

    Optional. Represents the connection string, used for the connectivity to the Azure IoT hub device.

    The name of the parameter is connectionString, when passed as a flag to the binary, or CONNECTION_STRING, when preset as an environment variable.

  • Device Certificate Path

    Optional. Represents the path to the X.509 certificate, used for the device authentication.

    The name of the parameter is cert, when passed as a flag to the binary, or CERT_PATH, when preset as an environment variable.

  • Device Certificate Key Path

    Optional. Represents the path to the private key, used for the device authentication.

    The name of the parameter is key, when passed as a flag to the binary, or KEY_PATH, when preset as an environment variable.

  • ID Scope

    Optional with default value ``. Represents the ID Scope for the Azure DPS authentication.

    The name of the parameter is idScope, when passed as a flag to the binary, or ID_SCOPE, when preset as an environment variable.

  • Tenant ID

    Optional with default value defaultTenant. Represents the tenant ID, which is used only internally with components that "speak" Ditto protocol, e.g. container management component.

    The name of the parameter is tenantId, when passed as a flag to the binary, or TENANT_ID, when preset as an environment variable.

  • Passthrough Device Topics

    Optional. Represents the list of the local MQTT topics that should be passed from the local MQTT broker to the cloud directly, without any topic remappings or payload transformation.

    The name of the parameter is passthroughDeviceTopics, when passed as a flag to the binary, or PASSTHROUGH_DEVICE_TOPICS, when preset as an environment variable.

  • Allowed Cloud Message Types

    Optional. Represents the list of the cloud command names that should be forwarded from the cloud to the local MQTT broker, without any payload transformations. The topic where the message is published in constructed from the other properties inside the cloud message: $appId/$cmdName.

    The name of the parameter is passthroughCommandNames, when passed as a flag to the binary, or PASSTHROUGH_COMMAND_NAMES, when preset as an environment variable.

  • Local Address

    Optional with default value tcp://localhost:1883. Represents the address of the local MQTT broker.

    The name of the parameter is localAddress, when passed as a flag to the binary, or LOCAL_ADDRESS, when preset as an environment variable.

  • SAS Token Validity

    Optional with default value 1h. Represents the validity period of the SAS token for device authentication.

    The name of the parameter is sasTokenValidity, when passed as a flag to the binary, or SAS_TOKEN_VALIDITY, when preset as an environment variable.

  • Root Certificate Path

    Optional with default value iothub.crt. Represents the path to the X.509 certificate, used for the connection to the Azure IoT Hub via MQTT.

    The name of the parameter is caCert, when passed as a flag to the binary, or CA_CERT_PATH, when preset as an environment variable.

  • Log File Location

    Optional with default value logs/log.txt. Represents the log file location.

    The name of the parameter is logFile, when passed as a flag to the binary, or LOG_FILE, when preset as an environment variable.

  • Message Mapper File Location

    Optional with default value message-mapper-config.json. Represents the message mappings configuration file location.

    The name of the parameter is messageMapperConfig, when passed as a flag to the binary, or MESSAGE_MAPPER_CONFIG, when preset as an environment variable.

  • Config File Location

    Optional with default empty value. Represents the connector configuration json file location.

    The name of the parameter is configFile, when passed as a flag to the binary, or CLOUD_CONNECTOR_CONFIG, when preset as an environment variable.

  • Log Level

    Optional with default value INFO. Represents the log level. The possible values are : TRACE, DEBUG, INFO, ERROR.

    The name of the parameter is logLevel, when passed as a flag to the binary, or LOG_LEVEL, when preset as an environment variable.

  • Passthrough Command Topic

    The passthrough command MQTT topic where all messages from the cloud are forwarded to on the local broker (default "cloud-to-device")

    The name of the parameter is passthroughCommandTopic, when passed as a flag to the binary, or PASSTHROUGH_COMMAND_TOPIC, when preset as an environment variable.

  • Passthrough Telemetry Topics

    The comma-separated list of passthrough telemetry MQTT topics the azure connector listens to on the local broker (default "device-to-cloud")

    The name of the parameter is passthroughTelemetryTopics, when passed as a flag to the binary, or PASSTHROUGH_TELEMETRY_TOPICS, when preset as an environment variable.

  • Device Certificate

    A PEM encoded certificate file for cloud access

    The name of the parameter is cert, when passed as a flag to the binary, or CERT_FILE, when preset as an environment variable.

  • Device Certificate Private Key

    A PEM encoded unencrypted private key file for cloud access

    The name of the parameter is key, when passed as a flag to the binary, or KEY_FILE, when preset as an environment variable.

  • Local Broker CA certificate file

    A PEM encoded local broker CA certificates file

    The name of the parameter is localCACert, when passed as a flag to the binary, or LOCAL_CA_CERT_FILE, when preset as an environment variable.

  • Local Broker Connection certificate file

    A PEM encoded certificate file for local broker

    The name of the parameter is localCert, when passed as a flag to the binary, or LOCAL_CERT_FILE, when preset as an environment variable.

  • Local Broker Connection private key file

    A PEM encoded unencrypted private key file for local broker

    The name of the parameter is localKey, when passed as a flag to the binary, or LOCAL_KEY_FILE, when preset as an environment variable.

  • Validity of SAS Token

    The validity period for the generated SAS token for device authentication. Should be a positive integer number followed by a unit suffix, such as '300m', '1h', etc. Valid time units are 'm' (minutes), 'h' (hours), 'd' (days) (default "1h")

    The name of the parameter is sasTokenValidity, when passed as a flag to the binary, or SAS_TOKEN_VALIDITY, when preset as an environment variable.

  • TPM Device name

    Path to the device file or the unix socket to access the TPM2

    The name of the parameter is tpmDevice, when passed as a flag to the binary, or TPM_DEVICE, when preset as an environment variable.

  • TPM Handle

    TPM2 storage root key handle (uint)

    The name of the parameter is tpmHandle, when passed as a flag to the binary, or TPM_HANDLE, when preset as an environment variable.

  • TPM private key

    Private part of TPM2 key file

    The name of the parameter is tpmKey, when passed as a flag to the binary, or TPM_KEY, when preset as an environment variable.

  • TPM public key

    Public part of TPM2 key file

    The name of the parameter is tpmKeyPub, when passed as a flag to the binary, or TPM_KEY_PUB, when preset as an environment variable.

Authentication mode

The cloud connector authenticates to cloud, using two alternative mechanisms - by SAS token or X.509 certificate.

SAS token-based device authentication

To connect to the cloud, using SAS token-based device authentication, the cloud connector must be started with provided a required Azure device connection string in the format HostName=<hostName>;DeviceId=<deviceId>;SharedAccessKey=<base64-encoded-shared-access-key>.

Optionally, a SAS token validity parameter can be provided to overwrite the default and apply custom SAS token validity period.

X.509 certificate-based authentication

To connect to the cloud, using X.509 certificate-based authentication, the cloud connector must be started with provided a required device certificate and device certificate key.

Optionally, a connection string in the format HostName=<hostName>;DeviceId=<deviceId> can be provided that contains the device connection info. If omitted, the cloud connector contacts the global Azure Provisioning Service to obtain the info for a given idScope.

Instructions

The cloud connector can be started in both ways:

  • As a standalone executable

    Run from the commandline cloudconnector <params>, where <params> denotes a list of supported cloud connector parameters (listed above), depending on the chosen device authentication mode.

  • By executing a shell script

    Execute the shell script cloudconnector_start.sh (or .bat for the windows/amd64 platform), located at <root_level>/resources. It is required that the script and the binary has to be placed in the same folder. The configuration parameters shall be passed as parameters to the script or preset as environment variables on the host.

    Note: If the cloud connector is started without specifying a custom X.509 certificate file, the default one, located at <root_level>/resources/iothub.crt needs be copied and placed in the same folder as the cloud connector binary.

Contributing

If you want to contribute bug reports or feature requests, please use GitHub Issues.

Data privacy notice

Please see our data privacy notice

License and Copyright

This program and the accompanying materials are made available under the terms of the Apache License 2.0 which is available at https://www.apache.org/licenses/LICENSE-2.0

For details, please see our license LICENSE