| 1 |
.\" ************************************************************************** |
| 2 |
.\" * _ _ ____ _ |
| 3 |
.\" * Project ___| | | | _ \| | |
| 4 |
.\" * / __| | | | |_) | | |
| 5 |
.\" * | (__| |_| | _ <| |___ |
| 6 |
.\" * \___|\___/|_| \_\_____| |
| 7 |
.\" * |
| 8 |
.\" * Copyright (C) 1998 - 2018, Daniel Stenberg, <[email protected]>, et al. |
| 9 |
.\" * |
| 10 |
.\" * This software is licensed as described in the file COPYING, which |
| 11 |
.\" * you should have received as part of this distribution. The terms |
| 12 |
.\" * are also available at https://curl.haxx.se/docs/copyright.html. |
| 13 |
.\" * |
| 14 |
.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell |
| 15 |
.\" * copies of the Software, and permit persons to whom the Software is |
| 16 |
.\" * furnished to do so, under the terms of the COPYING file. |
| 17 |
.\" * |
| 18 |
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY |
| 19 |
.\" * KIND, either express or implied. |
| 20 |
.\" * |
| 21 |
.\" ************************************************************************** |
| 22 |
.TH curl_global_sslset 3 "15 July 2017" "libcurl 7.56" "libcurl Manual" |
| 23 |
.SH NAME |
| 24 |
curl_global_sslset - Select SSL backend to use with libcurl |
| 25 |
.SH SYNOPSIS |
| 26 |
.B #include <curl/curl.h> |
| 27 |
.nf |
| 28 |
|
| 29 |
typedef struct { |
| 30 |
curl_sslbackend id; |
| 31 |
const char *name; |
| 32 |
} curl_ssl_backend; |
| 33 |
|
| 34 |
typedef enum { |
| 35 |
CURLSSLBACKEND_NONE = 0, |
| 36 |
CURLSSLBACKEND_OPENSSL = 1, |
| 37 |
CURLSSLBACKEND_GNUTLS = 2, |
| 38 |
CURLSSLBACKEND_NSS = 3, |
| 39 |
CURLSSLBACKEND_GSKIT = 5, |
| 40 |
CURLSSLBACKEND_POLARSSL = 6, |
| 41 |
CURLSSLBACKEND_WOLFSSL = 7, |
| 42 |
CURLSSLBACKEND_SCHANNEL = 8, |
| 43 |
CURLSSLBACKEND_DARWINSSL = 9, |
| 44 |
CURLSSLBACKEND_AXTLS = 10, /* deprecated */ |
| 45 |
CURLSSLBACKEND_MBEDTLS = 11, |
| 46 |
CURLSSLBACKEND_MESALINK = 12, |
| 47 |
CURLSSLBACKEND_BEARSSL = 13 |
| 48 |
} curl_sslbackend; |
| 49 |
|
| 50 |
.B "CURLsslset curl_global_sslset(curl_sslbackend " id, |
| 51 |
.B " const char *" name, |
| 52 |
.B " curl_ssl_backend ***" avail ");" |
| 53 |
.fi |
| 54 |
.SH DESCRIPTION |
| 55 |
This function configures at runtime which SSL backend to use with |
| 56 |
libcurl. This function can only be used to select an SSL backend once, and it |
| 57 |
must be called \fBbefore\fP \fIcurl_global_init(3)\fP. |
| 58 |
|
| 59 |
The backend can be identified by the \fIid\fP |
| 60 |
(e.g. \fBCURLSSLBACKEND_OPENSSL\fP). The backend can also be specified via the |
| 61 |
\fIname\fP parameter for a case insensitive match (passing -1 as \fIid\fP). If |
| 62 |
both \fIid\fP and \fIname\fP are specified, the \fIname\fP will be ignored. |
| 63 |
|
| 64 |
If neither \fIid\fP nor \fPname\fP are specified, the function will fail with |
| 65 |
CURLSSLSET_UNKNOWN_BACKEND and set the \fIavail\fP pointer to the |
| 66 |
NULL-terminated list of available backends. The available backends are those |
| 67 |
that this particular build of libcurl supports. |
| 68 |
|
| 69 |
Since libcurl 7.60.0, the \fIavail\fP pointer will always be set to the list |
| 70 |
of alternatives if non-NULL. |
| 71 |
|
| 72 |
Upon success, the function returns CURLSSLSET_OK. |
| 73 |
|
| 74 |
If the specified SSL backend is not available, the function returns |
| 75 |
CURLSSLSET_UNKNOWN_BACKEND and sets the \fIavail\fP pointer to a |
| 76 |
NULL-terminated list of available SSL backends. In this case, you may call the |
| 77 |
function again to try to select a different backend. |
| 78 |
|
| 79 |
The SSL backend can be set only once. If it has already been set, a subsequent |
| 80 |
attempt to change it will result in a \fBCURLSSLSET_TOO_LATE\fP. |
| 81 |
|
| 82 |
\fBThis function is not thread safe.\fP You must not call it when any other |
| 83 |
thread in the program (i.e. a thread sharing the same memory) is running. |
| 84 |
This doesn't just mean no other thread that is using libcurl. |
| 85 |
|
| 86 |
.SH AVAILABILITY |
| 87 |
This function was added in libcurl 7.56.0. Before this version, there was no |
| 88 |
support for choosing SSL backends at runtime. |
| 89 |
.SH RETURN VALUE |
| 90 |
If this function returns CURLSSLSET_OK, the backend was successfully selected. |
| 91 |
|
| 92 |
If the chosen backend is unknown (or support for the chosen backend has not |
| 93 |
been compiled into libcurl), the function returns \fICURLSSLSET_UNKNOWN_BACKEND\fP. |
| 94 |
|
| 95 |
If the backend had been configured previously, or if \fIcurl_global_init(3)\fP |
| 96 |
has already been called, the function returns \fICURLSSLSET_TOO_LATE\fP. |
| 97 |
|
| 98 |
If this libcurl was built completely without SSL support, with no backends at |
| 99 |
all, this function returns \fICURLSSLSET_NO_BACKENDS\fP. |
| 100 |
.SH "SEE ALSO" |
| 101 |
.BR curl_global_init "(3), " |
| 102 |
.BR libcurl "(3) " |