resolv/resolv-internal.h

   1 /* libresolv interfaces for internal use across glibc.
   2    Copyright (C) 2016-2022 Free Software Foundation, Inc.
   3    This file is part of the GNU C Library.
   4
   5    The GNU C Library is free software; you can redistribute it and/or
   6    modify it under the terms of the GNU Lesser General Public
   7    License as published by the Free Software Foundation; either
   8    version 2.1 of the License, or (at your option) any later version.
   9
  10    The GNU C Library is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13    Lesser General Public License for more details.
  14
  15    You should have received a copy of the GNU Lesser General Public
  16    License along with the GNU C Library; if not, see
  17    <https://www.gnu.org/licenses/>.  */
  18
  19 #ifndef _RESOLV_INTERNAL_H
  20 #define _RESOLV_INTERNAL_H 1
  21
  22 #include <resolv.h>
  23 #include <stdbool.h>
  24
  25 /* Resolver flags.  Used for _flags in struct __res_state.  */
  26 #define RES_F_VC        0x00000001 /* Socket is TCP.  */
  27 #define RES_F_CONN      0x00000002 /* Socket is connected.  */
  28 #define RES_F_EDNS0ERR  0x00000004 /* EDNS0 caused errors.  */
  29
  30 /* Legacy function.  This needs to be removed once all NSS modules
  31    have been adjusted.  */
  32 static inline bool
  33 res_use_inet6 (void)
  34 {
  35   return false;
  36 }
  37
  38 enum
  39   {
  40     /* The advertized EDNS buffer size.  The value 1200 is derived
  41        from the IPv6 minimum MTU (1280 bytes) minus some arbitrary
  42        space for tunneling overhead.  If the DNS server does not react
  43        to ICMP Fragmentation Needed But DF Set messages, this should
  44        avoid all UDP fragments on current networks.  Avoiding UDP
  45        fragments is desirable because it prevents fragmentation-based
  46        spoofing attacks because the randomness in a DNS packet is
  47        concentrated in the first fragment (with the headers) and does
  48        not protect subsequent fragments.  */
  49     RESOLV_EDNS_BUFFER_SIZE = 1200,
  50   };
  51
  52 struct resolv_context;
  53
  54 /* Internal function for implementing res_nmkquery and res_mkquery.
  55    Also used by __res_context_query.  */
  56 int __res_context_mkquery (struct resolv_context *, int op, const char *dname,
  57                            int class, int type, const unsigned char *data,
  58                            unsigned char *buf, int buflen);
  59 libc_hidden_proto (__res_context_mkquery)
  60
  61 /* Main resolver query function for use within glibc.  */
  62 int __res_context_search (struct resolv_context *, const char *, int, int,
  63                           unsigned char *, int, unsigned char **,
  64                           unsigned char **, int *, int *, int *);
  65 libc_hidden_proto (__res_context_search)
  66
  67 /* Main resolver query function for use within glibc.  */
  68 int __res_context_query (struct resolv_context *, const char *, int, int,
  69                          unsigned char *, int, unsigned char **,
  70                          unsigned char **, int *, int *, int *);
  71 libc_hidden_proto (__res_context_query)
  72
  73 /* Internal function used to implement the query and search
  74    functions.  */
  75 int __res_context_send (struct resolv_context *, const unsigned char *, int,
  76                         const unsigned char *, int, unsigned char *,
  77                         int, unsigned char **, unsigned char **,
  78                         int *, int *, int *);
  79 libc_hidden_proto (__res_context_send)
  80
  81 /* Internal function similar to res_hostalias.  */
  82 const char *__res_context_hostalias (struct resolv_context *,
  83                                      const char *, char *, size_t);
  84 libc_hidden_proto (__res_context_hostalias);
  85
  86 /* Add an OPT record to a DNS query.  */
  87 int __res_nopt (struct resolv_context *, int n0,
  88                 unsigned char *buf, int buflen, int anslen);
  89 libc_hidden_proto (__res_nopt)
  90
  91 /* Convert from presentation format (which usually means ASCII
  92    printable) to network format (which is usually some kind of binary
  93    format).  The input is in the range [SRC, SRC + SRCLEN).  The
  94    output is written to DST (which has to be 4 or 16 bytes long,
  95    depending on AF).  Return 0 for invalid input, 1 for success, -1
  96    for an invalid address family.  */
  97 int __inet_pton_length (int af, const char *src, size_t srclen, void *);
  98 libc_hidden_proto (__inet_pton_length)
  99
 100 /* Called as part of the thread shutdown sequence.  */
 101 void __res_thread_freeres (void) attribute_hidden;
 102
 103 /* The Linux kernel does not enable all ICMP messages on a UDP socket
 104    by default.  A call this function enables full error reporting for
 105    the socket FD.  FAMILY must be AF_INET or AF_INET6.  Returns 0 on
 106    success, -1 on failure.  */
 107 int __res_enable_icmp (int family, int fd) attribute_hidden;
 108
 109
 110 /* Returns the name server address for the indicated index.  */
 111 struct sockaddr *__res_get_nsaddr (res_state statp, unsigned int n);
 112 libc_hidden_proto (__res_get_nsaddr)
 113
 114
 115 #endif  /* _RESOLV_INTERNAL_H */