Merge pull request #1628 from rromrrom/crash_on_empty_string
[sip-router] / src / modules / ims_ipsec_pcscf / cmd.c
1 /*
2  * Copyright (C) 2012 Smile Communications, jason.penton@smilecoms.com
3  * Copyright (C) 2012 Smile Communications, richard.good@smilecoms.com
4  *
5  * The initial version of this code was written by Dragos Vingarzan
6  * (dragos(dot)vingarzan(at)fokus(dot)fraunhofer(dot)de and the
7  * Fruanhofer Institute. It was and still is maintained in a separate
8  * branch of the original SER. We are therefore migrating it to
9  * Kamailio/SR and look forward to maintaining it from here on out.
10  * 2011/2012 Smile Communications, Pty. Ltd.
11  * ported/maintained/improved by
12  * Jason Penton (jason(dot)penton(at)smilecoms.com and
13  * Richard Good (richard(dot)good(at)smilecoms.com) as part of an
14  * effort to add full IMS support to Kamailio/SR using a new and
15  * improved architecture
16  *
17  * NB: Alot of this code was originally part of OpenIMSCore,
18  * FhG Fokus.
19  * Copyright (C) 2004-2006 FhG Fokus
20  * Thanks for great work! This is an effort to
21  * break apart the various CSCF functions into logically separate
22  * components. We hope this will drive wider use. We also feel
23  * that in this way the architecture is more complete and thereby easier
24  * to manage in the Kamailio/SR environment
25  *
26  * This file is part of Kamailio, a free SIP server.
27  *
28  * Kamailio is free software; you can redistribute it and/or modify
29  * it under the terms of the GNU General Public License as published by
30  * the Free Software Foundation; either version 2 of the License, or
31  * (at your option) any later version
32  *
33  * Kamailio is distributed in the hope that it will be useful,
34  * but WITHOUT ANY WARRANTY; without even the implied warranty of
35  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
36  * GNU General Public License for more details.
37  *
38  * You should have received a copy of the GNU General Public License
39  * along with this program; if not, write to the Free Software
40  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
41  *
42  */
43
44 #include "../../core/parser/msg_parser.h"
45 #include "../../core/socket_info.h"
46 #include "../../lib/ims/ims_getters.h"
47 #include "../../modules/tm/tm_load.h"
48 #include "../ims_usrloc_pcscf/usrloc.h"
49
50 #include "ipsec.h"
51 #include "spi_gen.h"
52
53 #include <stdlib.h>
54 #include <string.h>
55
56
57 extern str ipsec_listen_addr;
58 extern short ipsec_listen_port;
59 extern short ipsec_server_port;
60 extern short ipsec_client_port;
61
62 // check http://www.asipto.com/pub/kamailio-devel-guide/#c16return_values
63 const int IPSEC_CMD_FAIL = -1;
64 const int IPSEC_CMD_SUCCESS = 1;
65
66 extern usrloc_api_t ul;
67 extern struct tm_binds tmb;
68
69
70 static str get_www_auth_param(const char* param_name, str www_auth)
71 {
72     str val = {0,0};
73     int i = 0;
74     int param_len = strlen(param_name);
75     int start = 0;
76     int end = 0;
77
78     for(i = 0; i < www_auth.len; i++) {
79         if (www_auth.s[i] == ' ') continue;
80
81         if(strncasecmp(www_auth.s+i, param_name, param_len) == 0) {
82             i += param_len;
83
84             //find first double quote
85             while(www_auth.s[i] != '"' && i < www_auth.len) i++;
86             i++; //and skip it
87
88             if (i == www_auth.len)
89                 return val; //error
90             start = i;
91             i++;
92
93             //find second double quote
94             while(www_auth.s[i] != '"' && i < www_auth.len) i++;
95             if (i == www_auth.len)
96                 return val; //error
97             end = i;
98             i++;
99
100             val.s = www_auth.s + start;
101             val.len = end - start;
102             break;
103         }
104
105         //parameter not relevant - fast forward
106         do { i++; } while (www_auth.s[i] != ',' && i < www_auth.len);
107     }
108
109     return val;
110 }
111
112
113 static int fill_contact(struct pcontact_info* ci, struct sip_msg* m)
114 {
115     contact_body_t* cb = NULL;
116     struct via_body* vb = NULL;
117     unsigned short port, proto = 0;
118     struct sip_msg* req = NULL;
119
120
121     if(!ci) {
122         LM_ERR("fill_contact() called with null ptr\n");
123         return -1;
124     }
125
126     memset(ci, 0, sizeof(struct pcontact_info));
127
128
129     if(m->first_line.type == SIP_REQUEST) {
130         struct sip_uri uri;
131         memset(&uri, 0, sizeof(struct sip_uri));
132
133         if(parse_uri(m->first_line.u.request.uri.s, m->first_line.u.request.uri.len, &uri)) {
134             LM_ERR("Can't parse the request URI from first line\n");
135             return -1;
136         }
137
138         // populate host,port, aor in CI
139         ci->via_host = uri.host;
140         ci->via_port = uri.port_no ? uri.port_no : 5060;
141         ci->via_prot = proto;
142         ci->aor = m->first_line.u.request.uri;
143
144         req = m;
145     }
146     else if(m->first_line.type == SIP_REPLY) {
147
148         cb = cscf_parse_contacts(m);
149         vb = cscf_get_ue_via(m);
150         port = vb->port?vb->port:5060;
151         proto = vb->proto;
152
153         struct cell *t = tmb.t_gett();
154         if (!t || t == (void*) -1) {
155             LM_ERR("fill_contact(): Reply without transaction\n");
156             return -1;
157         }
158
159         req = t->uas.request;
160
161         cb = cscf_parse_contacts(req);
162         if (!cb || (!cb->contacts)) {
163             LM_ERR("fill_contact(): No contact headers\n");
164             return -1;
165         }
166
167         // populate CI with bare minimum
168         ci->via_host = vb->host;
169         ci->via_port = port;
170         ci->via_prot = proto;
171         ci->aor = cb->contacts->uri;
172     }
173
174
175     char* srcip = NULL;
176     if((srcip = pkg_malloc(50)) == NULL) {
177         LM_ERR("Error allocating memory for source IP address\n");
178         return -1;
179     }
180
181     ci->received_host.len = ip_addr2sbuf(&req->rcv.src_ip, srcip, 50);
182     ci->received_host.s = srcip;
183     ci->received_port = req->rcv.src_port;
184     ci->received_proto = req->rcv.proto;
185
186     // Set to default, if not set:
187     if (ci->received_port == 0)
188         ci->received_port = 5060;
189
190
191     return 0;
192 }
193
194 // Get CK and IK from WWW-Authenticate
195 static int get_ck_ik(const struct sip_msg* m, str* ck, str* ik)
196 {
197     struct hdr_field *www_auth_hdr = NULL;
198     str www_auth;
199     memset(&www_auth, 0, sizeof(str));
200
201     www_auth = cscf_get_authenticate((sip_msg_t*)m, &www_auth_hdr);
202
203     *ck = get_www_auth_param("ck", www_auth);
204     if (ck->len == 0) {
205         LM_ERR("Error getting CK\n");
206         return -1;
207     }
208
209     *ik = get_www_auth_param("ik", www_auth);
210     if (ck->len == 0) {
211         LM_ERR("Error getting IK\n");
212         return -1;
213     }
214
215     return 0;
216 }
217
218 static int update_contact_ipsec_params(ipsec_t* s, const struct sip_msg* m)
219 {
220     // Get CK and IK
221     str ck, ik;
222     if(get_ck_ik(m, &ck, &ik) != 0) {
223         return -1;
224     }
225
226     // Save CK and IK in the contact
227     s->ck.s = shm_malloc(ck.len);
228     if(s->ck.s == NULL) {
229         LM_ERR("Error allocating memory for CK\n");
230         return -1;
231     }
232     memcpy(s->ck.s, ck.s, ck.len);
233     s->ck.len = ck.len;
234
235     s->ik.s = shm_malloc(ik.len);
236     if(s->ik.s == NULL) {
237         LM_ERR("Error allocating memory for IK\n");
238         shm_free(s->ck.s);
239         s->ck.s = NULL; s->ck.len = 0;
240         s->ik.s = NULL; s->ik.len = 0;
241         return -1;
242     }
243     memcpy(s->ik.s, ik.s, ik.len);
244     s->ik.len = ik.len;
245
246     // Generate SPI
247     if((s->spi_pc = acquire_spi()) == 0) {
248         LM_ERR("Error generating client SPI for IPSEC tunnel creation\n");
249         shm_free(s->ck.s);
250         s->ck.s = NULL; s->ck.len = 0;
251         shm_free(s->ik.s);
252         s->ik.s = NULL; s->ik.len = 0;
253         return -1;
254     }
255
256     if((s->spi_ps = acquire_spi()) == 0) {
257         LM_ERR("Error generating server SPI for IPSEC tunnel creation\n");
258         shm_free(s->ck.s);
259         s->ck.s = NULL; s->ck.len = 0;
260         shm_free(s->ik.s);
261         s->ik.s = NULL; s->ik.len = 0;
262         return -1;
263     }
264
265     return 0;
266 }
267
268 static int create_ipsec_tunnel(const str remote_addr, ipsec_t* s)
269 {
270     struct mnl_socket* sock = init_mnl_socket();
271     if (sock == NULL) {
272         return -1;
273     }
274
275     LM_DBG("Creating security associations: Local IP: %.*s client port: %d server port: %d; UE IP: %.*s; client port %d server port %d\n",
276             ipsec_listen_addr.len, ipsec_listen_addr.s, ipsec_client_port, ipsec_server_port,
277             remote_addr.len, remote_addr.s, s->port_uc, s->port_us);
278
279     // P-CSCF 'client' tunnel to UE 'server'
280     add_sa    (sock, ipsec_listen_addr, remote_addr, ipsec_client_port, s->port_us, s->spi_us, s->ck, s->ik);
281     add_policy(sock, ipsec_listen_addr, remote_addr, ipsec_client_port, s->port_us, s->spi_us, IPSEC_POLICY_DIRECTION_OUT);
282
283     // UE 'client' to P-CSCF 'server' tunnel
284     add_sa    (sock, remote_addr, ipsec_listen_addr, s->port_uc, ipsec_server_port, s->spi_ps, s->ck, s->ik);
285     add_policy(sock, remote_addr, ipsec_listen_addr, s->port_uc, ipsec_server_port, s->spi_ps, IPSEC_POLICY_DIRECTION_IN);
286
287     close_mnl_socket(sock);
288
289     return 0;
290 }
291
292 static int destroy_ipsec_tunnel(const str remote_addr, ipsec_t* s)
293 {
294     struct mnl_socket* sock = init_mnl_socket();
295     if (sock == NULL) {
296         return -1;
297     }
298
299     LM_DBG("Destroying security associations: Local IP: %.*s client port: %d server port: %d; UE IP: %.*s; client port %d server port %d\n",
300             ipsec_listen_addr.len, ipsec_listen_addr.s, ipsec_client_port, ipsec_server_port,
301             remote_addr.len, remote_addr.s, s->port_uc, s->port_us);
302
303     // P-CSCF 'client' tunnel to UE 'server'
304     remove_sa    (sock, ipsec_listen_addr, remote_addr, ipsec_client_port, s->port_us, s->spi_us);
305     remove_policy(sock, ipsec_listen_addr, remote_addr, ipsec_client_port, s->port_us, s->spi_us, IPSEC_POLICY_DIRECTION_OUT);
306
307     // UE 'client' to P-CSCF 'server' tunnel
308     remove_sa    (sock, remote_addr, ipsec_listen_addr, s->port_uc, ipsec_server_port, s->spi_ps);
309     remove_policy(sock, remote_addr, ipsec_listen_addr, s->port_uc, ipsec_server_port, s->spi_ps, IPSEC_POLICY_DIRECTION_IN);
310
311     // Release SPIs
312     release_spi(s->spi_uc);
313     release_spi(s->spi_us);
314
315
316     close_mnl_socket(sock);
317     return 0;
318 }
319
320 static void on_expire(struct pcontact *c, int type, void *param)
321 {
322     if(type != PCSCF_CONTACT_EXPIRE && type != PCSCF_CONTACT_DELETE) {
323         LM_ERR("Unexpected event type %d\n", type);
324         return;
325     }
326
327
328     if(c->security_temp == NULL) {
329         LM_ERR("No security parameters found in contact\n");
330         return;
331     }
332
333     //get security parameters
334     if(c->security_temp->type != SECURITY_IPSEC ) {
335         LM_ERR("Unsupported security type: %d\n", c->security_temp->type);
336         return;
337     }
338
339     destroy_ipsec_tunnel(c->received_host, c->security_temp->data.ipsec);
340 }
341
342 int add_supported_secagree_header(struct sip_msg* m)
343 {
344     // Add sec-agree header in the reply
345     const char* supported_sec_agree = "Supported: sec-agree\r\n";
346     const int supported_sec_agree_len = 22;
347
348     str* supported = NULL;
349     if((supported = pkg_malloc(sizeof(str))) == NULL) {
350         LM_ERR("Error allocating pkg memory for supported header\n");
351         return -1;
352     }
353
354     if((supported->s = pkg_malloc(supported_sec_agree_len)) == NULL) {
355         LM_ERR("Error allcationg pkg memory for supported header str\n");
356         return -1;
357     }
358     memcpy(supported->s, supported_sec_agree, supported_sec_agree_len);
359     supported->len = supported_sec_agree_len;
360
361     if(cscf_add_header(m, supported, HDR_SUPPORTED_T) != 1) {
362         LM_ERR("Error adding security header to reply!\n");
363         return -1;
364     }
365
366     return 0;
367 }
368
369 int add_security_server_header(struct sip_msg* m, ipsec_t* s)
370 {
371     // allocate memory for the header itself
372     str* sec_header = NULL;
373     if((sec_header = pkg_malloc(sizeof(str))) == NULL) {
374         LM_ERR("Error allocating pkg memory for security header\n");
375         return -1;
376     }
377     memset(sec_header, 0, sizeof(str));
378
379     // create a temporary buffer and set the value in it
380     char sec_hdr_buf[1024];
381     memset(sec_hdr_buf, 0, sizeof(sec_hdr_buf));
382     sec_header->len = snprintf(sec_hdr_buf, sizeof(sec_hdr_buf) - 1,
383                                 "Security-Server: ipsec-3gpp;prot=esp;mod=trans;spi-c=%d;spi-s=%d;port-c=%d;port-s=%d;alg=%.*s;ealg=%.*s\r\n",
384                                 s->spi_pc, s->spi_ps, ipsec_client_port, ipsec_server_port,
385                                 s->r_alg.len, s->r_alg.s,
386                                 s->r_ealg.len, s->r_ealg.s
387                               );
388
389     // copy to the header and add
390     if((sec_header->s = pkg_malloc(sec_header->len)) == NULL) {
391         LM_ERR("Error allocating pkg memory for security header payload\n");
392         pkg_free(sec_header);
393         return -1;
394     }
395     memcpy(sec_header->s, sec_hdr_buf, sec_header->len);
396
397     // add security-server header in reply
398     if(cscf_add_header(m, sec_header, HDR_OTHER_T) != 1) {
399         LM_ERR("Error adding security header to reply!\n");
400         pkg_free(sec_header->s);
401         pkg_free(sec_header);
402         return -1;
403     }
404
405     return 0;
406 }
407
408 int ipsec_create(struct sip_msg* m, udomain_t* d)
409 {
410     pcontact_t* pcontact = NULL;
411     struct pcontact_info ci;
412     int ret = IPSEC_CMD_FAIL;   // FAIL by default
413
414     // Find the contact
415     if(fill_contact(&ci, m) != 0) {
416         LM_ERR("Error filling in contact data\n");
417         return ret;
418     }
419
420     ul.lock_udomain(d, &ci.via_host, ci.via_port, ci.via_prot);
421
422     if (ul.get_pcontact(d, &ci, &pcontact) != 0) {
423         LM_ERR("Contact doesn't exist\n");
424         goto cleanup;
425     }
426
427     // Get security parameters
428     if(pcontact->security_temp == NULL) {
429         LM_ERR("No security parameters found in contact\n");
430         goto cleanup;
431     }
432
433     if(pcontact->security_temp->type != SECURITY_IPSEC ) {
434         LM_ERR("Unsupported security type: %d\n", pcontact->security_temp->type);
435         goto cleanup;
436     }
437
438     ipsec_t* s = pcontact->security_temp->data.ipsec;
439
440     if(update_contact_ipsec_params(s, m) != 0) {
441         goto cleanup;
442     }
443
444     if(create_ipsec_tunnel(ci.received_host, s) != 0) {
445         goto cleanup;
446     }
447
448     // TODO: Save security_tmp to security!!!!!
449
450     if (ul.update_pcontact(d, &ci, pcontact) != 0) {
451         LM_ERR("Error updating contact\n");
452         goto cleanup;
453     }
454
455     // Destroy the tunnel, if the contact expires
456     if(ul.register_ulcb(pcontact, PCSCF_CONTACT_EXPIRE|PCSCF_CONTACT_DELETE, on_expire, NULL) != 1) {
457         LM_ERR("Error subscribing for contact\n");
458         goto cleanup;
459     }
460
461
462     if(add_supported_secagree_header(m) != 0) {
463         goto cleanup;
464     }
465
466     if(add_security_server_header(m, s) != 0) {
467         goto cleanup;
468     }
469
470     ret = IPSEC_CMD_SUCCESS;    // all good, set ret to SUCCESS, and exit
471
472 cleanup:
473     // Do not free str* sec_header! It will be freed in data_lump.c -> free_lump()
474     ul.unlock_udomain(d, &ci.via_host, ci.via_port, ci.via_prot);
475     pkg_free(ci.received_host.s);
476     return ret;
477 }
478
479
480 int ipsec_forward(struct sip_msg* m, udomain_t* d)
481 {
482     struct pcontact_info ci;
483     pcontact_t* pcontact = NULL;
484     int ret = IPSEC_CMD_FAIL; // FAIL by default
485
486     //
487     // Find the contact
488     //
489     if(fill_contact(&ci, m) != 0) {
490         LM_ERR("Error filling in contact data\n");
491         return ret;
492     }
493
494     ul.lock_udomain(d, &ci.via_host, ci.via_port, ci.via_prot);
495
496     if (ul.get_pcontact(d, &ci, &pcontact) != 0) {
497         LM_ERR("Contact doesn't exist\n");
498         goto cleanup;
499     }
500
501
502     if(pcontact->security_temp == NULL) {
503         LM_ERR("No security parameters found in contact\n");
504         goto cleanup;
505     }
506
507     //get security parameters
508     if(pcontact->security_temp->type != SECURITY_IPSEC ) {
509         LM_ERR("Unsupported security type: %d\n", pcontact->security_temp->type);
510         goto cleanup;
511     }
512
513     ipsec_t* s = pcontact->security_temp->data.ipsec;
514
515
516     // Update the destination
517     //
518     //       from sec-agree
519     //            v
520     // sip:host:port
521     //       ^
522     //    from URI
523     //int uri_len = 4 /* strlen("sip:") */ + ci.via_host.len + 5 /* max len of port number */ ;
524
525     if(m->dst_uri.s) {
526         pkg_free(m->dst_uri.s);
527         m->dst_uri.s = NULL;
528         m->dst_uri.len = 0;
529     }
530
531     char buf[1024];
532     int buf_len = snprintf(buf, sizeof(buf) - 1, "sip:%.*s:%d", ci.via_host.len, ci.via_host.s, s->port_us);
533
534     if((m->dst_uri.s = pkg_malloc(buf_len)) == NULL) {
535         LM_ERR("Error allocating memory for dst_uri\n");
536         goto cleanup;
537     }
538
539     memcpy(m->dst_uri.s, buf, buf_len);
540     m->dst_uri.len = buf_len;
541
542     // Set send socket
543     struct socket_info * client_sock = grep_sock_info(&ipsec_listen_addr, ipsec_client_port, PROTO_UDP);
544     if(!client_sock) {
545         LM_ERR("Error calling grep_sock_info() for ipsec client port in ipsec_forward\n");
546         return -1;
547     }
548     m->force_send_socket = client_sock;
549
550    // Set destination info
551     struct dest_info dst_info;
552     dst_info.send_sock = client_sock;
553 #ifdef USE_DNS_FAILOVER
554     if (!uri2dst(NULL, &dst_info, m, &m->dst_uri, PROTO_UDP)) {
555 #else
556     if (!uri2dst(&dst_info, m, &m->dst_uri, PROTO_UDP)) {
557 #endif
558         LM_ERR("Error converting dst_uri (%.*s) to struct dst_info\n", m->dst_uri.len, m->dst_uri.s);
559         goto cleanup;
560     }
561
562     // Update dst_info in message
563     if(m->first_line.type == SIP_REPLY) {
564         struct cell *t = tmb.t_gett();
565         if (!t) {
566             LM_ERR("Error getting transaction\n");
567             goto cleanup;
568         }
569         t->uas.response.dst = dst_info;
570     }
571
572     LM_DBG("Destination changed to %.*s\n", m->dst_uri.len, m->dst_uri.s);
573
574     ret = IPSEC_CMD_SUCCESS; // all good, return SUCCESS
575
576     if(add_supported_secagree_header(m) != 0) {
577         goto cleanup;
578     }
579
580     if(add_security_server_header(m, s) != 0) {
581         goto cleanup;
582     }
583
584     ret = IPSEC_CMD_SUCCESS;    // all good, set ret to SUCCESS, and exit
585
586 cleanup:
587     ul.unlock_udomain(d, &ci.via_host, ci.via_port, ci.via_prot);
588     pkg_free(ci.received_host.s);
589     return ret;
590 }
591
592
593 int ipsec_destroy(struct sip_msg* m, udomain_t* d)
594 {
595     struct pcontact_info ci;
596     pcontact_t* pcontact = NULL;
597     int ret = IPSEC_CMD_FAIL; // FAIL by default
598
599     //
600     // Find the contact
601     //
602     if(fill_contact(&ci, m) != 0) {
603         LM_ERR("Error filling in contact data\n");
604         return ret;
605     }
606
607     ul.lock_udomain(d, &ci.via_host, ci.via_port, ci.via_prot);
608
609     if (ul.get_pcontact(d, &ci, &pcontact) != 0) {
610         LM_ERR("Contact doesn't exist\n");
611         goto cleanup;
612     }
613
614
615     if(pcontact->security_temp == NULL) {
616         LM_ERR("No security parameters found in contact\n");
617         goto cleanup;
618     }
619
620     //get security parameters
621     if(pcontact->security_temp->type != SECURITY_IPSEC ) {
622         LM_ERR("Unsupported security type: %d\n", pcontact->security_temp->type);
623         goto cleanup;
624     }
625
626     destroy_ipsec_tunnel(ci.received_host, pcontact->security_temp->data.ipsec);
627
628     ret = IPSEC_CMD_SUCCESS;    // all good, set ret to SUCCESS, and exit
629
630 cleanup:
631     ul.unlock_udomain(d, &ci.via_host, ci.via_port, ci.via_prot);
632     pkg_free(ci.received_host.s);
633     return ret;
634 }
635
636 int ipsec_cleanall()
637 {
638     struct mnl_socket* nlsock = init_mnl_socket();
639     if(!nlsock) {
640         return -1;
641     }
642
643     if(clean_sa(nlsock) != 0) {
644         LM_WARN("Error cleaning IPSec Security associations during startup.\n");
645     }
646
647     if(clean_policy(nlsock) != 0) {
648         LM_WARN("Error cleaning IPSec Policies during startup.\n");
649     }
650
651     close_mnl_socket(nlsock);
652
653     return 0;
654 }