From: Lutz Jänicke Date: Fri, 19 Jul 2002 11:05:50 +0000 (+0000) Subject: Manual page for SSL_do_handshake(). X-Git-Tag: OpenSSL_0_9_6e~14^2 X-Git-Url: https://git.librecmc.org/?a=commitdiff_plain;h=02b7ec88bb798326d2bdae41c549bebeabc8759f;p=oweals%2Fopenssl.git Manual page for SSL_do_handshake(). Submitted by: Martin Sjögren PR: 137 --- diff --git a/doc/ssl/SSL_accept.pod b/doc/ssl/SSL_accept.pod index ac6caf9baa..a673edba85 100644 --- a/doc/ssl/SSL_accept.pod +++ b/doc/ssl/SSL_accept.pod @@ -69,6 +69,7 @@ to find out the reason. L, L, L, L, L, L, +L, L =cut diff --git a/doc/ssl/SSL_connect.pod b/doc/ssl/SSL_connect.pod index 766f1876aa..8426310c0d 100644 --- a/doc/ssl/SSL_connect.pod +++ b/doc/ssl/SSL_connect.pod @@ -66,6 +66,7 @@ to find out the reason. L, L, L, L, L, L, +L, L =cut diff --git a/doc/ssl/SSL_do_handshake.pod b/doc/ssl/SSL_do_handshake.pod new file mode 100644 index 0000000000..243576451b --- /dev/null +++ b/doc/ssl/SSL_do_handshake.pod @@ -0,0 +1,75 @@ +=pod + +=head1 NAME + +SSL_do_handshake - perform a TLS/SSL handshake + +=head1 SYNOPSIS + + #include + + int SSL_do_handshake(SSL *ssl); + +=head1 DESCRIPTION + +SSL_do_handshake() will wait for a SSL/TLS handshake to take place. If the +connection is in client mode, the handshake will be started. The handshake +routines may have to be explicitly set in advance using either +L or +L. + +=head1 NOTES + +The behaviour of SSL_do_handshake() depends on the underlying BIO. + +If the underlying BIO is B, SSL_do_handshake() will only return +once the handshake has been finished or an error occurred, except for SGC +(Server Gated Cryptography). For SGC, SSL_do_handshake() may return with -1, +but SSL_get_error() will yield B and +SSL_do_handshake() should be called again. + +If the underlying BIO is B, SSL_do_handshake() will also return +when the underlying BIO could not satisfy the needs of SSL_do_handshake() +to continue the handshake. In this case a call to SSL_get_error() with the +return value of SSL_do_handshake() will yield B or +B. The calling process then must repeat the call after +taking appropriate action to satisfy the needs of SSL_do_handshake(). +The action depends on the underlying BIO. When using a non-blocking socket, +nothing is to be done, but select() can be used to check for the required +condition. When using a buffering BIO, like a BIO pair, data must be written +into or retrieved out of the BIO before being able to continue. + +=head1 RETURN VALUES + +The following return values can occur: + +=over 4 + +=item 1 + +The TLS/SSL handshake was successfully completed, a TLS/SSL connection has been +established. + +=item 0 + +The TLS/SSL handshake was not successful but was shut down controlled and +by the specifications of the TLS/SSL protocol. Call SSL_get_error() with the +return value B to find out the reason. + +=item E0 + +The TLS/SSL handshake was not successful because a fatal error occurred either +at the protocol level or a connection failure occurred. The shutdown was +not clean. It can also occur of action is need to continue the operation +for non-blocking BIOs. Call SSL_get_error() with the return value B +to find out the reason. + +=back + +=head1 SEE ALSO + +L, L, +L, L, L, +L + +=cut diff --git a/doc/ssl/SSL_set_connect_state.pod b/doc/ssl/SSL_set_connect_state.pod index 7adf8adfed..d88a057def 100644 --- a/doc/ssl/SSL_set_connect_state.pod +++ b/doc/ssl/SSL_set_connect_state.pod @@ -49,6 +49,7 @@ information. L, L, L, L, L, L, L, +L, L =cut diff --git a/doc/ssl/ssl.pod b/doc/ssl/ssl.pod index d0525582b0..1471e0312e 100644 --- a/doc/ssl/ssl.pod +++ b/doc/ssl/ssl.pod @@ -693,6 +693,7 @@ L, L, L, L, +L, L, L, L,