/***************************************************************************/ /* Copyright (c) 2024 Microsoft Corporation */ /* Copyright (c) 2026 Eclipse ThreadX contributors */ /* */ /* This program and the accompanying materials are made available under */ /* the terms of the MIT License which is available at */ /* https://opensource.org/licenses/MIT. */ /* */ /* SPDX-License-Identifier: MIT */ /***************************************************************************/ /* This NetX test concentrates on DNS operation with invalid resource in DNS response packet. */ #include "tx_api.h" #include "nx_api.h" #include "nx_udp.h" #include "nxd_dns.h" extern char invalid_response_ptr_0[119]; extern UINT invalid_response_size_0; extern char invalid_response_ptr_1[119]; extern UINT invalid_response_size_1; extern char invalid_response_ptr_2[119]; extern UINT invalid_response_size_2; extern char invalid_response_ptr_3[119]; extern UINT invalid_response_size_3; extern void test_control_return(UINT status); #if !defined(NX_DISABLE_IPV4) #define DEMO_STACK_SIZE 2048 /* Define the ThreadX and NetX object control blocks... */ static TX_THREAD thread_0; static TX_THREAD thread_1; static NX_PACKET_POOL pool_0; static NX_IP client_ip; static NX_IP server_ip; static NX_UDP_SOCKET server_socket; static NX_DNS client_dns; #define DNS_SERVER_ADDRESS IP_ADDRESS(10,0,0,1) #ifdef NX_DNS_CLIENT_USER_CREATE_PACKET_POOL NX_PACKET_POOL client_pool; #endif /* Define the counters used in the demo application... */ static UINT status; static ULONG error_counter; static ULONG notify_calls = 0; static UCHAR record_buffer[500]; static UINT record_count; /* Define thread prototypes. */ static void thread_0_entry(ULONG thread_input); static void thread_1_entry(ULONG thread_input); extern void _nx_ram_network_driver_512(struct NX_IP_DRIVER_STRUCT *driver_req); static void receive_packet_function(NX_UDP_SOCKET *socket_ptr); /* DNS Tests. */ static void dns_test_initialize(); /* Send DNS response. */ static UINT nx_dns_response_packet_send(NX_UDP_SOCKET *server_socket, UINT port, USHORT nx_dns_transmit_id, UINT packet_number); /* Send DNS query. */ static UINT nx_dns_query_packet_send(); typedef struct DNS_TEST_STRUCT { char *dns_test_pkt_data; UINT dns_test_pkt_size; } DNS_TEST; #define test_count 4 static DNS_TEST dns_test[test_count]; extern ULONG test_control_successful_tests; extern ULONG test_control_failed_tests; #define DNS_START_OFFSET (14 + 20 + 8) /* Define what the initial system looks like. */ #ifdef CTEST VOID test_application_define(void *first_unused_memory) #else void netx_dns_invalid_resource_get_test_application_define(void *first_unused_memory) #endif { CHAR *pointer; /* Setup the working pointer. */ pointer = (CHAR *) first_unused_memory; /* Create the DNS main thread. */ tx_thread_create(&thread_0, "thread 0", thread_0_entry, 0, pointer, DEMO_STACK_SIZE, 4, 4, TX_NO_TIME_SLICE, TX_AUTO_START); pointer = pointer + DEMO_STACK_SIZE; /* . */ tx_thread_create(&thread_1, "thread 1", thread_1_entry, 0, pointer, DEMO_STACK_SIZE, 3, 3, TX_NO_TIME_SLICE, TX_AUTO_START); pointer = pointer + DEMO_STACK_SIZE; /* Initialize the NetX system. */ nx_system_initialize(); /* Create a packet pool. */ status = nx_packet_pool_create(&pool_0, "NetX Main Packet Pool", 1500, pointer, 8192); pointer = pointer + 8192; #ifdef NX_DNS_CLIENT_USER_CREATE_PACKET_POOL /* Create the packet pool for the DNS Client to send packets. If the DNS Client is configured for letting the host application create the DNS packet pool, (see NX_DNS_CLIENT_USER_CREATE_PACKET_POOL option), see nx_dns_create() for guidelines on packet payload size and pool size. packet traffic for NetX Duo processes. */ status = nx_packet_pool_create(&client_pool, "DNS Client Packet Pool", NX_DNS_PACKET_PAYLOAD, pointer, NX_DNS_PACKET_POOL_SIZE); pointer = pointer + NX_DNS_PACKET_POOL_SIZE; /* Check for pool creation error. */ if (status) return; #endif /* Check for pool creation error. */ if (status) error_counter++; /* Create an IP instance. */ status = nx_ip_create(&client_ip, "NetX IP Instance 0", IP_ADDRESS(10, 0, 0, 10), 0xFFFFFF00UL, &pool_0, _nx_ram_network_driver_512, pointer, 2048, 1); pointer = pointer + 2048; /* Create another IP instance. */ status += nx_ip_create(&server_ip, "NetX IP Instance 1", IP_ADDRESS(10, 0, 0, 1), 0xFFFFFF00UL, &pool_0, _nx_ram_network_driver_512, pointer, 2048, 1); pointer = pointer + 2048; /* Check for IP create errors. */ if (status) error_counter++; /* Enable ARP and supply ARP cache memory for IP Instance 0. */ status = nx_arp_enable(&client_ip, (void *) pointer, 1024); pointer = pointer + 1024; /* Enable ARP and supply ARP cache memory for IP Instance 1. */ status += nx_arp_enable(&server_ip, (void *) pointer, 1024); pointer = pointer + 1024; /* Check for ARP enable errors. */ if (status) error_counter++; /* Enable UDP traffic. */ status = nx_udp_enable(&client_ip); status += nx_udp_enable(&server_ip); /* Check for UDP enable errors. */ if (status) error_counter++; } /* Define the test threads. */ static void thread_0_entry(ULONG thread_input) { UINT i; /* Create a DNS instance for the Client. Note this function will create the DNS Client packet pool for creating DNS message packets intended for querying its DNS server. */ status = nx_dns_create(&client_dns, &client_ip, (UCHAR *)"DNS Client"); /* Is the DNS client configured for the host application to create the pecket pool? */ #ifdef NX_DNS_CLIENT_USER_CREATE_PACKET_POOL /* Yes, use the packet pool created above which has appropriate payload size for DNS messages. */ status = nx_dns_packet_pool_set(&client_dns, &client_pool); /* Check for set DNS packet pool error. */ if (status) { error_counter++; } #endif /* NX_DNS_CLIENT_USER_CREATE_PACKET_POOL */ /* Add an IPv4 server address to the Client list. */ status = nx_dns_server_add(&client_dns, DNS_SERVER_ADDRESS); if (status) { error_counter++; } /* The DNS test initialize. */ dns_test_initialize(); printf("Begin test\n"); nx_dns_query_packet_send(); test_control_return(0xdeadbeef); } static void thread_1_entry(ULONG thread_input) { NX_PACKET *my_packet; UINT port; UINT i; USHORT nx_dns_transmit_id; UCHAR *data_ptr; /* Create a UDP socket act as the DNS server. */ status = nx_udp_socket_create(&server_ip, &server_socket, "Socket 1", NX_IP_NORMAL, NX_FRAGMENT_OKAY, 0x80, 5); /* Check status. */ if (status) { error_counter++; } /* Register the receive notify function. */ status = nx_udp_socket_receive_notify(&server_socket, receive_packet_function); /* Check status. */ if (status) { error_counter++; } /* Bind the UDP socket to the IP port. */ status = nx_udp_socket_bind(&server_socket, 53, TX_WAIT_FOREVER); /* Act as the DNS server to receive the DNS query and send the DNS response. */ for (i = 0; i < test_count; i++ ) { /* Receive a UDP packet. */ status = nx_udp_socket_receive(&server_socket, &my_packet, 10 * NX_IP_PERIODIC_RATE); /* Check status. */ if (status) { error_counter++; return; } /* Get the DNS client UDP port. */ status = nx_udp_packet_info_extract(my_packet, NX_NULL ,NX_NULL, &port, NX_NULL); /* Check status. */ if (status) { error_counter++; return; } /* Get the DNS transmit ID. */ data_ptr = my_packet -> nx_packet_prepend_ptr + NX_DNS_ID_OFFSET; nx_dns_transmit_id = *data_ptr++; nx_dns_transmit_id = (USHORT)((nx_dns_transmit_id << 8) | *data_ptr); /* Release the packet. */ nx_packet_release(my_packet); /* Send the DNS response packet. */ status = nx_dns_response_packet_send(&server_socket, port, nx_dns_transmit_id, i); /* Check status. */ if (status) { error_counter++; return; } } /* Unbind the UDP socket. */ status = nx_udp_socket_unbind(&server_socket); /* Check status. */ if (status) { error_counter++; return; } /* Delete the UDP socket. */ status = nx_udp_socket_delete(&server_socket); /* Check status. */ if (status) { error_counter++; return; } /* Let the DNS threads execute. */ tx_thread_relinquish(); } static void receive_packet_function(NX_UDP_SOCKET *socket_ptr) { if (socket_ptr == &server_socket) notify_calls++; } static UINT nx_dns_response_packet_send(NX_UDP_SOCKET *server_socket, UINT port, USHORT nx_dns_transmit_id, UINT packet_number) { UINT status; NX_PACKET *response_packet; UCHAR *data_ptr; /* Allocate a response packet. */ status = nx_packet_allocate(&pool_0, &response_packet, NX_UDP_PACKET, TX_WAIT_FOREVER); /* Check status. */ if (status) { error_counter++; } /* Write the DNS response messages into the packet payload! */ dns_test[packet_number].dns_test_pkt_data += DNS_START_OFFSET; memcpy(response_packet -> nx_packet_prepend_ptr, dns_test[packet_number].dns_test_pkt_data, dns_test[packet_number].dns_test_pkt_size - DNS_START_OFFSET); /* Adjust the write pointer. */ response_packet -> nx_packet_length = dns_test[packet_number].dns_test_pkt_size - DNS_START_OFFSET; response_packet -> nx_packet_append_ptr = response_packet -> nx_packet_prepend_ptr + response_packet -> nx_packet_length; /* Update the DNS transmit ID. */ data_ptr = response_packet -> nx_packet_prepend_ptr + NX_DNS_ID_OFFSET; *data_ptr++ = (UCHAR)(nx_dns_transmit_id >> 8); *data_ptr = (UCHAR)nx_dns_transmit_id; /* Send the UDP packet with the correct port. */ status = nx_udp_socket_send(server_socket, response_packet, IP_ADDRESS(10, 0, 0, 10), port); /* Check the status. */ if (status) nx_packet_release(response_packet); return status; } static UINT nx_dns_query_packet_send() { UINT status; UINT i; for (i = 0; i < test_count; i++) { printf("NetX Test: DNS Test [%u] with invalid resource in response ........", i); status = nx_dns_ipv4_address_by_name_get(&client_dns, (UCHAR *)"berkeley.edu", &record_buffer[0], 500, &record_count, 2 * NX_IP_PERIODIC_RATE); /* Check the record buffer. */ if (!status) { error_counter++; } /* Printf the test result. */ if (error_counter) { printf("ERROR!\n"); test_control_failed_tests++; } else { printf("SUCCESS!\n"); test_control_successful_tests++; } } return 0; } static void dns_test_initialize() { dns_test[0].dns_test_pkt_data = &invalid_response_ptr_2[0]; dns_test[0].dns_test_pkt_size = invalid_response_size_2; dns_test[1].dns_test_pkt_data = &invalid_response_ptr_1[0]; dns_test[1].dns_test_pkt_size = invalid_response_size_1; dns_test[2].dns_test_pkt_data = &invalid_response_ptr_2[0]; dns_test[2].dns_test_pkt_size = invalid_response_size_2; dns_test[3].dns_test_pkt_data = &invalid_response_ptr_3[0]; dns_test[3].dns_test_pkt_size = invalid_response_size_3; return; } #else #ifdef CTEST VOID test_application_define(void *first_unused_memory) #else void netx_dns_invalid_resource_get_test_application_define(void *first_unused_memory) #endif { /* Print out test information banner. */ printf("NetX Test: DNS Invalid Resource Get Test.........................................N/A\n"); test_control_return(3); } #endif