5c795f44adeafe3b384dfe68410745b1f8c7f18f
[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  */
53
54 #include <string.h>
55 #include "../../mem/shm_mem.h"
56 #include "../../dprint.h"
57 #include "../../globals.h"
58 #include "../../md5.h"
59 #include "../../crc.h"
60 #include "../../ip_addr.h"
61 #include "../../socket_info.h"
62 #include "ut.h"
63 #include "h_table.h"
64 #include "t_hooks.h"
65 #include "t_funcs.h"
66 #include "t_msgbuilder.h"
67 #include "callid.h"
68 #include "uac.h"
69
70
71 #define FROM_TAG_LEN (MD5_LEN + 1 /* - */ + CRC16_LEN) /* length of FROM tags */
72
73 static char from_tag[FROM_TAG_LEN + 1];
74
75 char* uac_from = "sip:foo@foo.bar"; /* Module parameter */
76
77
78 /*
79  * Initialize UAC
80  */
81 int uac_init(void) 
82 {
83         str src[3];
84         struct socket_info *si;
85
86         if (RAND_MAX < TABLE_ENTRIES) {
87                 LOG(L_WARN, "Warning: uac does not spread "
88                     "accross the whole hash table\n");
89         }
90         /* on tcp/tls bind_address is 0 so try to get the first address we listen
91          * on no matter the protocol */
92         si=bind_address?bind_address:get_first_socket();
93         if (si==0){
94                 LOG(L_CRIT, "BUG: uac_init: null socket list\n");
95                 return -1;
96         }
97
98         /* calculate the initial From tag */
99         src[0].s = "Long live SER server";
100         src[0].len = strlen(src[0].s);
101         src[1].s = si->address_str.s;
102         src[1].len = strlen(src[1].s);
103         src[2].s = si->port_no_str.s;
104         src[2].len = strlen(src[2].s);
105
106         MDStringArray(from_tag, src, 3);
107         from_tag[MD5_LEN] = '-';
108         return 1;
109 }
110
111
112 /*
113  * Generate a From tag
114  */
115 void generate_fromtag(str* tag, str* callid)
116 {
117              /* calculate from tag from callid */
118         crcitt_string_array(&from_tag[MD5_LEN + 1], callid, 1);
119         tag->s = from_tag; 
120         tag->len = FROM_TAG_LEN;
121 }
122
123
124 /*
125  * Check value of parameters
126  */
127 static inline int check_params(str* method, str* to, str* from, dlg_t** dialog)
128 {
129         if (!method || !to || !from || !dialog) {
130                 LOG(L_ERR, "check_params(): Invalid parameter value\n");
131                 return -1;
132         }
133
134         if (!method->s || !method->len) {
135                 LOG(L_ERR, "check_params(): Invalid request method\n");
136                 return -2;
137         }
138
139         if (!to->s || !to->len) {
140                 LOG(L_ERR, "check_params(): Invalid To URI\n");
141                 return -4;
142         }
143
144         if (!from->s || !from->len) {
145                 LOG(L_ERR, "check_params(): Invalid From URI\n");
146                 return -5;
147         }
148         return 0;
149 }
150
151 static inline unsigned int dlg2hash( dlg_t* dlg )
152 {
153         str cseq_nr;
154         unsigned int hashid;
155
156         cseq_nr.s=int2str(dlg->loc_seq.value, &cseq_nr.len);
157         hashid=hash(dlg->id.call_id, cseq_nr);
158         DBG("DEBUG: dlg2hash: %d\n", hashid);
159         return hashid;
160 }
161
162 /*
163  * Send a request using data from the dialog structure
164  */
165 int t_uac(str* method, str* headers, str* body, dlg_t* dialog,
166                                                                                                 transaction_cb cb, void* cbp)
167 {
168         struct socket_info* send_sock;
169         union sockaddr_union to_su;
170         struct cell *new_cell;
171         struct retr_buf *request;
172         char* buf;
173         int buf_len;
174         int ret;
175         unsigned int hi;
176
177         ret=-1;
178         
179         /*** added by dcm 
180          * - needed by external ua to send a request within a dlg
181          */
182         if(!dialog->hooks.next_hop && w_calculate_hooks(dialog)<0)
183                 goto error2;
184
185         DBG("DEBUG:tm:t_uac: next_hop=<%.*s>\n",dialog->hooks.next_hop->len,
186                         dialog->hooks.next_hop->s);
187         send_sock = uri2sock(dialog->hooks.next_hop, &to_su, PROTO_NONE);
188         if (!send_sock) {
189                 ret=ser_error;
190                 LOG(L_ERR, "t_uac: no socket found\n");
191                 goto error2;
192         }       
193
194         new_cell = build_cell(0); 
195         if (!new_cell) {
196                 ret=E_OUT_OF_MEM;
197                 LOG(L_ERR, "t_uac: short of cell shmem\n");
198                 goto error2;
199         }
200
201         /* add the callback the the transaction for LOCAL_COMPLETED event */
202         if(cb && insert_tmcb(&(new_cell->tmcb_hl),TMCB_LOCAL_COMPLETED,cb,cbp)!=1){
203                 ret=E_OUT_OF_MEM;
204                 LOG(L_ERR, "t_uac: short of tmcb shmem\n");
205                 goto error2;
206         }
207
208         if (method->len==INVITE_LEN && memcmp(method->s, INVITE, INVITE_LEN)==0)
209                 new_cell->flags |= T_IS_INVITE_FLAG;
210         new_cell->flags |= T_IS_LOCAL_FLAG;
211         set_kr(REQ_FWDED);
212
213         request = &new_cell->uac[0].request;
214         request->dst.to = to_su;
215         request->dst.send_sock = send_sock;
216         request->dst.proto = send_sock->proto;
217         request->dst.proto_reserved1 = 0;
218
219         hi=dlg2hash(dialog);
220         LOCK_HASH(hi);
221         insert_into_hash_table_unsafe(new_cell, hi);
222         UNLOCK_HASH(hi);
223
224         buf = build_uac_req(method, headers, body, dialog, 0, new_cell,
225                 &buf_len, send_sock);
226         if (!buf) {
227                 LOG(L_ERR, "t_uac: Error while building message\n");
228                 ret=E_OUT_OF_MEM;
229                 goto error1;
230         }
231
232         new_cell->method.s = buf;
233         new_cell->method.len = method->len;
234
235         request->buffer = buf;
236         request->buffer_len = buf_len;
237         new_cell->nr_of_outgoings++;
238         
239         if (SEND_BUFFER(request) == -1) {
240                 LOG(L_ERR, "t_uac: Attempt to send to '%.*s' failed\n", 
241                         dialog->hooks.next_hop->len,
242                         dialog->hooks.next_hop->s);
243         }
244         
245         start_retr(request);
246         return 1;
247
248  error1:
249         LOCK_HASH(hi);
250         remove_from_hash_table_unsafe(new_cell);
251         UNLOCK_HASH(hi);
252         free_cell(new_cell);
253 error2:
254         return ret;
255 }
256
257
258 /*
259  * Send a message within a dialog
260  */
261 int req_within(str* method, str* headers, str* body, dlg_t* dialog, transaction_cb completion_cb, void* cbp)
262 {
263         if (!method || !dialog) {
264                 LOG(L_ERR, "req_within: Invalid parameter value\n");
265                 goto err;
266         }
267
268         if (dialog->state != DLG_CONFIRMED) {
269                 LOG(L_ERR, "req_within: Dialog is not confirmed yet\n");
270                 goto err;
271         }
272
273         if ((method->len == 3) && (!memcmp("ACK", method->s, 3))) goto send;
274         if ((method->len == 6) && (!memcmp("CANCEL", method->s, 6))) goto send;
275         dialog->loc_seq.value++; /* Increment CSeq */
276  send:
277         return t_uac(method, headers, body, dialog, completion_cb, cbp);
278
279  err:
280         if (cbp) shm_free(cbp);
281         return -1;
282 }
283
284
285 /*
286  * Send an initial request that will start a dialog
287  */
288 int req_outside(str* method, str* to, str* from, str* headers, str* body, dlg_t** dialog, transaction_cb cb, void* cbp)
289 {
290         str callid, fromtag;
291
292         if (check_params(method, to, from, dialog) < 0) goto err;
293         
294         generate_callid(&callid);
295         generate_fromtag(&fromtag, &callid);
296
297         if (new_dlg_uac(&callid, &fromtag, DEFAULT_CSEQ, from, to, dialog) < 0) {
298                 LOG(L_ERR, "req_outside(): Error while creating new dialog\n");
299                 goto err;
300         }
301
302         return t_uac(method, headers, body, *dialog, cb, cbp);
303
304  err:
305         if (cbp) shm_free(cbp);
306         return -1;
307 }
308
309
310 /*
311  * Send a transactional request, no dialogs involved
312  */
313 int request(str* m, str* ruri, str* to, str* from, str* h, str* b, transaction_cb c, void* cp)
314 {
315         str callid, fromtag;
316         dlg_t* dialog;
317         int res;
318
319         if (check_params(m, to, from, &dialog) < 0) goto err;
320
321         generate_callid(&callid);
322         generate_fromtag(&fromtag, &callid);
323
324         if (new_dlg_uac(&callid, &fromtag, DEFAULT_CSEQ, from, to, &dialog) < 0) {
325                 LOG(L_ERR, "request(): Error while creating temorary dialog\n");
326                 goto err;
327         }
328
329         if (ruri) {
330                 dialog->rem_target.s = ruri->s;
331                 dialog->rem_target.len = ruri->len;
332                 dialog->hooks.request_uri = &dialog->rem_target;
333         }
334         w_calculate_hooks(dialog);
335
336         res = t_uac(m, h, b, dialog, c, cp);
337         dialog->rem_target.s = 0;
338         free_dlg(dialog);
339         return res;
340
341  err:
342         if (cp) shm_free(cp);
343         return -1;
344 }