Added Software (#2)

Author: buglloc

.github/workflows/firmware.yml

@@ -1,3 +1,4 @@
+---
 name: Firmware CI
 
 on:

.github/workflows/software.yml

@@ -0,0 +1,83 @@
+---
+name: Sofrware CI
+
+on:
+  push:
+    branches:
+      - main
+    tags:
+      - '*'
+    paths:
+      - 'software/**'
+      - '.github/workflows/software.yml'
+  pull_request:
+    paths:
+      - 'software/**'
+      - '.github/workflows/software.yml'
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  staticcheck:
+    permissions:
+      contents: read
+      pull-requests: read
+    runs-on: ubuntu-latest
+    steps:
+      # Get the repositery's code
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Set up Golang
+        uses: actions/setup-go@v4
+        with:
+          go-version: '1.23.x'
+          check-latest: true
+          cache: true
+          cache-dependency-path: software/go.sum
+
+      - name: Go test
+        working-directory: ./software
+        run: "go test ./..."
+
+      - name: Go ver
+        working-directory: ./software
+        run: "go vet ./..."
+
+      - name: StaticCheck
+        uses: dominikh/[email protected]
+        with:
+          version: "2024.1.1"
+          install-go: false
+          working-directory: ./software
+
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        platform:
+          - ubuntu
+        go:
+          - 21
+          - 22
+          - 23
+    name: 'tests on ${{ matrix.platform }} | 1.${{ matrix.go }}.x'
+    runs-on: ${{ matrix.platform }}-latest
+    steps:
+      # Get the repositery's code
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Set up Golang
+        uses: actions/setup-go@v4
+        with:
+          go-version: '1.${{ matrix.go }}.x'
+          check-latest: true
+          cache: true
+          cache-dependency-path: software/go.sum
+
+      - name: Run tests
+        working-directory: ./software
+        run: "go clean -testcache && go test -race -cover -covermode=atomic ./..."

software/.gitignore software/cmd/dupplcap/.gitignore

@@ -0,0 +1,148 @@
+package main
+
+import (
+	"fmt"
+	"io"
+	"os"
+	"path/filepath"
+	"runtime"
+
+	"github.com/gopacket/gopacket"
+	"github.com/gopacket/gopacket/layers"
+	"github.com/gopacket/gopacket/pcapgo"
+	"github.com/kor44/extcap"
+
+	"github.com/buglloc/Mr.Duppl/software/pkg/dupplcap"
+)
+
+const (
+	usePacketFoldingOpt = "packet-folding"
+)
+
+var (
+	usePacketFolding = extcap.NewConfigBoolOpt(usePacketFoldingOpt, "Use packet folding").
+		Default(true)
+)
+
+func main() {
+	app := extcap.App{
+		Usage: "dupplcap",
+		Version: extcap.VersionInfo{
+			Info: "1.0.0",
+			Help: "https://github.com/buglloc/Mr.Duppl",
+		},
+		HelpPage:            "DupplCAP - extcap application to integrate Mr.Duppl with Wireshark or something",
+		GetInterfaces:       getAllInterfaces,
+		GetDLT:              getDLT,
+		GetAllConfigOptions: getAllConfigOptions,
+		GetConfigOptions:    getConfigOptions,
+		StartCapture:        startCapture,
+	}
+
+	app.Run(os.Args)
+}
+
+func getAllInterfaces() ([]extcap.CaptureInterface, error) {
+	ifaces, err := dupplcap.Ifaces()
+	if err != nil {
+		return nil, fmt.Errorf("unable to get information about interfaces: %w", err)
+	}
+
+	extIfaces := make([]extcap.CaptureInterface, len(ifaces))
+	for i, iface := range ifaces {
+		// we use Name as Value to deal with Mr.Duppl replugs
+		extIfaces[i] = extcap.CaptureInterface{
+			Value:   iface.Name,
+			Display: iface.Path,
+		}
+	}
+
+	return extIfaces, nil
+}
+
+func getDLT(_ string) (extcap.DLT, error) {
+	return extcap.DLT{
+		Number: dupplcap.LinkTypeUSBFullSpeed.Int(),
+		Name:   dupplcap.LinkTypeUSBFullSpeed.String(),
+	}, nil
+}
+
+func getConfigOptions(_ string) ([]extcap.ConfigOption, error) {
+	opts := []extcap.ConfigOption{
+		usePacketFolding,
+	}
+
+	return opts, nil
+}
+
+func getAllConfigOptions() []extcap.ConfigOption {
+	opts := []extcap.ConfigOption{
+		usePacketFolding,
+	}
+	return opts
+}
+
+func startCapture(iface string, pipe io.WriteCloser, _ string, opts map[string]any) error {
+	defer func() { _ = pipe.Close() }()
+
+	dev, err := dupplcap.NewDeviceByName(iface)
+	if err != nil {
+		return fmt.Errorf("open device: %w", err)
+	}
+	defer func() { _ = dev.Close() }()
+
+	packetFoldingEnabled := true
+	if val, ok := opts[usePacketFoldingOpt]; ok {
+		if en, ok := val.(bool); ok {
+			packetFoldingEnabled = en
+		}
+	}
+
+	if err := dev.StartCapture(packetFoldingEnabled); err != nil {
+		return fmt.Errorf("start capture: %w", err)
+	}
+	defer func() { _ = dev.StopCapture() }()
+
+	w, err := pcapgo.NewNgWriterInterface(
+		pipe,
+		pcapgo.NgInterface{
+			Name:       filepath.Base(iface),
+			OS:         runtime.GOOS,
+			LinkType:   layers.LinkType(dupplcap.LinkTypeUSBFullSpeed.Int()),
+			SnapLength: 0, //unlimited
+			// TimestampResolution: 9,
+		},
+		pcapgo.NgWriterOptions{
+			SectionInfo: pcapgo.NgSectionInfo{
+				Hardware:    runtime.GOARCH,
+				OS:          runtime.GOOS,
+				Application: "Mr.Duppl", //spread the word
+			},
+		},
+	)
+	if err != nil {
+		return fmt.Errorf("open pcapng writer: %w", err)
+	}
+
+	for {
+		packet, err := dev.Packet()
+		if err != nil {
+			return fmt.Errorf("read packet: %w", err)
+		}
+
+		ci := gopacket.CaptureInfo{
+			Length:         len(packet),
+			CaptureLength:  len(packet),
+			InterfaceIndex: 0,
+		}
+		err = w.WritePacket(ci, packet)
+		if err != nil {
+			return fmt.Errorf("write packet: %w", err)
+		}
+
+		err = w.Flush()
+		if err != nil {
+			return fmt.Errorf("flush packet: %w", err)
+		}
+	}
+}

software/cmd/dupplcap/main.go

@@ -5,15 +5,19 @@ go 1.23.1
 require (
 	github.com/gopacket/gopacket v1.3.0
 	github.com/kor44/extcap v0.0.1
+	github.com/stretchr/testify v1.8.4
 	go.bug.st/serial v1.6.2
 )
 
 require (
 	github.com/cpuguy83/go-md2man/v2 v2.0.2 // indirect
 	github.com/creack/goselect v0.1.2 // indirect
+	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
 	github.com/russross/blackfriday/v2 v2.1.0 // indirect
 	github.com/urfave/cli/v2 v2.25.7 // indirect
 	github.com/xrash/smetrics v0.0.0-20201216005158-039620a65673 // indirect
 	golang.org/x/net v0.28.0 // indirect
 	golang.org/x/sys v0.24.0 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
 )

software/go.mod

@@ -28,5 +28,7 @@ golang.org/x/net v0.28.0 h1:a9JDOJc5GMUJ0+UDqmLT86WiEy7iWyIhz8gz8E4e5hE=
 golang.org/x/net v0.28.0/go.mod h1:yqtgsTWOOnlGLG9GFRrK3++bGOUEkNBoHZc8MEDWPNg=
 golang.org/x/sys v0.24.0 h1:Twjiwq9dn6R1fQcyiK+wQyHWfaz/BJB+YIpzU/Cv3Xg=
 golang.org/x/sys v0.24.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
 gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

software/go.sum

@@ -0,0 +1,67 @@
+package dupplcap
+
+import (
+	"fmt"
+
+	"go.bug.st/serial"
+)
+
+const (
+	cmdStartCapture = 0x01
+	cmdStopCapture  = 0x02
+)
+
+type Device struct {
+	port serial.Port
+}
+
+func NewDeviceByIface(iface string) (*Device, error) {
+	serialPort, err := serial.Open(iface, &serial.Mode{
+		BaudRate: 115200,
+	})
+	if err != nil {
+		return nil, fmt.Errorf("open serial port %s: %w", iface, err)
+	}
+
+	return &Device{
+		port: serialPort,
+	}, nil
+}
+
+func NewDeviceByName(name string) (*Device, error) {
+	ifaces, err := Ifaces()
+	if err != nil {
+		return nil, fmt.Errorf("list ifaces: %w", err)
+	}
+
+	for _, iface := range ifaces {
+		if iface.Name != name {
+			continue
+		}
+
+		return NewDeviceByIface(iface.Path)
+	}
+
+	return nil, fmt.Errorf("device with name %s not found", name)
+}
+
+func (r *Device) Packet() ([]byte, error) {
+	return readSlipPacket(r.port)
+}
+
+func (r *Device) StartCapture(withPacketFolding bool) error {
+	cmd := []byte{cmdStartCapture, 0x00}
+	if withPacketFolding {
+		cmd[1] = 0x01
+	}
+
+	return writeSlipPacket(r.port, cmd)
+}
+
+func (r *Device) StopCapture() error {
+	return writeSlipPacket(r.port, []byte{cmdStopCapture})
+}
+
+func (r *Device) Close() error {
+	return r.port.Close()
+}

software/pkg/dupplcap/device.go

@@ -0,0 +1,47 @@
+package dupplcap
+
+import (
+	"fmt"
+	"strings"
+
+	"go.bug.st/serial/enumerator"
+)
+
+const (
+	targetVID = "2E8A"
+	targetPID = "5052"
+)
+
+type Iface struct {
+	Path string
+	Name string
+}
+
+func Ifaces() ([]Iface, error) {
+	ports, err := enumerator.GetDetailedPortsList()
+	if err != nil {
+		return nil, fmt.Errorf("list detailed ports: %w", err)
+	}
+
+	var out []Iface
+	for _, port := range ports {
+		if !port.IsUSB {
+			continue
+		}
+
+		if !strings.EqualFold(port.VID, targetVID) {
+			continue
+		}
+
+		if !strings.EqualFold(port.PID, targetPID) {
+			continue
+		}
+
+		out = append(out, Iface{
+			Path: port.Name,
+			Name: fmt.Sprintf("Mr.Duppl:%s", port.SerialNumber),
+		})
+	}
+
+	return out, nil
+}