1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278
|
/*
* Copyright (c) 2014-2016, 2018 by Farsight Security, Inc.
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be included
* in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*
*/
#include <arpa/inet.h>
#include <netinet/in.h>
#include <sys/stat.h>
#include <sys/socket.h>
#include <sys/un.h>
#include <assert.h>
#include <errno.h>
#include <fcntl.h>
#include <signal.h>
#include <stdbool.h>
#include <stdint.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <time.h>
#include <unistd.h>
#include <event2/buffer.h>
#include <event2/bufferevent.h>
#include <event2/event.h>
#include <event2/listener.h>
#include <fstrm.h>
#include "libmy/argv.h"
#include "libmy/my_alloc.h"
#include "libmy/print_string.h"
#if HAVE_DECL_FFLUSH_UNLOCKED
# define fflush fflush_unlocked
#endif
#if HAVE_DECL_FREAD_UNLOCKED
# define fread fread_unlocked
#endif
#if HAVE_DECL_FWRITE_UNLOCKED
# define fwrite fwrite_unlocked
#endif
struct capture;
struct capture_args;
struct conn;
typedef enum {
CONN_STATE_READING_CONTROL_READY,
CONN_STATE_READING_CONTROL_START,
CONN_STATE_READING_DATA,
CONN_STATE_STOPPED,
} conn_state;
typedef enum conn_verbosity {
CONN_CRITICAL = 0,
CONN_ERROR = 1,
CONN_WARNING = 2,
CONN_INFO = 3,
CONN_DEBUG = 4,
CONN_TRACE = 5,
} conn_verbosity;
struct conn {
struct capture *ctx;
conn_state state;
uint32_t len_frame_payload;
uint32_t len_frame_total;
size_t len_buf;
size_t bytes_read;
size_t bytes_skip;
size_t count_read;
struct bufferevent *bev;
struct evbuffer *ev_input;
struct evbuffer *ev_output;
struct fstrm_control *control;
};
struct capture {
struct capture_args *args;
struct sockaddr_storage ss;
socklen_t ss_len;
evutil_socket_t listen_fd;
struct event_base *ev_base;
struct evconnlistener *ev_connlistener;
struct event *ev_sighup;
struct event *ev_sigusr1;
FILE *output_file;
char *output_fname;
time_t output_open_timestamp;
size_t bytes_written;
size_t count_written;
size_t capture_highwater;
int remaining_connections;
struct tm *(*calendar_fn)(const time_t *, struct tm *);
};
struct capture_args {
bool help;
int debug;
bool localtime;
bool gmtime;
char *str_content_type;
char *str_read_unix;
char *str_read_tcp_address;
char *str_read_tcp_port;
char *str_write_fname;
int split_seconds;
int buffer_size;
int count_connections;
};
static struct capture g_program_ctx;
static struct capture_args g_program_args;
static argv_t g_args[] = {
{ 'h', "help",
ARGV_BOOL,
&g_program_args.help,
NULL,
"display this help text and exit" },
{ 'd', "debug",
ARGV_INCR,
&g_program_args.debug,
NULL,
"increment debugging level" },
{ 't', "type",
ARGV_CHAR_P,
&g_program_args.str_content_type,
"<STRING>",
"Frame Streams content type" },
{ 'u', "unix",
ARGV_CHAR_P,
&g_program_args.str_read_unix,
"<FILENAME>",
"Unix socket path to read from" },
{ 'a', "tcp",
ARGV_CHAR_P,
&g_program_args.str_read_tcp_address,
"<ADDRESS>",
"TCP socket address to read from" },
{ 'p', "port",
ARGV_CHAR_P,
&g_program_args.str_read_tcp_port,
"<PORT>",
"TCP socket port to read from" },
{ 'b', "buffersize",
ARGV_INT,
&g_program_args.buffer_size,
"<SIZE>",
"read buffer size, in bytes (default 262144)" },
{ 'c', "maxconns",
ARGV_INT,
&g_program_args.count_connections,
"<COUNT>",
"maximum concurrent connections allowed" },
{ 'w', "write",
ARGV_CHAR_P,
&g_program_args.str_write_fname,
"<FILENAME>",
"file path to write Frame Streams data to" },
{ 's', "split",
ARGV_INT,
&g_program_args.split_seconds,
"<SECONDS>",
"seconds before rotating output file" },
{ '\0', "localtime",
ARGV_BOOL,
&g_program_args.localtime,
NULL,
"filter -w path with strftime (local time)" },
{ '\0', "gmtime",
ARGV_BOOL,
&g_program_args.gmtime,
NULL,
"filter -w path with strftime (UTC)" },
{ ARGV_LAST, 0, 0, 0, 0, 0 },
};
static struct conn *
conn_init(struct capture *ctx)
{
struct conn *conn;
conn = my_calloc(1, sizeof(*conn));
conn->ctx = ctx;
conn->state = CONN_STATE_READING_CONTROL_READY;
conn->control = fstrm_control_init();
return conn;
}
static void
conn_destroy(struct conn **conn)
{
if (*conn != NULL) {
fstrm_control_destroy(&(*conn)->control);
my_free(*conn);
}
}
static void
conn_log(int level, struct conn *conn, const char *format, ...)
{
if (level > conn->ctx->args->debug)
return;
int fd = -1;
if (conn->bev != NULL)
fd = (int) bufferevent_getfd(conn->bev);
fprintf(stderr, "%s: connection fd %d: ", argv_program, fd);
va_list args;
va_start(args, format);
vfprintf(stderr, format, args);
va_end(args);
fputc('\n', stderr);
}
static void
conn_log_data(int level, struct conn *conn, const void *data, size_t len, const char *format, ...)
{
if (level > conn->ctx->args->debug)
return;
fprintf(stderr, "%s: connection fd %d: ", argv_program,
(int) bufferevent_getfd(conn->bev));
va_list args;
va_start(args, format);
vfprintf(stderr, format, args);
va_end(args);
print_string(data, len, stderr);
fputc('\n', stderr);
}
static void
cb_close_conn(struct bufferevent *bev, short error, void *arg)
{
struct conn *conn = (struct conn *) arg;
struct capture *ctx = conn->ctx;
if (error & BEV_EVENT_ERROR)
conn_log(CONN_CRITICAL, conn, "libevent error: %s (%d)",
strerror(errno), errno);
conn_log(CONN_INFO, conn, "closing (read %zd frames, %zd bytes)",
conn->count_read, conn->bytes_read);
/*
* The BEV_OPT_CLOSE_ON_FREE flag is set on our bufferevent's, so the
* following call to bufferevent_free() will close the underlying
* socket transport.
*/
bufferevent_free(bev);
conn_destroy(&conn);
ctx->remaining_connections++;
if (ctx->remaining_connections == 1)
evconnlistener_enable(ctx->ev_connlistener);
}
static bool
usage(const char *msg)
{
if (msg)
fprintf(stderr, "%s: Usage error: %s\n", argv_program, msg);
argv_usage(g_args, ARGV_USAGE_DEFAULT);
argv_cleanup(g_args);
exit(EXIT_FAILURE);
}
static bool
parse_args(const int argc, char **argv, struct capture *ctx)
{
argv_version_string = PACKAGE_VERSION;
if (argv_process(g_args, argc, argv) != 0)
return false;
/* Validate args. */
if (g_program_args.help)
return false;
if (g_program_args.str_content_type == NULL)
usage("Frame Streams content type (--type) is not set");
if (g_program_args.str_read_unix == NULL &&
g_program_args.str_read_tcp_address == NULL)
usage("One of --unix or --tcp must be set");
if (g_program_args.str_read_tcp_address != NULL &&
g_program_args.str_read_tcp_port == NULL)
usage("If --tcp is set, --port must also be set");
g_program_ctx.capture_highwater = 262144;
if (g_program_args.buffer_size > 0)
g_program_ctx.capture_highwater = (size_t)g_program_args.buffer_size;
g_program_ctx.remaining_connections = -1; /* unlimited connections. */
if (g_program_args.count_connections > 0)
g_program_ctx.remaining_connections = (unsigned)g_program_args.count_connections;
if (g_program_args.str_write_fname == NULL)
usage("File path to write Frame Streams data to (--write) is not set");
if (strcmp(g_program_args.str_write_fname, "-") == 0) {
if (isatty(STDOUT_FILENO) == 1)
usage("Refusing to write binary output to a terminal");
if (g_program_args.split_seconds != 0)
usage("Cannot use output splitting when writing to stdout");
}
if (g_program_args.localtime && g_program_args.gmtime)
usage("--localtime and --gmtime are mutually exclusive");
if (g_program_args.split_seconds && !g_program_args.localtime && !g_program_args.gmtime)
usage("--split requires either --localtime or --gmtime");
/* Set calendar function, if needed. */
if (g_program_args.localtime)
ctx->calendar_fn = localtime_r;
else if (g_program_args.gmtime)
ctx->calendar_fn = gmtime_r;
return true;
}
static bool
open_read_unix(struct capture *ctx)
{
int ret;
struct sockaddr_un *sa = (struct sockaddr_un *) &ctx->ss;
if (ctx->args->str_read_tcp_port != NULL)
fputs("Warning: Ignoring --port with --unix\n", stderr);
/* Construct sockaddr_un structure. */
if (strlen(ctx->args->str_read_unix) + 1 >
sizeof(sa->sun_path))
{
usage("Unix socket path is too long");
return false;
}
sa->sun_family = AF_UNIX;
strncpy(sa->sun_path,
ctx->args->str_read_unix,
sizeof(sa->sun_path) - 1);
ctx->ss_len = SUN_LEN(sa);
/* Remove a previously bound socket existing on the filesystem. */
ret = remove(sa->sun_path);
if (ret != 0 && errno != ENOENT) {
fprintf(stderr, "%s: failed to remove existing socket path %s\n",
argv_program, sa->sun_path);
return false;
}
/* Success. */
fprintf(stderr, "%s: opening Unix socket path %s\n",
argv_program, sa->sun_path);
return true;
}
static bool
open_read_tcp(struct capture *ctx)
{
struct sockaddr_in *sai = (struct sockaddr_in *) &ctx->ss;
struct sockaddr_in6 *sai6 = (struct sockaddr_in6 *) &ctx->ss;
uint64_t port = 0;
char *endptr = NULL;
/* Parse TCP listen port. */
port = strtoul(ctx->args->str_read_tcp_port, &endptr, 0);
if (*endptr != '\0' || port > UINT16_MAX) {
usage("Failed to parse TCP listen port");
return false;
}
if (inet_pton(AF_INET, ctx->args->str_read_tcp_address, &sai->sin_addr) == 1) {
sai->sin_family = AF_INET;
sai->sin_port = htons(port);
ctx->ss_len = sizeof(*sai);
} else if (inet_pton(AF_INET6, ctx->args->str_read_tcp_address, &sai6->sin6_addr) == 1) {
sai6->sin6_family = AF_INET6;
sai6->sin6_port = htons(port);
ctx->ss_len = sizeof(*sai6);
} else {
usage("Failed to parse TCP listen address");
return false;
}
/* Success. */
fprintf(stderr, "%s: opening TCP socket [%s]:%s\n",
argv_program, ctx->args->str_read_tcp_address, ctx->args->str_read_tcp_port);
return true;
}
static bool
close_write_stop(struct capture *ctx)
{
fstrm_res res;
uint8_t control_frame[FSTRM_CONTROL_FRAME_LENGTH_MAX];
size_t len_control_frame = sizeof(control_frame);
struct fstrm_control *c = NULL;
/* Initialize the STOP control frame. */
c = fstrm_control_init();
res = fstrm_control_set_type(c, FSTRM_CONTROL_STOP);
if (res != fstrm_res_success)
goto fail;
/* Encode the STOP frame. */
res = fstrm_control_encode(c, control_frame, &len_control_frame,
FSTRM_CONTROL_FLAG_WITH_HEADER);
if (res != fstrm_res_success)
goto fail;
/* Write the STOP frame. */
size_t n_written;
n_written = fwrite(control_frame, len_control_frame, 1, ctx->output_file);
if (n_written != 1)
goto fail;
/* Success. */
ctx->bytes_written += len_control_frame;
ctx->count_written += 1;
fstrm_control_destroy(&c);
return true;
fail:
fstrm_control_destroy(&c);
return false;
}
static bool
open_write_start(struct capture *ctx)
{
fstrm_res res;
uint8_t control_frame[FSTRM_CONTROL_FRAME_LENGTH_MAX];
size_t len_control_frame = sizeof(control_frame);
struct fstrm_control *c = NULL;
/* Initialize the START control frame. */
c = fstrm_control_init();
res = fstrm_control_set_type(c, FSTRM_CONTROL_START);
if (res != fstrm_res_success)
goto fail;
/* Set the "Content Type". */
res = fstrm_control_add_field_content_type(c,
(const uint8_t *) ctx->args->str_content_type,
strlen(ctx->args->str_content_type));
if (res != fstrm_res_success)
goto fail;
/* Encode the START frame. */
res = fstrm_control_encode(c, control_frame, &len_control_frame,
FSTRM_CONTROL_FLAG_WITH_HEADER);
if (res != fstrm_res_success)
goto fail;
/* Write the START frame. */
size_t n_written;
n_written = fwrite(control_frame, len_control_frame, 1, ctx->output_file);
if (n_written != 1)
goto fail;
(void) fflush(ctx->output_file);
/* Success. */
ctx->bytes_written += len_control_frame;
ctx->count_written += 1;
fstrm_control_destroy(&c);
return true;
fail:
fstrm_control_destroy(&c);
return false;
}
static const char *
update_output_fname(struct capture *ctx)
{
time_t time_now = {0};
struct tm tm_now = {0};
/* Get current broken-down time representation. */
tzset();
time_now = time(NULL);
ctx->calendar_fn(&time_now, &tm_now);
/* Save current time. */
ctx->output_open_timestamp = time_now;
/*
* Filter ctx->args->str_write_fname with strftime(), store output in
* ctx->output_fname. Assume strftime() lengthens the string by no more
* than 256 bytes.
*/
if (ctx->output_fname != NULL)
my_free(ctx->output_fname);
const size_t len_output_fname = strlen(ctx->args->str_write_fname) + 256;
ctx->output_fname = my_calloc(1, len_output_fname);
if (strftime(ctx->output_fname, len_output_fname,
ctx->args->str_write_fname, &tm_now) <= 0)
{
my_free(ctx->output_fname);
fprintf(stderr, "%s: strftime() failed on format string \"%s\"\n",
argv_program, ctx->args->str_write_fname);
return NULL;
}
return ctx->output_fname;
}
static bool
open_write_file(struct capture *ctx)
{
const char *fname = ctx->args->str_write_fname;
if (strcmp(fname, "-") == 0) {
/* Use already opened FILE* for stdout. */
ctx->output_file = stdout;
} else {
mode_t open_mode = S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP | S_IROTH | S_IWOTH;
int open_flags = O_CREAT | O_WRONLY | O_TRUNC;
#if defined(O_CLOEXEC)
open_flags |= O_CLOEXEC;
#endif
/* Rewrite the output filename if needed. */
if (ctx->calendar_fn) {
fname = update_output_fname(ctx);
if (fname == NULL)
return false;
}
/* Open the file descriptor. */
int fd = open(fname, open_flags, open_mode);
if (fd == -1) {
fprintf(stderr, "%s: failed to open output file %s\n",
argv_program, fname);
return false;
}
/* Open the FILE object. */
ctx->output_file = fdopen(fd, "w");
if (!ctx->output_file) {
close(fd);
fprintf(stderr, "%s: failed to fdopen output file %s\n",
argv_program, fname);
return false;
}
}
/* Reset output statistics. */
ctx->count_written = 0;
ctx->bytes_written = 0;
/* Write the START frame. */
if (!open_write_start(ctx)) {
fclose(ctx->output_file);
ctx->output_file = NULL;
fprintf(stderr, "%s: failed to write output file %s\n",
argv_program, fname);
return false;
}
/* Success. */
fprintf(stderr, "%s: opened output file %s\n", argv_program, fname);
return true;
}
static bool
close_write_file(struct capture *ctx)
{
if (ctx->output_file != NULL) {
/* Write the STOP frame. */
if (!close_write_stop(ctx))
return false;
/* Close the FILE object. */
fclose(ctx->output_file);
ctx->output_file = NULL;
}
/* Success. */
fprintf(stderr, "%s: closed output file %s (wrote %zd frames, %zd bytes)\n",
argv_program,
ctx->output_fname ? ctx->output_fname : ctx->args->str_write_fname,
ctx->count_written, ctx->bytes_written);
return true;
}
static void
process_data_frame(struct conn *conn)
{
conn_log(CONN_TRACE, conn, "processing data frame (%u bytes)",
conn->len_frame_total);
/*
* Peek at 'conn->len_frame_total' bytes of data from the evbuffer, and
* write them to the output file.
*/
/* Determine how many iovec's we need to read. */
const int n_vecs = evbuffer_peek(conn->ev_input, conn->len_frame_total, NULL, NULL, 0);
/* Allocate space for the iovec's. */
struct evbuffer_iovec vecs[n_vecs];
/* Retrieve the iovec's. */
const int n = evbuffer_peek(conn->ev_input, conn->len_frame_total, NULL, vecs, n_vecs);
assert(n == n_vecs);
/* Write each iovec to the output file. */
size_t bytes_read = 0;
for (int i = 0; i < n_vecs; i++) {
size_t len = vecs[i].iov_len;
/* Only read up to 'conn->len_frame_total' bytes. */
if (bytes_read + len > conn->len_frame_total)
len = conn->len_frame_total - bytes_read;
/* Do the fwrite(). Fail hard if it fails. */
size_t res = fwrite(vecs[i].iov_base, len, 1, conn->ctx->output_file);
if (res != 1) {
fprintf(stderr, "%s: fwrite() failed: %s\n",
argv_program, strerror(errno));
exit(EXIT_FAILURE);
}
bytes_read += len;
}
/* Check that exactly the right number of bytes were written. */
assert(bytes_read == conn->len_frame_total);
/* Delete the data frame from the input buffer. */
evbuffer_drain(conn->ev_input, conn->len_frame_total);
/* Accounting. */
conn->count_read += 1;
conn->bytes_read += bytes_read;
conn->ctx->count_written += 1;
conn->ctx->bytes_written += bytes_read;
}
static void
rotate_output(struct capture *ctx)
{
/* Don't rotate output file if we're writing to stdout. */
if (ctx->output_file == stdout) {
fprintf(stderr, "%s: %s: not rotating stdout\n",
argv_program, __func__);
return;
}
/* Rotate output file, fail hard if unsuccessful. */
if (!close_write_file(ctx)) {
fprintf(stderr, "%s: %s: close_write_file() failed\n",
argv_program, __func__);
exit(EXIT_FAILURE);
}
if (!open_write_file(ctx)) {
fprintf(stderr, "%s: %s: open_write_file() failed\n",
argv_program, __func__);
exit(EXIT_FAILURE);
}
}
static void
maybe_rotate_output(struct conn *conn)
{
/* Output file rotation requested? */
if (conn->ctx->args->split_seconds > 0) {
time_t t_now = time(NULL);
/* Is it time to rotate? */
if (t_now >= conn->ctx->output_open_timestamp + conn->ctx->args->split_seconds) {
rotate_output(conn->ctx);
}
}
}
static bool
send_frame(struct conn *conn, const void *data, size_t size)
{
conn_log_data(CONN_TRACE, conn, data, size, "writing frame (%zd) bytes: ", size);
if (bufferevent_write(conn->bev, data, size) != 0) {
conn_log(CONN_WARNING, conn, "bufferevent_write() failed");
return false;
}
return true;
}
static bool
match_content_type(struct conn *conn)
{
fstrm_res res;
/* Match the "Content Type" against ours. */
res = fstrm_control_match_field_content_type(conn->control,
(const uint8_t *) conn->ctx->args->str_content_type,
strlen(conn->ctx->args->str_content_type));
if (res != fstrm_res_success) {
conn_log(CONN_WARNING, conn, "no CONTENT_TYPE matching: \"%s\"",
conn->ctx->args->str_content_type);
return false;
}
/* Success. */
return true;
}
static bool
write_control_frame(struct conn *conn)
{
fstrm_res res;
uint8_t control_frame[FSTRM_CONTROL_FRAME_LENGTH_MAX];
size_t len_control_frame = sizeof(control_frame);
/* Encode the control frame. */
res = fstrm_control_encode(conn->control,
control_frame, &len_control_frame,
FSTRM_CONTROL_FLAG_WITH_HEADER);
if (res != fstrm_res_success)
return false;
/* Send the control frame. */
fstrm_control_type type = 0;
(void)fstrm_control_get_type(conn->control, &type);
conn_log(CONN_DEBUG, conn, "sending %s (%d)",
fstrm_control_type_to_str(type), type);
if (!send_frame(conn, control_frame, len_control_frame))
return false;
/* Success. */
return true;
}
static bool
process_control_frame_ready(struct conn *conn)
{
fstrm_res res;
const uint8_t *content_type = NULL;
size_t len_content_type = 0;
size_t n_content_type = 0;
/* Retrieve the number of "Content Type" fields. */
res = fstrm_control_get_num_field_content_type(conn->control, &n_content_type);
if (res != fstrm_res_success)
return false;
for (size_t i = 0; i < n_content_type; i++) {
res = fstrm_control_get_field_content_type(conn->control, i,
&content_type,
&len_content_type);
if (res != fstrm_res_success)
return false;
conn_log_data(CONN_TRACE, conn,
content_type, len_content_type,
"CONTENT_TYPE [%zd/%zd] (%zd bytes): ",
i + 1, n_content_type, len_content_type);
}
/* Match the "Content Type" against ours. */
if (!match_content_type(conn))
return false;
/* Setup the ACCEPT frame. */
fstrm_control_reset(conn->control);
res = fstrm_control_set_type(conn->control, FSTRM_CONTROL_ACCEPT);
if (res != fstrm_res_success)
return false;
res = fstrm_control_add_field_content_type(conn->control,
(const uint8_t *) conn->ctx->args->str_content_type,
strlen(conn->ctx->args->str_content_type));
if (res != fstrm_res_success)
return false;
/* Send the ACCEPT frame. */
if (!write_control_frame(conn))
return false;
/* Success. */
conn->state = CONN_STATE_READING_CONTROL_START;
return true;
}
static bool
process_control_frame_start(struct conn *conn)
{
/* Match the "Content Type" against ours. */
if (!match_content_type(conn))
return false;
/* Success. */
conn->state = CONN_STATE_READING_DATA;
return true;
}
static bool
process_control_frame_stop(struct conn *conn)
{
fstrm_res res;
/* Setup the FINISH frame. */
fstrm_control_reset(conn->control);
res = fstrm_control_set_type(conn->control, FSTRM_CONTROL_FINISH);
if (res != fstrm_res_success)
return false;
/* Send the FINISH frame. */
if (!write_control_frame(conn))
return false;
conn->state = CONN_STATE_STOPPED;
/* We return true here, which prevents the caller from closing
* the connection directly (with the FINISH frame still in our
* write buffer). The connection will be closed after the FINISH
* frame is written and the write callback (cb_write) is called
* to refill the write buffer.
*/
return true;
}
static bool
process_control_frame(struct conn *conn)
{
fstrm_res res;
fstrm_control_type type;
/* Get the control frame type. */
res = fstrm_control_get_type(conn->control, &type);
if (res != fstrm_res_success)
return false;
conn_log(CONN_DEBUG, conn, "received %s (%u)",
fstrm_control_type_to_str(type), type);
switch (conn->state) {
case CONN_STATE_READING_CONTROL_READY: {
if (type != FSTRM_CONTROL_READY)
return false;
return process_control_frame_ready(conn);
}
case CONN_STATE_READING_CONTROL_START: {
if (type != FSTRM_CONTROL_START)
return false;
return process_control_frame_start(conn);
}
case CONN_STATE_READING_DATA: {
if (type != FSTRM_CONTROL_STOP)
return false;
return process_control_frame_stop(conn);
}
default:
return false;
}
/* Success. */
return true;
}
static bool
load_control_frame(struct conn *conn)
{
fstrm_res res;
uint8_t *control_frame = NULL;
/* Check if the frame is too big. */
if (conn->len_frame_total >= FSTRM_CONTROL_FRAME_LENGTH_MAX) {
/* Malformed. */
return false;
}
/* Get a pointer to the full, linearized control frame. */
control_frame = evbuffer_pullup(conn->ev_input, conn->len_frame_total);
if (!control_frame) {
/* Malformed. */
return false;
}
conn_log_data(CONN_TRACE, conn, control_frame, conn->len_frame_total,
"reading control frame (%u bytes): ", conn->len_frame_total);
/* Decode the control frame. */
res = fstrm_control_decode(conn->control,
control_frame,
conn->len_frame_total,
FSTRM_CONTROL_FLAG_WITH_HEADER);
if (res != fstrm_res_success) {
/* Malformed. */
return false;
}
/* Drain the data read. */
evbuffer_drain(conn->ev_input, conn->len_frame_total);
/* Success. */
return true;
}
static bool
can_read_full_frame(struct conn *conn)
{
uint32_t tmp[2] = {0};
/*
* This tracks the total number of bytes that must be removed from the
* input buffer to read the entire frame. */
conn->len_frame_total = 0;
/* Check if the frame length field has fully arrived. */
if (conn->len_buf < sizeof(uint32_t))
return false;
/* Read the frame length field. */
evbuffer_copyout(conn->ev_input, &tmp[0], sizeof(uint32_t));
conn->len_frame_payload = ntohl(tmp[0]);
/* Account for the frame length field. */
conn->len_frame_total += sizeof(uint32_t);
/* Account for the length of the frame payload. */
conn->len_frame_total += conn->len_frame_payload;
/* Check if this is a control frame. */
if (conn->len_frame_payload == 0) {
uint32_t len_control_frame = 0;
/*
* Check if the control frame length field has fully arrived.
* Note that the input buffer hasn't been drained, so we also
* need to account for the initial frame length field. That is,
* there must be at least 8 bytes available in the buffer.
*/
if (conn->len_buf < 2*sizeof(uint32_t))
return false;
/* Read the control frame length. */
evbuffer_copyout(conn->ev_input, &tmp[0], 2*sizeof(uint32_t));
len_control_frame = ntohl(tmp[1]);
/* Account for the length of the control frame length field. */
conn->len_frame_total += sizeof(uint32_t);
/* Enforce minimum and maximum control frame size. */
if (len_control_frame < sizeof(uint32_t) ||
len_control_frame > FSTRM_CONTROL_FRAME_LENGTH_MAX)
{
cb_close_conn(conn->bev, 0, conn);
return false;
}
/* Account for the control frame length. */
conn->len_frame_total += len_control_frame;
}
/*
* Check if the frame has fully arrived. 'len_buf' must have at least
* the number of bytes needed in order to read the full frame, which is
* exactly 'len_frame_total'.
*/
if (conn->len_buf < conn->len_frame_total) {
conn_log(CONN_TRACE, conn, "incomplete message (have %zd bytes, want %u)",
conn->len_buf, conn->len_frame_total);
if (conn->len_frame_total > conn->ctx->capture_highwater) {
conn_log(CONN_WARNING, conn,
"Skipping %zd byte message (%zd buffer)",
conn->len_frame_total,
conn->ctx->capture_highwater);
conn->bytes_skip = conn->len_frame_total;
}
return false;
}
/* Success. The entire frame can now be read from the buffer. */
return true;
}
static void
cb_write(struct bufferevent *bev, void *arg)
{
struct conn *conn = (struct conn *) arg;
if (conn->state != CONN_STATE_STOPPED)
return;
cb_close_conn(bev, 0, arg);
}
static void
cb_read(struct bufferevent *bev, void *arg)
{
struct conn *conn = (struct conn *) arg;
conn->bev = bev;
conn->ev_input = bufferevent_get_input(conn->bev);
conn->ev_output = bufferevent_get_output(conn->bev);
for (;;) {
/* Get the number of bytes available in the buffer. */
conn->len_buf = evbuffer_get_length(conn->ev_input);
/* Check if there is any data available in the buffer. */
if (conn->len_buf <= 0)
return;
/* Check if the full frame has arrived. */
if ((conn->bytes_skip == 0) && !can_read_full_frame(conn))
return;
/* Skip bytes of oversized frames. */
if (conn->bytes_skip > 0) {
size_t skip = conn->bytes_skip;
if (skip > conn->len_buf)
skip = conn->len_buf;
conn_log(CONN_TRACE, conn, "Skipping %zd bytes", skip);
evbuffer_drain(conn->ev_input, skip);
conn->bytes_skip -= skip;
continue;
}
/* Process the frame. */
if (conn->len_frame_payload > 0) {
/* This is a data frame. */
process_data_frame(conn);
/* Check if it's time to rotate the output file. */
maybe_rotate_output(conn);
} else {
/* This is a control frame. */
if (!load_control_frame(conn)) {
/* Malformed control frame, shut down the connection. */
cb_close_conn(conn->bev, 0, conn);
return;
}
if (!process_control_frame(conn)) {
/*
* Invalid control state requested, or the
* end-of-stream has been reached. Shut down
* the connection.
*/
cb_close_conn(conn->bev, 0, conn);
return;
}
}
}
}
static void
cb_accept_conn(struct evconnlistener *listener, evutil_socket_t fd,
__attribute__((unused)) struct sockaddr *sa,
__attribute__((unused)) int socklen, void *arg)
{
struct capture *ctx = (struct capture *) arg;
struct event_base *base = evconnlistener_get_base(listener);
/* Set up a bufferevent and per-connection context for the new connection. */
struct bufferevent *bev = bufferevent_socket_new(base, fd, BEV_OPT_CLOSE_ON_FREE);
if (!bev) {
if (ctx->args->debug >= CONN_ERROR)
fprintf(stderr, "%s: bufferevent_socket_new() failed\n",
argv_program);
evutil_closesocket(fd);
return;
}
struct conn *conn = conn_init(ctx);
bufferevent_setcb(bev, cb_read, cb_write, cb_close_conn, (void *) conn);
bufferevent_setwatermark(bev, EV_READ, 0, ctx->capture_highwater);
bufferevent_enable(bev, EV_READ | EV_WRITE);
if (ctx->args->debug >= CONN_INFO)
fprintf(stderr, "%s: accepted new connection fd %d\n", argv_program, fd);
ctx->remaining_connections--;
if (ctx->remaining_connections == 0)
evconnlistener_disable(listener);
}
static void
cb_accept_error(__attribute__((unused)) struct evconnlistener *listener,
__attribute__((unused)) void *arg)
{
const int err = EVUTIL_SOCKET_ERROR();
fprintf(stderr, "%s: accept() failed: %s\n", argv_program,
evutil_socket_error_to_string(err));
}
static void
do_sigusr1(__attribute__((unused)) evutil_socket_t sig,
__attribute__((unused)) short events, void *user_data)
{
struct capture *ctx = user_data;
if (ctx->output_file) {
fprintf(stderr, "%s: received SIGUSR1, rotating output file\n", argv_program);
rotate_output(ctx);
}
}
static void
do_sighup(__attribute__((unused)) evutil_socket_t sig,
__attribute__((unused)) short events, void *user_data)
{
struct capture *ctx = user_data;
if (ctx->output_file) {
fflush(ctx->output_file);
fprintf(stderr, "%s: received SIGHUP, flushing output\n", argv_program);
}
}
static bool
setup_event_loop(struct capture *ctx)
{
/* Create the event base. */
ctx->ev_base = event_base_new();
if (!ctx->ev_base)
return false;
/* Create the evconnlistener. */
unsigned flags = 0;
flags |= LEV_OPT_CLOSE_ON_FREE; /* Closes underlying sockets. */
flags |= LEV_OPT_CLOSE_ON_EXEC; /* Sets FD_CLOEXEC on underlying fd's. */
flags |= LEV_OPT_REUSEABLE; /* Sets SO_REUSEADDR on listener. */
ctx->ev_connlistener = evconnlistener_new_bind(ctx->ev_base,
cb_accept_conn, (void *) ctx, flags, -1,
(struct sockaddr *) &ctx->ss, ctx->ss_len);
if (!ctx->ev_connlistener) {
event_base_free(ctx->ev_base);
ctx->ev_base = NULL;
return false;
}
evconnlistener_set_error_cb(ctx->ev_connlistener, cb_accept_error);
/* Register our SIGHUP handler. */
ctx->ev_sighup = evsignal_new(ctx->ev_base, SIGHUP, &do_sighup,
&g_program_ctx);
evsignal_add(ctx->ev_sighup, NULL);
/* Register our SIGUSR1 handler. */
ctx->ev_sigusr1 = evsignal_new(ctx->ev_base, SIGUSR1, &do_sigusr1,
&g_program_ctx);
evsignal_add(ctx->ev_sigusr1, NULL);
/* Success. */
return true;
}
static void
shutdown_handler(int signum __attribute__((unused)))
{
event_base_loopexit(g_program_ctx.ev_base, NULL);
}
static bool
setup_signals(void)
{
struct sigaction sa = {
.sa_handler = shutdown_handler,
};
if (sigemptyset(&sa.sa_mask) != 0)
return false;
if (sigaction(SIGTERM, &sa, NULL) != 0)
return false;
if (sigaction(SIGINT, &sa, NULL) != 0)
return false;
/* Success. */
return true;
}
static void
cleanup(struct capture *ctx)
{
argv_cleanup(g_args);
if (ctx->ev_sighup != NULL)
event_free(ctx->ev_sighup);
if (ctx->ev_sigusr1 != NULL)
event_free(ctx->ev_sigusr1);
if (ctx->ev_connlistener != NULL)
evconnlistener_free(ctx->ev_connlistener);
if (ctx->ev_base != NULL)
event_base_free(ctx->ev_base);
my_free(ctx->output_fname);
}
int
main(int argc, char **argv)
{
/* Parse arguments. */
if (!parse_args(argc, argv, &g_program_ctx)) {
usage(NULL);
return EXIT_FAILURE;
}
g_program_ctx.args = &g_program_args;
/* Open the Unix socket input, if specified. */
if (g_program_ctx.args->str_read_unix != NULL) {
if (!open_read_unix(&g_program_ctx))
return EXIT_FAILURE;
} else if (g_program_ctx.args->str_read_tcp_address != NULL &&
g_program_ctx.args->str_read_tcp_port != NULL) {
/* Otherwise, open the TCP socket input. */
if (!open_read_tcp(&g_program_ctx))
return EXIT_FAILURE;
} else {
fprintf(stderr, "%s: failed to setup a listening socket\n", argv_program);
return EXIT_FAILURE;
}
/* Open the file output. */
if (!open_write_file(&g_program_ctx))
return EXIT_FAILURE;
/* Setup the event loop. */
if (!setup_event_loop(&g_program_ctx)) {
fprintf(stderr, "%s: failed to setup event loop\n", argv_program);
return EXIT_FAILURE;
}
/* Setup signals. */
if (!setup_signals()) {
fprintf(stderr, "%s: failed to setup signals\n", argv_program);
return EXIT_FAILURE;
}
/* Run the event loop. */
if (event_base_dispatch(g_program_ctx.ev_base) != 0) {
fprintf(stderr, "%s: failed to start event loop\n", argv_program);
return EXIT_FAILURE;
}
fprintf(stderr, "%s: shutting down\n", argv_program);
/* Shut down. */
if (!close_write_file(&g_program_ctx))
return EXIT_FAILURE;
cleanup(&g_program_ctx);
/* Success. */
return EXIT_SUCCESS;
}
|