Commitd709d270Recorded7 Nov 2026Repositorysigil-dbus
Clear owned D-Bus receive buffers after decoding and close
Changed
README.md | 6 ++++++
package.sgl | 2 +-
src/sigil/dbus/buffers.sgl | 9 +++++++++
src/sigil/dbus/transport.sgl | 20 ++++++++++++++++----
src/sigil/dbus/wire.sgl | 21 +++++++++++++--------
test/test-transport.sgl | 40 ++++++++++++++++++++++++++++++++++++++++
6 files changed, 85 insertions(+), 13 deletions(-)Diff
README.mdmodified
@@ -7,6 +7,12 @@ 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
The receive transport clears its owned socket chunks and completed frames after+11
decoding, including rejected frames, and clears an incomplete frame on close.+12
String decoding also clears its temporary UTF-8 bytevector. Returned strings+13
and bytevectors remain caller-owned; an agent receiving credentials in ordinary+14
method arguments must clear those decoded values after inspecting them.+15
16
A pure Sigil D-Bus client and object-service library. Requires public Sigil 17
0.23.1 on Unix. Uses Sigil's socket and cooperative scheduler APIs; there is 18
no libdbus or sd-bus dependency and no native extension in this package.package.sglmodified
@@ -1,6 +1,6 @@
1
(package 2
name: "sigil-dbus"−3
version: "0.1.1"+3
version: "0.1.2" 4
sigil: "0.24" 5
description: "Pure Sigil D-Bus wire protocol, clients, and object services" 6
license: "BSD-3-Clause"src/sigil/dbus/buffers.sgladded
@@ -0,0 +1,9 @@
+1
;;; Clearing belongs to the owner of a temporary wire buffer.+2
(define-library (sigil dbus buffers)+3
(export dbus-clear-buffer!)+4
(begin+5
(define (dbus-clear-buffer! bytes)+6
(let loop ((i 0))+7
(when (< i (bytevector-length bytes))+8
(bytevector-u8-set! bytes i 0)+9
(loop (+ i 1)))))))src/sigil/dbus/transport.sglmodified
@@ -1,6 +1,6 @@
1
(define-library (sigil dbus transport) 2
(import (sigil socket) (sigil async) (sigil time) (sigil process)−3
(sigil string) (sigil io) (sigil dbus message))+3
(sigil string) (sigil io) (sigil dbus message) (sigil dbus buffers)) 4
(export dbus-open-transport dbus-close-transport! dbus-transport-read! 5
dbus-transport-write! dbus-transport-closed? dbus-transport-fd dbus-parse-address 6
dbus-deadline dbus-remaining-ms)@@ -64,7 +64,12 @@
64
(and (not (dbus-transport-closed? transport)) (socket-fd (vector-ref transport 0)))) 65
66
(define (dbus-close-transport! transport)−67
(socket-close (vector-ref transport 0)))+67
(dynamic-wind+68
(lambda () #t)+69
(lambda () (socket-close (vector-ref transport 0)))+70
(lambda ()+71
(dbus-clear-buffer! (vector-ref transport 1))+72
(vector-set! transport 2 0)))) 73
74
(define (dbus-transport-write! transport bytes (keys: (timeout-ms 25000))) 75
(let ((deadline (dbus-deadline timeout-ms)) (sock (vector-ref transport 0)))@@ -183,6 +188,7 @@
188
(let* ((size (dbus-frame-size buffer max-bytes: (vector-ref transport 4))) 189
(frame (make-bytevector size))) 190
(bytevector-copy! frame 0 buffer)+191
(dbus-clear-buffer! buffer) 192
(vector-set! transport 1 frame) 193
(vector-set! transport 3 #f) 194
(loop))@@ -190,7 +196,10 @@
196
(vector-set! transport 1 (make-bytevector 16)) 197
(vector-set! transport 2 0) 198
(vector-set! transport 3 #t)−193
(dbus-decode-message buffer max-bytes: (vector-ref transport 4)))))+199
(dynamic-wind+200
(lambda () #t)+201
(lambda () (dbus-decode-message buffer max-bytes: (vector-ref transport 4)))+202
(lambda () (dbus-clear-buffer! buffer)))))) 203
((and (> timeout-ms 0) (<= (dbus-remaining-ms deadline) 0)) #f) 204
(else 205
(let ((chunk (socket-read-bytevector sock (min remaining 65536))))@@ -202,6 +211,9 @@
211
(begin (await-readable-any (list sock) timeout-ms: (dbus-remaining-ms deadline)) 212
(loop)))) 213
(else−205
(bytevector-copy! buffer used chunk)+214
(dynamic-wind+215
(lambda () #t)+216
(lambda () (bytevector-copy! buffer used chunk))+217
(lambda () (dbus-clear-buffer! chunk))) 218
(vector-set! transport 2 (+ used (bytevector-length chunk))) 219
(loop))))))))))))src/sigil/dbus/wire.sglmodified
@@ -1,5 +1,5 @@
1
(define-library (sigil dbus wire)−2
(import (sigil dbus types) (sigil io))+2
(import (sigil dbus types) (sigil dbus buffers) (sigil io)) 3
(export dbus-marshal dbus-unmarshal dbus-native-endianness 4
dbus-max-message-size dbus-max-array-size 5
wire-writer wire-reader wire-position wire-align! wire-put! wire-get!@@ -145,13 +145,18 @@
145
(let ((n (wire-read-uint! state (if (char=? type #\g) 1 4)))) 146
(wire-check! state (+ n 1)) 147
(let* ((start (wire-position state))−148
(bytes (bytevector-copy (vector-ref state 0) start (+ start n)))−149
(checked (check-utf8 bytes))−150
(text (utf8->string bytes)))−151
(vector-set! state 1 (+ start n))−152
(unless (= 0 (read-byte! state)) (error "Missing D-Bus string terminator"))−153
(check-text text type)−154
text)))+148
(bytes (bytevector-copy (vector-ref state 0) start (+ start n))))+149
(dynamic-wind+150
(lambda () #t)+151
(lambda ()+152
(check-utf8 bytes)+153
(let ((text (utf8->string bytes)))+154
(guard (e (else (string-fill! text (integer->char 0)) (raise e)))+155
(vector-set! state 1 (+ start n))+156
(unless (= 0 (read-byte! state)) (error "Missing D-Bus string terminator"))+157
(check-text text type)+158
text)))+159
(lambda () (dbus-clear-buffer! bytes)))))) 160
161
(define (integer-width type) 162
(condtest/test-transport.sglmodified
@@ -50,9 +50,49 @@
50
(define (reply text) 51
(dbus-encode-message 52
(dbus-message 2 1 (list (cons 5 (dbus-variant "u" 9))) "s" (list text))))+53
(define (cleared? bytes)+54
(let loop ((i 0))+55
(or (= i (bytevector-length bytes))+56
(and (= 0 (bytevector-u8-ref bytes i)) (loop (+ i 1)))))) 57
58
(with-async 59
(test-group "stream transport"+60
(test "decoded receive frame is cleared without changing returned values"+61
(let ((bytes (reply "buffer-canary")))+62
(with-peer "clear-decoded"+63
(lambda (peer)+64
(peer-send peer bytes 0 (- (bytevector-length bytes) 1))+65
(sleep 0.05)+66
(peer-send peer bytes (- (bytevector-length bytes) 1) (bytevector-length bytes)))+67
(lambda (transport)+68
(assert-false (dbus-transport-read! transport timeout-ms: 5))+69
(let ((frame (vector-ref transport 1)))+70
(assert-true (> (bytevector-length frame) 16))+71
(assert-equal '("buffer-canary")+72
(dbus-message-body (dbus-transport-read! transport timeout-ms: 300)))+73
(assert-true (cleared? frame)))))))+74
(test "malformed decoded receive frame is cleared on rejection"+75
(let ((bytes (reply "buffer-canary")))+76
(bytevector-u8-set! bytes (- (bytevector-length bytes) 1) 1)+77
(with-peer "clear-rejected"+78
(lambda (peer)+79
(peer-send peer bytes 0 (- (bytevector-length bytes) 1))+80
(sleep 0.05)+81
(peer-send peer bytes (- (bytevector-length bytes) 1) (bytevector-length bytes)))+82
(lambda (transport)+83
(assert-false (dbus-transport-read! transport timeout-ms: 5))+84
(let ((frame (vector-ref transport 1)))+85
(assert-error (dbus-transport-read! transport timeout-ms: 300))+86
(assert-true (cleared? frame)))))))+87
(test "closing clears an incomplete receive frame"+88
(let ((bytes (reply "buffer-canary")))+89
(with-peer "clear-partial"+90
(lambda (peer) (peer-send peer bytes 0 (- (bytevector-length bytes) 1)))+91
(lambda (transport)+92
(assert-false (dbus-transport-read! transport timeout-ms: 5))+93
(let ((frame (vector-ref transport 1)))+94
(dbus-close-transport! transport)+95
(assert-true (cleared? frame))))))) 96
(test "fragmented fixed header and body survive read timeouts" 97
(let ((bytes (reply "fragmented"))) 98
(with-peer "fragments"