add missing newlines, fix misspelling of nonexistent (bug #4027)
[asterisk/asterisk.git] / include / asterisk / dundi.h
1 /*
2  * Distributed Universal Number Discovery (DUNDi)
3  *
4  * Copyright (C) 2004 - 2005, Digium Inc.
5  *
6  * Written by Mark Spencer <markster@digium.com>
7  *
8  * This program is Free Software distributed under the terms of
9  * of the GNU General Public License.
10  */
11 #ifndef _ASTERISK_DUNDI_H 
12 #define _ASTERISK_DUNDI_H
13
14 #include <asterisk/channel.h>
15
16 #define DUNDI_PORT 4520
17
18 /* A DUNDi Entity ID is essentially a MAC address, brief and unique */
19 struct _dundi_eid {
20         unsigned char eid[6];
21 } __attribute__ ((__packed__));
22
23 typedef struct _dundi_eid dundi_eid;
24
25 struct dundi_hdr {
26         unsigned short strans;                  /* Source transaction */
27         unsigned short dtrans;                  /* Destination transaction */
28         unsigned char iseqno;                   /* Next expected incoming sequence number */
29         unsigned char oseqno;                   /* Outgoing sequence number */
30         unsigned char cmdresp;                  /* Command / Response */
31         unsigned char cmdflags;                 /* Command / Response specific flags*/
32         unsigned char ies[0];
33 } __attribute__ ((__packed__));
34
35 struct dundi_ie_hdr {
36         unsigned char ie;
37         unsigned char len;
38         unsigned char iedata[0];
39 } __attribute__ ((__packed__));
40
41 #define DUNDI_FLAG_RETRANS                      (1 << 16)       /* Applies to dtrans */
42 #define DUNDI_FLAG_RESERVED                     (1 << 16)       /* Applies to strans */
43
44 #define DUNDI_PROTO_NONE                        0       /* No answer yet */
45 #define DUNDI_PROTO_IAX                         1       /* IAX version 2 */
46 #define DUNDI_PROTO_SIP                         2       /* Session Initiation Protocol */
47 #define DUNDI_PROTO_H323                        3       /* ITU H.323 */
48
49 #define DUNDI_FLAG_NONEXISTENT          (0)                             /* Isn't and can't be a valid number */
50 #define DUNDI_FLAG_EXISTS                       (1 << 0)                /* Is a valid number */
51 #define DUNDI_FLAG_MATCHMORE            (1 << 1)                /* Might be valid if you add more digits */
52 #define DUNDI_FLAG_CANMATCH                     (1 << 2)                /* Might be a match */
53 #define DUNDI_FLAG_IGNOREPAT            (1 << 3)                /* Keep dialtone */
54 #define DUNDI_FLAG_RESIDENTIAL          (1 << 4)                /* Destination known to be residential */
55 #define DUNDI_FLAG_COMMERCIAL           (1 << 5)                /* Destination known to be commercial */
56 #define DUNDI_FLAG_MOBILE                       (1 << 6)                /* Destination known to be cellular/mobile */
57 #define DUNDI_FLAG_NOUNSOLICITED        (1 << 7)                /* No unsolicited calls of any kind through this route */
58 #define DUNDI_FLAG_NOCOMUNSOLICIT       (1 << 8)                /* No commercial unsolicited calls through this route */
59
60 #define DUNDI_HINT_NONE                         (0)
61 #define DUNDI_HINT_TTL_EXPIRED          (1 << 0)                /* TTL Expired */
62 #define DUNDI_HINT_DONT_ASK                     (1 << 1)                /* Don't ask for anything beginning with data */
63 #define DUNDI_HINT_UNAFFECTED           (1 << 2)                /* Answer not affected by entity list */
64
65 struct dundi_encblock {                         /* AES-128 encrypted block */
66         unsigned char iv[16];                   /* Initialization vector of random data */
67         unsigned char encdata[0];               /* Encrypted / compressed data */
68 } __attribute__ ((__packed__));
69
70 struct dundi_answer {
71         dundi_eid eid;                                  /* Original source of answer */
72         unsigned char protocol;                 /* Protocol (DUNDI_PROTO_*) */
73         unsigned short flags;                   /* Flags relating to answer */
74         unsigned short weight;                  /* Weight of answers */
75         unsigned char data[0];                  /* Protocol specific URI */
76 } __attribute__ ((__packed__));
77
78 struct dundi_hint {
79         unsigned short flags;                   /* Flags relating to answer */
80         unsigned char data[0];                  /* For data for hint */
81 } __attribute__ ((__packed__));
82
83 #define DUNDI_CAUSE_SUCCESS                     0       /* Success */
84 #define DUNDI_CAUSE_GENERAL                     1       /* General unspecified failure */
85 #define DUNDI_CAUSE_DYNAMIC                     2       /* Requested entity is dynamic */
86 #define DUNDI_CAUSE_NOAUTH                      3       /* No or improper authorization */
87 #define DUNDI_CAUSE_DUPLICATE           4       /* Duplicate request */
88 #define DUNDI_CAUSE_TTL_EXPIRED         5       /* Expired TTL */
89 #define DUNDI_CAUSE_NEEDKEY                     6       /* Need new session key to decode */
90 #define DUNDI_CAUSE_BADENCRYPT          7       /* Badly encrypted data */
91
92 struct dundi_cause {                    
93         unsigned char causecode;                /* Numerical cause (DUNDI_CAUSE_*) */
94         char desc[0];                                   /* Textual description */
95 } __attribute__ ((__packed__));
96
97 struct dundi_peer_status {
98         unsigned int flags;
99         unsigned short netlag;
100         unsigned short querylag;
101         dundi_eid peereid;
102 } __attribute__ ((__packed__));
103
104 #define DUNDI_PEER_PRIMARY                      (1 << 0)
105 #define DUNDI_PEER_SECONDARY            (1 << 1)
106 #define DUNDI_PEER_UNAVAILABLE          (1 << 2)
107 #define DUNDI_PEER_REGISTERED           (1 << 3)
108 #define DUNDI_PEER_MOD_OUTBOUND         (1 << 4)
109 #define DUNDI_PEER_MOD_INBOUND          (1 << 5)
110 #define DUNDI_PEER_PCMOD_OUTBOUND       (1 << 6)
111 #define DUNDI_PEER_PCMOD_INBOUND        (1 << 7)
112
113 #define DUNDI_COMMAND_FINAL                     (0x80)          /* Or'd with other flags */
114
115 #define DUNDI_COMMAND_ACK                       (0 | 0x40)      /* Ack a message */
116 #define DUNDI_COMMAND_DPDISCOVER        1                       /* Request discovery */
117 #define DUNDI_COMMAND_DPRESPONSE        (2 | 0x40)      /* Respond to a discovery request */
118 #define DUNDI_COMMAND_EIDQUERY          3                       /* Request information for a peer */
119 #define DUNDI_COMMAND_EIDRESPONSE       (4 | 0x40)      /* Response to a peer query */
120 #define DUNDI_COMMAND_PRECACHERQ        5                       /* Pre-cache Request */
121 #define DUNDI_COMMAND_PRECACHERP        (6 | 0x40)      /* Pre-cache Response */
122 #define DUNDI_COMMAND_INVALID           (7 | 0x40)      /* Invalid dialog state (does not require ack) */
123 #define DUNDI_COMMAND_UNKNOWN           (8 | 0x40)      /* Unknown command */
124 #define DUNDI_COMMAND_NULL                      9                       /* No-op */
125 #define DUNDI_COMMAND_REGREQ            (10)            /* Register Request */
126 #define DUNDI_COMMAND_REGRESPONSE       (11 | 0x40)     /* Register Response */
127 #define DUNDI_COMMAND_CANCEL            (12)            /* Cancel transaction entirely */
128 #define DUNDI_COMMAND_ENCRYPT           (13)            /* Send an encrypted message */
129 #define DUNDI_COMMAND_ENCREJ            (14 | 0x40)     /* Reject an encrypted message */
130
131 #define DUNDI_COMMAND_STATUS            15                      /* Status command */
132
133 /*
134  * Remember that some information elements may occur
135  * more than one time within a message
136  */
137
138 #define DUNDI_IE_EID                            1       /* Entity identifier (dundi_eid) */
139 #define DUNDI_IE_CALLED_CONTEXT         2       /* DUNDi Context (string) */
140 #define DUNDI_IE_CALLED_NUMBER          3       /* Number of equivalent (string) */
141 #define DUNDI_IE_EID_DIRECT                     4       /* Entity identifier (dundi_eid), direct connect */
142 #define DUNDI_IE_ANSWER                         5       /* An answer (struct dundi_answer) */
143 #define DUNDI_IE_TTL                            6       /* Max TTL for this request / Remaining TTL for the response  (short)*/
144 #define DUNDI_IE_VERSION                        10      /* DUNDi version (should be 1) (short) */
145 #define DUNDI_IE_EXPIRATION                     11      /* Recommended expiration (short) */
146 #define DUNDI_IE_UNKNOWN                        12      /* Unknown command (byte) */
147 #define DUNDI_IE_CAUSE                          14      /* Success or cause of failure */
148 #define DUNDI_IE_REQEID                         15      /* EID being requested for EIDQUERY*/
149 #define DUNDI_IE_ENCDATA                        16      /* AES-128 encrypted data */
150 #define DUNDI_IE_SHAREDKEY                      17      /* RSA encrypted AES-128 key */
151 #define DUNDI_IE_SIGNATURE                      18      /* RSA Signature of encrypted shared key */
152 #define DUNDI_IE_KEYCRC32                       19      /* CRC32 of encrypted key (int) */
153 #define DUNDI_IE_HINT                           20      /* Answer hints (struct ast_hint) */
154
155 #define DUNDI_IE_DEPARTMENT                     21      /* Department, for EIDQUERY (string) */
156 #define DUNDI_IE_ORGANIZATION           22      /* Organization, for EIDQUERY (string) */
157 #define DUNDI_IE_LOCALITY                       23      /* City/Locality, for EIDQUERY (string) */
158 #define DUNDI_IE_STATE_PROV                     24      /* State/Province, for EIDQUERY (string) */
159 #define DUNDI_IE_COUNTRY                        25      /* Country, for EIDQUERY (string) */
160 #define DUNDI_IE_EMAIL                          26      /* E-mail addy, for EIDQUERY (string) */
161 #define DUNDI_IE_PHONE                          27      /* Contact Phone, for EIDQUERY (string) */
162 #define DUNDI_IE_IPADDR                         28      /* IP Address, for EIDQUERY (string) */
163 #define DUNDI_IE_CACHEBYPASS            29      /* Bypass cache (empty) */
164
165 #define DUNDI_IE_PEERSTATUS                     30      /* Peer/peer status (struct dundi_peer_status) */
166
167 #define DUNDI_FLUFF_TIME                        2000    /* Amount of time for answer */
168 #define DUNDI_TTL_TIME                          200             /* Incremental average time */
169
170 #define DUNDI_DEFAULT_RETRANS           5
171 #define DUNDI_DEFAULT_RETRANS_TIMER     1000
172 #define DUNDI_DEFAULT_TTL                       120     /* In seconds/hops like TTL */
173 #define DUNDI_DEFAULT_VERSION           1
174 #define DUNDI_DEFAULT_CACHE_TIME        3600    /* In seconds */
175 #define DUNDI_DEFAULT_KEY_EXPIRE        3600    /* Life of shared key In seconds */
176 #define DUNDI_DEF_EMPTY_CACHE_TIME      60      /* In seconds, cache of empty answer */
177 #define DUNDI_WINDOW                            1       /* Max 1 message in window */
178
179 #define DEFAULT_MAXMS                           2000
180
181 struct dundi_result {
182         unsigned int flags;
183         int weight;
184         int expiration;
185         int techint;
186         dundi_eid eid;
187         char eid_str[20];
188         char tech[10];
189         char dest[256];
190 };
191
192 struct dundi_entity_info {
193         char country[80];
194         char stateprov[80];
195         char locality[80];
196         char org[80];
197         char orgunit[80];
198         char email[80];
199         char phone[80]; 
200         char ipaddr[80];
201 };
202
203 /* Lookup the given number in the given dundi context (or e164 if unspecified) using the given callerid (if specified) and return up to maxret results in the array specified.
204    returns the number of results found or -1 on a hangup of teh channel. */
205 int dundi_lookup(struct dundi_result *result, int maxret, struct ast_channel *chan, const char *dcontext, const char *number, int nocache);
206
207 /* Retrieve information on a specific EID */
208 int dundi_query_eid(struct dundi_entity_info *dei, const char *dcontext, dundi_eid eid);
209
210 /* Pre-cache to push upstream peers */
211 int dundi_precache(const char *dcontext, const char *number);
212 #endif /* _ASTERISK_DUNDI_H */