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