Implement GCP Cloud IoT Core integration.

Author: brocaar

.gitignore

@@ -14,3 +14,6 @@
 
 # dependencies
 /vendor
+
+# certificates
+/certs

Gopkg.lock

@@ -44,3 +44,7 @@
 [[override]]
   version = "v1.1.0"
   name = "github.com/golang/protobuf"
+
+[[constraint]]
+  name = "github.com/dgrijalva/jwt-go"
+  version = "3.2.0"

Gopkg.toml

@@ -78,6 +78,9 @@ skip_crc_check = {{ .PacketForwarder.SkipCRCCheck }}
 # LoRa Server MQTT backend. Therefore only change these values when
 # absolutely needed.
 # Use "{{ "{{ .MAC }}" }}" as an substitution for the LoRa gateway MAC. 
+#
+# Note that some authentication types might overwrite these templates (e.g.
+# in case of GCP Cloud IoT Core)!
 uplink_topic_template="{{ .Backend.MQTT.UplinkTopicTemplate }}"
 downlink_topic_template="{{ .Backend.MQTT.DownlinkTopicTemplate }}"
 stats_topic_template="{{ .Backend.MQTT.StatsTopicTemplate }}"
@@ -154,6 +157,41 @@ marshaler="{{ .Backend.MQTT.Marshaler }}"
     max_reconnect_interval="{{ .Backend.MQTT.Auth.Generic.MaxReconnectInterval }}"
 
 
+    # Google Cloud Platform Cloud IoT Core authentication.
+    #
+    # Please note that when using this authentication type, the MQTT topics
+    # will be automatically set to match the MQTT topics as expected by
+    # Cloud IoT Core.
+    [backend.mqtt.auth.gcp_cloud_iot_core]
+    # MQTT server.
+    server="{{ .Backend.MQTT.Auth.GCPCloudIoTCore.Server }}"
+
+    # Google Cloud IoT Core Device id.
+    device_id="{{ .Backend.MQTT.Auth.GCPCloudIoTCore.DeviceID }}"
+
+    # Google Cloud project id.
+    project_id="{{ .Backend.MQTT.Auth.GCPCloudIoTCore.ProjectID }}"
+
+    # Google Cloud region.
+    cloud_region="{{ .Backend.MQTT.Auth.GCPCloudIoTCore.CloudRegion }}"
+
+    # Google Cloud IoT registry id.
+    registry_id="{{ .Backend.MQTT.Auth.GCPCloudIoTCore.RegistryID }}"
+
+    # JWT token expiration time.
+    jwt_expiration="{{ .Backend.MQTT.Auth.GCPCloudIoTCore.JWTExpiration }}"
+
+    # JWT token key-file.
+    #
+    # Example command to generate a key-pair:
+    #  $ ssh-keygen -t rsa -b 4096 -f private-key.pem
+    #  $ openssl rsa -in private-key.pem -pubout -outform PEM -out public-key.pem
+    #
+    # Then point the setting below to the private-key.pem and associate the
+    # public-key.pem with this device / gateway in Google Cloud IoT Core.
+    jwt_key_file="{{ .Backend.MQTT.Auth.GCPCloudIoTCore.JWTKeyFile }}"
+
+
 # Metrics configuration.
 [metrics]
 

cmd/lora-gateway-bridge/cmd/configfile.go

