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