docs/libcurl/opts/CURLINFO_TLS_SESSION.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2016, Daniel Stenberg, <daniel@haxx.se>, 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 .\"
  23 .TH CURLINFO_TLS_SESSION 3 "12 Sep 2015" "libcurl 7.44.0" "curl_easy_getinfo options"
  24 .SH NAME
  25 CURLINFO_TLS_SESSION \- get TLS session info
  26 .SH SYNOPSIS
  27 .nf
  28 #include <curl/curl.h>
  29
  30 CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_TLS_SESSION,
  31                            struct curl_tlssessioninfo **session);
  32 .SH DESCRIPTION
  33 \fBThis option has been superseded\fP by \fICURLINFO_TLS_SSL_PTR(3)\fP which
  34 was added in 7.48.0. The only reason you would use this option instead is if
  35 you could be using a version of libcurl earlier than 7.48.0.
  36
  37 This option is exactly the same as \fICURLINFO_TLS_SSL_PTR(3)\fP except in the
  38 case of OpenSSL. If the session \fIbackend\fP is CURLSSLBACKEND_OPENSSL the
  39 session \fIinternals\fP pointer varies depending on the option:
  40
  41 CURLINFO_TLS_SESSION OpenSSL session \fIinternals\fP is SSL_CTX *.
  42
  43 CURLINFO_TLS_SSL_PTR OpenSSL session \fIinternals\fP is SSL *.
  44
  45 You can obtain an SSL_CTX pointer from an SSL pointer using OpenSSL function
  46 SSL_get_SSL_CTX. Therefore unless you need compatibility with older versions of
  47 libcurl use \fICURLINFO_TLS_SSL_PTR(3)\fP. Refer to that document for more
  48 information.
  49 .SH PROTOCOLS
  50 All TLS-based
  51 .SH EXAMPLE
  52 TODO
  53 .SH AVAILABILITY
  54 Added in 7.34.0, and supported OpenSSL, GnuTLS, NSS and gskit only up until
  55 7.48.0 was released.
  56 .SH RETURN VALUE
  57 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  58 .SH "SEE ALSO"
  59 .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "
  60 .BR CURLINFO_TLS_SSL_PTR "(3), "