- tmcb onsend callbacks update (they get also the request or the reply if they
[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 static inline int t_uac_prepare(str* method, str* headers, str* body, 
173                 dlg_t* dialog, transaction_cb cb, void* cbp, struct retr_buf **dst_req,
174                 struct cell **dst_cell)
175 {
176         struct dest_info dst;
177         struct cell *new_cell;
178         struct retr_buf *request;
179         char* buf;
180         int buf_len, ret, flags;
181         unsigned int hi;
182         int is_ack;
183 #ifdef USE_DNS_FAILOVER
184         struct dns_srv_handle dns_h;
185 #endif
186
187         ret=-1;
188         hi=0; /* make gcc happy */
189         /*if (dst_req) *dst_req = NULL;*/
190         is_ack = (((method->len == 3) && (memcmp("ACK", method->s, 3)==0)) ? 1 : 0);
191         
192         /*** added by dcm 
193          * - needed by external ua to send a request within a dlg
194          */
195         if (w_calculate_hooks(dialog)<0 && !dialog->hooks.next_hop)
196                 goto error2;
197
198         if (!dialog->loc_seq.is_set) {
199                 /* this is the first request in the dialog,
200                 set cseq to default value now - Miklos */
201                 dialog->loc_seq.value = DEFAULT_CSEQ;
202                 dialog->loc_seq.is_set = 1;
203         }
204
205         DBG("DEBUG:tm:t_uac: next_hop=<%.*s>\n",dialog->hooks.next_hop->len,
206                         dialog->hooks.next_hop->s);
207         /* it's a new message, so we will take the default socket */
208 #ifdef USE_DNS_FAILOVER
209         if (use_dns_failover){
210                 dns_srv_handle_init(&dns_h);
211                 if ((uri2dst(&dns_h, &dst, 0, dialog->hooks.next_hop, PROTO_NONE)==0)
212                                 || (dst.send_sock==0)){
213                         dns_srv_handle_put(&dns_h);
214                         ser_error = E_NO_SOCKET;
215                         ret=ser_error;
216                         LOG(L_ERR, "t_uac: no socket found\n");
217                         goto error2;
218                 }
219                 dns_srv_handle_put(&dns_h); /* not needed anymore */
220         }else{
221                 if ((uri2dst(0, &dst, 0, dialog->hooks.next_hop, PROTO_NONE)==0) ||
222                                 (dst.send_sock==0)){
223                         ser_error = E_NO_SOCKET;
224                         ret=ser_error;
225                         LOG(L_ERR, "t_uac: no socket found\n");
226                         goto error2;
227                 }
228         }
229 #else
230         if ((uri2dst(&dst, 0, dialog->hooks.next_hop, PROTO_NONE)==0) ||
231                         (dst.send_sock==0)){
232                 ser_error = E_NO_SOCKET;
233                 ret=ser_error;
234                 LOG(L_ERR, "t_uac: no socket found\n");
235                 goto error2;
236         }
237 #endif
238
239         new_cell = build_cell(0); 
240         if (!new_cell) {
241                 ret=E_OUT_OF_MEM;
242                 LOG(L_ERR, "t_uac: short of cell shmem\n");
243                 goto error2;
244         }
245         /* init timers hack, new_cell->fr_timer and new_cell->fr_inv_timer
246          * must be set, or else the fr will happen immediately
247          * we can't call init_new_t() because we don't have a sip msg
248          * => we'll ignore t_set_fr() or avp timer value and will use directly the
249          * module params fr_inv_timer and fr_timer -- andrei */
250         new_cell->fr_timeout=fr_timeout;
251         new_cell->fr_inv_timeout=fr_inv_timeout;
252
253         /* better reset avp list now - anyhow, it's useless from
254          * this point (bogdan) */
255         reset_avps();
256
257         /* add the callback the the transaction for LOCAL_COMPLETED event */
258  
259         flags = TMCB_LOCAL_COMPLETED;
260         /* Add also TMCB_LOCAL_REPLY_OUT if provisional replies are desired */
261         if (pass_provisional_replies) flags |= TMCB_LOCAL_RESPONSE_OUT;
262
263         if(cb && insert_tmcb(&(new_cell->tmcb_hl), flags, cb, cbp)!=1){
264                 ret=E_OUT_OF_MEM; 
265                 LOG(L_ERR, "t_uac: short of tmcb shmem\n");
266                 goto error2;
267         }
268
269         if (method->len==INVITE_LEN && memcmp(method->s, INVITE, INVITE_LEN)==0)
270                 new_cell->flags |= T_IS_INVITE_FLAG;
271         new_cell->flags |= T_IS_LOCAL_FLAG;
272         set_kr(REQ_FWDED);
273
274         request = &new_cell->uac[0].request;
275         
276         request->dst = dst;
277
278         if (!is_ack) {
279                 hi=dlg2hash(dialog);
280                 LOCK_HASH(hi);
281                 insert_into_hash_table_unsafe(new_cell, hi);
282                 UNLOCK_HASH(hi);
283         }
284
285         buf = build_uac_req(method, headers, body, dialog, 0, new_cell,
286                 &buf_len, &dst);
287         if (!buf) {
288                 LOG(L_ERR, "t_uac: Error while building message\n");
289                 ret=E_OUT_OF_MEM;
290                 goto error1;
291         }
292
293         new_cell->method.s = buf;
294         new_cell->method.len = method->len;
295
296         request->buffer = buf;
297         request->buffer_len = buf_len;
298         new_cell->nr_of_outgoings++;
299         
300         if (has_local_reqin_tmcbs())
301                         run_local_reqin_callbacks(new_cell, 0, 0);
302 #ifdef DIALOG_CALLBACKS
303         run_trans_dlg_callbacks(dialog, new_cell, request);
304 #endif /* DIALOG_CALLBACKS */
305         if (dst_req) *dst_req = request;
306         if (dst_cell) *dst_cell = new_cell;
307         
308         return 1;
309
310  error1:
311         if (!is_ack) {
312                 LOCK_HASH(hi);
313                 remove_from_hash_table_unsafe(new_cell);
314                 UNLOCK_HASH(hi);
315         }
316         free_cell(new_cell);
317 error2:
318         return ret;
319 }
320
321 /*
322  * Prepare a message within a dialog
323  */
324 int prepare_req_within(str* method, str* headers, 
325                 str* body, dlg_t* dialog, transaction_cb completion_cb, 
326                 void* cbp, struct retr_buf **dst_req)
327 {
328         if (!method || !dialog) {
329                 LOG(L_ERR, "req_within: Invalid parameter value\n");
330                 goto err;
331         }
332
333         if (dialog->state != DLG_CONFIRMED) {
334                 LOG(L_ERR, "req_within: Dialog is not confirmed yet\n");
335                 goto err;
336         }
337
338         if ((method->len == 3) && (!memcmp("ACK", method->s, 3))) goto send;
339         if ((method->len == 6) && (!memcmp("CANCEL", method->s, 6))) goto send;
340         dialog->loc_seq.value++; /* Increment CSeq */
341  send:
342         return t_uac_prepare(method, headers, body, dialog, completion_cb, cbp, dst_req, 0);
343
344  err:
345         /* if (cbp) shm_free(cbp); */
346         /* !! never free cbp here because if t_uac_prepare fails, cbp is not freed
347          * and thus caller has no chance to discover if it is freed or not !! */
348         return -1;
349 }
350
351 static inline void send_prepared_request_impl(struct retr_buf *request, int retransmit)
352 {
353         if (SEND_BUFFER(request) == -1) {
354                 LOG(L_ERR, "t_uac: Attempt to send to precreated request failed\n");
355         }
356 #ifdef TMCB_ONSEND
357         else if (unlikely(has_tran_tmcbs(request->my_T, TMCB_REQUEST_SENT)))
358                 /* we don't know the method here */
359                         run_onsend_callbacks(TMCB_REQUEST_SENT, request, 0, 0,
360                                                                         TMCB_LOCAL_F);
361 #endif
362         
363         if (retransmit && (start_retr(request)!=0))
364                 LOG(L_CRIT, "BUG: t_uac: failed to start retr. for %p\n", request);
365 }
366
367 void send_prepared_request(struct retr_buf *request)
368 {
369         send_prepared_request_impl(request, 1 /* retransmit */);
370 }
371
372 /*
373  * Send a request using data from the dialog structure
374  */
375 int t_uac(str* method, str* headers, str* body, dlg_t* dialog,
376           transaction_cb cb, void* cbp)
377 {
378         struct retr_buf *request;
379         struct cell *cell;
380         int ret;
381         int is_ack;
382
383         ret = t_uac_prepare(method, headers, body, dialog, cb, cbp, &request, &cell);
384         if (ret < 0) return ret;
385         is_ack = (method->len == 3) && (memcmp("ACK", method->s, 3)==0) ? 1 : 0;
386         send_prepared_request_impl(request, !is_ack /* retransmit */);
387         if (cell && is_ack)
388                 free_cell(cell);
389         return ret;
390 }
391
392 /*
393  * Send a request using data from the dialog structure
394  * ret_index and ret_label will identify the new cell
395  */
396 int t_uac_with_ids(str* method, str* headers, str* body, dlg_t* dialog,
397         transaction_cb cb, void* cbp,
398         unsigned int *ret_index, unsigned int *ret_label)
399 {
400         struct retr_buf *request;
401         struct cell *cell;
402         int ret;
403         int is_ack;
404
405         ret = t_uac_prepare(method, headers, body, dialog, cb, cbp, &request, &cell);
406         if (ret < 0) return ret;
407         is_ack = (method->len == 3) && (memcmp("ACK", method->s, 3)==0) ? 1 : 0;
408         send_prepared_request_impl(request, !is_ack /* retransmit */);
409         if (is_ack) {
410                 if (cell) free_cell(cell);
411                 if (ret_index && ret_label)
412                         *ret_index = *ret_label = 0;
413         } else {
414                 if (ret_index && ret_label) {
415                         *ret_index = cell->hash_index;
416                         *ret_label = cell->label;
417                 }
418         }
419         return ret;
420 }
421
422 /*
423  * Send a message within a dialog
424  */
425 int req_within(str* method, str* headers, str* body, dlg_t* dialog, transaction_cb completion_cb, void* cbp)
426 {
427         if (!method || !dialog) {
428                 LOG(L_ERR, "req_within: Invalid parameter value\n");
429                 goto err;
430         }
431
432         if ((method->len == 3) && (!memcmp("ACK", method->s, 3))) goto send;
433         if ((method->len == 6) && (!memcmp("CANCEL", method->s, 6))) goto send;
434         dialog->loc_seq.value++; /* Increment CSeq */
435  send:
436         return t_uac(method, headers, body, dialog, completion_cb, cbp);
437
438  err:
439         if (cbp) shm_free(cbp);
440         return -1;
441 }
442
443
444 /*
445  * Send an initial request that will start a dialog
446  */
447 int req_outside(str* method, str* to, str* from, str* headers, str* body, dlg_t** dialog, transaction_cb cb, void* cbp)
448 {
449         str callid, fromtag;
450
451         if (check_params(method, to, from, dialog) < 0) goto err;
452         
453         generate_callid(&callid);
454         generate_fromtag(&fromtag, &callid);
455
456         if (new_dlg_uac(&callid, &fromtag, DEFAULT_CSEQ, from, to, dialog) < 0) {
457                 LOG(L_ERR, "req_outside(): Error while creating new dialog\n");
458                 goto err;
459         }
460
461         return t_uac(method, headers, body, *dialog, cb, cbp);
462
463  err:
464         if (cbp) shm_free(cbp);
465         return -1;
466 }
467
468
469 /*
470  * Send a transactional request, no dialogs involved
471  */
472 int request(str* m, str* ruri, str* to, str* from, str* h, str* b, str *next_hop, transaction_cb c, void* cp)
473 {
474         str callid, fromtag;
475         dlg_t* dialog;
476         int res;
477
478         if (check_params(m, to, from, &dialog) < 0) goto err;
479
480         generate_callid(&callid);
481         generate_fromtag(&fromtag, &callid);
482
483         if (new_dlg_uac(&callid, &fromtag, DEFAULT_CSEQ, from, to, &dialog) < 0) {
484                 LOG(L_ERR, "request(): Error while creating temporary dialog\n");
485                 goto err;
486         }
487
488         if (ruri) {
489                 dialog->rem_target.s = ruri->s;
490                 dialog->rem_target.len = ruri->len;
491                 /* hooks will be set from w_calculate_hooks */
492         }
493
494         if (next_hop) dialog->dst_uri = *next_hop;
495         w_calculate_hooks(dialog);
496
497         /* WARNING:
498          * to be clean it should be called 
499          *   set_dlg_target(dialog, ruri, next_hop);
500          * which sets both uris if given [but it duplicates them in shm!]
501          *
502          * but in this case the _ruri parameter in set_dlg_target
503          * must be optional (it is needed now) and following hacks
504          *   dialog->rem_target.s = 0;
505          *   dialog->dst_uri.s = 0;
506          * before freeing dialog here must be removed
507          */
508
509         res = t_uac(m, h, b, dialog, c, cp);
510         dialog->rem_target.s = 0;
511         dialog->dst_uri.s = 0;
512         free_dlg(dialog);
513         return res;
514
515  err:
516         if (cp) shm_free(cp);
517         return -1;
518 }