Add DUNDi.... (http://www.dundi.com)

git-svn-id: http://svn.digium.com/svn/asterisk/trunk@4033 f38db490-d61c-443f-a65b-d21fe96a405b

1 files changed, 186 insertions, 0 deletions

diff --git a/include/asterisk/dundi.h b/include/asterisk/dundi.h
new file mode 100755
index 000000000..5780c3d52
--- /dev/null
+++ b/include/asterisk/dundi.h
@@ -0,0 +1,186 @@
+/*
+ * Distributed Universal Number Discovery (DUNDi)
+ *
+ * Copyright (C) 2004, Digium Inc.
+ *
+ * Written by Mark Spencer <markster@digium.com>
+ *
+ * This program is Free Software distributed under the terms of
+ * of the GNU General Public License.
+ */
+#ifndef _ASTERISK_DUNDI_H 
+#define _ASTERISK_DUNDI_H
+
+#include <asterisk/channel.h>
+
+#define DUNDI_PORT 4520
+
+/* A DUNDi Entity ID is essentially a MAC address, brief and unique */
+struct _dundi_eid {
+	unsigned char eid[6];
+} __attribute__ ((__packed__));
+
+typedef struct _dundi_eid dundi_eid;
+
+struct dundi_hdr {
+	unsigned short strans;			/* Source transaction */
+	unsigned short dtrans;			/* Destination transaction */
+	unsigned char iseqno;			/* Next expected incoming sequence number */
+	unsigned char oseqno;			/* Outgoing sequence number */
+	unsigned char cmdresp;			/* Command / Response */
+	unsigned char cmdflags;			/* Command / Response specific flags*/
+	unsigned char ies[0];
+} __attribute__ ((__packed__));
+
+struct dundi_ie_hdr {
+	unsigned char ie;
+	unsigned char len;
+	unsigned char iedata[0];
+} __attribute__ ((__packed__));
+
+#define DUNDI_FLAG_RETRANS			(1 << 16)	/* Applies to dtrans */
+#define DUNDI_FLAG_RESERVED			(1 << 16)	/* Applies to strans */
+
+#define DUNDI_PROTO_NONE			0	/* No answer yet */
+#define DUNDI_PROTO_IAX				1	/* IAX version 2 */
+#define DUNDI_PROTO_SIP				2	/* Session Initiation Protocol */
+#define DUNDI_PROTO_H323			3	/* ITU H.323 */
+
+#define DUNDI_FLAG_NONEXISTANT		(0)				/* Isn't and can't be a valid number */
+#define DUNDI_FLAG_EXISTS			(1 << 0)		/* Is a valid number */
+#define DUNDI_FLAG_MATCHMORE		(1 << 1)		/* Might be valid if you add more digits */
+#define DUNDI_FLAG_CANMATCH			(1 << 2)		/* Might be a match */
+#define DUNDI_FLAG_IGNOREPAT		(1 << 3)		/* Keep dialtone */
+#define DUNDI_FLAG_RESIDENTIAL		(1 << 4)		/* Destination known to be residential */
+#define DUNDI_FLAG_COMMERCIAL		(1 << 5)		/* Destination known to be commercial */
+#define DUNDI_FLAG_MOBILE			(1 << 6)		/* Destination known to be cellular/mobile */
+#define DUNDI_FLAG_NOUNSOLICITED	(1 << 7)		/* No unsolicited calls of any kind through this route */
+#define DUNDI_FLAG_NOCOMUNSOLICIT	(1 << 8)		/* No commercial unsolicited calls through this route */
+
+#define DUNDI_HINT_NONE				(0)
+#define DUNDI_HINT_TTL_EXPIRED		(1 << 0)		/* TTL Expired */
+#define DUNDI_HINT_DONT_ASK			(1 << 1)		/* Don't ask for anything beginning with data */
+#define DUNDI_HINT_UNAFFECTED		(1 << 2)		/* Answer not affected by entity list */
+
+struct dundi_encblock {				/* AES-128 encrypted block */
+	unsigned char iv[16];			/* Initialization vector of random data */
+	unsigned char encdata[0];		/* Encrypted / compressed data */
+} __attribute__ ((__packed__));
+
+struct dundi_answer {
+	dundi_eid eid;					/* Original source of answer */
+	unsigned char protocol;			/* Protocol (DUNDI_PROTO_*) */
+	unsigned short flags;			/* Flags relating to answer */
+	unsigned short weight;			/* Weight of answers */
+	unsigned char data[0];			/* Protocol specific URI */
+} __attribute__ ((__packed__));
+
+struct dundi_hint {
+	unsigned short flags;			/* Flags relating to answer */
+	unsigned char data[0];			/* For data for hint */
+} __attribute__ ((__packed__));
+
+#define DUNDI_CAUSE_SUCCESS			0	/* Success */
+#define DUNDI_CAUSE_GENERAL			1	/* General unspecified failure */
+#define DUNDI_CAUSE_DYNAMIC			2	/* Requested entity is dynamic */
+#define DUNDI_CAUSE_NOAUTH			3	/* No or improper authorization */
+#define DUNDI_CAUSE_DUPLICATE		4	/* Duplicate request */
+#define DUNDI_CAUSE_TTL_EXPIRED		5	/* Expired TTL */
+#define DUNDI_CAUSE_NEEDKEY			6	/* Need new session key to decode */
+#define DUNDI_CAUSE_BADENCRYPT		7	/* Badly encrypted data */
+
+struct dundi_cause {			
+	unsigned char causecode;		/* Numerical cause (DUNDI_CAUSE_*) */
+	char desc[0];					/* Textual description */
+} __attribute__ ((__packed__));
+
+#define DUNDI_COMMAND_FINAL			(0x80)		/* Or'd with other flags */
+
+#define DUNDI_COMMAND_ACK			(0 | 0x40)	/* Ack a message */
+#define DUNDI_COMMAND_DPDISCOVER	1			/* Request discovery */
+#define DUNDI_COMMAND_DPRESPONSE	(2 | 0x40)	/* Respond to a discovery request */
+#define DUNDI_COMMAND_EIDQUERY		3			/* Request information for a peer */
+#define DUNDI_COMMAND_EIDRESPONSE	(4 | 0x40)	/* Response to a peer query */
+#define DUNDI_COMMAND_INVALID		(7 | 0x40)	/* Invalid dialog state (does not require ack) */
+#define DUNDI_COMMAND_UNKNOWN		(8 | 0x40)	/* Unknown command */
+#define DUNDI_COMMAND_NULL			9			/* No-op */
+#define DUNDI_COMMAND_REGREQ		(10)		/* Register Request */
+#define DUNDI_COMMAND_REGRESPONSE	(11 | 0x40)	/* Register Response */
+#define DUNDI_COMMAND_CANCEL		(12)		/* Cancel transaction entirely */
+#define DUNDI_COMMAND_ENCRYPT		(13)		/* Send an encrypted message */
+#define DUNDI_COMMAND_ENCREJ		(14 | 0x40)	/* Reject an encrypted message */
+
+/*
+ * Remember that some information elements may occur
+ * more than one time within a message
+ */
+
+#define DUNDI_IE_EID				1	/* Entity identifier (dundi_eid) */
+#define DUNDI_IE_CALLED_CONTEXT		2	/* DUNDi Context (string) */
+#define DUNDI_IE_CALLED_NUMBER		3	/* Number of equivalent (string) */
+#define DUNDI_IE_EID_DIRECT			4	/* Entity identifier (dundi_eid), direct connect */
+#define DUNDI_IE_ANSWER				5	/* An answer (struct dundi_answer) */
+#define DUNDI_IE_TTL				6	/* Max TTL for this request / Remaining TTL for the response  (short)*/
+#define DUNDI_IE_VERSION			10	/* DUNDi version (should be 1) (short) */
+#define DUNDI_IE_EXPIRATION			11	/* Recommended expiration (short) */
+#define DUNDI_IE_UNKNOWN			12	/* Unknown command (byte) */
+#define DUNDI_IE_CAUSE				14	/* Success or cause of failure */
+#define DUNDI_IE_REQEID				15	/* EID being requested for EIDQUERY*/
+#define DUNDI_IE_ENCDATA			16	/* AES-128 encrypted data */
+#define DUNDI_IE_SHAREDKEY			17	/* RSA encrypted AES-128 key */
+#define DUNDI_IE_SIGNATURE			18	/* RSA Signature of encrypted shared key */
+#define DUNDI_IE_KEYCRC32			19	/* CRC32 of encrypted key (int) */
+#define DUNDI_IE_HINT				20	/* Answer hints (struct ast_hint) */
+
+#define DUNDI_IE_DEPARTMENT			21	/* Department, for EIDQUERY (string) */
+#define DUNDI_IE_ORGANIZATION		22	/* Organization, for EIDQUERY (string) */
+#define DUNDI_IE_LOCALITY			23	/* City/Locality, for EIDQUERY (string) */
+#define DUNDI_IE_STATE_PROV			24	/* State/Province, for EIDQUERY (string) */
+#define DUNDI_IE_COUNTRY			25	/* Country, for EIDQUERY (string) */
+#define DUNDI_IE_EMAIL				26	/* E-mail addy, for EIDQUERY (string) */
+#define DUNDI_IE_PHONE				27	/* Contact Phone, for EIDQUERY (string) */
+#define DUNDI_IE_IPADDR				28	/* IP Address, for EIDQUERY (string) */
+
+#define DUNDI_FLUFF_TIME			2000	/* Amount of time for answer */
+#define DUNDI_TTL_TIME				200		/* Incremental average time */
+
+#define DUNDI_DEFAULT_RETRANS		5
+#define DUNDI_DEFAULT_RETRANS_TIMER	1000
+#define DUNDI_DEFAULT_TTL			120	/* In seconds/hops like TTL */
+#define DUNDI_DEFAULT_VERSION		1
+#define DUNDI_DEFAULT_CACHE_TIME	3600	/* In seconds */
+#define DUNDI_DEFAULT_KEY_EXPIRE	3600	/* Life of shared key In seconds */
+#define DUNDI_DEF_EMPTY_CACHE_TIME	60	/* In seconds, cache of empty answer */
+#define DUNDI_WINDOW				1	/* Max 1 message in window */
+
+#define DEFAULT_MAXMS				2000
+
+struct dundi_result {
+	int flags;
+	int weight;
+	int expiration;
+	int techint;
+	dundi_eid eid;
+	char eid_str[20];
+	char tech[10];
+	char dest[256];
+};
+
+struct dundi_entity_info {
+	char country[80];
+	char stateprov[80];
+	char locality[80];
+	char org[80];
+	char orgunit[80];
+	char email[80];
+	char phone[80];	
+	char ipaddr[80];
+};
+
+/* 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.
+   returns the number of results found or -1 on a hangup of teh channel. */
+int dundi_lookup(struct dundi_result *result, int maxret, struct ast_channel *chan, const char *dcontext, const char *number);
+
+/* Retrieve information on a specific EID */
+int dundi_query_eid(struct dundi_entity_info *dei, const char *dcontext, dundi_eid eid);
+#endif /* _ASTERISK_DUNDI_H */