X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=src%2Fcommon%2Furi.c;h=3550af9755d22c5c0449cc2f11c8cb2657a4d6df;hp=3a58aedca53f95af2d8e9734eb53fd4fd5f5f4ba;hb=32dd26fbc3c69fe677a7917535e10ace066e674c;hpb=3a5713dad195a7cfa3f4866ad2c75f3a83d73a2f diff --git a/src/common/uri.c b/src/common/uri.c index 3a58aedca..3550af975 100644 --- a/src/common/uri.c +++ b/src/common/uri.c @@ -16,6 +16,7 @@ */ #define _GNU_SOURCE +#include #include #include #include @@ -24,6 +25,7 @@ #include #include +#include #include "uri.h" @@ -32,7 +34,8 @@ enum uri_proto_code { }; struct uri_proto { - char *name; + const char *name; + const char *leading_string; enum uri_proto_code code; enum lttng_proto_type type; enum lttng_dst_type dtype; @@ -40,29 +43,46 @@ struct uri_proto { /* Supported protocols */ static const struct uri_proto proto_uri[] = { - { .name = "file", .code = P_FILE, .type = 0, .dtype = LTTNG_DST_PATH}, - { .name = "net", .code = P_NET, .type = LTTNG_TCP, .dtype = LTTNG_DST_IPV4 }, - { .name = "net6", .code = P_NET6, .type = LTTNG_TCP, .dtype = LTTNG_DST_IPV6 }, - { .name = "tcp", .code = P_TCP, .type = LTTNG_TCP, .dtype = LTTNG_DST_IPV4 }, - { .name = "tcp6", .code = P_TCP6, .type = LTTNG_TCP, .dtype = LTTNG_DST_IPV6 }, - { .name = NULL } + { .name = "file", .leading_string = "file://", .code = P_FILE, .type = 0, .dtype = LTTNG_DST_PATH }, + { .name = "net", .leading_string = "net://", .code = P_NET, .type = LTTNG_TCP, .dtype = LTTNG_DST_IPV4 }, + { .name = "net6", .leading_string = "net6://", .code = P_NET6, .type = LTTNG_TCP, .dtype = LTTNG_DST_IPV6 }, + { .name = "tcp", .leading_string = "tcp://", .code = P_TCP, .type = LTTNG_TCP, .dtype = LTTNG_DST_IPV4 }, + { .name = "tcp6", .leading_string = "tcp6://", .code = P_TCP6, .type = LTTNG_TCP, .dtype = LTTNG_DST_IPV6 }, + /* Invalid proto marking the end of the array. */ + { NULL, NULL, 0, 0, 0 } }; +/* + * Return pointer to the character in s matching one of the characters in + * accept. If nothing is found, return pointer to the end of string (eos). + */ +static const inline char *strpbrk_or_eos(const char *s, const char *accept) +{ + char *p = strpbrk(s, accept); + if (p == NULL) { + p = strchr(s, '\0'); + } + + return p; +} + + /* * Validate if proto is a supported protocol from proto_uri array. */ -static const struct uri_proto *validate_protocol(char *proto) +static const struct uri_proto *get_uri_proto(const char *uri_str) { - const struct uri_proto *supported; + const struct uri_proto *supported = NULL; /* Safety net */ - if (proto == NULL) { + if (uri_str == NULL) { goto end; } for (supported = &proto_uri[0]; - supported->name != NULL; ++supported) { - if (strncmp(proto, supported->name, strlen(proto)) == 0) { + supported->leading_string != NULL; ++supported) { + if (strncasecmp(uri_str, supported->leading_string, + strlen(supported->leading_string)) == 0) { goto end; } } @@ -74,11 +94,90 @@ end: return supported; } +/* + * Set network address from string into dst. Supports both IP string and + * hostname. + */ +static int set_ip_address(const char *addr, int af, char *dst, size_t size) +{ + int ret; + unsigned char buf[sizeof(struct in6_addr)]; + struct hostent *record; + + assert(addr); + assert(dst); + + memset(dst, 0, size); + + /* Network protocol */ + ret = inet_pton(af, addr, buf); + if (ret < 1) { + /* We consider the dst to be an hostname or an invalid IP char */ + record = gethostbyname2(addr, af); + if (record == NULL) { + /* At this point, the IP or the hostname is bad */ + ERR("URI parse bad hostname %s for af %d", addr, af); + goto error; + } + + /* Translate IP to string */ + (void) inet_ntop(af, record->h_addr_list[0], dst, size); + } else { + if (size > 0) { + strncpy(dst, addr, size); + dst[size - 1] = '\0'; + } + } + + DBG2("IP address resolved to %s", dst); + + return 0; + +error: + return -1; +} + +/* + * Build a string URL from a lttng_uri object. + */ +__attribute__((visibility("hidden"))) +int uri_to_str_url(struct lttng_uri *uri, char *dst, size_t size) +{ + int ipver, ret; + const char *addr; + char proto[4], port[7]; + + assert(uri); + assert(dst); + + if (uri->dtype == LTTNG_DST_PATH) { + ipver = 0; + addr = uri->dst.path; + (void) snprintf(proto, sizeof(proto), "file"); + (void) snprintf(port, sizeof(port), "%s", ""); + } else { + ipver = (uri->dtype == LTTNG_DST_IPV4) ? 4 : 6; + addr = (ipver == 4) ? uri->dst.ipv4 : uri->dst.ipv6; + (void) snprintf(proto, sizeof(proto), "net%d", ipver); + (void) snprintf(port, sizeof(port), ":%d", uri->port); + } + + ret = snprintf(dst, size, "%s://%s%s%s%s/%s", proto, + (ipver == 6) ? "[" : "", addr, (ipver == 6) ? "]" : "", + port, uri->subdir); + if (ret < 0) { + PERROR("snprintf uri to url"); + } + + return ret; +} + /* * Compare two URIs. * * Return 0 if equal else 1. */ +__attribute__((visibility("hidden"))) int uri_compare(struct lttng_uri *uri1, struct lttng_uri *uri2) { return memcmp(uri1, uri2, sizeof(struct lttng_uri)); @@ -87,6 +186,7 @@ int uri_compare(struct lttng_uri *uri1, struct lttng_uri *uri2) /* * Free URI memory. */ +__attribute__((visibility("hidden"))) void uri_free(struct lttng_uri *uri) { /* Safety check */ @@ -98,6 +198,7 @@ void uri_free(struct lttng_uri *uri) /* * Return an allocated URI. */ +__attribute__((visibility("hidden"))) struct lttng_uri *uri_create(void) { struct lttng_uri *uri; @@ -110,142 +211,247 @@ struct lttng_uri *uri_create(void) return uri; } -static int set_ip_address(const char *addr, int af, char *dst, size_t size) -{ - int ret; - unsigned char buf[sizeof(struct in6_addr)]; - struct hostent *record; - - /* Network protocol */ - ret = inet_pton(af, addr, buf); - if (ret < 1) { - /* We consider the dst to be an hostname or an invalid IP char */ - record = gethostbyname2(addr, af); - if (record == NULL) { - /* At this point, the IP or the hostname is bad */ - printf("bad hostname\n"); - goto error; - } - - /* Translate IP to string */ - (void) inet_ntop(af, record->h_addr_list[0], dst, size); - } else { - memcpy(dst, addr, size); - } - - return 0; - -error: - return -1; -} - +/* + * Parses a string URI to a lttng_uri. This function can potentially return + * more than one URI in uris so the size of the array is returned and uris is + * allocated and populated. Caller must free(3) the array. + * + * This function can not detect the stream type of the URI so the caller has to + * make sure the correct type (stype) is set on the return URI(s). The default + * port must also be set by the caller if the returned URI has its port set to + * zero. + * + * NOTE: A good part of the following code was inspired from the "wget" source + * tree from the src/url.c file and url_parse() function. Also, the + * strpbrk_or_eos() function found above is also inspired by the same code. + * This code was originally licensed GPLv2 so we acknolwedge the Free Software + * Foundation here for the work and to make sure we are compliant with it. + */ +__attribute__((visibility("hidden"))) ssize_t uri_parse(const char *str_uri, struct lttng_uri **uris) { - int ret; + int ret, i = 0; /* Size of the uris array. Default is 1 */ ssize_t size = 1; - char net[6], dst[LTTNG_MAX_DNNAME + 1]; - unsigned int ctrl_port = DEFAULT_NETWORK_CONTROL_PORT; - unsigned int data_port = DEFAULT_NETWORK_DATA_PORT; - struct lttng_uri *uri; + char subdir[PATH_MAX]; + unsigned int ctrl_port = 0; + unsigned int data_port = 0; + struct lttng_uri *tmp_uris; + char *addr_f = NULL; const struct uri_proto *proto; + const char *purl, *addr_e, *addr_b, *subdir_b = NULL; + const char *seps = ":/\0"; /* * The first part is the protocol portion of a maximum of 5 bytes for now. - * (tcp, tcp6, udp, udp6, file, net). The second part is the hostname or IP - * address. The 255 bytes size is the limit found in the RFC 1035 for the - * total length of a domain name (https://www.ietf.org/rfc/rfc1035.txt). - * Finally, with the net:// protocol, two ports can be specified. + * The second part is the hostname or IP address. The 255 bytes size is the + * limit found in the RFC 1035 for the total length of a domain name + * (https://www.ietf.org/rfc/rfc1035.txt). Finally, for the net:// + * protocol, two ports CAN be specified. */ - ret = sscanf(str_uri, "%5[^:]://", net); - if (ret < 1) { - printf("bad protocol\n"); - goto error; - } - - DBG3("URI protocol : %s", str_uri); + DBG3("URI string: %s", str_uri); - proto = validate_protocol(net); + proto = get_uri_proto(str_uri); if (proto == NULL) { - printf("no protocol\n"); - ret = -1; + ERR("URI parse unknown protocol %s", str_uri); goto error; } + purl = str_uri; + if (proto->code == P_NET || proto->code == P_NET6) { - /* Special case for net:// which requires two URI object */ + /* Special case for net:// which requires two URI objects */ size = 2; } - /* Parse the rest of the URI */ - ret = sscanf(str_uri + strlen(net), "://%255[^:]:%u:%u", dst, - &ctrl_port, &data_port); - if (ret < 0) { - printf("bad URI\n"); + /* Allocate URI array */ + tmp_uris = zmalloc(sizeof(struct lttng_uri) * size); + if (tmp_uris == NULL) { + PERROR("zmalloc uri"); goto error; } - /* We have enough valid information to create URI(s) object */ + memset(subdir, 0, sizeof(subdir)); + purl += strlen(proto->leading_string); - /* Allocate URI array */ - uri = zmalloc(sizeof(struct lttng_uri) * size); - if (uri == NULL) { - PERROR("zmalloc uri"); - goto error; + /* Copy known value to the first URI. */ + tmp_uris[0].dtype = proto->dtype; + tmp_uris[0].proto = proto->type; + + if (proto->code == P_FILE) { + if (*purl != '/') { + ERR("Missing destination full path."); + goto free_error; + } + + strncpy(tmp_uris[0].dst.path, purl, sizeof(tmp_uris[0].dst.path)); + tmp_uris[0].dst.path[sizeof(tmp_uris[0].dst.path) - 1] = '\0'; + DBG3("URI file destination: %s", purl); + goto end; + } + + /* Assume we are at the beginning of an address or host of some sort. */ + addr_b = purl; + + /* + * Handle IPv6 address inside square brackets as mention by RFC 2732. IPv6 + * address that does not start AND end with brackets will be rejected even + * if valid. + * + * proto://[]... + * ^ + */ + if (*purl == '[') { + /* Address begins after '[' */ + addr_b = purl + 1; + addr_e = strchr(addr_b, ']'); + if (addr_e == NULL || addr_b == addr_e) { + ERR("Broken IPv6 address %s", addr_b); + goto free_error; + } + + /* Moving parsed URL pointer after the final bracket ']' */ + purl = addr_e + 1; + + /* + * The closing bracket must be followed by a seperator or NULL char. + */ + if (strchr(seps, *purl) == NULL) { + ERR("Unknown symbol after IPv6 address: %s", purl); + goto free_error; + } + } else { + purl = strpbrk_or_eos(purl, seps); + addr_e = purl; + } + + /* Check if we at least have a char for the addr or hostname. */ + if (addr_b == addr_e) { + ERR("No address or hostname detected."); + goto free_error; } + addr_f = utils_strdupdelim(addr_b, addr_e); + if (addr_f == NULL) { + goto free_error; + } + + /* + * Detect PORT after address. The net/net6 protocol allows up to two port + * so we can define the control and data port. + */ + while (*purl == ':') { + int port; + const char *port_b, *port_e; + char *port_f; + + /* Update pass counter */ + i++; + + /* + * Maximum of two ports is possible if P_NET/NET6. Bigger than that, + * two much stuff. + */ + if ((i == 2 && (proto->code != P_NET && proto->code != P_NET6)) + || i > 2) { + break; + } + + /* + * Move parsed URL to port value. + * proto://addr_host:PORT1:PORT2/foo/bar + * ^ + */ + ++purl; + port_b = purl; + purl = strpbrk_or_eos(purl, seps); + port_e = purl; + + if (port_b != port_e) { + port_f = utils_strdupdelim(port_b, port_e); + if (port_f == NULL) { + goto free_error; + } + + port = atoi(port_f); + if (port > 0xffff || port <= 0x0) { + ERR("Invalid port number %d", port); + free(port_f); + goto free_error; + } + free(port_f); + + if (i == 1) { + ctrl_port = port; + } else { + data_port = port; + } + } + }; + + /* Check for a valid subdir or trailing garbage */ + if (*purl == '/') { + /* + * Move to subdir value. + * proto://addr_host:PORT1:PORT2/foo/bar + * ^ + */ + ++purl; + subdir_b = purl; + } else if (*purl != '\0') { + ERR("Trailing characters not recognized: %s", purl); + goto free_error; + } + + /* We have enough valid information to create URI(s) object */ + /* Copy generic information */ - uri[0].dtype = proto->dtype; - uri[0].proto = proto->type; - uri[0].port = ctrl_port; + tmp_uris[0].port = ctrl_port; - DBG3("URI dtype: %d, proto: %d, port: %d", proto->dtype, proto->type, - ctrl_port); + /* Copy subdirectory if one. */ + if (subdir_b) { + strncpy(tmp_uris[0].subdir, subdir_b, sizeof(tmp_uris[0].subdir)); + tmp_uris[0].subdir[sizeof(tmp_uris[0].subdir) - 1] = '\0'; + } switch (proto->code) { - case P_FILE: - memcpy(uri[0].dst.path, dst, sizeof(uri[0].dst.path)); - /* Reset port for the file:// URI */ - uri[0].port = 0; - DBG3("URI file destination: %s", dst); - break; case P_NET: - ret = set_ip_address(dst, AF_INET, uri[0].dst.ipv4, - sizeof(uri[0].dst.ipv4)); + ret = set_ip_address(addr_f, AF_INET, tmp_uris[0].dst.ipv4, + sizeof(tmp_uris[0].dst.ipv4)); if (ret < 0) { goto free_error; } - memcpy(uri[1].dst.ipv4, uri[0].dst.ipv4, sizeof(uri[1].dst.ipv4)); + memcpy(tmp_uris[1].dst.ipv4, tmp_uris[0].dst.ipv4, sizeof(tmp_uris[1].dst.ipv4)); - uri[1].dtype = proto->dtype; - uri[1].proto = proto->type; - uri[1].port = data_port; + tmp_uris[1].dtype = proto->dtype; + tmp_uris[1].proto = proto->type; + tmp_uris[1].port = data_port; break; case P_NET6: - ret = set_ip_address(dst, AF_INET6, uri[0].dst.ipv6, - sizeof(uri[0].dst.ipv6)); + ret = set_ip_address(addr_f, AF_INET6, tmp_uris[0].dst.ipv6, + sizeof(tmp_uris[0].dst.ipv6)); if (ret < 0) { goto free_error; } - memcpy(uri[1].dst.ipv6, uri[0].dst.ipv6, sizeof(uri[1].dst.ipv6)); + memcpy(tmp_uris[1].dst.ipv6, tmp_uris[0].dst.ipv6, sizeof(tmp_uris[1].dst.ipv6)); - uri[1].dtype = proto->dtype; - uri[1].proto = proto->type; - uri[1].port = data_port; + tmp_uris[1].dtype = proto->dtype; + tmp_uris[1].proto = proto->type; + tmp_uris[1].port = data_port; break; case P_TCP: - ret = set_ip_address(dst, AF_INET, uri[0].dst.ipv4, - sizeof(uri[0].dst.ipv4)); + ret = set_ip_address(addr_f, AF_INET, tmp_uris[0].dst.ipv4, + sizeof(tmp_uris[0].dst.ipv4)); if (ret < 0) { goto free_error; } break; case P_TCP6: - ret = set_ip_address(dst, AF_INET6, uri[0].dst.ipv6, - sizeof(uri[0].dst.ipv6)); + ret = set_ip_address(addr_f, AF_INET6, tmp_uris[0].dst.ipv6, + sizeof(tmp_uris[0].dst.ipv6)); if (ret < 0) { goto free_error; } @@ -254,12 +460,19 @@ ssize_t uri_parse(const char *str_uri, struct lttng_uri **uris) goto free_error; } - *uris = uri; +end: + DBG3("URI dtype: %d, proto: %d, host: %s, subdir: %s, ctrl: %d, data: %d", + proto->dtype, proto->type, (addr_f == NULL) ? "" : addr_f, + (subdir_b == NULL) ? "" : subdir_b, ctrl_port, data_port); + + free(addr_f); + *uris = tmp_uris; return size; free_error: - free(uri); + free(addr_f); + free(tmp_uris); error: return -1; }