libnbd-release-notes-1.24 - release notes for libnbd 1.24
These are the release notes for libnbd stable release 1.24. This describes the major changes since 1.22.
libnbd 1.24.0 was released on XXX December 2025.
In nbd_connect_uri(3), and in several libnbd tools (for example, nbdinfo(1)), when using nbd+ssh:// URIs, the hostname field was not adequately sanitized. A consequence is that an attacker who can control this field in the URI could run commands from libnbd. This issue affected libnbd ≥ 1.22. For more information see: https://lists.libguestfs.org/archives/list/guestfs@lists.libguestfs.org/thread/YZMBF3SJRWTRVT5L3KWSNHITFTRMQNTT/
If you find a security issue, please read SECURITY in the source (online here: https://gitlab.com/nbdkit/libnbd/blob/master/SECURITY). To find out about previous security issues in libnbd, see libnbd-security(3).
New nbd_get_version_extra(3) returns the string passed to ./configure --with-extra="...". This is intended to be used by downstream packagers.
New nbd_get_handle_size(3) which returns an estimate of the size of the handle in bytes. This is intended for use by garbage collected languages as a hint for when to free the handle.
In nbd_connect_uri(3) nbd+ssh:// URIs, extra nbd-port and tls-username query parameters allow you to separately control the NBD TLS and SSH user/port. The new compress=true query parameter lets you enable SSH compression.
New nbddiscard(1) and nbdzero(1) tools which can be used to trim/discard, or zero, part or all of an NBD disk (additional features by Eric Blake).
New nbdcopy(1) --blkhash feature. This can calculate the blkhash (similar to a checksum) of the image as it is being copied (Nir Soffer, Vera Wu).
Obey nbdcopy --destination-is-zero and --allocated options when running in synchronous mode (Nir Soffer).
OCaml bindings now implement NBD.Buffer.is_zero
OCaml bindings now provide a better estimate of the size of the libnbd handle to the garbage collector, allowing it to — at least in theory — make better decisions on when to free the handle (thanks Kit-ty-kate).
Python bindings implement indexing and slicing of nbd.Buffer
Improve the automatic conversion of POD documentation to Rust documentation. Previously garbled mark-up will now be converted properly.
Enhanced tests of the nbdcopy --allocated and --destination-is-zero options.
When running libnbd tests on ZFS, several tests would fail. They are now skipped (thanks Arsen Arsenović, Eric Blake).
nbdcopy now gives a hard error if the Linux system call sync_file_range(2) fails. This can happen for certain device I/O errors (thanks Eric Sandeen, Dave Chinner).
On macOS and Linux, set Unix domain socket buffer sizes for improved performance (Nir Soffer).
Fix several typos and spelling mistakes in the documentation (Eric Blake).
New libnbd-python(3) page which provides an introduction to the Python API. This information was previously scattered in a few places.
./configure --with-extra="..." can be used by downstream packagers to add extra information to the --version output of tools, such as the version of the downstream package.
Colourize and improve the ./configure output, if using a terminal.
Copy new vector and string functions from nbdkit, including vector_uniq, vector_append_array, vector_insert_array, C,vector_remove_range>, string_append_format.
Copyright Red Hat
This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA