VoIP Configuration and Forwarding Read Me
Open PDFDocument date: -
Pages: 3
Genre: manual
Banner: SECRET//REL TO USA, FVEY
Classification: SECRET
Dissemination: REL TO USA, FVEY
A SECRET XKeyscore configuration manual describing how to set up the system to intercept internet phone calls, faxes and video calls and forward them to NUCLEON — NSA's voice intercept repository which at time of writing supported over 8,000 users worldwide across 75 servers receiving 700,000 voice, fax, video and tag files per day.
My notes
SECRET//REL TO USA, FVEY
(U) VoIP Configuration and Forwarding Read Me
(U) Overview
(U//FOUO) In the late 1990s, voice over IP (VoIP) emerged as an alternative to the Time Division Multiplexed (TDM) technology for transporting international voice traffic. Since then, VoIP has developed into a widely used technology that accounts for a large percentage of cross-border voice traffic.
(S//SI//REL) NUCLEON is NSAW's signals intelligence voice, facsimile, video and pre-released transcription repository. It supports over 8000 users worldwide and is composed of 75 operational servers receiving 700,000 voice, fax, video, and tag files per day. This Read Me provides procedures for configuring XKEYSCORE to generate and forward VoIP hits to NUCLEON.
(U) Pre-Configuration Requirements
(C//REL) Before configuring xks.config for VoIP processing you must:
- Confirm UTT tasking is in place for the UTT selectors to be used. Please refer to the UTT Configuration Read Me to ensure UTT tasking has been set up.
- Confirm MAILORDER is configured to pick up MAILORDER files from the
$XSCORE_DATA_DIR/outputs/mailorderdirectory on the Master server. To do this, create a MAILORDER ticket to set up the pick-up directory for your Master XKS server:
a. Typego mailorderin the URL field of a browser on a high-side computer.
b. ClickPATHMASTER Remedy Ticketnear the top right of the screen. The Remedy Ticket Submission screen will appear.
c. In the bottom half of the Remedy Ticket Submission screen is two yellow Submit Remedy Ticket buttons. Click the top button of the two. (This ticket pertains to New Data-Flow). The ITSC login screen will appear.
d. Enter the SID of your alternate POC and then clickContinue. A screen containing contact information for you and your POC will appear.
e. Add/Edit the contact information as appropriate and then clickContinueto go to the Data transport service screen.
f. ClickDataflow requestand then clickContinue. The Request for New Data Flow on an Existing Transport System screen will appear.
SECRET//REL TO USA, FVEY
SECRET// REL TO USA, FVEY
g. Enter as much information as you can. In the Data Flow Change Description field, specifically indicate that the pick-up directory should be:
/$XSCORE_DATA_DIR/outputs/mailorder
h. Click Submit. You will receive a confirmation e-mail indicating the ticket has been received and more information may be requested before the ticket can be completed. Overall, the process might take anywhere from a few days to a week to complete.
(C//REL) Configuring xks.config for VoIP Processing
(U) Configuration for VoIP can be accomplished in just three steps:
- (U//FOUO) Log on as the user
oper.
- (U//FOUO) At the command line from within any directory, type
viconfigand then press Enter. Thexks.configfile will open.
- (U//FOUO) In the VoIP Configuration section of
xks.config, set the following configurations:
a.voip = yes: This runs the VoIP workflows.
b.voip mode = site: This indicates that normal site VoIP workflows will run. Other valid values are:overlord: runs workflows for the overlord server to do cross-cluster pairing at the same site.cross_site: runs workflows for the central VoIP server to do cross-site pairing.
c.voip_tasking_site_utt = {default:yes}: This uses UTT tasking from the site SSDM. It assumes you have an SSDM at site that is sending UTT tasking to XKEYSCORE and that you have "utt = yes" in thexks.configfile (see UTT configuration).
d.voip_tasking_site_csv = {default:no}: This controls where VoIP uses csv files from. By default, it uses the csv files from$XSCORE_DIR/config/dictionaries/voip_site.
Note: If you are using target number directory (tnd) tasking, then you must change the setting to yes. Provided tnd=yes in xks.config, the tnd_proc.py script will write a csv file to $XSCORE_DIR/config/dictionaries/voip_site.
e. voip_tasking_royale_file = {default:no} : This controls whether or not config/dictionaries/voip/xkdb_tasking.csv is used. This file represents the legacy way of tasking VoIP, but it is not guaranteed to be completely legal for any site. By default, it is set not to be used and should only be used as a last option when no site-specific tasking is available.
2 |
SECRET// REL TO USA, FVEY
SECRET// REL TO USA, FVEY
f. voip_forward_voice=enable=yes,fdi="FD0",local_fdi="FD1;J:FD2;K:FD3"
This enables forwarding of voice captures. Set the file distribution indicator (fdi) to the MAILORDER trigraph for voice (FD0). Configure local_fdi if you want to route local zip codes to a different fdi. Zip codes that begin with 'L' are forwarded to FD1, zip codes that start with 'J' go to FD2, and zip codes that start with 'K' go to FD3.
g. voip_forward_fax=enable=yes,fdi="DEF",local_fdi="XXX" : This enables forwarding of captured faxes. The file distribution indicator (fdi) should be set to the MAILORDER trigraph for faxes. And, set the local_fdi if you want to route local zip codes that start with 'L' to a different fdi.
h. voip_forward_dictionaries="uttdnr" : This indicates that VoIP forwarding dictionaries will use UTT selectors.
i. csdf_classification = "" : This overrides the default classification of the system. By default this option is commented out, but it can be uncommented and modified.
(U) Additional Processes
(U//FOUO) In addition to editing VoIP configurations in xks.config, it is important to execute several set-up processes. As the oper user, execute the following commands only after entering the VoIP configurations in xks.config:
- (U//FOUO)
xks setup voip: This ensures all VoIP configurations are applied where applicable.
- (U//FOUO)
xks rsync push_config: This pushes any changes to the slaves in the cluster.
- (U//FOUO)
xks proc saferestart: After setup is complete, this restartsprocess_data_parent's for the new configuration to take effect. This process loads all the dictionaries and fingerprints and then performs dictionary scanning, metadata extraction, databasing of metadata, and archival of content. When the parent is finished reloading, it will do a staggered restart of its children based on which slave the parent is running on.
3 |
SECRET// REL TO USA, FVEY