secure/lib/libcrypto/man/BIO_parse_hostserv.3

   1 .\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
   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 >0, 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 .if !\nF .nr F 0
  58 .if \nF>0 \{\
  59 .    de IX
  60 .    tm Index:\\$1\t\\n%\t"\\$2"
  61 ..
  62 .    if !\nF==2 \{\
  63 .        nr % 0
  64 .        nr F 2
  65 .    \}
  66 .\}
  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
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 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 "BIO_PARSE_HOSTSERV 3"
 132 .TH BIO_PARSE_HOSTSERV 3 "2018-09-11" "1.1.1" "OpenSSL"
 133 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 134 .\" way too many mistakes in technical documents.
 135 .if n .ad l
 136 .nh
 137 .SH "NAME"
 138 BIO_hostserv_priorities, BIO_parse_hostserv \&\- utility routines to parse a standard host and service string
 139 .SH "SYNOPSIS"
 140 .IX Header "SYNOPSIS"
 141 .Vb 1
 142 \& #include <openssl/bio.h>
 143 \&
 144 \& enum BIO_hostserv_priorities {
 145 \&     BIO_PARSE_PRIO_HOST, BIO_PARSE_PRIO_SERV
 146 \& };
 147 \& int BIO_parse_hostserv(const char *hostserv, char **host, char **service,
 148 \&                        enum BIO_hostserv_priorities hostserv_prio);
 149 .Ve
 150 .SH "DESCRIPTION"
 151 .IX Header "DESCRIPTION"
 152 \&\fIBIO_parse_hostserv()\fR will parse the information given in \fBhostserv\fR,
 153 create strings with the host name and service name and give those
 154 back via \fBhost\fR and \fBservice\fR.  Those will need to be freed after
 155 they are used.  \fBhostserv_prio\fR helps determine if \fBhostserv\fR shall
 156 be interpreted primarily as a host name or a service name in ambiguous
 157 cases.
 158 .PP
 159 The syntax the \fIBIO_parse_hostserv()\fR recognises is:
 160 .PP
 161 .Vb 7
 162 \& host + \*(Aq:\*(Aq + service
 163 \& host + \*(Aq:\*(Aq + \*(Aq*\*(Aq
 164 \& host + \*(Aq:\*(Aq
 165 \&        \*(Aq:\*(Aq + service
 166 \& \*(Aq*\*(Aq  + \*(Aq:\*(Aq + service
 167 \& host
 168 \& service
 169 .Ve
 170 .PP
 171 The host part can be a name or an \s-1IP\s0 address.  If it's a IPv6
 172 address, it \s-1MUST\s0 be enclosed in brackets, such as '[::1]'.
 173 .PP
 174 The service part can  be a service name or its port number.
 175 .PP
 176 The returned values will depend on the given \fBhostserv\fR string
 177 and \fBhostserv_prio\fR, as follows:
 178 .PP
 179 .Vb 5
 180 \& host + \*(Aq:\*(Aq + service  => *host = "host", *service = "service"
 181 \& host + \*(Aq:\*(Aq + \*(Aq*\*(Aq      => *host = "host", *service = NULL
 182 \& host + \*(Aq:\*(Aq            => *host = "host", *service = NULL
 183 \&        \*(Aq:\*(Aq + service  => *host = NULL, *service = "service"
 184 \&  \*(Aq*\*(Aq + \*(Aq:\*(Aq + service  => *host = NULL, *service = "service"
 185 \&
 186 \& in case no \*(Aq:\*(Aq is present in the string, the result depends on
 187 \& hostserv_prio, as follows:
 188 \&
 189 \& when hostserv_prio == BIO_PARSE_PRIO_HOST
 190 \& host                 => *host = "host", *service untouched
 191 \&
 192 \& when hostserv_prio == BIO_PARSE_PRIO_SERV
 193 \& service              => *host untouched, *service = "service"
 194 .Ve
 195 .SH "RETURN VALUES"
 196 .IX Header "RETURN VALUES"
 197 \&\fIBIO_parse_hostserv()\fR returns 1 on success or 0 on error.
 198 .SH "SEE ALSO"
 199 .IX Header "SEE ALSO"
 200 \&\s-1\fIBIO_ADDRINFO\s0\fR\|(3)
 201 .SH "COPYRIGHT"
 202 .IX Header "COPYRIGHT"
 203 Copyright 2016\-2018 The OpenSSL Project Authors. All Rights Reserved.
 204 .PP
 205 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 206 this file except in compliance with the License.  You can obtain a copy
 207 in the file \s-1LICENSE\s0 in the source distribution or at
 208 <https://www.openssl.org/source/license.html>.