Toolpack:Configuring lawful interception A

From TBwiki
(Difference between revisions)
Jump to: navigation, search
(Testing anchors)
(standardize parameters link name)
 
(46 intermediate revisions by 3 users not shown)
Line 1: Line 1:
Lawful Intercept configuration in [[Toolpack]] Web Portal is made with the following steps:
+
=== '''''Applies to version(s): v2.7''''' ===
# Configuring a Law Enforcement Agency and it's parameters
+
{{DISPLAYTITLE:Configuring Lawful Interception}}
# Creating of a NAP connected to the Law Enforcement Agency
+
# Providing a list of targets to intercept (through a coma-separate-values .csv file)
+
# Enabling the Lawful Intercept routing script filter
+
# Exchanging SSH public/private keys with server to allow password-less SFTP
+
  
Here is how these steps are performed using Toolpack Web Portal.
 
  
= Configuring a Law Enforcement Agency and it's parameters =
 
* Log into the Web Portal
 
* Go to the left menu of the Web Portal
 
* Click the "Lawful Intercept" section, under "Gateway"
 
  
This page contains global Lawful Intercept parameters, and a list of Law Enforcement Agencies.
+
'''Note:''' This procedure assumes that a Law Enforcement Agencies NAP has been created. Each Law Enforcement Agencies requires that a NAP be configured in order that the intercepted call legs are sent. NAPs can be dedicated for lawful interceptions or not.
  
[[Image:lawful_configuration_shot.PNG]]
 
  
Available parameter are:
 
* NWO (Network Operator) Identifier:  An internationally unique identifier that represents the network operator, access provider or service provider using the [[Tmedia]] equipment
 
  
== Law Enforcement Agency parameters ==
+
Multiple Law Enforcement Agencies can be created in [[Toolpack]]. They operate independently of each other. They can intercept the same calls, as well as different ones.
Multiple Law Enforcement Agencies can be created in [[Toolpack]]. Each act in an independent manner from the others, and can intercept the same calls, or different calls.
+
  
[[Image:lawful_agency_shot.PNG]]
+
'''To configure a Law Enforcement Agency:'''
  
Each Law Enforcement Agency has the following parameters:
+
1- Select '''Lawful Interception''' from the navigation panel
* Name
+
* .csv file that contains the list of targets to intercept
+
* NAP to use for making outgoing calls to Law Enforcement Agency, carrying audio for intercepted call legs
+
* Configuration of FTP/SFTP client for uploading IRI (Intercept Related Information) records to Law Enforcement Agency's FTP or SFTP server:
+
** IP address or domain name of the FTP/SFTP server
+
** User name to use for FTP/SFTP server login
+
** Password to use for FTP/SFTP server login
+
** Remote directory to store IRI records into
+
** FTP/SFTP connection timeout
+
** Maximum number of IRI entries in the upload queue
+
** Maximum time a IRI entry can remain in the upload queue
+
  
= Creating of a NAP connected to the Law Enforcement Agency =
+
[[Image:Toolpack_Navigation_LawfulInterception_A.png]]
Create a NAP, like would normally be done with [[Toolpack]]. The ETSI specifications refer to ISDN NAP, but other type of NAPs are also supported by TelcoBridges. This NAP must be connected to the Law Enforcement Agency that will receive the intercepted calls.
+
  
Documentation on NAPs creation can be found here: [[Toolpack_v2.3:Creating_a_NAP|Creating a NAP]]
+
2- Enter an Indentifier for the Network Operator.
 +
* Click '''Save'''
  
= Providing a list of targets to intercept (through a coma-separate-values .csv file) =
+
3- Create a Lawful Agency
 +
* Click '''Create New Lawful Agency'''
  
== Uploading/modifying Lawful Intercept Targets configuration files (.csv) ==
 
The list of targets to intercept is provided as a .csv file. Each configured Law Enforcement Agency points to it's own .csv file.
 
  
The .csv file is uploaded from the Web Portal:
+
[[Image:Lawful_configuration_shot.png]]
* Log into the Web Portal
+
* Go to the left menu of the Web Portal
+
* Click the "File Db" section, under "Gateway"
+
* Edit one of the listed File Db, or click "Create New File Db" to create a new one
+
* Under section "Lawful Intercept Targets", click "import" (to create new file) or "update" one of the existing files
+
  
[[Image:file_db_shot.PNG]]
+
4- Configure the Lawful Agency parameters:
 +
* Click '''Save'''.
  
