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