Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

CURLINFO_TLS_SESSION (3)

Name

CURLINFO_TLS_SESSION - get TLS session info

Synopsis

#include <curl/curl.h>

CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_TLS_SESSION,
struct curl_tlssessioninfo **session);

Description

CURLINFO_TLS_SESSION(3)    curl_easy_getinfo options   CURLINFO_TLS_SESSION(3)



NAME
       CURLINFO_TLS_SESSION - get TLS session info

SYNOPSIS
       #include <curl/curl.h>

       CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_TLS_SESSION,
                                  struct curl_tlssessioninfo **session);

DESCRIPTION
       This  option  has  been superseded by CURLINFO_TLS_SSL_PTR(3) which was
       added in 7.48.0. The only reason you would use this option  instead  is
       if you could be using a version of libcurl earlier than 7.48.0.

       This  option  is  exactly the same as CURLINFO_TLS_SSL_PTR(3) except in
       the case of OpenSSL. If the session backend  is  CURLSSLBACKEND_OPENSSL
       the session internals pointer varies depending on the option:

       CURLINFO_TLS_SESSION OpenSSL session internals is SSL_CTX *.

       CURLINFO_TLS_SSL_PTR OpenSSL session internals is SSL *.

       You  can  obtain  an  SSL_CTX pointer from an SSL pointer using OpenSSL
       function SSL_get_SSL_CTX. Therefore unless you need compatibility  with
       older  versions  of  libcurl use CURLINFO_TLS_SSL_PTR(3). Refer to that
       document for more information.

PROTOCOLS
       All TLS-based

EXAMPLE
       CURL *curl = curl_easy_init();
       if(curl) {
         CURLcode res;
         struct curl_tlssessioninfo *tls;
         curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
         res = curl_easy_perform(curl);
         curl_easy_getinfo(curl, CURLINFO_TLS_SESSION, &tls);
         curl_easy_cleanup(curl);
       }

AVAILABILITY
       Added in 7.34.0, and supported OpenSSL, GnuTLS, NSS and gskit  only  up
       until 7.48.0 was released.

RETURN VALUE
       Returns  CURLE_OK  if the option is supported, and CURLE_UNKNOWN_OPTION
       if not.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | web/curl         |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+

SEE ALSO
       curl_easy_getinfo(3), curl_easy_setopt(3), CURLINFO_TLS_SSL_PTR(3),



NOTES
       Source code for open source software components in Oracle  Solaris  can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source      was      downloaded       from        https://curl.se/down-
       load/curl-7.83.1.tar.bz2.

       Further information about this software can be found on the open source
       community website at http://curl.haxx.se/.



libcurl 7.83.1                 November 04, 2020       CURLINFO_TLS_SESSION(3)