.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Podwrapper::Man 1.22.0 (Pod::Simple 3.45)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "libnbd-release-notes-1.22 1"
.TH libnbd-release-notes-1.22 1 2025-03-25 libnbd-1.22.0 LIBNBD
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
libnbd\-release\-notes\-1.22 \- release notes for libnbd 1.22
.SH DESCRIPTION
.IX Header "DESCRIPTION"
These are the release notes for libnbd stable release 1.22.
This describes the major changes since 1.20.
.PP
libnbd 1.22.0 was released on \fBXXX XXX 2025\fR.
.SS Security
.IX Subsection "Security"
Multiple flaws in TLS server certificate checking were found and fixed
(CVE\-2024\-7383).  See
https://lists.libguestfs.org/archives/list/guestfs@lists.libguestfs.org/thread/LHR3BW6RJ7K4BJBQIYV3GTZLSY27VZO2/
(thanks Jon Szymaniak, Daniel P. Berrangé).
.PP
If you find a security issue, please read \fISECURITY\fR in the source
(online here:
https://gitlab.com/nbdkit/libnbd/blob/master/SECURITY).  To
find out about previous security issues in libnbd, see
\&\fBlibnbd\-security\fR\|(3).
.SS "New APIs"
.IX Subsection "New APIs"
\&\fBnbd_set_tls_hostname\fR\|(3) and \fBnbd_get_tls_hostname\fR\|(3) can be used
to set and get the hostname used for TLS server certificate checking.
This hostname, if set, is used in preference to the hostname of the
server.  This can be used when NBD connections are proxied, or
transported over a Unix domain socket.
.PP
\&\fBnbd_is_uri\fR\|(3) applies a heuristic to detect if something is likely
to be an NBD URI or not.
.PP
\&\fBnbd_get_subprocess_pid\fR\|(3) returns the process ID (PID) of the
subprocess created by functions such as \fBnbd_connect_command\fR\|(3).
.SS "Enhancements to existing APIs"
.IX Subsection "Enhancements to existing APIs"
As an extension to \fBnbd_connect_uri\fR\|(3), you can now connect to
\&\f(CW\*(C`nbd+ssh://\*(C'\fR or \f(CW\*(C`nbds+ssh://\*(C'\fR URIs, creating an NBD tunnel over an
SSH connection.  This is very convenient when you have SSH access to a
remote host, but a firewall prevents direct access to NBD ports.
.SS Protocol
.IX Subsection "Protocol"
We now print the full error message string if one is sent by the
server.  nbdkit\ ≥\ 1.42 will send full error messages from
plugins over the NBD connection to compatible NBD clients like
libnbd\ 1.22 or qemu.
.SS Tools
.IX Subsection "Tools"
Fix \fBnbdfuse\fR\|(1) so that TLS URIs using \f(CW\*(C`?tls\-certificates\*(C'\fR or
\&\f(CW\*(C`?tls\-psk\-file\*(C'\fR now work properly (Jon Szymaniak).
.PP
\&\fBnbddump\fR\|(1) has a new \fI\-\-offset\fR option (Eric Blake).
.SS "Language bindings"
.IX Subsection "Language bindings"
Various fixes to the Rust bindings (thanks Hanna Czenczek).
.PP
The documentation included in the Rust bindings has been improved
greatly.
.SS "Other improvements and bug fixes"
.IX Subsection "Other improvements and bug fixes"
Common code is now used to get the size of block devices, and this has
been fixed to work properly on BSD.  This affected at least nbdcopy
when used to copy to and from block devices on BSD.
.SS Documentation
.IX Subsection "Documentation"
Fix links to \fBnbd\-server\fR\|(1) and other pages in HTML-generated
documentation (Vera Wu).
.PP
In \fBnbd_connect_uri\fR\|(3) we documented small differences in the way
that we parse NBD URIs versus qemu.
.PP
\&\fBnbd_connect_uri\fR\|(3) adds additional documentation on the reserved
VSock port numbers.
.SS Build
.IX Subsection "Build"
gnutls\ ≥\ 3.5.18 is now required.  This matches the version
needed by qemu.  If using RHEL, this means that RHEL\ ≥\ 8 is now
required.
.PP
libnbd should now compile on macOS.
.PP
\&\fIexamples/connect\-benchmark\fR is a new example that can be used to
benchmark connections.
.PP
Add support for GCC 15.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBlibnbd\fR\|(3).
.SH AUTHORS
.IX Header "AUTHORS"
.IP "Daniel P. Berrangé" 4
.IX Item "Daniel P. Berrangé"
.PD 0
.IP "Eric Blake" 4
.IX Item "Eric Blake"
.IP "Richard W.M. Jones" 4
.IX Item "Richard W.M. Jones"
.IP "Jon Szymaniak" 4
.IX Item "Jon Szymaniak"
.PD
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright Red Hat
.SH LICENSE
.IX Header "LICENSE"
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.
.PP
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.
.PP
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