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