d152443c7f8783b02ee679f249787335333d0d77
[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
28
29 #ifndef msg_parser_h
30 #define msg_parser_h
31
32 #include "../str.h"
33 #include "../data_lump.h"
34 #include "../flags.h"
35 #include "../ip_addr.h"
36 #include "../md5utils.h"
37 #include "../config.h"
38 #include "parse_def.h"
39 #include "parse_cseq.h"
40 #include "parse_to.h"
41 #include "parse_via.h"
42 #include "parse_fline.h"
43 #include "hf.h"
44
45
46 /* convenience short-cut macros */
47 #define REQ_LINE(_msg) ((_msg)->first_line.u.request)
48 #define REQ_METHOD first_line.u.request.method_value
49 #define REPLY_STATUS first_line.u.reply.statuscode
50 #define REPLY_CLASS(_reply) ((_reply)->REPLY_STATUS/100)
51
52 /* number methods as power of two to allow bitmap matching */
53 enum request_method { METHOD_INVITE=1, METHOD_CANCEL=2, METHOD_ACK=4, 
54         METHOD_BYE=8, METHOD_OTHER=16 };
55
56 #define IFISMETHOD(methodname,firstchar)                                  \
57 if (  (*tmp==(firstchar) || *tmp==((firstchar) | 32)) &&                  \
58         strncasecmp( tmp+1, #methodname +1, methodname##_LEN-1)==0 &&     \
59         *(tmp+methodname##_LEN)==' ') {                                   \
60                 fl->type=SIP_REQUEST;                                     \
61                 fl->u.request.method.len=methodname##_LEN;                \
62                 fl->u.request.method_value=METHOD_##methodname;           \
63                 tmp=buffer+methodname##_LEN;                              \
64 }
65
66
67
68 struct sip_uri {
69         str user;     /* Username */
70         str passwd;   /* Password */
71         str host;     /* Host name */
72         str port;     /* Port number */
73         str params;   /* Parameters */
74         str headers;  
75         unsigned short port_no;
76 };
77
78
79
80 struct sip_msg {
81         unsigned int id;               /* message id, unique/process*/
82         struct msg_start first_line;   /* Message first line */
83         struct via_body* via1;         /* The first via */
84         struct via_body* via2;         /* The second via */
85         struct hdr_field* headers;     /* All the parsed headers*/
86         struct hdr_field* last_header; /* Pointer to the last parsed header*/
87         int parsed_flag;               /* Already parsed header field types */
88
89              /* Via, To, CSeq, Call-Id, From, end of header*/
90              /* pointers to the first occurances of these headers;
91                   * everything is also saved in 'headers'
92                   * (WARNING: do not deallocate them twice!)*/
93
94         struct hdr_field* h_via1;
95         struct hdr_field* h_via2;
96         struct hdr_field* callid;
97         struct hdr_field* to;
98         struct hdr_field* cseq;
99         struct hdr_field* from;
100         struct hdr_field* contact;
101         struct hdr_field* maxforwards;
102         struct hdr_field* route;
103         struct hdr_field* record_route;
104         struct hdr_field* content_type;
105         struct hdr_field* content_length;
106         struct hdr_field* authorization;
107         struct hdr_field* expires;
108         struct hdr_field* proxy_auth;
109         struct hdr_field* www_auth;
110         struct hdr_field* supported;
111         struct hdr_field* require;
112         struct hdr_field* proxy_require;
113         struct hdr_field* unsupported;
114         struct hdr_field* allow;
115         struct hdr_field* event;
116
117         char* eoh;        /* pointer to the end of header (if found) or null */
118         char* unparsed;   /* here we stopped parsing*/
119
120         struct ip_addr src_ip;
121         struct ip_addr dst_ip;
122         
123         char* orig;       /* original message copy */
124         char* buf;        /* scratch pad, holds a modfied message,
125                            *  via, etc. point into it 
126                            */
127         unsigned int len; /* message len (orig) */
128
129              /* modifications */
130         
131         str new_uri; /* changed first line uri*/
132
133         str dst_uri; /* Destination URI, must be forwarded to this URI if len != 0 */
134
135         int parsed_uri_ok; /* 1 if parsed_uri is valid, 0 if not */
136         struct sip_uri parsed_uri; /* speed-up > keep here the parsed uri*/
137         
138         struct lump* add_rm;         /* used for all the forwarded requests */
139         struct lump* repl_add_rm;    /* used for all the forwarded replies */
140         struct lump_rpl *reply_lump; /* only for localy generated replies !!!*/
141
142         /* str add_to_branch; 
143            whatever whoever want to append to branch comes here 
144         */
145         char add_to_branch_s[MAX_BRANCH_PARAM_LEN];
146         int add_to_branch_len;
147         
148              /* index to TM hash table; stored in core to avoid unnecessary calcs */
149         unsigned int  hash_index;
150         
151              /* allows to set various flags on the message; may be used for 
152               * simple inter-module communication or remembering processing state
153               * reached 
154               */
155         flag_t flags;   
156 };
157
158 /* pointer to a fakes message which was never received ;
159    (when this message is "relayed", it is generated out
160     of the original request)
161 */
162 #define FAKED_REPLY     ((struct sip_msg *) -1)
163
164 extern int via_cnt;
165
166 int parse_msg(char* buf, unsigned int len, struct sip_msg* msg);
167
168 int parse_headers(struct sip_msg* msg, int flags, int next);
169
170 void free_sip_msg(struct sip_msg* msg);
171
172 /* make sure all HFs needed for transaction identification have been
173    parsed; return 0 if those HFs can't be found
174  */
175
176 int check_transaction_quadruple( struct sip_msg* msg );
177
178 /* calculate characteristic value of a message -- this value
179    is used to identify a transaction during the process of
180    reply matching
181  */
182 inline static int char_msg_val( struct sip_msg *msg, char *cv )
183 {
184         str src[8];
185
186         if (!check_transaction_quadruple(msg)) {
187                 LOG(L_ERR, "ERROR: can't calculate char_value due "
188                         "to a parsing error\n");
189                 memset( cv, '0', MD5_LEN );
190                 return 0;
191         }
192
193         src[0]= msg->from->body;
194         src[1]= msg->to->body;
195         src[2]= msg->callid->body;
196         src[3]= msg->first_line.u.request.uri;
197         src[4]= get_cseq( msg )->number;
198         
199         /* topmost Via is part of transaction key as well ! */
200         src[5]= msg->via1->host;
201         src[6]= msg->via1->port_str;
202         if (msg->via1->branch) {
203                 src[7]= msg->via1->branch->value;
204                 MDStringArray ( cv, src, 8 );
205         } else {
206                 MDStringArray( cv, src, 7 );
207         }
208         return 1;
209 }
210
211
212 /* returns a pointer to the begining of the msg's body
213  */
214 inline static char* get_body(struct sip_msg *msg)
215 {
216         int offset;
217
218         if ( parse_headers(msg,HDR_EOH, 0)==-1 )
219                 return 0;
220
221         if ( strncmp(CRLF,msg->unparsed,CRLF_LEN)==0 )
222                 offset = CRLF_LEN;
223         else if (*(msg->unparsed)=='\n' || *(msg->unparsed)=='\r' )
224                 offset = 1;
225         else
226                 return 0;
227
228         return msg->unparsed + offset;
229 }
230
231 #endif