X-Git-Url: https://git.openssl.org/?p=openssl.git;a=blobdiff_plain;f=doc%2Fssl%2Fssl.pod;h=9a95019930d49d9ee0335edd8604a6e61217eea3;hp=6e9650a6fd0c14c03c7be6707fff9186e63ed9fa;hb=ff3bb913cfe47104293138a17014d3bde9db5e32;hpb=99ec4fdb40a4c06ee8e986f6293e59516d05999a diff --git a/doc/ssl/ssl.pod b/doc/ssl/ssl.pod index 6e9650a6fd..9a95019930 100644 --- a/doc/ssl/ssl.pod +++ b/doc/ssl/ssl.pod @@ -1,4 +1,3 @@ - =pod =head1 NAME @@ -7,6 +6,8 @@ SSL - OpenSSL SSL/TLS library =head1 SYNOPSIS +See the individual manual pages for details. + =head1 DESCRIPTION The OpenSSL B library implements the Secure Sockets Layer (SSL v2/v3) and @@ -111,7 +112,7 @@ it's already included by ssl.h>. Currently the OpenSSL B library exports 214 API functions. They are documented in the following: -=head2 DEALING WITH PROTOCOL METHODS +=head2 Dealing with Protocol Methods Here we document the various API functions which deal with the SSL/TLS protocol methods defined in B structures. @@ -182,7 +183,7 @@ Constructor for the SSLv3 SSL_METHOD structure for servers. =back -=head2 DEALING WITH CIPHERS +=head2 Dealing with Ciphers Here we document the various API functions which deal with the SSL/TLS ciphers defined in B structures. @@ -214,7 +215,7 @@ in the specification the first time). =back -=head2 DEALING WITH PROTOCOL CONTEXTS +=head2 Dealing with Protocol Contexts Here we document the various API functions which deal with the SSL/TLS protocol context defined in the B structure. @@ -405,11 +406,9 @@ Use the file path to locate trusted CA certificates. =item void B(SSL_CTX *ctx, unsigned int (*callback)(SSL *ssl, const char *identity, unsigned char *psk, int max_psk_len)); - - =back -=head2 DEALING WITH SESSIONS +=head2 Dealing with Sessions Here we document the various API functions which deal with the SSL/TLS sessions defined in the B structures. @@ -448,7 +447,7 @@ sessions defined in the B structures. =back -=head2 DEALING WITH CONNECTIONS +=head2 Dealing with Connections Here we document the various API functions which deal with the SSL/TLS connection defined in the B structure. @@ -723,6 +722,10 @@ Returns the current handshake state. =back +=head1 RETURN VALUES + +See the individual manual pages for details. + =head1 SEE ALSO L, L, @@ -808,4 +811,13 @@ in OpenSSL 1.1.0. The return type of B was changed from void to int in OpenSSL 1.1.0. +=head1 COPYRIGHT + +Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved. + +Licensed under the OpenSSL license (the "License"). You may not use +this file except in compliance with the License. You can obtain a copy +in the file LICENSE in the source distribution or at +L. + =cut