d17def8e589b8577b8ae96e29a1ac8036b8c100f
[asterisk/asterisk.git] / channels / iax2 / include / parser.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Implementation of Inter-Asterisk eXchange
5  * 
6  * Copyright (C) 2003, Digium
7  *
8  * Mark Spencer <markster@digium.com>
9  *
10  * This program is free software, distributed under the terms of
11  * the GNU General Public License
12  */
13
14 /*!\file
15  * \brief Implementation of the IAX2 protocol
16  */
17  
18 #ifndef _IAX2_PARSER_H
19 #define _IAX2_PARSER_H
20
21 #include "asterisk/frame.h"
22 #include "asterisk/linkedlists.h"
23 #include "asterisk/crypto.h"
24 #include "iax2.h"
25
26 struct iax_ies {
27         char *called_number;
28         char *calling_number;
29         char *calling_ani;
30         char *calling_name;
31         int calling_ton;
32         int calling_tns;
33         int calling_pres;
34         char *called_context;
35         char *username;
36         char *password;
37         iax2_format capability;
38         iax2_format format;
39         char *codec_prefs;
40         char *language;
41         int version;
42         unsigned short adsicpe;
43         char *dnid;
44         char *rdnis;
45         unsigned int authmethods;
46         unsigned int encmethods;
47         char *challenge;
48         char *md5_result;
49         char *rsa_result;
50         struct ast_sockaddr apparent_addr;
51         unsigned short refresh;
52         unsigned short dpstatus;
53         unsigned short callno;
54         char *cause;
55         unsigned char causecode;
56         unsigned char iax_unknown;
57         int msgcount;
58         int autoanswer;
59         int musiconhold;
60         unsigned int transferid;
61         unsigned int datetime;
62         char *devicetype;
63         char *serviceident;
64         int firmwarever;
65         unsigned int fwdesc;
66         unsigned char *fwdata;
67         unsigned char fwdatalen;
68         unsigned char *enckey;
69         unsigned char enckeylen;
70         unsigned int provver;
71         unsigned short samprate;
72         int provverpres;
73         unsigned int rr_jitter;
74         unsigned int rr_loss;
75         unsigned int rr_pkts;
76         unsigned short rr_delay;
77         unsigned int rr_dropped;
78         unsigned int rr_ooo;
79         struct ast_variable *vars;
80         char *osptokenblock[IAX_MAX_OSPBLOCK_NUM];
81         unsigned int ospblocklength[IAX_MAX_OSPBLOCK_NUM];
82         unsigned char calltoken;
83         unsigned char *calltokendata;
84 };
85
86 #define DIRECTION_INGRESS 1
87 #define DIRECTION_OUTGRESS 2
88
89 struct iax_frame {
90 #ifdef LIBIAX
91         struct iax_session *session;
92         struct iax_event *event;
93 #else
94         int sockfd;
95 #endif
96
97         /*! /Our/ call number */
98         unsigned short callno;
99         /*! /Their/ call number */
100         unsigned short dcallno;
101         /*! Start of raw frame (outgoing only) */
102         void *data;
103         /*! Length of frame (outgoing only) */
104         int datalen;
105         /*! How many retries so far? */
106         int retries;
107         /*! Outgoing relative timestamp (ms) */
108         unsigned int ts;
109         /*! How long to wait before retrying */
110         int retrytime;
111         /*! Are we received out of order?  */
112         unsigned int outoforder:1;
113         /*! Have we been sent at all yet? */
114         unsigned int sentyet:1;
115         /*! Non-zero if should be sent to transfer peer */
116         unsigned int transfer:1;
117         /*! Non-zero if this is the final message */
118         unsigned int final:1;
119         /*! Ingress or outgres */
120         unsigned int direction:2;
121         /*! Can this frame be cached? */
122         unsigned int cacheable:1;
123         /*! Outgoing Packet sequence number */
124         int oseqno;
125         /*! Next expected incoming packet sequence number */
126         int iseqno;
127         /*! Retransmission ID */
128         int retrans;
129         /*! is this packet encrypted or not. if set this varible holds encryption methods*/
130         int encmethods;
131         /*! store encrypt key */
132         ast_aes_encrypt_key ecx;
133         /*! store decrypt key which corresponds to ecx */
134         ast_aes_decrypt_key mydcx;
135         /*! random data for encryption pad */
136         unsigned char semirand[32];
137         /*! Easy linking */
138         AST_LIST_ENTRY(iax_frame) list;
139         /*! Actual, isolated frame header */
140         struct ast_frame af;
141         /*! Amount of space _allocated_ for data */
142         size_t afdatalen;
143         unsigned char unused[AST_FRIENDLY_OFFSET];
144         unsigned char afdata[0];        /* Data for frame */
145 };
146
147 struct iax_ie_data {
148         unsigned char buf[1024];
149         int pos;
150 };
151
152 /* Choose a different function for output */
153 void iax_set_output(void (*output)(const char *data));
154 /* Choose a different function for errors */
155 void iax_set_error(void (*output)(const char *data));
156 void iax_showframe(struct iax_frame *f, struct ast_iax2_full_hdr *fhi, int rx, struct ast_sockaddr *addr, int datalen);
157 void iax_frame_subclass2str(enum iax_frame_subclass subclass, char *str, size_t len);
158
159 const char *iax_ie2str(int ie);
160
161 int iax_ie_append_raw(struct iax_ie_data *ied, unsigned char ie, const void *data, int datalen);
162 int iax_ie_append_addr(struct iax_ie_data *ied, unsigned char ie, const struct ast_sockaddr *addr);
163 int iax_ie_append_versioned_uint64(struct iax_ie_data *ied, unsigned char ie, unsigned char version, uint64_t value);
164 int iax_ie_append_int(struct iax_ie_data *ied, unsigned char ie, unsigned int value);
165 int iax_ie_append_short(struct iax_ie_data *ied, unsigned char ie, unsigned short value);
166 int iax_ie_append_str(struct iax_ie_data *ied, unsigned char ie, const char *str);
167 int iax_ie_append_byte(struct iax_ie_data *ied, unsigned char ie, unsigned char dat);
168 int iax_ie_append(struct iax_ie_data *ied, unsigned char ie);
169 int iax_parse_ies(struct iax_ies *ies, unsigned char *data, int datalen);
170
171 int iax_get_frames(void);
172 int iax_get_iframes(void);
173 int iax_get_oframes(void);
174
175 void iax_frame_wrap(struct iax_frame *fr, struct ast_frame *f);
176 struct iax_frame *iax_frame_new(int direction, int datalen, unsigned int cacheable);
177 void iax_frame_free(struct iax_frame *fr);
178 #endif