secure/lib/libcrypto/man/BIO_s_connect.3

   1 .\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   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
  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-
  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 .    ds C`
  42 .    ds C'
  43 'br\}
  44 .\"
  45 .\" Escape single quotes in literal strings from groff's Unicode transform.
  46 .ie \n(.g .ds Aq \(aq
  47 .el       .ds Aq '
  48 .\"
  49 .\" If the F register is turned on, we'll generate index entries on stderr for
  50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  52 .\" output yourself in some meaningful fashion.
  53 .\"
  54 .\" Avoid warning from groff about undefined register 'F'.
  55 .de IX
  56 ..
  57 .nr rF 0
  58 .if \n(.g .if rF .nr rF 1
  59 .if (\n(rF:(\n(.g==0)) \{
  60 .    if \nF \{
  61 .        de IX
  62 .        tm Index:\\$1\t\\n%\t"\\$2"
  63 ..
  64 .        if !\nF==2 \{
  65 .            nr % 0
  66 .            nr F 2
  67 .        \}
  68 .    \}
  69 .\}
  70 .rr rF
  71 .\"
  72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  73 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  74 .    \" fudge factors for nroff and troff
  75 .if n \{\
  76 .    ds #H 0
  77 .    ds #V .8m
  78 .    ds #F .3m
  79 .    ds #[ \f1
  80 .    ds #] \fP
  81 .\}
  82 .if t \{\
  83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  84 .    ds #V .6m
  85 .    ds #F 0
  86 .    ds #[ \&
  87 .    ds #] \&
  88 .\}
  89 .    \" simple accents for nroff and troff
  90 .if n \{\
  91 .    ds ' \&
  92 .    ds ` \&
  93 .    ds ^ \&
  94 .    ds , \&
  95 .    ds ~ ~
  96 .    ds /
  97 .\}
  98 .if t \{\
  99 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 100 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 101 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 102 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 103 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 104 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 105 .\}
 106 .    \" troff and (daisy-wheel) nroff accents
 107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 114 .ds ae a\h'-(\w'a'u*4/10)'e
 115 .ds Ae A\h'-(\w'A'u*4/10)'E
 116 .    \" corrections for vroff
 117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 119 .    \" for low resolution devices (crt and lpr)
 120 .if \n(.H>23 .if \n(.V>19 \
 121 \{\
 122 .    ds : e
 123 .    ds 8 ss
 124 .    ds o a
 125 .    ds d- d\h'-1'\(ga
 126 .    ds D- D\h'-1'\(hy
 127 .    ds th \o'bp'
 128 .    ds Th \o'LP'
 129 .    ds ae ae
 130 .    ds Ae AE
 131 .\}
 132 .rm #[ #] #H #V #F C
 133 .\" ========================================================================
 134 .\"
 135 .IX Title "BIO_s_connect 3"
 136 .TH BIO_s_connect 3 "2015-07-09" "1.0.1p" "OpenSSL"
 137 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 138 .\" way too many mistakes in technical documents.
 139 .if n .ad l
 140 .nh
 141 .SH "NAME"
 142 BIO_s_connect, BIO_set_conn_hostname, BIO_set_conn_port,
 143 BIO_set_conn_ip, BIO_set_conn_int_port, BIO_get_conn_hostname,
 144 BIO_get_conn_port, BIO_get_conn_ip, BIO_get_conn_int_port,
 145 BIO_set_nbio, BIO_do_connect \- connect BIO
 146 .SH "SYNOPSIS"
 147 .IX Header "SYNOPSIS"
 148 .Vb 1
 149 \& #include <openssl/bio.h>
 150 \&
 151 \& BIO_METHOD * BIO_s_connect(void);
 152 \&
 153 \& BIO *BIO_new_connect(char *name);
 154 \&
 155 \& long BIO_set_conn_hostname(BIO *b, char *name);
 156 \& long BIO_set_conn_port(BIO *b, char *port);
 157 \& long BIO_set_conn_ip(BIO *b, char *ip);
 158 \& long BIO_set_conn_int_port(BIO *b, char *port);
 159 \& char *BIO_get_conn_hostname(BIO *b);
 160 \& char *BIO_get_conn_port(BIO *b);
 161 \& char *BIO_get_conn_ip(BIO *b, dummy);
 162 \& long BIO_get_conn_int_port(BIO *b, int port);
 163 \&
 164 \& long BIO_set_nbio(BIO *b, long n);
 165 \&
 166 \& int BIO_do_connect(BIO *b);
 167 .Ve
 168 .SH "DESCRIPTION"
 169 .IX Header "DESCRIPTION"
 170 \&\fIBIO_s_connect()\fR returns the connect \s-1BIO\s0 method. This is a wrapper
 171 round the platform's \s-1TCP/IP\s0 socket connection routines.
 172 .PP
 173 Using connect BIOs, \s-1TCP/IP\s0 connections can be made and data
 174 transferred using only \s-1BIO\s0 routines. In this way any platform
 175 specific operations are hidden by the \s-1BIO\s0 abstraction.
 176 .PP
 177 Read and write operations on a connect \s-1BIO\s0 will perform I/O
 178 on the underlying connection. If no connection is established
 179 and the port and hostname (see below) is set up properly then
 180 a connection is established first.
 181 .PP
 182 Connect BIOs support \fIBIO_puts()\fR but not \fIBIO_gets()\fR.
 183 .PP
 184 If the close flag is set on a connect \s-1BIO\s0 then any active
 185 connection is shutdown and the socket closed when the \s-1BIO\s0
 186 is freed.
 187 .PP
 188 Calling \fIBIO_reset()\fR on a connect \s-1BIO\s0 will close any active
 189 connection and reset the \s-1BIO\s0 into a state where it can connect
 190 to the same host again.
 191 .PP
 192 \&\fIBIO_get_fd()\fR places the underlying socket in \fBc\fR if it is not \s-1NULL,\s0
 193 it also returns the socket . If \fBc\fR is not \s-1NULL\s0 it should be of
 194 type (int *).
 195 .PP
 196 \&\fIBIO_set_conn_hostname()\fR uses the string \fBname\fR to set the hostname.
 197 The hostname can be an \s-1IP\s0 address. The hostname can also include the
 198 port in the form hostname:port . It is also acceptable to use the
 199 form \*(L"hostname/any/other/path\*(R" or \*(L"hostname:port/any/other/path\*(R".
 200 .PP
 201 \&\fIBIO_set_conn_port()\fR sets the port to \fBport\fR. \fBport\fR can be the
 202 numerical form or a string such as \*(L"http\*(R". A string will be looked
 203 up first using \fIgetservbyname()\fR on the host platform but if that
 204 fails a standard table of port names will be used. Currently the
 205 list is http, telnet, socks, https, ssl, ftp, gopher and wais.
 206 .PP
 207 \&\fIBIO_set_conn_ip()\fR sets the \s-1IP\s0 address to \fBip\fR using binary form,
 208 that is four bytes specifying the \s-1IP\s0 address in big-endian form.
 209 .PP
 210 \&\fIBIO_set_conn_int_port()\fR sets the port using \fBport\fR. \fBport\fR should
 211 be of type (int *).
 212 .PP
 213 \&\fIBIO_get_conn_hostname()\fR returns the hostname of the connect \s-1BIO\s0 or
 214 \&\s-1NULL\s0 if the \s-1BIO\s0 is initialized but no hostname is set.
 215 This return value is an internal pointer which should not be modified.
 216 .PP
 217 \&\fIBIO_get_conn_port()\fR returns the port as a string.
 218 .PP
 219 \&\fIBIO_get_conn_ip()\fR returns the \s-1IP\s0 address in binary form.
 220 .PP
 221 \&\fIBIO_get_conn_int_port()\fR returns the port as an int.
 222 .PP
 223 \&\fIBIO_set_nbio()\fR sets the non blocking I/O flag to \fBn\fR. If \fBn\fR is
 224 zero then blocking I/O is set. If \fBn\fR is 1 then non blocking I/O
 225 is set. Blocking I/O is the default. The call to \fIBIO_set_nbio()\fR
 226 should be made before the connection is established because
 227 non blocking I/O is set during the connect process.
 228 .PP
 229 \&\fIBIO_new_connect()\fR combines \fIBIO_new()\fR and \fIBIO_set_conn_hostname()\fR into
 230 a single call: that is it creates a new connect \s-1BIO\s0 with \fBname\fR.
 231 .PP
 232 \&\fIBIO_do_connect()\fR attempts to connect the supplied \s-1BIO.\s0 It returns 1
 233 if the connection was established successfully. A zero or negative
 234 value is returned if the connection could not be established, the
 235 call \fIBIO_should_retry()\fR should be used for non blocking connect BIOs
 236 to determine if the call should be retried.
 237 .SH "NOTES"
 238 .IX Header "NOTES"
 239 If blocking I/O is set then a non positive return value from any
 240 I/O call is caused by an error condition, although a zero return
 241 will normally mean that the connection was closed.
 242 .PP
 243 If the port name is supplied as part of the host name then this will
 244 override any value set with \fIBIO_set_conn_port()\fR. This may be undesirable
 245 if the application does not wish to allow connection to arbitrary
 246 ports. This can be avoided by checking for the presence of the ':'
 247 character in the passed hostname and either indicating an error or
 248 truncating the string at that point.
 249 .PP
 250 The values returned by \fIBIO_get_conn_hostname()\fR, \fIBIO_get_conn_port()\fR,
 251 \&\fIBIO_get_conn_ip()\fR and \fIBIO_get_conn_int_port()\fR are updated when a
 252 connection attempt is made. Before any connection attempt the values
 253 returned are those set by the application itself.
 254 .PP
 255 Applications do not have to call \fIBIO_do_connect()\fR but may wish to do
 256 so to separate the connection process from other I/O processing.
 257 .PP
 258 If non blocking I/O is set then retries will be requested as appropriate.
 259 .PP
 260 It addition to \fIBIO_should_read()\fR and \fIBIO_should_write()\fR it is also
 261 possible for \fIBIO_should_io_special()\fR to be true during the initial
 262 connection process with the reason \s-1BIO_RR_CONNECT.\s0 If this is returned
 263 then this is an indication that a connection attempt would block,
 264 the application should then take appropriate action to wait until
 265 the underlying socket has connected and retry the call.
 266 .PP
 267 \&\fIBIO_set_conn_hostname()\fR, \fIBIO_set_conn_port()\fR, \fIBIO_set_conn_ip()\fR,
 268 \&\fIBIO_set_conn_int_port()\fR, \fIBIO_get_conn_hostname()\fR, \fIBIO_get_conn_port()\fR,
 269 \&\fIBIO_get_conn_ip()\fR, \fIBIO_get_conn_int_port()\fR, \fIBIO_set_nbio()\fR and
 270 \&\fIBIO_do_connect()\fR are macros.
 271 .SH "RETURN VALUES"
 272 .IX Header "RETURN VALUES"
 273 \&\fIBIO_s_connect()\fR returns the connect \s-1BIO\s0 method.
 274 .PP
 275 \&\fIBIO_get_fd()\fR returns the socket or \-1 if the \s-1BIO\s0 has not
 276 been initialized.
 277 .PP
 278 \&\fIBIO_set_conn_hostname()\fR, \fIBIO_set_conn_port()\fR, \fIBIO_set_conn_ip()\fR and
 279 \&\fIBIO_set_conn_int_port()\fR always return 1.
 280 .PP
 281 \&\fIBIO_get_conn_hostname()\fR returns the connected hostname or \s-1NULL\s0 is
 282 none was set.
 283 .PP
 284 \&\fIBIO_get_conn_port()\fR returns a string representing the connected
 285 port or \s-1NULL\s0 if not set.
 286 .PP
 287 \&\fIBIO_get_conn_ip()\fR returns a pointer to the connected \s-1IP\s0 address in
 288 binary form or all zeros if not set.
 289 .PP
 290 \&\fIBIO_get_conn_int_port()\fR returns the connected port or 0 if none was
 291 set.
 292 .PP
 293 \&\fIBIO_set_nbio()\fR always returns 1.
 294 .PP
 295 \&\fIBIO_do_connect()\fR returns 1 if the connection was successfully
 296 established and 0 or \-1 if the connection failed.
 297 .SH "EXAMPLE"
 298 .IX Header "EXAMPLE"
 299 This is example connects to a webserver on the local host and attempts
 300 to retrieve a page and copy the result to standard output.
 301 .PP
 302 .Vb 10
 303 \& BIO *cbio, *out;
 304 \& int len;
 305 \& char tmpbuf[1024];
 306 \& ERR_load_crypto_strings();
 307 \& cbio = BIO_new_connect("localhost:http");
 308 \& out = BIO_new_fp(stdout, BIO_NOCLOSE);
 309 \& if(BIO_do_connect(cbio) <= 0) {
 310 \&        fprintf(stderr, "Error connecting to server\en");
 311 \&        ERR_print_errors_fp(stderr);
 312 \&        /* whatever ... */
 313 \&        }
 314 \& BIO_puts(cbio, "GET / HTTP/1.0\en\en");
 315 \& for(;;) {
 316 \&        len = BIO_read(cbio, tmpbuf, 1024);
 317 \&        if(len <= 0) break;
 318 \&        BIO_write(out, tmpbuf, len);
 319 \& }
 320 \& BIO_free(cbio);
 321 \& BIO_free(out);
 322 .Ve
 323 .SH "SEE ALSO"
 324 .IX Header "SEE ALSO"
 325 \&\s-1TBA\s0