b06ff0d8d2c33a9b12ee57a71b9ec79178c13cbd
[sip-router] / src / core / parser / msg_parser.h
1 /*
2  * Copyright (C) 2001-2003 FhG Fokus
3  *
4  * This file is part of Kamailio, a free SIP server.
5  *
6  * Kamailio is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version
10  *
11  * Kamailio is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
19  *
20  */
21
22 /*! \file
23  * \brief Parser :: ???
24  *
25  * \ingroup parser
26  */
27
28
29 #ifndef msg_parser_h
30 #define msg_parser_h
31
32
33 #include "../comp_defs.h"
34 #include "../str.h"
35 #include "../lump_struct.h"
36 #include "../flags.h"
37 #include "../ip_addr.h"
38 #include "../md5utils.h"
39 #include "../config.h"
40 #include "parse_def.h"
41 #include "parse_cseq.h"
42 #include "parse_via.h"
43 #include "parse_fline.h"
44 #include "parse_retry_after.h"
45 #include "hf.h"
46 #include "../error.h"
47
48
49 /*! \name convenience short-cut macros */
50 /*@{ */
51 #define REQ_LINE(_msg) ((_msg)->first_line.u.request)
52 #define REQ_METHOD first_line.u.request.method_value
53 #define REPLY_STATUS first_line.u.reply.statuscode
54 #define REPLY_CLASS(_reply) ((_reply)->REPLY_STATUS/100)
55 /*@} */
56
57 /*! \brief start of "actual" sip msg (start of first line) */
58 #define SIP_MSG_START(m)        ((m)->first_line.u.request.method.s)
59
60 /*! \brief number methods as power of two to allow bitmap matching */
61 typedef enum request_method {
62         METHOD_UNDEF=0,           /*!< 0 - --- */
63         METHOD_INVITE=1,          /*!< 1 - 2^0 */
64         METHOD_CANCEL=2,          /*!< 2 - 2^1 */
65         METHOD_ACK=4,             /*!< 4 - 2^2 */
66         METHOD_BYE=8,             /*!< 8 - 2^3 */
67         METHOD_INFO=16,           /*!< 16 - 2^4 */
68         METHOD_REGISTER=32,       /*!< 32 - 2^5 */
69         METHOD_SUBSCRIBE=64,      /*!< 64 - 2^6 */
70         METHOD_NOTIFY=128,        /*!< 128 - 2^7 */
71         METHOD_MESSAGE=256,       /*!< 256 - 2^8 */
72         METHOD_OPTIONS=512,       /*!< 512 - 2^9 */
73         METHOD_PRACK=1024,        /*!< 1024 - 2^10 */
74         METHOD_UPDATE=2048,       /*!< 2048 - 2^11 */
75         METHOD_REFER=4096,        /*!< 4096 - 2^12 */
76         METHOD_PUBLISH=8192,      /*!< 8192 - 2^13 */
77         METHOD_OTHER=16384        /*!< 16384 - 2^14 */
78 } request_method_t;
79
80 #define FL_FORCE_RPORT  (1 << 0)  /*!< force rport */
81 #define FL_FORCE_ACTIVE (1 << 1)  /*!< force active SDP */
82 #define FL_SDP_IP_AFS   (1 << 2)  /*!< SDP IP rewritten */
83 #define FL_SDP_PORT_AFS (1 << 3)  /*!< SDP port rewritten */
84 #define FL_SHM_CLONE    (1 << 4)  /*!< msg cloned in SHM as a single chunk */
85 #define FL_TIMEOUT      (1 << 5)  /*!< message belongs to an "expired" branch
86                                                                         (for failure route use) */
87 #define FL_REPLIED      (1 << 6)  /*!< message branch received at least one reply
88                                                                         (for failure route use) */
89 #define FL_HASH_INDEX   (1 << 7)  /*!< msg->hash_index contains a valid value (tm use)*/
90
91 #define FL_MTU_TCP_FB   (1 << 8)
92 #define FL_MTU_TLS_FB   (1 << 9)
93 #define FL_MTU_SCTP_FB  (1 << 10)
94 #define FL_ADD_LOCAL_RPORT  (1 << 11) /*!< add 'rport' to local via hdr */
95 #define FL_SDP_BODY     (1 << 12)  /*!< msg has SDP in body */
96 #define FL_USE_UAC_FROM      (1<<13)  /* take FROM hdr from UAC instead of UAS*/
97 #define FL_USE_UAC_TO        (1<<14)  /* take TO hdr from UAC instead of UAS */
98 #define FL_TM_RPL_MATCHED    (1<<15)  /* tm matched reply already */
99 #define FL_RPL_SUSPENDED     (1<<16)  /* for async reply processing */
100 #define FL_BODY_MULTIPART    (1<<17)  /* body modified is multipart */
101 #define FL_RR_ADDED          (1<<18)  /* Record-Route header was added */
102 #define FL_UAC_AUTH          (1<<19)  /* Proxy UAC-like authentication */
103 #define FL_ADD_SRVID         (1<<20) /*!< add 'srvid' to local via hdr */
104
105 /* WARNING: Value (1 << 28) is temporarily reserved for use in kamailio call_control
106  * module (flag  FL_USE_CALL_CONTROL )! */
107
108 /* WARNING: Value (1 << 29) is temporarily reserved for use in kamailio acc
109  * module (flag FL_REQ_UPSTREAM)! */
110
111 /* WARNING: Value (1 << 30) is temporarily reserved for use in kamailio
112  * media proxy module (flag FL_USE_MEDIA_PROXY)! */
113
114 /* WARNING: Value (1 << 31) is temporarily reserved for use in kamailio
115  * nat_traversal module (flag FL_DO_KEEPALIVE)! */
116
117 #define FL_MTU_FB_MASK  (FL_MTU_TCP_FB|FL_MTU_TLS_FB|FL_MTU_SCTP_FB)
118
119
120 #define IFISMETHOD(methodname,firstchar)                                  \
121 if (  (*tmp==(firstchar) || *tmp==((firstchar) | 32)) &&                  \
122                 strncasecmp( tmp+1, #methodname +1, methodname##_LEN-1)==0 &&     \
123                 *(tmp+methodname##_LEN)==' ') {                                   \
124                                 fl->type=SIP_REQUEST;                                     \
125                                 fl->u.request.method.len=methodname##_LEN;                \
126                                 fl->u.request.method_value=METHOD_##methodname;           \
127                                 tmp=buffer+methodname##_LEN;                              \
128 }
129
130 #define IS_HTTP(req)                                                \
131         ((req)->first_line.u.request.version.len >= HTTP_VERSION_LEN && \
132         !strncasecmp((req)->first_line.u.request.version.s,             \
133                 HTTP_VERSION, HTTP_VERSION_LEN))
134
135 #define IS_SIP(req)                                                \
136         ((req)->first_line.u.request.version.len >= SIP_VERSION_LEN && \
137         !strncasecmp((req)->first_line.u.request.version.s,             \
138                 SIP_VERSION, SIP_VERSION_LEN))
139
140 #define IS_HTTP_REPLY(rpl)                                                \
141         ((rpl)->first_line.u.reply.version.len >= HTTP_VERSION_LEN && \
142         !strncasecmp((rpl)->first_line.u.reply.version.s,             \
143                 HTTP_VERSION, HTTP_VERSION_LEN))
144
145 #define IS_SIP_REPLY(rpl)                                                \
146         ((rpl)->first_line.u.reply.version.len >= SIP_VERSION_LEN && \
147         !strncasecmp((rpl)->first_line.u.reply.version.s,             \
148                 SIP_VERSION, SIP_VERSION_LEN))
149
150 /*! \brief
151  * Return a URI to which the message should be really sent (not what should
152  * be in the Request URI. The following fields are tried in this order:
153  * 1) dst_uri
154  * 2) new_uri
155  * 3) first_line.u.request.uri
156  */
157 #define GET_NEXT_HOP(m) \
158 (((m)->dst_uri.s && (m)->dst_uri.len) ? (&(m)->dst_uri) : \
159 (((m)->new_uri.s && (m)->new_uri.len) ? (&(m)->new_uri) : (&(m)->first_line.u.request.uri)))
160
161
162 /*! \brief
163  * Return the Reqeust URI of a message.
164  * The following fields are tried in this order:
165  * 1) new_uri
166  * 2) first_line.u.request.uri
167  */
168 #define GET_RURI(m) \
169 (((m)->new_uri.s && (m)->new_uri.len) ? (&(m)->new_uri) : (&(m)->first_line.u.request.uri))
170
171
172 enum _uri_type{ERROR_URI_T=0, SIP_URI_T, SIPS_URI_T, TEL_URI_T, TELS_URI_T, URN_URI_T};
173 typedef enum _uri_type uri_type;
174 enum _uri_flags{
175         URI_USER_NORMALIZE=1,
176         URI_SIP_USER_PHONE=2
177 }; /* bit fields */
178 typedef enum _uri_flags uri_flags;
179
180 /*! \brief The SIP uri object */
181 struct sip_uri {
182         str user;     /*!< Username */
183         str passwd;   /*!< Password */
184         str host;     /*!< Host name */
185         str port;     /*!< Port number */
186         str params;   /*!< Parameters */
187         str sip_params; /*!< Parameters of the sip: URI.
188                                         * (If a tel: URI is embedded in a sip: URI, then
189                                         * params points to the parameters of the tel: URI,
190                                         * and sip_params to the parameters of the sip: URI.
191                                         */
192         str headers;
193         unsigned short port_no;
194         unsigned short proto; /*!< from transport */
195         uri_type type; /*!< uri scheme */
196         uri_flags flags;
197         /*!< parameters */
198         str transport;
199         str ttl;
200         str user_param;
201         str maddr;
202         str method;
203         str lr;
204         str r2; /*!< ser specific rr parameter */
205         str gr;
206         str transport_val; /*!< transport value */
207         str ttl_val;     /*!< TTL value */
208         str user_param_val; /*!< User= param value */
209         str maddr_val; /*!< Maddr= param value */
210         str method_val; /*!< Method value */
211         str lr_val; /*!< lr value placeholder for lr=on a.s.o*/
212         str r2_val;
213         str gr_val;
214 #ifdef USE_COMP
215         unsigned short comp;
216 #endif
217 };
218
219 typedef struct sip_uri sip_uri_t;
220
221 struct msg_body;
222
223 typedef void (*free_msg_body_f)(struct msg_body** ptr);
224
225 typedef enum msg_body_type {
226         MSG_BODY_UNKNOWN = 0,
227         MSG_BODY_SDP
228 } msg_body_type_t;
229
230 /*! \brief This structure represents a generic SIP message body, regardless of the
231  * body type.
232  *
233  * Body parsers are supposed to cast this structure to some other
234  * body-type specific structure, but the body type specific structure must
235  * retain msg_body_type variable and a pointer to the free function as the
236  * first two variables within the structure.
237  */
238 typedef struct msg_body {
239         msg_body_type_t type;
240         free_msg_body_f free;
241 } msg_body_t;
242
243
244 /* pre-declaration, to include sys/time.h in .c */
245 struct timeval;
246
247 /* structure for cached decoded flow for outbound */
248 typedef struct ocd_flow {
249                 int decoded;
250                 struct receive_info rcv;
251 } ocd_flow_t;
252
253 /* structure holding fields that don't have to be cloned in shm
254  * - its content is memset'ed to in shm clone
255  * - add to msg_ldata_reset() if a field uses dynamic memory */
256 typedef struct msg_ldata {
257         ocd_flow_t flow;
258 } msg_ldata_t;
259
260 /*! \brief The SIP message */
261 typedef struct sip_msg {
262         unsigned int id;               /*!< message id, unique/process*/
263         int pid;                       /*!< process id */
264         struct timeval tval;           /*!< time value associated to message */
265         snd_flags_t fwd_send_flags;    /*!< send flags for forwarding */
266         snd_flags_t rpl_send_flags;    /*!< send flags for replies */
267         struct msg_start first_line;   /*!< Message first line */
268         struct via_body* via1;         /*!< The first via */
269         struct via_body* via2;         /*!< The second via */
270         struct hdr_field* headers;     /*!< All the parsed headers*/
271         struct hdr_field* last_header; /*!< Pointer to the last parsed header*/
272         hdr_flags_t parsed_flag;    /*!< Already parsed header field types */
273
274         /* Via, To, CSeq, Call-Id, From, end of header*/
275         /* pointers to the first occurrences of these headers;
276          * everything is also saved in 'headers'
277          * (WARNING: do not deallocate them twice!)*/
278
279         struct hdr_field* h_via1;
280         struct hdr_field* h_via2;
281         struct hdr_field* callid;
282         struct hdr_field* to;
283         struct hdr_field* cseq;
284         struct hdr_field* from;
285         struct hdr_field* contact;
286         struct hdr_field* maxforwards;
287         struct hdr_field* route;
288         struct hdr_field* record_route;
289         struct hdr_field* content_type;
290         struct hdr_field* content_length;
291         struct hdr_field* authorization;
292         struct hdr_field* expires;
293         struct hdr_field* proxy_auth;
294         struct hdr_field* supported;
295         struct hdr_field* require;
296         struct hdr_field* proxy_require;
297         struct hdr_field* unsupported;
298         struct hdr_field* allow;
299         struct hdr_field* event;
300         struct hdr_field* accept;
301         struct hdr_field* accept_language;
302         struct hdr_field* organization;
303         struct hdr_field* priority;
304         struct hdr_field* subject;
305         struct hdr_field* user_agent;
306         struct hdr_field* server;
307         struct hdr_field* content_disposition;
308         struct hdr_field* diversion;
309         struct hdr_field* rpid;
310         struct hdr_field* refer_to;
311         struct hdr_field* session_expires;
312         struct hdr_field* min_se;
313         struct hdr_field* sipifmatch;
314         struct hdr_field* subscription_state;
315         struct hdr_field* date;
316         struct hdr_field* identity;
317         struct hdr_field* identity_info;
318         struct hdr_field* pai;
319         struct hdr_field* ppi;
320         struct hdr_field* path;
321         struct hdr_field* privacy;
322         struct hdr_field* min_expires;
323
324         struct msg_body* body;
325
326         char* eoh;        /*!< pointer to the end of header (if found) or null */
327         char* unparsed;   /*!< here we stopped parsing*/
328
329         struct receive_info rcv; /*!< source & dest ip, ports, proto a.s.o*/
330
331         char* buf;        /*!< scratch pad, holds a modified message,
332                                                 *  via, etc. point into it */
333         unsigned int len; /*!< message len (orig) */
334
335         /* modifications */
336
337         str new_uri; /*!< changed first line uri, when you change this
338                                         don't forget to set parsed_uri_ok to 0*/
339
340         str dst_uri; /*!< Destination URI, must be forwarded to this URI if len != 0 */
341
342         /* current uri */
343         int parsed_uri_ok; /*!< 1 if parsed_uri is valid, 0 if not, set if to 0
344                                                 if you modify the uri (e.g change new_uri)*/
345         struct sip_uri parsed_uri; /*!< speed-up > keep here the parsed uri*/
346         int parsed_orig_ruri_ok; /*!< 1 if parsed_orig_uri is valid, 0 if not, set if to 0
347                                                                 if you modify the uri (e.g change new_uri)*/
348         struct sip_uri parsed_orig_ruri; /*!< speed-up > keep here the parsed orig uri*/
349
350         struct lump* add_rm;       /*!< used for all the forwarded requests/replies */
351         struct lump* body_lumps;     /*!< Lumps that update Content-Length */
352         struct lump_rpl *reply_lump; /*!< only for localy generated replies !!!*/
353
354         /*! \brief str add_to_branch;
355                 whatever whoever want to append to Via branch comes here */
356         char add_to_branch_s[MAX_BRANCH_PARAM_LEN];
357         int add_to_branch_len;
358
359         unsigned int  hash_index; /*!< index to TM hash table; stored in core
360                                                                 to avoid unnecessary calculations */
361         unsigned int msg_flags; /*!< internal flags used by core */
362         flag_t flags; /*!< config flags */
363         flag_t xflags[KSR_XFLAGS_SIZE]; /*!< config extended flags */
364         str set_global_address;
365         str set_global_port;
366         struct socket_info* force_send_socket; /*!< force sending on this socket */
367         str path_vec;
368         str instance;
369         unsigned int reg_id;
370         str ruid;
371         str location_ua;
372
373         /* structure with fields that are needed for local processing
374          * - not cloned to shm, reset to 0 in the clone */
375         msg_ldata_t ldv;
376
377         /* IMPORTANT: when adding new fields in this structure (sip_msg_t),
378          * be sure it is freed in free_sip_msg() and it is cloned or reset
379          * to shm structure for transaction - see sip_msg_clone.c. In tm
380          * module, take care of these fields for faked environemt used for
381          * runing failure handlers - see modules/tm/t_reply.c */
382 } sip_msg_t;
383
384 /*! \brief pointer to a fakes message which was never received ;
385         (when this message is "relayed", it is generated out
386         of the original request)
387 */
388 #define FAKED_REPLY     ((struct sip_msg *) -1)
389
390 extern int via_cnt;
391 /** global  request flags.
392  *  msg->msg_flags should be OR'ed with it before
393  * a flag value is checked, e.g.:
394  * if ((msg->msg_flags|global_req_flags) & FL_XXX) ...
395  */
396 extern unsigned int global_req_flags;
397
398
399 int parse_msg(char* const buf, const unsigned int len, struct sip_msg* const msg);
400
401 int parse_headers(struct sip_msg* const msg, const hdr_flags_t flags, const int next);
402
403 char* get_hdr_field(char* const buf, char* const end, struct hdr_field* const hdr);
404
405 void free_sip_msg(struct sip_msg* const msg);
406
407 /*! \brief make sure all HFs needed for transaction identification have been
408         parsed; return 0 if those HFs can't be found
409 */
410 int check_transaction_quadruple(sip_msg_t* const msg);
411
412 /*! \brief returns a pointer to the begining of the msg's body
413  */
414 char* get_body(sip_msg_t* const msg);
415
416 /*! \brief If the new_uri is set, then reset it */
417 void reset_new_uri(struct sip_msg* const msg);
418
419 /*! \brief
420  * Make a private copy of the string and assign it to dst_uri
421  */
422 int set_dst_uri(struct sip_msg* const msg, const str* const uri);
423
424 /*! \brief If the dst_uri is set to an URI then reset it */
425 void reset_dst_uri(struct sip_msg* const msg);
426
427 hdr_field_t* get_hdr(const sip_msg_t* const msg, const enum _hdr_types_t ht);
428 hdr_field_t* next_sibling_hdr(const hdr_field_t* const hf);
429 /** not used yet */
430 hdr_field_t* get_hdr_by_name(const sip_msg_t* const msg, const char* const name,
431                 const int name_len);
432 hdr_field_t* next_sibling_hdr_by_name(const hdr_field_t* const hf);
433
434 int set_path_vector(struct sip_msg* msg, str* path);
435
436 void reset_path_vector(struct sip_msg* const msg);
437
438 int set_instance(struct sip_msg* msg, str* instance);
439
440 void reset_instance(struct sip_msg* const msg);
441
442 int set_ruid(struct sip_msg* msg, str* ruid);
443
444 void reset_ruid(struct sip_msg* const msg);
445
446 int set_ua(struct sip_msg* msg, str *location_ua);
447
448 void reset_ua(struct sip_msg* const msg);
449
450 /** force a specific send socket for forwarding a request.
451  * @param msg - sip msg.
452  * @param fsocket - forced socket, pointer to struct socket_info, can be 0 (in
453  *                  which case it's equivalent to reset_force_socket()).
454  */
455 #define set_force_socket(msg, fsocket) \
456         do { \
457                 (msg)->force_send_socket=(fsocket); \
458                 if ((msg)->force_send_socket) \
459                         (msg)->fwd_send_flags.f |= SND_F_FORCE_SOCKET; \
460                 else \
461                         (msg)->fwd_send_flags.f &= ~SND_F_FORCE_SOCKET; \
462         } while (0)
463
464 /** reset a previously forced send socket. */
465 #define reset_force_socket(msg) set_force_socket(msg, 0)
466
467 /**
468  * struct to identify a msg context
469  * - the pair of pid and message-id
470  */
471 typedef struct msg_ctx_id {
472         int pid;
473         int msgid;
474 } msg_ctx_id_t;
475
476 /**
477  * set msg context id
478  * - return: -1 on error; 0 - on set
479  */
480 int msg_ctx_id_set(const sip_msg_t* const msg, msg_ctx_id_t* const mid);
481
482 /**
483  * check msg context id
484  * - return: -1 on error; 0 - on no match; 1 - on match
485  */
486 int msg_ctx_id_match(const sip_msg_t* const msg, const msg_ctx_id_t* const mid);
487
488 /**
489  * set msg time value
490  */
491 int msg_set_time(sip_msg_t* const msg);
492
493 /**
494  * reset content of msg->ldv (msg_ldata_t structure)
495  */
496 void msg_ldata_reset(sip_msg_t*);
497
498 /**
499  * get source ip, port and protocol in SIP URI format
500  */
501 int get_src_uri(sip_msg_t *m, int tmode, str *uri);
502
503 /**
504  * get source proto:ip:port (socket address format)
505  */
506 int get_src_address_socket(sip_msg_t *m, str *ssock);
507
508 /**
509  * get received-on-socket ip, port and protocol in SIP URI format
510  */
511 int get_rcv_socket_uri(sip_msg_t *m, int tmode, str *uri, int atype);
512
513 #endif