net/netfilter/ipvs/ip_vs_ftp.c

   1 /*
   2  * ip_vs_ftp.c: IPVS ftp application module
   3  *
   4  * Authors:     Wensong Zhang <wensong@linuxvirtualserver.org>
   5  *
   6  * Changes:
   7  *
   8  *
   9  *      This program is free software; you can redistribute it and/or
  10  *      modify it under the terms of the GNU General Public License
  11  *      as published by the Free Software Foundation; either version
  12  *      2 of the License, or (at your option) any later version.
  13  *
  14  * Most code here is taken from ip_masq_ftp.c in kernel 2.2. The difference
  15  * is that ip_vs_ftp module handles the reverse direction to ip_masq_ftp.
  16  *
  17  *              IP_MASQ_FTP ftp masquerading module
  18  *
  19  * Version:     @(#)ip_masq_ftp.c 0.04   02/05/96
  20  *
  21  * Author:      Wouter Gadeyne
  22  *
  23  */
  24
  25 #define KMSG_COMPONENT "IPVS"
  26 #define pr_fmt(fmt) KMSG_COMPONENT ": " fmt
  27
  28 #include <linux/module.h>
  29 #include <linux/moduleparam.h>
  30 #include <linux/kernel.h>
  31 #include <linux/skbuff.h>
  32 #include <linux/in.h>
  33 #include <linux/ip.h>
  34 #include <linux/netfilter.h>
  35 #include <linux/gfp.h>
  36 #include <net/protocol.h>
  37 #include <net/tcp.h>
  38 #include <asm/unaligned.h>
  39
  40 #include <net/ip_vs.h>
  41
  42
  43 #define SERVER_STRING "227 Entering Passive Mode ("
  44 #define CLIENT_STRING "PORT "
  45
  46
  47 /*
  48  * List of ports (up to IP_VS_APP_MAX_PORTS) to be handled by helper
  49  * First port is set to the default port.
  50  */
  51 static unsigned short ports[IP_VS_APP_MAX_PORTS] = {21, 0};
  52 module_param_array(ports, ushort, NULL, 0);
  53 MODULE_PARM_DESC(ports, "Ports to monitor for FTP control commands");
  54
  55
  56 /*      Dummy variable */
  57 static int ip_vs_ftp_pasv;
  58
  59
  60 static int
  61 ip_vs_ftp_init_conn(struct ip_vs_app *app, struct ip_vs_conn *cp)
  62 {
  63         return 0;
  64 }
  65
  66
  67 static int
  68 ip_vs_ftp_done_conn(struct ip_vs_app *app, struct ip_vs_conn *cp)
  69 {
  70         return 0;
  71 }
  72
  73
  74 /*
  75  * Get <addr,port> from the string "xxx.xxx.xxx.xxx,ppp,ppp", started
  76  * with the "pattern" and terminated with the "term" character.
  77  * <addr,port> is in network order.
  78  */
  79 static int ip_vs_ftp_get_addrport(char *data, char *data_limit,
  80                                   const char *pattern, size_t plen, char term,
  81                                   __be32 *addr, __be16 *port,
  82                                   char **start, char **end)
  83 {
  84         unsigned char p[6];
  85         int i = 0;
  86
  87         if (data_limit - data < plen) {
  88                 /* check if there is partial match */
  89                 if (strnicmp(data, pattern, data_limit - data) == 0)
  90                         return -1;
  91                 else
  92                         return 0;
  93         }
  94
  95         if (strnicmp(data, pattern, plen) != 0) {
  96                 return 0;
  97         }
  98         *start = data + plen;
  99
 100         for (data = *start; *data != term; data++) {
 101                 if (data == data_limit)
 102                         return -1;
 103         }
 104         *end = data;
 105
 106         memset(p, 0, sizeof(p));
 107         for (data = *start; data != *end; data++) {
 108                 if (*data >= '0' && *data <= '9') {
 109                         p[i] = p[i]*10 + *data - '0';
 110                 } else if (*data == ',' && i < 5) {
 111                         i++;
 112                 } else {
 113                         /* unexpected character */
 114                         return -1;
 115                 }
 116         }
 117
 118         if (i != 5)
 119                 return -1;
 120
 121         *addr = get_unaligned((__be32 *)p);
 122         *port = get_unaligned((__be16 *)(p + 4));
 123         return 1;
 124 }
 125
 126
 127 /*
 128  * Look at outgoing ftp packets to catch the response to a PASV command
 129  * from the server (inside-to-outside).
 130  * When we see one, we build a connection entry with the client address,
 131  * client port 0 (unknown at the moment), the server address and the
 132  * server port.  Mark the current connection entry as a control channel
 133  * of the new entry. All this work is just to make the data connection
 134  * can be scheduled to the right server later.
 135  *
 136  * The outgoing packet should be something like
 137  *   "227 Entering Passive Mode (xxx,xxx,xxx,xxx,ppp,ppp)".
 138  * xxx,xxx,xxx,xxx is the server address, ppp,ppp is the server port number.
 139  */
 140 static int ip_vs_ftp_out(struct ip_vs_app *app, struct ip_vs_conn *cp,
 141                          struct sk_buff *skb, int *diff)
 142 {
 143         struct iphdr *iph;
 144         struct tcphdr *th;
 145         char *data, *data_limit;
 146         char *start, *end;
 147         union nf_inet_addr from;
 148         __be16 port;
 149         struct ip_vs_conn *n_cp;
 150         char buf[24];           /* xxx.xxx.xxx.xxx,ppp,ppp\000 */
 151         unsigned buf_len;
 152         int ret;
 153
 154 #ifdef CONFIG_IP_VS_IPV6
 155         /* This application helper doesn't work with IPv6 yet,
 156          * so turn this into a no-op for IPv6 packets
 157          */
 158         if (cp->af == AF_INET6)
 159                 return 1;
 160 #endif
 161
 162         *diff = 0;
 163
 164         /* Only useful for established sessions */
 165         if (cp->state != IP_VS_TCP_S_ESTABLISHED)
 166                 return 1;
 167
 168         /* Linear packets are much easier to deal with. */
 169         if (!skb_make_writable(skb, skb->len))
 170                 return 0;
 171
 172         if (cp->app_data == &ip_vs_ftp_pasv) {
 173                 iph = ip_hdr(skb);
 174                 th = (struct tcphdr *)&(((char *)iph)[iph->ihl*4]);
 175                 data = (char *)th + (th->doff << 2);
 176                 data_limit = skb_tail_pointer(skb);
 177
 178                 if (ip_vs_ftp_get_addrport(data, data_limit,
 179                                            SERVER_STRING,
 180                                            sizeof(SERVER_STRING)-1, ')',
 181                                            &from.ip, &port,
 182                                            &start, &end) != 1)
 183                         return 1;
 184
 185                 IP_VS_DBG(7, "PASV response (%pI4:%d) -> %pI4:%d detected\n",
 186                           &from.ip, ntohs(port), &cp->caddr.ip, 0);
 187
 188                 /*
 189                  * Now update or create an connection entry for it
 190                  */
 191                 n_cp = ip_vs_conn_out_get(AF_INET, iph->protocol, &from, port,
 192                                           &cp->caddr, 0);
 193                 if (!n_cp) {
 194                         n_cp = ip_vs_conn_new(AF_INET, IPPROTO_TCP,
 195                                               &cp->caddr, 0,
 196                                               &cp->vaddr, port,
 197                                               &from, port,
 198                                               IP_VS_CONN_F_NO_CPORT,
 199                                               cp->dest);
 200                         if (!n_cp)
 201                                 return 0;
 202
 203                         /* add its controller */
 204                         ip_vs_control_add(n_cp, cp);
 205                 }
 206
 207                 /*
 208                  * Replace the old passive address with the new one
 209                  */
 210                 from.ip = n_cp->vaddr.ip;
 211                 port = n_cp->vport;
 212                 sprintf(buf, "%u,%u,%u,%u,%u,%u", NIPQUAD(from.ip),
 213                         (ntohs(port)>>8)&255, ntohs(port)&255);
 214                 buf_len = strlen(buf);
 215
 216                 /*
 217                  * Calculate required delta-offset to keep TCP happy
 218                  */
 219                 *diff = buf_len - (end-start);
 220
 221                 if (*diff == 0) {
 222                         /* simply replace it with new passive address */
 223                         memcpy(start, buf, buf_len);
 224                         ret = 1;
 225                 } else {
 226                         ret = !ip_vs_skb_replace(skb, GFP_ATOMIC, start,
 227                                           end-start, buf, buf_len);
 228                 }
 229
 230                 cp->app_data = NULL;
 231                 ip_vs_tcp_conn_listen(n_cp);
 232                 ip_vs_conn_put(n_cp);
 233                 return ret;
 234         }
 235         return 1;
 236 }
 237
 238
 239 /*
 240  * Look at incoming ftp packets to catch the PASV/PORT command
 241  * (outside-to-inside).
 242  *
 243  * The incoming packet having the PORT command should be something like
 244  *      "PORT xxx,xxx,xxx,xxx,ppp,ppp\n".
 245  * xxx,xxx,xxx,xxx is the client address, ppp,ppp is the client port number.
 246  * In this case, we create a connection entry using the client address and
 247  * port, so that the active ftp data connection from the server can reach
 248  * the client.
 249  */
 250 static int ip_vs_ftp_in(struct ip_vs_app *app, struct ip_vs_conn *cp,
 251                         struct sk_buff *skb, int *diff)
 252 {
 253         struct iphdr *iph;
 254         struct tcphdr *th;
 255         char *data, *data_start, *data_limit;
 256         char *start, *end;
 257         union nf_inet_addr to;
 258         __be16 port;
 259         struct ip_vs_conn *n_cp;
 260
 261 #ifdef CONFIG_IP_VS_IPV6
 262         /* This application helper doesn't work with IPv6 yet,
 263          * so turn this into a no-op for IPv6 packets
 264          */
 265         if (cp->af == AF_INET6)
 266                 return 1;
 267 #endif
 268
 269         /* no diff required for incoming packets */
 270         *diff = 0;
 271
 272         /* Only useful for established sessions */
 273         if (cp->state != IP_VS_TCP_S_ESTABLISHED)
 274                 return 1;
 275
 276         /* Linear packets are much easier to deal with. */
 277         if (!skb_make_writable(skb, skb->len))
 278                 return 0;
 279
 280         /*
 281          * Detecting whether it is passive
 282          */
 283         iph = ip_hdr(skb);
 284         th = (struct tcphdr *)&(((char *)iph)[iph->ihl*4]);
 285
 286         /* Since there may be OPTIONS in the TCP packet and the HLEN is
 287            the length of the header in 32-bit multiples, it is accurate
 288            to calculate data address by th+HLEN*4 */
 289         data = data_start = (char *)th + (th->doff << 2);
 290         data_limit = skb_tail_pointer(skb);
 291
 292         while (data <= data_limit - 6) {
 293                 if (strnicmp(data, "PASV\r\n", 6) == 0) {
 294                         /* Passive mode on */
 295                         IP_VS_DBG(7, "got PASV at %td of %td\n",
 296                                   data - data_start,
 297                                   data_limit - data_start);
 298                         cp->app_data = &ip_vs_ftp_pasv;
 299                         return 1;
 300                 }
 301                 data++;
 302         }
 303
 304         /*
 305          * To support virtual FTP server, the scenerio is as follows:
 306          *       FTP client ----> Load Balancer ----> FTP server
 307          * First detect the port number in the application data,
 308          * then create a new connection entry for the coming data
 309          * connection.
 310          */
 311         if (ip_vs_ftp_get_addrport(data_start, data_limit,
 312                                    CLIENT_STRING, sizeof(CLIENT_STRING)-1,
 313                                    '\r', &to.ip, &port,
 314                                    &start, &end) != 1)
 315                 return 1;
 316
 317         IP_VS_DBG(7, "PORT %pI4:%d detected\n", &to.ip, ntohs(port));
 318
 319         /* Passive mode off */
 320         cp->app_data = NULL;
 321
 322         /*
 323          * Now update or create a connection entry for it
 324          */
 325         IP_VS_DBG(7, "protocol %s %pI4:%d %pI4:%d\n",
 326                   ip_vs_proto_name(iph->protocol),
 327                   &to.ip, ntohs(port), &cp->vaddr.ip, 0);
 328
 329         n_cp = ip_vs_conn_in_get(AF_INET, iph->protocol,
 330                                  &to, port,
 331                                  &cp->vaddr, htons(ntohs(cp->vport)-1));
 332         if (!n_cp) {
 333                 n_cp = ip_vs_conn_new(AF_INET, IPPROTO_TCP,
 334                                       &to, port,
 335                                       &cp->vaddr, htons(ntohs(cp->vport)-1),
 336                                       &cp->daddr, htons(ntohs(cp->dport)-1),
 337                                       0,
 338                                       cp->dest);
 339                 if (!n_cp)
 340                         return 0;
 341
 342                 /* add its controller */
 343                 ip_vs_control_add(n_cp, cp);
 344         }
 345
 346         /*
 347          *      Move tunnel to listen state
 348          */
 349         ip_vs_tcp_conn_listen(n_cp);
 350         ip_vs_conn_put(n_cp);
 351
 352         return 1;
 353 }
 354
 355
 356 static struct ip_vs_app ip_vs_ftp = {
 357         .name =         "ftp",
 358         .type =         IP_VS_APP_TYPE_FTP,
 359         .protocol =     IPPROTO_TCP,
 360         .module =       THIS_MODULE,
 361         .incs_list =    LIST_HEAD_INIT(ip_vs_ftp.incs_list),
 362         .init_conn =    ip_vs_ftp_init_conn,
 363         .done_conn =    ip_vs_ftp_done_conn,
 364         .bind_conn =    NULL,
 365         .unbind_conn =  NULL,
 366         .pkt_out =      ip_vs_ftp_out,
 367         .pkt_in =       ip_vs_ftp_in,
 368 };
 369
 370
 371 /*
 372  *      ip_vs_ftp initialization
 373  */
 374 static int __init ip_vs_ftp_init(void)
 375 {
 376         int i, ret;
 377         struct ip_vs_app *app = &ip_vs_ftp;
 378
 379         ret = register_ip_vs_app(app);
 380         if (ret)
 381                 return ret;
 382
 383         for (i=0; i<IP_VS_APP_MAX_PORTS; i++) {
 384                 if (!ports[i])
 385                         continue;
 386                 ret = register_ip_vs_app_inc(app, app->protocol, ports[i]);
 387                 if (ret)
 388                         break;
 389                 pr_info("%s: loaded support on port[%d] = %d\n",
 390                         app->name, i, ports[i]);
 391         }
 392
 393         if (ret)
 394                 unregister_ip_vs_app(app);
 395
 396         return ret;
 397 }
 398
 399
 400 /*
 401  *      ip_vs_ftp finish.
 402  */
 403 static void __exit ip_vs_ftp_exit(void)
 404 {
 405         unregister_ip_vs_app(&ip_vs_ftp);
 406 }
 407
 408
 409 module_init(ip_vs_ftp_init);
 410 module_exit(ip_vs_ftp_exit);
 411 MODULE_LICENSE("GPL");