hot fix: close client on verifying connection (will keep client open)

the repository https://github.com/kerberos-io/snap-agent is linked to the snap build system and will generate new releases

.github/workflows/docker-nightly.yml

@@ -18,7 +18,7 @@ jobs:
           username: ${{ secrets.DOCKERHUB_USERNAME }}
           password: ${{ secrets.DOCKERHUB_TOKEN }}
       - name: Checkout
-        uses: actions/checkout@v3
+        run: git clone https://github.com/kerberos-io/agent && cd agent
       - name: Set up QEMU
         uses: docker/setup-qemu-action@v2
       - name: Set up Docker Buildx
@@ -41,7 +41,7 @@ jobs:
         username: ${{ secrets.DOCKERHUB_USERNAME }}
         password: ${{ secrets.DOCKERHUB_TOKEN }}
     - name: Checkout
-      uses: actions/checkout@v3
+      run: git clone https://github.com/kerberos-io/agent && cd agent
     - name: Set up QEMU
       uses: docker/setup-qemu-action@v2
     - name: Set up Docker Buildx

.github/workflows/go.yml

@@ -7,17 +7,17 @@ on:
     branches: [ develop, master ]
 
 jobs:
-
   build:
     name: Build
     runs-on: ubuntu-latest
     container:
-      image: kerberos/base:70d69dc
-
-
+      image: kerberos/base:0a50dc9
+      
     strategy:
       matrix:
-        go-version: [1.17, 1.18, 1.19]
+        #No longer supported Go versions.
+        #go-version: ['1.17', '1.18', '1.19']
+        go-version: ['1.20', '1.21']
 
     steps:
     - name: Set up Go ${{ matrix.go-version }}
@@ -25,7 +25,9 @@ jobs:
       with:
         go-version: ${{ matrix.go-version }}
     - name: Check out code into the Go module directory
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
+    - name: Set up git ownershi
+      run: git config --system --add safe.directory /__w/agent/agent
     - name: Get dependencies
       run: cd machinery && go mod download
     - name: Build

README.md

@@ -111,7 +111,7 @@ This repository contains everything you'll need to know about our core product,
 - Simplified and modern user interface.
 - Multi architecture (ARMv7, ARMv8, amd64, etc).).
 - Multi stream, for example recording in H265, live streaming and motion detection in H264.
-- Multi camera support: IP Cameras (H264 and H265), USB cameras and Raspberry Pi Cameras [through a RTSP proxy](https://github.com/kerberos-io/camera-to-rtsp
+- Multi camera support: IP Cameras (H264 and H265), USB cameras and Raspberry Pi Cameras [through a RTSP proxy](https://github.com/kerberos-io/camera-to-rtsp).
 - Single camera per instance (e.g. one container per camera).
 - Low resolution streaming through MQTT and high resolution streaming through WebRTC (only supports H264/PCM).
 - Backchannel audio from Kerberos Hub to IP camera (requires PCM ULAW codec)

deployments/binary/README.md

@@ -9,7 +9,7 @@ Kerberos Agents are now also shipped as static binaries. Within the Docker image
 
 You can run the binary as following on port `8080`:
 
-    main run cameraname 8080
+    main -action=run -port=80
 
 ## Systemd
 
@@ -18,7 +18,7 @@ When running on a Linux OS you might consider to auto-start the Kerberos Agent u
     [Unit]
     Wants=network.target
     [Service]
-    ExecStart=/home/pi/agent/main run camera 80
+    ExecStart=/home/pi/agent/main -action=run -port=80
     WorkingDirectory=/home/pi/agent/
     [Install]
     WantedBy=multi-user.target

machinery/docs/docs.go

@@ -279,6 +279,40 @@ const docTemplate = `{
                 }
             }
         },
+        "/api/camera/onvif/verify": {
+            "post": {
+                "security": [
+                    {
+                        "Bearer": []
+                    }
+                ],
+                "description": "Will verify the ONVIF connectivity.",
+                "tags": [
+                    "onvif"
+                ],
+                "summary": "Will verify the ONVIF connectivity.",
+                "operationId": "verify-onvif",
+                "parameters": [
+                    {
+                        "description": "OnvifCredentials",
+                        "name": "config",
+                        "in": "body",
+                        "required": true,
+                        "schema": {
+                            "$ref": "#/definitions/models.OnvifCredentials"
+                        }
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "description": "OK",
+                        "schema": {
+                            "$ref": "#/definitions/models.APIResponse"
+                        }
+                    }
+                }
+            }
+        },
         "/api/camera/onvif/zoom": {
             "post": {
                 "description": "Zooming in or out the camera.",
@@ -590,40 +624,6 @@ const docTemplate = `{
                 }
             }
         },
