.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Podwrapper::Man 1.38.2 (Pod::Simple 3.43)
.\"
.\" 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 "nbdkit-release-notes-1.34 1"
.TH nbdkit-release-notes-1.34 1 2024-05-08 nbdkit-1.38.2 NBDKIT
.\" 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
nbdkit\-release\-notes\-1.34 \- release notes for nbdkit 1.34
.SH DESCRIPTION
.IX Header "DESCRIPTION"
These are the release notes for nbdkit stable release 1.34.
This describes the major changes since 1.32.
.PP
nbdkit 1.34.0 was released on \fB14 April 2023\fR.
.SS Security
.IX Subsection "Security"
Various sanity checks were added to \fBnbdkit\-luks\-filter\fR\|(1) so it can
handle untrusted disk images.
.PP
TLS support was hardened against a Man-in-the-Middle attacker
injecting unknown NBD options before STARTTLS (Eric Blake).
.PP
Fix rare assertion failure (denial of service) which can be triggered
by clients hanging up early (Eric Blake).
.PP
All past security issues and information about how to report new ones
can be found in \fBnbdkit\-security\fR\|(1).
.SS Plugins
.IX Subsection "Plugins"
New \fBnbdkit\-blkio\-plugin\fR\|(1) allows you to easily consume and
automate the libblkio high
performance storage library.  This allows you to (amongst other
things) access local vhost-user and VFIO devices (thanks Alberto Faria
and Stefan Hajnoczi).
.PP
\&\fBnbdkit\-file\-plugin\fR\|(1) has new \f(CW\*(C`fd\*(C'\fR and \f(CW\*(C`dirfd\*(C'\fR parameters
allowing a file or directory to be passed from a parent process
through a file descriptor.
.PP
Several enhancements were made to \fBnbdkit\-curl\-plugin\fR\|(1),
concentrating on improved performance and functionality:
.IP \(bu 4
Multi-conn is now enabled for read-only connections (thanks Eric
Blake).
.IP \(bu 4
Instead of using one libcurl handle per NBD client, we now use a
common pool of handles, which improves performance.
.IP \(bu 4
Fix the \f(CW\*(C`tls13\-ciphers\*(C'\fR parameter (Michal Orzel).
.IP \(bu 4
We now use the new \fBCURLOPT_PROTOCOLS_STR\fR\|(3) feature of libcurl (if
available) instead of hard-coding the list of protocols into the
plugin.
.IP \(bu 4
Support was added for forcing \f(CW\*(C`ssl\-version\*(C'\fR, http-version
.PP
\&\fBnbdkit\-vddk\-plugin\fR\|(1) now supports VDDK 8 (thanks Ming Xie, Alice
Frosi).
.PP
\&\fBnbdkit\-torrent\-plugin\fR\|(1) was ported to macOS (Eric Blake).
.SS Filters
.IX Subsection "Filters"
\&\fBnbdkit\-blocksize\-policy\-filter\fR\|(1) has a new
\&\f(CW\*(C`blocksize\-write\-disconnect\*(C'\fR to force a disconnection if a client
attempts a write larger than a certain threshold (Eric Blake).
.PP
\&\fBnbdkit\-retry\-filter\fR\|(1) can now retry plugin open (Eric Blake).
.SS "Language bindings"
.IX Subsection "Language bindings"
\&\fBnbdkit\-python\-plugin\fR\|(3) now rejects extra parameters to
\&\f(CW\*(C`export_name\*(C'\fR and \f(CW\*(C`shutdown\*(C'\fR functions (Eric Blake).
.PP
Tracebacks from Python plugins should now include the full method name
(Eric Blake).
.PP
\&\fBnbdkit\-sh\-plugin\fR\|(3) status codes have changed in this release,
although in a way that will normally be backwards compatible with
older plugins.  Two new status codes are reserved for shutdown server
and disconnect client.  Check the manual page for details.  (Eric
Blake)
.SS Server
.IX Subsection "Server"
\&\f(CW\*(C`nbdkit \-\-dump\-config\*(C'\fR now reports \f(CW\*(C`exit_with_parent=yes|no\*(C'\fR so you
can tell if the optional exit with parent
functionality is enabled on the platform.
.PP
Debug messages from filters and plugins are now picked out in bold,
making them easier to read amongst other nbdkit debug messages.
.SS API
.IX Subsection "API"
New \f(CW\*(C`nbdkit_disconnect\*(C'\fR API which allows a plugin or filter to drop
the connection to the current client (Eric Blake).
.SS "Bug fixes"
.IX Subsection "Bug fixes"
Fix a deadlock in \fBnbdkit\-exitwhen\-filter\fR\|(1) (Piotr Dobrowolski).
.PP
Fix the error message in \fBnbdkit\-ssh\-plugin\fR\|(1) when the
\&\fIknown_hosts\fR file is not readable (thanks Jonathon Jongsma).
.SS Documentation
.IX Subsection "Documentation"
The \fI\-\-help\fR output of plugins is now consistent with the manual
pages, and extra tests were added to ensure it stays this way.
.SS Tests
.IX Subsection "Tests"
Multiple CI improvements, particularly for Alpine Linux and macOS
(Eric Blake).
.SS Build
.IX Subsection "Build"
Most \f(CW\*(C`./configure\*(C'\fR\-time features can now be both enabled and disabled
using \fI\-\-with\-\fRfeature and \fI\-\-without\-\fRfeature (Arsen Arsenović).
.PP
Multiple VPATH build problems fixed (Eric Blake).
.SS Internals
.IX Subsection "Internals"
Use \fISubject Alternative Name\fR instead of \fIcommonName\fR in test
certificates and suggest its use in documentation (thanks Daniel
Berrangé).
.PP
Source files reformatted to use ≤ 80 columns (Laszlo Ersek).
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBnbdkit\fR\|(1).
.SH AUTHORS
.IX Header "AUTHORS"
Authors of nbdkit 1.34:
.IP "Alan Somers" 4
.IX Item "Alan Somers"
.PD 0
.IP "Arsen Arsenović" 4
.IX Item "Arsen Arsenović"
.IP "Daniel P. Berrangé" 4
.IX Item "Daniel P. Berrangé"
.IP "Eric Blake" 4
.IX Item "Eric Blake"
.IP "Laszlo Ersek" 4
.IX Item "Laszlo Ersek"
.IP "Michal Orzel" 4
.IX Item "Michal Orzel"
.IP "Nikolaus Rath" 4
.IX Item "Nikolaus Rath"
.IP "Nir Soffer" 4
.IX Item "Nir Soffer"
.IP "Piotr Dobrowolski" 4
.IX Item "Piotr Dobrowolski"
.IP "Richard W.M. Jones" 4
.IX Item "Richard W.M. Jones"
.IP "Thomas Weißschuh" 4
.IX Item "Thomas Weißschuh"
.PD
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright Red Hat
.SH LICENSE
.IX Header "LICENSE"
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:
.IP \(bu 4
Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
.IP \(bu 4
Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
.IP \(bu 4
Neither the name of Red Hat nor the names of its contributors may be
used to endorse or promote products derived from this software without
specific prior written permission.
.PP
THIS SOFTWARE IS PROVIDED BY RED HAT AND CONTRIBUTORS ''AS IS'' AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL RED HAT OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.