dns.h

Go to the documentation of this file.

/* 
 * Copyright (C) 2008-2011 Teluu Inc. (http://www.teluu.com)
 * Copyright (C) 2003-2008 Benny Prijono <benny@prijono.org>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA 
 */
#ifndef __PJLIB_UTIL_DNS_H__
#define __PJLIB_UTIL_DNS_H__
 
 
#include <pjlib-util/types.h>
#include <pj/sock.h>
 
PJ_BEGIN_DECL
 
enum
{
    PJ_DNS_CLASS_IN     = 1     
};
 
typedef enum pj_dns_type
{
    PJ_DNS_TYPE_A       = 1,    
    PJ_DNS_TYPE_NS      = 2,    
    PJ_DNS_TYPE_MD      = 3,    
    PJ_DNS_TYPE_MF      = 4,    
    PJ_DNS_TYPE_CNAME   = 5,    
    PJ_DNS_TYPE_SOA     = 6,    
    PJ_DNS_TYPE_MB      = 7,    
    PJ_DNS_TYPE_MG      = 8,    
    PJ_DNS_TYPE_MR      = 9,    
    PJ_DNS_TYPE_NULL    = 10,   
    PJ_DNS_TYPE_WKS     = 11,   
    PJ_DNS_TYPE_PTR     = 12,   
    PJ_DNS_TYPE_HINFO   = 13,   
    PJ_DNS_TYPE_MINFO   = 14,   
    PJ_DNS_TYPE_MX      = 15,   
    PJ_DNS_TYPE_TXT     = 16,   
    PJ_DNS_TYPE_RP      = 17,   
    PJ_DNS_TYPE_AFSB    = 18,   
    PJ_DNS_TYPE_X25     = 19,   
    PJ_DNS_TYPE_ISDN    = 20,   
    PJ_DNS_TYPE_RT      = 21,   
    PJ_DNS_TYPE_NSAP    = 22,   
    PJ_DNS_TYPE_NSAP_PTR= 23,   
    PJ_DNS_TYPE_SIG     = 24,   
    PJ_DNS_TYPE_KEY     = 25,   
    PJ_DNS_TYPE_PX      = 26,   
    PJ_DNS_TYPE_GPOS    = 27,   
    PJ_DNS_TYPE_AAAA    = 28,   
    PJ_DNS_TYPE_LOC     = 29,   
    PJ_DNS_TYPE_NXT     = 30,   
    PJ_DNS_TYPE_EID     = 31,   
    PJ_DNS_TYPE_NIMLOC  = 32,   
    PJ_DNS_TYPE_SRV     = 33,   
    PJ_DNS_TYPE_ATMA    = 34,   
    PJ_DNS_TYPE_NAPTR   = 35,   
    PJ_DNS_TYPE_KX      = 36,   
    PJ_DNS_TYPE_CERT    = 37,   
    PJ_DNS_TYPE_A6      = 38,   
    PJ_DNS_TYPE_DNAME   = 39,   
    PJ_DNS_TYPE_OPT     = 41,   
    PJ_DNS_TYPE_APL     = 42,   
    PJ_DNS_TYPE_DS      = 43,   
    PJ_DNS_TYPE_SSHFP   = 44,   
    PJ_DNS_TYPE_IPSECKEY= 45,   
    PJ_DNS_TYPE_RRSIG   = 46,   
    PJ_DNS_TYPE_NSEC    = 47,   
    PJ_DNS_TYPE_DNSKEY  = 48    
} pj_dns_type;
 
 
 
typedef struct pj_dns_hdr
{
    pj_uint16_t  id;        
    pj_uint16_t  flags;     
    pj_uint16_t  qdcount;   
    pj_uint16_t  anscount;  
    pj_uint16_t  nscount;   
    pj_uint16_t  arcount;   
} pj_dns_hdr;
 
#define PJ_DNS_SET_RCODE(c)     ((pj_uint16_t)((c) & 0x0F))
 
#define PJ_DNS_SET_RA(on)       ((pj_uint16_t)((on) << 7))
 
#define PJ_DNS_SET_RD(on)       ((pj_uint16_t)((on) << 8))
 
#define PJ_DNS_SET_TC(on)       ((pj_uint16_t)((on) << 9))
 
#define PJ_DNS_SET_AA(on)       ((pj_uint16_t)((on) << 10))
 
#define PJ_DNS_SET_OPCODE(o)    ((pj_uint16_t)((o)  << 11))
 
#define PJ_DNS_SET_QR(on)       ((pj_uint16_t)((on) << 15))
 
 
#define PJ_DNS_GET_RCODE(val)   (((val) & PJ_DNS_SET_RCODE(0x0F)) >> 0)
 
#define PJ_DNS_GET_RA(val)      (((val) & PJ_DNS_SET_RA(1)) >> 7)
 
#define PJ_DNS_GET_RD(val)      (((val) & PJ_DNS_SET_RD(1)) >> 8)
 
