mirror of
https://github.com/asterisk/asterisk.git
synced 2025-09-04 11:58:52 +00:00
e06a23681c
At one point in time, it seemed like a good idea to use the Asterisk
channel name as the HEP correlation UUID. In particular, it felt like
this would be a useful identifier to tie PJSIP messages and RTCP
messages together, along with whatever other data we may eventually send
to Homer. This also had the benefit of keeping the correlation UUID
channel technology agnostic.
In practice, it isn't as useful as hoped, for two reasons:
1) The first INVITE request received doesn't have a channel. As a
result, there is always an 'odd message out', leading it to be
potentially uncorrelated in Homer.
2) Other systems sending capture packets (Kamailio) use the SIP Call-ID.
This causes RTCP information to be uncorrelated to the SIP message
traffic seen by those capture nodes.
In order to support both (in case someone is trying to use res_hep_rtcp
with a non-PJSIP channel), this patch adds a new option, uuid_type, with
two valid values - 'call-id' and 'channel'. The uuid_type option is used
by a module to determine the preferred UUID type. When available, that
source of a correlation UUID is used; when not, the more readily available
source is used.
For res_hep_pjsip:
- uuid_type = call-id: the module uses the SIP Call-ID header value
- uuid_type = channel: the module uses the channel name if available,
falling back to SIP Call-ID if not
For res_hep_rtcp:
- uuid_type = call-id: the module uses the SIP Call-ID header if the
channel type is PJSIP and we have a channel,
falling back to the Stasis event provided
channel name if not
- uuid_type = channel: the module uses the channel name
ASTERISK-25352 #close
Change-Id: Ide67e59a52d9c806e3cc0a797ea1a4b88a00122c
126 lines
3.5 KiB
C
126 lines
3.5 KiB
C
/*
|
|
* Asterisk -- An open source telephony toolkit.
|
|
*
|
|
* Copyright (C) 1999 - 2014, Digium, Inc.
|
|
*
|
|
* Alexandr Dubovikov <alexandr.dubovikov@sipcapture.org>
|
|
* Matt Jordan <mjordan@digium.com>
|
|
*
|
|
* See http://www.asterisk.org for more information about
|
|
* the Asterisk project. Please do not directly contact
|
|
* any of the maintainers of this project for assistance;
|
|
* the project provides a web site, mailing lists and IRC
|
|
* channels for your use.
|
|
*
|
|
* This program is free software, distributed under the terms of
|
|
* the GNU General Public License Version 2. See the LICENSE file
|
|
* at the top of the source tree.
|
|
*/
|
|
|
|
/*!
|
|
* \file
|
|
* \brief Routines for integration with Homer using HEPv3
|
|
*
|
|
* \author Alexandr Dubovikov <alexandr.dubovikov@sipcapture.org>
|
|
* \author Matt Jordan <mjordan@digium.com>
|
|
*
|
|
*/
|
|
|
|
#ifndef _ASTERISK_RES_HEPV3_H
|
|
#define _ASTERISK_RES_HEPV3_H
|
|
|
|
#if defined(__cplusplus) || defined(c_plusplus)
|
|
extern "C" {
|
|
#endif
|
|
|
|
#include "asterisk/netsock2.h"
|
|
|
|
/*! \brief HEPv3 Packet Capture Types */
|
|
enum hepv3_capture_type {
|
|
HEPV3_CAPTURE_TYPE_SIP = 0x01,
|
|
HEPV3_CAPTURE_TYPE_H323 = 0x02,
|
|
HEPV3_CAPTURE_TYPE_SDP = 0x03,
|
|
HEPV3_CAPTURE_TYPE_RTP = 0x04,
|
|
HEPV3_CAPTURE_TYPE_RTCP = 0x05,
|
|
HEPV3_CAPTURE_TYPE_MGCP = 0x06,
|
|
HEPV3_CAPTURE_TYPE_MEGACO = 0x07,
|
|
HEPV3_CAPTURE_TYPE_M2UA = 0x08,
|
|
HEPV3_CAPTURE_TYPE_M3UA = 0x09,
|
|
HEPV3_CAPTURE_TYPE_IAX = 0x10,
|
|
};
|
|
|
|
enum hep_uuid_type {
|
|
HEP_UUID_TYPE_CALL_ID = 0,
|
|
HEP_UUID_TYPE_CHANNEL,
|
|
};
|
|
|
|
/*! \brief HEPv3 Capture Info */
|
|
struct hepv3_capture_info {
|
|
/*! The source address of the packet */
|
|
struct ast_sockaddr src_addr;
|
|
/*! The destination address of the packet */
|
|
struct ast_sockaddr dst_addr;
|
|
/*! The time the packet was captured */
|
|
struct timeval capture_time;
|
|
/*! The actual payload */
|
|
void *payload;
|
|
/*! Some UUID for the packet */
|
|
char *uuid;
|
|
/*! The \ref hepv3_capture_type packet type captured */
|
|
enum hepv3_capture_type capture_type;
|
|
/*! The size of the payload */
|
|
size_t len;
|
|
/*! If non-zero, the payload accompanying this capture info will be compressed */
|
|
unsigned int zipped:1;
|
|
};
|
|
|
|
/*!
|
|
* \brief Create a \ref hepv3_capture_info object
|
|
*
|
|
* This returned object is an ao2 reference counted object.
|
|
*
|
|
* Any attribute in the returned \ref hepv3_capture_info that is a
|
|
* pointer should point to something that is allocated on the heap,
|
|
* as it will be free'd when the \ref hepv3_capture_info object is
|
|
* reclaimed.
|
|
*
|
|
* \param payload The payload to send to the HEP capture node
|
|
* \param len Length of \ref payload
|
|
*
|
|
* \retval A \ref hepv3_capture_info ref counted object on success
|
|
* \retval NULL on error
|
|
*/
|
|
struct hepv3_capture_info *hepv3_create_capture_info(const void *payload, size_t len);
|
|
|
|
/*!
|
|
* \brief Send a generic packet capture to HEPv3
|
|
*
|
|
* \param capture_info Information describing the packet. This
|
|
* should be a reference counted object, created via
|
|
* \ref hepv3_create_capture_info.
|
|
*
|
|
* Once this function is called, it assumes ownership of the
|
|
* \ref capture_info object and steals the reference of the
|
|
* object. Regardless of success or failure, the calling function
|
|
* should assumed that this function will own the object.
|
|
*
|
|
* \retval 0 on success
|
|
* \retval -1 on error
|
|
*/
|
|
int hepv3_send_packet(struct hepv3_capture_info *capture_info);
|
|
|
|
/*!
|
|
* \brief Get the preferred UUID type
|
|
*
|
|
* \since 13.10.0
|
|
*
|
|
* \retval The type of UUID the packet should use
|
|
*/
|
|
enum hep_uuid_type hepv3_get_uuid_type(void);
|
|
|
|
#if defined(__cplusplus) || defined(c_plusplus)
|
|
}
|
|
#endif
|
|
|
|
#endif /* _ASTERISK_RES_HEPV3_H */
|