Function t_uac splitted into two parts - one which prepares the message and one
[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  *  2003-10-24  updated to the new socket_info lists (andrei)
48  *  2003-12-03  completion filed removed from transaction and uac callbacks
49  *              merged in transaction callbacks as LOCAL_COMPLETED (bogdan)
50  *  2004-02-11  FIFO/CANCEL + alignments (hash=f(callid,cseq)) (uli+jiri)
51  *  2004-02-13  t->is_invite, t->local, t->noisy_ctimer replaced (bogdan)
52  *  2004-08-23  avp support in t_uac (bogdan)
53  *  2005-12-16  t_uac will set the new_cell timers to the default values,
54  *               fixes 0 fr_timer bug (andrei)
55  */
56
57 #include <string.h>
58 #include "../../mem/shm_mem.h"
59 #include "../../dprint.h"
60 #include "../../globals.h"
61 #include "../../md5.h"
62 #include "../../crc.h"
63 #include "../../ip_addr.h"
64 #include "../../socket_info.h"
65 #include "ut.h"
66 #include "h_table.h"
67 #include "t_hooks.h"
68 #include "t_funcs.h"
69 #include "t_msgbuilder.h"
70 #include "callid.h"
71 #include "uac.h"
72
73
74 #define FROM_TAG_LEN (MD5_LEN + 1 /* - */ + CRC16_LEN) /* length of FROM tags */
75
76 static char from_tag[FROM_TAG_LEN + 1];
77
78 char* uac_from = "sip:foo@foo.bar"; /* Module parameter */
79
80 /* Enable/disable passing of provisional replies to FIFO applications */
81 int pass_provisional_replies = 0;
82
83 /*
84  * Initialize UAC
85  */
86 int uac_init(void) 
87 {
88         str src[3];
89         struct socket_info *si;
90
91         if (RAND_MAX < TABLE_ENTRIES) {
92                 LOG(L_WARN, "Warning: uac does not spread "
93                     "across the whole hash table\n");
94         }
95         /* on tcp/tls bind_address is 0 so try to get the first address we listen
96          * on no matter the protocol */
97         si=bind_address?bind_address:get_first_socket();
98         if (si==0){
99                 LOG(L_CRIT, "BUG: uac_init: null socket list\n");
100                 return -1;
101         }
102
103         /* calculate the initial From tag */
104         src[0].s = "Long live SER server";
105         src[0].len = strlen(src[0].s);
106         src[1].s = si->address_str.s;
107         src[1].len = strlen(src[1].s);
108         src[2].s = si->port_no_str.s;
109         src[2].len = strlen(src[2].s);
110
111         MDStringArray(from_tag, src, 3);
112         from_tag[MD5_LEN] = '-';
113         return 1;
114 }
115
116
117 /*
118  * Generate a From tag
119  */
120 void generate_fromtag(str* tag, str* callid)
121 {
122              /* calculate from tag from callid */
123         crcitt_string_array(&from_tag[MD5_LEN + 1], callid, 1);
124         tag->s = from_tag; 
125         tag->len = FROM_TAG_LEN;
126 }
127
128
129 /*
130  * Check value of parameters
131  */
132 static inline int check_params(str* method, str* to, str* from, dlg_t** dialog)
133 {
134         if (!method || !to || !from || !dialog) {
135                 LOG(L_ERR, "check_params(): Invalid parameter value\n");
136                 return -1;
137         }
138
139         if (!method->s || !method->len) {
140                 LOG(L_ERR, "check_params(): Invalid request method\n");
141                 return -2;
142         }
143
144         if (!to->s || !to->len) {
145                 LOG(L_ERR, "check_params(): Invalid To URI\n");
146                 return -4;
147         }
148
149         if (!from->s || !from->len) {
150                 LOG(L_ERR, "check_params(): Invalid From URI\n");
151                 return -5;
152         }
153         return 0;
154 }
155
156 static inline unsigned int dlg2hash( dlg_t* dlg )
157 {
158         str cseq_nr;
159         unsigned int hashid;
160
161         cseq_nr.s=int2str(dlg->loc_seq.value, &cseq_nr.len);
162         hashid=hash(dlg->id.call_id, cseq_nr);
163         DBG("DEBUG: dlg2hash: %d\n", hashid);
164         return hashid;
165 }
166
167 static inline int t_uac_prepare(str* method, str* headers, str* body, dlg_t* dialog,
168           transaction_cb cb, void* cbp, struct retr_buf **dst_req)
169 {
170         struct dest_info dst;
171         struct cell *new_cell;
172         struct retr_buf *request;
173         char* buf;
174         int buf_len, ret, flags;
175         unsigned int hi;
176
177         ret=-1;
178         /*if (dst_req) *dst_req = NULL;*/
179         
180         /*** added by dcm 
181          * - needed by external ua to send a request within a dlg
182          */
183         if(!dialog->hooks.next_hop && w_calculate_hooks(dialog)<0)
184                 goto error2;
185
186         DBG("DEBUG:tm:t_uac: next_hop=<%.*s>\n",dialog->hooks.next_hop->len,
187                         dialog->hooks.next_hop->s);
188         /* it's a new message, so we will take the default socket */
189         if ((uri2dst(&dst, 0, dialog->hooks.next_hop, PROTO_NONE)==0) ||
190                         (dst.send_sock==0)){
191                 ser_error = E_NO_SOCKET;
192                 ret=ser_error;
193                 LOG(L_ERR, "t_uac: no socket found\n");
194                 goto error2;
195         }       
196
197         new_cell = build_cell(0); 
198         if (!new_cell) {
199                 ret=E_OUT_OF_MEM;
200                 LOG(L_ERR, "t_uac: short of cell shmem\n");
201                 goto error2;
202         }
203         /* init timers hack, new_cell->fr_timer and new_cell->fr_inv_timer
204          * must be set, or else the fr will happen immediately
205          * we can't call init_new_t() because we don't have a sip msg
206          * => we'll ignore t_set_fr() or avp timer value and will use directly the
207          * module params fr_inv_timer and fr_timer -- andrei */
208         new_cell->fr_timeout=fr_timeout;
209         new_cell->fr_inv_timeout=fr_inv_timeout;
210
211         /* better reset avp list now - anyhow, it's useless from
212          * this point (bogdan) */
213         reset_avps();
214
215         /* add the callback the the transaction for LOCAL_COMPLETED event */
216  
217         flags = TMCB_LOCAL_COMPLETED;
218         /* Add also TMCB_LOCAL_REPLY_OUT if provisional replies are desired */
219         if (pass_provisional_replies) flags |= TMCB_LOCAL_RESPONSE_OUT;
220
221         if(cb && insert_tmcb(&(new_cell->tmcb_hl), flags, cb, cbp)!=1){
222                 ret=E_OUT_OF_MEM; 
223                 LOG(L_ERR, "t_uac: short of tmcb shmem\n");
224                 goto error2;
225         }
226
227         if (method->len==INVITE_LEN && memcmp(method->s, INVITE, INVITE_LEN)==0)
228                 new_cell->flags |= T_IS_INVITE_FLAG;
229         new_cell->flags |= T_IS_LOCAL_FLAG;
230         set_kr(REQ_FWDED);
231
232         request = &new_cell->uac[0].request;
233         
234         request->dst = dst;
235
236         hi=dlg2hash(dialog);
237         LOCK_HASH(hi);
238         insert_into_hash_table_unsafe(new_cell, hi);
239         UNLOCK_HASH(hi);
240
241         buf = build_uac_req(method, headers, body, dialog, 0, new_cell,
242                 &buf_len, &dst);
243         if (!buf) {
244                 LOG(L_ERR, "t_uac: Error while building message\n");
245                 ret=E_OUT_OF_MEM;
246                 goto error1;
247         }
248
249         new_cell->method.s = buf;
250         new_cell->method.len = method->len;
251
252         request->buffer = buf;
253         request->buffer_len = buf_len;
254         new_cell->nr_of_outgoings++;
255         
256         if (dst_req) *dst_req = request;
257         return 1;
258
259  error1:
260         LOCK_HASH(hi);
261         remove_from_hash_table_unsafe(new_cell);
262         UNLOCK_HASH(hi);
263         free_cell(new_cell);
264 error2:
265         return ret;
266 }
267
268 /*
269  * Prepare a message within a dialog
270  */
271 int prepare_req_within(str* method, str* headers, 
272                 str* body, dlg_t* dialog, transaction_cb completion_cb, 
273                 void* cbp, struct retr_buf **dst_req)
274 {
275         if (!method || !dialog) {
276                 LOG(L_ERR, "req_within: Invalid parameter value\n");
277                 goto err;
278         }
279
280         if (dialog->state != DLG_CONFIRMED) {
281                 LOG(L_ERR, "req_within: Dialog is not confirmed yet\n");
282                 goto err;
283         }
284
285         if ((method->len == 3) && (!memcmp("ACK", method->s, 3))) goto send;
286         if ((method->len == 6) && (!memcmp("CANCEL", method->s, 6))) goto send;
287         dialog->loc_seq.value++; /* Increment CSeq */
288  send:
289         return t_uac_prepare(method, headers, body, dialog, completion_cb, cbp, dst_req);
290
291  err:
292         /* if (cbp) shm_free(cbp); */
293         /* !! never free cbp here because if t_uac_prepare fails, cbp is not freed
294          * and thus caller has no chance to discover if it is freed or not !! */
295         return -1;
296 }
297
298 static inline void send_prepared_request_impl(struct retr_buf *request)
299 {
300         if (SEND_BUFFER(request) == -1) {
301                 LOG(L_ERR, "t_uac: Attempt to send to precreated request failed\n");
302         }
303         
304         if (start_retr(request)!=0)
305                 LOG(L_CRIT, "BUG: t_uac: failed to start retr. for %p\n", request);
306 }
307
308 void send_prepared_request(struct retr_buf *request)
309 {
310         send_prepared_request_impl(request);
311 }
312
313 /*
314  * Send a request using data from the dialog structure
315  */
316 int t_uac(str* method, str* headers, str* body, dlg_t* dialog,
317           transaction_cb cb, void* cbp)
318 {
319         struct retr_buf *request;
320         int ret;
321
322         ret = t_uac_prepare(method, headers, body, dialog, cb, cbp, &request);
323         if (ret < 0) return ret;
324         send_prepared_request_impl(request);
325         return ret;
326 }
327
328
329 /*
330  * Send a message within a dialog
331  */
332 int req_within(str* method, str* headers, str* body, dlg_t* dialog, transaction_cb completion_cb, void* cbp)
333 {
334         if (!method || !dialog) {
335                 LOG(L_ERR, "req_within: Invalid parameter value\n");
336                 goto err;
337         }
338
339         if (dialog->state != DLG_CONFIRMED) {
340                 LOG(L_ERR, "req_within: Dialog is not confirmed yet\n");
341                 goto err;
342         }
343
344         if ((method->len == 3) && (!memcmp("ACK", method->s, 3))) goto send;
345         if ((method->len == 6) && (!memcmp("CANCEL", method->s, 6))) goto send;
346         dialog->loc_seq.value++; /* Increment CSeq */
347  send:
348         return t_uac(method, headers, body, dialog, completion_cb, cbp);
349
350  err:
351         if (cbp) shm_free(cbp);
352         return -1;
353 }
354
355
356 /*
357  * Send an initial request that will start a dialog
358  */
359 int req_outside(str* method, str* to, str* from, str* headers, str* body, dlg_t** dialog, transaction_cb cb, void* cbp)
360 {
361         str callid, fromtag;
362
363         if (check_params(method, to, from, dialog) < 0) goto err;
364         
365         generate_callid(&callid);
366         generate_fromtag(&fromtag, &callid);
367
368         if (new_dlg_uac(&callid, &fromtag, DEFAULT_CSEQ, from, to, dialog) < 0) {
369                 LOG(L_ERR, "req_outside(): Error while creating new dialog\n");
370                 goto err;
371         }
372
373         return t_uac(method, headers, body, *dialog, cb, cbp);
374
375  err:
376         if (cbp) shm_free(cbp);
377         return -1;
378 }
379
380
381 /*
382  * Send a transactional request, no dialogs involved
383  */
384 int request(str* m, str* ruri, str* to, str* from, str* h, str* b, str *next_hop, transaction_cb c, void* cp)
385 {
386         str callid, fromtag;
387         dlg_t* dialog;
388         int res;
389
390         if (check_params(m, to, from, &dialog) < 0) goto err;
391
392         generate_callid(&callid);
393         generate_fromtag(&fromtag, &callid);
394
395         if (new_dlg_uac(&callid, &fromtag, DEFAULT_CSEQ, from, to, &dialog) < 0) {
396                 LOG(L_ERR, "request(): Error while creating temporary dialog\n");
397                 goto err;
398         }
399
400         if (ruri) {
401                 dialog->rem_target.s = ruri->s;
402                 dialog->rem_target.len = ruri->len;
403                 dialog->hooks.request_uri = &dialog->rem_target;
404         }
405         w_calculate_hooks(dialog);
406
407         if (next_hop) 
408                 if ((next_hop->len > 0) && next_hop->s) dialog->hooks.next_hop = next_hop;
409
410         res = t_uac(m, h, b, dialog, c, cp);
411         dialog->rem_target.s = 0;
412         free_dlg(dialog);
413         return res;
414
415  err:
416         if (cp) shm_free(cp);
417         return -1;
418 }