Skip to content

Commit 7adec03

Browse files
authored
fix(discovery): redact remote pairing auth tags from logs (#205)
* fix(discovery): redact remote pairing auth tags from Avahi logs * fix(pairing): mask auth tag in subprocess debug command * test(discovery): verify pairing auth tags stay out of discovery logs * ci(test): run isolated Linux pairing-redaction regression checks * chore(ci): remove temporary verification workflow after passing checks
1 parent 603205d commit 7adec03

3 files changed

Lines changed: 83 additions & 7 deletions

File tree

‎internal/manager/device_manager.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -468,7 +468,7 @@ func (dm *DeviceManager) CheckDevicePairedContext(ctx context.Context, identifie
468468
return nil, nil
469469
}
470470

471-
cmd := exec.CommandContext(ctx, "plumesign", "check", "find-pairing", "--identifier", identifier, "--auth-tag", authTag).WithTimeout(10 * time.Second)
471+
cmd := exec.CommandContext(ctx, "plumesign", "check", "find-pairing", "--identifier", identifier, "--auth-tag", authTag).WithTimeout(10 * time.Second).WithSecret(authTag)
472472

473473
data, err := cmd.CombinedOutput()
474474
if err != nil {

‎internal/manager/device_manager_avahi.go‎

Lines changed: 24 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -200,7 +200,7 @@ func (dm *DeviceManager) runDiscovery(ctx context.Context, server *avahi.Server)
200200
log.Err(err).Msgf("Failed to resolve service: name=%s type=%s", service.Name, service.Type)
201201
continue
202202
}
203-
log.Printf("%s name=%s type=%s ip=%s port=%d txt=%v", "[+]", service.Name, service.Type, service.Address, service.Port, dm.parseTextRecord(service.Txt))
203+
dm.logAvahiService("[+]", service)
204204

205205
macAddr := strings.Split(service.Name, "@")[0]
206206
name := dm.parseName(service.Host)
@@ -238,7 +238,7 @@ func (dm *DeviceManager) runDiscovery(ctx context.Context, server *avahi.Server)
238238
if !ok {
239239
return errAvahiBrowserFreed
240240
}
241-
log.Printf("%s name=%s type=%s ip=%s port=%d txt=%v", "[-]", service.Name, service.Type, service.Address, service.Port, dm.parseTextRecord(service.Txt))
241+
dm.logAvahiService("[-]", service)
242242

243243
macAddr := strings.Split(service.Name, "@")[0]
244244
dm.DeleteDeviceByMacAddr(macAddr)
@@ -252,7 +252,7 @@ func (dm *DeviceManager) runDiscovery(ctx context.Context, server *avahi.Server)
252252
log.Err(err).Msgf("Failed to resolve service: name=%s type=%s", service.Name, service.Type)
253253
continue
254254
}
255-
log.Printf("%s name=%s type=%s ip=%s port=%d txt=%v", "[+]", service.Name, service.Type, service.Address, service.Port, dm.parseTextRecord(service.Txt))
255+
dm.logAvahiService("[+]", service)
256256

257257
name := dm.parseName(service.Host)
258258

@@ -294,7 +294,7 @@ func (dm *DeviceManager) runDiscovery(ctx context.Context, server *avahi.Server)
294294
if !ok {
295295
return errAvahiBrowserFreed
296296
}
297-
log.Printf("%s name=%s type=%s ip=%s port=%d txt=%v", "[-]", service.Name, service.Type, service.Address, service.Port, dm.parseTextRecord(service.Txt))
297+
dm.logAvahiService("[-]", service)
298298
// ItemRemove has no TXT records. Use the identifier captured from
299299
// ItemNew rather than the service name: checks and throttle entries
300300
// are keyed by identifier, not service name.
@@ -305,7 +305,7 @@ func (dm *DeviceManager) runDiscovery(ctx context.Context, server *avahi.Server)
305305
if !ok {
306306
return errAvahiBrowserFreed
307307
}
308-
log.Printf("%s name=%s type=%s ip=%s port=%d txt=%v", "[+]", service.Name, service.Type, service.Address, service.Port, dm.parseTextRecord(service.Txt))
308+
dm.logAvahiService("[+]", service)
309309

