packed_rrset.h

Go to the documentation of this file.

/*
 * util/data/packed_rrset.h - data storage for a set of resource records.
 *
 * 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 UTIL_DATA_PACKED_RRSET_H
#define UTIL_DATA_PACKED_RRSET_H
#include "util/storage/lruhash.h"
struct alloc_cache;
struct regional;

typedef uint64_t rrset_id_type;

#define PACKED_RRSET_NSEC_AT_APEX 0x1
#define PACKED_RRSET_PARENT_SIDE 0x2
#define PACKED_RRSET_SOA_NEG 0x4
#define PACKED_RRSET_FIXEDTTL 0x80000000

#define RR_COUNT_MAX 0xffffff

struct packed_rrset_key {
    uint8_t* dname;
    size_t dname_len;
    uint32_t flags;
    uint16_t type;
    uint16_t rrset_class;
};

struct ub_packed_rrset_key {
    struct lruhash_entry entry;
    rrset_id_type id;
    struct packed_rrset_key rk;
};

enum rrset_trust {
    rrset_trust_none = 0,
    rrset_trust_add_noAA,
    rrset_trust_auth_noAA,
    rrset_trust_add_AA,
    rrset_trust_nonauth_ans_AA,
    rrset_trust_ans_noAA,
    rrset_trust_glue,
    rrset_trust_auth_AA,
    rrset_trust_ans_AA,
    rrset_trust_sec_noglue,
    rrset_trust_prim_noglue,
    rrset_trust_validated,
    rrset_trust_ultimate
};

enum sec_status {
    sec_status_unchecked = 0,
    sec_status_bogus,
    sec_status_indeterminate,
    sec_status_insecure,
    sec_status_secure_sentinel_fail,
    sec_status_secure
};

struct packed_rrset_data {
    time_t ttl;
    size_t count;
    size_t rrsig_count;
    enum rrset_trust trust; 
    enum sec_status security;
    size_t* rr_len;
    time_t *rr_ttl;
    uint8_t** rr_data;
};

struct packed_rrset {
    struct packed_rrset_key* k;
    struct packed_rrset_data* d;
};

struct packed_rrset_list {
    struct packed_rrset_list* next;
    struct packed_rrset rrset;
};

void ub_packed_rrset_parsedelete(struct ub_packed_rrset_key* pkey,
    struct alloc_cache* alloc);

size_t packed_rrset_sizeof(struct packed_rrset_data* data);

time_t ub_packed_rrset_ttl(struct ub_packed_rrset_key* key);

size_t ub_rrset_sizefunc(void* key, void* data);

int ub_rrset_compare(void* k1, void* k2);

int rrsetdata_equal(struct packed_rrset_data* d1, struct packed_rrset_data* d2);

void ub_rrset_key_delete(void* key, void* userdata);

void rrset_data_delete(void* data, void* userdata);

hashvalue_type rrset_key_hash(struct packed_rrset_key* key);

void packed_rrset_ptr_fixup(struct packed_rrset_data* data);

void packed_rrset_ttl_add(struct packed_rrset_data* data, time_t add);

void get_cname_target(struct ub_packed_rrset_key* rrset, uint8_t** dname, 
    size_t* dname_len);

const char* rrset_trust_to_string(enum rrset_trust s);

const char* sec_status_to_string(enum sec_status s);

void log_rrset_key(enum verbosity_value v, const char* str, 
    struct ub_packed_rrset_key* rrset);

int packed_rr_to_string(struct ub_packed_rrset_key* rrset, size_t i,
    time_t now, char* dest, size_t dest_len);

void log_packed_rrset(enum verbosity_value v, const char* str,
    struct ub_packed_rrset_key* rrset);

struct ub_packed_rrset_key* packed_rrset_copy_region(
    struct ub_packed_rrset_key* key, struct regional* region, 
    time_t now);

struct ub_packed_rrset_key* packed_rrset_copy_alloc(
    struct ub_packed_rrset_key* key, struct alloc_cache* alloc, 
    time_t now);
 
#endif /* UTIL_DATA_PACKED_RRSET_H */