contrib/bind9/lib/isccfg/include/isccfg/aclconf.h

   1 /*
   2  * Copyright (C) 2004-2006  Internet Systems Consortium, Inc. ("ISC")
   3  * Copyright (C) 1999-2001  Internet Software Consortium.
   4  *
   5  * Permission to use, copy, modify, and distribute this software for any
   6  * purpose with or without fee is hereby granted, provided that the above
   7  * copyright notice and this permission notice appear in all copies.
   8  *
   9  * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
  10  * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  11  * AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
  12  * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  13  * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  14  * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  15  * PERFORMANCE OF THIS SOFTWARE.
  16  */
  17
  18 /* $Id: aclconf.h,v 1.2.2.5 2006/03/02 00:37:22 marka Exp $ */
  19
  20 #ifndef ISCCFG_ACLCONF_H
  21 #define ISCCFG_ACLCONF_H 1
  22
  23 #include <isc/lang.h>
  24
  25 #include <isccfg/cfg.h>
  26
  27 #include <dns/types.h>
  28
  29 typedef struct cfg_aclconfctx {
  30         ISC_LIST(dns_acl_t) named_acl_cache;
  31 } cfg_aclconfctx_t;
  32
  33 /***
  34  *** Functions
  35  ***/
  36
  37 ISC_LANG_BEGINDECLS
  38
  39 void
  40 cfg_aclconfctx_init(cfg_aclconfctx_t *ctx);
  41 /*
  42  * Initialize an ACL configuration context.
  43  */
  44
  45 void
  46 cfg_aclconfctx_destroy(cfg_aclconfctx_t *ctx);
  47 /*
  48  * Destroy an ACL configuration context.
  49  */
  50
  51 isc_result_t
  52 cfg_acl_fromconfig(const cfg_obj_t *caml,
  53                    const cfg_obj_t *cctx,
  54                    isc_log_t *lctx,
  55                    cfg_aclconfctx_t *ctx,
  56                    isc_mem_t *mctx,
  57                    dns_acl_t **target);
  58 /*
  59  * Construct a new dns_acl_t from configuration data in 'caml' and
  60  * 'cctx'.  Memory is allocated through 'mctx'.
  61  *
  62  * Any named ACLs referred to within 'caml' will be be converted
  63  * into nested dns_acl_t objects.  Multiple references to the same
  64  * named ACLs will be converted into shared references to a single
  65  * nested dns_acl_t object when the referring objects were created
  66  * passing the same ACL configuration context 'ctx'.
  67  *
  68  * On success, attach '*target' to the new dns_acl_t object.
  69  */
  70
  71 ISC_LANG_ENDDECLS
  72
  73 #endif /* ISCCFG_ACLCONF_H */