3 * Copyright (C) 2003, Digium
4 * Mark Spencer <markster@digium.com>
8 * Wireshark - Network traffic analyzer
9 * By Gerald Combs <gerald@wireshark.org>
10 * Copyright 1998 Gerald Combs
12 * This program is free software; you can redistribute it and/or
13 * modify it under the terms of the GNU General Public License
14 * as published by the Free Software Foundation; either version 2
15 * of the License, or (at your option) any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, write to the Free Software
24 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
27 #ifndef _PACKET_IAX2_H
28 #define _PACKET_IAX2_H
30 #include <epan/tap-voip.h>
32 /* Max version of IAX protocol we support */
33 #define IAX_PROTO_VERSION 2
35 #define IAX_MAX_CALLS 32768
37 #define IAX_FLAG_FULL 0x8000
39 #define IAX_FLAG_RETRANS 0x8000
41 #define IAX_FLAG_SC_LOG 0x80
43 #define IAX_MAX_SHIFT 0x1F
47 #define AST_FRAME_DTMF_END 1 /* A DTMF end event, subclass is the digit */
48 #define AST_FRAME_VOICE 2 /* Voice data, subclass is AST_FORMAT_* */
49 #define AST_FRAME_VIDEO 3 /* Video frame, maybe?? :) */
50 #define AST_FRAME_CONTROL 4 /* A control frame, subclass is AST_CONTROL_* */
51 #define AST_FRAME_NULL 5 /* An empty, useless frame */
52 #define AST_FRAME_IAX 6 /* Inter Aterisk Exchange private frame type */
53 #define AST_FRAME_TEXT 7 /* Text messages */
54 #define AST_FRAME_IMAGE 8 /* Image Frames */
55 #define AST_FRAME_HTML 9 /* HTML Frames */
56 #define AST_FRAME_CNG 10 /* Confort Noise Generation */
57 #define AST_FRAME_MODEM 11 /* Modem-over-IP datastream */
58 #define AST_FRAME_DTMF_BEGIN 12 /* A DTMF begin event, subclass is the digit */
62 /* Subclass for AST_FRAME_IAX */
63 #define IAX_COMMAND_NEW 1
64 #define IAX_COMMAND_PING 2
65 #define IAX_COMMAND_PONG 3
66 #define IAX_COMMAND_ACK 4
67 #define IAX_COMMAND_HANGUP 5
68 #define IAX_COMMAND_REJECT 6
69 #define IAX_COMMAND_ACCEPT 7
70 #define IAX_COMMAND_AUTHREQ 8
71 #define IAX_COMMAND_AUTHREP 9
72 #define IAX_COMMAND_INVAL 10
73 #define IAX_COMMAND_LAGRQ 11
74 #define IAX_COMMAND_LAGRP 12
75 #define IAX_COMMAND_REGREQ 13 /* Registration request */
76 #define IAX_COMMAND_REGAUTH 14 /* Registration authentication required */
77 #define IAX_COMMAND_REGACK 15 /* Registration accepted */
78 #define IAX_COMMAND_REGREJ 16 /* Registration rejected */
79 #define IAX_COMMAND_REGREL 17 /* Force release of registration */
80 #define IAX_COMMAND_VNAK 18 /* If we receive voice before valid first voice frame, send this */
81 #define IAX_COMMAND_DPREQ 19 /* Request status of a dialplan entry */
82 #define IAX_COMMAND_DPREP 20 /* Request status of a dialplan entry */
83 #define IAX_COMMAND_DIAL 21 /* Request a dial on channel brought up TBD */
84 #define IAX_COMMAND_TXREQ 22 /* Transfer Request */
85 #define IAX_COMMAND_TXCNT 23 /* Transfer Connect */
86 #define IAX_COMMAND_TXACC 24 /* Transfer Accepted */
87 #define IAX_COMMAND_TXREADY 25 /* Transfer ready */
88 #define IAX_COMMAND_TXREL 26 /* Transfer release */
89 #define IAX_COMMAND_TXREJ 27 /* Transfer reject */
90 #define IAX_COMMAND_QUELCH 28 /* Stop audio/video transmission */
91 #define IAX_COMMAND_UNQUELCH 29 /* Resume audio/video transmission */
92 #define IAX_COMMAND_POKE 30 /* Like ping, but does not require an open connection */
93 #define IAX_COMMAND_PAGE 31 /* Paging description */
94 #define IAX_COMMAND_MWI 32 /* Stand-alone message waiting indicator */
95 #define IAX_COMMAND_UNSUPPORT 33 /* Unsupported message received */
96 #define IAX_COMMAND_TRANSFER 34 /* Request remote transfer */
97 #define IAX_COMMAND_PROVISION 35 /* Provision device */
98 #define IAX_COMMAND_FWDOWNL 36 /* Download firmware */
99 #define IAX_COMMAND_FWDATA 37 /* Firmware Data */
100 #define IAX_COMMAND_TXMEDIA 38 /* Transfer Media */
101 #define IAX_COMMAND_RTKEY 39 /* Rotate key */
102 #define IAX_COMMAND_CALLTOKEN 40 /* Call token */
104 #define IAX_DEFAULT_REG_EXPIRE 60 /* By default require re-registration once per minute */
106 #define IAX_LINGER_TIMEOUT 10 /* How long to wait before closing bridged call */
108 #define IAX_DEFAULT_PORTNO 4569
110 /* IAX Information elements */
111 #define IAX_IE_CALLED_NUMBER 1 /* Number/extension being called - string */
112 #define IAX_IE_CALLING_NUMBER 2 /* Calling number - string */
113 #define IAX_IE_CALLING_ANI 3 /* Calling number ANI for billing - string */
114 #define IAX_IE_CALLING_NAME 4 /* Name of caller - string */
115 #define IAX_IE_CALLED_CONTEXT 5 /* Context for number - string */
116 #define IAX_IE_USERNAME 6 /* Username (peer or user) for authentication - string */
117 #define IAX_IE_PASSWORD 7 /* Password for authentication - string */
118 #define IAX_IE_CAPABILITY 8 /* Actual codec capability - unsigned int */
119 #define IAX_IE_FORMAT 9 /* Desired codec format - unsigned int */
120 #define IAX_IE_LANGUAGE 10 /* Desired language - string */
121 #define IAX_IE_VERSION 11 /* Protocol version - short */
122 #define IAX_IE_ADSICPE 12 /* CPE ADSI capability - short */
123 #define IAX_IE_DNID 13 /* Originally dialed DNID - string */
124 #define IAX_IE_AUTHMETHODS 14 /* Authentication method(s) - short */
125 #define IAX_IE_CHALLENGE 15 /* Challenge data for MD5/RSA - string */
126 #define IAX_IE_MD5_RESULT 16 /* MD5 challenge result - string */
127 #define IAX_IE_RSA_RESULT 17 /* RSA challenge result - string */
128 #define IAX_IE_APPARENT_ADDR 18 /* Apparent address of peer - struct sockaddr_in */
129 #define IAX_IE_REFRESH 19 /* When to refresh registration - short */
130 #define IAX_IE_DPSTATUS 20 /* Dialplan status - short */
131 #define IAX_IE_CALLNO 21 /* Call number of peer - short */
132 #define IAX_IE_CAUSE 22 /* Cause - string */
133 #define IAX_IE_IAX_UNKNOWN 23 /* Unknown IAX command - byte */
134 #define IAX_IE_MSGCOUNT 24 /* How many messages waiting - short */
135 #define IAX_IE_AUTOANSWER 25 /* Request auto-answering -- none */
136 #define IAX_IE_MUSICONHOLD 26 /* Request musiconhold with QUELCH -- none or string */
137 #define IAX_IE_TRANSFERID 27 /* Transfer Request Identifier -- int */
138 #define IAX_IE_RDNIS 28 /* Referring DNIS -- string */
139 #define IAX_IE_PROVISIONING 29 /* Provisioning info */
140 #define IAX_IE_AESPROVISIONING 30 /* AES Provisioning info */
141 #define IAX_IE_DATETIME 31 /* Date/Time -- unsigned int */
142 #define IAX_IE_DEVICETYPE 32 /* Device Type -- string */
143 #define IAX_IE_SERVICEIDENT 33 /* Service Identifier -- string */
144 #define IAX_IE_FIRMWAREVER 34 /* Firmware revision -- u16 */
145 #define IAX_IE_FWBLOCKDESC 35 /* Firmware block description -- u32 */
146 #define IAX_IE_FWBLOCKDATA 36 /* Firmware block of data -- raw */
147 #define IAX_IE_PROVVER 37 /* Provisioning Version (u32) */
148 #define IAX_IE_CALLINGPRES 38 /* Calling presentation (u8) */
149 #define IAX_IE_CALLINGTON 39 /* Calling type of number (u8) */
150 #define IAX_IE_CALLINGTNS 40 /* Calling transit network select (u16) */
151 #define IAX_IE_SAMPLINGRATE 41 /* Supported sampling rates (u16) */
152 #define IAX_IE_CAUSECODE 42 /* Hangup cause (u8) */
153 #define IAX_IE_ENCRYPTION 43 /* Encryption format (u16) */
154 #define IAX_IE_ENCKEY 44 /* Encryption key (raw) */
155 #define IAX_IE_CODEC_PREFS 45 /* Codec Negotiation */
156 #define IAX_IE_RR_JITTER 46 /* Received jitter (as in RFC1889) u32 */
157 #define IAX_IE_RR_LOSS 47 /* Received loss (high byte loss pct, low 24 bits loss count, as in rfc1889 */
158 #define IAX_IE_RR_PKTS 48 /* Received frames (total frames received) u32 */
159 #define IAX_IE_RR_DELAY 49 /* Max playout delay for received frames (in ms) u16 */
160 #define IAX_IE_RR_DROPPED 50 /* Dropped frames (presumably by jitterbuf) u32 */
161 #define IAX_IE_RR_OOO 51 /* Frames received Out of Order u32 */
162 #define IAX_IE_VARIABLE 52 /* IAX variable transmission */
163 #define IAX_IE_OSPTOKEN 53 /* OSP Token */
164 #define IAX_IE_CALLTOKEN 54 /* Call Token */
165 #define IAX_IE_CAPABILITY2 55 /* Codec capability */
166 #define IAX_IE_FORMAT2 56 /* Desired codec capability */
167 #define IAX_IE_DATAFORMAT 255 /* Data call format -- iax_dataformat_t */
169 /* hangup cause codes */
170 #define AST_CAUSE_UNALLOCATED 1
171 #define AST_CAUSE_NO_ROUTE_TRANSIT_NET 2
172 #define AST_CAUSE_NO_ROUTE_DESTINATION 3
173 #define AST_CAUSE_MISDIALLED_TRUNK_PREFIX 5
174 #define AST_CAUSE_CHANNEL_UNACCEPTABLE 6
175 #define AST_CAUSE_CALL_AWARDED_DELIVERED 7
176 #define AST_CAUSE_PRE_EMPTED 8
177 #define AST_CAUSE_NUMBER_PORTED_NOT_HERE 14
178 #define AST_CAUSE_NORMAL_CLEARING 16
179 #define AST_CAUSE_USER_BUSY 17
180 #define AST_CAUSE_NO_USER_RESPONSE 18
181 #define AST_CAUSE_NO_ANSWER 19
182 #define AST_CAUSE_SUBSCRIBER_ABSENT 20
183 #define AST_CAUSE_CALL_REJECTED 21
184 #define AST_CAUSE_NUMBER_CHANGED 22
185 #define AST_CAUSE_REDIRECTED_TO_NEW_DESTINATION 23
186 #define AST_CAUSE_ANSWERED_ELSEWHERE 26
187 #define AST_CAUSE_DESTINATION_OUT_OF_ORDER 27
188 #define AST_CAUSE_INVALID_NUMBER_FORMAT 28
189 #define AST_CAUSE_FACILITY_REJECTED 29
190 #define AST_CAUSE_RESPONSE_TO_STATUS_ENQUIRY 30
191 #define AST_CAUSE_NORMAL_UNSPECIFIED 31
192 #define AST_CAUSE_NORMAL_CIRCUIT_CONGESTION 34
193 #define AST_CAUSE_NETWORK_OUT_OF_ORDER 38
194 #define AST_CAUSE_NORMAL_TEMPORARY_FAILURE 41
195 #define AST_CAUSE_SWITCH_CONGESTION 42
196 #define AST_CAUSE_ACCESS_INFO_DISCARDED 43
197 #define AST_CAUSE_REQUESTED_CHAN_UNAVAIL 44
198 #define AST_CAUSE_FACILITY_NOT_SUBSCRIBED 50
199 #define AST_CAUSE_OUTGOING_CALL_BARRED 52
200 #define AST_CAUSE_INCOMING_CALL_BARRED 54
201 #define AST_CAUSE_BEARERCAPABILITY_NOTAUTH 57
202 #define AST_CAUSE_BEARERCAPABILITY_NOTAVAIL 58
203 #define AST_CAUSE_BEARERCAPABILITY_NOTIMPL 65
204 #define AST_CAUSE_CHAN_NOT_IMPLEMENTED 66
205 #define AST_CAUSE_FACILITY_NOT_IMPLEMENTED 69
206 #define AST_CAUSE_INVALID_CALL_REFERENCE 81
207 #define AST_CAUSE_INCOMPATIBLE_DESTINATION 88
208 #define AST_CAUSE_INVALID_MSG_UNSPECIFIED 95
209 #define AST_CAUSE_MANDATORY_IE_MISSING 96
210 #define AST_CAUSE_MESSAGE_TYPE_NONEXIST 97
211 #define AST_CAUSE_WRONG_MESSAGE 98
212 #define AST_CAUSE_IE_NONEXIST 99
213 #define AST_CAUSE_INVALID_IE_CONTENTS 100
214 #define AST_CAUSE_WRONG_CALL_STATE 101
215 #define AST_CAUSE_RECOVERY_ON_TIMER_EXPIRE 102
216 #define AST_CAUSE_MANDATORY_IE_LENGTH_ERROR 103
217 #define AST_CAUSE_PROTOCOL_ERROR 111
218 #define AST_CAUSE_INTERWORKING 127
220 #define IAX_AUTH_PLAINTEXT (1 << 0)
221 #define IAX_AUTH_MD5 (1 << 1)
222 #define IAX_AUTH_RSA (1 << 2)
224 #define IAX_META_TRUNK 1 /* Trunk meta-message */
225 #define IAX_META_VIDEO 2 /* Video frame */
227 #define IAX_DPSTATUS_EXISTS (1 << 0)
228 #define IAX_DPSTATUS_CANEXIST (1 << 1)
229 #define IAX_DPSTATUS_NONEXISTANT (1 << 2)
230 #define IAX_DPSTATUS_IGNOREPAT (1 << 14)
231 #define IAX_DPSTATUS_MATCHMORE (1 << 15)
234 IAX2_MINI_VOICE_PACKET
,
236 IAX2_MINI_VIDEO_PACKET
,
240 /* Container for tapping relevant data */
241 typedef struct _iax2_info_t
250 voip_call_state callState
;
251 const gchar
*messageName
;
252 const gchar
*callingParty
;
253 const gchar
*calledParty
;
254 const guint8
*payload_data
;