1nbd_get_tls_negotiated(3)           LIBNBD           nbd_get_tls_negotiated(3)
2
3
4

NAME

6       nbd_get_tls_negotiated - find out if TLS was negotiated on a connection
7

SYNOPSIS

9        #include <libnbd.h>
10
11        int nbd_get_tls_negotiated (struct nbd_handle *h);
12

DESCRIPTION

14       After connecting you may call this to find out if the connection is
15       using TLS.
16
17       This is only really useful if you set the TLS request mode to
18       "LIBNBD_TLS_ALLOW" (see nbd_set_tls(3)), because in this mode we try to
19       use TLS but fall back to unencrypted if it was not available.  This
20       function will tell you if TLS was negotiated or not.
21
22       In "LIBNBD_TLS_REQUIRE" mode (the most secure) the connection would
23       have failed if TLS could not be negotiated, and in "LIBNBD_TLS_DISABLE"
24       mode TLS is not tried.
25

RETURN VALUE

27       This call returns a boolean value.
28

ERRORS

30       On error "-1" is returned.
31
32       Refer to "ERROR HANDLING" in libnbd(3) for how to get further details
33       of the error.
34

HANDLE STATE

36       The handle must be negotiating, or connected with the server, or shut
37       down, otherwise this call will return an error.
38

VERSION

40       This function first appeared in libnbd 1.2.
41
42       If you need to test if this function is available at compile time check
43       if the following macro is defined:
44
45        #define LIBNBD_HAVE_NBD_GET_TLS_NEGOTIATED 1
46

SEE ALSO

48       nbd_create(3), nbd_get_tls(3), nbd_set_tls(3), libnbd(3).
49

AUTHORS

51       Eric Blake
52
53       Richard W.M. Jones
54

56       Copyright (C) 2019-2021 Red Hat Inc.
57

LICENSE

59       This library is free software; you can redistribute it and/or modify it
60       under the terms of the GNU Lesser General Public License as published
61       by the Free Software Foundation; either version 2 of the License, or
62       (at your option) any later version.
63
64       This library is distributed in the hope that it will be useful, but
65       WITHOUT ANY WARRANTY; without even the implied warranty of
66       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
67       Lesser General Public License for more details.
68
69       You should have received a copy of the GNU Lesser General Public
70       License along with this library; if not, write to the Free Software
71       Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
72       02110-1301 USA
73
74
75
76libnbd-1.10.1                     2021-10-25         nbd_get_tls_negotiated(3)
Impressum