310310
service, err := resolveService(server, service.Interface, service.Protocol, service.Name,
311311
service.Type, service.Domain)
@@ -344,7 +344,7 @@ func (dm *DeviceManager) runDiscovery(ctx context.Context, server *avahi.Server)
344344
if !ok {
345345
return errAvahiBrowserFreed
346346
}
347-
log.Printf("%s name=%s type=%s ip=%s port=%d txt=%v", "[-]", service.Name, service.Type, service.Address, service.Port, dm.parseTextRecord(service.Txt))
347+
dm.logAvahiService("[-]", service)
348348
dm.DeleteDeviceByServiceName(service.Name, model.DeviceConnectionRemote)
349349
}
350350
}
@@ -631,6 +631,24 @@ func (dm *DeviceManager) ScanWirelessDevices(ctx context.Context, timeout time.D
631631
}
632632
}
633633

634+
// logAvahiService logs discovery metadata without exposing remote pairing
635+
// authentication tags. Pairing still uses the original TXT records.
636+
func (dm *DeviceManager) logAvahiService(event string, service avahi.Service) {
637+
log.Printf("%s name=%s type=%s ip=%s port=%d txt=%v",
638+
event, service.Name, service.Type, service.Address, service.Port,
639+
dm.parseTextRecordForLog(service.Txt))
640+
}
641+
642+
// parseTextRecordForLog returns a separate map so redaction never changes
643+
// the authentication tag consumed by pairing.
644+
func (dm *DeviceManager) parseTextRecordForLog(txt [][]byte) map[string]string {
645+
record := dm.parseTextRecord(txt)
646+
if _, found := record["authTag"]; found {
647+
record["authTag"] = "[REDACTED]"
648+
}
649+
return record
650+
}
651+
634652
func (dm *DeviceManager) parseTextRecord(txt [][]byte) map[string]string {
635653
result := make(map[string]string)
636654
for _, item := range txt {
Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
//go:build linux
2+
3+
package manager
4+
5+
import (
6+
"fmt"
7+
"strings"
8+
"testing"
9+
)
10+
11+
func TestAvahiLogRedactsAuthTagWithoutChangingPairingData(t *testing.T) {
12+
const secret = "pairing-secret-123"
13+
txt := [][]byte{
14+
[]byte("identifier=device-id"),
15+
[]byte("authTag=" + secret),
16+
[]byte("flags=0"),
17+
}
18+
19+
dm := newDeviceManager()
20+
logged := dm.parseTextRecordForLog(txt)
21+
if got := logged["authTag"]; got != "[REDACTED]" {
22+
t.Fatalf("logged authTag = %q, want redaction", got)
23+
}
24+
if got := logged["identifier"]; got != "device-id" {
25+
t.Fatalf("logged identifier = %q, want original metadata", got)
26+
}
27+
if got := logged["flags"]; got != "0" {
28+
t.Fatalf("logged flags = %q, want original metadata", got)
29+
}
30+
if strings.Contains(fmt.Sprint(logged), secret) {
31+
t.Fatal("pairing auth tag leaked into log metadata")
32+
}
33+
if got := dm.parseTextRecordAuthTag(txt); got != secret {
34+
t.Fatalf("pairing authTag changed: %q", got)
35+
}
36+
if got := string(txt[1]); got != "authTag="+secret {
37+
t.Fatalf("original TXT record mutated: %q", got)
38+
}
39+
}
40+
41+
func TestAvahiLogPreservesRecordsWithoutAuthTag(t *testing.T) {
42+
dm := newDeviceManager()
43+
txt := [][]byte{
44+
[]byte("identifier=device-id"),
45+
[]byte("flags=0"),
46+
[]byte("invalid"),
47+
}
48+
got := dm.parseTextRecordForLog(txt)
49+
if _, ok := got["authTag"]; ok {
50+
t.Fatal("unexpected authTag field")
51+
}
52+
if got["identifier"] != "device-id" || got["flags"] != "0" {
53+
t.Fatalf("log metadata was changed: %v", got)
54+
}
55+
if _, ok := got["invalid"]; ok {
56+
t.Fatal("malformed TXT record unexpectedly parsed")
57+
}
58+
}

0 commit comments

Comments
 (0)
⌂ 换网址