NOISSUE - Update magistrala messaging #188

nyagamunene · 2024-05-20T23:23:02Z

What does this do?

It updated Magistrala messaging docs. It provides examples of how to do it.

List any changes that modify/break current functionality

It adds the functionality of running Magistrala with TLS and MTLS.

Have you included tests for your changes?

Yes.

Did you document any new/modified functionality?

Yes

Notes

Signed-off-by: nyagamunene <[email protected]>

felixgateru · 2024-05-22T11:10:42Z

docs/messaging.md

@@ -1,33 +1,88 @@
 # Messaging

-Once a channel is provisioned and thing is connected to it, it can start to publish messages on the channel. The following sections will provide an example of message publishing for each of the supported protocols.
+Once a channel is provisioned and thing is connected to it, it can start to publish messages on the channel. The following sections will provide an example of message publishing for each of the supported protocols, with the examples being shown without TLS, with TLS, and with mTLS.
+> While using MTLS the `thing.crt` and `thing.crt` can be genarated by running `make thing_cert` while in the `docker/ssl` folder


thing.key and thing crt.

felixgateru · 2024-05-22T11:12:51Z

docs/messaging.md

@@ -1,33 +1,88 @@
 # Messaging

-Once a channel is provisioned and thing is connected to it, it can start to publish messages on the channel. The following sections will provide an example of message publishing for each of the supported protocols.
+Once a channel is provisioned and thing is connected to it, it can start to publish messages on the channel. The following sections will provide an example of message publishing for each of the supported protocols, with the examples being shown without TLS, with TLS, and with mTLS.
+> While using MTLS the `thing.crt` and `thing.crt` can be genarated by running `make thing_cert` while in the `docker/ssl` folder


Also as it is mtls would it be more appropriate to have magistrala-client.key and magistrala-client.crt

felixgateru · 2024-05-22T11:15:53Z

docs/messaging.md


 ## HTTP

-To publish message over channel, thing should send following request:
+The following environmental variables are used to enable or disable HTTP with TLS and MTLS: `MG_HTTP_ADAPTER_CERT_FILE`,`MG_HTTP_ADAPTER_KEY_FILE`, `MG_HTTP_ADAPTER_SERVER_CA_FILE`, `MG_HTTP_ADAPTER_CLIENT_CA_FILE`. These can be located in the `docker/.env` file.


Suggested change

The following environmental variables are used to enable or disable HTTP with TLS and MTLS: `MG_HTTP_ADAPTER_CERT_FILE`,`MG_HTTP_ADAPTER_KEY_FILE`, `MG_HTTP_ADAPTER_SERVER_CA_FILE`, `MG_HTTP_ADAPTER_CLIENT_CA_FILE`. These can be located in the `docker/.env` file.

The following environment variables are used to enable or disable HTTP with TLS and MTLS: `MG_HTTP_ADAPTER_CERT_FILE`,`MG_HTTP_ADAPTER_KEY_FILE`, `MG_HTTP_ADAPTER_SERVER_CA_FILE`, `MG_HTTP_ADAPTER_CLIENT_CA_FILE`. These can be located in the `docker/.env` file.

felixgateru · 2024-05-22T11:23:51Z

docs/messaging.md

+
+### Without TLS
+
+To use magistala HTTP without TLS, comment out all of the listed environment variables provided above. To publish message over channel, thing should send following request:


You can also mention or provide an example for subscribing.

felixgateru · 2024-05-22T11:26:01Z

docs/messaging.md

 Note that if you're going to use senml message format, you should always send messages as an array.

 For more information about the HTTP messaging service API, please check out the [API documentation][http-api].

 ## MQTT

 To send and receive messages over MQTT you could use [Mosquitto tools][mosquitto], or [Paho][paho] if you want to use MQTT over WebSocket.
+The following environmental variables are used to enable or disable MQTT with TLS and MTLS: `MG_MQTT_ADAPTER_CERT_FILE`, `MG_MQTT_ADAPTER_KEY_FILE`, `MG_MQTT_ADAPTER_SERVER_CA_FILE`, `MG_MQTT_ADAPTER_CLIENT_CA_FILE`.


Suggested change

The following environmental variables are used to enable or disable MQTT with TLS and MTLS: `MG_MQTT_ADAPTER_CERT_FILE`, `MG_MQTT_ADAPTER_KEY_FILE`, `MG_MQTT_ADAPTER_SERVER_CA_FILE`, `MG_MQTT_ADAPTER_CLIENT_CA_FILE`.

