d8b2e534a7b74a534fa187ceb012956d2cb07028
[sip-router] / 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
104 /* WARNING: Value (1 << 28) is temporarily reserved for use in kamailio call_control
105  * module (flag  FL_USE_CALL_CONTROL )! */
106
107 /* WARNING: Value (1 << 29) is temporarily reserved for use in kamailio acc
108  * module (flag FL_REQ_UPSTREAM)! */
109
110 /* WARNING: Value (1 << 30) is temporarily reserved for use in kamailio
111  * media proxy module (flag FL_USE_MEDIA_PROXY)! */
112
113 /* WARNING: Value (1 << 31) is temporarily reserved for use in kamailio
114  * nat_traversal module (flag FL_DO_KEEPALIVE)! */
115
116 #define FL_MTU_FB_MASK  (FL_MTU_TCP_FB|FL_MTU_TLS_FB|FL_MTU_SCTP_FB)
117
118
119 #define IFISMETHOD(methodname,firstchar)                                  \
120 if (  (*tmp==(firstchar) || *tmp==((firstchar) | 32)) &&                  \
121         strncasecmp( tmp+1, #methodname +1, methodname##_LEN-1)==0 &&     \
122         *(tmp+methodname##_LEN)==' ') {                                   \
123                 fl->type=SIP_REQUEST;                                     \
124                 fl->u.request.method.len=methodname##_LEN;                \
125                 fl->u.request.method_value=METHOD_##methodname;           \
126                 tmp=buffer+methodname##_LEN;                              \
127 }
128
129 #define IS_HTTP(req)                                                \
130     ((req)->first_line.u.request.version.len >= HTTP_VERSION_LEN && \
131     !strncasecmp((req)->first_line.u.request.version.s,             \
132                 HTTP_VERSION, HTTP_VERSION_LEN))
133
134 #define IS_SIP(req)                                                \
135     ((req)->first_line.u.request.version.len >= SIP_VERSION_LEN && \
136     !strncasecmp((req)->first_line.u.request.version.s,             \
137                 SIP_VERSION, SIP_VERSION_LEN))
138
139 #define IS_HTTP_REPLY(rpl)                                                \
140     ((rpl)->first_line.u.reply.version.len >= HTTP_VERSION_LEN && \
141     !strncasecmp((rpl)->first_line.u.reply.version.s,             \
142                 HTTP_VERSION, HTTP_VERSION_LEN))
143
144 #define IS_SIP_REPLY(rpl)                                                \
145     ((rpl)->first_line.u.reply.version.len >= SIP_VERSION_LEN && \
146     !strncasecmp((rpl)->first_line.u.reply.version.s,             \
147                 SIP_VERSION, SIP_VERSION_LEN))
148
149 /*! \brief
150  * Return a URI to which the message should be really sent (not what should
151  * be in the Request URI. The following fields are tried in this order:
152  * 1) dst_uri
153  * 2) new_uri
154  * 3) first_line.u.request.uri
155  */
156 #define GET_NEXT_HOP(m) \
157 (((m)->dst_uri.s && (m)->dst_uri.len) ? (&(m)->dst_uri) : \
158 (((m)->new_uri.s && (m)->new_uri.len) ? (&(m)->new_uri) : (&(m)->first_line.u.request.uri)))
159
160
161 /*! \brief
162  * Return the Reqeust URI of a message.
163  * The following fields are tried in this order:
164  * 1) new_uri
165  * 2) first_line.u.request.uri
166  */
167 #define GET_RURI(m) \
168 (((m)->new_uri.s && (m)->new_uri.len) ? (&(m)->new_uri) : (&(m)->first_line.u.request.uri))
169
170
171 enum _uri_type{ERROR_URI_T=0, SIP_URI_T, SIPS_URI_T, TEL_URI_T, TELS_URI_T, URN_URI_T};
172 typedef enum _uri_type uri_type;
173 enum _uri_flags{
174         URI_USER_NORMALIZE=1,
175         URI_SIP_USER_PHONE=2
176 }; /* bit fields */
177 typedef enum _uri_flags uri_flags;
178
179 /*! \brief The SIP uri object */
180 struct sip_uri {
181         str user;     /*!< Username */
182         str passwd;   /*!< Password */
183         str host;     /*!< Host name */
184         str port;     /*!< Port number */
185         str params;   /*!< Parameters */
186         str sip_params; /*!< Parameters of the sip: URI.
187                           * (If a tel: URI is embedded in a sip: URI, then
188                           * params points to the parameters of the tel: URI,
189                           * and sip_params to the parameters of the sip: URI. 
190                           */
191         str headers;
192         unsigned short port_no;
193         unsigned short proto; /*!< from transport */
194         uri_type type; /*!< uri scheme */
195         uri_flags flags;
196         /*!< parameters */
197         str transport;
198         str ttl;
199         str user_param;
200         str maddr;
201         str method;
202         str lr;
203         str r2; /*!< ser specific rr parameter */
204         str gr;
205         str transport_val; /*!< transport value */
206         str ttl_val;     /*!< TTL value */
207         str user_param_val; /*!< User= param value */
208         str maddr_val; /*!< Maddr= param value */
209         str method_val; /*!< Method value */
210         str lr_val; /*!< lr value placeholder for lr=on a.s.o*/
211         str r2_val;
212         str gr_val;
213 #ifdef USE_COMP
214         unsigned short comp;
215 #endif
216 };
217
218 typedef struct sip_uri sip_uri_t;
219
220 struct msg_body;
221
222 typedef void (*free_msg_body_f)(struct msg_body** ptr);
223
224 typedef enum msg_body_type {
225         MSG_BODY_UNKNOWN = 0,
226         MSG_BODY_SDP
227 } msg_body_type_t;
228
229 /*! \brief This structure represents a generic SIP message body, regardless of the
230  * body type.
231  * 
232  * Body parsers are supposed to cast this structure to some other
233  * body-type specific structure, but the body type specific structure must
234  * retain msg_body_type variable and a pointer to the free function as the 
235  * first two variables within the structure.
236  */
237 typedef struct msg_body {
238         msg_body_type_t type;
239         free_msg_body_f free;
240 } msg_body_t;
241
242
243 /* pre-declaration, to include sys/time.h in .c */
244 struct timeval;
245
246 /* structure for cached decoded flow for outbound */
247 typedef struct ocd_flow {
248                 int decoded;
249                 struct receive_info rcv;
250 } ocd_flow_t;
251
252 /* structure holding fields that don't have to be cloned in shm
253  * - its content is memset'ed to in shm clone
254  * - add to msg_ldata_reset() if a field uses dynamic memory */
255 typedef struct msg_ldata {
256         ocd_flow_t flow;
257 } msg_ldata_t;
258
259 /*! \brief The SIP message */
260 typedef struct sip_msg {
261         unsigned int id;               /*!< message id, unique/process*/
262         int pid;                       /*!< process id */
263         struct timeval tval;           /*!< time value associated to message */
264         snd_flags_t fwd_send_flags;    /*!< send flags for forwarding */
265         snd_flags_t rpl_send_flags;    /*!< send flags for replies */
266         struct msg_start first_line;   /*!< Message first line */
267         struct via_body* via1;         /*!< The first via */
268         struct via_body* via2;         /*!< The second via */
269         struct hdr_field* headers;     /*!< All the parsed headers*/
270         struct hdr_field* last_header; /*!< Pointer to the last parsed header*/
271         hdr_flags_t parsed_flag;    /*!< Already parsed header field types */
272
273              /* Via, To, CSeq, Call-Id, From, end of header*/
274              /* pointers to the first occurrences of these headers;
275                   * everything is also saved in 'headers'
276                   * (WARNING: do not deallocate them twice!)*/
277
278         struct hdr_field* h_via1;
279         struct hdr_field* h_via2;
280         struct hdr_field* callid;
281         struct hdr_field* to;
282         struct hdr_field* cseq;
283         struct hdr_field* from;
284         struct hdr_field* contact;
285         struct hdr_field* maxforwards;
286         struct hdr_field* route;
287         struct hdr_field* record_route;
288         struct hdr_field* content_type;
289         struct hdr_field* content_length;
290         struct hdr_field* authorization;
291         struct hdr_field* expires;
292         struct hdr_field* proxy_auth;
293         struct hdr_field* supported;
294         struct hdr_field* require;
295         struct hdr_field* proxy_require;
296         struct hdr_field* unsupported;
297         struct hdr_field* allow;
298         struct hdr_field* event;
299         struct hdr_field* accept;
300         struct hdr_field* accept_language;
301         struct hdr_field* organization;
302         struct hdr_field* priority;
303         struct hdr_field* subject;
304         struct hdr_field* user_agent;
305         struct hdr_field* server;
306         struct hdr_field* content_disposition;
307         struct hdr_field* diversion;
308         struct hdr_field* rpid;
309         struct hdr_field* refer_to;
310         struct hdr_field* session_expires;
311         struct hdr_field* min_se;
312         struct hdr_field* sipifmatch;
313         struct hdr_field* subscription_state;
314         struct hdr_field* date;
315         struct hdr_field* identity;
316         struct hdr_field* identity_info;
317         struct hdr_field* pai;
318         struct hdr_field* ppi;
319         struct hdr_field* path;
320         struct hdr_field* privacy;
321
322         struct msg_body* body;
323
324         char* eoh;        /*!< pointer to the end of header (if found) or null */
325         char* unparsed;   /*!< here we stopped parsing*/
326
327         struct receive_info rcv; /*!< source & dest ip, ports, proto a.s.o*/
328
329         char* buf;        /*!< scratch pad, holds a modified message,
330                                            *  via, etc. point into it */
331         unsigned int len; /*!< message len (orig) */
332
333              /* modifications */
334
335         str new_uri; /*!< changed first line uri, when you change this
336                         don't forget to set parsed_uri_ok to 0*/
337
338         str dst_uri; /*!< Destination URI, must be forwarded to this URI if len != 0 */
339
340         /* current uri */
341         int parsed_uri_ok; /*!< 1 if parsed_uri is valid, 0 if not, set if to 0
342                               if you modify the uri (e.g change new_uri)*/
343         struct sip_uri parsed_uri; /*!< speed-up > keep here the parsed uri*/
344         int parsed_orig_ruri_ok; /*!< 1 if parsed_orig_uri is valid, 0 if not, set if to 0
345                               if you modify the uri (e.g change new_uri)*/
346         struct sip_uri parsed_orig_ruri; /*!< speed-up > keep here the parsed orig uri*/
347
348         struct lump* add_rm;       /*!< used for all the forwarded requests/replies */
349         struct lump* body_lumps;     /*!< Lumps that update Content-Length */
350         struct lump_rpl *reply_lump; /*!< only for localy generated replies !!!*/
351
352         /*! \brief str add_to_branch;
353            whatever whoever want to append to Via branch comes here */
354         char add_to_branch_s[MAX_BRANCH_PARAM_LEN];
355         int add_to_branch_len;
356
357         unsigned int  hash_index; /*!< index to TM hash table; stored in core to avoid unnecessary calculations */
358         unsigned int msg_flags; /*!< internal flags used by core */
359         flag_t flags; /*!< config flags */
360         str set_global_address;
361         str set_global_port;
362         struct socket_info* force_send_socket; /*!< force sending on this socket */
363         str path_vec;
364         str instance;
365         unsigned int reg_id;
366         str ruid;
367         str location_ua;
368
369         /* structure with fields that are needed for local processing
370          * - not cloned to shm, reset to 0 in the clone */
371         msg_ldata_t ldv;
372
373         /* IMPORTANT: when adding new fields in this structure (sip_msg_t),
374          * be sure it is freed in free_sip_msg() and it is cloned or reset
375          * to shm structure for transaction - see sip_msg_clone.c. In tm
376          * module, take care of these fields for faked environemt used for
377          * runing failure handlers - see modules/tm/t_reply.c */
378 } sip_msg_t;
379
380 /*! \brief pointer to a fakes message which was never received ;
381    (when this message is "relayed", it is generated out
382     of the original request)
383 */
384 #define FAKED_REPLY     ((struct sip_msg *) -1)
385
386 extern int via_cnt;
387 /** global  request flags.
388  *  msg->msg_flags should be OR'ed with it before
389  * a flag value is checked, e.g.:
390  * if ((msg->msg_flags|global_req_flags) & FL_XXX) ...
391  */
392 extern unsigned int global_req_flags;
393
394
395 int parse_msg(char* const buf, const unsigned int len, struct sip_msg* const msg);
396
397 int parse_headers(struct sip_msg* const msg, const hdr_flags_t flags, const int next);
398
399 char* get_hdr_field(char* const buf, char* const end, struct hdr_field* const hdr);
400
401 void free_sip_msg(struct sip_msg* const msg);
402
403 /*! \brief make sure all HFs needed for transaction identification have been
404    parsed; return 0 if those HFs can't be found
405 */
406 inline static int check_transaction_quadruple(struct sip_msg* const msg)
407 {
408         if ( parse_headers(msg, HDR_FROM_F|HDR_TO_F|HDR_CALLID_F|HDR_CSEQ_F,0)!=-1
409                 && msg->from && msg->to && msg->callid && msg->cseq ) {
410                 return 1;
411         } else {
412                 ser_error=E_BAD_TUPEL;
413                 return 0;
414         }
415 }
416
417
418
419 /*! \brief returns a pointer to the begining of the msg's body
420  */
421 inline static char* get_body(struct sip_msg* const msg)
422 {
423         int offset;
424         unsigned int len;
425
426         if ( parse_headers(msg, HDR_EOH_F, 0)==-1 )
427                 return 0;
428
429         if (msg->unparsed){
430                 len=(unsigned int)(msg->unparsed-msg->buf);
431         }else return 0;
432         if ((len+2<=msg->len) && (strncmp(CRLF,msg->unparsed,CRLF_LEN)==0) )
433                 offset = CRLF_LEN;
434         else if ( (len+1<=msg->len) &&
435                                 (*(msg->unparsed)=='\n' || *(msg->unparsed)=='\r' ) )
436                 offset = 1;
437         else
438                 return 0;
439
440         return msg->unparsed + offset;
441 }
442
443 /*! \brief If the new_uri is set, then reset it */
444 void reset_new_uri(struct sip_msg* const msg);
445
446 /*! \brief
447  * Make a private copy of the string and assign it to dst_uri
448  */
449 int set_dst_uri(struct sip_msg* const msg, const str* const uri);
450
451 /*! \brief If the dst_uri is set to an URI then reset it */
452 void reset_dst_uri(struct sip_msg* const msg);
453
454 hdr_field_t* get_hdr(const sip_msg_t* const msg, const enum _hdr_types_t ht);
455 hdr_field_t* next_sibling_hdr(const hdr_field_t* const hf);
456 /** not used yet */
457 hdr_field_t* get_hdr_by_name(const sip_msg_t* const msg, const char* const name, const int name_len);
458 hdr_field_t* next_sibling_hdr_by_name(const hdr_field_t* const hf);
459
460 int set_path_vector(struct sip_msg* msg, str* path);
461
462 void reset_path_vector(struct sip_msg* const msg);
463
464 int set_instance(struct sip_msg* msg, str* instance);
465
466 void reset_instance(struct sip_msg* const msg);
467
468 int set_ruid(struct sip_msg* msg, str* ruid);
469
470 void reset_ruid(struct sip_msg* const msg);
471
472 int set_ua(struct sip_msg* msg, str *location_ua);
473
474 void reset_ua(struct sip_msg* const msg);
475
476 /** force a specific send socket for forwarding a request.
477  * @param msg - sip msg.
478  * @param fsocket - forced socket, pointer to struct socket_info, can be 0 (in
479  *                  which case it's equivalent to reset_force_socket()).
480  */
481 #define set_force_socket(msg, fsocket) \
482         do { \
483                 (msg)->force_send_socket=(fsocket); \
484                 if ((msg)->force_send_socket) \
485                         (msg)->fwd_send_flags.f |= SND_F_FORCE_SOCKET; \
486                 else \
487                         (msg)->fwd_send_flags.f &= ~SND_F_FORCE_SOCKET; \
488         } while (0)
489
490 /** reset a previously forced send socket. */
491 #define reset_force_socket(msg) set_force_socket(msg, 0)
492
493 /**
494  * struct to identify a msg context
495  * - the pair of pid and message-id
496  */
497 typedef struct msg_ctx_id {
498         int pid;
499         int msgid;
500 } msg_ctx_id_t;
501
502 /**
503  * set msg context id
504  * - return: -1 on error; 0 - on set 
505  */
506 int msg_ctx_id_set(const sip_msg_t* const msg, msg_ctx_id_t* const mid);
507
508 /**
509  * check msg context id
510  * - return: -1 on error; 0 - on no match; 1 - on match
511  */
512 int msg_ctx_id_match(const sip_msg_t* const msg, const msg_ctx_id_t* const mid);
513
514 /**
515  * set msg time value
516  */
517 int msg_set_time(sip_msg_t* const msg);
518
519 /**
520  * reset content of msg->ldv (msg_ldata_t structure)
521  */
522 void msg_ldata_reset(sip_msg_t*);
523
524 #endif