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