Add ability to generate pcap files

Owned by John Shaheen
Last updated: 13.10.2022 by Stephen HoogerhydeVersion comment
Target releaseTBD
Epic BRKT-37 - Getting issue details... STATUS
JIRA FR BRKT-342 - Getting issue details... STATUS  
Document statusDRAFT
Document owner

John Shaheen

Designer
Developers
QA

Goals

  • Add the capability into the SR140 to capture packet traffic for debugging or TSS purposes.

Background and strategic fit

The current debugging process for issues includes installing Wireshark on the customers system to perform packet capturing. These packet capture files in a pcap format are captured by the team as a way to debug field issues. Some customers are wary of installing packet sniffing tools on to their network. This feature request is to build packet capturing functionality into the SR140 and to be able to configure the product to perform the packet capture.  The first phase will allow to capture all traffic to a file.  Future enhancements to this feature will allow a user to set filters and/or enable capturing at run-time.

Assumptions

  • Will be able to install WinPcap on to the users system.

Requirements

#TitleUser StoryImportance
1Perform Packet Capture

Enable SR140 product to capture packet traffic on the system to a file. 

Support under Windows and Linux.

The winpcap library is not a requirement to run the boston host service.  The system must be able to perform
normally if the library is not present even if the product is configured for capturing.   There shall be no dependency on
whether the winpcap library is installed on the product.

Must Have
2Launch Button

Provide the use a launch button from the config tool to start the packet capture as we do with the license manager.  

If the WinPcap library is not currently installed on the system, this launch button will launch the installation of the
WinPcap library.  The WinPcap library may have been installed previously on the target system from either the SR140
or from another installation.  Once the library is installed, it may require the system to be rebooted.

Nice to have: Ability to start/stop the packet capture at run-time without restarting boston host service.

Nice to have: Ability to start/stop the packet capture from an application. Do not want to use brktcctrace for this functionality.
Review Debug_control functionality located in bfv.api/bapp.src.

 

 


 

3 Logging File

Logging will take place to a ring of files in the pcap format.
This ring buffer usage would be the same as other logging performed by the product. 

 

 
 4Packet Capture 

Capture all packets to the system to the configure file. 

Ability to configure a filter string for what is captured.  WinPcap uses a low level filter.  To capture SIP you need to specify
capturing UDP packets on port 5060.

Nice to have: Checkbox for filters to turn on SIP/H.323, RTP, T.38 etc. These checkboxes would be on by default.

 

 
    

User interaction and design

Questions

Below is a list of questions to be addressed as a result of this requirements document:

QuestionOutcome

Not Doing