The following environment variables are used to enable or disable MQTT with TLS and MTLS: `MG_MQTT_ADAPTER_CERT_FILE`, `MG_MQTT_ADAPTER_KEY_FILE`, `MG_MQTT_ADAPTER_SERVER_CA_FILE`, `MG_MQTT_ADAPTER_CLIENT_CA_FILE`.

docs/messaging.md

rodneyosodo

Also update coap messaging

rodneyosodo · 2024-05-22T12:15:22Z

docs/messaging.md

+        panic(token.Error())
+    }
+}
+


Add expected output

rodneyosodo · 2024-05-22T12:15:29Z

docs/messaging.md

+	}
+	return []byte{}, nil
+}
+


rodneyosodo · 2024-05-22T12:16:11Z

docs/messaging.md

+To use magistala HTTP without TLS, comment out all of the listed environment variables provided above. To publish message over channel, thing should send following request:
+
+```bash
+curl -s -S -i -X POST -H "Content-Type: application/senml+json" -H "Authorization: Thing <thing_secret>" http://localhost/http/channels/<channel_id>/messages -d '[{"bn":"some-base-name:","bt":1.276020076001e+09, "bu":"A","bver":5, "n":"voltage","u":"V","v":120.1}, {"n":"current","t":-5,"v":1.2}, {"n":"current","t":-4,"v":1.3}]'


For all examples add expected outputs

docs/messaging.md

felixgateru · 2024-05-22T12:17:42Z

docs/messaging.md

+
+### With TLS
+
+Uncomment out the following environment variables: `MG_MQTT_ADAPTER_WS_CERT_FILE`,`MG_MQTT_ADAPTER_WS_KEY_FILE` and comment out the rest to enable TLS certificates.


Suggested change

Uncomment out the following environment variables: `MG_MQTT_ADAPTER_WS_CERT_FILE`,`MG_MQTT_ADAPTER_WS_KEY_FILE` and comment out the rest to enable TLS certificates.

Uncomment the following environment variables: `MG_MQTT_ADAPTER_WS_CERT_FILE`,`MG_MQTT_ADAPTER_WS_KEY_FILE` and comment out the rest to enable TLS certificates.

docs/messaging.md

JeffMboya · 2024-05-22T12:42:56Z

docs/messaging.md

+```bash
+curl -s -S -i --cacert docker/ssl/certs/ca.crt --cert docker/ssl/certs/thing.crt --key docker/ssl/certs/thing.key -X POST -H "Content-Type: application/senml+json" -H "Authorization: Thing <thing_secret>" https://localhost/http/channels/<channel_id>/messages -d '[{"bn":"some-base-name:","bt":1.276020076001e+09, "bu":"A","bver":5, "n":"voltage","u":"V","v":120.1}, {"n":"current","t":-5,"v":1.2}, {"n":"current","t":-4,"v":1.3}]'
+```
+
 Note that if you're going to use senml message format, you should always send messages as an array.

 For more information about the HTTP messaging service API, please check out the [API documentation][http-api].

 ## MQTT

 To send and receive messages over MQTT you could use [Mosquitto tools][mosquitto], or [Paho][paho] if you want to use MQTT over WebSocket.


Suggested change

To send and receive messages over MQTT you could use [Mosquitto tools][mosquitto], or [Paho][paho] if you want to use MQTT over WebSocket.

To send and receive messages over MQTT, you can use [Mosquitto tools][mosquitto]. If you prefer to use MQTT over WebSocket, you can use [Paho][paho].

Signed-off-by: nyagamunene <[email protected]>

dborovcanin · 2024-06-26T13:19:01Z

@nyagamunene @JeffMboya What's the status of this PR?

nyagamunene · 2024-06-26T13:25:43Z

@nyagamunene @JeffMboya What's the status of this PR?

It was placed on hold because it is dependant on this PR

dborovcanin · 2024-12-18T10:53:27Z

@nyagamunene What's the status of this PR?

nyagamunene · 2024-12-18T11:25:48Z

@nyagamunene What's the status of this PR?

This is not ready it related to mtls and tls messaging

nyagamunene added 2 commits May 21, 2024 02:07

Updated mqtt and http

d325afc

Signed-off-by: nyagamunene <[email protected]>

Updated mqtt and http

9cd7822

Signed-off-by: nyagamunene <[email protected]>

nyagamunene self-assigned this May 20, 2024

nyagamunene added 3 commits May 21, 2024 12:31

Updated mqtt over ws

196d9c6

Signed-off-by: nyagamunene <[email protected]>

Update http command

a26874f

Signed-off-by: nyagamunene <[email protected]>

changed http casing

387db81

Signed-off-by: nyagamunene <[email protected]>

nyagamunene marked this pull request as ready for review May 21, 2024 10:05

Added mtls certs generation

7ac3954

Signed-off-by: nyagamunene <[email protected]>

rodneyosodo requested review from JeffMboya and felixgateru May 22, 2024 10:06

felixgateru requested changes May 22, 2024

View reviewed changes

rodneyosodo requested changes May 22, 2024

View reviewed changes

felixgateru requested changes May 22, 2024

View reviewed changes

JeffMboya requested changes May 22, 2024

View reviewed changes

Update messaging with examples

e2016ab

Signed-off-by: nyagamunene <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

NOISSUE - Update magistrala messaging #188

NOISSUE - Update magistrala messaging #188

nyagamunene commented May 20, 2024

felixgateru May 22, 2024

felixgateru May 22, 2024

felixgateru May 22, 2024

felixgateru May 22, 2024

felixgateru May 22, 2024

rodneyosodo left a comment

rodneyosodo May 22, 2024

rodneyosodo May 22, 2024

rodneyosodo May 22, 2024

felixgateru May 22, 2024

JeffMboya May 22, 2024

dborovcanin commented Jun 26, 2024

nyagamunene commented Jun 26, 2024

dborovcanin commented Dec 18, 2024

nyagamunene commented Dec 18, 2024 •

edited

Loading

	The following environmental variables are used to enable or disable HTTP with TLS and MTLS: `MG_HTTP_ADAPTER_CERT_FILE`,`MG_HTTP_ADAPTER_KEY_FILE`, `MG_HTTP_ADAPTER_SERVER_CA_FILE`, `MG_HTTP_ADAPTER_CLIENT_CA_FILE`. These can be located in the `docker/.env` file.
	The following environment variables are used to enable or disable HTTP with TLS and MTLS: `MG_HTTP_ADAPTER_CERT_FILE`,`MG_HTTP_ADAPTER_KEY_FILE`, `MG_HTTP_ADAPTER_SERVER_CA_FILE`, `MG_HTTP_ADAPTER_CLIENT_CA_FILE`. These can be located in the `docker/.env` file.


		### Without TLS

		To use magistala HTTP without TLS, comment out all of the listed environment variables provided above. To publish message over channel, thing should send following request:


		### With TLS

		Uncomment out the following environment variables: `MG_MQTT_ADAPTER_WS_CERT_FILE`,`MG_MQTT_ADAPTER_WS_KEY_FILE` and comment out the rest to enable TLS certificates.

	Uncomment out the following environment variables: `MG_MQTT_ADAPTER_WS_CERT_FILE`,`MG_MQTT_ADAPTER_WS_KEY_FILE` and comment out the rest to enable TLS certificates.
	Uncomment the following environment variables: `MG_MQTT_ADAPTER_WS_CERT_FILE`,`MG_MQTT_ADAPTER_WS_KEY_FILE` and comment out the rest to enable TLS certificates.

	To send and receive messages over MQTT you could use [Mosquitto tools][mosquitto], or [Paho][paho] if you want to use MQTT over WebSocket.
	To send and receive messages over MQTT, you can use [Mosquitto tools][mosquitto]. If you prefer to use MQTT over WebSocket, you can use [Paho][paho].

NOISSUE - Update magistrala messaging #188

Are you sure you want to change the base?

NOISSUE - Update magistrala messaging #188

Conversation

nyagamunene commented May 20, 2024

What does this do?

List any changes that modify/break current functionality

Have you included tests for your changes?

Did you document any new/modified functionality?

Notes

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rodneyosodo left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dborovcanin commented Jun 26, 2024

nyagamunene commented Jun 26, 2024

dborovcanin commented Dec 18, 2024

nyagamunene commented Dec 18, 2024 • edited Loading

nyagamunene commented Dec 18, 2024 •

edited

Loading