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