221 lines
8.0 KiB
Groff
Executable File
221 lines
8.0 KiB
Groff
Executable File
.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
|
|
.\"
|
|
.\" Standard preamble:
|
|
.\" ========================================================================
|
|
.de Sp \" Vertical space (when we can't use .PP)
|
|
.if t .sp .5v
|
|
.if n .sp
|
|
..
|
|
.de Vb \" Begin verbatim text
|
|
.ft CW
|
|
.nf
|
|
.ne \\$1
|
|
..
|
|
.de Ve \" End verbatim text
|
|
.ft R
|
|
.fi
|
|
..
|
|
.\" 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 C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
|
|
.ie n \{\
|
|
. 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\}
|
|
.el\{\
|
|
. ds -- \|\(em\|
|
|
. ds PI \(*p
|
|
. ds L" ``
|
|
. ds R" ''
|
|
'br\}
|
|
.\"
|
|
.\" Escape single quotes in literal strings from groff's Unicode transform.
|
|
.ie \n(.g .ds Aq \(aq
|
|
.el .ds Aq '
|
|
.\"
|
|
.\" If the F register is turned on, 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.
|
|
.ie \nF \{\
|
|
. de IX
|
|
. tm Index:\\$1\t\\n%\t"\\$2"
|
|
..
|
|
. nr % 0
|
|
. rr F
|
|
.\}
|
|
.el \{\
|
|
. de IX
|
|
..
|
|
.\}
|
|
.\"
|
|
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
|
|
.\" Fear. Run. Save yourself. No user-serviceable parts.
|
|
. \" fudge factors for nroff and troff
|
|
.if n \{\
|
|
. ds #H 0
|
|
. ds #V .8m
|
|
. ds #F .3m
|
|
. ds #[ \f1
|
|
. ds #] \fP
|
|
.\}
|
|
.if t \{\
|
|
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
|
|
. ds #V .6m
|
|
. ds #F 0
|
|
. ds #[ \&
|
|
. ds #] \&
|
|
.\}
|
|
. \" simple accents for nroff and troff
|
|
.if n \{\
|
|
. ds ' \&
|
|
. ds ` \&
|
|
. ds ^ \&
|
|
. ds , \&
|
|
. ds ~ ~
|
|
. ds /
|
|
.\}
|
|
.if t \{\
|
|
. 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
|
|
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
|
|
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
|
|
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
|
|
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
|
|
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
|
|
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
|
|
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
|
|
.ds ae a\h'-(\w'a'u*4/10)'e
|
|
.ds Ae A\h'-(\w'A'u*4/10)'E
|
|
. \" corrections for vroff
|
|
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
|
|
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
|
|
. \" for low resolution devices (crt and lpr)
|
|
.if \n(.H>23 .if \n(.V>19 \
|
|
\{\
|
|
. 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
|
|
.\}
|
|
.rm #[ #] #H #V #F C
|
|
.\" ========================================================================
|
|
.\"
|
|
.IX Title "SSL 7"
|
|
.TH SSL 7 "2020-03-02" "3.0.0-dev" "OpenSSL"
|
|
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
|
|
.\" way too many mistakes in technical documents.
|
|
.if n .ad l
|
|
.nh
|
|
.SH "NAME"
|
|
ssl \- OpenSSL SSL/TLS library
|
|
.SH "SYNOPSIS"
|
|
.IX Header "SYNOPSIS"
|
|
See the individual manual pages for details.
|
|
.SH "DESCRIPTION"
|
|
.IX Header "DESCRIPTION"
|
|
The OpenSSL \fBssl\fR 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.
|
|
.PP
|
|
An \fB\s-1SSL_CTX\s0\fR object is created as a framework to establish
|
|
\&\s-1TLS/SSL\s0 enabled connections (see \fISSL_CTX_new\fR\|(3)).
|
|
Various options regarding certificates, algorithms etc. can be set
|
|
in this object.
|
|
.PP
|
|
When a network connection has been created, it can be assigned to an
|
|
\&\fB\s-1SSL\s0\fR object. After the \fB\s-1SSL\s0\fR object has been created using
|
|
\&\fISSL_new\fR\|(3), \fISSL_set_fd\fR\|(3) or
|
|
\&\fISSL_set_bio\fR\|(3) can be used to associate the network
|
|
connection with the object.
|
|
.PP
|
|
When the \s-1TLS/SSL\s0 handshake is performed using
|
|
\&\fISSL_accept\fR\|(3) or \fISSL_connect\fR\|(3)
|
|
respectively.
|
|
\&\fISSL_read_ex\fR\|(3), \fISSL_read\fR\|(3), \fISSL_write_ex\fR\|(3) and \fISSL_write\fR\|(3) are
|
|
used to read and write data on the \s-1TLS/SSL\s0 connection.
|
|
\&\fISSL_shutdown\fR\|(3) can be used to shut down the
|
|
\&\s-1TLS/SSL\s0 connection.
|
|
.SH "DATA STRUCTURES"
|
|
.IX Header "DATA STRUCTURES"
|
|
Here are some of the main data structures in the library.
|
|
.IP "\fB\s-1SSL_METHOD\s0\fR (\s-1SSL\s0 Method)" 4
|
|
.IX Item "SSL_METHOD (SSL Method)"
|
|
This is a dispatch structure describing the internal \fBssl\fR library
|
|
methods/functions which implement the various protocol versions (SSLv3
|
|
TLSv1, ...). It's needed to create an \fB\s-1SSL_CTX\s0\fR.
|
|
.IP "\fB\s-1SSL_CIPHER\s0\fR (\s-1SSL\s0 Cipher)" 4
|
|
.IX 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 \fB\s-1SSL_CTX\s0\fR basis and the actual ones used are then part of the
|
|
\&\fB\s-1SSL_SESSION\s0\fR.
|
|
.IP "\fB\s-1SSL_CTX\s0\fR (\s-1SSL\s0 Context)" 4
|
|
.IX 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\fR structures which are later created for the connections.
|
|
.IP "\fB\s-1SSL_SESSION\s0\fR (\s-1SSL\s0 Session)" 4
|
|
.IX Item "SSL_SESSION (SSL Session)"
|
|
This is a structure containing the current \s-1TLS/SSL\s0 session details for a
|
|
connection: \fB\s-1SSL_CIPHER\s0\fRs, client and server certificates, keys, etc.
|
|
.IP "\fB\s-1SSL\s0\fR (\s-1SSL\s0 Connection)" 4
|
|
.IX 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\s0 \s-1API\s0.
|
|
At run-time the application usually deals with this structure which has
|
|
links to mostly all other structures.
|
|
.SH "HEADER FILES"
|
|
.IX Header "HEADER FILES"
|
|
Currently the OpenSSL \fBssl\fR library provides the following C header files
|
|
containing the prototypes for the data structures and functions:
|
|
.IP "\fI<openssl/ssl.h>\fR" 4
|
|
.IX Item "<openssl/ssl.h>"
|
|
This is the common header file for the \s-1SSL/TLS\s0 \s-1API\s0. Include it into your
|
|
program to make the \s-1API\s0 of the \fBssl\fR library available. It internally
|
|
includes both more private \s-1SSL\s0 headers and headers from the \fBcrypto\fR library.
|
|
Whenever you need hard-core details on the internals of the \s-1SSL\s0 \s-1API\s0, look
|
|
inside this header file.
|
|
This file also includes the others listed below.
|
|
.IP "\fI<openssl/ssl2.h>\fR" 4
|
|
.IX Item "<openssl/ssl2.h>"
|
|
Unused. Present for backwards compatibility only.
|
|
.IP "\fI<openssl/ssl3.h>\fR" 4
|
|
.IX Item "<openssl/ssl3.h>"
|
|
This is the sub header file dealing with the SSLv3 protocol only.
|
|
.IP "\fI<openssl/tls1.h>\fR" 4
|
|
.IX Item "<openssl/tls1.h>"
|
|
This is the sub header file dealing with the TLSv1 protocol only.
|
|
.SH "COPYRIGHT"
|
|
.IX Header "COPYRIGHT"
|
|
Copyright 2000\-2018 The OpenSSL Project Authors. All Rights Reserved.
|
|
.PP
|
|
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>.
|