To activate a .csv file, go to the Law Enforcement Agency configuration page (left menu, "Lawful Intercept" under "Gateway), and select the .csv file in the appropriate Law Enforcement Agency's configuration page.
 
  
[[Image:file_db_selection_shot.PNG]]
+
[[Image:lawful_agency_shot.png]]
  
== Format Lawful Intercept Targets configuration files (.csv) ==
 
The Lawful Intercept Targets configuration files must be formatted in .csv (coma-separated values) format. The following columns must be present:
 
* liid:  Text string that uniquely identifies the target to intercept. This ID will be provided with each outgoing call on interception NAP to the Law Enforcement Agency, and in each IRI record uploaded to the FTP/SFTP server.
 
* number: The phone number of the target to intercept.  Any call with this number as the calling, or the called number, will be intercepted.
 
* start: (optional) Starting date/time from which the interception can take place. Calls made before that date from/to the target won't be intercepted.
 
* end: (optional) End date/time where this target interception ends. Calls made after that date from/to the target won't be intercepted.
 
  
'''*** Warning: The column names are case sensitive'''
+
==List of Parameters==
  
Example:
+
* [[Parameter: LI_Name|Name]]
  liid,number,start,end
+
* [[Parameter: FTP Server Address|FTP Server Address]]
  John Smith,5550001,2012-10-24T00:00:00-05:00,2012-10-24T23:59:59-05:00
+
* [[Parameter: FTP User Name|FTP User Name]]
  Joe Dalton,14503333007,2012-01-01T00:00:00-05:00,2012-12-31T23:59:59-05:00
+
* [[Parameter: FTP Server Password|FTP Server Password]]
 
+
* [[Parameter: FTP Server Directory|FTP Server Directory]]
= Enabling the Lawful Intercept routing script filter =
+
* [[Parameter: IRI Records Queue Length|IRI Records Queue Length]]
Interpretation of the Lawful Intercept Targets configuration files (.csv) is done by a routing script filter, that can easily be added to any existing routing script used by the [[Toolpack]] system.
+
* [[Parameter: IRI Upload Mode|IRI Upload Mode]]
 
+
* [[Parameter: Maximum grouped file delay before upload|Maximum grouped file delay before upload]]
Documentation on routing script can be found here: [[Scriptable_Routing_Engine|Scriptable Routing Engine]]
+
* [[Parameter: Maximum grouped file upload size|Maximum grouped file upload size]]
 
+
* [[Parameter: File name prefix|File name prefix]]
== Installing missing ruby 'gem' ==
+
The Lawful Intercept filter script requires the 'json' ruby gem.
+
TMedia units ([[TMG800]], [[TMG3200]], [[TMG7800]]) provided by TelcoBridges are now shipped with that 'gem' already installed.
+
 
+
If you have an older TMedia, or if you are using your own host, please validate that the host has the 'json' gem already installed:
+
  gem list --local
+
 
+
In case it's missing, you can install it from a shell:
+
  gem install json
+
 
+
== Including the Lawful Intercept filter script ==
+
The Lawful Intercept filter is activated by:
+
* Including the 'Lawful intercept' module in your routing script: '''''require 'base_routing''''''
+
* Include the LawfulIntercept class: '''''include LawfulIntercept'''''
+
* Add the Lawful Intercept "after_filter" to your script: '''''after_filter :method => :enable_lawful_intercept'''''
+
 
+
== Example script ==
+
<div id="test_anchor"></div>
+
Here is an example "simple routing" script that enables Lawful Intercept:
+
 
+
require 'base_routing'
+
+
# Insert following line ===================>
+
require 'lawful_intercept'
+
+
class SimpleRouting < BaseRouting
+
  # Insert following line ===================>
+
  include LawfulIntercept
+
 
+
  route_match :call_field_name => :called
+
  route_match :call_field_name => :calling
+
  route_match :call_field_name => :nap
+
  route_remap :call_field_name => :called, :route_field_name => :remapped_called
+
  route_remap :call_field_name => :calling, :route_field_name => :remapped_calling
+
  route_remap :call_field_name => :nap, :route_field_name => :remapped_nap
+
 
+
  # Insert following line ===================>
+
  after_filter :method => :enable_lawful_intercept
+
end
+
+
@@routing = SimpleRouting.new
+
+
def init_routes( routes )
+
  @@routing.init routes
+
end
+
+
def route( call, nap_list )
+
  @@routing.route call, nap_list
+
end
+
 
+
= Exchanging SSH public/private keys with server to allow password-less SFTP =
+
Toolpack can use the secure FTP (SFTP) protocol to upload IRI records to a remote server.
+
 
+
Please read the following documentation:
+
*[[configuring_lawful_interception_ssh|Configure IRI (Intercept Related Information) records for SFTP upload]]
+
 
+
 
+
[[category:Needs revising]]
+

Latest revision as of 15:03, 27 June 2013

Applies to version(s): v2.7

Note: This procedure assumes that a Law Enforcement Agencies NAP has been created. Each Law Enforcement Agencies requires that a NAP be configured in order that the intercepted call legs are sent. NAPs can be dedicated for lawful interceptions or not.


Multiple Law Enforcement Agencies can be created in Toolpack. They operate independently of each other. They can intercept the same calls, as well as different ones.

To configure a Law Enforcement Agency:

1- Select Lawful Interception from the navigation panel

Toolpack Navigation LawfulInterception A.png

2- Enter an Indentifier for the Network Operator.

  • Click Save

3- Create a Lawful Agency

  • Click Create New Lawful Agency


Lawful configuration shot.png

4- Configure the Lawful Agency parameters:

  • Click Save.


Lawful agency shot.png


List of Parameters

Personal tools