suneetnangia/azure-iot-edge-secure-access repository overview

Azure IoT Edge module image which allows remote access to the edge device via device streams feature.

Please refer to the GitHub repo here⁠ for more technical details.

⁠Image Variants

⁠suneetnangia/azure-iot-edge-secure-access:< cpu architecture >

This is a stable image version which can be used in the production environments.

Images here are built from the stable⁠ branch in GitHub repo.

⁠suneetnangia/azure-iot-edge-secure-access:< ci-cpu architecture >

This is a CI build images which are built using debug configurations for better dev/test experiences.

Images here are built from the master⁠ branch in GitHub repo.

⁠Image Usage

This image runs in Azure IoT Edge environment as an IoT Edge device module which can be on any of the supported environments.

Steps-

1. Create a device in IoT Hub. Ensure it is created in a region where Device Stream feature is supported.
2. Create IoT devices one for each protocol (e.g. call them SSHDevice, SCPDevice, RDPDevice).
3. Create an edge device in IoT Hub.
4. Add IoT Edge module which points to one of the images in this repository as per your target environment/cpu architecture.

The module needs the following environment variables to be configured-

⁠SSH

1. sshDeviceConnectionString- Connection string of an IoT device (created in step 1 above) which will be used to connect remote clients using Device Stream feature. Example value: HostName=SEDataHubStreams.azure-devices.net;DeviceId=SSHDevice;SharedAccessKey=VP/Qcazf/KAhb8IDUKGs6erbSUf6g2KRLNieHanKZcY=
2. sshTargetHost- IP or hostname of the service which can be connected remotely, e.g. SSH service. Example value: 10.0.0.5
3. sshTargetPort- port of the service which can be connected remotely, e.g. SSH service. Example value: 22

⁠SCP

1. scpDeviceConnectionString- Connection string of an IoT device (created in step 1 above) which will be used to connect remote clients using Device Stream feature. Example value: HostName=SEDataHubStreams.azure-devices.net;DeviceId=SSHDevice;SharedAccessKey=VP/Qcazf/KAhb8IDUKGs6erbSUf6g2KRLNieHanKZcY=
2. scpTargetHost- IP or hostname of the service which can be connected remotely, e.g. SSH service. Example value: 10.0.0.5
3. scpTargetPort- port of the service which can be connected remotely, e.g. SSH service. Example value: 22

⁠RDP

1. rdpDeviceConnectionString- Connection string of an IoT device (created in step 1 above) which will be used to connect remote clients using Device Stream feature. Example value: HostName=SEDataHubStreams.azure-devices.net;DeviceId=SSHDevice;SharedAccessKey=VP/Qcazf/KAhb8IDUKGs6erbSUf6g2KRLNieHanKZcY=
2. rdpTargetHost- IP or hostname of the service which can be connected remotely, e.g. SSH service. Example value: 10.0.0.5
3. rdpTargetPort- port of the service which can be connected remotely, e.g. SSH service. Example value: 3389

⁠Warranties

This code is written on best effort basis to allow you to use these images directly without any modifications in your environment or solution. There are no official warranties or support provided by the author. Contributions and suggestions are welcomed.