subnetmod.h

Go to the documentation of this file.

/*
 * edns-subnet/subnetmod.h - edns subnet module. Must be called before validator
 * and iterator.
 *
 * Copyright (c) 2013, NLnet Labs. All rights reserved.
 *
 * This software is open source.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 
 * Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 * 
 * Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 * 
 * Neither the name of the NLNET LABS nor the names of its contributors may
 * be used to endorse or promote products derived from this software without
 * specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
 * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
#ifndef SUBNETMOD_H
#define SUBNETMOD_H
#include "util/module.h"
#include "services/outbound_list.h"
#include "util/alloc.h"
#include "util/net_help.h"
#include "util/storage/slabhash.h"
#include "edns-subnet/addrtree.h"
#include "edns-subnet/edns-subnet.h"

struct subnet_env {
    struct slabhash* subnet_msg_cache;
    struct ecs_whitelist* whitelist;
    struct alloc_cache alloc;
    lock_rw_type biglock;
};
 
struct subnet_msg_cache_data {
    struct addrtree* tree4;
    struct addrtree* tree6;
};
 
struct subnet_qstate {
    hashvalue_type qinfo_hash;
    struct ecs_data ecs_client_in;
    struct ecs_data ecs_client_out;
    struct ecs_data ecs_server_in;
    struct ecs_data ecs_server_out;
    int subnet_downstream;
    int subnet_sent;
};
 
void subnet_data_delete(void* d, void* ATTR_UNUSED(arg));
size_t msg_cache_sizefunc(void* k, void* d);

struct module_func_block* subnetmod_get_funcblock(void);

int subnetmod_init(struct module_env* env, int id);

void subnetmod_deinit(struct module_env* env, int id);

void subnetmod_operate(struct module_qstate* qstate, enum module_ev event,
    int id, struct outbound_entry* outbound);

void subnetmod_inform_super(struct module_qstate* qstate, int id,
    struct module_qstate* super);

void subnetmod_clear(struct module_qstate* qstate, int id);

size_t subnetmod_get_mem(struct module_env* env, int id);

size_t unittest_wrapper_subnetmod_sizefunc(void *elemptr);

int ecs_whitelist_check(struct query_info* qinfo, uint16_t flags,
    struct module_qstate* qstate, struct sockaddr_storage* addr,
    socklen_t addrlen, uint8_t* zone, size_t zonelen,
    struct regional* region, int id, void* cbargs);

int ecs_edns_back_parsed(struct module_qstate* qstate, int id, void* cbargs);

int ecs_query_response(struct module_qstate* qstate, struct dns_msg* response,
    int id, void* cbargs);
 
#endif /* SUBNETMOD_H */