xref: /freebsd/secure/lib/libcrypto/man/man7/ssl.7 (revision 2e3f49888ec8851bafb22011533217487764fdb0)
Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)

Standard preamble:
========================================================================
..
..
.. Set up some character translations and predefined strings. \*(-- will
give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
double quote, and \*(R" will give a right double quote. \*(C+ will
give a nicer C++. Capital omega is used to do unbreakable dashes and
therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
nothing in troff, for use with C<>.
.tr \(*W- . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.

Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] .\} . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents . \" corrections for vroff . \" for low resolution devices (crt and lpr) \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} ========================================================================

Title "SSL 7ossl"
SSL 7ossl "2023-09-19" "3.0.11" "OpenSSL"
For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
"NAME"
ssl - OpenSSL SSL/TLS library
"SYNOPSIS"
Header "SYNOPSIS" See the individual manual pages for details.
"DESCRIPTION"
Header "DESCRIPTION" The OpenSSL ssl library implements several versions of the Secure Sockets Layer, Transport Layer Security, and Datagram Transport Layer Security protocols. This page gives a brief overview of the extensive \s-1API\s0 and data types provided by the library.

An \s-1SSL_CTX\s0 object is created as a framework to establish \s-1TLS/SSL\s0 enabled connections (see SSL_CTX_new\|(3)). Various options regarding certificates, algorithms etc. can be set in this object.

When a network connection has been created, it can be assigned to an \fB\s-1SSL\s0 object. After the \s-1SSL\s0 object has been created using \fBSSL_new\|(3), SSL_set_fd\|(3) or \fBSSL_set_bio\|(3) can be used to associate the network connection with the object.

When the \s-1TLS/SSL\s0 handshake is performed using \fBSSL_accept\|(3) or SSL_connect\|(3) respectively. \fBSSL_read_ex\|(3), SSL_read\|(3), SSL_write_ex\|(3) and SSL_write\|(3) are used to read and write data on the \s-1TLS/SSL\s0 connection. \fBSSL_shutdown\|(3) can be used to shut down the \s-1TLS/SSL\s0 connection.

"DATA STRUCTURES"
Header "DATA STRUCTURES" Here are some of the main data structures in the library.
"\s-1SSL_METHOD\s0 (\s-1SSL\s0 Method)" 4
Item "SSL_METHOD (SSL Method)" This is a dispatch structure describing the internal ssl library methods/functions which implement the various protocol versions (SSLv3 TLSv1, ...). It's needed to create an \s-1SSL_CTX\s0.
"\s-1SSL_CIPHER\s0 (\s-1SSL\s0 Cipher)" 4
Item "SSL_CIPHER (SSL Cipher)" This structure holds the algorithm information for a particular cipher which are a core part of the \s-1SSL/TLS\s0 protocol. The available ciphers are configured on a \s-1SSL_CTX\s0 basis and the actual ones used are then part of the \fB\s-1SSL_SESSION\s0.
"\s-1SSL_CTX\s0 (\s-1SSL\s0 Context)" 4
Item "SSL_CTX (SSL Context)" This is the global context structure which is created by a server or client once per program life-time and which holds mainly default values for the \fB\s-1SSL\s0 structures which are later created for the connections.
"\s-1SSL_SESSION\s0 (\s-1SSL\s0 Session)" 4
Item "SSL_SESSION (SSL Session)" This is a structure containing the current \s-1TLS/SSL\s0 session details for a connection: \s-1SSL_CIPHER\s0s, client and server certificates, keys, etc.
"\s-1SSL\s0 (\s-1SSL\s0 Connection)" 4
Item "SSL (SSL Connection)" This is the main \s-1SSL/TLS\s0 structure which is created by a server or client per established connection. This actually is the core structure in the \s-1SSL API.\s0 At run-time the application usually deals with this structure which has links to mostly all other structures.
"HEADER FILES"
Header "HEADER FILES" Currently the OpenSSL ssl library provides the following C header files containing the prototypes for the data structures and functions:
"<openssl/ssl.h>" 4
Item "<openssl/ssl.h>" This is the common header file for the \s-1SSL/TLS API.\s0 Include it into your program to make the \s-1API\s0 of the ssl library available. It internally includes both more private \s-1SSL\s0 headers and headers from the crypto library. Whenever you need hard-core details on the internals of the \s-1SSL API,\s0 look inside this header file. This file also includes the others listed below. Item "<openssl/ssl2.h>" Unused. Present for backwards compatibility only. Item "<openssl/ssl3.h>" This is the sub header file dealing with the SSLv3 protocol only. Item "<openssl/tls1.h>" This is the sub header file dealing with the TLSv1 protocol only.
"COPYRIGHT"
Header "COPYRIGHT" Copyright 2000-2018 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use this file except in compliance with the License. You can obtain a copy in the file \s-1LICENSE\s0 in the source distribution or at <https://www.openssl.org/source/license.html>.