mirror of
https://github.com/kerberos-io/agent.git
synced 2026-11-15 21:50:47 +00:00
Merge pull request #329 from kerberos-io/feature/support-mqtt-ssl
feature/support-mqtt-ssl
This commit is contained in:
@@ -341,7 +341,7 @@ See [RTSPS and TLS certificates](README-RTSPS-TLS.md) for the complete Bosch UI,
|
||||
| `AGENT_CAPTURE_PIXEL_CHANGE` | If `CONTINUOUS` set to `false`, the number of pixel require to change before motion triggers. | "150" |
|
||||
| `AGENT_CAPTURE_FRAGMENTED` | Set the format of the recorded MP4 to fragmented (suitable for HLS). | "false" |
|
||||
| `AGENT_CAPTURE_FRAGMENTED_DURATION` | If `AGENT_CAPTURE_FRAGMENTED` set to `true`, define the duration (seconds) of a fragment. | "8" |
|
||||
| `AGENT_MQTT_URI` | An MQTT broker endpoint that is used for bi-directional communication (live view, onvif, etc) | "tcp://mqtt.kerberos.io:1883" |
|
||||
| `AGENT_MQTT_URI` | MQTT broker endpoint for bi-directional communication. Accepts ActiveMQ `mqtt+ssl://` URLs. | "tcp://mqtt.kerberos.io:1883" |
|
||||
| `AGENT_MQTT_USERNAME` | Username of the MQTT broker. | "" |
|
||||
| `AGENT_MQTT_PASSWORD` | Password of the MQTT broker. | "" |
|
||||
| `AGENT_REALTIME_PROCESSING` | If `AGENT_REALTIME_PROCESSING` set to `true`, the agent will send key frames to the topic | "" |
|
||||
|
||||
@@ -1,7 +1,9 @@
|
||||
package mqtt
|
||||
|
||||
import (
|
||||
"context"
|
||||
"crypto/rsa"
|
||||
"crypto/tls"
|
||||
"crypto/x509"
|
||||
"encoding/base64"
|
||||
"encoding/json"
|
||||
@@ -9,13 +11,14 @@ import (
|
||||
"fmt"
|
||||
"io/ioutil"
|
||||
"math/rand"
|
||||
"net"
|
||||
"net/url"
|
||||
"os"
|
||||
"strconv"
|
||||
"strings"
|
||||
"sync"
|
||||
"time"
|
||||
|
||||
"context"
|
||||
|
||||
mqtt "github.com/eclipse/paho.mqtt.golang"
|
||||
"github.com/kerberos-io/agent/machinery/src/capture"
|
||||
configService "github.com/kerberos-io/agent/machinery/src/config"
|
||||
@@ -24,6 +27,7 @@ import (
|
||||
"github.com/kerberos-io/agent/machinery/src/onvif"
|
||||
"github.com/kerberos-io/agent/machinery/src/webrtc"
|
||||
log "github.com/sirupsen/logrus"
|
||||
"golang.org/x/net/proxy"
|
||||
)
|
||||
|
||||
// We'll cache the MQTT settings to know if we need to reinitialize the MQTT client connection.
|
||||
@@ -34,6 +38,177 @@ var PREV_MQTTPassword string
|
||||
var PREV_HubKey string
|
||||
var PREV_AgentKey string
|
||||
|
||||
type pahoErrorLogger struct{}
|
||||
|
||||
func (pahoErrorLogger) Println(values ...interface{}) {
|
||||
log.WithFields(log.Fields{
|
||||
"component": "routers/mqtt",
|
||||
"event": "paho_error",
|
||||
}).Error(strings.TrimSpace(fmt.Sprintln(values...)))
|
||||
}
|
||||
|
||||
func (pahoErrorLogger) Printf(format string, values ...interface{}) {
|
||||
log.WithFields(log.Fields{
|
||||
"component": "routers/mqtt",
|
||||
"event": "paho_error",
|
||||
}).Errorf(strings.TrimSpace(format), values...)
|
||||
}
|
||||
|
||||
func init() {
|
||||
mqtt.ERROR = pahoErrorLogger{}
|
||||
}
|
||||
|
||||
func enableMQTTConnectionDiagnostics(options *mqtt.ClientOptions, brokerURL string) {
|
||||
if !strings.Contains(brokerURL, "://") {
|
||||
options.SetCustomOpenConnectionFn(openMQTTConnection)
|
||||
return
|
||||
}
|
||||
|
||||
parsedURL, err := url.Parse(brokerURL)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
switch strings.ToLower(parsedURL.Scheme) {
|
||||
case "", "mqtt", "tcp", "ssl", "tls", "mqtts", "mqtt+ssl", "tcps":
|
||||
options.SetCustomOpenConnectionFn(openMQTTConnection)
|
||||
}
|
||||
}
|
||||
|
||||
func openMQTTConnection(uri *url.URL, options mqtt.ClientOptions) (net.Conn, error) {
|
||||
host := uri.Hostname()
|
||||
fields := log.Fields{
|
||||
"component": "routers/mqtt",
|
||||
"host": host,
|
||||
"port": uri.Port(),
|
||||
"scheme": uri.Scheme,
|
||||
}
|
||||
logMQTTDNSResolution(host, options.ConnectTimeout, fields)
|
||||
|
||||
connectionStartedAt := time.Now()
|
||||
dialer := options.Dialer
|
||||
if dialer == nil {
|
||||
dialer = &net.Dialer{Timeout: options.ConnectTimeout}
|
||||
}
|
||||
|
||||
proxyConfigured := os.Getenv("all_proxy") != ""
|
||||
proxyMode := "direct"
|
||||
if proxyConfigured {
|
||||
proxyMode = "socks"
|
||||
}
|
||||
fields["proxy_mode"] = proxyMode
|
||||
log.WithFields(fields).Info("Opening MQTT TCP connection")
|
||||
|
||||
var (
|
||||
connection net.Conn
|
||||
err error
|
||||
)
|
||||
if proxyConfigured {
|
||||
connection, err = proxy.FromEnvironment().Dial("tcp", uri.Host)
|
||||
} else {
|
||||
connection, err = dialer.Dial("tcp", uri.Host)
|
||||
}
|
||||
fields["duration_ms"] = time.Since(connectionStartedAt).Milliseconds()
|
||||
if err != nil {
|
||||
logMQTTNetworkError("MQTT TCP connection failed", err, fields)
|
||||
return nil, err
|
||||
}
|
||||
|
||||
fields["local_address"] = connection.LocalAddr().String()
|
||||
fields["remote_address"] = connection.RemoteAddr().String()
|
||||
log.WithFields(fields).Info("MQTT TCP connection established")
|
||||
|
||||
if !isSecureMQTTScheme(uri.Scheme) {
|
||||
return connection, nil
|
||||
}
|
||||
|
||||
tlsConfig := options.TLSConfig
|
||||
if tlsConfig == nil {
|
||||
tlsConfig = &tls.Config{}
|
||||
} else {
|
||||
tlsConfig = tlsConfig.Clone()
|
||||
}
|
||||
if tlsConfig.ServerName == "" {
|
||||
tlsConfig.ServerName = host
|
||||
}
|
||||
|
||||
tlsConnection := tls.Client(connection, tlsConfig)
|
||||
tlsStartedAt := time.Now()
|
||||
if options.ConnectTimeout > 0 {
|
||||
_ = tlsConnection.SetDeadline(connectionStartedAt.Add(options.ConnectTimeout))
|
||||
}
|
||||
if err = tlsConnection.Handshake(); err != nil {
|
||||
_ = connection.Close()
|
||||
fields["duration_ms"] = time.Since(tlsStartedAt).Milliseconds()
|
||||
fields["server_name"] = tlsConfig.ServerName
|
||||
logMQTTNetworkError("MQTT TLS handshake failed", err, fields)
|
||||
return nil, err
|
||||
}
|
||||
_ = tlsConnection.SetDeadline(time.Time{})
|
||||
|
||||
state := tlsConnection.ConnectionState()
|
||||
fields["cipher_suite"] = tls.CipherSuiteName(state.CipherSuite)
|
||||
fields["duration_ms"] = time.Since(tlsStartedAt).Milliseconds()
|
||||
fields["server_name"] = tlsConfig.ServerName
|
||||
fields["tls_version"] = tls.VersionName(state.Version)
|
||||
log.WithFields(fields).Info("MQTT TLS handshake established")
|
||||
return tlsConnection, nil
|
||||
}
|
||||
|
||||
func logMQTTDNSResolution(host string, timeout time.Duration, fields log.Fields) {
|
||||
if host == "" || net.ParseIP(host) != nil {
|
||||
return
|
||||
}
|
||||
|
||||
lookupTimeout := timeout
|
||||
if lookupTimeout <= 0 || lookupTimeout > 5*time.Second {
|
||||
lookupTimeout = 5 * time.Second
|
||||
}
|
||||
ctx, cancel := context.WithTimeout(context.Background(), lookupTimeout)
|
||||
defer cancel()
|
||||
|
||||
startedAt := time.Now()
|
||||
addresses, err := net.DefaultResolver.LookupHost(ctx, host)
|
||||
dnsFields := cloneLogFields(fields)
|
||||
dnsFields["duration_ms"] = time.Since(startedAt).Milliseconds()
|
||||
if err != nil {
|
||||
logMQTTNetworkError("MQTT broker DNS resolution failed", err, dnsFields)
|
||||
return
|
||||
}
|
||||
|
||||
dnsFields["resolved_addresses"] = addresses
|
||||
log.WithFields(dnsFields).Info("MQTT broker DNS resolved")
|
||||
}
|
||||
|
||||
func logMQTTNetworkError(message string, err error, fields log.Fields) {
|
||||
errorFields := cloneLogFields(fields)
|
||||
if networkError, ok := err.(net.Error); ok {
|
||||
errorFields["network_timeout"] = networkError.Timeout()
|
||||
}
|
||||
if operationError, ok := err.(*net.OpError); ok {
|
||||
errorFields["network"] = operationError.Net
|
||||
errorFields["operation"] = operationError.Op
|
||||
}
|
||||
log.WithError(err).WithFields(errorFields).Error(message)
|
||||
}
|
||||
|
||||
func cloneLogFields(fields log.Fields) log.Fields {
|
||||
cloned := make(log.Fields, len(fields))
|
||||
for key, value := range fields {
|
||||
cloned[key] = value
|
||||
}
|
||||
return cloned
|
||||
}
|
||||
|
||||
func isSecureMQTTScheme(scheme string) bool {
|
||||
switch strings.ToLower(scheme) {
|
||||
case "ssl", "tls", "mqtts", "mqtt+ssl", "tcps":
|
||||
return true
|
||||
default:
|
||||
return false
|
||||
}
|
||||
}
|
||||
|
||||
func HasMQTTClientModified(configuration *models.Configuration) bool {
|
||||
MTTURI := configuration.Config.MQTTURI
|
||||
MTTUsername := configuration.Config.MQTTUsername
|
||||
@@ -116,6 +291,7 @@ func ConfigureMQTT(configDirectory string, configuration *models.Configuration,
|
||||
// Some extra options to make sure the connection behaves
|
||||
// properly. More information here: github.com/eclipse/paho.mqtt.golang.
|
||||
//opts.SetCleanSession(true)
|
||||
enableMQTTConnectionDiagnostics(opts, mqttURL)
|
||||
opts.SetCleanSession(false)
|
||||
opts.SetResumeSubs(true)
|
||||
opts.SetStore(mqtt.NewMemoryStore())
|
||||
@@ -203,7 +379,7 @@ func ConfigureMQTT(configDirectory string, configuration *models.Configuration,
|
||||
"component": "routers/mqtt",
|
||||
"event": "initial_connection_timeout",
|
||||
"timeout_ms": (30 * time.Second).Milliseconds(),
|
||||
}).Error("Timed out establishing initial MQTT connection")
|
||||
}).Warn("Initial MQTT connection is still retrying")
|
||||
}
|
||||
return mqc
|
||||
}
|
||||
|
||||
@@ -1,12 +1,93 @@
|
||||
package mqtt
|
||||
|
||||
import (
|
||||
"crypto/tls"
|
||||
"net/http/httptest"
|
||||
"net/url"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
mqtt "github.com/eclipse/paho.mqtt.golang"
|
||||
"github.com/kerberos-io/agent/machinery/src/models"
|
||||
)
|
||||
|
||||
func TestEnableMQTTConnectionDiagnostics(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
brokerURL string
|
||||
want bool
|
||||
}{
|
||||
{name: "ActiveMQ TLS", brokerURL: "mqtt+ssl://broker.example:8883", want: true},
|
||||
{name: "TCP", brokerURL: "tcp://broker.example:1883", want: true},
|
||||
{name: "default TCP", brokerURL: "broker.example:1883", want: true},
|
||||
{name: "WebSocket", brokerURL: "wss://broker.example/mqtt", want: false},
|
||||
}
|
||||
|
||||
for _, test := range tests {
|
||||
t.Run(test.name, func(t *testing.T) {
|
||||
options := mqtt.NewClientOptions()
|
||||
enableMQTTConnectionDiagnostics(options, test.brokerURL)
|
||||
if got := options.CustomOpenConnectionFn != nil; got != test.want {
|
||||
t.Fatalf("CustomOpenConnectionFn configured = %t, want %t", got, test.want)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestOpenMQTTConnectionReturnsTCPError(t *testing.T) {
|
||||
options := *mqtt.NewClientOptions().SetConnectTimeout(100 * time.Millisecond)
|
||||
brokerURL, err := url.Parse("tcp://127.0.0.1:0")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
connection, err := openMQTTConnection(brokerURL, options)
|
||||
if connection != nil {
|
||||
connection.Close()
|
||||
t.Fatal("openMQTTConnection() returned a connection for an unavailable endpoint")
|
||||
}
|
||||
if err == nil {
|
||||
t.Fatal("openMQTTConnection() returned no TCP error")
|
||||
}
|
||||
}
|
||||
|
||||
func TestOpenMQTTConnectionEstablishesActiveMQTLS(t *testing.T) {
|
||||
server := httptest.NewTLSServer(nil)
|
||||
defer server.Close()
|
||||
|
||||
serverURL, err := url.Parse(server.URL)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
brokerURL, err := url.Parse("mqtt+ssl://" + serverURL.Host)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
options := *mqtt.NewClientOptions().
|
||||
SetConnectTimeout(time.Second).
|
||||
SetTLSConfig(&tls.Config{InsecureSkipVerify: true}) // #nosec G402 -- local test server
|
||||
|
||||
connection, err := openMQTTConnection(brokerURL, options)
|
||||
if err != nil {
|
||||
t.Fatalf("openMQTTConnection() error = %v", err)
|
||||
}
|
||||
defer connection.Close()
|
||||
if _, ok := connection.(*tls.Conn); !ok {
|
||||
t.Fatalf("openMQTTConnection() connection type = %T, want *tls.Conn", connection)
|
||||
}
|
||||
}
|
||||
|
||||
func TestIsSecureMQTTScheme(t *testing.T) {
|
||||
for _, scheme := range []string{"ssl", "tls", "mqtts", "mqtt+ssl", "tcps"} {
|
||||
if !isSecureMQTTScheme(scheme) {
|
||||
t.Errorf("isSecureMQTTScheme(%q) = false, want true", scheme)
|
||||
}
|
||||
}
|
||||
if isSecureMQTTScheme("tcp") {
|
||||
t.Error("isSecureMQTTScheme(\"tcp\") = true, want false")
|
||||
}
|
||||
}
|
||||
|
||||
func TestConfigureMQTTRequiresHubKey(t *testing.T) {
|
||||
configuration := &models.Configuration{Config: models.Config{Key: "agent-key"}}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user