1 /* $NetBSD: client.h,v 1.16 2024/02/23 21:09:49 christos Exp $ */ 2 3 /* 4 * Copyright (C) Internet Systems Consortium, Inc. ("ISC") 5 * 6 * SPDX-License-Identifier: MPL-2.0 7 * 8 * This Source Code Form is subject to the terms of the Mozilla Public 9 * License, v. 2.0. If a copy of the MPL was not distributed with this 10 * file, you can obtain one at https://mozilla.org/MPL/2.0/. 11 * 12 * See the COPYRIGHT file distributed with this work for additional 13 * information regarding copyright ownership. 14 */ 15 16 #pragma once 17 18 /***** 19 ***** Module Info 20 *****/ 21 22 /*! \file 23 * \brief 24 * This module defines two objects, ns_client_t and ns_clientmgr_t. 25 * 26 * An ns_client_t object handles incoming DNS requests from clients 27 * on a given network interface. 28 * 29 * Each ns_client_t object can handle only one TCP connection or UDP 30 * request at a time. Therefore, several ns_client_t objects are 31 * typically created to serve each network interface, e.g., one 32 * for handling TCP requests and a few (one per CPU) for handling 33 * UDP requests. 34 * 35 * Incoming requests are classified as queries, zone transfer 36 * requests, update requests, notify requests, etc, and handed off 37 * to the appropriate request handler. When the request has been 38 * fully handled (which can be much later), the ns_client_t must be 39 * notified of this by calling one of the following functions 40 * exactly once in the context of its task: 41 * \code 42 * ns_client_send() (sending a non-error response) 43 * ns_client_sendraw() (sending a raw response) 44 * ns_client_error() (sending an error response) 45 * ns_client_drop() (sending no response, logging the reason) 46 *\endcode 47 * This will release any resources used by the request and 48 * and allow the ns_client_t to listen for the next request. 49 * 50 * A ns_clientmgr_t manages a number of ns_client_t objects. 51 * New ns_client_t objects are created by calling 52 * ns_clientmgr_createclients(). They are destroyed by 53 * destroying their manager. 54 */ 55 56 /*** 57 *** Imports 58 ***/ 59 60 #include <inttypes.h> 61 #include <stdbool.h> 62 63 #include <isc/atomic.h> 64 #include <isc/buffer.h> 65 #include <isc/magic.h> 66 #include <isc/netmgr.h> 67 #include <isc/quota.h> 68 #include <isc/stdtime.h> 69 70 #include <dns/db.h> 71 #include <dns/ecs.h> 72 #include <dns/fixedname.h> 73 #include <dns/name.h> 74 #include <dns/rdataclass.h> 75 #include <dns/rdatatype.h> 76 #include <dns/types.h> 77 78 #include <ns/query.h> 79 #include <ns/types.h> 80 81 /*** 82 *** Types 83 ***/ 84 85 #define NS_CLIENT_TCP_BUFFER_SIZE 65535 86 #define NS_CLIENT_SEND_BUFFER_SIZE 4096 87 88 /*! 89 * Client object states. Ordering is significant: higher-numbered 90 * states are generally "more active", meaning that the client can 91 * have more dynamically allocated data, outstanding events, etc. 92 * In the list below, any such properties listed for state N 93 * also apply to any state > N. 94 */ 95 96 typedef enum { 97 NS_CLIENTSTATE_FREED = 0, 98 /*%< 99 * The client object no longer exists. 100 */ 101 102 NS_CLIENTSTATE_INACTIVE = 1, 103 /*%< 104 * The client object exists and has a task and timer. 105 * Its "query" struct and sendbuf are initialized. 106 * It has a message and OPT, both in the reset state. 107 */ 108 109 NS_CLIENTSTATE_READY = 2, 110 /*%< 111 * The client object is either a TCP or a UDP one, and 112 * it is associated with a network interface. It is on the 113 * client manager's list of active clients. 114 * 115 * If it is a TCP client object, it has a TCP listener socket 116 * and an outstanding TCP listen request. 117 * 118 * If it is a UDP client object, it has a UDP listener socket 119 * and an outstanding UDP receive request. 120 */ 121 122 NS_CLIENTSTATE_WORKING = 3, 123 /*%< 124 * The client object has received a request and is working 125 * on it. It has a view, and it may have any of a non-reset OPT, 126 * recursion quota, and an outstanding write request. 127 */ 128 129 NS_CLIENTSTATE_RECURSING = 4, 130 /*%< 131 * The client object is recursing. It will be on the 132 * 'recursing' list. 133 */ 134 135 NS_CLIENTSTATE_MAX = 5 136 /*%< 137 * Sentinel value used to indicate "no state". 138 */ 139 } ns_clientstate_t; 140 141 typedef ISC_LIST(ns_client_t) client_list_t; 142 143 /*% nameserver client manager structure */ 144 struct ns_clientmgr { 145 /* Unlocked. */ 146 unsigned int magic; 147 148 isc_mem_t *mctx; 149 isc_mem_t *send_mctx; 150 ns_server_t *sctx; 151 isc_taskmgr_t *taskmgr; 152 isc_timermgr_t *timermgr; 153 isc_refcount_t references; 154 int tid; 155 156 /* Attached by clients, needed for e.g. recursion */ 157 isc_task_t *task; 158 159 dns_aclenv_t *aclenv; 160 161 /* Lock covers the recursing list */ 162 isc_mutex_t reclock; 163 client_list_t recursing; /*%< Recursing clients */ 164 }; 165 166 /*% nameserver client structure */ 167 struct ns_client { 168 unsigned int magic; 169 isc_mem_t *mctx; 170 int tid; 171 bool allocated; /* Do we need to free it? */ 172 ns_server_t *sctx; 173 ns_clientmgr_t *manager; 174 ns_clientstate_t state; 175 int nupdates; 176 bool nodetach; 177 bool shuttingdown; 178 unsigned int attributes; 179 isc_task_t *task; 180 dns_view_t *view; 181 dns_dispatch_t *dispatch; 182 isc_nmhandle_t *handle; /* Permanent pointer to handle */ 183 isc_nmhandle_t *sendhandle; /* Waiting for send callback */ 184 isc_nmhandle_t *reqhandle; /* Waiting for request callback 185 (query, update, notify) */ 186 isc_nmhandle_t *fetchhandle; /* Waiting for recursive fetch */ 187 isc_nmhandle_t *prefetchhandle; /* Waiting for prefetch / rpzfetch */ 188 isc_nmhandle_t *updatehandle; /* Waiting for update callback */ 189 unsigned char *tcpbuf; 190 size_t tcpbuf_size; 191 dns_message_t *message; 192 unsigned char *sendbuf; 193 dns_rdataset_t *opt; 194 dns_ednsopt_t *ede; 195 uint16_t udpsize; 196 uint16_t extflags; 197 int16_t ednsversion; /* -1 noedns */ 198 uint16_t additionaldepth; 199 void (*cleanup)(ns_client_t *); 200 ns_query_t query; 201 isc_time_t requesttime; 202 isc_stdtime_t now; 203 isc_time_t tnow; 204 dns_name_t signername; /*%< [T]SIG key name */ 205 dns_name_t *signer; /*%< NULL if not valid sig */ 206 bool mortal; /*%< Die after handling request */ 207 isc_quota_t *recursionquota; 208 209 isc_sockaddr_t peeraddr; 210 bool peeraddr_valid; 211 isc_netaddr_t destaddr; 212 isc_sockaddr_t destsockaddr; 213 214 dns_ecs_t ecs; /*%< EDNS client subnet sent by client */ 215 216 struct in6_pktinfo pktinfo; 217 /*% 218 * Information about recent FORMERR response(s), for 219 * FORMERR loop avoidance. This is separate for each 220 * client object rather than global only to avoid 221 * the need for locking. 222 */ 223 struct { 224 isc_sockaddr_t addr; 225 isc_stdtime_t time; 226 dns_messageid_t id; 227 } formerrcache; 228 229 /*% Callback function to send a response when unit testing */ 230 void (*sendcb)(isc_buffer_t *buf); 231 232 ISC_LINK(ns_client_t) rlink; 233 unsigned char cookie[8]; 234 uint32_t expire; 235 unsigned char *keytag; 236 uint16_t keytag_len; 237 238 /*% 239 * Used to override the DNS response code in ns_client_error(). 240 * If set to -1, the rcode is determined from the result code, 241 * but if set to any other value, the least significant 12 242 * bits will be used as the rcode in the response message. 243 */ 244 int32_t rcode_override; 245 }; 246 247 #define NS_CLIENT_MAGIC ISC_MAGIC('N', 'S', 'C', 'c') 248 #define NS_CLIENT_VALID(c) ISC_MAGIC_VALID(c, NS_CLIENT_MAGIC) 249 250 #define NS_CLIENTATTR_TCP 0x00001 251 #define NS_CLIENTATTR_RA 0x00002 /*%< Client gets recursive service */ 252 #define NS_CLIENTATTR_PKTINFO 0x00004 /*%< pktinfo is valid */ 253 #define NS_CLIENTATTR_MULTICAST 0x00008 /*%< recv'd from multicast */ 254 #define NS_CLIENTATTR_WANTDNSSEC 0x00010 /*%< include dnssec records */ 255 #define NS_CLIENTATTR_WANTNSID 0x00020 /*%< include nameserver ID */ 256 /* Obsolete: NS_CLIENTATTR_FILTER_AAAA 0x00040 */ 257 /* Obsolete: NS_CLIENTATTR_FILTER_AAAA_RC 0x00080 */ 258 #define NS_CLIENTATTR_WANTAD 0x00100 /*%< want AD in response if possible */ 259 #define NS_CLIENTATTR_WANTCOOKIE 0x00200 /*%< return a COOKIE */ 260 #define NS_CLIENTATTR_HAVECOOKIE 0x00400 /*%< has a valid COOKIE */ 261 #define NS_CLIENTATTR_WANTEXPIRE 0x00800 /*%< return seconds to expire */ 262 #define NS_CLIENTATTR_HAVEEXPIRE 0x01000 /*%< return seconds to expire */ 263 #define NS_CLIENTATTR_WANTOPT 0x02000 /*%< add opt to reply */ 264 #define NS_CLIENTATTR_HAVEECS 0x04000 /*%< received an ECS option */ 265 #define NS_CLIENTATTR_WANTPAD 0x08000 /*%< pad reply */ 266 #define NS_CLIENTATTR_USEKEEPALIVE 0x10000 /*%< use TCP keepalive */ 267 268 #define NS_CLIENTATTR_NOSETFC 0x20000 /*%< don't set servfail cache */ 269 270 /* 271 * Flag to use with the SERVFAIL cache to indicate 272 * that a query had the CD bit set. 273 */ 274 #define NS_FAILCACHE_CD 0x01 275 276 #ifdef _LP64 277 extern atomic_uint_fast64_t ns_client_requests; 278 #else 279 extern atomic_uint_fast32_t ns_client_requests; 280 #endif 281 282 /*** 283 *** Functions 284 ***/ 285 286 /* 287 * Note! These ns_client_ routines MUST be called ONLY from the client's 288 * task in order to ensure synchronization. 289 */ 290 291 void 292 ns_client_send(ns_client_t *client); 293 /*%< 294 * Finish processing the current client request and 295 * send client->message as a response. 296 * \brief 297 * Note! These ns_client_ routines MUST be called ONLY from the client's 298 * task in order to ensure synchronization. 299 */ 300 301 void 302 ns_client_sendraw(ns_client_t *client, dns_message_t *msg); 303 /*%< 304 * Finish processing the current client request and 305 * send msg as a response using client->message->id for the id. 306 */ 307 308 void 309 ns_client_error(ns_client_t *client, isc_result_t result); 310 /*%< 311 * Finish processing the current client request and return 312 * an error response to the client. The error response 313 * will have an RCODE determined by 'result'. 314 */ 315 316 void 317 ns_client_extendederror(ns_client_t *client, uint16_t code, const char *text); 318 /*%< 319 * Set extended error with INFO-CODE <code> and EXTRA-TEXT <text>. 320 */ 321 322 void 323 ns_client_drop(ns_client_t *client, isc_result_t result); 324 /*%< 325 * Log the reason the current client request has failed; no response 326 * will be sent. 327 */ 328 329 bool 330 ns_client_shuttingdown(ns_client_t *client); 331 /*%< 332 * Return true iff the client is currently shutting down. 333 */ 334 335 isc_result_t 336 ns_client_replace(ns_client_t *client); 337 /*%< 338 * Try to replace the current client with a new one, so that the 339 * current one can go off and do some lengthy work without 340 * leaving the dispatch/socket without service. 341 */ 342 343 void 344 ns_client_settimeout(ns_client_t *client, unsigned int seconds); 345 /*%< 346 * Set a timer in the client to go off in the specified amount of time. 347 */ 348 349 isc_result_t 350 ns_clientmgr_create(ns_server_t *sctx, isc_taskmgr_t *taskmgr, 351 isc_timermgr_t *timermgr, dns_aclenv_t *aclenv, int tid, 352 ns_clientmgr_t **managerp); 353 /*%< 354 * Create a client manager. 355 */ 356 357 void 358 ns_clientmgr_shutdown(ns_clientmgr_t *manager); 359 /*%< 360 * Shutdown a client manager and all ns_client_t objects 361 * managed by it 362 */ 363 364 void 365 ns_clientmgr_detach(ns_clientmgr_t **managerp); 366 /*%< 367 * Detach from a client manager. 368 */ 369 370 isc_sockaddr_t * 371 ns_client_getsockaddr(ns_client_t *client); 372 /*%< 373 * Get the socket address of the client whose request is 374 * currently being processed. 375 */ 376 377 isc_sockaddr_t * 378 ns_client_getdestaddr(ns_client_t *client); 379 /*%< 380 * Get the destination address (server) for the request that is 381 * currently being processed. 382 */ 383 384 isc_result_t 385 ns_client_checkaclsilent(ns_client_t *client, isc_netaddr_t *netaddr, 386 dns_acl_t *acl, bool default_allow); 387 388 /*%< 389 * Convenience function for client request ACL checking. 390 * 391 * Check the current client request against 'acl'. If 'acl' 392 * is NULL, allow the request iff 'default_allow' is true. 393 * If netaddr is NULL, check the ACL against client->peeraddr; 394 * otherwise check it against netaddr. 395 * 396 * Notes: 397 *\li This is appropriate for checking allow-update, 398 * allow-query, allow-transfer, etc. It is not appropriate 399 * for checking the blackhole list because we treat positive 400 * matches as "allow" and negative matches as "deny"; in 401 * the case of the blackhole list this would be backwards. 402 * 403 * Requires: 404 *\li 'client' points to a valid client. 405 *\li 'netaddr' points to a valid address, or is NULL. 406 *\li 'acl' points to a valid ACL, or is NULL. 407 * 408 * Returns: 409 *\li ISC_R_SUCCESS if the request should be allowed 410 * \li DNS_R_REFUSED if the request should be denied 411 *\li No other return values are possible. 412 */ 413 414 isc_result_t 415 ns_client_checkacl(ns_client_t *client, isc_sockaddr_t *sockaddr, 416 const char *opname, dns_acl_t *acl, bool default_allow, 417 int log_level); 418 /*%< 419 * Like ns_client_checkaclsilent, except the outcome of the check is 420 * logged at log level 'log_level' if denied, and at debug 3 if approved. 421 * Log messages will refer to the request as an 'opname' request. 422 * 423 * Requires: 424 *\li 'client' points to a valid client. 425 *\li 'sockaddr' points to a valid address, or is NULL. 426 *\li 'acl' points to a valid ACL, or is NULL. 427 *\li 'opname' points to a null-terminated string. 428 */ 429 430 void 431 ns_client_log(ns_client_t *client, isc_logcategory_t *category, 432 isc_logmodule_t *module, int level, const char *fmt, ...) 433 ISC_FORMAT_PRINTF(5, 6); 434 435 void 436 ns_client_logv(ns_client_t *client, isc_logcategory_t *category, 437 isc_logmodule_t *module, int level, const char *fmt, va_list ap) 438 ISC_FORMAT_PRINTF(5, 0); 439 440 void 441 ns_client_aclmsg(const char *msg, const dns_name_t *name, dns_rdatatype_t type, 442 dns_rdataclass_t rdclass, char *buf, size_t len); 443 444 #define NS_CLIENT_ACLMSGSIZE(x) \ 445 (DNS_NAME_FORMATSIZE + DNS_RDATATYPE_FORMATSIZE + \ 446 DNS_RDATACLASS_FORMATSIZE + sizeof(x) + sizeof("'/'")) 447 448 void 449 ns_client_recursing(ns_client_t *client); 450 /*%< 451 * Add client to end of th recursing list. 452 */ 453 454 void 455 ns_client_killoldestquery(ns_client_t *client); 456 /*%< 457 * Kill the oldest recursive query (recursing list head). 458 */ 459 460 void 461 ns_client_dumprecursing(FILE *f, ns_clientmgr_t *manager); 462 /*%< 463 * Dump the outstanding recursive queries to 'f'. 464 */ 465 466 void 467 ns_client_qnamereplace(ns_client_t *client, dns_name_t *name); 468 /*%< 469 * Replace the qname. 470 */ 471 472 isc_result_t 473 ns_client_sourceip(dns_clientinfo_t *ci, isc_sockaddr_t **addrp); 474 475 isc_result_t 476 ns_client_addopt(ns_client_t *client, dns_message_t *message, 477 dns_rdataset_t **opt); 478 479 /*%< 480 * Get a client object from the inactive queue, or create one, as needed. 481 * (Not intended for use outside this module and associated tests.) 482 */ 483 484 void 485 ns__client_request(isc_nmhandle_t *handle, isc_result_t eresult, 486 isc_region_t *region, void *arg); 487 488 /*%< 489 * Handle client requests. 490 * (Not intended for use outside this module and associated tests.) 491 */ 492 493 isc_result_t 494 ns__client_tcpconn(isc_nmhandle_t *handle, isc_result_t result, void *arg); 495 496 /*%< 497 * Called every time a TCP connection is establish. This is used for 498 * updating TCP statistics. 499 */ 500 501 dns_rdataset_t * 502 ns_client_newrdataset(ns_client_t *client); 503 504 void 505 ns_client_putrdataset(ns_client_t *client, dns_rdataset_t **rdatasetp); 506 /*%< 507 * Get and release temporary rdatasets in the client message; 508 * used in query.c and in plugins. 509 */ 510 511 isc_result_t 512 ns_client_newnamebuf(ns_client_t *client); 513 /*%< 514 * Allocate a name buffer for the client message. 515 */ 516 517 dns_name_t * 518 ns_client_newname(ns_client_t *client, isc_buffer_t *dbuf, isc_buffer_t *nbuf); 519 /*%< 520 * Get a temporary name for the client message. 521 */ 522 523 isc_buffer_t * 524 ns_client_getnamebuf(ns_client_t *client); 525 /*%< 526 * Get a name buffer from the pool, or allocate a new one if needed. 527 */ 528 529 void 530 ns_client_keepname(ns_client_t *client, dns_name_t *name, isc_buffer_t *dbuf); 531 /*%< 532 * Adjust buffer 'dbuf' to reflect that 'name' is using space in it, 533 * and set client attributes appropriately. 534 */ 535 536 void 537 ns_client_releasename(ns_client_t *client, dns_name_t **namep); 538 /*%< 539 * Release 'name' back to the pool of temporary names for the client 540 * message. If it is using a name buffer, relinquish its exclusive 541 * rights on the buffer. 542 */ 543 544 isc_result_t 545 ns_client_newdbversion(ns_client_t *client, unsigned int n); 546 /*%< 547 * Allocate 'n' new database versions for use by client queries. 548 */ 549 550 ns_dbversion_t * 551 ns_client_getdbversion(ns_client_t *client); 552 /*%< 553 * Get a free database version for use by a client query, allocating 554 * a new one if necessary. 555 */ 556 557 ns_dbversion_t * 558 ns_client_findversion(ns_client_t *client, dns_db_t *db); 559 /*%< 560 * Find the correct database version to use with a client query. 561 * If we have already done a query related to the database 'db', 562 * make sure subsequent queries are from the same version; 563 * otherwise, take a database version from the list of dbversions 564 * allocated by ns_client_newdbversion(). 565 */ 566 567 isc_result_t 568 ns__client_setup(ns_client_t *client, ns_clientmgr_t *manager, bool new); 569 /*%< 570 * Perform initial setup of an allocated client. 571 */ 572 573 void 574 ns__client_reset_cb(void *client0); 575 /*%< 576 * Reset the client object so that it can be reused. 577 */ 578 579 void 580 ns__client_put_cb(void *client0); 581 /*%< 582 * Free all resources allocated to this client object, so that 583 * it can be freed. 584 */ 585