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
|
#include "recording.h"
#include <stdio.h>
#include <stdlib.h>
#include <glib.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <netinet/in.h>
#include <time.h>
#include <pcap.h>
#include <inttypes.h>
#include <errno.h>
#include <unistd.h>
#include <assert.h>
#include <stdarg.h>
#include "call.h"
#include "main.h"
#include "kernel.h"
#include "rtplib.h"
#include "cdr.h"
#include "log.h"
#include "call_interfaces.h"
#include "media_player.h"
#include "xt_RTPENGINE.h"
struct rec_pcap_format {
int linktype;
int headerlen;
void (*header)(unsigned char *, struct packet_stream *);
};
static int check_main_spool_dir(const char *spoolpath);
static char *recording_setup_file(struct recording *recording, const str *);
static char *meta_setup_file(struct recording *recording, const str *);
static int append_meta_chunk(struct recording *recording, const char *buf, unsigned int buflen,
const char *label_fmt, ...)
__attribute__((format(printf,4,5)));
static int vappend_meta_chunk(struct recording *recording, const char *buf, unsigned int buflen,
const char *label_fmt, va_list ap);
// all methods
static int create_spool_dir_all(const char *spoolpath);
static void init_all(call_t *call);
static void sdp_after_all(struct recording *recording, const str *str, struct call_monologue *ml,
enum ng_opmode opmode);
static void dump_packet_all(struct media_packet *mp, const str *s);
static void finish_all(call_t *call, bool discard);
// pcap methods
static int rec_pcap_create_spool_dir(const char *dirpath);
static void rec_pcap_init(call_t *);
static void sdp_after_pcap(struct recording *, const str *str, struct call_monologue *, enum ng_opmode opmode);
static void dump_packet_pcap(struct media_packet *mp, const str *s);
static void finish_pcap(call_t *, bool discard);
static void response_pcap(struct recording *, const ng_parser_t *, parser_arg);
// proc methods
static void proc_init(call_t *);
static void sdp_before_proc(struct recording *, const str *, struct call_monologue *, enum ng_opmode);
static void sdp_after_proc(struct recording *, const str *sdp, struct call_monologue *, enum ng_opmode opmode);
static void meta_chunk_proc(struct recording *, const char *, const str *);
static void update_flags_proc(call_t *call, bool streams);
static void finish_proc(call_t *, bool discard);
static void dump_packet_proc(struct media_packet *mp, const str *s);
static void init_stream_proc(struct packet_stream *);
static void setup_stream_proc(struct packet_stream *);
static void setup_media_proc(struct call_media *);
static void setup_monologue_proc(struct call_monologue *);
static void kernel_info_proc(struct packet_stream *, struct rtpengine_target_info *);
static void rec_pcap_eth_header(unsigned char *, struct packet_stream *);
#define append_meta_chunk_str(r, str, f...) append_meta_chunk(r, (str)->s, (str)->len, f)
#define vappend_meta_chunk_str(r, str, f, ap) vappend_meta_chunk(r, (str)->s, (str)->len, f, ap)
#define append_meta_chunk_s(r, str, f...) append_meta_chunk(r, (str), strlen(str), f)
#define append_meta_chunk_null(r,f...) append_meta_chunk(r, "", 0, f)
const struct recording_method methods[] = {
{
.name = "pcap",
.kernel_support = 0,
.create_spool_dir = rec_pcap_create_spool_dir,
.init_struct = rec_pcap_init,
.sdp_before = NULL,
.sdp_after = sdp_after_pcap,
.meta_chunk = NULL,
.update_flags = NULL,
.dump_packet = dump_packet_pcap,
.finish = finish_pcap,
.init_stream_struct = NULL,
.setup_stream = NULL,
.setup_media = NULL,
.setup_monologue = NULL,
.stream_kernel_info = NULL,
.response = response_pcap,
},
{
.name = "proc",
.kernel_support = 1,
.create_spool_dir = check_main_spool_dir,
.init_struct = proc_init,
.sdp_before = sdp_before_proc,
.sdp_after = sdp_after_proc,
.meta_chunk = meta_chunk_proc,
.update_flags = update_flags_proc,
.dump_packet = dump_packet_proc,
.finish = finish_proc,
.init_stream_struct = init_stream_proc,
.setup_stream = setup_stream_proc,
.setup_media = setup_media_proc,
.setup_monologue = setup_monologue_proc,
.stream_kernel_info = kernel_info_proc,
.response = NULL,
},
{
.name = "all",
.kernel_support = 0,
.create_spool_dir = create_spool_dir_all,
.init_struct = init_all,
.sdp_before = sdp_before_proc,
.sdp_after = sdp_after_all,
.meta_chunk = meta_chunk_proc,
.update_flags = update_flags_proc,
.dump_packet = dump_packet_all,
.finish = finish_all,
.init_stream_struct = init_stream_proc,
.setup_stream = setup_stream_proc,
.setup_media = setup_media_proc,
.setup_monologue = setup_monologue_proc,
.stream_kernel_info = kernel_info_proc,
.response = response_pcap,
},
};
static const struct rec_pcap_format rec_pcap_format_raw = {
.linktype = DLT_RAW,
.headerlen = 0,
};
static const struct rec_pcap_format rec_pcap_format_eth = {
.linktype = DLT_EN10MB,
.headerlen = 14,
.header = rec_pcap_eth_header,
};
// Global file reference to the spool directory.
static char *spooldir = NULL;
const struct recording_method *selected_recording_method;
static const struct rec_pcap_format *rec_pcap_format;
/**
* Free RTP Engine filesystem settings and structure.
* Check for and free the RTP Engine spool directory.
*/
void recording_fs_free(void) {
g_clear_pointer(&spooldir, free);
}
/**
* Initialize RTP Engine filesystem settings and structure.
* Check for or create the RTP Engine spool directory.
*/
void recording_fs_init(const char *spoolpath, const char *method_str, const char *format_str) {
int i;
// Whether or not to fail if the spool directory does not exist.
if (spoolpath == NULL || spoolpath[0] == '\0')
return;
for (i = 0; i < G_N_ELEMENTS(methods); i++) {
if (!strcmp(methods[i].name, method_str)) {
selected_recording_method = &methods[i];
goto found;
}
}
ilog(LOG_ERROR, "Recording method '%s' not supported", method_str);
return;
found:
if(!strcmp("raw", format_str))
rec_pcap_format = &rec_pcap_format_raw;
else if(!strcmp("eth", format_str))
rec_pcap_format = &rec_pcap_format_eth;
else {
ilog(LOG_ERR, "Invalid value for recording format \"%s\".", format_str);
exit(-1);
}
spooldir = strdup(spoolpath);
int path_len = strlen(spooldir);
// Get rid of trailing "/" if it exists. Other code adds that in when needed.
if (spooldir[path_len-1] == '/') {
spooldir[path_len-1] = '\0';
}
if (!_rm_ret(create_spool_dir, spooldir)) {
ilog(LOG_ERR, "Error while setting up spool directory \"%s\".", spooldir);
ilog(LOG_ERR, "Please run `mkdir %s` and start rtpengine again.", spooldir);
exit(-1);
}
}
static int check_create_dir(const char *dir, const char *desc, mode_t creat_mode) {
struct stat info;
if (stat(dir, &info) != 0) {
if (!creat_mode) {
ilog(LOG_WARN, "%s directory \"%s\" does not exist.", desc, dir);
return FALSE;
}
ilog(LOG_INFO, "Creating %s directory \"%s\".", desc, dir);
// coverity[toctou : FALSE]
if (mkdir(dir, creat_mode) == 0)
return TRUE;
ilog(LOG_ERR, "Failed to create %s directory \"%s\": %s", desc, dir, strerror(errno));
return FALSE;
}
if(!S_ISDIR(info.st_mode)) {
ilog(LOG_ERR, "%s file exists, but \"%s\" is not a directory.", desc, dir);
return FALSE;
}
return TRUE;
}
static int check_main_spool_dir(const char *spoolpath) {
return check_create_dir(spoolpath, "spool", 0700);
}
/**
* Sets up the spool directory for RTP Engine.
* If the directory does not exist, return FALSE.
* If the directory exists, but "$spoolpath/metadata" or "$spoolpath/pcaps"
* exist as non-directory files, return FALSE.
* Otherwise, return TRUE.
*
* Create the "metadata" and "pcaps" directories if they are not there.
*/
static int rec_pcap_create_spool_dir(const char *spoolpath) {
int spool_good = TRUE;
if (!check_main_spool_dir(spoolpath))
return FALSE;
// Spool directory exists. Make sure it has inner directories.
int path_len = strlen(spoolpath);
char meta_path[path_len + 10];
char rec_path[path_len + 7];
char tmp_path[path_len + 5];
snprintf(meta_path, sizeof(meta_path), "%s/metadata", spoolpath);
snprintf(rec_path, sizeof(rec_path), "%s/pcaps", spoolpath);
snprintf(tmp_path, sizeof(tmp_path), "%s/tmp", spoolpath);
if (!check_create_dir(meta_path, "metadata", 0777))
spool_good = FALSE;
if (!check_create_dir(rec_path, "pcaps", 0777))
spool_good = FALSE;
if (!check_create_dir(tmp_path, "tmp", 0777))
spool_good = FALSE;
return spool_good;
}
// lock must be held
static void update_call_field(call_t *call, str *dst_field, const str *src_field, const char *meta_fmt, ...) {
if (!call)
return;
if (src_field && src_field->len && str_cmp_str(src_field, dst_field))
*dst_field = call_str_cpy(src_field);
if (call->recording && dst_field->len) {
va_list ap;
va_start(ap, meta_fmt);
vappend_meta_chunk_str(call->recording, dst_field, meta_fmt, ap);
va_end(ap);
}
}
// lock must be held
void update_metadata_call(call_t *call, const sdp_ng_flags *flags) {
if (flags && flags->skip_recording_db)
CALL_SET(call, NO_REC_DB);
if (call->recording) {
// must come first because METADATA triggers update to DB
if (CALL_ISSET(call, NO_REC_DB))
append_meta_chunk_null(call->recording, "SKIP_DATABASE");
}
update_call_field(call, &call->metadata, flags ? &flags->metadata : NULL, "METADATA");
update_call_field(call, &call->recording_file, flags ? &flags->recording_file : NULL, "RECORDING_FILE");
update_call_field(call, &call->recording_path, flags ? &flags->recording_path : NULL, "RECORDING_PATH");
update_call_field(call, &call->recording_pattern, flags ? &flags->recording_pattern : NULL,
"RECORDING_PATTERN");
if (call->recording)
append_meta_chunk_null(call->recording, "STARTED");
}
// lock must be held
void update_metadata_monologue_only(struct call_monologue *ml, const sdp_ng_flags *flags) {
if (!ml)
return;
update_call_field(ml->call, &ml->metadata, flags ? &flags->metadata : NULL,
"METADATA-TAG %u", ml->unique_id);
update_call_field(ml->call, &ml->label, NULL, "LABEL %u", ml->unique_id);
}
void update_metadata_monologue(struct call_monologue *ml, const sdp_ng_flags *flags) {
if (!ml)
return;
update_metadata_monologue_only(ml, flags);
update_metadata_call(ml->call, flags);
}
// lock must be held
static void update_flags_proc(call_t *call, bool streams) {
append_meta_chunk_null(call->recording, "RECORDING %u", CALL_ISSET(call, RECORDING_ON));
append_meta_chunk_null(call->recording, "FORWARDING %u", CALL_ISSET(call, REC_FORWARDING));
update_metadata_call(call, NULL);
if (!streams)
return;
for (__auto_type l = call->streams.head; l; l = l->next) {
struct packet_stream *ps = l->data;
append_meta_chunk_null(call->recording, "STREAM %u FORWARDING %u",
ps->unique_id, ML_ISSET(ps->media->monologue, REC_FORWARDING) ? 1 : 0);
}
}
static void recording_update_flags(call_t *call, bool streams) {
_rm(update_flags, call, streams);
}
static void rec_setup_monologue(struct call_monologue *ml) {
recording_setup_monologue(ml);
if (ml->rec_player) {
bool ret = media_player_start(ml->rec_player);
if (!ret)
ilog(LOG_WARN, "Failed to start media player for recording announcement");
}
}
// lock must be held
void recording_start_daemon(call_t *call) {
if (call->recording) {
// already active
recording_update_flags(call, true);
return;
}
if (!spooldir) {
ilog(LOG_ERR, "Call recording requested, but no spool directory configured");
return;
}
ilog(LOG_NOTICE, "Turning on call recording.");
call->recording = g_new0(struct recording, 1);
g_autoptr(char) escaped_callid = g_uri_escape_string(call->callid.s, NULL, 0);
if (!call->recording_meta_prefix.len) {
const int rand_bytes = 8;
char rand_str[rand_bytes * 2 + 1];
rand_hex_str(rand_str, rand_bytes);
g_autoptr(char) meta_prefix = g_strdup_printf("%s-%s", escaped_callid, rand_str);
call->recording_meta_prefix = call_str_cpy(STR_PTR(meta_prefix));
call->recording_random_tag = call_str_cpy(&STR_CONST(rand_str));
}
_rm(init_struct, call);
// update main call flags (global recording/forwarding on/off) to prevent recording
// features from being started when the stream info (through setup_stream) is
// propagated if recording is actually off
recording_update_flags(call, false);
// if recording has been turned on after initial call setup, we must walk
// through all related objects and initialize the recording stuff. if this
// function is called right at the start of the call, all of the following
// is essentially a no-op
for (__auto_type l = call->monologues.head; l; l = l->next) {
struct call_monologue *ml = l->data;
rec_setup_monologue(ml);
}
for (__auto_type l = call->medias.head; l; l = l->next) {
struct call_media *m = l->data;
recording_setup_media(m);
}
for (__auto_type l = call->streams.head; l; l = l->next) {
struct packet_stream *ps = l->data;
recording_setup_stream(ps);
__unkernelize(ps, "recording start");
__reset_sink_handlers(ps);
}
recording_update_flags(call, true);
}
// lock must be held
void recording_start(call_t *call) {
bool was_paused = call->recording && !CALL_ISSET(call, RECORDING_ON);
CALL_SET(call, RECORDING_ON);
// Write resume timestamp to metadata file if resuming a paused recording
if (was_paused && call->recording->pcap.meta_fp) {
time_t now = rtpe_now / 1000000;
char timebuffer[32];
struct tm timeinfo;
if (localtime_r(&now, &timeinfo) != NULL) {
strftime(timebuffer, sizeof(timebuffer), "%FT%T", &timeinfo);
fprintf(call->recording->pcap.meta_fp,
"\nRecording resumed at: %s (%.3lf ms)\n",
timebuffer, rtpe_now / 1000.0);
}
}
recording_start_daemon(call);
}
// lock must be held
void recording_stop_daemon(call_t *call) {
if (!call->recording)
return;
// check if all recording options are disabled
if (CALL_ISSET(call, RECORDING_ON) || CALL_ISSET(call, REC_FORWARDING)) {
recording_update_flags(call, true);
return;
}
for (__auto_type l = call->monologues.head; l; l = l->next) {
struct call_monologue *ml = l->data;
if (ML_ISSET(ml, REC_FORWARDING)) {
recording_update_flags(call, true);
return;
}
}
ilog(LOG_NOTICE, "Turning off call recording.");
recording_finish(call, false);
}
// lock must be held
void recording_stop(call_t *call) {
CALL_CLEAR(call, RECORDING_ON);
recording_stop_daemon(call);
}
// lock must be held
void recording_pause(call_t *call) {
CALL_CLEAR(call, RECORDING_ON);
if (!call->recording)
return;
ilog(LOG_NOTICE, "Pausing call recording.");
// Write pause timestamp to metadata file
if (call->recording->pcap.meta_fp) {
time_t now = rtpe_now / 1000000;
char timebuffer[32];
struct tm timeinfo;
if (localtime_r(&now, &timeinfo) != NULL) {
strftime(timebuffer, sizeof(timebuffer), "%FT%T", &timeinfo);
fprintf(call->recording->pcap.meta_fp,
"\nRecording paused at: %s (%.3lf ms)\n",
timebuffer, rtpe_now / 1000.0);
}
}
recording_update_flags(call, true);
}
// lock must be held
void recording_discard(call_t *call) {
CALL_CLEAR(call, RECORDING_ON);
if (!call->recording)
return;
ilog(LOG_NOTICE, "Turning off call recording and discarding outputs.");
recording_finish(call, true);
}
/**
*
* Controls the setting of recording variables on a `call_t *`.
* Sets the `record_call` value on the `struct call`, initializing the
* recording struct if necessary.
* If we do not yet have a PCAP file associated with the call, create it
* and write its file URL to the metadata file.
*
* Returns a boolean for whether or not the call is being recorded.
*/
void detect_setup_recording(call_t *call, const sdp_ng_flags *flags) {
if (!flags)
return;
const str *recordcall = &flags->record_call_str;
if (!str_cmp(recordcall, "yes") || !str_cmp(recordcall, "on") || flags->record_call) {
// Don't auto-start recording if it's currently paused
// Only start if there's no existing recording or if recording is not paused
if (!call->recording || CALL_ISSET(call, RECORDING_ON))
recording_start(call);
}
else if (!str_cmp(recordcall, "no") || !str_cmp(recordcall, "off"))
recording_stop(call);
else if (!str_cmp(recordcall, "discard") || flags->discard_recording)
recording_discard(call);
else if (recordcall->len != 0)
ilog(LOG_INFO, "\"record-call\" flag "STR_FORMAT" is invalid flag.", STR_FMT(recordcall));
}
static void rec_pcap_init(call_t *call) {
struct recording *recording = call->recording;
// Wireshark starts at packet index 1, so we start there, too
recording->pcap.packet_num = 1;
mutex_init(&recording->pcap.recording_lock);
meta_setup_file(recording, &call->recording_meta_prefix);
// set up pcap file
char *pcap_path = recording_setup_file(recording, &call->recording_meta_prefix);
if (pcap_path != NULL && recording->pcap.recording_pdumper != NULL
&& recording->pcap.meta_fp) {
// Write the location of the PCAP file to the metadata file
fprintf(recording->pcap.meta_fp, "%s\n\n", pcap_path);
}
}
static char *file_path_str(const char *id, const char *prefix, const char *suffix) {
return g_strdup_printf("%s%s%s%s", spooldir, prefix, id, suffix);
}
/**
* Create a call metadata file in a temporary location.
* Attaches the filepath and the file pointer to the call struct.
*/
static char *meta_setup_file(struct recording *recording, const str *meta_prefix) {
if (spooldir == NULL) {
// No spool directory was created, so we cannot have metadata files.
return NULL;
}
char *meta_filepath = file_path_str(meta_prefix->s, "/tmp/rtpengine-meta-", ".tmp");
recording->pcap.meta_filepath = meta_filepath;
FILE *mfp = fopen(meta_filepath, "w");
// coverity[check_return : FALSE]
chmod(meta_filepath, S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP | S_IROTH);
if (mfp == NULL) {
ilog(LOG_ERROR, "Could not open metadata file: %s%s%s", FMT_M(meta_filepath));
g_clear_pointer(&recording->pcap.meta_filepath, free);
return NULL;
}
setvbuf(mfp, NULL, _IONBF, 0);
recording->pcap.meta_fp = mfp;
ilog(LOG_DEBUG, "Wrote metadata file to temporary path: %s%s%s", FMT_M(meta_filepath));
return meta_filepath;
}
/**
* Write out a block of SDP to the metadata file.
*/
static void sdp_after_pcap(struct recording *recording, const str *s, struct call_monologue *ml,
enum ng_opmode opmode)
{
if (!recording)
return;
FILE *meta_fp = recording->pcap.meta_fp;
if (!meta_fp)
return;
if (ml->label.len) {
fprintf(meta_fp, "\nLabel: " STR_FORMAT, STR_FMT(&ml->label));
}
fprintf(meta_fp, "\nTimestamp started ms: ");
fprintf(meta_fp, "%.3lf", ml->started / 1000.);
fprintf(meta_fp, "\nSDP mode: ");
fprintf(meta_fp, "%s", get_opmode_text(opmode));
fprintf(meta_fp, "\nSDP before RTP packet: %" PRIu64 "\n\n", recording->pcap.packet_num);
if (fwrite(s->s, s->len, 1, meta_fp) < 1)
ilog(LOG_WARN, "Error writing SDP body to metadata file: %s", strerror(errno));
}
/**
* Writes metadata to metafile, closes file, and renames it to finished location.
*/
static void rec_pcap_meta_finish_file(call_t *call) {
// This should usually be called from a place that has the call->master_lock
struct recording *recording = call->recording;
if (recording == NULL || recording->pcap.meta_fp == NULL) {
ilog(LOG_INFO, "Trying to clean up recording meta file without a file pointer opened.");
return;
}
// Print start timestamp and end timestamp
// YYYY-MM-DDThh:mm:ss
time_t start = call->created / 1000000;
time_t end = rtpe_now / 1000000;
char timebuffer[20];
struct tm timeinfo;
int64_t terminate;
terminate = (((struct call_monologue *)call->monologues.head->data)->terminated);
fprintf(recording->pcap.meta_fp, "\nTimestamp terminated ms(first monologue): %.3lf", terminate / 1000.);
if (localtime_r(&start, &timeinfo) == NULL) {
ilog(LOG_ERROR, "Cannot get start local time, while cleaning up recording meta file: %s", strerror(errno));
} else {
strftime(timebuffer, 20, "%FT%T", &timeinfo);
fprintf(recording->pcap.meta_fp, "\n\ncall start time: %s\n", timebuffer);
}
if (localtime_r(&end, &timeinfo) == NULL) {
ilog(LOG_ERROR, "Cannot get end local time, while cleaning up recording meta file: %s", strerror(errno));
} else {
strftime(timebuffer, 20, "%FT%T", &timeinfo);
fprintf(recording->pcap.meta_fp, "call end time: %s\n", timebuffer);
}
// Print metadata
if (call->metadata.len)
fprintf(recording->pcap.meta_fp, "\n\n"STR_FORMAT"\n", STR_FMT(&call->metadata));
fclose(recording->pcap.meta_fp);
recording->pcap.meta_fp = NULL;
// Get the filename (in between its directory and the file extension)
// and move it to the finished file location.
// Rename extension to ".txt".
int fn_len;
char *meta_filename = strrchr(recording->pcap.meta_filepath, '/');
char *meta_ext = NULL;
if (meta_filename == NULL) {
meta_filename = recording->pcap.meta_filepath;
}
else {
meta_filename = meta_filename + 1;
}
// We can always expect a file extension
meta_ext = strrchr(meta_filename, '.');
fn_len = meta_ext - meta_filename;
int prefix_len = strlen(spooldir) + 10; // constant for "/metadata/" suffix
int ext_len = 4; // for ".txt"
char new_metapath[prefix_len + fn_len + ext_len + 1];
snprintf(new_metapath, prefix_len+fn_len+1, "%s/metadata/%s", spooldir, meta_filename);
snprintf(new_metapath + prefix_len+fn_len, ext_len+1, ".txt");
int return_code = rename(recording->pcap.meta_filepath, new_metapath);
if (return_code != 0) {
ilog(LOG_ERROR, "Could not move metadata file \"%s\" to \"%s/metadata/\"",
recording->pcap.meta_filepath, spooldir);
} else {
ilog(LOG_INFO, "Moved metadata file \"%s\" to \"%s/metadata\"",
recording->pcap.meta_filepath, spooldir);
}
mutex_destroy(&recording->pcap.recording_lock);
g_clear_pointer(&recording->pcap.meta_filepath, g_free);
}
/**
* Closes and discards all output files.
*/
static void rec_pcap_meta_discard_file(call_t *call) {
struct recording *recording = call->recording;
if (recording == NULL || recording->pcap.meta_fp == NULL)
return;
fclose(recording->pcap.meta_fp);
recording->pcap.meta_fp = NULL;
unlink(recording->pcap.recording_path);
unlink(recording->pcap.meta_filepath);
g_clear_pointer(&recording->pcap.meta_filepath, free);
}
/**
* Generate a random PCAP filepath to write recorded RTP stream.
* Returns path to created file.
*/
static char *recording_setup_file(struct recording *recording, const str *meta_prefix) {
char *recording_path = NULL;
if (!spooldir)
return NULL;
if (recording->pcap.recording_pd || recording->pcap.recording_pdumper)
return NULL;
recording_path = file_path_str(meta_prefix->s, "/pcaps/", ".pcap");
recording->pcap.recording_path = recording_path;
recording->pcap.recording_pd = pcap_open_dead(rec_pcap_format->linktype, 65535);
recording->pcap.recording_pdumper = pcap_dump_open(recording->pcap.recording_pd, recording_path);
if (recording->pcap.recording_pdumper == NULL) {
pcap_close(recording->pcap.recording_pd);
recording->pcap.recording_pd = NULL;
ilog(LOG_INFO, "Failed to write recording file: %s", recording_path);
} else {
ilog(LOG_INFO, "Writing recording file: %s", recording_path);
}
return recording_path;
}
/**
* Flushes PCAP file, closes the dumper and descriptors, and frees object memory.
*/
static void rec_pcap_recording_finish_file(struct recording *recording) {
if (recording->pcap.recording_pdumper != NULL) {
pcap_dump_flush(recording->pcap.recording_pdumper);
pcap_dump_close(recording->pcap.recording_pdumper);
g_clear_pointer(&recording->pcap.recording_path, free);
}
if (recording->pcap.recording_pd != NULL) {
pcap_close(recording->pcap.recording_pd);
}
}
// "out" must be at least inp->len + MAX_PACKET_HEADER_LEN bytes
static unsigned int fake_ip_header(unsigned char *out, struct media_packet *mp, const str *inp) {
endpoint_t *src_endpoint, *dst_endpoint;
if (!rtpe_config.rec_egress) {
src_endpoint = &mp->fsin;
dst_endpoint = &mp->sfd->socket.local;
}
else {
src_endpoint = &mp->sfd->socket.local;
dst_endpoint = &mp->fsin;
}
unsigned int hdr_len =
endpoint_packet_header(out, src_endpoint, dst_endpoint, inp->len);
assert(hdr_len <= MAX_PACKET_HEADER_LEN);
// payload
memcpy(out + hdr_len, inp->s, inp->len);
return hdr_len + inp->len;
}
static void rec_pcap_eth_header(unsigned char *pkt, struct packet_stream *stream) {
memset(pkt, 0, 14);
uint16_t *hdr16 = (void *) pkt;
hdr16[6] = htons(stream->selected_sfd->socket.local.address.family->ethertype);
}
/**
* Write out a PCAP packet with payload string.
* A fair amount extraneous of packet data is spoofed.
*/
static void stream_pcap_dump(struct media_packet *mp, const str *s) {
pcap_dumper_t *pdumper = mp->call->recording->pcap.recording_pdumper;
if (!pdumper)
return;
unsigned char pkt[s->len + MAX_PACKET_HEADER_LEN + rec_pcap_format->headerlen];
unsigned int pkt_len = fake_ip_header(pkt + rec_pcap_format->headerlen, mp, s) + rec_pcap_format->headerlen;
if (rec_pcap_format->header)
rec_pcap_format->header(pkt, mp->stream);
// Set up PCAP packet header
struct pcap_pkthdr header;
ZERO(header);
header.ts = timeval_from_us(rtpe_now);
header.caplen = pkt_len;
header.len = pkt_len;
// Write the packet to the PCAP file
// Casting quiets compiler warning.
pcap_dump((unsigned char *)pdumper, &header, pkt);
}
static void dump_packet_pcap(struct media_packet *mp, const str *s) {
if (ML_ISSET(mp->media->monologue, NO_RECORDING))
return;
if (!CALL_ISSET(mp->call, RECORDING_ON))
return;
struct recording *recording = mp->call->recording;
mutex_lock(&recording->pcap.recording_lock);
stream_pcap_dump(mp, s);
recording->pcap.packet_num++;
mutex_unlock(&recording->pcap.recording_lock);
}
static void finish_pcap(call_t *call, bool discard) {
rec_pcap_recording_finish_file(call->recording);
if (!discard)
rec_pcap_meta_finish_file(call);
else
rec_pcap_meta_discard_file(call);
}
static void response_pcap(struct recording *recording, const ng_parser_t *parser, parser_arg output) {
if (!recording)
return;
if (!recording->pcap.recording_path)
return;
parser_arg recordings = parser->dict_add_list(output, "recordings");
parser->list_add_string(recordings, recording->pcap.recording_path);
}
void recording_finish(call_t *call, bool discard) {
if (!call || !call->recording)
return;
__call_unkernelize(call, "recording finished");
struct recording *recording = call->recording;
_rm(finish, call, discard);
g_free(recording);
call->recording = NULL;
// clear the meta prefix to esure that pcaps for subsequent
// start recordings dont overwrite previous ones
call->recording_meta_prefix = STR_NULL;
}
static int open_proc_meta_file(struct recording *recording) {
int fd;
fd = open(recording->proc.meta_filepath, O_WRONLY | O_APPEND | O_CREAT, 0666);
if (fd == -1) {
ilog(LOG_ERR, "Failed to open recording metadata file '%s' for writing: %s",
recording->proc.meta_filepath, strerror(errno));
return -1;
}
return fd;
}
static int vappend_meta_chunk_iov(struct recording *recording, struct iovec *in_iov, int iovcnt,
unsigned int str_len, const char *label_fmt, va_list ap)
{
int fd = open_proc_meta_file(recording);
if (fd == -1)
return -1;
char label[128];
int lablen = vsnprintf(label, sizeof(label), label_fmt, ap);
char infix[128];
int inflen = snprintf(infix, sizeof(infix), "\n%u:\n", str_len);
// use writev for an atomic write
struct iovec iov[iovcnt + 3];
iov[0].iov_base = label;
iov[0].iov_len = lablen;
iov[1].iov_base = infix;
iov[1].iov_len = inflen;
memcpy(&iov[2], in_iov, iovcnt * sizeof(*iov));
iov[iovcnt + 2].iov_base = "\n\n";
iov[iovcnt + 2].iov_len = 2;
if (writev(fd, iov, iovcnt + 3) != (str_len + lablen + inflen + 2))
ilog(LOG_WARN, "writev return value incorrect");
close(fd); // this triggers the inotify
return 0;
}
static int vappend_meta_chunk(struct recording *recording, const char *buf, unsigned int buflen,
const char *label_fmt, va_list ap)
{
struct iovec iov;
if (!recording->proc.meta_filepath)
return -1;
iov.iov_base = (void *) buf;
iov.iov_len = buflen;
int ret = vappend_meta_chunk_iov(recording, &iov, 1, buflen, label_fmt, ap);
return ret;
}
static int append_meta_chunk(struct recording *recording, const char *buf, unsigned int buflen,
const char *label_fmt, ...)
{
va_list ap;
if (!recording->proc.meta_filepath)
return -1;
va_start(ap, label_fmt);
int ret = vappend_meta_chunk(recording, buf, buflen, label_fmt, ap);
va_end(ap);
return ret;
}
static void proc_init(call_t *call) {
struct recording *recording = call->recording;
recording->proc.call_idx = UNINIT_IDX;
if (!kernel.is_open) {
ilog(LOG_WARN, "Call recording through /proc interface requested, but kernel table not open");
return;
}
recording->proc.call_idx = kernel_add_call(call->recording_meta_prefix.s);
if (recording->proc.call_idx == UNINIT_IDX) {
ilog(LOG_ERR, "Failed to add call to kernel recording interface: %s", strerror(errno));
return;
}
ilog(LOG_DEBUG, "kernel call idx is %u", recording->proc.call_idx);
recording->proc.meta_filepath = file_path_str(call->recording_meta_prefix.s, "/", ".meta");
unlink(recording->proc.meta_filepath); // start fresh XXX good idea?
append_meta_chunk_str(recording, &call->callid, "CALL-ID");
append_meta_chunk_s(recording, call->recording_meta_prefix.s, "PARENT");
append_meta_chunk_s(recording, call->recording_random_tag.s, "RANDOM_TAG");
}
static void sdp_before_proc(struct recording *recording, const str *sdp, struct call_monologue *ml,
enum ng_opmode opmode)
{
if (!recording)
return;
append_meta_chunk_str(recording, sdp,
"SDP from %u before %s", ml->unique_id, get_opmode_text(opmode));
}
static void sdp_after_proc(struct recording *recording, const str *sdp, struct call_monologue *ml,
enum ng_opmode opmode)
{
if (!recording)
return;
append_meta_chunk_str(recording, sdp,
"SDP from %u after %s", ml->unique_id, get_opmode_text(opmode));
}
static void finish_proc(call_t *call, bool discard) {
struct recording *recording = call->recording;
if (!kernel.is_open)
return;
if (recording->proc.call_idx != UNINIT_IDX) {
kernel_del_call(recording->proc.call_idx);
recording->proc.call_idx = UNINIT_IDX;
}
for (__auto_type l = call->streams.head; l; l = l->next) {
struct packet_stream *ps = l->data;
ps->recording.proc.stream_idx = UNINIT_IDX;
}
const char *unlink_fn = recording->proc.meta_filepath;
g_autoptr(char) discard_fn = NULL;
if (discard) {
discard_fn = g_strdup_printf("%s.DISCARD", recording->proc.meta_filepath);
int ret = rename(recording->proc.meta_filepath, discard_fn);
if (ret)
ilog(LOG_ERR, "Failed to rename metadata file \"%s\" to \"%s\": %s",
recording->proc.meta_filepath,
discard_fn,
strerror(errno));
unlink_fn = discard_fn;
}
int ret = unlink(unlink_fn);
if (ret)
ilog(LOG_ERR, "Failed to delete metadata file \"%s\": %s",
unlink_fn, strerror(errno));
g_clear_pointer(&recording->proc.meta_filepath, free);
}
static void init_stream_proc(struct packet_stream *stream) {
stream->recording.proc.stream_idx = UNINIT_IDX;
}
static void setup_stream_proc(struct packet_stream *stream) {
struct call_media *media = stream->media;
struct call_monologue *ml = media->monologue;
call_t *call = stream->call;
struct recording *recording = call->recording;
char buf[128];
int len;
unsigned int media_rec_slot;
unsigned int media_rec_slots;
if (!recording)
return;
if (!kernel.is_open)
return;
if (stream->recording.proc.stream_idx != UNINIT_IDX)
return;
if (ML_ISSET(ml, NO_RECORDING))
return;
ilog(LOG_INFO, "media_rec_slot=%u, media_rec_slots=%u, stream=%u", media->media_rec_slot, call->media_rec_slots, stream->unique_id);
// If no slots have been specified or someone has tried to use slott 0 then we set the variables up so that the mix
// channels will be used in sequence as each SSRC is seen. (see mix.c for the algorithm)
if(call->media_rec_slots < 1 || media->media_rec_slot < 1) {
media_rec_slot = 1;
media_rec_slots = 1;
} else {
media_rec_slot = media->media_rec_slot;
media_rec_slots = call->media_rec_slots;
}
if(media_rec_slot > media_rec_slots) {
ilog(LOG_ERR, "slot %i is greater than the total number of slots available %i, setting to slot %i", media->media_rec_slot, call->media_rec_slots, media_rec_slots);
media_rec_slot = media_rec_slots;
}
len = snprintf(buf, sizeof(buf), "TAG %u MEDIA %u TAG-MEDIA %u COMPONENT %u FLAGS %" PRIu64 " MEDIA-SDP-ID %i MEDIA-REC-SLOT %i MEDIA-REC-SLOTS %i",
ml->unique_id, media->unique_id, media->index, stream->component,
atomic64_get_na(&stream->ps_flags), media->media_sdp_id, media_rec_slot, media_rec_slots);
append_meta_chunk(recording, buf, len, "STREAM %u details", stream->unique_id);
len = snprintf(buf, sizeof(buf), "tag-%u-media-%u-component-%u-%s-id-%u",
ml->unique_id, media->index, stream->component,
(PS_ISSET(stream, RTCP) && !PS_ISSET(stream, RTP)) ? "RTCP" : "RTP",
stream->unique_id);
stream->recording.proc.stream_idx = kernel_add_intercept_stream(recording->proc.call_idx, buf);
if (stream->recording.proc.stream_idx == UNINIT_IDX) {
ilog(LOG_ERR, "Failed to add stream to kernel recording interface: %s", strerror(errno));
return;
}
ilog(LOG_DEBUG, "kernel stream idx is %u", stream->recording.proc.stream_idx);
append_meta_chunk(recording, buf, len, "STREAM %u interface", stream->unique_id);
}
static void setup_monologue_proc(struct call_monologue *ml) {
call_t *call = ml->call;
struct recording *recording = call->recording;
if (!recording)
return;
if (ML_ISSET(ml, NO_RECORDING))
return;
append_meta_chunk_str(recording, &ml->tag, "TAG %u", ml->unique_id);
update_metadata_monologue_only(ml, NULL);
}
static void setup_media_proc(struct call_media *media) {
call_t *call = media->call;
struct recording *recording = call->recording;
if (!recording)
return;
if (ML_ISSET(media->monologue, NO_RECORDING))
return;
append_meta_chunk_null(recording, "MEDIA %u PTIME %i", media->unique_id, media->ptime);
codecs_ht_iter iter;
t_hash_table_iter_init(&iter, media->codecs.codecs);
rtp_payload_type *pt;
while (t_hash_table_iter_next(&iter, NULL, &pt)) {
append_meta_chunk(recording, pt->encoding_with_params.s, pt->encoding_with_params.len,
"MEDIA %u PAYLOAD TYPE %u", media->unique_id, pt->payload_type);
append_meta_chunk(recording, pt->format_parameters.s, pt->format_parameters.len,
"MEDIA %u FMTP %u", media->unique_id, pt->payload_type);
}
}
static void dump_packet_proc(struct media_packet *mp, const str *s) {
struct packet_stream *stream = mp->stream;
if (stream->recording.proc.stream_idx == UNINIT_IDX)
return;
if (!CALL_ISSET(mp->call, RECORDING_ON))
return;
struct rtpengine_command_packet *cmd;
unsigned char pkt[sizeof(*cmd) + s->len + MAX_PACKET_HEADER_LEN];
cmd = (void *) pkt;
cmd->cmd = REMG_PACKET;
//remsg->packet.call_idx = stream->call->recording->proc.call_idx; // unused
cmd->packet.stream_idx = stream->recording.proc.stream_idx;
unsigned int pkt_len = fake_ip_header(cmd->packet.data, mp, s);
pkt_len += sizeof(*cmd);
int ret = write(kernel.fd, pkt, pkt_len);
if (ret < 0)
ilog(LOG_ERR, "Failed to submit packet to kernel intercepted stream: %s", strerror(errno));
}
static void kernel_info_proc(struct packet_stream *stream, struct rtpengine_target_info *reti) {
if (!stream->call->recording)
return;
if (stream->recording.proc.stream_idx == UNINIT_IDX)
return;
ilog(LOG_DEBUG, "enabling kernel intercept with stream idx %u", stream->recording.proc.stream_idx);
reti->do_intercept = 1;
reti->intercept_stream_idx = stream->recording.proc.stream_idx;
}
static void meta_chunk_proc(struct recording *recording, const char *label, const str *data) {
append_meta_chunk_str(recording, data, "%s", label);
}
static int create_spool_dir_all(const char *spoolpath) {
int ret1, ret2;
ret1 = rec_pcap_create_spool_dir(spoolpath);
ret2 = check_main_spool_dir(spoolpath);
if (ret1 == FALSE || ret2 == FALSE) {
return FALSE;
}
return TRUE;
}
static void init_all(call_t *call) {
rec_pcap_init(call);
proc_init(call);
}
static void sdp_after_all(struct recording *recording, const str *s, struct call_monologue *ml,
enum ng_opmode opmode)
{
sdp_after_pcap(recording, s, ml, opmode);
sdp_after_proc(recording, s, ml, opmode);
}
static void dump_packet_all(struct media_packet *mp, const str *s) {
dump_packet_pcap(mp, s);
dump_packet_proc(mp, s);
}
static void finish_all(call_t *call, bool discard) {
finish_pcap(call, discard);
finish_proc(call, discard);
}
|