@@ -81,11 +81,13 @@ func init() {
 
 	viper.SetDefault("backend.mqtt.marshaler", "v2_json")
 	viper.SetDefault("backend.mqtt.auth.type", "generic")
+
 	viper.SetDefault("backend.mqtt.auth.generic.server", "tcp://127.0.0.1:1883")
 	viper.SetDefault("backend.mqtt.auth.generic.clean_session", true)
 	viper.SetDefault("backend.mqtt.auth.generic.max_reconnect_interval", 10*time.Minute)
 
-	viper.SetDefault("metrics.prometheus.bind", "")
+	viper.SetDefault("backend.mqtt.auth.gcp_cloud_iot_core.server", "ssl://mqtt.googleapis.com:8883")
+	viper.SetDefault("backend.mqtt.auth.gcp_cloud_iot_core.jwt_expiration", time.Hour*24)
 
 	rootCmd.AddCommand(versionCmd)
 	rootCmd.AddCommand(configCmd)

cmd/lora-gateway-bridge/cmd/root.go

@@ -1,6 +1,7 @@
 package cmd
 
 import (
+	"fmt"
 	"net/http"
 	"os"
 	"os/signal"
@@ -56,6 +57,10 @@ func run(cmd *cobra.Command, args []string) error {
 	}()
 
 	if config.C.Backend.MQTT.Marshaler == "v2_json" {
+		if config.C.Backend.MQTT.Auth.Type != "generic" {
+			return fmt.Errorf("auth type '%s' can not be used with 'v2_json' marshaler", config.C.Backend.MQTT.Auth.Type)
+		}
+
 		return runV2(cmd, args)
 	}
 	return runV3(cmd, args)

cmd/lora-gateway-bridge/cmd/root_run.go

@@ -19,10 +19,10 @@ pygmentsUseClasses = true
     weight = 2
 
 [[menu.main]]
-    pre = "<i class='fas fa-user'></i>"
-    name = "Use"
-    identifier = "use"
-    url = "/use/"
+    pre = "<i class='fas fa-code'></i>"
+    name = "Integrate"
+    identifier = "integrate"
+    url = "/integrate/"
     weight = 3
 
 [[menu.main]]

docs/config.toml

@@ -142,6 +142,9 @@ skip_crc_check = false
 # LoRa Server MQTT backend. Therefore only change these values when
 # absolutely needed.
 # Use "{{ .MAC }}" as an substitution for the LoRa gateway MAC.
+#
+# Note that some authentication types might overwrite these templates (e.g.
+# in case of GCP Cloud IoT Core)!
 uplink_topic_template="gateway/{{ .MAC }}/rx"
 downlink_topic_template="gateway/{{ .MAC }}/tx"
 stats_topic_template="gateway/{{ .MAC }}/stats"
@@ -218,6 +221,41 @@ marshaler="v2_json"
     max_reconnect_interval="10m0s"
 
 
+    # Google Cloud Platform Cloud IoT Core authentication.
+    #
+    # Please note that when using this authentication type, the MQTT topics
+    # will be automatically set to match the MQTT topics as expected by
+    # Cloud IoT Core.
+    [backend.mqtt.auth.gcp_cloud_iot_core]
+    # MQTT server.
+    server="ssl://mqtt.googleapis.com:8883"
+
+    # Google Cloud IoT Core Device id.
+    device_id=""
+
+    # Google Cloud project id.
+    project_id=""
+
+    # Google Cloud region.
+    cloud_region=""
+
+    # Google Cloud IoT registry id.
+    registry_id=""
+
+    # JWT token expiration time.
+    jwt_expiration="24h0m0s"
+
+    # JWT token key-file.
+    #
+    # Example command to generate a key-pair:
+    #  $ ssh-keygen -t rsa -b 4096 -f private-key.pem
+    #  $ openssl rsa -in private-key.pem -pubout -outform PEM -out public-key.pem
+    #
+    # Then point the setting below to the private-key.pem and associate the
+    # public-key.pem with this device / gateway in Google Cloud IoT Core.
+    jwt_key_file=""
+
+
 # Metrics configuration.
 [metrics]
 

docs/content/install/config.md

@@ -11,7 +11,7 @@ description: Instructions on how to install the LoRa Gateway Bridge component on
 # Gateway installation & configuration
 
 For Raspberry Pi / Rasbian based gateways, please refer the
-[Debian / Ubuntu]({{< ref "install/debian.md" >}}) installation instructions.
+[Debian / Ubuntu]({{< ref "/install/debian.md" >}}) installation instructions.
 
 ## Contribute to this list
 

docs/content/install/gateway/_index.md

@@ -22,7 +22,7 @@ These steps will install the LoRa Gateway Bridge ARM build on the Kerlink.
     {{< /highlight >}}
 
 2. Download and extract the LoRa Gateway Bridge ARM binary into the above
-   directory. See [downloads]({{< ref "overview/downloads.md" >}}).
+   directory. See [downloads]({{< ref "/overview/downloads.md" >}}).
    Make sure the binary is marked as executable.
 
 3. Save the following content as `/mnt/fsuser-1/lora-gateway-bridge/start.sh`: