X-Git-Url: https://git.openssl.org/?a=blobdiff_plain;f=doc%2Fssl%2Fssl.pod;h=7e2cd85ffeadcbd4971eb68ebcf4d182aaca8fe8;hb=9d5ac9532c58c8b2d10d5e8ee8029dcb40aecfbe;hp=33133ff78f2cbcce75eeeb0f0bcc45812e4cff16;hpb=8106cb8b6d706079cbcabd4631f05e4526a316e1;p=openssl.git diff --git a/doc/ssl/ssl.pod b/doc/ssl/ssl.pod index 33133ff78f..7e2cd85ffe 100644 --- a/doc/ssl/ssl.pod +++ b/doc/ssl/ssl.pod @@ -13,9 +13,6 @@ The OpenSSL B library implements the Secure Sockets Layer (SSL v2/v3) and Transport Layer Security (TLS v1) protocols. It provides a rich API which is documented here. -At first the library must be initialized; see -L. - Then an B object is created as a framework to establish TLS/SSL enabled connections (see L). Various options regarding certificates, algorithms etc. can be set @@ -79,7 +76,7 @@ links to mostly all other structures. =head1 HEADER FILES Currently the OpenSSL B library provides the following C header files -containing the prototypes for the data structures and and functions: +containing the prototypes for the data structures and functions: =over 4 @@ -121,29 +118,67 @@ protocol methods defined in B structures. =over 4 -=item const SSL_METHOD *B(void); +=item const SSL_METHOD *B(void); -Constructor for the SSLv3 SSL_METHOD structure for a dedicated client. +Constructor for the I SSL_METHOD structure for clients, +servers or both. +See L for details. -=item const SSL_METHOD *B(void); +=item const SSL_METHOD *B(void); -Constructor for the SSLv3 SSL_METHOD structure for a dedicated server. +Constructor for the I SSL_METHOD structure for clients. -=item const SSL_METHOD *B(void); +=item const SSL_METHOD *B(void); + +Constructor for the I SSL_METHOD structure for servers. + +=item const SSL_METHOD *B(void); + +Constructor for the TLSv1.2 SSL_METHOD structure for clients, servers or both. + +=item const SSL_METHOD *B(void); + +Constructor for the TLSv1.2 SSL_METHOD structure for clients. + +=item const SSL_METHOD *B(void); + +Constructor for the TLSv1.2 SSL_METHOD structure for servers. + +=item const SSL_METHOD *B(void); + +Constructor for the TLSv1.1 SSL_METHOD structure for clients, servers or both. + +=item const SSL_METHOD *B(void); + +Constructor for the TLSv1.1 SSL_METHOD structure for clients. + +=item const SSL_METHOD *B(void); -Constructor for the SSLv3 SSL_METHOD structure for combined client and server. +Constructor for the TLSv1.1 SSL_METHOD structure for servers. + +=item const SSL_METHOD *B(void); + +Constructor for the TLSv1 SSL_METHOD structure for clients, servers or both. =item const SSL_METHOD *B(void); -Constructor for the TLSv1 SSL_METHOD structure for a dedicated client. +Constructor for the TLSv1 SSL_METHOD structure for clients. =item const SSL_METHOD *B(void); -Constructor for the TLSv1 SSL_METHOD structure for a dedicated server. +Constructor for the TLSv1 SSL_METHOD structure for servers. -=item const SSL_METHOD *B(void); +=item const SSL_METHOD *B(void); + +Constructor for the SSLv3 SSL_METHOD structure for clients, servers or both. + +=item const SSL_METHOD *B(void); -Constructor for the TLSv1 SSL_METHOD structure for combined client and server. +Constructor for the SSLv3 SSL_METHOD structure for clients. + +=item const SSL_METHOD *B(void); + +Constructor for the SSLv3 SSL_METHOD structure for servers. =back @@ -171,7 +206,7 @@ Return the internal name of I as a string. These are the various strings defined by the I and I definitions in the header files. -=item char *B(SSL_CIPHER *cipher); +=item const char *B(SSL_CIPHER *cipher); Returns a string like "C" or "C" which indicates the SSL/TLS protocol version to which I belongs (i.e. where it was defined @@ -204,6 +239,8 @@ protocol context defined in the B structure. =item X509_STORE *B(SSL_CTX *ctx); +=item STACK *B(const SSL_CTX *ctx); + =item STACK *B(const SSL_CTX *ctx); =item int (*B(SSL_CTX *ctx))(SSL *ssl, X509 **x509, EVP_PKEY **pkey); @@ -234,6 +271,8 @@ protocol context defined in the B structure. =item SSL_CTX *B(const SSL_METHOD *meth); +=item void SSL_CTX_up_ref(SSL_CTX *ctx); + =item int B(SSL_CTX *ctx, SSL_SESSION *c); =item int B(SSL_CTX *ctx); @@ -301,11 +340,11 @@ directory path and one default file path. Both are set via this call. =item int B(SSL_CTX *ctx) -Use the default directory path to locate trusted CA certficates. +Use the default directory path to locate trusted CA certificates. =item int B(SSL_CTX *ctx) -Use the file path to locate trusted CA certficates. +Use the file path to locate trusted CA certificates. =item int B(SSL_CTX *s, int idx, char *arg); @@ -558,10 +597,10 @@ fresh handle for each connection. =item STACK *B(char *file); -=item void B(void); - =item SSL *B(SSL_CTX *ctx); +=item void SSL_up_ref(SSL *s); + =item long B(SSL *ssl); =item int B(SSL *ssl, void *buf, int num); @@ -738,7 +777,6 @@ L, L, L, L, -L, L, L, L,