1 /*
2  * Copyright (C) 2004-2007, 2010-2012, 2014  Internet Systems Consortium, Inc. ("ISC")
3  * Copyright (C) 1999-2001  Internet Software Consortium.
4  *
5  * Permission to use, copy, modify, and/or 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$ */
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 	isc_mem_t *mctx;
32 	isc_refcount_t references;
33 } cfg_aclconfctx_t;
34 
35 /***
36  *** Functions
37  ***/
38 
39 ISC_LANG_BEGINDECLS
40 
41 isc_result_t
42 cfg_aclconfctx_create(isc_mem_t *mctx, cfg_aclconfctx_t **ret);
43 /*
44  * Creates and initializes an ACL configuration context.
45  */
46 
47 void
48 cfg_aclconfctx_detach(cfg_aclconfctx_t **actxp);
49 /*
50  * Removes a reference to an ACL configuration context; when references
51  * reaches zero, clears the contents and deallocate the structure.
52  */
53 
54 void
55 cfg_aclconfctx_attach(cfg_aclconfctx_t *src, cfg_aclconfctx_t **dest);
56 /*
57  * Attaches a pointer to an existing ACL configuration context.
58  */
59 
60 isc_result_t
61 cfg_acl_fromconfig(const cfg_obj_t *caml, const cfg_obj_t *cctx,
62 		   isc_log_t *lctx, cfg_aclconfctx_t *ctx,
63 		   isc_mem_t *mctx, unsigned int nest_level,
64 		   dns_acl_t **target);
65 
66 isc_result_t
67 cfg_acl_fromconfig2(const cfg_obj_t *caml, const cfg_obj_t *cctx,
68 		   isc_log_t *lctx, cfg_aclconfctx_t *ctx,
69 		   isc_mem_t *mctx, unsigned int nest_level,
70 		   isc_uint16_t family, dns_acl_t **target);
71 /*
72  * Construct a new dns_acl_t from configuration data in 'caml' and
73  * 'cctx'.  Memory is allocated through 'mctx'.
74  *
75  * Any named ACLs referred to within 'caml' will be be converted
76  * into nested dns_acl_t objects.  Multiple references to the same
77  * named ACLs will be converted into shared references to a single
78  * nested dns_acl_t object when the referring objects were created
79  * passing the same ACL configuration context 'ctx'.
80  *
81  * cfg_acl_fromconfig() is a backward-compatible version of
82  * cfg_acl_fromconfig2(), which allows an address family to be
83  * specified.  If 'family' is not zero, then only addresses/prefixes
84  * of a matching family (AF_INET or AF_INET6) may be configured.
85  *
86  * On success, attach '*target' to the new dns_acl_t object.
87  */
88 
89 ISC_LANG_ENDDECLS
90 
91 #endif /* ISCCFG_ACLCONF_H */
92