.\" -*- 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.28 1"
.TH nbdkit-release-notes-1.28 1 2024-05-10 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.28 \- release notes for nbdkit 1.28
.SH DESCRIPTION
.IX Header "DESCRIPTION"
These are the release notes for nbdkit stable release 1.28.
This describes the major changes since 1.26.
.PP
nbdkit 1.28.0 was released on \fB23 September 2021\fR.
.SS Security
.IX Subsection "Security"
\fICVE\-2021\-3716 reset structured replies on starttls\fR
.IX Subsection "CVE-2021-3716 reset structured replies on starttls"
.PP
nbdkit was vulnerable to injected plaintext when upgrading to a secure
connection.  For the full announcement see
https://www.redhat.com/archives/libguestfs/2021\-August/msg00083.html
(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"
\&\fBnbdkit\-data\-plugin\fR\|(1) has new \f(CW\*(C`le<NN>:\*(C'\fR and
\&\f(CW\*(C`be<NN>:\*(C'\fR prefixes for little and big endian words.  Also the
plugin tries much harder to optimize expressions.  The test suite has
been greatly expanded to catch potential regressions.
.PP
\&\fBnbdkit\-floppy\-plugin\fR\|(1) now allows you to reserve free space (Nolan
Leake).
.PP
\&\fBnbdkit\-ssh\-plugin\fR\|(1) no longer references SHA1 host keys as part of
the effort to remove insecure algorithms (Daniel Berrangé).
.PP
\&\fBnbdkit\-vddk\-plugin\fR\|(1) reports \f(CW\*(C`can_flush\*(C'\fR and \f(CW\*(C`can_fua\*(C'\fR based on
what the version of VDDK supports.  New debug flag \fI\-D vddk.stats=1\fR
prints the amount of time spent in VDDK calls on exit which can be
useful for profiling performance.
.SS Filters
.IX Subsection "Filters"
\&\fBnbdkit\-cow\-filter\fR\|(1) and \fBnbdkit\-cache\-filter\fR\|(1) no longer break
up large read requests into page-sized requests.  In addition the
default block size for both filters is now 64K.  Both changes greatly
improve performance.
.PP
\&\fBnbdkit\-cache\-filter\fR\|(1) has a new \f(CW\*(C`cache\-on\-read=/PATH\*(C'\fR parameter
allowing callers to enable and disable the cache-on-read feature at
runtime.  Also there is a new \f(CW\*(C`cache\-min\-block\-size\*(C'\fR parameter
letting you select the block size at runtime (thanks Martin
Kletzander).
.PP
\&\fBnbdkit\-cow\-filter\fR\|(1) has a new \f(CW\*(C`cow\-on\-read\*(C'\fR parameter which works
similarly to the corresponding cache filter feature.  The new
\&\f(CW\*(C`cow\-block\-size\*(C'\fR parameter lets you select the block size at runtime.
.PP
\&\fBnbdkit\-cow\-filter\fR\|(1) has less verbose debugging.  To restore the
old debug output use \fI\-D cow.verbose=1\fR
.PP
\&\fBnbdkit\-delay\-filter\fR\|(1) has new \f(CW\*(C`delay\-open\*(C'\fR and \f(CW\*(C`delay\-close\*(C'\fR
parameters to inject delays when clients connect and disconnect.
Delay filter parameters are now parsed more accurately (thanks Ming
Xie).
.SS "Language bindings"
.IX Subsection "Language bindings"
The OCaml bindings now call \f(CW\*(C`caml_shutdown\*(C'\fR when unloading the
plugin.  This causes \f(CW\*(C`Stdlib.at_exit\*(C'\fR handlers to run correctly,
closes file descriptors, releases dependent shared libraries and frees
memory.  Valgrind on OCaml plugins should not show any false positives
about leaked memory.
.PP
OCaml and Python bindings may now use the \f(CW\*(C`.cleanup\*(C'\fR method.
.PP
References to Python 2 in \fBnbdkit\-python\-plugin\fR\|(3) have been removed.
.SS Server
.IX Subsection "Server"
Fix captive nbdkit \f(CW$uri\fR variable so when TLS is used the URI is
constructed with the \f(CW\*(C`nbds:\*(C'\fR prefix.  Additionally add a new variable
\&\f(CW$tls\fR which can be used by the subprocess to tell if TLS is enabled.
.PP
Debug messages are now printed atomically.  This means that debug
messages are no longer broken up across multiple lines if there are
other processes writing to stderr at the same time (which often
happened when using captive nbdkit).
.PP
Enhanced valgrind support (\fI./configure \-\-enable\-valgrind\fR) can now
be enabled safely and with no performance impact even in production
builds (Eric Blake).
.SS API
.IX Subsection "API"
Plugins or filters using \f(CW\*(C`nbdkit_nanosleep\*(C'\fR now don't hang if the
client closes the socket abruptly (thanks Ming Xie).
.SS "Bug fixes"
.IX Subsection "Bug fixes"
\&\fBnbdkit\-data\-plugin\fR\|(1) and \fBnbdkit\-memory\-plugin\fR\|(1) using
allocator=malloc no longer crash because of memory corruption in some
corner cases (only seen on s390x, but could happen on other
architectures).  Meanwhile \f(CW\*(C`allocator=zstd\*(C'\fR no longer crashes when
zeroing unallocated space.
.SS Tests
.IX Subsection "Tests"
Tests now use the new \f(CW\*(C`GLIBC_TUNABLES\*(C'\fR feature, replacing
\&\f(CW\*(C`MALLOC_CHECK_\*(C'\fR on glibc ≥ 2.34 (thanks Eric Blake,
Siddhesh Poyarekar).
.SS Build
.IX Subsection "Build"
\&\fIconfigure.ac\fR now uses spaces consistently, and has been
modernized to support the latest autotools (Eric Blake).
.PP
\&\fIpodwrapper.pl\fR has been unified (almost) with the copy in libnbd.
.PP
Continue fuzzing using AFL++.  Updated the fuzzing documentation.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBnbdkit\fR\|(1).
.SH AUTHORS
.IX Header "AUTHORS"
Authors of nbdkit 1.28:
.IP "Daniel P. Berrangé" 4
.IX Item "Daniel P. Berrangé"
.PD 0
.IP "Eric Blake" 4
.IX Item "Eric Blake"
.IP "Martin Kletzander" 4
.IX Item "Martin Kletzander"
.IP "Nolan Leake" 4
.IX Item "Nolan Leake"
.IP "Richard W.M. Jones" 4
.IX Item "Richard W.M. Jones"
.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.