nbd_set_tls_hostname - Man Page

 #include <libnbd.h>

 int nbd_set_tls_hostname (
       struct nbd_handle *h, const char *hostname
     );

Set the TLS server hostname.  This is used in preference to the hostname supplied when connecting (eg. through nbd_connect_tcp(3)), or when there is no explicit hostname at all (nbd_connect_unix(3)). It can be useful when you are connecting to a proxy which is forwarding the data to the final server, to specify the name of the final server so that the server's certificate can be checked.

This function may be called regardless of whether TLS is supported, but will have no effect unless nbd_set_tls(3) is also used to request or require TLS.

If the call is successful the function returns 0.

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, hostname. For more information see "Non-NULL parameters" in libnbd(3).

nbd_set_tls_hostname 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 function first appeared in libnbd 1.22.

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_TLS_HOSTNAME 1

nbd_connect_tcp(3), nbd_connect_unix(3), nbd_create(3), nbd_set_tls(3), nbd_set_tls_username(3), libnbd(3).

Eric Blake

Richard W.M. Jones

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

libnbd(3), NBD(3), nbd_connect_uri(3), nbd_get_tls_hostname(3), nbd_set_tls_username(3).