$NetBSD: BIO_parse_hostserv.3,v 1.9 2024/09/08 13:08:15 christos Exp $

-*- mode: troff; coding: utf-8 -*-
Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)

Standard preamble:
========================================================================
..

..

.. \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
. ds C` "" . ds C' "" 'br\} . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.

Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF ========================================================================

Title "BIO_parse_hostserv 3" For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
BIO_hostserv_priorities, BIO_parse_hostserv \- utility routines to parse a standard host and service string Header "SYNOPSIS" .Vb 1 #include <openssl/bio.h> \& enum BIO_hostserv_priorities { BIO_PARSE_PRIO_HOST, BIO_PARSE_PRIO_SERV }; int BIO_parse_hostserv(const char *hostserv, char **host, char **service, enum BIO_hostserv_priorities hostserv_prio); .Ve Header "DESCRIPTION" \fBBIO_parse_hostserv() will parse the information given in hostserv, create strings with the hostname and service name and give those back via host and service. Those will need to be freed after they are used. hostserv_prio helps determine if hostserv shall be interpreted primarily as a hostname or a service name in ambiguous cases.

The syntax the BIO_parse_hostserv() recognises is:

.Vb 7 host + \*(Aq:\*(Aq + service host + \*(Aq:\*(Aq + \*(Aq*\*(Aq host + \*(Aq:\*(Aq \*(Aq:\*(Aq + service \*(Aq*\*(Aq + \*(Aq:\*(Aq + service host service .Ve

The host part can be a name or an IP address. If it's a IPv6 address, it MUST be enclosed in brackets, such as '[::1]'.

The service part can be a service name or its port number. A service name will be mapped to a port number using the system function getservbyname().

The returned values will depend on the given hostserv string and hostserv_prio, as follows:

.Vb 5 host + \*(Aq:\*(Aq + service => *host = "host", *service = "service" host + \*(Aq:\*(Aq + \*(Aq*\*(Aq => *host = "host", *service = NULL host + \*(Aq:\*(Aq => *host = "host", *service = NULL \*(Aq:\*(Aq + service => *host = NULL, *service = "service" \*(Aq*\*(Aq + \*(Aq:\*(Aq + service => *host = NULL, *service = "service" \& in case no \*(Aq:\*(Aq is present in the string, the result depends on hostserv_prio, as follows: \& when hostserv_prio == BIO_PARSE_PRIO_HOST host => *host = "host", *service untouched \& when hostserv_prio == BIO_PARSE_PRIO_SERV service => *host untouched, *service = "service" .Ve

Header "RETURN VALUES" \fBBIO_parse_hostserv() returns 1 on success or 0 on error. Header "SEE ALSO" \fBBIO_ADDRINFO\|(3) Header "COPYRIGHT" Copyright 2016-2021 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the "License"). You may not use this file except in compliance with the License. You can obtain a copy in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>.