Skip to content

Commit

Permalink
Fixed local ip lookup on macOS GitHub instances.
Browse files Browse the repository at this point in the history
myIpAddress() and myIpAddressEx() should be enumerating the network interfaces
and returning the local addresses with getifaddrs/GetAdapterAddresses.

Where as, dnsResolve() and dnsResolveEx() enumerates resolved host
names using getaddrinfo.
  • Loading branch information
nmoinvaz committed Dec 12, 2023
1 parent 75e368c commit 6cf4e27
Show file tree
Hide file tree
Showing 7 changed files with 202 additions and 132 deletions.
18 changes: 9 additions & 9 deletions execute_jscore.c
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,7 @@ static JSValueRef proxy_execute_jscore_dns_resolve_ex(JSContextRef ctx, JSObject

static JSValueRef proxy_execute_jscore_my_ip_address(JSContextRef ctx, JSObjectRef function, JSObjectRef object,
size_t argc, const JSValueRef argv[], JSValueRef *exception) {
char *address = dns_resolve(NULL, NULL);
char *address = my_ip_address();
if (!address)
return NULL;

Expand All @@ -216,18 +216,18 @@ static JSValueRef proxy_execute_jscore_my_ip_address(JSContextRef ctx, JSObjectR

static JSValueRef proxy_execute_jscore_my_ip_address_ex(JSContextRef ctx, JSObjectRef function, JSObjectRef object,
size_t argc, const JSValueRef argv[], JSValueRef *exception) {
char *address = dns_resolve_ex(NULL, NULL);
if (!address)
char *addresses = my_ip_address_ex();
if (!addresses)
return NULL;

JSStringRef address_string = g_proxy_execute_jscore.JSStringCreateWithUTF8CString(address);
free(address);
if (!address_string)
JSStringRef addresses_string = g_proxy_execute_jscore.JSStringCreateWithUTF8CString(addresses);
free(addresses);
if (!addresses_string)
return NULL;

JSValueRef address_value = g_proxy_execute_jscore.JSValueMakeString(ctx, address_string);
g_proxy_execute_jscore.JSStringRelease(address_string);
return address_value;
JSValueRef addresses_value = g_proxy_execute_jscore.JSValueMakeString(ctx, addresses_string);
g_proxy_execute_jscore.JSStringRelease(addresses_string);
return addresses_value;
}

bool proxy_execute_register_function(void *ctx, JSGlobalContextRef global, const char *name,
Expand Down
4 changes: 2 additions & 2 deletions execute_wsh_dispatch.h
Original file line number Diff line number Diff line change
Expand Up @@ -146,9 +146,9 @@ static HRESULT STDMETHODCALLTYPE script_dispatch_invoke(IDispatch *dispatch, DIS
char *ip = NULL;

if (disp_id == SCRIPT_DISPATCH_MY_IP_ADDRESS_EX_ID)
ip = dns_resolve_ex(NULL, NULL);
ip = my_ip_address_ex();
else
ip = dns_resolve(NULL, NULL);
ip = my_ip_address();

if (!ip)
return E_FAIL;
Expand Down
169 changes: 119 additions & 50 deletions net_util.c
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <errno.h>

#ifdef _WIN32
# include <winsock2.h>
Expand All @@ -16,104 +17,172 @@
# include <unistd.h>
#endif

#include "net_adapter.h"
#include "util.h"

typedef struct address_list {
int32_t family;
int32_t max_addrs;
char *string;
size_t string_len;
size_t max_string;
} address_list;

// Calculate the max length of the address string
static bool my_ip_address_list_length(void *user_data, net_adapter_s *adapter) {
address_list *list = (address_list *)user_data;
// Use different length depending on the address type
list->max_string += ((list->family == AF_INET) ? INET_ADDRSTRLEN : INET6_ADDRSTRLEN);
// Add room for semi-colon separators
list->max_string += 2;
return true;
}

// Copy each localhost address into a string buffer seperated by semi-colons
static bool my_ip_address_list_populate(void *user_data, net_adapter_s *adapter) {
address_list *list = (address_list *)user_data;

if (!list->max_addrs || !adapter->is_connected || !*adapter->ip)
return true;

#ifdef _WIN32
if (!adapter->is_dhcp_v4)
return true;
#endif

if (list->family == AF_INET || list->family == AF_UNSPEC) {
char ip_str[INET_ADDRSTRLEN] = {0};
inet_ntop(AF_INET, adapter->ip, ip_str, sizeof(ip_str));
strncat(list->string + list->string_len, ip_str, list->max_string - list->string_len - 1);
list->string_len += strlen(ip_str);
}

if (adapter->is_ipv6 && (list->family == AF_INET6 || list->family == AF_UNSPEC)) {
// Append semi-colon separator
if (list->max_string - list->string_len > 1) {
list->string[list->string_len++] = ';';
list->string[list->string_len] = 0;
}

Check warning on line 65 in net_util.c

View check run for this annotation

Codecov / codecov/patch

net_util.c#L65

Added line #L65 was not covered by tests

char ipv6_str[INET6_ADDRSTRLEN] = {0};
inet_ntop(AF_INET6, adapter->ipv6, ipv6_str, sizeof(ipv6_str));
strncat(list->string + list->string_len, ipv6_str, list->max_string - list->string_len - 1);
list->string_len += strlen(ipv6_str);
}

Check warning on line 71 in net_util.c

View check run for this annotation

Codecov / codecov/patch

net_util.c#L71

Added line #L71 was not covered by tests

list->max_addrs--;

// Append semi-colon separator
if (list->max_addrs && list->max_string - list->string_len > 1) {
list->string[list->string_len++] = ';';
list->string[list->string_len] = 0;
}
return true;
}

// Enumerate network adapters and get localhost addresses with a filter
static char *my_ip_address_filter(int32_t family, int32_t max_addrs) {
address_list list = {family, max_addrs, NULL, 0, 1};
int32_t err = 0;

if (!net_adapter_enum(&list, my_ip_address_list_length))
return NULL;

Check warning on line 89 in net_util.c

View check run for this annotation

Codecov / codecov/patch

net_util.c#L89

Added line #L89 was not covered by tests

// Allocate buffer for the return string
list.string = (char *)calloc(1, list.max_string);
if (list.string) {
if (!net_adapter_enum(&list, my_ip_address_list_populate)) {
free(list.string);
list.string = NULL;
}

Check warning on line 97 in net_util.c

View check run for this annotation

Codecov / codecov/patch

net_util.c#L95-L97

Added lines #L95 - L97 were not covered by tests
}

return list.string;
}

// Get local IPv4 address for localhost
char *my_ip_address(void) {
return my_ip_address_filter(AF_INET, 1);
}

// Get local IPv6 and IPv6 addresses for localhost
char *my_ip_address_ex(void) {
return my_ip_address_filter(AF_UNSPEC, UINT8_MAX);
}

// Resolve a host name to its addresses with a filter and custom separator
static char *dns_resolve_filter(const char *host, int32_t family, uint8_t max_addrs, int32_t *error) {
char name[HOST_MAX] = {0};
address_list list = {family, max_addrs, NULL, 0, 1};
struct addrinfo hints = {0};
struct addrinfo *address_info = NULL;
struct addrinfo *address = NULL;
char *ai_string = NULL;
size_t ai_string_len = 0;
int32_t err = 0;

// If no host supplied, then use local machine name
if (!host) {
err = gethostname(name, sizeof(name));
if (err != 0)
goto dns_resolve_error;
} else {
// Otherwise copy the host provided
strncat(name, host, sizeof(name) - 1);
if (error)
*error = EINVAL;
return NULL;

Check warning on line 124 in net_util.c

View check run for this annotation

Codecov / codecov/patch

net_util.c#L123-L124

Added lines #L123 - L124 were not covered by tests
}

hints.ai_flags = AI_NUMERICHOST;
hints.ai_family = PF_UNSPEC;
hints.ai_family = family;
hints.ai_socktype = SOCK_STREAM;
hints.ai_protocol = IPPROTO_TCP;

err = getaddrinfo(name, NULL, &hints, &address_info);
if (err != EAI_NONAME) {
if (err != 0)
goto dns_resolve_error;

// Name is already an IP address
freeaddrinfo(address_info);
return strdup(name);
}

hints.ai_flags = 0;
err = getaddrinfo(name, NULL, &hints, &address_info);
err = getaddrinfo(host, NULL, &hints, &address_info);
if (err != 0)
goto dns_resolve_error;

// Calculate the length of the return string
size_t max_ai_string = 1;
address = address_info;
while (address) {
// Use different length depending on the address type
if (address->ai_family == AF_INET)
max_ai_string += INET_ADDRSTRLEN;
else
max_ai_string += INET6_ADDRSTRLEN;

list.max_string += (address->ai_family == AF_INET) ? INET_ADDRSTRLEN : INET6_ADDRSTRLEN;
// Add room for semi-colon separator
max_ai_string++;
list.max_string++;
address = address->ai_next;
}

// Allocate buffer for the return string
ai_string = (char *)calloc(1, max_ai_string);
if (!ai_string)
list.string = (char *)calloc(1, list.max_string);
if (!list.string)
goto dns_resolve_error;

// Enumerate each address
address = address_info;
while (address && max_addrs) {
while (address && list.max_addrs) {
// Only copy addresses that match the family filter
if (family == AF_UNSPEC || address->ai_family == family) {
if (list.family == AF_UNSPEC || address->ai_family == list.family) {
// Ensure there is room to copy something into return string buffer
if (ai_string_len >= max_ai_string)
if (list.string_len >= list.max_string)
break;

// Copy address name into return string
err = getnameinfo(address->ai_addr, (socklen_t)address->ai_addrlen, ai_string + ai_string_len,
(uint32_t)(max_ai_string - ai_string_len), NULL, 0, NI_NUMERICHOST);
if (err != 0)
goto dns_resolve_error;
// Convert address name into a numeric host string
err = getnameinfo(address->ai_addr, (socklen_t)address->ai_addrlen, list.string + list.string_len,
(uint32_t)(list.max_string - list.string_len), NULL, 0, NI_NUMERICHOST);
if (err != 0) {
continue;

Check warning on line 162 in net_util.c

View check run for this annotation

Codecov / codecov/patch

net_util.c#L162

Added line #L162 was not covered by tests
}

max_addrs--;
list.max_addrs--;

// Append semi-colon separator
ai_string_len = strlen(ai_string);
if (max_addrs && address->ai_next && ai_string_len + 1 < max_ai_string) {
ai_string[ai_string_len++] = ';';
ai_string[ai_string_len] = 0;
list.string_len = strlen(list.string);
if (list.max_addrs && address->ai_next && list.string_len + 1 < list.max_string) {
list.string[list.string_len++] = ';';
list.string[list.string_len] = 0;
}
}

address = address->ai_next;
}

if (err != 0)
if (err != 0 && list.string_len == 0)
goto dns_resolve_error;

return ai_string;
return list.string;

dns_resolve_error:

free(ai_string);
free(list.string);

if (address_info)
freeaddrinfo(address_info);
Expand Down
8 changes: 7 additions & 1 deletion net_util.h
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,16 @@
extern "C" {
#endif

// Get local IPv4 address for localhost
char *my_ip_address(void);

// Get local IPv6 and IPv6 addresses for localhost
char *my_ip_address_ex(void);

// Resolve a host name to it an IPv4 address
char *dns_resolve(const char *host, int32_t *error);

// Resolve a host name to its addresses
// Resolve a host name to its IPv6 and IPv6 addresses
char *dns_resolve_ex(const char *host, int32_t *error);

// Check if the ipv4 address matches the cidr notation range
Expand Down
8 changes: 4 additions & 4 deletions test/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ if(PROXYRES_BUILD_CLI)
uwp/Square150x150Logo.png
uwp/StoreLogo.png
uwp/Package.appxmanifest)
set_source_files_properties(${PROXYCLI_ASSETS} PROPERTIES

set_source_files_properties(${PROXYCLI_ASSETS} PROPERTIES
VS_DEPLOYMENT_CONTENT 1
VS_DEPLOYMENT_LOCATION "Assets")
endif()
Expand Down Expand Up @@ -85,6 +85,8 @@ if(PROXYRES_BUILD_TESTS)
set(TEST_SRCS
test_config.cc
test_main.cc
test_net_util.cc
test_net_adapter.cc
test_threadpool.cc
test_util.cc)
if(WIN32)
Expand All @@ -96,10 +98,8 @@ if(PROXYRES_BUILD_TESTS)
endif()
if(PROXYRES_EXECUTE)
list(APPEND TEST_SRCS
test_dns.cc
test_execute.cc
test_fetch.cc
test_net_adapter.cc
test_wpad.cc)
endif()

Expand Down
8 changes: 2 additions & 6 deletions test/test_execute.cc
Original file line number Diff line number Diff line change
Expand Up @@ -74,9 +74,7 @@ INSTANTIATE_TEST_SUITE_P(execute, execute, testing::ValuesIn(execute_tests));

// Construct expected output for myip test case
static char *expected_my_ip(void) {
int32_t error = 0;
char *address = dns_resolve(NULL, &error);
EXPECT_EQ(error, 0);
char *address = my_ip_address();
if (!address)
return NULL;

Expand All @@ -92,9 +90,7 @@ static char *expected_my_ip(void) {

// Construct expected output for myipex test case
static char *expected_my_ip_ex(void) {
int32_t error = 0;
char *addresses = dns_resolve_ex(NULL, &error);
EXPECT_EQ(error, 0);
char *addresses = my_ip_address_ex();
if (!addresses)
return NULL;

Expand Down
Loading

0 comments on commit 6cf4e27

Please sign in to comment.