- new stats support
[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  *  2006-08-11  t_uac uses dns failover until it finds a send socket (andrei)
56  *  2007-03-15  TMCB_ONSEND callbacks support added (andrei)
57  *  2007-03-23  TMCB_LOCAL_REQUEST_IN callbacks support (andrei)
58  *  2007-04-23  per dialog callbacks support (andrei)
59  *  2007-06-01  support for per transaction different retransmissions intervals
60  *              (andrei)
61  */
62
63 #include <string.h>
64 #include "../../mem/shm_mem.h"
65 #include "../../dprint.h"
66 #include "../../globals.h"
67 #include "../../md5.h"
68 #include "../../crc.h"
69 #include "../../ip_addr.h"
70 #include "../../socket_info.h"
71 #include "../../compiler_opt.h"
72 #include "ut.h"
73 #include "h_table.h"
74 #include "t_hooks.h"
75 #include "t_funcs.h"
76 #include "t_msgbuilder.h"
77 #include "callid.h"
78 #include "uac.h"
79 #include "t_stats.h"
80
81
82 #define FROM_TAG_LEN (MD5_LEN + 1 /* - */ + CRC16_LEN) /* length of FROM tags */
83
84 static char from_tag[FROM_TAG_LEN + 1];
85
86 char* uac_from = "sip:foo@foo.bar"; /* Module parameter */
87
88 /* Enable/disable passing of provisional replies to FIFO applications */
89 int pass_provisional_replies = 0;
90
91 /*
92  * Initialize UAC
93  */
94 int uac_init(void) 
95 {
96         str src[3];
97         struct socket_info *si;
98
99         if (RAND_MAX < TABLE_ENTRIES) {
100                 LOG(L_WARN, "Warning: uac does not spread "
101                     "across the whole hash table\n");
102         }
103         /* on tcp/tls bind_address is 0 so try to get the first address we listen
104          * on no matter the protocol */
105         si=bind_address?bind_address:get_first_socket();
106         if (si==0){
107                 LOG(L_CRIT, "BUG: uac_init: null socket list\n");
108                 return -1;
109         }
110
111         /* calculate the initial From tag */
112         src[0].s = "Long live SER server";
113         src[0].len = strlen(src[0].s);
114         src[1].s = si->address_str.s;
115         src[1].len = strlen(src[1].s);
116         src[2].s = si->port_no_str.s;
117         src[2].len = strlen(src[2].s);
118
119         MDStringArray(from_tag, src, 3);
120         from_tag[MD5_LEN] = '-';
121         return 1;
122 }
123
124
125 /*
126  * Generate a From tag
127  */
128 void generate_fromtag(str* tag, str* callid)
129 {
130              /* calculate from tag from callid */
131         crcitt_string_array(&from_tag[MD5_LEN + 1], callid, 1);
132         tag->s = from_tag; 
133         tag->len = FROM_TAG_LEN;
134 }
135
136
137 /*
138  * Check value of parameters
139  */
140 static inline int check_params(str* method, str* to, str* from, dlg_t** dialog)
141 {
142         if (!method || !to || !from || !dialog) {
143                 LOG(L_ERR, "check_params(): Invalid parameter value\n");
144                 return -1;
145         }
146
147         if (!method->s || !method->len) {
148                 LOG(L_ERR, "check_params(): Invalid request method\n");
149                 return -2;
150         }
151
152         if (!to->s || !to->len) {
153                 LOG(L_ERR, "check_params(): Invalid To URI\n");
154                 return -4;
155         }
156
157         if (!from->s || !from->len) {
158                 LOG(L_ERR, "check_params(): Invalid From URI\n");
159                 return -5;
160         }
161         return 0;
162 }
163
164 static inline unsigned int dlg2hash( dlg_t* dlg )
165 {
166         str cseq_nr;
167         unsigned int hashid;
168
169         cseq_nr.s=int2str(dlg->loc_seq.value, &cseq_nr.len);
170         hashid=hash(dlg->id.call_id, cseq_nr);
171         DBG("DEBUG: dlg2hash: %d\n", hashid);
172         return hashid;
173 }
174
175
176 /* WARNING: - dst_cell contains the created cell, but it is un-referenced
177  *            (before using it make sure you REF() it first)
178  *          - if  ACK (method==ACK), a cell will be created but it will not
179  *            be added in the hash table (should be either deleted by the 
180  *            caller) 
181  */
182 static inline int t_uac_prepare(str* method, str* headers, str* body, 
183                 dlg_t* dialog, transaction_cb cb, void* cbp, struct retr_buf **dst_req,
184                 struct cell **dst_cell)
185 {
186         struct dest_info dst;
187         struct cell *new_cell;
188         struct retr_buf *request;
189         char* buf;
190         int buf_len, ret, flags;
191         unsigned int hi;
192         int is_ack;
193         ticks_t lifetime;
194 #ifdef USE_DNS_FAILOVER
195         struct dns_srv_handle dns_h;
196 #endif
197
198         ret=-1;
199         hi=0; /* make gcc happy */
200         /*if (dst_req) *dst_req = NULL;*/
201         is_ack = (((method->len == 3) && (memcmp("ACK", method->s, 3)==0)) ? 1 : 0);
202         
203         /*** added by dcm 
204          * - needed by external ua to send a request within a dlg
205          */
206         if (w_calculate_hooks(dialog)<0 && !dialog->hooks.next_hop)
207                 goto error2;
208
209         if (!dialog->loc_seq.is_set) {
210                 /* this is the first request in the dialog,
211                 set cseq to default value now - Miklos */
212                 dialog->loc_seq.value = DEFAULT_CSEQ;
213                 dialog->loc_seq.is_set = 1;
214         }
215
216         DBG("DEBUG:tm:t_uac: next_hop=<%.*s>\n",dialog->hooks.next_hop->len,
217                         dialog->hooks.next_hop->s);
218         /* it's a new message, so we will take the default socket */
219 #ifdef USE_DNS_FAILOVER
220         if (use_dns_failover){
221                 dns_srv_handle_init(&dns_h);
222                 if ((uri2dst(&dns_h, &dst, 0, dialog->hooks.next_hop, PROTO_NONE)==0)
223                                 || (dst.send_sock==0)){
224                         dns_srv_handle_put(&dns_h);
225                         ser_error = E_NO_SOCKET;
226                         ret=ser_error;
227                         LOG(L_ERR, "t_uac: no socket found\n");
228                         goto error2;
229                 }
230                 dns_srv_handle_put(&dns_h); /* not needed anymore */
231         }else{
232                 if ((uri2dst(0, &dst, 0, dialog->hooks.next_hop, PROTO_NONE)==0) ||
233                                 (dst.send_sock==0)){
234                         ser_error = E_NO_SOCKET;
235                         ret=ser_error;
236                         LOG(L_ERR, "t_uac: no socket found\n");
237                         goto error2;
238                 }
239         }
240 #else
241         if ((uri2dst(&dst, 0, dialog->hooks.next_hop, PROTO_NONE)==0) ||
242                         (dst.send_sock==0)){
243                 ser_error = E_NO_SOCKET;
244                 ret=ser_error;
245                 LOG(L_ERR, "t_uac: no socket found\n");
246                 goto error2;
247         }
248 #endif
249
250         new_cell = build_cell(0); 
251         if (!new_cell) {
252                 ret=E_OUT_OF_MEM;
253                 LOG(L_ERR, "t_uac: short of cell shmem\n");
254                 goto error2;
255         }
256         if (method->len==INVITE_LEN && memcmp(method->s, INVITE, INVITE_LEN)==0){
257                 new_cell->flags |= T_IS_INVITE_FLAG;
258                 new_cell->flags|=T_AUTO_INV_100 & (!tm_auto_inv_100 -1);
259                 lifetime=tm_max_inv_lifetime;
260         }else
261                 lifetime=tm_max_noninv_lifetime;
262         new_cell->flags |= T_IS_LOCAL_FLAG;
263         /* init timers hack, new_cell->fr_timer and new_cell->fr_inv_timer
264          * must be set, or else the fr will happen immediately
265          * we can't call init_new_t() because we don't have a sip msg
266          * => we'll ignore t_set_fr() or avp timer value and will use directly the
267          * module params fr_inv_timer and fr_timer -- andrei */
268         new_cell->fr_timeout=fr_timeout;
269         new_cell->fr_inv_timeout=fr_inv_timeout;
270         new_cell->end_of_life=get_ticks_raw()+lifetime;
271 #ifdef TM_DIFF_RT_TIMEOUT
272         /* same as above for retransmission intervals */
273         new_cell->rt_t1_timeout=rt_t1_timeout;
274         new_cell->rt_t2_timeout=rt_t2_timeout;
275 #endif
276
277         /* better reset avp list now - anyhow, it's useless from
278          * this point (bogdan) */
279         reset_avps();
280
281         /* add the callback the the transaction for LOCAL_COMPLETED event */
282  
283         flags = TMCB_LOCAL_COMPLETED;
284         /* Add also TMCB_LOCAL_REPLY_OUT if provisional replies are desired */
285         if (pass_provisional_replies) flags |= TMCB_LOCAL_RESPONSE_OUT;
286
287         if(cb && insert_tmcb(&(new_cell->tmcb_hl), flags, cb, cbp)!=1){
288                 ret=E_OUT_OF_MEM; 
289                 LOG(L_ERR, "t_uac: short of tmcb shmem\n");
290                 goto error2;
291         }
292
293         set_kr(REQ_FWDED);
294
295         request = &new_cell->uac[0].request;
296         
297         request->dst = dst;
298
299         if (!is_ack) {
300 #ifdef TM_DEL_UNREF
301                 INIT_REF(new_cell, 1); /* ref'ed only from the hash */
302 #endif
303                 hi=dlg2hash(dialog);
304                 LOCK_HASH(hi);
305                 insert_into_hash_table_unsafe(new_cell, hi);
306                 UNLOCK_HASH(hi);
307         }
308
309         buf = build_uac_req(method, headers, body, dialog, 0, new_cell,
310                 &buf_len, &dst);
311         if (!buf) {
312                 LOG(L_ERR, "t_uac: Error while building message\n");
313                 ret=E_OUT_OF_MEM;
314                 goto error1;
315         }
316
317         new_cell->method.s = buf;
318         new_cell->method.len = method->len;
319
320         request->buffer = buf;
321         request->buffer_len = buf_len;
322         new_cell->nr_of_outgoings++;
323         
324         if (has_local_reqin_tmcbs())
325                         run_local_reqin_callbacks(new_cell, 0, 0);
326 #ifdef DIALOG_CALLBACKS
327         run_trans_dlg_callbacks(dialog, new_cell, request);
328 #endif /* DIALOG_CALLBACKS */
329         if (dst_req) *dst_req = request;
330         if (dst_cell) *dst_cell = new_cell;
331         else if(is_ack && dst_req==0){
332                 free_cell(new_cell);
333         }
334         
335         return 1;
336
337  error1:
338         if (!is_ack) {
339                 LOCK_HASH(hi);
340                 remove_from_hash_table_unsafe(new_cell);
341                 UNLOCK_HASH(hi);
342 #ifdef TM_DEL_UNREF
343                 UNREF_FREE(new_cell);
344         }else
345 #else
346         }
347 #endif
348                 free_cell(new_cell);
349 error2:
350         return ret;
351 }
352
353 /*
354  * Prepare a message within a dialog
355  */
356 int prepare_req_within(str* method, str* headers, 
357                 str* body, dlg_t* dialog, transaction_cb completion_cb, 
358                 void* cbp, struct retr_buf **dst_req)
359 {
360         if (!method || !dialog) {
361                 LOG(L_ERR, "req_within: Invalid parameter value\n");
362                 goto err;
363         }
364
365         if (dialog->state != DLG_CONFIRMED) {
366                 LOG(L_ERR, "req_within: Dialog is not confirmed yet\n");
367                 goto err;
368         }
369
370         if ((method->len == 3) && (!memcmp("ACK", method->s, 3))) goto send;
371         if ((method->len == 6) && (!memcmp("CANCEL", method->s, 6))) goto send;
372         dialog->loc_seq.value++; /* Increment CSeq */
373  send:
374         return t_uac_prepare(method, headers, body, dialog, completion_cb, cbp, dst_req, 0);
375
376  err:
377         /* if (cbp) shm_free(cbp); */
378         /* !! never free cbp here because if t_uac_prepare fails, cbp is not freed
379          * and thus caller has no chance to discover if it is freed or not !! */
380         return -1;
381 }
382
383 static inline void send_prepared_request_impl(struct retr_buf *request, int retransmit)
384 {
385         if (SEND_BUFFER(request) == -1) {
386                 LOG(L_ERR, "t_uac: Attempt to send to precreated request failed\n");
387         }
388 #ifdef TMCB_ONSEND
389         else if (unlikely(has_tran_tmcbs(request->my_T, TMCB_REQUEST_SENT)))
390                 /* we don't know the method here */
391                         run_onsend_callbacks(TMCB_REQUEST_SENT, request, 0, 0,
392                                                                         TMCB_LOCAL_F);
393 #endif
394         
395         if (retransmit && (start_retr(request)!=0))
396                 LOG(L_CRIT, "BUG: t_uac: failed to start retr. for %p\n", request);
397 }
398
399 void send_prepared_request(struct retr_buf *request)
400 {
401         send_prepared_request_impl(request, 1 /* retransmit */);
402 }
403
404 /*
405  * Send a request using data from the dialog structure
406  */
407 int t_uac(str* method, str* headers, str* body, dlg_t* dialog,
408           transaction_cb cb, void* cbp)
409 {
410         struct retr_buf *request;
411         struct cell *cell;
412         int ret;
413         int is_ack;
414
415         ret = t_uac_prepare(method, headers, body, dialog, cb, cbp, &request, &cell);
416         if (ret < 0) return ret;
417         is_ack = (method->len == 3) && (memcmp("ACK", method->s, 3)==0) ? 1 : 0;
418         send_prepared_request_impl(request, !is_ack /* retransmit */);
419         if (cell && is_ack)
420                 free_cell(cell);
421         return ret;
422 }
423
424 /*
425  * Send a request using data from the dialog structure
426  * ret_index and ret_label will identify the new cell
427  */
428 int t_uac_with_ids(str* method, str* headers, str* body, dlg_t* dialog,
429         transaction_cb cb, void* cbp,
430         unsigned int *ret_index, unsigned int *ret_label)
431 {
432         struct retr_buf *request;
433         struct cell *cell;
434         int ret;
435         int is_ack;
436
437         ret = t_uac_prepare(method, headers, body, dialog, cb, cbp, &request, &cell);
438         if (ret < 0) return ret;
439         is_ack = (method->len == 3) && (memcmp("ACK", method->s, 3)==0) ? 1 : 0;
440         send_prepared_request_impl(request, !is_ack /* retransmit */);
441         if (is_ack) {
442                 if (cell) free_cell(cell);
443                 if (ret_index && ret_label)
444                         *ret_index = *ret_label = 0;
445         } else {
446                 if (ret_index && ret_label) {
447                         *ret_index = cell->hash_index;
448                         *ret_label = cell->label;
449                 }
450         }
451         return ret;
452 }
453
454 /*
455  * Send a message within a dialog
456  */
457 int req_within(str* method, str* headers, str* body, dlg_t* dialog, transaction_cb completion_cb, void* cbp)
458 {
459         if (!method || !dialog) {
460                 LOG(L_ERR, "req_within: Invalid parameter value\n");
461                 goto err;
462         }
463
464         if ((method->len == 3) && (!memcmp("ACK", method->s, 3))) goto send;
465         if ((method->len == 6) && (!memcmp("CANCEL", method->s, 6))) goto send;
466         dialog->loc_seq.value++; /* Increment CSeq */
467  send:
468         return t_uac(method, headers, body, dialog, completion_cb, cbp);
469
470  err:
471         if (cbp) shm_free(cbp);
472         return -1;
473 }
474
475
476 /*
477  * Send an initial request that will start a dialog
478  */
479 int req_outside(str* method, str* to, str* from, str* headers, str* body, dlg_t** dialog, transaction_cb cb, void* cbp)
480 {
481         str callid, fromtag;
482
483         if (check_params(method, to, from, dialog) < 0) goto err;
484         
485         generate_callid(&callid);
486         generate_fromtag(&fromtag, &callid);
487
488         if (new_dlg_uac(&callid, &fromtag, DEFAULT_CSEQ, from, to, dialog) < 0) {
489                 LOG(L_ERR, "req_outside(): Error while creating new dialog\n");
490                 goto err;
491         }
492
493         return t_uac(method, headers, body, *dialog, cb, cbp);
494
495  err:
496         if (cbp) shm_free(cbp);
497         return -1;
498 }
499
500
501 /*
502  * Send a transactional request, no dialogs involved
503  */
504 int request(str* m, str* ruri, str* to, str* from, str* h, str* b, str *next_hop, transaction_cb c, void* cp)
505 {
506         str callid, fromtag;
507         dlg_t* dialog;
508         int res;
509
510         if (check_params(m, to, from, &dialog) < 0) goto err;
511
512         generate_callid(&callid);
513         generate_fromtag(&fromtag, &callid);
514
515         if (new_dlg_uac(&callid, &fromtag, DEFAULT_CSEQ, from, to, &dialog) < 0) {
516                 LOG(L_ERR, "request(): Error while creating temporary dialog\n");
517                 goto err;
518         }
519
520         if (ruri) {
521                 dialog->rem_target.s = ruri->s;
522                 dialog->rem_target.len = ruri->len;
523                 /* hooks will be set from w_calculate_hooks */
524         }
525
526         if (next_hop) dialog->dst_uri = *next_hop;
527         w_calculate_hooks(dialog);
528
529         /* WARNING:
530          * to be clean it should be called 
531          *   set_dlg_target(dialog, ruri, next_hop);
532          * which sets both uris if given [but it duplicates them in shm!]
533          *
534          * but in this case the _ruri parameter in set_dlg_target
535          * must be optional (it is needed now) and following hacks
536          *   dialog->rem_target.s = 0;
537          *   dialog->dst_uri.s = 0;
538          * before freeing dialog here must be removed
539          */
540
541         res = t_uac(m, h, b, dialog, c, cp);
542         dialog->rem_target.s = 0;
543         dialog->dst_uri.s = 0;
544         free_dlg(dialog);
545         return res;
546
547  err:
548         if (cp) shm_free(cp);
549         return -1;
550 }