-        "/api/onvif/verify": {
-            "post": {
-                "security": [
-                    {
-                        "Bearer": []
-                    }
-                ],
-                "description": "Will verify the ONVIF connectivity.",
-                "tags": [
-                    "onvif"
-                ],
-                "summary": "Will verify the ONVIF connectivity.",
-                "operationId": "verify-onvif",
-                "parameters": [
-                    {
-                        "description": "OnvifCredentials",
-                        "name": "config",
-                        "in": "body",
-                        "required": true,
-                        "schema": {
-                            "$ref": "#/definitions/models.OnvifCredentials"
-                        }
-                    }
-                ],
-                "responses": {
-                    "200": {
-                        "description": "OK",
-                        "schema": {
-                            "$ref": "#/definitions/models.APIResponse"
-                        }
-                    }
-                }
-            }
-        },
         "/api/persistence/verify": {
             "post": {
                 "security": [

machinery/docs/swagger.json

@@ -271,6 +271,40 @@
                 }
             }
         },
+        "/api/camera/onvif/verify": {
+            "post": {
+                "security": [
+                    {
+                        "Bearer": []
+                    }
+                ],
+                "description": "Will verify the ONVIF connectivity.",
+                "tags": [
+                    "onvif"
+                ],
+                "summary": "Will verify the ONVIF connectivity.",
+                "operationId": "verify-onvif",
+                "parameters": [
+                    {
+                        "description": "OnvifCredentials",
+                        "name": "config",
+                        "in": "body",
+                        "required": true,
+                        "schema": {
+                            "$ref": "#/definitions/models.OnvifCredentials"
+                        }
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "description": "OK",
+                        "schema": {
+                            "$ref": "#/definitions/models.APIResponse"
+                        }
+                    }
+                }
+            }
+        },
         "/api/camera/onvif/zoom": {
             "post": {
                 "description": "Zooming in or out the camera.",
@@ -582,40 +616,6 @@
                 }
             }
         },
