server.h

Go to the documentation of this file.

/*
 * Copyright (C) 2004-2015  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: server.h,v 1.118 2012/01/31 23:47:31 tbox Exp $ */

#ifndef NAMED_SERVER_H
#define NAMED_SERVER_H 1

/*! \file */

#include <isc/log.h>
#include <isc/magic.h>
#include <isc/quota.h>
#include <isc/sockaddr.h>
#include <isc/types.h>
#include <isc/xml.h>

#include <dns/acl.h>
#include <dns/types.h>

#include <named/types.h>

#define NS_EVENTCLASS           ISC_EVENTCLASS(0x4E43)
#define NS_EVENT_RELOAD         (NS_EVENTCLASS + 0)
#define NS_EVENT_CLIENTCONTROL  (NS_EVENTCLASS + 1)

/*%
 * Name server state.  Better here than in lots of separate global variables.
 */
struct ns_server {
        unsigned int            magic;
        isc_mem_t *             mctx;

        isc_task_t *            task;

        /* Configurable data. */
        isc_quota_t             xfroutquota;
        isc_quota_t             tcpquota;
        isc_quota_t             recursionquota;
        dns_acl_t               *blackholeacl;
        dns_acl_t               *keepresporder;
        char *                  statsfile;      /*%< Statistics file name */
        char *                  dumpfile;       /*%< Dump file name */
        char *                  secrootsfile;   /*%< Secroots file name */
        char *                  bindkeysfile;   /*%< bind.keys file name */
        char *                  recfile;        /*%< Recursive file name */
        isc_boolean_t           version_set;    /*%< User has set version */
        char *                  version;        /*%< User-specified version */
        isc_boolean_t           hostname_set;   /*%< User has set hostname */
        char *                  hostname;       /*%< User-specified hostname */
        /*% Use hostname for server id */
        isc_boolean_t           server_usehostname;
        char *                  server_id;      /*%< User-specified server id */

        /*%
         * Current ACL environment.  This defines the
         * current values of the localhost and localnets
         * ACLs.
         */
        dns_aclenv_t            aclenv;

        /* Server data structures. */
        dns_loadmgr_t *         loadmgr;
        dns_zonemgr_t *         zonemgr;
        dns_viewlist_t          viewlist;
        ns_interfacemgr_t *     interfacemgr;
        dns_db_t *              in_roothints;
        dns_tkeyctx_t *         tkeyctx;

        isc_timer_t *           interface_timer;
        isc_timer_t *           heartbeat_timer;
        isc_timer_t *           pps_timer;

        isc_uint32_t            interface_interval;
        isc_uint32_t            heartbeat_interval;

        isc_mutex_t             reload_event_lock;
        isc_event_t *           reload_event;

        isc_boolean_t           flushonshutdown;
        isc_boolean_t           log_queries;    /*%< For BIND 8 compatibility */

        ns_cachelist_t          cachelist;      /*%< Possibly shared caches */
        isc_stats_t *           nsstats;        /*%< Server stats */
        dns_stats_t *           rcvquerystats;  /*% Incoming query stats */
        dns_stats_t *           opcodestats;    /*%< Incoming message stats */
        isc_stats_t *           zonestats;      /*% Zone management stats */
        isc_stats_t  *          resolverstats;  /*% Resolver stats */
        isc_stats_t *           sockstats;      /*%< Socket stats */

        ns_controls_t *         controls;       /*%< Control channels */
        unsigned int            dispatchgen;
        ns_dispatchlist_t       dispatches;

        dns_acache_t            *acache;

        ns_statschannellist_t   statschannels;

        dns_tsigkey_t           *sessionkey;
        char                    *session_keyfile;
        dns_name_t              *session_keyname;
        unsigned int            session_keyalg;
        isc_uint16_t            session_keybits;
        isc_boolean_t           interface_auto;
        unsigned char           secret[32];     /*%< Source Identity Token */

        char *                  lockfile;
};

#define NS_SERVER_MAGIC                 ISC_MAGIC('S','V','E','R')
#define NS_SERVER_VALID(s)              ISC_MAGIC_VALID(s, NS_SERVER_MAGIC)

/*%
 * Server statistics counters.  Used as isc_statscounter_t values.
 */
enum {
        dns_nsstatscounter_requestv4 = 0,
        dns_nsstatscounter_requestv6 = 1,
        dns_nsstatscounter_edns0in = 2,
        dns_nsstatscounter_badednsver = 3,
        dns_nsstatscounter_tsigin = 4,
        dns_nsstatscounter_sig0in = 5,
        dns_nsstatscounter_invalidsig = 6,
        dns_nsstatscounter_requesttcp = 7,

