X-Git-Url: https://git.openssl.org/?p=openssl.git;a=blobdiff_plain;f=doc%2Fssl%2Fssl.pod;h=695a13c1c5c2b14287f36fec5be5946a35e4d650;hp=8d5b8c380e179d3ae629dfd39cff2e9e4714443e;hb=ca7256fbd947870101220735dc375862ec7eb9b1;hpb=a25f9adc778e17568fe2a325e5c3606adb8329f1 diff --git a/doc/ssl/ssl.pod b/doc/ssl/ssl.pod index 8d5b8c380e..695a13c1c5 100644 --- a/doc/ssl/ssl.pod +++ b/doc/ssl/ssl.pod @@ -14,25 +14,25 @@ Transport Layer Security (TLS v1) protocols. It provides a rich API which is documented here. At first the library must be initialized; see -L. +L. Then an B object is created as a framework to establish -TLS/SSL enabled connections (see L). +TLS/SSL enabled connections (see L). 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 B object. After the B object has been created using -L, L or -L can be used to associate the network +L, L or +L can be used to associate the network connection with the object. Then the TLS/SSL handshake is performed using -L or L +L or L respectively. -L and L are used +L and L are used to read and write data on the TLS/SSL connection. -L can be used to shut down the +L can be used to shut down the TLS/SSL connection. =head1 DATA STRUCTURES @@ -45,8 +45,8 @@ structures: =item B (SSL Method) That's a dispatch structure describing the internal B library -methods/functions which implement the various protocol versions (SSLv1, SSLv2 -and TLSv1). It's needed to create an B. +methods/functions which implement the various protocol versions (SSLv3 +TLSv1, ...). It's needed to create an B. =item B (SSL Cipher) @@ -103,13 +103,6 @@ That's the sub header file dealing with the SSLv3 protocol only. I. -=item B - -That's the sub header file dealing with the combined use of the SSLv2 and -SSLv3 protocols. -I. - =item B That's the sub header file dealing with the TLSv1 protocol only. @@ -130,18 +123,6 @@ protocol methods defined in B structures. =over 4 -=item const SSL_METHOD *B(void); - -Constructor for the SSLv2 SSL_METHOD structure for a dedicated client. - -=item const SSL_METHOD *B(void); - -Constructor for the SSLv2 SSL_METHOD structure for a dedicated server. - -=item const SSL_METHOD *B(void); - -Constructor for the SSLv2 SSL_METHOD structure for combined client and server. - =item const SSL_METHOD *B(void); Constructor for the SSLv3 SSL_METHOD structure for a dedicated client. @@ -189,7 +170,7 @@ I) and the bits which are actually used (the return value). =item const char *B(SSL_CIPHER *cipher); Return the internal name of I as a string. These are the various -strings defined by the I, I and I +strings defined by the I and I definitions in the header files. =item char *B(SSL_CIPHER *cipher); @@ -229,6 +210,8 @@ protocol context defined in the B structure. =item int (*B(SSL_CTX *ctx))(SSL *ssl, X509 **x509, EVP_PKEY **pkey); +=item void B(SSL_CTX *ctx); + =item char *B(const SSL_CTX *s, int idx); =item int B(long argl, char *argp, int (*new_func);(void), int (*dup_func)(void), void (*free_func)(void)) @@ -237,6 +220,8 @@ protocol context defined in the B structure. =item int B(const SSL_CTX *ctx); +=item void B(SSL_CTX *ctx); + =item int B(SSL_CTX *ctx); =item long B(const SSL_CTX *ctx); @@ -325,6 +310,8 @@ protocol context defined in the B structure. =item void B(SSL_CTX *ctx, int mode); +=item void B(SSL_CTX *ctx, int m); + =item void B(SSL_CTX *ctx, int mode); =item int B(SSL_CTX *ctx, const SSL_METHOD *meth); @@ -459,7 +446,10 @@ connection defined in the B structure. =item int B(SSL *ssl); -=item void B(SSL *t, const SSL *f); +=item int B(SSL *t, const SSL *f); + +Sets the session details for B to be the same as in B. Returns 1 on +success or 0 on failure. =item long B(SSL *ssl, int cmd, long larg, char *parg); @@ -677,86 +667,94 @@ connection defined in the B structure. =head1 SEE ALSO -L, L, -L, L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L +L, L, +L, L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L =head1 HISTORY -The L document appeared in OpenSSL 0.9.2 +The L document appeared in OpenSSL 0.9.2 + +B, B and B where removed +in OpenSSL 1.1.0. + +The return type of B was changed from void to int in +OpenSSL 1.1.0. =cut