376 lines
10 KiB
C
376 lines
10 KiB
C
/*
|
|
* Copyright (C) 2004-2009 Internet Systems Consortium, Inc. ("ISC")
|
|
* Copyright (C) 1999-2003 Internet Software Consortium.
|
|
*
|
|
* Permission to use, copy, modify, and/or distribute this software for any
|
|
* purpose with or without fee is hereby granted, provided that the above
|
|
* copyright notice and this permission notice appear in all copies.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
|
|
* REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
|
|
* AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
|
|
* INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
|
|
* LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
|
|
* OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
|
|
* PERFORMANCE OF THIS SOFTWARE.
|
|
*/
|
|
|
|
/* $Id: client.h,v 1.86.120.2 2009/01/18 23:47:34 tbox Exp $ */
|
|
|
|
#ifndef NAMED_CLIENT_H
|
|
#define NAMED_CLIENT_H 1
|
|
|
|
/*****
|
|
***** Module Info
|
|
*****/
|
|
|
|
/*! \file
|
|
* \brief
|
|
* This module defines two objects, ns_client_t and ns_clientmgr_t.
|
|
*
|
|
* An ns_client_t object handles incoming DNS requests from clients
|
|
* on a given network interface.
|
|
*
|
|
* Each ns_client_t object can handle only one TCP connection or UDP
|
|
* request at a time. Therefore, several ns_client_t objects are
|
|
* typically created to serve each network interface, e.g., one
|
|
* for handling TCP requests and a few (one per CPU) for handling
|
|
* UDP requests.
|
|
*
|
|
* Incoming requests are classified as queries, zone transfer
|
|
* requests, update requests, notify requests, etc, and handed off
|
|
* to the appropriate request handler. When the request has been
|
|
* fully handled (which can be much later), the ns_client_t must be
|
|
* notified of this by calling one of the following functions
|
|
* exactly once in the context of its task:
|
|
* \code
|
|
* ns_client_send() (sending a non-error response)
|
|
* ns_client_sendraw() (sending a raw response)
|
|
* ns_client_error() (sending an error response)
|
|
* ns_client_next() (sending no response)
|
|
*\endcode
|
|
* This will release any resources used by the request and
|
|
* and allow the ns_client_t to listen for the next request.
|
|
*
|
|
* A ns_clientmgr_t manages a number of ns_client_t objects.
|
|
* New ns_client_t objects are created by calling
|
|
* ns_clientmgr_createclients(). They are destroyed by
|
|
* destroying their manager.
|
|
*/
|
|
|
|
/***
|
|
*** Imports
|
|
***/
|
|
|
|
#include <isc/buffer.h>
|
|
#include <isc/magic.h>
|
|
#include <isc/stdtime.h>
|
|
#include <isc/quota.h>
|
|
|
|
#include <dns/fixedname.h>
|
|
#include <dns/name.h>
|
|
#include <dns/rdataclass.h>
|
|
#include <dns/rdatatype.h>
|
|
#include <dns/tcpmsg.h>
|
|
#include <dns/types.h>
|
|
|
|
#include <named/types.h>
|
|
#include <named/query.h>
|
|
|
|
/***
|
|
*** Types
|
|
***/
|
|
|
|
typedef ISC_LIST(ns_client_t) client_list_t;
|
|
|
|
/*% nameserver client structure */
|
|
struct ns_client {
|
|
unsigned int magic;
|
|
isc_mem_t * mctx;
|
|
ns_clientmgr_t * manager;
|
|
int state;
|
|
int newstate;
|
|
int naccepts;
|
|
int nreads;
|
|
int nsends;
|
|
int nrecvs;
|
|
int nupdates;
|
|
int nctls;
|
|
int references;
|
|
isc_boolean_t needshutdown; /*
|
|
* Used by clienttest to get
|
|
* the client to go from
|
|
* inactive to free state
|
|
* by shutting down the
|
|
* client's task.
|
|
*/
|
|
unsigned int attributes;
|
|
isc_task_t * task;
|
|
dns_view_t * view;
|
|
dns_dispatch_t * dispatch;
|
|
isc_socket_t * udpsocket;
|
|
isc_socket_t * tcplistener;
|
|
isc_socket_t * tcpsocket;
|
|
unsigned char * tcpbuf;
|
|
dns_tcpmsg_t tcpmsg;
|
|
isc_boolean_t tcpmsg_valid;
|
|
isc_timer_t * timer;
|
|
isc_boolean_t timerset;
|
|
dns_message_t * message;
|
|
isc_socketevent_t * sendevent;
|
|
isc_socketevent_t * recvevent;
|
|
unsigned char * recvbuf;
|
|
dns_rdataset_t * opt;
|
|
isc_uint16_t udpsize;
|
|
isc_uint16_t extflags;
|
|
isc_int16_t ednsversion; /* -1 noedns */
|
|
void (*next)(ns_client_t *);
|
|
void (*shutdown)(void *arg, isc_result_t result);
|
|
void *shutdown_arg;
|
|
ns_query_t query;
|
|
isc_stdtime_t requesttime;
|
|
isc_stdtime_t now;
|
|
dns_name_t signername; /*%< [T]SIG key name */
|
|
dns_name_t * signer; /*%< NULL if not valid sig */
|
|
isc_boolean_t mortal; /*%< Die after handling request */
|
|
isc_quota_t *tcpquota;
|
|
isc_quota_t *recursionquota;
|
|
ns_interface_t *interface;
|
|
isc_sockaddr_t peeraddr;
|
|
isc_boolean_t peeraddr_valid;
|
|
struct in6_pktinfo pktinfo;
|
|
isc_event_t ctlevent;
|
|
/*%
|
|
* Information about recent FORMERR response(s), for
|
|
* FORMERR loop avoidance. This is separate for each
|
|
* client object rather than global only to avoid
|
|
* the need for locking.
|
|
*/
|
|
struct {
|
|
isc_sockaddr_t addr;
|
|
isc_stdtime_t time;
|
|
dns_messageid_t id;
|
|
} formerrcache;
|
|
ISC_LINK(ns_client_t) link;
|
|
/*%
|
|
* The list 'link' is part of, or NULL if not on any list.
|
|
*/
|
|
client_list_t *list;
|
|
};
|
|
|
|
#define NS_CLIENT_MAGIC ISC_MAGIC('N','S','C','c')
|
|
#define NS_CLIENT_VALID(c) ISC_MAGIC_VALID(c, NS_CLIENT_MAGIC)
|
|
|
|
#define NS_CLIENTATTR_TCP 0x01
|
|
#define NS_CLIENTATTR_RA 0x02 /*%< Client gets recursive service */
|
|
#define NS_CLIENTATTR_PKTINFO 0x04 /*%< pktinfo is valid */
|
|
#define NS_CLIENTATTR_MULTICAST 0x08 /*%< recv'd from multicast */
|
|
#define NS_CLIENTATTR_WANTDNSSEC 0x10 /*%< include dnssec records */
|
|
#define NS_CLIENTATTR_WANTNSID 0x20 /*%< include nameserver ID */
|
|
|
|
extern unsigned int ns_client_requests;
|
|
|
|
/***
|
|
*** Functions
|
|
***/
|
|
|
|
/*%
|
|
* Note! These ns_client_ routines MUST be called ONLY from the client's
|
|
* task in order to ensure synchronization.
|
|
*/
|
|
|
|
void
|
|
ns_client_send(ns_client_t *client);
|
|
/*%
|
|
* Finish processing the current client request and
|
|
* send client->message as a response.
|
|
* \brief
|
|
* Note! These ns_client_ routines MUST be called ONLY from the client's
|
|
* task in order to ensure synchronization.
|
|
*/
|
|
|
|
void
|
|
ns_client_sendraw(ns_client_t *client, dns_message_t *msg);
|
|
/*%
|
|
* Finish processing the current client request and
|
|
* send msg as a response using client->message->id for the id.
|
|
*/
|
|
|
|
void
|
|
ns_client_error(ns_client_t *client, isc_result_t result);
|
|
/*%
|
|
* Finish processing the current client request and return
|
|
* an error response to the client. The error response
|
|
* will have an RCODE determined by 'result'.
|
|
*/
|
|
|
|
void
|
|
ns_client_next(ns_client_t *client, isc_result_t result);
|
|
/*%
|
|
* Finish processing the current client request,
|
|
* return no response to the client.
|
|
*/
|
|
|
|
isc_boolean_t
|
|
ns_client_shuttingdown(ns_client_t *client);
|
|
/*%
|
|
* Return ISC_TRUE iff the client is currently shutting down.
|
|
*/
|
|
|
|
void
|
|
ns_client_attach(ns_client_t *source, ns_client_t **target);
|
|
/*%
|
|
* Attach '*targetp' to 'source'.
|
|
*/
|
|
|
|
void
|
|
ns_client_detach(ns_client_t **clientp);
|
|
/*%
|
|
* Detach '*clientp' from its client.
|
|
*/
|
|
|
|
isc_result_t
|
|
ns_client_replace(ns_client_t *client);
|
|
/*%
|
|
* Try to replace the current client with a new one, so that the
|
|
* current one can go off and do some lengthy work without
|
|
* leaving the dispatch/socket without service.
|
|
*/
|
|
|
|
void
|
|
ns_client_settimeout(ns_client_t *client, unsigned int seconds);
|
|
/*%
|
|
* Set a timer in the client to go off in the specified amount of time.
|
|
*/
|
|
|
|
isc_result_t
|
|
ns_clientmgr_create(isc_mem_t *mctx, isc_taskmgr_t *taskmgr,
|
|
isc_timermgr_t *timermgr, ns_clientmgr_t **managerp);
|
|
/*%
|
|
* Create a client manager.
|
|
*/
|
|
|
|
void
|
|
ns_clientmgr_destroy(ns_clientmgr_t **managerp);
|
|
/*%
|
|
* Destroy a client manager and all ns_client_t objects
|
|
* managed by it.
|
|
*/
|
|
|
|
isc_result_t
|
|
ns_clientmgr_createclients(ns_clientmgr_t *manager, unsigned int n,
|
|
ns_interface_t *ifp, isc_boolean_t tcp);
|
|
/*%
|
|
* Create up to 'n' clients listening on interface 'ifp'.
|
|
* If 'tcp' is ISC_TRUE, the clients will listen for TCP connections,
|
|
* otherwise for UDP requests.
|
|
*/
|
|
|
|
isc_sockaddr_t *
|
|
ns_client_getsockaddr(ns_client_t *client);
|
|
/*%
|
|
* Get the socket address of the client whose request is
|
|
* currently being processed.
|
|
*/
|
|
|
|
isc_result_t
|
|
ns_client_checkaclsilent(ns_client_t *client,
|
|
isc_sockaddr_t *sockaddr,
|
|
dns_acl_t *acl,
|
|
isc_boolean_t default_allow);
|
|
|
|
/*%
|
|
* Convenience function for client request ACL checking.
|
|
*
|
|
* Check the current client request against 'acl'. If 'acl'
|
|
* is NULL, allow the request iff 'default_allow' is ISC_TRUE.
|
|
* If netaddr is NULL, check the ACL against client->peeraddr;
|
|
* otherwise check it against netaddr.
|
|
*
|
|
* Notes:
|
|
*\li This is appropriate for checking allow-update,
|
|
* allow-query, allow-transfer, etc. It is not appropriate
|
|
* for checking the blackhole list because we treat positive
|
|
* matches as "allow" and negative matches as "deny"; in
|
|
* the case of the blackhole list this would be backwards.
|
|
*
|
|
* Requires:
|
|
*\li 'client' points to a valid client.
|
|
*\li 'sockaddr' points to a valid address, or is NULL.
|
|
*\li 'acl' points to a valid ACL, or is NULL.
|
|
*
|
|
* Returns:
|
|
*\li ISC_R_SUCCESS if the request should be allowed
|
|
* \li ISC_R_REFUSED if the request should be denied
|
|
*\li No other return values are possible.
|
|
*/
|
|
|
|
isc_result_t
|
|
ns_client_checkacl(ns_client_t *client,
|
|
isc_sockaddr_t *sockaddr,
|
|
const char *opname, dns_acl_t *acl,
|
|
isc_boolean_t default_allow,
|
|
int log_level);
|
|
/*%
|
|
* Like ns_client_checkaclsilent, except the outcome of the check is
|
|
* logged at log level 'log_level' if denied, and at debug 3 if approved.
|
|
* Log messages will refer to the request as an 'opname' request.
|
|
*
|
|
* Requires:
|
|
*\li 'client' points to a valid client.
|
|
*\li 'sockaddr' points to a valid address, or is NULL.
|
|
*\li 'acl' points to a valid ACL, or is NULL.
|
|
*\li 'opname' points to a null-terminated string.
|
|
*/
|
|
|
|
void
|
|
ns_client_log(ns_client_t *client, isc_logcategory_t *category,
|
|
isc_logmodule_t *module, int level,
|
|
const char *fmt, ...) ISC_FORMAT_PRINTF(5, 6);
|
|
|
|
void
|
|
ns_client_logv(ns_client_t *client, isc_logcategory_t *category,
|
|
isc_logmodule_t *module, int level, const char *fmt, va_list ap) ISC_FORMAT_PRINTF(5, 0);
|
|
|
|
void
|
|
ns_client_aclmsg(const char *msg, dns_name_t *name, dns_rdatatype_t type,
|
|
dns_rdataclass_t rdclass, char *buf, size_t len);
|
|
|
|
#define NS_CLIENT_ACLMSGSIZE(x) \
|
|
(DNS_NAME_FORMATSIZE + DNS_RDATATYPE_FORMATSIZE + \
|
|
DNS_RDATACLASS_FORMATSIZE + sizeof(x) + sizeof("'/'"))
|
|
|
|
void
|
|
ns_client_recursing(ns_client_t *client);
|
|
/*%
|
|
* Add client to end of th recursing list.
|
|
*/
|
|
|
|
void
|
|
ns_client_killoldestquery(ns_client_t *client);
|
|
/*%
|
|
* Kill the oldest recursive query (recursing list head).
|
|
*/
|
|
|
|
void
|
|
ns_client_dumprecursing(FILE *f, ns_clientmgr_t *manager);
|
|
/*%
|
|
* Dump the outstanding recursive queries to 'f'.
|
|
*/
|
|
|
|
void
|
|
ns_client_qnamereplace(ns_client_t *client, dns_name_t *name);
|
|
/*%
|
|
* Replace the qname.
|
|
*/
|
|
|
|
isc_boolean_t
|
|
ns_client_isself(dns_view_t *myview, dns_tsigkey_t *mykey,
|
|
isc_sockaddr_t *srcaddr, isc_sockaddr_t *destaddr,
|
|
dns_rdataclass_t rdclass, void *arg);
|
|
/*%
|
|
* Isself callback.
|
|
*/
|
|
|
|
#endif /* NAMED_CLIENT_H */
|