        dns_nsstatscounter_authrej = 8,
        dns_nsstatscounter_recurserej = 9,
        dns_nsstatscounter_xfrrej = 10,
        dns_nsstatscounter_updaterej = 11,

        dns_nsstatscounter_response = 12,
        dns_nsstatscounter_truncatedresp = 13,
        dns_nsstatscounter_edns0out = 14,
        dns_nsstatscounter_tsigout = 15,
        dns_nsstatscounter_sig0out = 16,

        dns_nsstatscounter_success = 17,
        dns_nsstatscounter_authans = 18,
        dns_nsstatscounter_nonauthans = 19,
        dns_nsstatscounter_referral = 20,
        dns_nsstatscounter_nxrrset = 21,
        dns_nsstatscounter_servfail = 22,
        dns_nsstatscounter_formerr = 23,
        dns_nsstatscounter_nxdomain = 24,
        dns_nsstatscounter_recursion = 25,
        dns_nsstatscounter_duplicate = 26,
        dns_nsstatscounter_dropped = 27,
        dns_nsstatscounter_failure = 28,

        dns_nsstatscounter_xfrdone = 29,

        dns_nsstatscounter_updatereqfwd = 30,
        dns_nsstatscounter_updaterespfwd = 31,
        dns_nsstatscounter_updatefwdfail = 32,
        dns_nsstatscounter_updatedone = 33,
        dns_nsstatscounter_updatefail = 34,
        dns_nsstatscounter_updatebadprereq = 35,

        dns_nsstatscounter_recursclients = 36,

        dns_nsstatscounter_dns64 = 37,

        dns_nsstatscounter_ratedropped = 38,
        dns_nsstatscounter_rateslipped = 39,

        dns_nsstatscounter_rpz_rewrites = 40,

        dns_nsstatscounter_udp = 41,
        dns_nsstatscounter_tcp = 42,

        dns_nsstatscounter_nsidopt = 43,
        dns_nsstatscounter_expireopt = 44,
        dns_nsstatscounter_otheropt = 45,
        dns_nsstatscounter_ecsopt = 46,

#ifdef ISC_PLATFORM_USESIT
        dns_nsstatscounter_sitopt = 47,
        dns_nsstatscounter_sitbadsize = 48,
        dns_nsstatscounter_sitbadtime = 49,
        dns_nsstatscounter_sitnomatch = 50,
        dns_nsstatscounter_sitmatch = 51,
        dns_nsstatscounter_sitnew = 52,

        dns_nsstatscounter_max = 53
#else
        dns_nsstatscounter_max = 47
#endif
};

void
ns_server_create(isc_mem_t *mctx, ns_server_t **serverp);
/*%<
 * Create a server object with default settings.
 * This function either succeeds or causes the program to exit
 * with a fatal error.
 */

void
ns_server_destroy(ns_server_t **serverp);
/*%<
 * Destroy a server object, freeing its memory.
 */

void
ns_server_reloadwanted(ns_server_t *server);
/*%<
 * Inform a server that a reload is wanted.  This function
 * may be called asynchronously, from outside the server's task.
 * If a reload is already scheduled or in progress, the call
 * is ignored.
 */

void
ns_server_scan_interfaces(ns_server_t *server);
/*%<
 * Trigger a interface scan.
 * Must only be called when running under server->task.
 */

void
ns_server_flushonshutdown(ns_server_t *server, isc_boolean_t flush);
/*%<
 * Inform the server that the zones should be flushed to disk on shutdown.
 */

isc_result_t
ns_server_reloadcommand(ns_server_t *server, char *args, isc_buffer_t **text);
/*%<
 * Act on a "reload" command from the command channel.
 */

isc_result_t
ns_server_reconfigcommand(ns_server_t *server, char *args);
/*%<
 * Act on a "reconfig" command from the command channel.
 */

isc_result_t
ns_server_notifycommand(ns_server_t *server, char *args, isc_buffer_t **text);
/*%<
 * Act on a "notify" command from the command channel.
 */

isc_result_t
ns_server_refreshcommand(ns_server_t *server, char *args, isc_buffer_t **text);
/*%<
 * Act on a "refresh" command from the command channel.
 */

isc_result_t
ns_server_retransfercommand(ns_server_t *server, char *args,
                            isc_buffer_t **text);
/*%<
 * Act on a "retransfer" command from the command channel.
 */

isc_result_t
ns_server_togglequerylog(ns_server_t *server, char *args);
/*%<
 * Enable/disable logging of queries.  (Takes "yes" or "no" argument,
 * but can also be used as a toggle for backward comptibility.)
 */

