<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> <title>unbound: daemon/acl_list.h File Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"> <link href="doxygen.css" rel="stylesheet" type="text/css"> </head><body> <!-- Generated by Doxygen 1.5.9 --> <div class="navigation" id="top"> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="annotated.html"><span>Data Structures</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> <li><a href="dirs.html"><span>Directories</span></a></li> </ul> </div> <div class="tabs"> <ul> <li><a href="files.html"><span>File List</span></a></li> <li><a href="globals.html"><span>Globals</span></a></li> </ul> </div> <div class="navpath"><a class="el" href="dir_25e37f0a75013b615a5ba63405adf018.html">daemon</a> </div> </div> <div class="contents"> <h1>acl_list.h File Reference</h1>This file keeps track of the list of clients that are allowed to access the server. <a href="#_details">More...</a> <p> <code>#include "<a class="el" href="dnstree_8h.html">util/storage/dnstree.h</a>"</code><br> <table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> <tr><td colspan="2"><br><h2>Data Structures</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structacl__list.html">acl_list</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Access control storage structure. <a href="structacl__list.html#_details">More...</a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structacl__addr.html">acl_addr</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">An address span with access control information. <a href="structacl__addr.html#_details">More...</a><br></td></tr> <tr><td colspan="2"><br><h2>Enumerations</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="acl__list_8h.html#425804e9a2adb7d8d2c48cf34253446f">acl_access</a> { <a class="el" href="acl__list_8h.html#425804e9a2adb7d8d2c48cf34253446f3ac79a9db55a8f8d79c5708667df7c52">acl_deny</a> = 0, <a class="el" href="acl__list_8h.html#425804e9a2adb7d8d2c48cf34253446fc00e3f728f0a013f7ce842a7e4330ae1">acl_refuse</a>, <a class="el" href="acl__list_8h.html#425804e9a2adb7d8d2c48cf34253446f6459e46459d992c0b580637d53b0d8f9">acl_allow</a>, <a class="el" href="acl__list_8h.html#425804e9a2adb7d8d2c48cf34253446fb93b00e10056d124da4a68222fb92919">acl_allow_snoop</a> }</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Enumeration of access control options for an address range. <a href="acl__list_8h.html#425804e9a2adb7d8d2c48cf34253446f">More...</a><br></td></tr> <tr><td colspan="2"><br><h2>Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">struct <a class="el" href="structacl__list.html">acl_list</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="acl__list_8h.html#a4f26709de4b14d7cfdab0d14cecb86c">acl_list_create</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Create acl structure. <a href="#a4f26709de4b14d7cfdab0d14cecb86c"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="acl__list_8h.html#ae9cd8529458ca916bc548b0eed351ab">acl_list_delete</a> (struct <a class="el" href="structacl__list.html">acl_list</a> *acl)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Delete acl structure. <a href="#ae9cd8529458ca916bc548b0eed351ab"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="acl__list_8h.html#315d48e621312fe130cbb47516e2b280">acl_list_apply_cfg</a> (struct <a class="el" href="structacl__list.html">acl_list</a> *acl, struct <a class="el" href="structconfig__file.html">config_file</a> *cfg)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Process access control config. <a href="#315d48e621312fe130cbb47516e2b280"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">enum <a class="el" href="acl__list_8h.html#425804e9a2adb7d8d2c48cf34253446f">acl_access</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="acl__list_8h.html#4dddca6ebb058641b6affbb0b8343e5f">acl_list_lookup</a> (struct <a class="el" href="structacl__list.html">acl_list</a> *acl, struct sockaddr_storage *addr, socklen_t addrlen)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Lookup address to see its access control status. <a href="#4dddca6ebb058641b6affbb0b8343e5f"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="acl__list_8h.html#8e31e3545da98fb1b7df10b28564837f">acl_list_get_mem</a> (struct <a class="el" href="structacl__list.html">acl_list</a> *acl)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get memory used by acl structure. <a href="#8e31e3545da98fb1b7df10b28564837f"></a><br></td></tr> </table> <hr><h2>Detailed Description</h2> This file keeps track of the list of clients that are allowed to access the server. <p> <hr><h2>Enumeration Type Documentation</h2> <a class="anchor" name="425804e9a2adb7d8d2c48cf34253446f"></a><!-- doxytag: member="acl_list.h::acl_access" ref="425804e9a2adb7d8d2c48cf34253446f" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">enum <a class="el" href="acl__list_8h.html#425804e9a2adb7d8d2c48cf34253446f">acl_access</a> </td> </tr> </table> </div> <div class="memdoc"> <p> Enumeration of access control options for an address range. <p> Allow or deny access. <dl compact><dt><b>Enumerator: </b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"><em><a class="anchor" name="425804e9a2adb7d8d2c48cf34253446f3ac79a9db55a8f8d79c5708667df7c52"></a><!-- doxytag: member="acl_deny" ref="425804e9a2adb7d8d2c48cf34253446f3ac79a9db55a8f8d79c5708667df7c52" args="" -->acl_deny</em> </td><td> disallow any access whatsoever, drop it </td></tr> <tr><td valign="top"><em><a class="anchor" name="425804e9a2adb7d8d2c48cf34253446fc00e3f728f0a013f7ce842a7e4330ae1"></a><!-- doxytag: member="acl_refuse" ref="425804e9a2adb7d8d2c48cf34253446fc00e3f728f0a013f7ce842a7e4330ae1" args="" -->acl_refuse</em> </td><td> disallow access, send a polite 'REFUSED' reply </td></tr> <tr><td valign="top"><em><a class="anchor" name="425804e9a2adb7d8d2c48cf34253446f6459e46459d992c0b580637d53b0d8f9"></a><!-- doxytag: member="acl_allow" ref="425804e9a2adb7d8d2c48cf34253446f6459e46459d992c0b580637d53b0d8f9" args="" -->acl_allow</em> </td><td> allow full access for recursion (+RD) queries </td></tr> <tr><td valign="top"><em><a class="anchor" name="425804e9a2adb7d8d2c48cf34253446fb93b00e10056d124da4a68222fb92919"></a><!-- doxytag: member="acl_allow_snoop" ref="425804e9a2adb7d8d2c48cf34253446fb93b00e10056d124da4a68222fb92919" args="" -->acl_allow_snoop</em> </td><td> allow full access for all queries, recursion and cache snooping </td></tr> </table> </dl> </div> </div><p> <hr><h2>Function Documentation</h2> <a class="anchor" name="a4f26709de4b14d7cfdab0d14cecb86c"></a><!-- doxytag: member="acl_list.h::acl_list_create" ref="a4f26709de4b14d7cfdab0d14cecb86c" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">struct <a class="el" href="structacl__list.html">acl_list</a>* acl_list_create </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td><code> [read]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Create acl structure. <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd>new structure or NULL on error. </dd></dl> <p>References <a class="el" href="acl__list_8c_source.html#l00065">acl_list_delete()</a>, <a class="el" href="acl__list_8h_source.html#l00069">acl_list::region</a>, and <a class="el" href="regional_8c_source.html#l00061">regional_create()</a>.</p> <p>Referenced by <a class="el" href="daemon_8c_source.html#l00147">daemon_init()</a>.</p> </div> </div><p> <a class="anchor" name="ae9cd8529458ca916bc548b0eed351ab"></a><!-- doxytag: member="acl_list.h::acl_list_delete" ref="ae9cd8529458ca916bc548b0eed351ab" args="(struct acl_list *acl)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void acl_list_delete </td> <td>(</td> <td class="paramtype">struct <a class="el" href="structacl__list.html">acl_list</a> * </td> <td class="paramname"> <em>acl</em> </td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p> Delete acl structure. <p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>acl,:</em> </td><td>to delete. </td></tr> </table> </dl> <p>References <a class="el" href="acl__list_8h_source.html#l00069">acl_list::region</a>, and <a class="el" href="regional_8c_source.html#l00108">regional_destroy()</a>.</p> <p>Referenced by <a class="el" href="acl__list_8c_source.html#l00050">acl_list_create()</a>, and <a class="el" href="daemon_8c_source.html#l00475">daemon_delete()</a>.</p> </div> </div><p> <a class="anchor" name="315d48e621312fe130cbb47516e2b280"></a><!-- doxytag: member="acl_list.h::acl_list_apply_cfg" ref="315d48e621312fe130cbb47516e2b280" args="(struct acl_list *acl, struct config_file *cfg)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int acl_list_apply_cfg </td> <td>(</td> <td class="paramtype">struct <a class="el" href="structacl__list.html">acl_list</a> * </td> <td class="paramname"> <em>acl</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">struct <a class="el" href="structconfig__file.html">config_file</a> * </td> <td class="paramname"> <em>cfg</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p> Process access control config. <p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>acl,:</em> </td><td>where to store. </td></tr> <tr><td valign="top"></td><td valign="top"><em>cfg,:</em> </td><td>config options. </td></tr> </table> </dl> <dl class="return" compact><dt><b>Returns:</b></dt><dd>0 on error. </dd></dl> <p>References <a class="el" href="acl__list_8c_source.html#l00093">acl_list_str_cfg()</a>, <a class="el" href="dnstree_8c_source.html#l00079">addr_tree_init()</a>, <a class="el" href="dnstree_8c_source.html#l00107">addr_tree_init_parents()</a>, <a class="el" href="config__file_8h_source.html#l00071">config_file::do_ip6</a>, <a class="el" href="acl__list_8c_source.html#l00126">read_acl_list()</a>, <a class="el" href="acl__list_8h_source.html#l00069">acl_list::region</a>, <a class="el" href="regional_8c_source.html#l00090">regional_free_all()</a>, and <a class="el" href="acl__list_8h_source.html#l00074">acl_list::tree</a>.</p> <p>Referenced by <a class="el" href="daemon_8c_source.html#l00397">daemon_fork()</a>.</p> </div> </div><p> <a class="anchor" name="4dddca6ebb058641b6affbb0b8343e5f"></a><!-- doxytag: member="acl_list.h::acl_list_lookup" ref="4dddca6ebb058641b6affbb0b8343e5f" args="(struct acl_list *acl, struct sockaddr_storage *addr, socklen_t addrlen)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">enum <a class="el" href="acl__list_8h.html#425804e9a2adb7d8d2c48cf34253446f">acl_access</a> acl_list_lookup </td> <td>(</td> <td class="paramtype">struct <a class="el" href="structacl__list.html">acl_list</a> * </td> <td class="paramname"> <em>acl</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">struct sockaddr_storage * </td> <td class="paramname"> <em>addr</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">socklen_t </td> <td class="paramname"> <em>addrlen</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p> Lookup address to see its access control status. <p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>acl,:</em> </td><td>structure for address storage. </td></tr> <tr><td valign="top"></td><td valign="top"><em>addr,:</em> </td><td>address to check </td></tr> <tr><td valign="top"></td><td valign="top"><em>addrlen,:</em> </td><td>length of addr. </td></tr> </table> </dl> <dl class="return" compact><dt><b>Returns:</b></dt><dd>: what to do with message from this address. </dd></dl> <p>References <a class="el" href="acl__list_8h_source.html#l00055">acl_deny</a>, <a class="el" href="dnstree_8c_source.html#l00203">addr_tree_lookup()</a>, <a class="el" href="acl__list_8h_source.html#l00085">acl_addr::control</a>, and <a class="el" href="acl__list_8h_source.html#l00074">acl_list::tree</a>.</p> <p>Referenced by <a class="el" href="worker_8c_source.html#l00681">worker_handle_request()</a>.</p> </div> </div><p> <a class="anchor" name="8e31e3545da98fb1b7df10b28564837f"></a><!-- doxytag: member="acl_list.h::acl_list_get_mem" ref="8e31e3545da98fb1b7df10b28564837f" args="(struct acl_list *acl)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">size_t acl_list_get_mem </td> <td>(</td> <td class="paramtype">struct <a class="el" href="structacl__list.html">acl_list</a> * </td> <td class="paramname"> <em>acl</em> </td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p> Get memory used by acl structure. <p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>acl,:</em> </td><td>structure for address storage. </td></tr> </table> </dl> <dl class="return" compact><dt><b>Returns:</b></dt><dd>bytes in use. </dd></dl> <p>References <a class="el" href="acl__list_8h_source.html#l00069">acl_list::region</a>, and <a class="el" href="regional_8c_source.html#l00214">regional_get_mem()</a>.</p> </div> </div><p> </div> <hr size="1"><address style="text-align: right;"><small>Generated on Tue Oct 13 06:46:30 2009 for unbound by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address> </body> </html>