xref: /FreeRTOS-Plus-TCP-v4.0.0/source/include/FreeRTOS_DNS_Parser.h (revision 2d3f4daa567ffe71aeda2e0f6d0bc02850db0627) 
1 /*
2  * FreeRTOS+TCP <DEVELOPMENT BRANCH>
3  * Copyright (C) 2022 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
4  *
5  * SPDX-License-Identifier: MIT
6  *
7  * Permission is hereby granted, free of charge, to any person obtaining a copy of
8  * this software and associated documentation files (the "Software"), to deal in
9  * the Software without restriction, including without limitation the rights to
10  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
11  * the Software, and to permit persons to whom the Software is furnished to do so,
12  * subject to the following conditions:
13  *
14  * The above copyright notice and this permission notice shall be included in all
15  * copies or substantial portions of the Software.
16  *
17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
19  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
20  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
21  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
22  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
23  *
24  * https://github.com/FreeRTOS
25  * https://www.FreeRTOS.org
26  */
27 
28 #ifndef FREERTOS_DNS_PARSER_H
29 #define FREERTOS_DNS_PARSER_H
30 
31 /* FreeRTOS includes. */
32 #include "FreeRTOS.h"
33 
34 /* FreeRTOS+TCP includes. */
35 #include "FreeRTOS_IP.h"
36 
37 #include "FreeRTOS_DNS_Globals.h"
38 
39 /* Standard includes. */
40 #include <stdint.h>
41 #if ( ipconfigUSE_DNS != 0 )
42 
43 /** @brief Flag DNS parsing errors in situations where an IPv4 address is the return
44  * type. */
45 
46     #if ( ipconfigUSE_DNS_CACHE == 1 ) || ( ipconfigDNS_USE_CALLBACKS == 1 )
47         size_t DNS_ReadNameField( ParseSet_t * pxSet,
48                                   size_t uxDestLen );
49     #endif /* ipconfigUSE_DNS_CACHE || ipconfigDNS_USE_CALLBACKS */
50 
51 /*
52  * Simple routine that jumps over the NAME field of a resource record.
53  * It returns the number of bytes read.
54  */
55     size_t DNS_SkipNameField( const uint8_t * pucByte,
56                               size_t uxLength );
57 
58 /*
59  * Process a response packet from a DNS server.
60  * The parameter 'xExpected' indicates whether the identifier in the reply
61  * was expected, and thus if the DNS cache may be updated with the reply.
62  */
63     uint32_t DNS_ParseDNSReply( uint8_t * pucUDPPayloadBuffer,
64                                 size_t uxBufferLength,
65                                 struct freertos_addrinfo ** ppxAddressInfo,
66                                 BaseType_t xExpected,
67                                 uint16_t usPort );
68 
69 /*
70  * The NBNS and the LLMNR protocol share this reply function.
71  */
72     #if ( ( ipconfigUSE_MDNS == 1 ) || ( ipconfigUSE_LLMNR == 1 ) || ( ipconfigUSE_NBNS == 1 ) )
73         void prepareReplyDNSMessage( NetworkBufferDescriptor_t * pxNetworkBuffer,
74                                      BaseType_t lNetLength );
75     #endif
76     #if ( ipconfigUSE_NBNS == 1 )
77         void DNS_TreatNBNS( uint8_t * pucPayload,
78                             size_t uxBufferLength,
79                             uint32_t ulIPAddress );
80     #endif
81 
82 /**
83  * Parse the DNS answer/response.
84  */
85     uint32_t parseDNSAnswer( ParseSet_t * pxSet,
86                              struct freertos_addrinfo ** ppxAddressInfo,
87                              size_t * uxBytesRead );
88 
89 #endif /* if ( ipconfigUSE_DNS != 0 ) */
90 #endif /* ifndef FREERTOS_DNS_PARSER_H */
91