nbd_set_uri_allow_tls - set the allowed TLS settings in NBD URIs

       Eric Blake

       Richard W.M. Jones

       Copyright Red Hat

       Set which TLS settings are allowed to appear in NBD URIs.  The default is to allow either non-TLS or TLS
       URIs.

       The "tls" parameter can be:

       "LIBNBD_TLS_DISABLE"
           TLS URIs are not permitted, ie. a URI such as "nbds://..."  will be rejected.

       "LIBNBD_TLS_ALLOW"
           This is the default.  TLS may be used or not, depending on whether the URI uses "nbds" or "nbd".

       "LIBNBD_TLS_REQUIRE"
           TLS URIs are required.  All URIs must use "nbds".

       On error -1 is returned.

       Refer to "ERROR HANDLING" in libnbd(3) for how to get further details of the error.

       The  following  parameters  must  not  be  NULL:  "h".  For more information see "Non-NULL parameters" in
       libnbd(3).

       nbd_set_uri_allow_tls can be called when the handle is in the following state:

        ┌─────────────────────────────────────┬─────────────────────────┐
        │ Handle created, before connecting   │ ✅ allowed              │
        │ Connecting                          │ ❌ error                │
        │ Connecting & handshaking (opt_mode) │ ❌ error                │
        │ Connected to the server             │ ❌ error                │
        │ Connection shut down                │ ❌ error                │
        │ Handle dead                         │ ❌ error                │
        └─────────────────────────────────────┴─────────────────────────┘

       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

libnbd-1.22.2                                      2025-06-16                           nbd_set_uri_allow_tls(3)

       nbd_set_uri_allow_tls - set the allowed TLS settings in NBD URIs

       If the call is successful the function returns 0.

nbd_connect_uri(3), nbd_create(3), nbd_set_uri_allow_transports(3), libnbd(3).

        #include <libnbd.h>

        int nbd_set_uri_allow_tls (
              struct nbd_handle *h, int tls
            );

       This function first appeared in libnbd 1.2.

       If you need to test if this function is available at  compile  time  check  if  the  following  macro  is
       defined:

        #define LIBNBD_HAVE_NBD_SET_URI_ALLOW_TLS 1