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