Home | History | Annotate | Line # | Download | only in iterator 
      1 /*
      2  * iterator/iter_scrub.h - scrubbing, normalization, sanitization of DNS msgs.
      3  *
      4  * Copyright (c) 2007, NLnet Labs. All rights reserved.
      5  *
      6  * This software is open source.
      7  *
      8  * Redistribution and use in source and binary forms, with or without
      9  * modification, are permitted provided that the following conditions
     10  * are met:
     11  *
     12  * Redistributions of source code must retain the above copyright notice,
     13  * this list of conditions and the following disclaimer.
     14  *
     15  * Redistributions in binary form must reproduce the above copyright notice,
     16  * this list of conditions and the following disclaimer in the documentation
     17  * and/or other materials provided with the distribution.
     18  *
     19  * Neither the name of the NLNET LABS nor the names of its contributors may
     20  * be used to endorse or promote products derived from this software without
     21  * specific prior written permission.
     22  *
     23  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
     24  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
     25  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
     26  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
     27  * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
     28  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
     29  * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
     30  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
     31  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
     32  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
     33  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     34  */
     35 
     36 /**
     37  * \file
     38  *
     39  * This file has routine(s) for cleaning up incoming DNS messages from
     40  * possible useless or malicious junk in it.
     41  */
     42 
     43 #ifndef ITERATOR_ITER_SCRUB_H
     44 #define ITERATOR_ITER_SCRUB_H
     45 struct sldns_buffer;
     46 struct msg_parse;
     47 struct query_info;
     48 struct regional;
     49 struct module_env;
     50 struct iter_env;
     51 struct module_qstate;
     52 
     53 /**
     54  * Cleanup the passed dns message.
     55  * @param pkt: the packet itself, for resolving name compression pointers.
     56  *	the packet buffer is unaltered.
     57  * @param msg: the parsed packet, this structure is cleaned up.
     58  * @param qinfo: the query info that was sent to the server. Checked.
     59  * @param zonename: the name of the last delegation point.
     60  *	Used to determine out of bailiwick information.
     61  * @param regional: where to allocate (new) parts of the message.
     62  * @param env: module environment with config settings and cache.
     63  * @param qstate: for setting errinf for EDE error messages.
     64  * @param ie: iterator module environment data.
     65  * @return: false if the message is total waste. true if scrubbed with success.
     66  */
     67 int scrub_message(struct sldns_buffer* pkt, struct msg_parse* msg,
     68 	struct query_info* qinfo, uint8_t* zonename, struct regional* regional,
     69 	struct module_env* env, struct module_qstate* qstate,
     70 	struct iter_env* ie);
     71 
     72 #endif /* ITERATOR_ITER_SCRUB_H */
     73