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