3 * Socket source and target definitions
5 * (c) 1999 Straylight/Edgeware
8 /*----- Licensing notice --------------------------------------------------*
10 * This file is part of the `fwd' port forwarder.
12 * `fwd' is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
17 * `fwd' is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with `fwd'; if not, write to the Free Software Foundation,
24 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
29 /*----- Data structures ---------------------------------------------------*/
31 /* --- Socket source options --- */
33 typedef struct ssource_opts
{
40 static ssource_opts ssgo
= { 256, 0, 5, 1 };
42 #define SOCKOPT_LIMIT 0u
43 #define SOCKOPT_NOLIMIT 1u
44 #define SOCKOPT_ONESHOT 2u
46 /* --- Socket source --- */
48 typedef struct ssource
{
57 /* --- Socket target --- */
59 typedef struct starget
{
65 /* --- Socket target endpoint --- */
67 typedef struct stept
{
73 /* --- Socket source endpoint --- */
75 typedef struct ssept
{
80 /*----- Protocol table ----------------------------------------------------*/
82 static addr_ops
*addrs
[] = { &inet_ops
, &un_ops
, 0 };
84 /*----- Other persistent variables ----------------------------------------*/
86 static addr_opts gsao
= { 0 }, gtao
= { 0 };
88 /*----- Parsing address types ---------------------------------------------*/
90 /* --- @getaddrtype@ --- *
92 * Arguments: @scanner *sc@ = pointer to scanner (for error reporting)
93 * @const char *p@ = pointer to protocol name
94 * @int abbrev@ = nonzero to allow abbreviations
96 * Returns: Pointer to address operations table or null.
98 * Use: Looks up a protocol name. Handy when parsing addresses and
99 * other bits of configuration. Returns null if no matching
103 static addr_ops
*getaddrtype(scanner
*sc
, const char *p
, int abbrev
)
106 addr_ops
*chosen
= 0;
107 size_t sz
= strlen(p
);
109 for (ops
= addrs
; *ops
; ops
++) {
110 if (strncmp((*ops
)->name
, p
, sz
) == 0) {
111 if ((*ops
)->name
[sz
] == 0)
113 else if (chosen
&& abbrev
)
114 error(sc
, "ambiguous socket address type `%s'", p
);
123 /* --- @getaddr@ --- *
125 * Arguments: @scanner *sc@ = pointer to scanner to read from
126 * @unsigned type@ = address type (@ADDR_SRC@ or @ADDR_DEST@)
128 * Returns: Pointer to an address successfully read.
130 * Use: Reads an optionally qualified address.
133 static addr
*getaddr(scanner
*sc
, unsigned type
)
142 if (sc
->t
== CTOK_WORD
)
143 ops
= getaddrtype(sc
, sc
->d
.buf
, abbrev
);
147 error(sc
, "unknown socket address type `%s'", sc
->d
.buf
);
153 return (ops
->read(sc
, type
));
156 /*----- Socket endpoints --------------------------------------------------*/
158 /* --- @wclose@ --- */
160 static void sept_wclose(endpt
*e
)
162 shutdown(e
->out
->fd
, 1);
165 /* --- @close@ (source) --- */
167 static void ss_listen(ssource */
*ss*/
);
169 static void ssept_close(endpt
*e
)
171 ssept
*ee
= (ssept
*)e
;
173 if (ee
->s
->o
.opt
== SOCKOPT_LIMIT
) {
175 if (ee
->s
->o
.conn
== 1)
179 REFFD_DEC(ee
->e
.out
);
184 /* --- @close@ (target) --- */
186 static void stept_close(endpt
*e
)
188 stept
*ee
= (stept
*)e
;
190 if (ee
->e
.f
& EPF_PENDING
)
194 REFFD_DEC(ee
->e
.out
);
202 /* --- @starget_connected@ --- *
204 * Arguments: @int fd@ = file descriptor now ready for use
205 * @void *p@ = pointer to an endpoint structure
209 * Use: Handles successful connection of the target endpoint.
212 void starget_connected(int fd
, void *p
)
217 fw_log(-1, "[%s] connection failed: %s", e
->desc
, strerror(errno
));
220 reffd
*r
= reffd_init(fd
);
223 fdflags(fd
, O_NONBLOCK
, O_NONBLOCK
, FD_CLOEXEC
, FD_CLOEXEC
);
224 setsockopt(fd
, SOL_SOCKET
, SO_OOBINLINE
, &opt
, sizeof(opt
));
225 e
->e
.in
= e
->e
.out
= r
;
226 e
->e
.f
&= ~EPF_PENDING
;
228 endpt_join(&e
->e
, e
->e
.other
, 0);
232 /* --- Socket endpoint definition --- */
234 static endpt_ops ssept_ops
= {
235 0, 0, sept_wclose
, ssept_close
238 static endpt_ops stept_ops
= {
239 0, 0, sept_wclose
, stept_close
242 /*----- Source definition -------------------------------------------------*/
244 /* --- @option@ --- */
246 static int ssource_option(source
*s
, scanner
*sc
)
248 ssource
*ss
= (ssource
*)s
;
249 ssource_opts
*sso
= ss ?
&ss
->o
: &ssgo
;
251 CONF_BEGIN(sc
, "socket", "socket source")
253 /* --- Make sure the next token is a word --- */
255 if (sc
->t
!= CTOK_WORD
)
256 error(sc
, "parse error, option keyword expected");
258 /* --- Handle options at this level --- */
260 if (strcmp(sc
->d
.buf
, "conn") == 0) {
264 if (sc
->t
!= CTOK_WORD
)
265 error(sc
, "parse error, expected `unlimited', `one-shot' or number");
266 if (isdigit((unsigned char)sc
->d
.buf
[0])) {
267 sso
->conn
= atoi(sc
->d
.buf
);
269 error(sc
, "argument of `conn' must be positive");
270 sso
->opt
= SOCKOPT_LIMIT
;
274 sso
->opt
= 1 + (1 & conf_enum(sc
,
275 "unlimited,one-shot,infinite",
276 ENUM_ABBREV
, "`conn' option"));
281 if (strcmp(sc
->d
.buf
, "listen") == 0) {
285 if (sc
->t
!= CTOK_WORD
|| !isdigit((unsigned char)sc
->d
.buf
[0]))
286 error(sc
, "parse error, expected number");
287 sso
->listen
= atoi(sc
->d
.buf
);
288 if (sso
->listen
== 0)
289 error(sc
, "argument of `listen' must be positive");
294 if (strcmp(sc
->d
.buf
, "accept") == 0 ||
295 strcmp(sc
->d
.buf
, "accept-count") == 0) {
299 if (sc
->t
!= CTOK_WORD
)
300 error(sc
, "parse error, expected `unlimited' or number");
301 else if (isdigit((unsigned char)sc
->d
.buf
[0])) {
302 sso
->naccept
= atoi(sc
->d
.buf
);
303 if (sso
->naccept
== 0)
304 error(sc
, "argument of `accept-count' must be positive");
307 conf_enum(sc
, "unlimited,infinite",
308 ENUM_ABBREV
, "`accept-count' option");
314 if (strcmp(sc
->d
.buf
, "logging") == 0 ||
315 strcmp(sc
->d
.buf
, "log") == 0) {
316 addr_opts
*ao
= ss ? ss
->ao
: &gsao
;
320 if (conf_enum(sc
, "no,yes", ENUM_ABBREV
, "logging status"))
321 ao
->f
&= ~ADDRF_NOLOG
;
323 ao
->f
|= ADDRF_NOLOG
;
327 /* --- Pass the option around the various address types --- */
330 if (ss
->a
->ops
->option
&& ss
->a
->ops
->option(sc
, ss
->ao
, ADDR_SRC
))
334 for (a
= addrs
; *a
; a
++) {
335 if ((*a
)->option
&& (*a
)->option(sc
, 0, ADDR_GLOBAL
))
340 /* --- Nobody understood the option --- */
347 static source
*ssource_read(scanner
*sc
)
351 (void)(conf_prefix(sc
, "socket") || conf_prefix(sc
, "sk"));
352 ss
= CREATE(ssource
);
353 ss
->s
.ops
= &ssource_ops
;
356 ss
->a
= getaddr(sc
, ADDR_SRC
);
357 if (ss
->a
->ops
->initsrcopts
)
358 ss
->ao
= ss
->a
->ops
->initsrcopts();
360 ss
->ao
= CREATE(addr_opts
);
366 /* --- @ss_accept@ --- *
368 * Arguments: @int fd@ = file descriptor to accept from
369 * @unsigned mode@ = what's ready with the descriptor
370 * @void *p@ = pointer to the source definition
374 * Use: Accepts an incoming connection and attaches it to a target
378 static void ssource_destroy(source */
*s*/
);
380 static void ss_accept(int fd
, unsigned mode
, void *p
)
391 /* --- Make the file descriptor --- */
395 if ((r
= ss
->a
->ops
->accept(fd
, ss
->ao
, ss
->s
.desc
)) == 0)
397 setsockopt(r
->fd
, SOL_SOCKET
, SO_OOBINLINE
, &opt
, sizeof(opt
));
398 fdflags(r
->fd
, O_NONBLOCK
, O_NONBLOCK
, FD_CLOEXEC
, FD_CLOEXEC
);
401 /* --- Make an endpoint --- */
404 e
->e
.ops
= &ssept_ops
;
408 e
->e
.in
= e
->e
.out
= r
;
412 /* --- Obtain the target endpoint and let rip --- */
414 if ((ee
= ss
->t
->ops
->create(ss
->t
, ss
->s
.desc
)) == 0) {
422 /* --- Note that we've done one --- */
425 if (i
>= ss
->o
.naccept
)
428 /* --- Remove the listening socket if necessary --- */
434 if (!(ss
->ao
->f
& ADDRF_NOLOG
))
435 fw_log(-1, "[%s] maximum connections reached", ss
->s
.desc
);
438 if (ss
->a
->ops
->unbind
)
439 ss
->a
->ops
->unbind(ss
->a
);
443 case SOCKOPT_NOLIMIT
:
445 case SOCKOPT_ONESHOT
:
448 if (ss
->a
->ops
->unbind
)
449 ss
->a
->ops
->unbind(ss
->a
);
450 ssource_destroy(&ss
->s
);
455 /* --- Let everything else happen --- */
457 endpt_join(&e
->e
, ee
, ss
->s
.desc
);
461 /* --- @ss_listen@ --- *
463 * Arguments: @ssource *ss@ = source to listen on
467 * Use: Sets the socket to listen again, if it stopped for some
468 * reason. This is a copy of the code in the @read@ function,
469 * because it has different (wildly different) error handling
473 static void ss_listen(ssource
*ss
)
478 if (!(ss
->ao
->f
& ADDRF_NOLOG
))
479 fw_log(-1, "[%s] reattaching listener", ss
->s
.desc
);
481 /* --- Make the socket --- */
483 if ((fd
= ss
->a
->ops
->bind(ss
->a
, ss
->ao
)) < 0) {
484 fw_log(-1, "[%s] couldn't create socket: %s",
485 ss
->s
.desc
, strerror(errno
));
489 /* --- Set it to listen for connections --- */
491 setsockopt(fd
, SOL_SOCKET
, SO_OOBINLINE
, &opt
, sizeof(opt
));
492 fdflags(fd
, O_NONBLOCK
, O_NONBLOCK
, FD_CLOEXEC
, FD_CLOEXEC
);
493 if (listen(fd
, ss
->o
.listen
)) {
494 fw_log(-1, "[%s] couldn't listen on socket: %s",
495 ss
->s
.desc
, strerror(errno
));
499 /* --- Set the listener up again --- */
505 /* --- Tidy up if it failed --- *
507 * I'll just remove the entire source.
514 ssource_destroy(&ss
->s
);
517 /* --- @attach@ --- */
519 static void ssource_attach(source
*s
, scanner
*sc
, target
*t
)
521 ssource
*ss
= (ssource
*)s
;
527 /* --- Initialize the description string --- */
531 dstr_puts(&d
, "socket.");
532 ss
->a
->ops
->print(ss
->a
, ADDR_SRC
, &d
);
533 dstr_puts(&d
, " -> ");
534 dstr_puts(&d
, ss
->t
->desc
);
535 ss
->s
.desc
= xstrdup(d
.buf
);
539 /* --- Confirm the address --- */
541 if (ss
->a
->ops
->confirm
)
542 ss
->a
->ops
->confirm(ss
->a
, ADDR_SRC
, ss
->ao
);
544 /* --- Initialize the socket for listening --- */
546 if ((fd
= ss
->a
->ops
->bind(ss
->a
, ss
->ao
)) < 0)
547 error(sc
, "couldn't bind socket `%s': %s", ss
->s
.desc
, strerror(errno
));
549 /* --- Set it to listen for connections --- */
551 setsockopt(fd
, SOL_SOCKET
, SO_OOBINLINE
, &opt
, sizeof(opt
));
552 fdflags(fd
, O_NONBLOCK
, O_NONBLOCK
, FD_CLOEXEC
, FD_CLOEXEC
);
553 if (listen(fd
, ss
->o
.listen
)) {
554 error(sc
, "couldn't listen on socket `%s': %s",
555 ss
->s
.desc
, strerror(errno
));
558 /* --- We're ready to go now --- */
560 sel_initfile(sel
, &ss
->r
, fd
, SEL_READ
, ss_accept
, ss
);
566 /* --- @destroy@ --- */
568 static void ssource_destroy(source
*s
)
570 ssource
*ss
= (ssource
*)s
;
572 if (ss
->o
.conn
|| ss
->o
.opt
!= SOCKOPT_LIMIT
) {
575 if (ss
->a
->ops
->unbind
)
576 ss
->a
->ops
->unbind(ss
->a
);
578 if (ss
->a
->ops
->freesrcopts
)
579 ss
->a
->ops
->freesrcopts(ss
->ao
);
583 ss
->a
->ops
->destroy(ss
->a
);
584 ss
->t
->ops
->destroy(ss
->t
);
585 source_remove(&ss
->s
);
590 /* --- Source definition block --- */
592 source_ops ssource_ops
= {
594 ssource_option
, ssource_read
, ssource_attach
, ssource_destroy
597 /*----- Target definition -------------------------------------------------*/
599 /* --- @options@ --- */
601 static int starget_option(target
*t
, scanner
*sc
)
603 starget
*st
= (starget
*)t
;
605 CONF_BEGIN(sc
, "starget", "socket target")
607 /* --- Pass the option around the various address types --- */
610 if (st
->a
->ops
->option
&& st
->a
->ops
->option(sc
, st
->ao
, ADDR_DEST
))
613 /* We'd have done it already if it was global */
622 static target
*starget_read(scanner
*sc
)
627 (void)(conf_prefix(sc
, "socket") || conf_prefix(sc
, "sk"));
628 st
= CREATE(starget
);
629 st
->t
.ops
= &starget_ops
;
630 st
->a
= getaddr(sc
, ADDR_DEST
);
631 if (st
->a
->ops
->inittargopts
)
632 st
->ao
= st
->a
->ops
->inittargopts();
634 st
->ao
= CREATE(addr_opts
);
637 dstr_puts(&d
, "socket.");
638 st
->a
->ops
->print(st
->a
, ADDR_DEST
, &d
);
639 st
->t
.desc
= xstrdup(d
.buf
);
644 /* --- @confirm@ --- */
646 static void starget_confirm(target
*t
)
648 starget
*st
= (starget
*)t
;
650 if (st
->a
->ops
->confirm
)
651 st
->a
->ops
->confirm(st
->a
, ADDR_DEST
, st
->ao
);
654 /* --- @create@ --- */
656 static endpt
*starget_create(target
*t
, const char *desc
)
658 starget
*st
= (starget
*)t
;
659 stept
*e
= CREATE(stept
);
661 e
->e
.ops
= &stept_ops
;
663 e
->e
.f
= EPF_FILE
| EPF_PENDING
;
665 e
->desc
= xstrdup(desc
);
666 if (st
->a
->ops
->connect(st
->a
, st
->ao
, &e
->c
, &e
->e
)) {
667 fw_log(-1, "[%s] couldn't connect: %s", e
->desc
, strerror(errno
));
675 /* --- @destroy@ --- */
677 static void starget_destroy(target
*t
)
679 starget
*st
= (starget
*)t
;
680 if (st
->a
->ops
->freetargopts
)
681 st
->a
->ops
->freetargopts(st
->ao
);
684 st
->a
->ops
->destroy(st
->a
);
689 /* --- Socket target definition block --- */
691 target_ops starget_ops
= {
693 starget_option
, starget_read
, starget_confirm
,
694 starget_create
, starget_destroy
697 /*----- That's all, folks -------------------------------------------------*/