Annotation of embedaddon/curl/docs/libcurl/opts/CURLINFO_TLS_SESSION.3, revision 1.1
1.1 ! misho 1: .\" **************************************************************************
! 2: .\" * _ _ ____ _
! 3: .\" * Project ___| | | | _ \| |
! 4: .\" * / __| | | | |_) | |
! 5: .\" * | (__| |_| | _ <| |___
! 6: .\" * \___|\___/|_| \_\_____|
! 7: .\" *
! 8: .\" * Copyright (C) 1998 - 2017, 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 "May 31, 2017" "libcurl 7.70.0" "curl_easy_getinfo options"
! 24:
! 25: .SH NAME
! 26: CURLINFO_TLS_SESSION \- get TLS session info
! 27: .SH SYNOPSIS
! 28: .nf
! 29: #include <curl/curl.h>
! 30:
! 31: CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_TLS_SESSION,
! 32: struct curl_tlssessioninfo **session);
! 33: .SH DESCRIPTION
! 34: \fBThis option has been superseded\fP by \fICURLINFO_TLS_SSL_PTR(3)\fP which
! 35: was added in 7.48.0. The only reason you would use this option instead is if
! 36: you could be using a version of libcurl earlier than 7.48.0.
! 37:
! 38: This option is exactly the same as \fICURLINFO_TLS_SSL_PTR(3)\fP except in the
! 39: case of OpenSSL. If the session \fIbackend\fP is CURLSSLBACKEND_OPENSSL the
! 40: session \fIinternals\fP pointer varies depending on the option:
! 41:
! 42: CURLINFO_TLS_SESSION OpenSSL session \fIinternals\fP is SSL_CTX *.
! 43:
! 44: CURLINFO_TLS_SSL_PTR OpenSSL session \fIinternals\fP is SSL *.
! 45:
! 46: You can obtain an SSL_CTX pointer from an SSL pointer using OpenSSL function
! 47: SSL_get_SSL_CTX. Therefore unless you need compatibility with older versions of
! 48: libcurl use \fICURLINFO_TLS_SSL_PTR(3)\fP. Refer to that document for more
! 49: information.
! 50: .SH PROTOCOLS
! 51: All TLS-based
! 52: .SH EXAMPLE
! 53: .nf
! 54: CURL *curl = curl_easy_init();
! 55: if(curl) {
! 56: CURLcode res;
! 57: struct curl_tlssessioninfo *tls;
! 58: curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
! 59: res = curl_easy_perform(curl);
! 60: curl_easy_getinfo(curl, CURLINFO_TLS_SESSION, &tls);
! 61: curl_easy_cleanup(curl);
! 62: }
! 63: .fi
! 64: .SH AVAILABILITY
! 65: Added in 7.34.0, and supported OpenSSL, GnuTLS, NSS and gskit only up until
! 66: 7.48.0 was released.
! 67: .SH RETURN VALUE
! 68: Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
! 69: .SH "SEE ALSO"
! 70: .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "
! 71: .BR CURLINFO_TLS_SSL_PTR "(3), "
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>