ims_ipsec_pcscf: cast const param to get rid of compile warning
[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 -3;
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;
176     srcip = pkg_malloc(50);
177
178     ci->received_host.len = ip_addr2sbuf(&req->rcv.src_ip, srcip, 50);
179     ci->received_host.s = srcip;
180     ci->received_port = req->rcv.src_port;
181     ci->received_proto = req->rcv.proto;
182
183     // Set to default, if not set:
184     if (ci->received_port == 0)
185         ci->received_port = 5060;
186
187
188     return 0;
189 }
190
191 // Get CK and IK from WWW-Authenticate
192 static int get_ck_ik(const struct sip_msg* m, str* ck, str* ik)
193 {
194     struct hdr_field *www_auth_hdr = NULL;
195     str www_auth;
196     memset(&www_auth, 0, sizeof(str));
197
198     www_auth = cscf_get_authenticate((sip_msg_t*)m, &www_auth_hdr);
199
200     *ck = get_www_auth_param("ck", www_auth);
201     if (ck->len == 0) {
202         LM_ERR("Error getting CK\n");
203         return -1;
204     }
205
206     *ik = get_www_auth_param("ik", www_auth);
207     if (ck->len == 0) {
208         LM_ERR("Error getting IK\n");
209         return -1;
210     }
211
212     return 0;
213 }
214
215 static int update_contact_ipsec_params(ipsec_t* s, const struct sip_msg* m)
216 {
217     // Get CK and IK
218     str ck, ik;
219     if(get_ck_ik(m, &ck, &ik) != 0) {
220         return -1;
221     }
222
223     // Save CK and IK in the contact
224     s->ck.s = shm_malloc(ck.len);
225     if(s->ck.s == NULL) {
226         LM_ERR("Error allocating memory for CK\n");
227         return -1;
228     }
229     memcpy(s->ck.s, ck.s, ck.len);
230     s->ck.len = ck.len;
231
232     s->ik.s = shm_malloc(ik.len);
233     if(s->ik.s == NULL) {
234         LM_ERR("Error allocating memory for IK\n");
235         shm_free(s->ck.s);
236         s->ck.s = NULL; s->ck.len = 0;
237         s->ik.s = NULL; s->ik.len = 0;
238         return -1;
239     }
240     memcpy(s->ik.s, ik.s, ik.len);
241     s->ik.len = ik.len;
242
243     // Generate SPI
244     if((s->spi_pc = acquire_spi()) == 0) {
245         LM_ERR("Error generating client SPI for IPSEC tunnel creation\n");
246         shm_free(s->ck.s);
247         s->ck.s = NULL; s->ck.len = 0;
248         shm_free(s->ik.s);
249         s->ik.s = NULL; s->ik.len = 0;
250         return -1;
251     }
252
253     if((s->spi_ps = acquire_spi()) == 0) {
254         LM_ERR("Error generating server SPI for IPSEC tunnel creation\n");
255         shm_free(s->ck.s);
256         s->ck.s = NULL; s->ck.len = 0;
257         shm_free(s->ik.s);
258         s->ik.s = NULL; s->ik.len = 0;
259         return -1;
260     }
261
262     return 0;
263 }
264
265 static int create_ipsec_tunnel(const str remote_addr, ipsec_t* s)
266 {
267     struct mnl_socket* sock = init_mnl_socket();
268     if (sock == NULL) {
269         return -1;
270     }
271
272     LM_DBG("Creating security associations: Local IP: %.*s client port: %d server port: %d; UE IP: %.*s; client port %d server port %d\n",
273             ipsec_listen_addr.len, ipsec_listen_addr.s, ipsec_client_port, ipsec_server_port,
274             remote_addr.len, remote_addr.s, s->port_uc, s->port_us);
275
276     // P-CSCF 'client' tunnel to UE 'server'
277     add_sa    (sock, ipsec_listen_addr, remote_addr, ipsec_client_port, s->port_us, s->spi_us, s->ck, s->ik);
278     add_policy(sock, ipsec_listen_addr, remote_addr, ipsec_client_port, s->port_us, s->spi_us, IPSEC_POLICY_DIRECTION_OUT);
279
280     // UE 'client' to P-CSCF 'server' tunnel
281     add_sa    (sock, remote_addr, ipsec_listen_addr, s->port_uc, ipsec_server_port, s->spi_ps, s->ck, s->ik);
282     add_policy(sock, remote_addr, ipsec_listen_addr, s->port_uc, ipsec_server_port, s->spi_ps, IPSEC_POLICY_DIRECTION_IN);
283
284     close_mnl_socket(sock);
285
286     return 0;
287 }
288
289 static int destroy_ipsec_tunnel(const str remote_addr, ipsec_t* s)
290 {
291     struct mnl_socket* sock = init_mnl_socket();
292     if (sock == NULL) {
293         return -1;
294     }
295
296     LM_DBG("Destroying security associations: Local IP: %.*s client port: %d server port: %d; UE IP: %.*s; client port %d server port %d\n",
297             ipsec_listen_addr.len, ipsec_listen_addr.s, ipsec_client_port, ipsec_server_port,
298             remote_addr.len, remote_addr.s, s->port_uc, s->port_us);
299
300     // P-CSCF 'client' tunnel to UE 'server'
301     remove_sa    (sock, ipsec_listen_addr, remote_addr, ipsec_client_port, s->port_us, s->spi_us);
302     remove_policy(sock, ipsec_listen_addr, remote_addr, ipsec_client_port, s->port_us, s->spi_us, IPSEC_POLICY_DIRECTION_OUT);
303
304     // UE 'client' to P-CSCF 'server' tunnel
305     remove_sa    (sock, remote_addr, ipsec_listen_addr, s->port_uc, ipsec_server_port, s->spi_ps);
306     remove_policy(sock, remote_addr, ipsec_listen_addr, s->port_uc, ipsec_server_port, s->spi_ps, IPSEC_POLICY_DIRECTION_IN);
307
308     // Release SPIs
309     release_spi(s->spi_uc);
310     release_spi(s->spi_us);
311
312
313     close_mnl_socket(sock);
314     return 0;
315 }
316
317 static void on_expire(struct pcontact *c, int type, void *param)
318 {
319     if(type != PCSCF_CONTACT_EXPIRE && type != PCSCF_CONTACT_DELETE) {
320         LM_ERR("Unexpected event type %d\n", type);
321         return;
322     }
323
324
325     if(c->security_temp == NULL) {
326         LM_ERR("No security parameters found in contact\n");
327         return;
328     }
329
330     //get security parameters
331     if(c->security_temp->type != SECURITY_IPSEC ) {
332         LM_ERR("Unsupported security type: %d\n", c->security_temp->type);
333         return;
334     }
335
336     destroy_ipsec_tunnel(c->received_host, c->security_temp->data.ipsec);
337 }
338
339 int add_supported_secagree_header(struct sip_msg* m)
340 {
341     // Add sec-agree header in the reply
342     const char* supported_sec_agree = "Supported: sec-agree\r\n";
343     const int supported_sec_agree_len = 22;
344
345     str* supported = NULL;
346     if((supported = pkg_malloc(sizeof(str))) == NULL) {
347         LM_ERR("Error allocating pkg memory for supported header\n");
348         return -1;
349     }
350
351     if((supported->s = pkg_malloc(supported_sec_agree_len)) == NULL) {
352         LM_ERR("Error allcationg pkg memory for supported header str\n");
353         return -1;
354     }
355     memcpy(supported->s, supported_sec_agree, supported_sec_agree_len);
356     supported->len = supported_sec_agree_len;
357
358     if(cscf_add_header(m, supported, HDR_SUPPORTED_T) != 1) {
359         LM_ERR("Error adding security header to reply!\n");
360         return -1;
361     }
362
363     return 0;
364 }
365
366 int add_security_server_header(struct sip_msg* m, ipsec_t* s)
367 {
368     // allocate memory for the header itself
369     str* sec_header = NULL;
370     if((sec_header = pkg_malloc(sizeof(str))) == NULL) {
371         LM_ERR("Error allocating pkg memory for security header\n");
372         return -1;
373     }
374     memset(sec_header, 0, sizeof(str));
375
376     // create a temporary buffer and set the value in it
377     char sec_hdr_buf[1024];
378     memset(sec_hdr_buf, 0, sizeof(sec_hdr_buf));
379     sec_header->len = snprintf(sec_hdr_buf, sizeof(sec_hdr_buf) - 1,
380                                 "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",
381                                 s->spi_pc, s->spi_ps, ipsec_client_port, ipsec_server_port,
382                                 s->r_alg.len, s->r_alg.s,
383                                 s->r_ealg.len, s->r_ealg.s
384                               );
385
386     // copy to the header and add
387     if((sec_header->s = pkg_malloc(sec_header->len)) == NULL) {
388         LM_ERR("Error allocating pkg memory for security header payload\n");
389         return -1;
390     }
391     memcpy(sec_header->s, sec_hdr_buf, sec_header->len);
392
393     // add security-server header in reply
394     if(cscf_add_header(m, sec_header, HDR_OTHER_T) != 1) {
395         LM_ERR("Error adding security header to reply!\n");
396         return -1;
397     }
398
399     return 0;
400 }
401
402 int ipsec_create(struct sip_msg* m, udomain_t* d)
403 {
404     pcontact_t* pcontact = NULL;
405     struct pcontact_info ci;
406     int ret = IPSEC_CMD_FAIL;   // FAIL by default
407
408     // Find the contact
409     if(fill_contact(&ci, m) != 0) {
410         LM_ERR("Error filling in contact data\n");
411         return ret;
412     }
413
414     ul.lock_udomain(d, &ci.via_host, ci.via_port, ci.via_prot);
415
416     if (ul.get_pcontact(d, &ci, &pcontact) != 0) {
417         LM_ERR("Contact doesn't exist\n");
418         goto cleanup;
419     }
420
421     // Get security parameters
422     if(pcontact->security_temp == NULL) {
423         LM_ERR("No security parameters found in contact\n");
424         goto cleanup;
425     }
426
427     if(pcontact->security_temp->type != SECURITY_IPSEC ) {
428         LM_ERR("Unsupported security type: %d\n", pcontact->security_temp->type);
429         goto cleanup;
430     }
431
432     ipsec_t* s = pcontact->security_temp->data.ipsec;
433
434     if(update_contact_ipsec_params(s, m) != 0) {
435         goto cleanup;
436     }
437
438     if(create_ipsec_tunnel(ci.received_host, s) != 0) {
439         goto cleanup;
440     }
441
442     // TODO: Save security_tmp to security!!!!!
443
444     if (ul.update_pcontact(d, &ci, pcontact) != 0) {
445         LM_ERR("Error updating contact\n");
446         goto cleanup;
447     }
448
449     // Destroy the tunnel, if the contact expires
450     if(ul.register_ulcb(pcontact, PCSCF_CONTACT_EXPIRE|PCSCF_CONTACT_DELETE, on_expire, NULL) != 1) {
451         LM_ERR("Error subscribing for contact\n");
452         goto cleanup;
453     }
454
455
456     if(add_supported_secagree_header(m) != 0) {
457         goto cleanup;
458     }
459
460     if(add_security_server_header(m, s) != 0) {
461         goto cleanup;
462     }
463
464     ret = IPSEC_CMD_SUCCESS;    // all good, set ret to SUCCESS, and exit
465
466 cleanup:
467     // Do not free str* sec_header! It will be freed in data_lump.c -> free_lump()
468     ul.unlock_udomain(d, &ci.via_host, ci.via_port, ci.via_prot);
469     pkg_free(ci.received_host.s);
470     return ret;
471 }
472
473
474 int ipsec_forward(struct sip_msg* m, udomain_t* d)
475 {
476     struct pcontact_info ci;
477     pcontact_t* pcontact = NULL;
478     int ret = IPSEC_CMD_FAIL; // FAIL by default
479
480     //
481     // Find the contact
482     //
483     if(fill_contact(&ci, m) != 0) {
484         LM_ERR("Error filling in contact data\n");
485         return ret;
486     }
487
488     ul.lock_udomain(d, &ci.via_host, ci.via_port, ci.via_prot);
489
490     if (ul.get_pcontact(d, &ci, &pcontact) != 0) {
491         LM_ERR("Contact doesn't exist\n");
492         goto cleanup;
493     }
494
495
496     if(pcontact->security_temp == NULL) {
497         LM_ERR("No security parameters found in contact\n");
498         goto cleanup;
499     }
500
501     //get security parameters
502     if(pcontact->security_temp->type != SECURITY_IPSEC ) {
503         LM_ERR("Unsupported security type: %d\n", pcontact->security_temp->type);
504         goto cleanup;
505     }
506
507     ipsec_t* s = pcontact->security_temp->data.ipsec;
508
509
510     // Update the destination
511     //
512     //       from sec-agree
513     //            v
514     // sip:host:port
515     //       ^
516     //    from URI
517     //int uri_len = 4 /* strlen("sip:") */ + ci.via_host.len + 5 /* max len of port number */ ;
518
519     if(m->dst_uri.s) {
520         pkg_free(m->dst_uri.s);
521         m->dst_uri.s = NULL;
522         m->dst_uri.len = 0;
523     }
524
525     char buf[1024];
526     int buf_len = snprintf(buf, sizeof(buf) - 1, "sip:%.*s:%d", ci.via_host.len, ci.via_host.s, s->port_us);
527
528     if((m->dst_uri.s = pkg_malloc(buf_len)) == NULL) {
529         LM_ERR("Error allocating memory for dst_uri\n");
530         goto cleanup;
531     }
532
533     memcpy(m->dst_uri.s, buf, buf_len);
534     m->dst_uri.len = buf_len;
535
536     // Set send socket
537     struct socket_info * client_sock = grep_sock_info(&ipsec_listen_addr, ipsec_client_port, PROTO_UDP);
538     if(!client_sock) {
539         LM_ERR("Error calling grep_sock_info() for ipsec client port in ipsec_forward\n");
540         return -1;
541     }
542     m->force_send_socket = client_sock;
543
544    // Set destination info
545     struct dest_info dst_info;
546     dst_info.send_sock = client_sock;
547 #ifdef USE_DNS_FAILOVER
548     if (!uri2dst(NULL, &dst_info, m, &m->dst_uri, PROTO_UDP)) {
549 #else
550     if (!uri2dst(&dst_info, m, &m->dst_uri, PROTO_UDP)) {
551 #endif
552         LM_ERR("Error converting dst_uri (%.*s) to struct dst_info\n", m->dst_uri.len, m->dst_uri.s);
553         goto cleanup;
554     }
555
556     // Update dst_info in message
557     if(m->first_line.type == SIP_REPLY) {
558         struct cell *t = tmb.t_gett();
559         if (!t) {
560             LM_ERR("Error getting transaction\n");
561             goto cleanup;
562         }
563         t->uas.response.dst = dst_info;
564     }
565
566     LM_DBG("Destination changed to %.*s\n", m->dst_uri.len, m->dst_uri.s);
567
568     ret = IPSEC_CMD_SUCCESS; // all good, return SUCCESS
569
570     if(add_supported_secagree_header(m) != 0) {
571         goto cleanup;
572     }
573
574     if(add_security_server_header(m, s) != 0) {
575         goto cleanup;
576     }
577
578     ret = IPSEC_CMD_SUCCESS;    // all good, set ret to SUCCESS, and exit
579
580 cleanup:
581     ul.unlock_udomain(d, &ci.via_host, ci.via_port, ci.via_prot);
582     pkg_free(ci.received_host.s);
583     return ret;
584 }
585
586
587 int ipsec_destroy(struct sip_msg* m, udomain_t* d)
588 {
589     struct pcontact_info ci;
590     pcontact_t* pcontact = NULL;
591     int ret = IPSEC_CMD_FAIL; // FAIL by default
592
593     //
594     // Find the contact
595     //
596     if(fill_contact(&ci, m) != 0) {
597         LM_ERR("Error filling in contact data\n");
598         return ret;
599     }
600
601     ul.lock_udomain(d, &ci.via_host, ci.via_port, ci.via_prot);
602
603     if (ul.get_pcontact(d, &ci, &pcontact) != 0) {
604         LM_ERR("Contact doesn't exist\n");
605         goto cleanup;
606     }
607
608
609     if(pcontact->security_temp == NULL) {
610         LM_ERR("No security parameters found in contact\n");
611         goto cleanup;
612     }
613
614     //get security parameters
615     if(pcontact->security_temp->type != SECURITY_IPSEC ) {
616         LM_ERR("Unsupported security type: %d\n", pcontact->security_temp->type);
617         goto cleanup;
618     }
619
620     destroy_ipsec_tunnel(ci.received_host, pcontact->security_temp->data.ipsec);
621
622     ret = IPSEC_CMD_SUCCESS;    // all good, set ret to SUCCESS, and exit
623
624 cleanup:
625     ul.unlock_udomain(d, &ci.via_host, ci.via_port, ci.via_prot);
626     pkg_free(ci.received_host.s);
627     return ret;
628 }
629
630 int ipsec_cleanall()
631 {
632     struct mnl_socket* nlsock = init_mnl_socket();
633     if(!nlsock) {
634         return -1;
635     }
636
637     if(clean_sa(nlsock) != 0) {
638         LM_WARN("Error cleaning IPSec Security associations during startup.\n");
639     }
640
641     if(clean_policy(nlsock) != 0) {
642         LM_WARN("Error cleaning IPSec Policies during startup.\n");
643     }
644
645     close_mnl_socket(nlsock);
646
647     return 0;
648 }