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