diff options
| author | Dr. David von Oheimb <David.von.Oheimb@siemens.com> | 2020-06-02 13:02:42 +0200 |
|---|---|---|
| committer | Dr. David von Oheimb <David.von.Oheimb@siemens.com> | 2020-06-06 11:24:23 +0200 |
| commit | 591315297ec45ada0d31f057c4f6cff7f572bf3e (patch) | |
| tree | 4240b9a0d61e4ecf849f3a0361d4291cd4a2b63b /doc | |
| parent | f5e23fe88904fb5309e5b199bf5254b06dd4f883 (diff) | |
Consolidate doc of BIO_do_connect() and its alias BIO_do_handshake()
Also documents that they meanwhile try all IP addresses resolved for a given domain name
Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org>
(Merged from https://github.com/openssl/openssl/pull/12017)
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/man3/BIO_f_ssl.pod | 15 | ||||
| -rw-r--r-- | doc/man3/BIO_s_connect.pod | 13 |
2 files changed, 18 insertions, 10 deletions
diff --git a/doc/man3/BIO_f_ssl.pod b/doc/man3/BIO_f_ssl.pod index 6b896e2a2b..8bbbb0436d 100644 --- a/doc/man3/BIO_f_ssl.pod +++ b/doc/man3/BIO_f_ssl.pod @@ -96,12 +96,15 @@ chain and calling SSL_shutdown() on its internal SSL pointer. BIO_do_handshake() attempts to complete an SSL handshake on the -supplied BIO and establish the SSL connection. It returns 1 -if the connection was established successfully. A zero or negative -value is returned if the connection could not be established, the -call BIO_should_retry() should be used for non blocking connect BIOs -to determine if the call should be retried. If an SSL connection has -already been established this call has no effect. +-supplied BIO and establish the SSL connection. +For non-SSL BIOs the connection is done typically at TCP level. +If domain name resolution yields multiple IP addresses all of them are tried +after connect() failures. +The function returns 1 if the connection was established successfully. +A zero or negative value is returned if the connection could not be established. +The call BIO_should_retry() should be used for non-blocking connect BIOs +to determine if the call should be retried. +If a connection has already been established this call has no effect. =head1 NOTES diff --git a/doc/man3/BIO_s_connect.pod b/doc/man3/BIO_s_connect.pod index 24f1120625..d5a909dcd2 100644 --- a/doc/man3/BIO_s_connect.pod +++ b/doc/man3/BIO_s_connect.pod @@ -94,11 +94,16 @@ non blocking I/O is set during the connect process. BIO_new_connect() combines BIO_new() and BIO_set_conn_hostname() into a single call: that is it creates a new connect BIO with B<name>. -BIO_do_connect() attempts to connect the supplied BIO. It returns 1 -if the connection was established successfully. A zero or negative -value is returned if the connection could not be established, the -call BIO_should_retry() should be used for non blocking connect BIOs +BIO_do_connect() attempts to connect the supplied BIO. +This performs an SSL/TLS handshake as far as supported by the BIO. +For non-SSL BIOs the connection is done typically at TCP level. +If domain name resolution yields multiple IP addresses all of them are tried +after connect() failures. +The function returns 1 if the connection was established successfully. +A zero or negative value is returned if the connection could not be established. +The call BIO_should_retry() should be used for non blocking connect BIOs to determine if the call should be retried. +If a connection has already been established this call has no effect. =head1 NOTES |