#define PJ_DNS_GET_TC(val)      (((val) & PJ_DNS_SET_TC(1)) >> 9)
 
#define PJ_DNS_GET_AA(val)      (((val) & PJ_DNS_SET_AA(1)) >> 10)
 
#define PJ_DNS_GET_OPCODE(val)  (((val) & PJ_DNS_SET_OPCODE(0x0F)) >> 11)
 
#define PJ_DNS_GET_QR(val)      (((val) & PJ_DNS_SET_QR(1)) >> 15)
 
 
typedef enum pj_dns_rcode
{
    PJ_DNS_RCODE_FORMERR    = 1,    
    PJ_DNS_RCODE_SERVFAIL   = 2,    
    PJ_DNS_RCODE_NXDOMAIN   = 3,    
    PJ_DNS_RCODE_NOTIMPL    = 4,    
    PJ_DNS_RCODE_REFUSED    = 5,    
    PJ_DNS_RCODE_YXDOMAIN   = 6,    
    PJ_DNS_RCODE_YXRRSET    = 7,    
    PJ_DNS_RCODE_NXRRSET    = 8,    
    PJ_DNS_RCODE_NOTAUTH    = 9,    
    PJ_DNS_RCODE_NOTZONE    = 10    
} pj_dns_rcode;
 
 
typedef struct pj_dns_parsed_query
{
    pj_str_t    name;       
    pj_uint16_t type;       
    pj_uint16_t dnsclass;   
} pj_dns_parsed_query;
 
 
typedef struct pj_dns_parsed_rr
{
    pj_str_t     name;      
    pj_uint16_t  type;      
    pj_uint16_t  dnsclass;  
    pj_uint32_t  ttl;       
    pj_uint16_t  rdlength;  
    void        *data;      
    union rdata
    {
        struct srv {
            pj_uint16_t prio;   
            pj_uint16_t weight; 
            pj_uint16_t port;   
            pj_str_t    target; 
        } srv; 
        struct cname {
            pj_str_t    name;   
        } cname; 
        struct ns {
            pj_str_t    name;   
        } ns; 
        struct ptr {
            pj_str_t    name;   
        } ptr; 
        struct a {
            pj_in_addr  ip_addr;
        } a; 
        struct aaaa {
            pj_in6_addr ip_addr;
        } aaaa; 
    } rdata;
 
} pj_dns_parsed_rr;
 
 
typedef struct pj_dns_parsed_packet
{
    pj_dns_hdr           hdr;   
    pj_dns_parsed_query *q;     
    pj_dns_parsed_rr    *ans;   
    pj_dns_parsed_rr    *ns;    
    pj_dns_parsed_rr    *arr;   
} pj_dns_parsed_packet;
 
 
enum pj_dns_dup_options
{
    PJ_DNS_NO_QD    = 1, 
    PJ_DNS_NO_ANS   = 2, 
    PJ_DNS_NO_NS    = 4, 
    PJ_DNS_NO_AR    = 8  
};
 
 
PJ_DECL(pj_status_t) pj_dns_make_query(void *packet,
                                       unsigned *size,
                                       pj_uint16_t id,
                                       int qtype,
                                       const pj_str_t *name);
 
PJ_DECL(pj_status_t) pj_dns_parse_packet(pj_pool_t *pool,
                                         const void *packet,
                                         unsigned size,
                                         pj_dns_parsed_packet **p_res);
 
PJ_DECL(void) pj_dns_packet_dup(pj_pool_t *pool,
                                const pj_dns_parsed_packet*p,
                                unsigned options,
                                pj_dns_parsed_packet **p_dst);
 
 
PJ_DECL(const char *) pj_dns_get_type_name(int type);
 
 
PJ_DECL(void) pj_dns_init_srv_rr(pj_dns_parsed_rr *rec,
                                 const pj_str_t *res_name,
                                 unsigned dnsclass,
                                 unsigned ttl,
                                 unsigned prio,
                                 unsigned weight,
                                 unsigned port,
                                 const pj_str_t *target);
 
PJ_DECL(void) pj_dns_init_cname_rr(pj_dns_parsed_rr *rec,
                                   const pj_str_t *res_name,
                                   unsigned dnsclass,
                                   unsigned ttl,
                                   const pj_str_t *name);
 
PJ_DECL(void) pj_dns_init_a_rr(pj_dns_parsed_rr *rec,
                               const pj_str_t *res_name,
                               unsigned dnsclass,
                               unsigned ttl,
                               const pj_in_addr *ip_addr);
 
PJ_DECL(void) pj_dns_init_aaaa_rr(pj_dns_parsed_rr *rec,
                                  const pj_str_t *res_name,
                                  unsigned dnsclass,
                                  unsigned ttl,
                                  const pj_in6_addr *ip_addr);
 
PJ_DECL(void) pj_dns_dump_packet(const pj_dns_parsed_packet *res);
 
 
PJ_END_DECL
 
 
#endif  /* __PJLIB_UTIL_DNS_H__ */