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