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