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