Refactoring BIO: add wrappers around sockaddr et al
Because different platforms have different levels of support for IPv6,
different kinds of sockaddr variants, and some have getaddrinfo et al
while others don't, we could end up with a mess if ifdefs, duplicate
code and other maintainance nightmares.
Instead, we're introducing wrappers around the common form for socket
communication:
BIO_ADDR, closely related to struct sockaddr and some of its variants.
BIO_ADDRINFO, closely related to struct addrinfo.
With that comes support routines, both convenient creators and
accessors, plus a few utility functions:
BIO_parse_hostserv, takes a string of the form host:service and
splits it into host and service. It checks for * in both parts, and
converts any [ipv6-address] syntax to ust the IPv6 address.
BIO_lookup, looks up information on a host.
All routines handle IPv4 (AF_INET) and IPv6 (AF_INET6) addresses, and
there is support for local sockets (AF_UNIX) as well.
Reviewed-by: Kurt Roeckx <kurt@openssl.org>
2016-02-02 22:54:57 +08:00
|
|
|
=pod
|
|
|
|
|
|
|
|
|
|
=head1 NAME
|
|
|
|
|
|
|
|
|
|
BIO_parse_hostserv - utility routines to parse a standard host and service
|
|
|
|
|
string
|
|
|
|
|
|
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
|
|
|
|
|
|
#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);
|
|
|
|
|
|
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
|
|
|
|
|
|
BIO_parse_hostserv() will parse the information given in B<hostserv>,
|
|
|
|
|
create strings with the host name and service name and give those
|
|
|
|
|
back via B<host> and B<service>. Those will need to be freed after
|
|
|
|
|
they are used. B<hostserv_prio> helps determine if B<hostserv> shall
|
|
|
|
|
be interpreted primarly as a host name or a service name in ambiguous
|
|
|
|
|
cases.
|
|
|
|
|
|
|
|
|
|
The syntax the BIO_parse_hostserv() recognises is:
|
|
|
|
|
|
|
|
|
|
host + ':' + service
|
|
|
|
|
host + ':' + '*'
|
|
|
|
|
host + ':'
|
|
|
|
|
':' + service
|
|
|
|
|
'*' + ':' + service
|
|
|
|
|
host
|
|
|
|
|
service
|
|
|
|
|
|
|
|
|
|
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.
|
|
|
|
|
|
|
|
|
|
The returned values will depend on the given B<hostserv> string
|
|
|
|
|
and B<hostserv_prio>, as follows:
|
|
|
|
|
|
2016-02-09 04:42:00 +08:00
|
|
|
=for comment
|
|
|
|
|
The following is ONE verbatim block. To make sure it's rendered as
|
|
|
|
|
one block and not several, the blank lines in between have one space.
|
|
|
|
|
They should be left as is.
|
|
|
|
|
|
Refactoring BIO: add wrappers around sockaddr et al
Because different platforms have different levels of support for IPv6,
different kinds of sockaddr variants, and some have getaddrinfo et al
while others don't, we could end up with a mess if ifdefs, duplicate
code and other maintainance nightmares.
Instead, we're introducing wrappers around the common form for socket
communication:
BIO_ADDR, closely related to struct sockaddr and some of its variants.
BIO_ADDRINFO, closely related to struct addrinfo.
With that comes support routines, both convenient creators and
accessors, plus a few utility functions:
BIO_parse_hostserv, takes a string of the form host:service and
splits it into host and service. It checks for * in both parts, and
converts any [ipv6-address] syntax to ust the IPv6 address.
BIO_lookup, looks up information on a host.
All routines handle IPv4 (AF_INET) and IPv6 (AF_INET6) addresses, and
there is support for local sockets (AF_UNIX) as well.
Reviewed-by: Kurt Roeckx <kurt@openssl.org>
2016-02-02 22:54:57 +08:00
|
|
|
host + ':' + service => *host = "host", *service = "service"
|
|
|
|
|
host + ':' + '*' => *host = "host", *service = NULL
|
|
|
|
|
host + ':' => *host = "host", *service = NULL
|
|
|
|
|
':' + service => *host = NULL, *service = "service"
|
|
|
|
|
'*' + ':' + service => *host = NULL, *service = "service"
|
|
|
|
|
|
|
|
|
|
in case no ':' 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"
|
|
|
|
|
|
|
|
|
|
=head1 SEE ALSO
|
|
|
|
|
|
|
|
|
|
L<BIO_ADDRINFO(3)>
|