Skip to contentSkip to conversation

docs/secure-coding-practices: Describe how to use 'null-co' block driver

PATCH Superseded Philippe Mathieu-Daudé 3 participants 3 messages Jun 1, 2021

v3 of 4 Superseded Latest is v4 →

lore
Share & tools
lore
#0 lore raw

PATCH v3 1/1 docs/secure-coding-practices: Describe how to use 'null-co' block driver

Document that security reports must use 'null-co,read-zeroes=on' because otherwise the memory is left uninitialized (which is an on-purpose performance feature).

---
v3: Simplified using Vladimir suggestion.

---
 docs/devel/secure-coding-practices.rst | 9 +++++++++
 1 file changed, 9 insertions(+)
docs/devel/secure-coding-practices.rst +9 -0
index cbfc8af67e6..79a3dcd09a3 100644
@@ -104,3 +104,12 @@ structures and only process the local copy.  This prevents
 time-of-check-to-time-of-use (TOCTOU) race conditions that could cause QEMU to
 crash when a vCPU thread modifies guest RAM while device emulation is
 processing it.
+
+Use of null-co block drivers
+----------------------------
+
+The ``null-co`` block driver is designed for performance: its read accesses are
+not initialized by default. In case it this driver has to be used for security
+research, it must be used with the ``read-zeroes=on`` option which fills read
+buffers with zeroes. Security issues reported with the default
+(``read-zeroes=off``) will be discarded.
Signature · 1 line
2.26.3
#2 lore raw
In reply to Philippe Mathieu-Daudé

Am 01.06.2021 um 07:35 hat Philippe Mathieu-Daudé geschrieben:

Quoted 16 lines

Document that security reports must use 'null-co,read-zeroes=on' because otherwise the memory is left uninitialized (which is an on-purpose performance feature).

---
v3: Simplified using Vladimir suggestion.

---
 docs/devel/secure-coding-practices.rst | 9 +++++++++
 1 file changed, 9 insertions(+)
docs/devel/secure-coding-practices.rst +0 -0
index cbfc8af67e6..79a3dcd09a3 100644

docs/devel/secure-coding-practices.rst structures and only process the local copy. This prevents · line 112

Quoted 9 lines
docs/devel/secure-coding-practices.rst +6 -0
@@ -104,3 +104,12 @@ structures and only process the local copy.  This prevents
 time-of-check-to-time-of-use (TOCTOU) race conditions that could cause QEMU to
 crash when a vCPU thread modifies guest RAM while device emulation is
 processing it.
+
+Use of null-co block drivers
+----------------------------
+
+The ``null-co`` block driver is designed for performance: its read accesses are
+not initialized by default. In case it this driver has to be used for security

"it this driver" is probably a typo?

docs/devel/secure-coding-practices.rst structures and only process the local copy. This prevents · line 115

Quoted 3 lines
docs/devel/secure-coding-practices.rst +3 -0
+research, it must be used with the ``read-zeroes=on`` option which fills read
+buffers with zeroes. Security issues reported with the default
+(``read-zeroes=off``) will be discarded.

Kevin