-        "/api/onvif/verify": {
-            "post": {
-                "security": [
-                    {
-                        "Bearer": []
-                    }
-                ],
-                "description": "Will verify the ONVIF connectivity.",
-                "tags": [
-                    "onvif"
-                ],
-                "summary": "Will verify the ONVIF connectivity.",
-                "operationId": "verify-onvif",
-                "parameters": [
-                    {
-                        "description": "OnvifCredentials",
-                        "name": "config",
-                        "in": "body",
-                        "required": true,
-                        "schema": {
-                            "$ref": "#/definitions/models.OnvifCredentials"
-                        }
-                    }
-                ],
-                "responses": {
-                    "200": {
-                        "description": "OK",
-                        "schema": {
-                            "$ref": "#/definitions/models.APIResponse"
-                        }
-                    }
-                }
-            }
-        },
         "/api/persistence/verify": {
             "post": {
                 "security": [

machinery/docs/swagger.yaml

@@ -494,6 +494,27 @@ paths:
       summary: Will return the ONVIF presets for the specific camera.
       tags:
       - onvif
+  /api/camera/onvif/verify:
+    post:
+      description: Will verify the ONVIF connectivity.
+      operationId: verify-onvif
+      parameters:
+      - description: OnvifCredentials
+        in: body
+        name: config
+        required: true
+        schema:
+          $ref: '#/definitions/models.OnvifCredentials'
+      responses:
+        "200":
+          description: OK
+          schema:
+            $ref: '#/definitions/models.APIResponse'
+      security:
+      - Bearer: []
+      summary: Will verify the ONVIF connectivity.
+      tags:
+      - onvif
   /api/camera/onvif/zoom:
     post:
       description: Zooming in or out the camera.
@@ -700,27 +721,6 @@ paths:
       summary: Get Authorization token.
       tags:
       - authentication
-  /api/onvif/verify:
-    post:
-      description: Will verify the ONVIF connectivity.
-      operationId: verify-onvif
-      parameters:
-      - description: OnvifCredentials
-        in: body
-        name: config
-        required: true
-        schema:
-          $ref: '#/definitions/models.OnvifCredentials'
-      responses:
-        "200":
-          description: OK
-          schema:
-            $ref: '#/definitions/models.APIResponse'
-      security:
-      - Bearer: []
-      summary: Will verify the ONVIF connectivity.
-      tags:
-      - onvif
   /api/persistence/verify:
     post:
       description: Will verify the persistence.

machinery/src/capture/Gortsplib.go

@@ -360,7 +360,7 @@ func (g *Golibrtsp) Start(ctx context.Context, queue *packets.Queue, configurati
 			// decode timestamp
 			pts, ok := g.Client.PacketPTS(g.AudioG711Media, rtppkt)
 			if !ok {
-				log.Log.Warning("capture.golibrtsp.Start(): " + "unable to get PTS")
+				log.Log.Debug("capture.golibrtsp.Start(): " + "unable to get PTS")
 				return
 			}
 
@@ -443,7 +443,7 @@ func (g *Golibrtsp) Start(ctx context.Context, queue *packets.Queue, configurati
 				// decode timestamp
 				pts, ok := g.Client.PacketPTS(g.VideoH264Media, rtppkt)
 				if !ok {
-					log.Log.Warning("capture.golibrtsp.Start(): " + "unable to get PTS")
+					log.Log.Debug("capture.golibrtsp.Start(): " + "unable to get PTS")
 					return
 				}
 
@@ -554,7 +554,7 @@ func (g *Golibrtsp) Start(ctx context.Context, queue *packets.Queue, configurati
 				// decode timestamp
 				pts, ok := g.Client.PacketPTS(g.VideoH265Media, rtppkt)
 				if !ok {
-					log.Log.Warning("capture.golibrtsp.Start(): " + "unable to get PTS")
+					log.Log.Debug("capture.golibrtsp.Start(): " + "unable to get PTS")
 					return
 				}
 

machinery/src/capture/main.go

@@ -564,17 +564,23 @@ func VerifyCamera(c *gin.Context) {
 				}
 			}
 
-			if videoIdx > -1 {
-				c.JSON(200, models.APIResponse{
-					Message: "All good, detected a H264 codec.",
-					Data:    streams,
-				})
+			err := rtspClient.Close()
+			if err == nil {
+				if videoIdx > -1 {
+					c.JSON(200, models.APIResponse{
+						Message: "All good, detected a H264 codec.",
+						Data:    streams,
+					})
+				} else {
+					c.JSON(400, models.APIResponse{
+						Message: "Stream doesn't have a H264 codec, we only support H264 so far.",
+					})
+				}
 			} else {
 				c.JSON(400, models.APIResponse{
-					Message: "Stream doesn't have a H264 codec, we only support H264 so far.",
+					Message: "Something went wrong while closing the connection " + err.Error(),
 				})
 			}
-
 		} else {
 			c.JSON(400, models.APIResponse{
 				Message: err.Error(),

machinery/src/cloud/Cloud.go

@@ -290,7 +290,7 @@ loop:
 						onvifPresetsList = []byte("[]")
 					}
 				} else {
-					log.Log.Error("cloud.HandleHeartBeat(): error while getting PTZ configurations: " + err.Error())
+					log.Log.Debug("cloud.HandleHeartBeat(): error while getting PTZ configurations: " + err.Error())
 					onvifPresetsList = []byte("[]")
 				}
 

machinery/src/components/Kerberos.go

@@ -115,14 +115,22 @@ func RunAgent(configDirectory string, configuration *models.Configuration, commu
 	// Establishing the camera connection without backchannel if no substream
 	rtspUrl := config.Capture.IPCamera.RTSP
 	rtspClient := captureDevice.SetMainClient(rtspUrl)
-
-	err := rtspClient.Connect(context.Background())
-	if err != nil {
-		log.Log.Error("components.Kerberos.RunAgent(): error connecting to RTSP stream: " + err.Error())
-		rtspClient.Close()
+	if rtspUrl != "" {
+		err := rtspClient.Connect(context.Background())
+		if err != nil {
+			log.Log.Error("components.Kerberos.RunAgent(): error connecting to RTSP stream: " + err.Error())
+			rtspClient.Close()
+			rtspClient = nil
+			time.Sleep(time.Second * 3)
+			return status
+		}
+	} else {
+		log.Log.Error("components.Kerberos.RunAgent(): no rtsp url found in config, please provide one.")
+		rtspClient = nil
 		time.Sleep(time.Second * 3)
 		return status
 	}
+
 	log.Log.Info("components.Kerberos.RunAgent(): opened RTSP stream: " + rtspUrl)
 
 	// Get the video streams from the RTSP server.

machinery/src/onvif/main.go

@@ -312,12 +312,17 @@ func GetPositionFromDevice(configuration models.Configuration) (xsdonvif.PTZVect
 			// Get the PTZ configurations from the device
 			position, err := GetPosition(device, token)
 			if err == nil {
-				// float to string
-				x := strconv.FormatFloat(position.PanTilt.X, 'f', 6, 64)
-				y := strconv.FormatFloat(position.PanTilt.Y, 'f', 6, 64)
-				z := strconv.FormatFloat(position.Zoom.X, 'f', 6, 64)
-				log.Log.Info("onvif.GetPositionFromDevice(): successfully got position (" + x + ", " + y + ", " + z + ")")
-				return position, err
+				if position.PanTilt != nil && position.Zoom != nil {
+					// float to string
+					x := strconv.FormatFloat(position.PanTilt.X, 'f', 6, 64)
+					y := strconv.FormatFloat(position.PanTilt.Y, 'f', 6, 64)
+					z := strconv.FormatFloat(position.Zoom.X, 'f', 6, 64)
+					log.Log.Info("onvif.GetPositionFromDevice(): successfully got position (" + x + ", " + y + ", " + z + ")")
+					return position, err
+				} else {
+					log.Log.Debug("onvif.GetPositionFromDevice(): position is nil")
+					return position, errors.New("position is nil")
+				}
 			} else {
 				log.Log.Debug("onvif.GetPositionFromDevice(): " + err.Error())
 				return position, err
@@ -893,7 +898,7 @@ func GetPTZFunctionsFromDevice(configurations ptz.GetConfigurationsResponse) ([]
 }
 
 // VerifyOnvifConnection godoc
-// @Router /api/onvif/verify [post]
+// @Router /api/camera/onvif/verify [post]
 // @ID verify-onvif
 // @Security Bearer
 // @securityDefinitions.apikey Bearer

machinery/src/routers/http/routes.go

@@ -54,11 +54,6 @@ func AddRoutes(r *gin.Engine, authMiddleware *jwt.GinJWTMiddleware, configDirect
 			components.UpdateConfig(c, configDirectory, configuration, communication)
 		})
 
-		// Will verify the current onvif settings.
-		api.POST("/onvif/verify", func(c *gin.Context) {
-			onvif.VerifyOnvifConnection(c)
-		})
-
 		// Will verify the current hub settings.
 		api.POST("/hub/verify", func(c *gin.Context) {
 			cloud.VerifyHub(c)
@@ -94,7 +89,8 @@ func AddRoutes(r *gin.Engine, authMiddleware *jwt.GinJWTMiddleware, configDirect
 		})
 
 		// Onvif specific methods. Doesn't require any authorization.
-
+		// Will verify the current onvif settings.
+		api.POST("/camera/onvif/verify", onvif.VerifyOnvifConnection)
 		api.POST("/camera/onvif/login", LoginToOnvif)
 		api.POST("/camera/onvif/capabilities", GetOnvifCapabilities)
 		api.POST("/camera/onvif/presets", GetOnvifPresets)

snap/hooks/configure

@@ -1,6 +0,0 @@
-#!/bin/sh -e
-
-cp -R $SNAP/data $SNAP_COMMON/
-cp -R $SNAP/www $SNAP_COMMON/
-cp -R $SNAP/version $SNAP_COMMON/
-cp -R $SNAP/mp4fragment $SNAP_COMMON/

snap/snapcraft.yaml

@@ -1,23 +0,0 @@
-name: kerberosio # you probably want to 'snapcraft register <name>'
-base: core22 # the base snap is the execution environment for this snap
-version: '3.0.0' # just for humans, typically '1.2+git' or '1.3.2'
-summary: A stand-alone open source video surveillance system # 79 char long summary
-description: |
-   Kerberos Agent is an isolated and scalable video (surveillance) management
-   agent made available as Open Source under the MIT License. This means that
-   all the source code is available for you or your company, and you can use,
-   transform and distribute the source code; as long you keep a reference of
-   the original license. Kerberos Agent can be used for commercial usage.
-
-grade: stable # stable # must be 'stable' to release into candidate/stable channels
-confinement: strict # use 'strict' once you have the right plugs and slots
-environment:
-  GIN_MODE: release
-apps:
-  agent:
-    command: main -config /var/snap/kerberosio/common
-    plugs: [ network, network-bind ]
-parts:
-  agent:
-    source: . #https://github.com/kerberos-io/agent/releases/download/21c0e01/agent-amd64.tar
-    plugin: dump