localzone.h

Go to the documentation of this file.

/*
 * services/localzone.h - local zones authority service.
 *
 * Copyright (c) 2007, 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 SERVICES_LOCALZONE_H
#define SERVICES_LOCALZONE_H
#include "util/rbtree.h"
#include "util/locks.h"
#include "util/storage/dnstree.h"
#include "util/module.h"
#include "services/view.h"
struct packed_rrset_data;
struct ub_packed_rrset_key;
struct regional;
struct config_file;
struct edns_data;
struct query_info;
struct sldns_buffer;
struct comm_reply;
struct config_strlist;

enum localzone_type {
    local_zone_unset = 0,
    local_zone_deny,
    local_zone_refuse,
    local_zone_static,
    local_zone_transparent,
    local_zone_typetransparent,
    local_zone_redirect,
    local_zone_nodefault,
    local_zone_inform,
    local_zone_inform_deny,  
    local_zone_always_transparent, 
    local_zone_always_refuse,
    local_zone_always_nxdomain,
    local_zone_noview
};

struct local_zones {
    lock_rw_type lock;
    rbtree_type ztree;
};

struct local_zone {
    rbnode_type node;
    struct local_zone* parent;

    uint8_t* name;
    size_t namelen;
    int namelabs;
    uint16_t dclass;

    lock_rw_type lock;

    enum localzone_type type;
    uint8_t* taglist;
    size_t taglen;
    struct rbtree_type* override_tree;

    struct regional* region;
    rbtree_type data;
    struct ub_packed_rrset_key* soa;
};

struct local_data {
    rbnode_type node;
    uint8_t* name;
    size_t namelen;
    int namelabs;
    struct local_rrset* rrsets;
};

struct local_rrset {
    struct local_rrset* next;
    struct ub_packed_rrset_key* rrset;
};

struct local_zone_override {
    struct addr_tree_node node;
    enum localzone_type type;
};

struct local_zones* local_zones_create(void);

void local_zones_delete(struct local_zones* zones);

int local_zones_apply_cfg(struct local_zones* zones, struct config_file* cfg);

int local_zone_cmp(const void* z1, const void* z2);

int local_data_cmp(const void* d1, const void* d2);

void local_zone_delete(struct local_zone* z);

struct local_zone* local_zones_tags_lookup(struct local_zones* zones, 
    uint8_t* name, size_t len, int labs, uint16_t dclass, uint16_t dtype,
    uint8_t* taglist, size_t taglen, int ignoretags);

struct local_zone* local_zones_lookup(struct local_zones* zones, 
    uint8_t* name, size_t len, int labs, uint16_t dclass, uint16_t dtype);

void local_zones_print(struct local_zones* zones);

int local_zones_answer(struct local_zones* zones, struct module_env* env,
    struct query_info* qinfo, struct edns_data* edns, struct sldns_buffer* buf,
    struct regional* temp, struct comm_reply* repinfo, uint8_t* taglist,
    size_t taglen, uint8_t* tagactions, size_t tagactionssize,
    struct config_strlist** tag_datas, size_t tag_datas_size,
    char** tagname, int num_tags, struct view* view);

int local_zone_str2type(const char* str, enum localzone_type* t);

const char* local_zone_type2str(enum localzone_type t);

struct local_zone* local_zones_find(struct local_zones* zones, 
    uint8_t* name, size_t len, int labs, uint16_t dclass);

struct local_zone* local_zones_add_zone(struct local_zones* zones, 
    uint8_t* name, size_t len, int labs, uint16_t dclass, 
    enum localzone_type tp);

void local_zones_del_zone(struct local_zones* zones, struct local_zone* zone);

int local_zones_add_RR(struct local_zones* zones, const char* rr);

void local_zones_del_data(struct local_zones* zones, 
    uint8_t* name, size_t len, int labs, uint16_t dclass);
 

int parse_dname(const char* str, uint8_t** res, size_t* len, int* labs);

int local_data_find_tag_datas(const struct query_info* qinfo,
    struct config_strlist* list, struct ub_packed_rrset_key* r,
    struct regional* temp);

enum localzone_type local_data_find_tag_action(const uint8_t* taglist,
    size_t taglen, const uint8_t* taglist2, size_t taglen2,
    const uint8_t* tagactions, size_t tagactionssize,
    enum localzone_type lzt, int* tag, char* const* tagname, int num_tags);

int local_zone_enter_defaults(struct local_zones* zones,
    struct config_file* cfg);

int rrstr_get_rr_content(const char* str, uint8_t** nm, uint16_t* type,
    uint16_t* dclass, time_t* ttl, uint8_t* rr, size_t len,
    uint8_t** rdata, size_t* rdata_len);

int rrset_insert_rr(struct regional* region, struct packed_rrset_data* pd,
    uint8_t* rdata, size_t rdata_len, time_t ttl, const char* rrstr);

enum respip_action {
    respip_none = local_zone_unset,
    respip_deny = local_zone_deny,
    respip_redirect = local_zone_redirect,
    respip_inform = local_zone_inform,
    respip_inform_deny = local_zone_inform_deny,
    respip_always_transparent = local_zone_always_transparent,
    respip_always_refuse = local_zone_always_refuse,
    respip_always_nxdomain = local_zone_always_nxdomain,
 
    /* The rest of the values are only possible as
     * access-control-tag-action */

    respip_refuse = local_zone_refuse,
    respip_static = local_zone_static,
    respip_transparent = local_zone_transparent,
    respip_typetransparent = local_zone_typetransparent,
};
 
#endif /* SERVICES_LOCALZONE_H */