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. */
10 #include "unaligned.h"
19 #define SLIP_ESCEND 220
20 #define SLIP_ESCESC 221
24 struct buffer_if *buff; /* We unstuff received packets into here
25 and send them to the netlink code. */
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 uint32_t local_address;
33 /* Generic SLIP mangling code */
35 static void slip_stuff(struct slip *st, struct buffer_if *buf, int fd)
37 uint8_t txbuf[DEFAULT_BUFSIZE];
43 /* There's probably a much more efficient way of implementing this */
45 for (i=buf->start; i<(buf->start+buf->size); i++) {
49 txbuf[j++]=SLIP_ESCEND;
53 txbuf[j++]=SLIP_ESCESC;
59 if ((j+2)>DEFAULT_BUFSIZE) {
60 if (write(fd,txbuf,j)<0) {
61 fatal_perror("slip_stuff: write()");
67 if (write(fd,txbuf,j)<0) {
68 fatal_perror("slip_stuff: write()");
73 static void slip_unstuff(struct slip *st, uint8_t *buf, uint32_t l)
77 BUF_ASSERT_USED(st->buff);
80 enum { OUTPUT_END = 256, OUTPUT_NOTHING = 257 };
82 if (st->pending_esc) {
83 st->pending_esc=False;
92 if (!st->ignoring_packet) {
93 Message(M_WARNING, "userv_afterpoll: bad SLIP escape"
94 " character, dropping packet\n");
96 st->ignoring_packet=True;
97 outputchr=OUTPUT_NOTHING;
103 outputchr=OUTPUT_END;
106 st->pending_esc=True;
107 outputchr=OUTPUT_NOTHING;
115 if (st->ignoring_packet) {
116 if (outputchr == OUTPUT_END) {
117 st->ignoring_packet=False;
118 buffer_init(st->buff,calculate_max_start_pad());
121 if (outputchr == OUTPUT_END) {
122 if (st->buff->size>0) {
123 st->netlink_to_tunnel(&st->nl,st->buff);
124 BUF_ALLOC(st->buff,"userv_afterpoll");
126 buffer_init(st->buff,calculate_max_start_pad());
127 } else if (outputchr != OUTPUT_NOTHING) {
128 if (st->buff->size < st->buff->len) {
129 buf_append_uint8(st->buff,outputchr);
131 Message(M_WARNING, "userv_afterpoll: dropping overlong"
133 st->ignoring_packet=True;
140 static void slip_init(struct slip *st, struct cloc loc, dict_t *dict,
141 cstring_t name, netlink_deliver_fn *to_host)
143 st->netlink_to_tunnel=
144 netlink_init(&st->nl,st,loc,dict,
145 "netlink-userv-ipif",NULL,to_host);
146 st->buff=find_cl_if(dict,"buffer",CL_BUFFER,True,"name",loc);
147 st->local_address=string_item_to_ipaddr(
148 dict_find_item(dict,"local-address", True, name, loc),"netlink");
149 BUF_ALLOC(st->buff,"slip_init");
150 st->pending_esc=False;
151 st->ignoring_packet=False;
154 /* Connection to the kernel through userv-ipif */
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;
164 bool_t expecting_userv_exit;
167 static int userv_beforepoll(void *sst, struct pollfd *fds, int *nfds_io,
170 struct userv *st=sst;
175 fds[0].events=0; /* Might want to pick up POLLOUT sometime */
177 fds[1].events=POLLIN;
184 static void userv_afterpoll(void *sst, struct pollfd *fds, int nfds)
186 struct userv *st=sst;
187 uint8_t rxbuf[DEFAULT_BUFSIZE];
192 if (fds[1].revents&POLLERR) {
193 Message(M_ERR,"%s: userv_afterpoll: POLLERR!\n",st->slip.nl.name);
195 if (fds[1].revents&POLLIN) {
196 l=read(st->rxfd,rxbuf,DEFAULT_BUFSIZE);
199 fatal_perror("%s: userv_afterpoll: read(rxfd)",
202 fatal("%s: userv_afterpoll: read(rxfd)=0; userv gone away?",
204 } else slip_unstuff(&st->slip,rxbuf,l);
208 /* Send buf to the kernel. Free buf before returning. */
209 static void userv_deliver_to_kernel(void *sst, struct buffer_if *buf)
211 struct userv *st=sst;
213 slip_stuff(&st->slip,buf,st->txfd);
216 static void userv_userv_callback(void *sst, pid_t pid, int status)
218 struct userv *st=sst;
221 Message(M_WARNING,"userv_callback called unexpectedly with pid %d "
222 "(expected %d)\n",pid,st->pid);
225 if (!st->expecting_userv_exit) {
226 if (WIFEXITED(status)) {
227 fatal("%s: userv exited unexpectedly with status %d",
228 st->slip.nl.name,WEXITSTATUS(status));
229 } else if (WIFSIGNALED(status)) {
230 fatal("%s: userv exited unexpectedly: uncaught signal %d",
231 st->slip.nl.name,WTERMSIG(status));
233 fatal("%s: userv stopped unexpectedly",
237 Message(M_WARNING,"%s: userv subprocess died with status %d\n",
238 st->slip.nl.name,WEXITSTATUS(status));
242 struct userv_entry_rec {
247 /* XXX perhaps we should collect and log stderr? */
250 static void userv_entry(void *sst)
252 struct userv_entry_rec *st=sst;
257 /* XXX close all other fds */
259 /* XXX We really should strdup() all of argv[] but because we'll just
260 exit anyway if execvp() fails it doesn't seem worth bothering. */
261 execvp(st->path,(char *const*)st->argv);
262 perror("userv-entry: execvp()");
266 static void userv_invoke_userv(struct userv *st)
268 struct userv_entry_rec *er;
274 struct netlink_client *r;
275 struct ipset *allnets;
276 struct subnet_list *snets;
281 fatal("userv_invoke_userv: already running");
284 /* This is where we actually invoke userv - all the networks we'll
285 be using should already have been registered. */
287 addrs=safe_malloc(512,"userv_invoke_userv:addrs");
288 snprintf(addrs,512,"%s,%s,%d,slip",
289 ipaddr_to_string(st->slip.local_address),
290 ipaddr_to_string(st->slip.nl.secnet_address),st->slip.nl.mtu);
293 for (r=st->slip.nl.clients; r; r=r->next) {
294 if (r->link_quality > LINK_QUALITY_UNUSED) {
297 nan=ipset_union(allnets,r->networks);
302 snets=ipset_to_subnet_list(allnets);
304 nets=safe_malloc(20*snets->entries,"userv_invoke_userv:nets");
306 for (i=0; i<snets->entries; i++) {
307 s=subnet_to_string(snets->list[i]);
312 nets[strlen(nets)-1]=0;
313 subnet_list_free(snets);
315 Message(M_INFO,"%s: about to invoke: %s %s %s %s %s\n",st->slip.nl.name,
316 st->userv_path,st->service_user,st->service_name,addrs,nets);
318 st->slip.pending_esc=False;
321 if (pipe(c_stdin)!=0) {
322 fatal_perror("userv_invoke_userv: pipe(c_stdin)");
324 if (pipe(c_stdout)!=0) {
325 fatal_perror("userv_invoke_userv: pipe(c_stdout)");
328 st->rxfd=c_stdout[0];
330 er=safe_malloc(sizeof(*r),"userv_invoke_userv: er");
334 /* The arguments are:
338 local-addr,secnet-addr,mtu,protocol
340 er->argv=safe_malloc(sizeof(*er->argv)*6,"userv_invoke_userv:argv");
341 er->argv[0]=st->userv_path;
342 er->argv[1]=st->service_user;
343 er->argv[2]=st->service_name;
347 er->path=st->userv_path;
349 st->pid=makesubproc(userv_entry, userv_userv_callback,
350 er, st, st->slip.nl.name);
357 Message(M_INFO,"%s: userv-ipif pid is %d\n",st->slip.nl.name,st->pid);
358 /* Read a single character from the pipe to confirm userv-ipif is
359 running. If we get a SIGCHLD at this point then we'll get EINTR. */
360 if ((nread=read(st->rxfd,&confirm,1))!=1) {
362 Message(M_WARNING,"%s: read of confirmation byte was "
363 "interrupted\n",st->slip.nl.name);
366 fatal_perror("%s: error reading confirmation byte",
369 fatal("%s: unexpected EOF instead of confirmation byte"
370 " - userv ipif failed?", st->slip.nl.name);
374 if (confirm!=SLIP_END) {
375 fatal("%s: bad confirmation byte %d from userv-ipif",
376 st->slip.nl.name,confirm);
381 static void userv_kill_userv(struct userv *st)
384 kill(-st->pid,SIGTERM);
385 st->expecting_userv_exit=True;
389 static void userv_phase_hook(void *sst, uint32_t newphase)
391 struct userv *st=sst;
392 /* We must wait until signal processing has started before forking
394 if (newphase==PHASE_RUN) {
395 userv_invoke_userv(st);
396 /* Register for poll() */
397 register_for_poll(st, userv_beforepoll, userv_afterpoll, 2,
400 if (newphase==PHASE_SHUTDOWN) {
401 userv_kill_userv(st);
405 static list_t *userv_apply(closure_t *self, struct cloc loc, dict_t *context,
412 st=safe_malloc(sizeof(*st),"userv_apply");
414 /* First parameter must be a dict */
415 item=list_elem(args,0);
416 if (!item || item->type!=t_dict)
417 cfgfatal(loc,"userv-ipif","parameter must be a dictionary\n");
419 dict=item->data.dict;
421 slip_init(&st->slip,loc,dict,"netlink-userv-ipif",
422 userv_deliver_to_kernel);
424 st->userv_path=dict_read_string(dict,"userv-path",False,"userv-netlink",
426 st->service_user=dict_read_string(dict,"service-user",False,
427 "userv-netlink",loc);
428 st->service_name=dict_read_string(dict,"service-name",False,
429 "userv-netlink",loc);
430 if (!st->userv_path) st->userv_path="userv";
431 if (!st->service_user) st->service_user="root";
432 if (!st->service_name) st->service_name="ipif";
433 st->rxfd=-1; st->txfd=-1;
435 st->expecting_userv_exit=False;
436 add_hook(PHASE_RUN,userv_phase_hook,st);
437 add_hook(PHASE_SHUTDOWN,userv_phase_hook,st);
439 return new_closure(&st->slip.nl.cl);
442 void slip_module(dict_t *dict)
444 add_closure(dict,"userv-ipif",userv_apply);