contrib/unbound/ipsecmod/ipsecmod.h

   1 /*
   2  * ipsecmod/ipsecmod.h - facilitate opportunistic IPsec module
   3  *
   4  * Copyright (c) 2017, 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 contains a module that facilitates opportunistic IPsec. It does so
  40  * by also quering for the IPSECKEY for A/AAAA queries and calling a
  41  * configurable hook (eg. signaling an IKE daemon) before replying.
  42  */
  43
  44 #ifndef IPSECMOD_H
  45 #define IPSECMOD_H
  46 #include "util/module.h"
  47 #include "util/rbtree.h"
  48
  49 /**
  50  * The global variable environment contents for the ipsecmod
  51  * Shared between threads, this represents long term information.
  52  */
  53 struct ipsecmod_env {
  54         /** White listed domains for ipsecmod. */
  55         rbtree_type* whitelist;
  56 };
  57
  58 /**
  59  * Per query state for the ipsecmod module.
  60  */
  61 struct ipsecmod_qstate {
  62         /** State of the IPsec module. */
  63         /** NOTE: This value is copied here from the configuration so that a change
  64          *  with unbound-control would not complicate an already running mesh. */
  65         int enabled;
  66         /** If the qname is whitelisted or not. */
  67         /** NOTE: No whitelist means all qnames are whitelisted. */
  68         int is_whitelisted;
  69         /** Pointer to IPSECKEY rrset allocated in the qstate region. NULL if there
  70          *  was no IPSECKEY reply from the subquery. */
  71         struct ub_packed_rrset_key* ipseckey_rrset;
  72         /** If the IPSECKEY subquery has finished. */
  73         int ipseckey_done;
  74 };
  75
  76 /** Init the ipsecmod module */
  77 int ipsecmod_init(struct module_env* env, int id);
  78 /** Deinit the ipsecmod module */
  79 void ipsecmod_deinit(struct module_env* env, int id);
  80 /** Operate on an event on a query (in qstate). */
  81 void ipsecmod_operate(struct module_qstate* qstate, enum module_ev event,
  82         int id, struct outbound_entry* outbound);
  83 /** Subordinate query done, inform this super request of its conclusion */
  84 void ipsecmod_inform_super(struct module_qstate* qstate, int id,
  85         struct module_qstate* super);
  86 /** clear the ipsecmod query-specific contents out of qstate */
  87 void ipsecmod_clear(struct module_qstate* qstate, int id);
  88 /** return memory estimate for the ipsecmod module */
  89 size_t ipsecmod_get_mem(struct module_env* env, int id);
  90
  91 /**
  92  * Get the function block with pointers to the ipsecmod functions
  93  * @return the function block for "ipsecmod".
  94  */
  95 struct module_func_block* ipsecmod_get_funcblock(void);
  96
  97 #endif /* IPSECMOD_H */