- appropriate log messages in check_params(...)
[sip-router] / modules / tm / uac.c
1 /*
2  * $Id$
3  *
4  * simple UAC for things such as SUBSCRIBE or SMS gateway;
5  * no authentication and other UAC features -- just send
6  * a message, retransmit and await a reply; forking is not
7  * supported during client generation, in all other places
8  * it is -- adding it should be simple
9  *
10  * Copyright (C) 2001-2003 Fhg Fokus
11  *
12  * This file is part of ser, a free SIP server.
13  *
14  * ser is free software; you can redistribute it and/or modify
15  * it under the terms of the GNU General Public License as published by
16  * the Free Software Foundation; either version 2 of the License, or
17  * (at your option) any later version
18  *
19  * For a license to use the ser software under conditions
20  * other than those described here, or to purchase support for this
21  * software, please contact iptel.org by e-mail at the following addresses:
22  *    info@iptel.org
23  *
24  * ser is distributed in the hope that it will be useful,
25  * but WITHOUT ANY WARRANTY; without even the implied warranty of
26  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
27  * GNU General Public License for more details.
28  *
29  * You should have received a copy of the GNU General Public License 
30  * along with this program; if not, write to the Free Software 
31  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
32  *
33  * History:
34  * --------
35  *  2003-01-23  t_uac_dlg now uses get_out_socket (jiri)
36  *  2003-01-27  fifo:t_uac_dlg completed (jiri)
37  *  2003-01-29  scratchpad removed (jiri)
38  *  2003-02-13  t_uac, t _uac_dlg, gethfblock, uri2proxy changed to use 
39  *               proto & rb->dst (andrei)
40  *  2003-02-27  FIFO/UAC now dumps reply -- good for CTD (jiri)
41  *  2003-02-28  scratchpad compatibility abandoned (jiri)
42  *  2003-03-01  kr set through a function now (jiri)
43  *  2003-03-19  replaced all mallocs/frees w/ pkg_malloc/pkg_free (andrei)
44  *  2003-04-02  port_no_str does not contain a leading ':' anymore (andrei)
45  *  2003-07-08  appropriate log messages in check_params(...), 
46  *               call calculate_hooks if next_hop==NULL in t_uac (dcm) 
47  */
48
49 #include <string.h>
50 #include "../../mem/shm_mem.h"
51 #include "../../dprint.h"
52 #include "../../globals.h"
53 #include "../../md5.h"
54 #include "../../crc.h"
55 #include "../../ip_addr.h"
56 #include "ut.h"
57 #include "h_table.h"
58 #include "t_hooks.h"
59 #include "t_funcs.h"
60 #include "t_msgbuilder.h"
61 #include "callid.h"
62 #include "uac.h"
63
64
65 #define FROM_TAG_LEN (MD5_LEN + 1 /* - */ + CRC16_LEN) /* length of FROM tags */
66
67 static char from_tag[FROM_TAG_LEN + 1];
68
69 char* uac_from = "sip:foo@foo.bar"; /* Module parameter */
70
71
72 /*
73  * Initialize UAC
74  */
75 int uac_init(void) 
76 {
77         str src[3];
78
79         if (RAND_MAX < TABLE_ENTRIES) {
80                 LOG(L_WARN, "Warning: uac does not spread "
81                     "accross the whole hash table\n");
82         }
83
84         /* calculate the initial From tag */
85         src[0].s = "Long live SER server";
86         src[0].len = strlen(src[0].s);
87         src[1].s = sock_info[bind_idx].address_str.s;
88         src[1].len = strlen(src[1].s);
89         src[2].s = sock_info[bind_idx].port_no_str.s;
90         src[2].len = strlen(src[2].s);
91
92         MDStringArray(from_tag, src, 3);
93         from_tag[MD5_LEN] = '-';
94         return 1;
95 }
96
97
98 /*
99  * Generate a From tag
100  */
101 void generate_fromtag(str* tag, str* callid)
102 {
103              /* calculate from tag from callid */
104         crcitt_string_array(&from_tag[MD5_LEN + 1], callid, 1);
105         tag->s = from_tag; 
106         tag->len = FROM_TAG_LEN;
107 }
108
109
110 /*
111  * Check value of parameters
112  */
113 static inline int check_params(str* method, str* to, str* from, dlg_t** dialog)
114 {
115         if (!method || !to || !from || !dialog) {
116                 LOG(L_ERR, "check_params(): Invalid parameter value\n");
117                 return -1;
118         }
119
120         if (!method->s || !method->len) {
121                 LOG(L_ERR, "check_params(): Invalid request method\n");
122                 return -2;
123         }
124
125         if (!to->s || !to->len) {
126                 LOG(L_ERR, "check_params(): Invalid To URI\n");
127                 return -4;
128         }
129
130         if (!from->s || !from->len) {
131                 LOG(L_ERR, "check_params(): Invalid From URI\n");
132                 return -5;
133         }
134         return 0;
135 }
136
137
138 /*
139  * Send a request using data from the dialog structure
140  */
141 int t_uac(str* method, str* headers, str* body, dlg_t* dialog, transaction_cb cb, void* cbp)
142 {
143         struct socket_info* send_sock;
144         union sockaddr_union to_su;
145         struct cell *new_cell;
146         struct retr_buf *request;
147         char* buf;
148         int buf_len;
149         int ret;
150
151         ret=-1;
152         
153         /*** added by dcm 
154          * - needed by external ua to send a request within a dlg
155          */
156         if(!dialog->hooks.next_hop && w_calculate_hooks(dialog)<0)
157                 goto error2;
158
159         send_sock = uri2sock(dialog->hooks.next_hop, &to_su, PROTO_NONE);
160         if (!send_sock) {
161                 ret=ser_error;
162                 LOG(L_ERR, "t_uac: no socket found\n");
163                 goto error2;
164         }       
165
166         new_cell = build_cell(0); 
167         if (!new_cell) {
168                 ret=E_OUT_OF_MEM;
169                 LOG(L_ERR, "t_uac: short of cell shmem\n");
170                 goto error2;
171         }
172
173         new_cell->completion_cb = cb;
174         new_cell->cbp = cbp;
175         
176              /* cbp is installed -- tell error handling bellow not to free it */
177         cbp = 0;
178
179         new_cell->is_invite = method->len == INVITE_LEN && memcmp(method->s, INVITE, INVITE_LEN) == 0;
180         new_cell->local= 1;
181         set_kr(REQ_FWDED);
182         
183         request = &new_cell->uac[0].request;
184         request->dst.to = to_su;
185         request->dst.send_sock = send_sock;
186         request->dst.proto = send_sock->proto;
187         request->dst.proto_reserved1 = 0;
188
189              /* need to put in table to calculate label which is needed for printing */
190         LOCK_HASH(new_cell->hash_index);
191         insert_into_hash_table_unsafe(new_cell);
192         UNLOCK_HASH(new_cell->hash_index);
193
194         buf = build_uac_req(method, headers, body, dialog, 0, new_cell, &buf_len, send_sock);
195         if (!buf) {
196                 LOG(L_ERR, "t_uac: Error while building message\n");
197                 ret=E_OUT_OF_MEM;
198                 goto error1;
199         }
200
201         new_cell->method.s = buf;
202         new_cell->method.len = method->len;
203
204         request->buffer = buf;
205         request->buffer_len = buf_len;
206         new_cell->nr_of_outgoings++;
207         
208         if (SEND_BUFFER(request) == -1) {
209                 LOG(L_ERR, "t_uac: Attempt to send to '%.*s' failed\n", 
210                     dialog->hooks.next_hop->len,
211                     dialog->hooks.next_hop->s
212                     );
213         }
214         
215         start_retr(request);
216         return 1;
217
218  error1:
219         LOCK_HASH(new_cell->hash_index);
220         remove_from_hash_table_unsafe(new_cell);
221         UNLOCK_HASH(new_cell->hash_index);
222         free_cell(new_cell);
223
224  error2:
225              /* if we did not install cbp, release it now */
226         if (cbp) shm_free(cbp);
227         return ret;
228 }
229
230
231 /*
232  * Send a message within a dialog
233  */
234 int req_within(str* method, str* headers, str* body, dlg_t* dialog, transaction_cb completion_cb, void* cbp)
235 {
236         if (!method || !dialog) {
237                 LOG(L_ERR, "req_within: Invalid parameter value\n");
238                 goto err;
239         }
240
241         if (dialog->state != DLG_CONFIRMED) {
242                 LOG(L_ERR, "req_within: Dialog is not confirmed yet\n");
243                 goto err;
244         }
245
246         if ((method->len == 3) && (!memcmp("ACK", method->s, 3))) goto send;
247         if ((method->len == 6) && (!memcmp("CANCEL", method->s, 6))) goto send;
248         dialog->loc_seq.value++; /* Increment CSeq */
249  send:
250         return t_uac(method, headers, body, dialog, completion_cb, cbp);
251
252  err:
253         if (cbp) shm_free(cbp);
254         return -1;
255 }
256
257
258 /*
259  * Send an initial request that will start a dialog
260  */
261 int req_outside(str* method, str* to, str* from, str* headers, str* body, dlg_t** dialog, transaction_cb cb, void* cbp)
262 {
263         str callid, fromtag;
264
265         if (check_params(method, to, from, dialog) < 0) goto err;
266         
267         generate_callid(&callid);
268         generate_fromtag(&fromtag, &callid);
269
270         if (new_dlg_uac(&callid, &fromtag, DEFAULT_CSEQ, from, to, dialog) < 0) {
271                 LOG(L_ERR, "req_outside(): Error while creating new dialog\n");
272                 goto err;
273         }
274
275         return t_uac(method, headers, body, *dialog, cb, cbp);
276
277  err:
278         if (cbp) shm_free(cbp);
279         return -1;
280 }
281
282
283 /*
284  * Send a transactional request, no dialogs involved
285  */
286 int request(str* m, str* ruri, str* to, str* from, str* h, str* b, transaction_cb c, void* cp)
287 {
288         str callid, fromtag;
289         dlg_t* dialog;
290         int res;
291
292         if (check_params(m, to, from, &dialog) < 0) goto err;
293
294         generate_callid(&callid);
295         generate_fromtag(&fromtag, &callid);
296
297         if (new_dlg_uac(&callid, &fromtag, DEFAULT_CSEQ, from, to, &dialog) < 0) {
298                 LOG(L_ERR, "req_outside(): Error while creating temorary dialog\n");
299                 goto err;
300         }
301
302         if (ruri) {
303                 dialog->rem_target.s = ruri->s;
304                 dialog->rem_target.len = ruri->len;
305                 dialog->hooks.request_uri = &dialog->rem_target;
306         }
307
308         res = t_uac(m, h, b, dialog, c, cp);
309         dialog->rem_target.s = 0;
310         free_dlg(dialog);
311         return res;
312
313  err:
314         if (cp) shm_free(cp);
315         return -1;
316 }