Cleanup documentation for removed functionality

[openssl.git] / doc / ssl / ssl.pod

diff --git a/doc/ssl/ssl.pod b/doc/ssl/ssl.pod
index 7e2cd85ffeadcbd4971eb68ebcf4d182aaca8fe8..dfd83ead2da96407feaf522bb2e889a344038cd2 100644 (file)
--- a/doc/ssl/ssl.pod
+++ b/doc/ssl/ssl.pod
@@ -1,12 +1,15 @@
-
 =pod
 
+=for comment openssl_manual_section:7
+
 =head1 NAME
 
 SSL - OpenSSL SSL/TLS library
 
 =head1 SYNOPSIS
 
+See the individual manual pages for details.
+
 =head1 DESCRIPTION
 
 The OpenSSL B<ssl> library implements the Secure Sockets Layer (SSL v2/v3) and
@@ -111,7 +114,7 @@ it's already included by ssl.h>.
 Currently the OpenSSL B<ssl> 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<SSL_METHOD> structures.
@@ -182,7 +185,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<SSL_CIPHER> structures.
@@ -214,7 +217,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<SSL_CTX> structure.
@@ -265,13 +268,11 @@ protocol context defined in the B<SSL_CTX> structure.
 
 =item int B<SSL_CTX_get_verify_mode>(SSL_CTX *ctx);
 
-=item int B<SSL_CTX_load_verify_locations>(SSL_CTX *ctx, char *CAfile, char *CApath);
-
-=item long B<SSL_CTX_need_tmp_RSA>(SSL_CTX *ctx);
+=item int B<SSL_CTX_load_verify_locations>(SSL_CTX *ctx, const char *CAfile, const char *CApath);
 
 =item SSL_CTX *B<SSL_CTX_new>(const SSL_METHOD *meth);
 
-=item void SSL_CTX_up_ref(SSL_CTX *ctx);
+=item int SSL_CTX_up_ref(SSL_CTX *ctx);
 
 =item int B<SSL_CTX_remove_session>(SSL_CTX *ctx, SSL_SESSION *c);
 
@@ -380,19 +381,19 @@ Use the file path to locate trusted CA certificates.
 
 =item int B<SSL_CTX_use_PrivateKey_ASN1>(int type, SSL_CTX *ctx, unsigned char *d, long len);
 
-=item int B<SSL_CTX_use_PrivateKey_file>(SSL_CTX *ctx, char *file, int type);
+=item int B<SSL_CTX_use_PrivateKey_file>(SSL_CTX *ctx, const char *file, int type);
 
 =item int B<SSL_CTX_use_RSAPrivateKey>(SSL_CTX *ctx, RSA *rsa);
 
 =item int B<SSL_CTX_use_RSAPrivateKey_ASN1>(SSL_CTX *ctx, unsigned char *d, long len);
 
-=item int B<SSL_CTX_use_RSAPrivateKey_file>(SSL_CTX *ctx, char *file, int type);
+=item int B<SSL_CTX_use_RSAPrivateKey_file>(SSL_CTX *ctx, const char *file, int type);
 
 =item int B<SSL_CTX_use_certificate>(SSL_CTX *ctx, X509 *x);
 
 =item int B<SSL_CTX_use_certificate_ASN1>(SSL_CTX *ctx, int len, unsigned char *d);
 
-=item int B<SSL_CTX_use_certificate_file>(SSL_CTX *ctx, char *file, int type);
+=item int B<SSL_CTX_use_certificate_file>(SSL_CTX *ctx, const char *file, int type);
 
 =item X509 *B<SSL_CTX_get0_certificate>(const SSL_CTX *ctx);
 
@@ -405,11 +406,9 @@ Use the file path to locate trusted CA certificates.
 =item void B<SSL_CTX_set_psk_server_callback>(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<SSL_SESSION> structures.
@@ -448,7 +447,7 @@ sessions defined in the B<SSL_SESSION> 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<SSL> structure.
@@ -521,6 +520,8 @@ fresh handle for each connection.
 
 =item const char *B<SSL_get_cipher>(const SSL *ssl);
 
+=item int B<SSL_is_dtls>(const SSL *ssl);
+
 =item int B<SSL_get_cipher_bits>(const SSL *ssl, int *alg_bits);
 
 =item char *B<SSL_get_cipher_list>(const SSL *ssl, int n);
@@ -595,11 +596,11 @@ fresh handle for each connection.
 
 =item int B<SSL_is_init_finished>(SSL *ssl);
 
-=item STACK *B<SSL_load_client_CA_file>(char *file);
+=item STACK *B<SSL_load_client_CA_file>(const char *file);
 
 =item SSL *B<SSL_new>(SSL_CTX *ctx);
 
-=item void SSL_up_ref(SSL *s);
+=item int SSL_up_ref(SSL *s);
 
 =item long B<SSL_num_renegotiations>(SSL *ssl);
 
@@ -683,19 +684,19 @@ Returns the current handshake state.
 
 =item int B<SSL_use_PrivateKey_ASN1>(int type, SSL *ssl, unsigned char *d, long len);
 
-=item int B<SSL_use_PrivateKey_file>(SSL *ssl, char *file, int type);
+=item int B<SSL_use_PrivateKey_file>(SSL *ssl, const char *file, int type);
 
 =item int B<SSL_use_RSAPrivateKey>(SSL *ssl, RSA *rsa);
 
 =item int B<SSL_use_RSAPrivateKey_ASN1>(SSL *ssl, unsigned char *d, long len);
 
-=item int B<SSL_use_RSAPrivateKey_file>(SSL *ssl, char *file, int type);
+=item int B<SSL_use_RSAPrivateKey_file>(SSL *ssl, const char *file, int type);
 
 =item int B<SSL_use_certificate>(SSL *ssl, X509 *x);
 
 =item int B<SSL_use_certificate_ASN1>(SSL *ssl, int len, unsigned char *d);
 
-=item int B<SSL_use_certificate_file>(SSL *ssl, char *file, int type);
+=item int B<SSL_use_certificate_file>(SSL *ssl, const char *file, int type);
 
 =item int B<SSL_version>(const SSL *ssl);
 
@@ -723,6 +724,10 @@ Returns the current handshake state.
 
 =back
 
+=head1 RETURN VALUES
+
+See the individual manual pages for details.
+
 =head1 SEE ALSO
 
 L<openssl(1)>, L<crypto(3)>,
@@ -808,5 +813,13 @@ in OpenSSL 1.1.0.
 The return type of B<SSL_copy_session_id> was changed from void to int in
 OpenSSL 1.1.0.
 
-=cut
+=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<https://www.openssl.org/source/license.html>.
+
+=cut