chiark / gitweb /
debian/changelog: Start new version 0.3.2~~
[secnet.git] / slip.c
1 /* When dealing with SLIP (to a pty, or ipif) we have separate rx, tx
2    and client buffers.  When receiving we may read() any amount, not
3    just whole packets.  When transmitting we need to bytestuff anyway,
4    and may be part-way through receiving. */
5
6 #include "secnet.h"
7 #include "util.h"
8 #include "netlink.h"
9 #include "process.h"
10 #include "unaligned.h"
11 #include <stdio.h>
12 #include <string.h>
13 #include <unistd.h>
14 #include <errno.h>
15 #include <fcntl.h>
16
17 #define SLIP_END    192
18 #define SLIP_ESC    219
19 #define SLIP_ESCEND 220
20 #define SLIP_ESCESC 221
21
22 struct slip {
23     struct netlink nl;
24     struct buffer_if *buff; /* We unstuff received packets into here
25                                and send them to the netlink code. */
26     bool_t pending_esc;
27     bool_t ignoring_packet; /* If this packet was corrupt or overlong,
28                                we ignore everything up to the next END */
29     netlink_deliver_fn *netlink_to_tunnel;
30 };
31
32 /* Generic SLIP mangling code */
33
34 static void slip_stuff(struct slip *st, struct buffer_if *buf, int fd)
35 {
36     uint8_t txbuf[DEFAULT_BUFSIZE];
37     uint8_t *i;
38     int32_t j=0;
39
40     BUF_ASSERT_USED(buf);
41
42     /* There's probably a much more efficient way of implementing this */
43     txbuf[j++]=SLIP_END;
44     for (i=buf->start; i<(buf->start+buf->size); i++) {
45         switch (*i) {
46         case SLIP_END:
47             txbuf[j++]=SLIP_ESC;
48             txbuf[j++]=SLIP_ESCEND;
49             break;
50         case SLIP_ESC:
51             txbuf[j++]=SLIP_ESC;
52             txbuf[j++]=SLIP_ESCESC;
53             break;
54         default:
55             txbuf[j++]=*i;
56             break;
57         }
58         if ((j+2)>DEFAULT_BUFSIZE) {
59             if (write(fd,txbuf,j)<0) {
60                 fatal_perror("slip_stuff: write()");
61             }
62             j=0;
63         }
64     }
65     txbuf[j++]=SLIP_END;
66     if (write(fd,txbuf,j)<0) {
67         fatal_perror("slip_stuff: write()");
68     }
69     BUF_FREE(buf);
70 }
71
72 static void slip_unstuff(struct slip *st, uint8_t *buf, uint32_t l)
73 {
74     uint32_t i;
75
76     BUF_ASSERT_USED(st->buff);
77     for (i=0; i<l; i++) {
78         int outputchr;
79         enum { OUTPUT_END = 256, OUTPUT_NOTHING = 257 };
80
81         if (!st->buff->size)
82             buffer_init(st->buff,calculate_max_start_pad());
83
84         if (st->pending_esc) {
85             st->pending_esc=False;
86             switch(buf[i]) {
87             case SLIP_ESCEND:
88                 outputchr=SLIP_END;
89                 break;
90             case SLIP_ESCESC:
91                 outputchr=SLIP_ESC;
92                 break;
93             default:
94                 if (!st->ignoring_packet) {
95                     Message(M_WARNING, "userv_afterpoll: bad SLIP escape"
96                             " character, dropping packet\n");
97                 }
98                 st->ignoring_packet=True;
99                 outputchr=OUTPUT_NOTHING;
100                 break;
101             }
102         } else {
103             switch (buf[i]) {
104             case SLIP_END:
105                 outputchr=OUTPUT_END;
106                 break;
107             case SLIP_ESC:
108                 st->pending_esc=True;
109                 outputchr=OUTPUT_NOTHING;
110                 break;
111             default:
112                 outputchr=buf[i];
113                 break;
114             }
115         }
116
117         if (st->ignoring_packet) {
118             if (outputchr == OUTPUT_END) {
119                 st->ignoring_packet=False;
120                 st->buff->size=0;
121             }
122         } else {
123             if (outputchr == OUTPUT_END) {
124                 if (st->buff->size>0) {
125                     st->netlink_to_tunnel(&st->nl,st->buff);
126                     BUF_ALLOC(st->buff,"userv_afterpoll");
127                 }
128                 st->buff->size=0;
129             } else if (outputchr != OUTPUT_NOTHING) {
130                 if (st->buff->size < st->buff->len) {
131                     buf_append_uint8(st->buff,outputchr);
132                 } else {
133                     Message(M_WARNING, "userv_afterpoll: dropping overlong"
134                             " SLIP packet\n");
135                     st->ignoring_packet=True;
136                 }
137             }
138         }
139     }
140 }
141
142 static void slip_init(struct slip *st, struct cloc loc, dict_t *dict,
143                       cstring_t name, netlink_deliver_fn *to_host)
144 {
145     st->netlink_to_tunnel=
146         netlink_init(&st->nl,st,loc,dict,
147                      "netlink-userv-ipif",NULL,to_host);
148     st->buff=find_cl_if(dict,"buffer",CL_BUFFER,True,"name",loc);
149     BUF_ALLOC(st->buff,"slip_init");
150     st->pending_esc=False;
151     st->ignoring_packet=False;
152 }
153
154 /* Connection to the kernel through userv-ipif */
155
156 struct userv {
157     struct slip slip;
158     int txfd; /* We transmit to userv */
159     int rxfd; /* We receive from userv */
160     cstring_t userv_path;
161     cstring_t service_user;
162     cstring_t service_name;
163     pid_t pid;
164     bool_t expecting_userv_exit;
165 };
166
167 static int userv_beforepoll(void *sst, struct pollfd *fds, int *nfds_io,
168                             int *timeout_io)
169 {
170     struct userv *st=sst;
171
172     if (st->rxfd!=-1) {
173         *nfds_io=2;
174         fds[0].fd=st->txfd;
175         fds[0].events=0; /* Might want to pick up POLLOUT sometime */
176         fds[1].fd=st->rxfd;
177         fds[1].events=POLLIN;
178     } else {
179         *nfds_io=0;
180     }
181     return 0;
182 }
183
184 static void userv_afterpoll(void *sst, struct pollfd *fds, int nfds)
185 {
186     struct userv *st=sst;
187     uint8_t rxbuf[DEFAULT_BUFSIZE];
188     int l;
189
190     if (nfds==0) return;
191
192     if (fds[1].revents&POLLERR) {
193         Message(M_ERR,"%s: userv_afterpoll: POLLERR!\n",st->slip.nl.name);
194     }
195     if (fds[1].revents&POLLIN) {
196         l=read(st->rxfd,rxbuf,DEFAULT_BUFSIZE);
197         if (l<0) {
198             if (errno!=EINTR)
199                 fatal_perror("%s: userv_afterpoll: read(rxfd)",
200                              st->slip.nl.name);
201         } else if (l==0) {
202             fatal("%s: userv_afterpoll: read(rxfd)=0; userv gone away?",
203                   st->slip.nl.name);
204         } else slip_unstuff(&st->slip,rxbuf,l);
205     }
206 }
207
208 /* Send buf to the kernel. Free buf before returning. */
209 static void userv_deliver_to_kernel(void *sst, struct buffer_if *buf)
210 {
211     struct userv *st=sst;
212
213     if (buf->size > st->slip.nl.mtu) {
214         Message(M_ERR,"%s: packet of size %"PRIu32" exceeds mtu %"PRIu32":"
215                 " cannot be injected into kernel, dropped\n",
216                 st->slip.nl.name, buf->size, st->slip.nl.mtu);
217         BUF_FREE(buf);
218         return;
219     }
220
221     slip_stuff(&st->slip,buf,st->txfd);
222 }
223
224 static void userv_userv_callback(void *sst, pid_t pid, int status)
225 {
226     struct userv *st=sst;
227
228     if (pid!=st->pid) {
229         Message(M_WARNING,"userv_callback called unexpectedly with pid %d "
230                 "(expected %d)\n",pid,st->pid);
231         return;
232     }
233     if (!st->expecting_userv_exit) {
234         if (WIFEXITED(status)) {
235             fatal("%s: userv exited unexpectedly with status %d",
236                   st->slip.nl.name,WEXITSTATUS(status));
237         } else if (WIFSIGNALED(status)) {
238             fatal("%s: userv exited unexpectedly: uncaught signal %d",
239                   st->slip.nl.name,WTERMSIG(status));
240         } else {
241             fatal("%s: userv stopped unexpectedly",
242                   st->slip.nl.name);
243         }
244     }
245     Message(M_WARNING,"%s: userv subprocess died with status %d\n",
246             st->slip.nl.name,WEXITSTATUS(status));
247     st->pid=0;
248 }
249
250 struct userv_entry_rec {
251     cstring_t path;
252     const char **argv;
253     int in;
254     int out;
255     /* XXX perhaps we should collect and log stderr? */
256 };
257
258 static void userv_entry(void *sst)
259 {
260     struct userv_entry_rec *st=sst;
261
262     dup2(st->in,0);
263     dup2(st->out,1);
264
265     /* XXX close all other fds */
266     setsid();
267     /* XXX We really should strdup() all of argv[] but because we'll just
268        exit anyway if execvp() fails it doesn't seem worth bothering. */
269     execvp(st->path,(char *const*)st->argv);
270     perror("userv-entry: execvp()");
271     exit(1);
272 }
273
274 static void userv_invoke_userv(struct userv *st)
275 {
276     struct userv_entry_rec *er;
277     int c_stdin[2];
278     int c_stdout[2];
279     string_t addrs;
280     string_t nets;
281     string_t s;
282     struct netlink_client *r;
283     struct ipset *allnets;
284     struct subnet_list *snets;
285     int i, nread;
286     uint8_t confirm;
287
288     if (st->pid) {
289         fatal("userv_invoke_userv: already running");
290     }
291
292     /* This is where we actually invoke userv - all the networks we'll
293        be using should already have been registered. */
294
295     addrs=safe_malloc(512,"userv_invoke_userv:addrs");
296     snprintf(addrs,512,"%s,%s,%d,slip",
297              ipaddr_to_string(st->slip.nl.local_address),
298              ipaddr_to_string(st->slip.nl.secnet_address),st->slip.nl.mtu);
299
300     allnets=ipset_new();
301     for (r=st->slip.nl.clients; r; r=r->next) {
302         if (r->link_quality > LINK_QUALITY_UNUSED) {
303             struct ipset *nan;
304             r->kup=True;
305             nan=ipset_union(allnets,r->networks);
306             ipset_free(allnets);
307             allnets=nan;
308         }
309     }
310     snets=ipset_to_subnet_list(allnets);
311     ipset_free(allnets);
312     nets=safe_malloc(20*snets->entries,"userv_invoke_userv:nets");
313     *nets=0;
314     for (i=0; i<snets->entries; i++) {
315         s=subnet_to_string(snets->list[i]);
316         strcat(nets,s);
317         strcat(nets,",");
318         free(s);
319     }
320     nets[strlen(nets)-1]=0;
321     subnet_list_free(snets);
322
323     Message(M_INFO,"%s: about to invoke: %s %s %s %s %s\n",st->slip.nl.name,
324             st->userv_path,st->service_user,st->service_name,addrs,nets);
325
326     st->slip.pending_esc=False;
327
328     /* Invoke userv */
329     if (pipe(c_stdin)!=0) {
330         fatal_perror("userv_invoke_userv: pipe(c_stdin)");
331     }
332     if (pipe(c_stdout)!=0) {
333         fatal_perror("userv_invoke_userv: pipe(c_stdout)");
334     }
335     st->txfd=c_stdin[1];
336     st->rxfd=c_stdout[0];
337
338     er=safe_malloc(sizeof(*r),"userv_invoke_userv: er");
339
340     er->in=c_stdin[0];
341     er->out=c_stdout[1];
342     /* The arguments are:
343        userv
344        service-user
345        service-name
346        local-addr,secnet-addr,mtu,protocol
347        route1,route2,... */
348     er->argv=safe_malloc(sizeof(*er->argv)*6,"userv_invoke_userv:argv");
349     er->argv[0]=st->userv_path;
350     er->argv[1]=st->service_user;
351     er->argv[2]=st->service_name;
352     er->argv[3]=addrs;
353     er->argv[4]=nets;
354     er->argv[5]=NULL;
355     er->path=st->userv_path;
356
357     st->pid=makesubproc(userv_entry, userv_userv_callback,
358                         er, st, st->slip.nl.name);
359     close(er->in);
360     close(er->out);
361     free(er->argv);
362     free(er);
363     free(addrs);
364     free(nets);
365     Message(M_INFO,"%s: userv-ipif pid is %d\n",st->slip.nl.name,st->pid);
366     /* Read a single character from the pipe to confirm userv-ipif is
367        running. If we get a SIGCHLD at this point then we'll get EINTR. */
368     if ((nread=read(st->rxfd,&confirm,1))!=1) {
369         if (errno==EINTR) {
370             Message(M_WARNING,"%s: read of confirmation byte was "
371                     "interrupted\n",st->slip.nl.name);
372         } else {
373             if (nread<0) {
374                 fatal_perror("%s: error reading confirmation byte",
375                              st->slip.nl.name);
376             } else {
377                 fatal("%s: unexpected EOF instead of confirmation byte"
378                       " - userv ipif failed?", st->slip.nl.name);
379             }
380         }
381     } else {
382         if (confirm!=SLIP_END) {
383             fatal("%s: bad confirmation byte %d from userv-ipif",
384                   st->slip.nl.name,confirm);
385         }
386     }
387 }
388
389 static void userv_kill_userv(struct userv *st)
390 {
391     if (st->pid) {
392         kill(-st->pid,SIGTERM);
393         st->expecting_userv_exit=True;
394     }
395 }
396
397 static void userv_phase_hook(void *sst, uint32_t newphase)
398 {
399     struct userv *st=sst;
400     /* We must wait until signal processing has started before forking
401        userv */
402     if (newphase==PHASE_RUN) {
403         userv_invoke_userv(st);
404         /* Register for poll() */
405         register_for_poll(st, userv_beforepoll, userv_afterpoll, 2,
406                           st->slip.nl.name);
407     }
408     if (newphase==PHASE_SHUTDOWN) {
409         userv_kill_userv(st);
410     }
411 }
412
413 static list_t *userv_apply(closure_t *self, struct cloc loc, dict_t *context,
414                            list_t *args)
415 {
416     struct userv *st;
417     item_t *item;
418     dict_t *dict;
419
420     st=safe_malloc(sizeof(*st),"userv_apply");
421
422     /* First parameter must be a dict */
423     item=list_elem(args,0);
424     if (!item || item->type!=t_dict)
425         cfgfatal(loc,"userv-ipif","parameter must be a dictionary\n");
426     
427     dict=item->data.dict;
428
429     slip_init(&st->slip,loc,dict,"netlink-userv-ipif",
430               userv_deliver_to_kernel);
431
432     st->userv_path=dict_read_string(dict,"userv-path",False,"userv-netlink",
433                                     loc);
434     st->service_user=dict_read_string(dict,"service-user",False,
435                                       "userv-netlink",loc);
436     st->service_name=dict_read_string(dict,"service-name",False,
437                                       "userv-netlink",loc);
438     if (!st->userv_path) st->userv_path="userv";
439     if (!st->service_user) st->service_user="root";
440     if (!st->service_name) st->service_name="ipif";
441     st->rxfd=-1; st->txfd=-1;
442     st->pid=0;
443     st->expecting_userv_exit=False;
444     add_hook(PHASE_RUN,userv_phase_hook,st);
445     add_hook(PHASE_SHUTDOWN,userv_phase_hook,st);
446
447     return new_closure(&st->slip.nl.cl);
448 }
449
450 void slip_module(dict_t *dict)
451 {
452     add_closure(dict,"userv-ipif",userv_apply);
453 }