Commitae2e4f6aRecorded6 Nov 2026Repositorysigil-dbus
Support owned secret replies in nested settings dictionaries
Changed
README.md | 7 +++++++
src/sigil/dbus.sgl | 2 +-
src/sigil/dbus/sensitive.sgl | 42 +++++++++++++++++++++++++++++++++---------
test/test-sensitive.sgl | 35 +++++++++++++++++++++++++++++++++++
4 files changed, 76 insertions(+), 10 deletions(-)Diff
README.mdmodified
@@ -1,5 +1,12 @@
1
# sigil-dbus 2
+3
`dbus-sensitive-dictionary-reply` takes a public setting name, a public field+4
name and owned UTF-8 bytes. It returns one string secret in `a{sa{sv}}`, for+5
example a NetworkManager SecretAgent reply. As with `dbus-sensitive-reply`,+6
the input and final encoded frame are cleared after send, cancellation,+7
validation failure or transport failure. The value is usable once. This+8
does not clear runtime, kernel, daemon or caller-created copies.+9
10
A pure Sigil D-Bus client and object-service library. Requires public Sigil 11
0.23.1 on Unix. Uses Sigil's socket and cooperative scheduler APIs; there is 12
no libdbus or sd-bus dependency and no native extension in this package.src/sigil/dbus.sglmodified
@@ -12,7 +12,7 @@
12
dbus-request-name! dbus-release-name! dbus-allow-replacement 13
dbus-replace-existing dbus-do-not-queue dbus-subscribe! dbus-unsubscribe! 14
dbus-send-signal! dbus-method dbus-property dbus-signal dbus-interface−15
dbus-sensitive-reply dbus-sensitive-reply? dbus-sensitive-reply-clear!+15
dbus-sensitive-reply dbus-sensitive-dictionary-reply dbus-sensitive-reply? dbus-sensitive-reply-clear! 16
dbus-export! dbus-unexport! dbus-introspect dbus-properties-changed! 17
dbus-message dbus-message? dbus-message-type dbus-message-flags 18
dbus-message-serial dbus-message-fields dbus-message-signaturesrc/sigil/dbus/sensitive.sglmodified
@@ -1,7 +1,8 @@
1
;;; One-use string replies keep credentials out of ordinary string marshalling. 2
(define-library (sigil dbus sensitive)−3
(import (sigil dbus message) (sigil dbus wire))−4
(export dbus-sensitive-reply dbus-sensitive-reply? dbus-sensitive-reply-clear!+3
(import (sigil dbus message) (sigil dbus wire) (sigil dbus types))+4
(export dbus-sensitive-reply dbus-sensitive-dictionary-reply+5
dbus-sensitive-reply? dbus-sensitive-reply-clear! 6
dbus-validate-sensitive-reply! dbus-write-sensitive-reply!) 7
(begin 8
(define tag (list 'sensitive-reply))@@ -9,10 +10,18 @@
10
;; Ownership transfers immediately; callers must not read or modify BYTES. 11
(define (dbus-sensitive-reply bytes) 12
(unless (bytevector? bytes) (error "Sensitive reply requires UTF-8 bytes"))−12
(vector tag bytes #f))+13
(vector tag bytes #f #f #f))+14
+15
;; Setting and field names are public metadata. BYTES transfer ownership.+16
(define (dbus-sensitive-dictionary-reply setting field bytes)+17
(unless (bytevector? bytes) (error "Sensitive reply requires UTF-8 bytes"))+18
(unless (and (string? setting) (string? field))+19
(clear! bytes)+20
(error "Sensitive dictionary reply requires public setting and field names"))+21
(vector tag bytes #f setting field)) 22
23
(define (dbus-sensitive-reply? reply)−15
(and (vector? reply) (= 3 (vector-length reply))+24
(and (vector? reply) (= 5 (vector-length reply)) 25
(eq? tag (vector-ref reply 0)))) 26
27
(define (clear! bytes)@@ -28,8 +37,8 @@
37
(define (dbus-validate-sensitive-reply! reply signature) 38
(guard (e (else (dbus-sensitive-reply-clear! reply) (raise e))) 39
(when (vector-ref reply 2) (error "Sensitive reply was already consumed"))−31
(unless (string=? "s" signature)−32
(error "Sensitive replies require one string output"))+40
(unless (string=? (if (vector-ref reply 3) "a{sa{sv}}" "s") signature)+41
(error "Sensitive reply output signature mismatch")) 42
(unless (<= (bytevector-length (vector-ref reply 1)) dbus-max-message-size) 43
(error "Sensitive reply exceeds byte limit")) 44
(wire-check-utf8 (vector-ref reply 1))))@@ -54,17 +63,32 @@
63
(error "Sensitive replies require a method return")) 64
;; An empty public string produces the header without any secret 65
;; copies. Replace its five-byte body directly in the final frame.−57
(let* ((empty (dbus-encode-message+66
(let* ((setting (vector-ref reply 3))+67
(signature (if setting "a{sa{sv}}" "s"))+68
(body (if setting+69
(list (list (cons setting+70
(list (cons (vector-ref reply 4) (dbus-variant "s" ""))))))+71
'("")))+72
(empty (dbus-encode-message 73
(dbus-message 2 (dbus-message-serial message)−59
(dbus-message-fields message) "s" '(""))+74
(dbus-message-fields message) signature body) 75
endianness: 'little)) 76
(start (- (bytevector-length empty) 5))+77
(body-size (bytevector-length (dbus-marshal signature body endianness: 'little)))+78
(body-start (- (bytevector-length empty) body-size)) 79
(n (bytevector-length bytes))) 80
(unless (<= (+ start 5 n) dbus-max-message-size) 81
(error "Sensitive reply exceeds byte limit")) 82
(set! frame (make-bytevector (+ start 5 n) 0)) 83
(bytevector-copy! frame 0 empty 0 start)−67
(uint32! frame 4 (+ n 5))+84
(uint32! frame 4 (+ n body-size))+85
(when setting+86
;; Both array lengths include the secret appended at the end.+87
(let* ((after-setting (+ body-start 8 4 (bytevector-length (string->utf8 setting)) 1))+88
(inner (+ after-setting (modulo (- 4 (modulo after-setting 4)) 4)))+89
(data (+ inner 4 (modulo (- 8 (modulo (+ inner 4) 8)) 8))))+90
(uint32! frame body-start (+ n (- body-size 8)))+91
(uint32! frame inner (+ n (- (bytevector-length empty) data))))) 92
(uint32! frame start n) 93
(bytevector-copy! frame (+ start 4) bytes) 94
(write frame)))test/test-sensitive.sglmodified
@@ -49,4 +49,39 @@
49
(dbus-sensitive-reply-clear! reply) 50
(assert-true (zero? bytes)) 51
(assert-error (dbus-write-sensitive-reply! (message "s") reply (lambda (b) #t))))))+52
(test-group "owned nested dictionary replies"+53
(test "nested lengths and alignment for public names and UTF-8 secrets"+54
(for-each+55
(lambda (setting)+56
(for-each+57
(lambda (field)+58
(let* ((bytes (string->utf8 "héλ🙂"))+59
(reply (dbus-sensitive-dictionary-reply setting field bytes)) (sent #f))+60
(dbus-write-sensitive-reply! (message "a{sa{sv}}") reply+61
(lambda (frame)+62
(set! sent frame)+63
(assert-equal+64
(list (list (cons setting (list (cons field (dbus-variant "s" "héλ🙂"))))))+65
(dbus-message-body (dbus-decode-message frame)))))+66
(assert-true (zero? bytes))+67
(assert-true (zero? sent))+68
(assert-error (dbus-write-sensitive-reply! (message "a{sa{sv}}") reply (lambda (b) #t)))))+69
'("p" "psk" "long-field")))+70
'("a" "ab" "abc" "abcd" "802-11-wireless-security")))+71
(test "failed writes and validation clear the owned secret"+72
(for-each+73
(lambda (signature)+74
(let ((bytes (string->utf8 "abcdefgh")) (sent #f))+75
(assert-error+76
(dbus-write-sensitive-reply! (message signature)+77
(dbus-sensitive-dictionary-reply "802-11-wireless-security" "psk" bytes)+78
(lambda (frame) (set! sent frame) (error "forced failure"))))+79
(assert-true (zero? bytes))+80
(when sent (assert-true (zero? sent)))))+81
'("a{sa{sv}}" "s")))+82
(test "no-reply cancellation clears a dictionary reply"+83
(let ((bytes (string->utf8 "abcdefgh")))+84
(dbus-send-reply! #f (dbus-message 1 7 '() "" '() flags: 1) "a{sa{sv}}"+85
(dbus-sensitive-dictionary-reply "802-11-wireless-security" "psk" bytes))+86
(assert-true (zero? bytes))))) 87
(unless (run-tests) (exit 1))