/*%
 * Save the current NTAs for all views to files.
 */
isc_result_t
ns_server_saventa(ns_server_t *server);

/*%
 * Load NTAs for all views from files.
 */
isc_result_t
ns_server_loadnta(ns_server_t *server);

/*%
 * Dump the current statistics to the statistics file.
 */
isc_result_t
ns_server_dumpstats(ns_server_t *server);

/*%
 * Dump the current cache to the dump file.
 */
isc_result_t
ns_server_dumpdb(ns_server_t *server, char *args);

/*%
 * Dump the current security roots to the secroots file.
 */
isc_result_t
ns_server_dumpsecroots(ns_server_t *server, char *args, isc_buffer_t **text);

/*%
 * Change or increment the server debug level.
 */
isc_result_t
ns_server_setdebuglevel(ns_server_t *server, char *args);

/*%
 * Flush the server's cache(s)
 */
isc_result_t
ns_server_flushcache(ns_server_t *server, char *args);

/*%
 * Flush a particular name from the server's cache.  If 'tree' is false,
 * also flush the name from the ADB and badcache.  If 'tree' is true, also
 * flush all the names under the specified name.
 */
isc_result_t
ns_server_flushnode(ns_server_t *server, char *args, isc_boolean_t tree);

/*%
 * Report the server's status.
 */
isc_result_t
ns_server_status(ns_server_t *server, isc_buffer_t **text);

/*%
 * Report a list of dynamic and static tsig keys, per view.
 */
isc_result_t
ns_server_tsiglist(ns_server_t *server, isc_buffer_t **text);

/*%
 * Delete a specific key (with optional view).
 */
isc_result_t
ns_server_tsigdelete(ns_server_t *server, char *command, isc_buffer_t **text);

/*%
 * Enable or disable updates for a zone.
 */
isc_result_t
ns_server_freeze(ns_server_t *server, isc_boolean_t freeze, char *args,
                 isc_buffer_t **text);

/*%
 * Dump zone updates to disk, optionally removing the journal file
 */
isc_result_t
ns_server_sync(ns_server_t *server, char *args, isc_buffer_t **text);

/*%
 * Update a zone's DNSKEY set from the key repository.  If
 * the command that triggered the call to this function was "sign",
 * then force a full signing of the zone.  If it was "loadkeys",
 * then don't sign the zone; any needed changes to signatures can
 * take place incrementally.
 */
isc_result_t
ns_server_rekey(ns_server_t *server, char *args, isc_buffer_t **text);

/*%
 * Dump the current recursive queries.
 */
isc_result_t
ns_server_dumprecursing(ns_server_t *server);

/*%
 * Maintain a list of dispatches that require reserved ports.
 */
void
ns_add_reserved_dispatch(ns_server_t *server, const isc_sockaddr_t *addr);

/*%
 * Enable or disable dnssec validation.
 */
isc_result_t
ns_server_validation(ns_server_t *server, char *args, isc_buffer_t **text);

/*%
 * Add a zone to a running process, or modify an existing zone
 */
isc_result_t
ns_server_changezone(ns_server_t *server, char *args, isc_buffer_t **text);

/*%
 * Deletes a zone from a running process
 */
isc_result_t
ns_server_delzone(ns_server_t *server, char *args, isc_buffer_t **text);

/*%
 * Show current configuration for a given zone
 */
isc_result_t
ns_server_showzone(ns_server_t *server, char *args, isc_buffer_t **text);

/*%
 * Lists the status of the signing records for a given zone.
 */
isc_result_t
ns_server_signing(ns_server_t *server, char *args, isc_buffer_t **text);

/*%
 * Lists status information for a given zone (e.g., name, type, files,
 * load time, expiry, etc).
 */
isc_result_t
ns_server_zonestatus(ns_server_t *server, char *args, isc_buffer_t **text);

/*%
 * Adds a Negative Trust Anchor (NTA) for a specified name and
 * duration, in a particular view if specified, or in all views.
 */
isc_result_t
ns_server_nta(ns_server_t *server, char *args, isc_buffer_t **text);

/*%
 * Generates a test sequence that is only for use in system tests. The
 * argument is the size of required output in bytes.
 */
isc_result_t
ns_server_testgen(char *args, isc_buffer_t **text);

/*%
 * Force fefresh or print status for managed keys zones.
 */
isc_result_t
ns_server_mkeys(ns_server_t *server, char *args, isc_buffer_t **text);

#endif /* NAMED_SERVER_H */

---