unbound.h

Go to the documentation of this file.

/*
 * unbound.h - unbound validating resolver public API
 *
 * 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 _UB_UNBOUND_H
#define _UB_UNBOUND_H
 
#ifdef __cplusplus
extern "C" {
#endif

#define UNBOUND_VERSION_MAJOR @UNBOUND_VERSION_MAJOR@
#define UNBOUND_VERSION_MINOR @UNBOUND_VERSION_MINOR@
#define UNBOUND_VERSION_MICRO @UNBOUND_VERSION_MICRO@

struct ub_ctx;

struct ub_result {
    char* qname;
    int qtype;
    int qclass;

    char** data;

    int* len;

    char* canonname;

    int rcode;

    void* answer_packet;
    int answer_len;

    int havedata;

    int nxdomain;

    int secure;

    int bogus;
    
    char* why_bogus;

    int ttl;
};

typedef void (*ub_callback_type)(void*, int, struct ub_result*);

struct ub_ctx* ub_ctx_create(void);

void ub_ctx_delete(struct ub_ctx* ctx);

int ub_ctx_set_option(struct ub_ctx* ctx, const char* opt, const char* val);

int ub_ctx_get_option(struct ub_ctx* ctx, const char* opt, char** str);

int ub_ctx_config(struct ub_ctx* ctx, const char* fname);

int ub_ctx_set_fwd(struct ub_ctx* ctx, const char* addr);

int ub_ctx_set_stub(struct ub_ctx* ctx, const char* zone, const char* addr,
    int isprime);

int ub_ctx_resolvconf(struct ub_ctx* ctx, const char* fname);

int ub_ctx_hosts(struct ub_ctx* ctx, const char* fname);

int ub_ctx_add_ta(struct ub_ctx* ctx, const char* ta);

int ub_ctx_add_ta_file(struct ub_ctx* ctx, const char* fname);

int ub_ctx_add_ta_autr(struct ub_ctx* ctx, const char* fname);

int ub_ctx_trustedkeys(struct ub_ctx* ctx, const char* fname);

int ub_ctx_debugout(struct ub_ctx* ctx, void* out);

int ub_ctx_debuglevel(struct ub_ctx* ctx, int d);

int ub_ctx_async(struct ub_ctx* ctx, int dothread);

int ub_poll(struct ub_ctx* ctx);

int ub_wait(struct ub_ctx* ctx);

int ub_fd(struct ub_ctx* ctx);

int ub_process(struct ub_ctx* ctx);

int ub_resolve(struct ub_ctx* ctx, const char* name, int rrtype, 
    int rrclass, struct ub_result** result);

int ub_resolve_async(struct ub_ctx* ctx, const char* name, int rrtype, 
    int rrclass, void* mydata, ub_callback_type callback, int* async_id);

int ub_cancel(struct ub_ctx* ctx, int async_id);

void ub_resolve_free(struct ub_result* result);

const char* ub_strerror(int err);

int ub_ctx_print_local_zones(struct ub_ctx* ctx);

int ub_ctx_zone_add(struct ub_ctx* ctx, const char *zone_name, 
    const char *zone_type);

int ub_ctx_zone_remove(struct ub_ctx* ctx, const char *zone_name);

int ub_ctx_data_add(struct ub_ctx* ctx, const char *data);

int ub_ctx_data_remove(struct ub_ctx* ctx, const char *data);

const char* ub_version(void);

struct ub_shm_stat_info {
    int num_threads;
 
    struct {
        long long now_sec, now_usec;
        long long up_sec, up_usec;
        long long elapsed_sec, elapsed_usec;
    } time;
 
    struct {
        long long msg;
        long long rrset;
        long long val;
        long long iter;
        long long subnet;
        long long ipsecmod;
        long long respip;
        long long dnscrypt_shared_secret;
        long long dnscrypt_nonce;
    } mem;
};

#define UB_STATS_QTYPE_NUM 256
#define UB_STATS_QCLASS_NUM 256
#define UB_STATS_RCODE_NUM 16
#define UB_STATS_OPCODE_NUM 16
#define UB_STATS_BUCKET_NUM 40

struct ub_server_stats {
    long long num_queries;
    long long num_queries_ip_ratelimited;
    long long num_queries_missed_cache;
    long long num_queries_prefetch;

    long long sum_query_list_size;
    long long max_query_list_size;

    int extended;

    long long qtype[UB_STATS_QTYPE_NUM];
    long long qtype_big;
    long long qclass[UB_STATS_QCLASS_NUM];
    long long qclass_big;
    long long qopcode[UB_STATS_OPCODE_NUM];
    long long qtcp;
    long long qtcp_outgoing;
    long long qipv6;
    long long qbit_QR;
    long long qbit_AA;
    long long qbit_TC;
    long long qbit_RD;
    long long qbit_RA;
    long long qbit_Z;
    long long qbit_AD;
    long long qbit_CD;
    long long qEDNS;
    long long qEDNS_DO;
    long long ans_rcode[UB_STATS_RCODE_NUM];
    long long ans_rcode_nodata;
    long long ans_secure;
    long long ans_bogus;
    long long rrset_bogus;
    long long queries_ratelimited;
    long long unwanted_replies;
    long long unwanted_queries;
    long long tcp_accept_usage;
    long long zero_ttl_responses;
    long long hist[UB_STATS_BUCKET_NUM];
    
    long long msg_cache_count;
    long long rrset_cache_count;
    long long infra_cache_count;
    long long key_cache_count;

    long long num_query_dnscrypt_crypted;
    long long num_query_dnscrypt_cert;
    long long num_query_dnscrypt_cleartext;
    long long num_query_dnscrypt_crypted_malformed;
    long long num_query_dnscrypt_secret_missed_cache;
    long long shared_secret_cache_count;
    long long num_query_dnscrypt_replay;
    long long nonce_cache_count;
    long long num_query_authzone_up;
    long long num_query_authzone_down;
    long long num_neg_cache_noerror;
    long long num_neg_cache_nxdomain;
};

struct ub_stats_info {
    struct ub_server_stats svr;

    long long mesh_num_states;
    long long mesh_num_reply_states;
    long long mesh_jostled;
    long long mesh_dropped;
    long long mesh_replies_sent;
    long long mesh_replies_sum_wait_sec, mesh_replies_sum_wait_usec;
    double mesh_time_median;
};
 
#ifdef __cplusplus
}
#endif
 
#endif /* _UB_UNBOUND_H */