| SSL_connect.3 (206048) | SSL_connect.3 (215698) |
|---|---|
| 1.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.37 | 1.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.07) |
| 2.\" 3.\" Standard preamble: 4.\" ======================================================================== | 2.\" 3.\" Standard preamble: 4.\" ======================================================================== |
| 5.de Sh \" Subsection heading 6.br 7.if t .Sp 8.ne 5 9.PP 10\fB\\$1\fR 11.PP 12.. | |
| 13.de Sp \" Vertical space (when we can't use .PP) 14.if t .sp .5v 15.if n .sp 16.. 17.de Vb \" Begin verbatim text 18.ft CW 19.nf 20.ne \\$1 21.. 22.de Ve \" End verbatim text 23.ft R 24.fi 25.. 26.\" Set up some character translations and predefined strings. \*(-- will 27.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left | 5.de Sp \" Vertical space (when we can't use .PP) 6.if t .sp .5v 7.if n .sp 8.. 9.de Vb \" Begin verbatim text 10.ft CW 11.nf 12.ne \\$1 13.. 14.de Ve \" End verbatim text 15.ft R 16.fi 17.. 18.\" Set up some character translations and predefined strings. \*(-- will 19.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left |
| 28.\" double quote, and \*(R" will give a right double quote. | will give a 29.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to 30.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' 31.\" expand to `' in nroff, nothing in troff, for use with C<>. 32.tr \(*W-|\(bv\*(Tr | 20.\" double quote, and \*(R" will give a right double quote. \*(C+ will 21.\" give a nicer C++. Capital omega is used to do unbreakable dashes and 22.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, 23.\" nothing in troff, for use with C<>. 24.tr \(*W- |
| 33.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' 34.ie n \{\ 35. ds -- \(*W- 36. ds PI pi 37. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch 38. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch 39. ds L" "" 40. ds R" "" 41. ds C` "" 42. ds C' "" 43'br\} 44.el\{\ 45. ds -- \|\(em\| 46. ds PI \(*p 47. ds L" `` 48. ds R" '' 49'br\} 50.\" | 25.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' 26.ie n \{\ 27. ds -- \(*W- 28. ds PI pi 29. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch 30. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch 31. ds L" "" 32. ds R" "" 33. ds C` "" 34. ds C' "" 35'br\} 36.el\{\ 37. ds -- \|\(em\| 38. ds PI \(*p 39. ds L" `` 40. ds R" '' 41'br\} 42.\" |
| 43.\" Escape single quotes in literal strings from groff's Unicode transform. 44.ie \n(.g .ds Aq \(aq 45.el .ds Aq ' 46.\" |
|
| 51.\" If the F register is turned on, we'll generate index entries on stderr for | 47.\" If the F register is turned on, we'll generate index entries on stderr for |
| 52.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index | 48.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index |
| 53.\" entries marked with X<> in POD. Of course, you'll have to process the 54.\" output yourself in some meaningful fashion. | 49.\" entries marked with X<> in POD. Of course, you'll have to process the 50.\" output yourself in some meaningful fashion. |
| 55.if \nF \{\ | 51.ie \nF \{\ |
| 56. de IX 57. tm Index:\\$1\t\\n%\t"\\$2" 58.. 59. nr % 0 60. rr F 61.\} | 52. de IX 53. tm Index:\\$1\t\\n%\t"\\$2" 54.. 55. nr % 0 56. rr F 57.\} |
| 58.el \{\ 59. de IX 60.. 61.\} |
|
| 62.\" | 62.\" |
| 63.\" For nroff, turn off justification. Always turn off hyphenation; it makes 64.\" way too many mistakes in technical documents. 65.hy 0 66.if n .na 67.\" | |
| 68.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). 69.\" Fear. Run. Save yourself. No user-serviceable parts. 70. \" fudge factors for nroff and troff 71.if n \{\ 72. ds #H 0 73. ds #V .8m 74. ds #F .3m 75. ds #[ \f1 --- 48 unchanged lines hidden (view full) --- 124. ds Th \o'LP' 125. ds ae ae 126. ds Ae AE 127.\} 128.rm #[ #] #H #V #F C 129.\" ======================================================================== 130.\" 131.IX Title "SSL_connect 3" | 63.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). 64.\" Fear. Run. Save yourself. No user-serviceable parts. 65. \" fudge factors for nroff and troff 66.if n \{\ 67. ds #H 0 68. ds #V .8m 69. ds #F .3m 70. ds #[ \f1 --- 48 unchanged lines hidden (view full) --- 119. ds Th \o'LP' 120. ds ae ae 121. ds Ae AE 122.\} 123.rm #[ #] #H #V #F C 124.\" ======================================================================== 125.\" 126.IX Title "SSL_connect 3" |
| 132.TH SSL_connect 3 "2010-03-24" "0.9.8n" "OpenSSL" | 127.TH SSL_connect 3 "2010-11-16" "0.9.8p" "OpenSSL" 128.\" For nroff, turn off justification. Always turn off hyphenation; it makes 129.\" way too many mistakes in technical documents. 130.if n .ad l 131.nh |
| 133.SH "NAME" 134SSL_connect \- initiate the TLS/SSL handshake with an TLS/SSL server 135.SH "SYNOPSIS" 136.IX Header "SYNOPSIS" 137.Vb 1 138\& #include <openssl/ssl.h> | 132.SH "NAME" 133SSL_connect \- initiate the TLS/SSL handshake with an TLS/SSL server 134.SH "SYNOPSIS" 135.IX Header "SYNOPSIS" 136.Vb 1 137\& #include <openssl/ssl.h> |
| 139.Ve 140.PP 141.Vb 1 | 138\& |
| 142\& int SSL_connect(SSL *ssl); 143.Ve 144.SH "DESCRIPTION" 145.IX Header "DESCRIPTION" 146\&\fISSL_connect()\fR initiates the \s-1TLS/SSL\s0 handshake with a server. The communication 147channel must already have been set and assigned to the \fBssl\fR by setting an 148underlying \fB\s-1BIO\s0\fR. 149.SH "NOTES" 150.IX Header "NOTES" | 139\& int SSL_connect(SSL *ssl); 140.Ve 141.SH "DESCRIPTION" 142.IX Header "DESCRIPTION" 143\&\fISSL_connect()\fR initiates the \s-1TLS/SSL\s0 handshake with a server. The communication 144channel must already have been set and assigned to the \fBssl\fR by setting an 145underlying \fB\s-1BIO\s0\fR. 146.SH "NOTES" 147.IX Header "NOTES" |
| 151The behaviour of \fISSL_connect()\fR depends on the underlying \s-1BIO\s0. | 148The behaviour of \fISSL_connect()\fR depends on the underlying \s-1BIO\s0. |
| 152.PP 153If the underlying \s-1BIO\s0 is \fBblocking\fR, \fISSL_connect()\fR will only return once the 154handshake has been finished or an error occurred. 155.PP 156If the underlying \s-1BIO\s0 is \fBnon-blocking\fR, \fISSL_connect()\fR will also return 157when the underlying \s-1BIO\s0 could not satisfy the needs of \fISSL_connect()\fR 158to continue the handshake, indicating the problem by the return value \-1. 159In this case a call to \fISSL_get_error()\fR with the 160return value of \fISSL_connect()\fR will yield \fB\s-1SSL_ERROR_WANT_READ\s0\fR or 161\&\fB\s-1SSL_ERROR_WANT_WRITE\s0\fR. The calling process then must repeat the call after 162taking appropriate action to satisfy the needs of \fISSL_connect()\fR. 163The action depends on the underlying \s-1BIO\s0. When using a non-blocking socket, 164nothing is to be done, but \fIselect()\fR can be used to check for the required 165condition. When using a buffering \s-1BIO\s0, like a \s-1BIO\s0 pair, data must be written 166into or retrieved out of the \s-1BIO\s0 before being able to continue. 167.SH "RETURN VALUES" 168.IX Header "RETURN VALUES" 169The following return values can occur: | 149.PP 150If the underlying \s-1BIO\s0 is \fBblocking\fR, \fISSL_connect()\fR will only return once the 151handshake has been finished or an error occurred. 152.PP 153If the underlying \s-1BIO\s0 is \fBnon-blocking\fR, \fISSL_connect()\fR will also return 154when the underlying \s-1BIO\s0 could not satisfy the needs of \fISSL_connect()\fR 155to continue the handshake, indicating the problem by the return value \-1. 156In this case a call to \fISSL_get_error()\fR with the 157return value of \fISSL_connect()\fR will yield \fB\s-1SSL_ERROR_WANT_READ\s0\fR or 158\&\fB\s-1SSL_ERROR_WANT_WRITE\s0\fR. The calling process then must repeat the call after 159taking appropriate action to satisfy the needs of \fISSL_connect()\fR. 160The action depends on the underlying \s-1BIO\s0. When using a non-blocking socket, 161nothing is to be done, but \fIselect()\fR can be used to check for the required 162condition. When using a buffering \s-1BIO\s0, like a \s-1BIO\s0 pair, data must be written 163into or retrieved out of the \s-1BIO\s0 before being able to continue. 164.SH "RETURN VALUES" 165.IX Header "RETURN VALUES" 166The following return values can occur: |
| 170.IP "1" 4 171.IX Item "1" | 167.IP "1." 4 |
| 172The \s-1TLS/SSL\s0 handshake was successfully completed, a \s-1TLS/SSL\s0 connection has been 173established. | 168The \s-1TLS/SSL\s0 handshake was successfully completed, a \s-1TLS/SSL\s0 connection has been 169established. |
| 174.IP "0" 4 | 170.IP "2." 4 |
| 175The \s-1TLS/SSL\s0 handshake was not successful but was shut down controlled and 176by the specifications of the \s-1TLS/SSL\s0 protocol. Call \fISSL_get_error()\fR with the 177return value \fBret\fR to find out the reason. | 171The \s-1TLS/SSL\s0 handshake was not successful but was shut down controlled and 172by the specifications of the \s-1TLS/SSL\s0 protocol. Call \fISSL_get_error()\fR with the 173return value \fBret\fR to find out the reason. |
| 178.IP "<0" 4 179.IX Item "<0" | 174.IP "3." 4 175<0 176.Sp |
| 180The \s-1TLS/SSL\s0 handshake was not successful, because a fatal error occurred either 181at the protocol level or a connection failure occurred. The shutdown was 182not clean. It can also occur of action is need to continue the operation 183for non-blocking BIOs. Call \fISSL_get_error()\fR with the return value \fBret\fR 184to find out the reason. 185.SH "SEE ALSO" 186.IX Header "SEE ALSO" 187\&\fISSL_get_error\fR\|(3), \fISSL_accept\fR\|(3), 188\&\fISSL_shutdown\fR\|(3), \fIssl\fR\|(3), \fIbio\fR\|(3), 189\&\fISSL_set_connect_state\fR\|(3), 190\&\fISSL_do_handshake\fR\|(3), 191\&\fISSL_CTX_new\fR\|(3) | 177The \s-1TLS/SSL\s0 handshake was not successful, because a fatal error occurred either 178at the protocol level or a connection failure occurred. The shutdown was 179not clean. It can also occur of action is need to continue the operation 180for non-blocking BIOs. Call \fISSL_get_error()\fR with the return value \fBret\fR 181to find out the reason. 182.SH "SEE ALSO" 183.IX Header "SEE ALSO" 184\&\fISSL_get_error\fR\|(3), \fISSL_accept\fR\|(3), 185\&\fISSL_shutdown\fR\|(3), \fIssl\fR\|(3), \fIbio\fR\|(3), 186\&\fISSL_set_connect_state\fR\|(3), 187\&\fISSL_do_handshake\fR\|(3), 188\&\fISSL_CTX_new\fR\|(3) |
| 189.SH "POD ERRORS" 190.IX Header "POD ERRORS" 191Hey! \fBThe above document had some coding errors, which are explained below:\fR 192.IP "Around line 49:" 4 193.IX Item "Around line 49:" 194You have '=item 0' instead of the expected '=item 2' 195.IP "Around line 55:" 4 196.IX Item "Around line 55:" 197Expected '=item 3' |
|