ProSBC:CAPTCHA Authentication - Revision history

Nicole Tan at 21:24, 8 March 2023

2023-03-08T21:24:59Z

Nicole Tan: /* Captcha Call Flow */

2023-03-08T21:22:48Z

Captcha Call Flow

← Older revision		Revision as of 17:22, 8 March 2023
Line 44:		Line 44:

	Upon receiving 302		Upon receiving 302
	4c: ~~ProSBC extracts~~ the ~~CNAM ([V] prefix))~~ in the ~~PAI~~ header of the ~~302, and pass it to~~ the ~~next destination (~~NAP~~) according~~ to the ~~Routes priority order~~		4d: 302 with the captcha.clearip.com in the contact header
	~~Call Source (TDM or SIP)~~ --~~-Invite or SETUP or IAM --->~~ ProSBC~~/TMG ----Invite--> ClearIP~~		ProSBC will send the call the CAPTCHA NAP- captcha.clearip.com
	~~ProSBC/TMG <~~ --~~--302---- ClearIP~~		Captcha will request the caller to enter the code:
	~~ProSBC/TMG ----Invite with CNAM ([V] prefix)) ---Next Routes~~		-- Code entered correctly within the timer; Captcha returns 503. ProSBC will do advance route
			-- Code entered incorrectly 3 times or timeout, Captcha returns 603, call will be dropped

	=ProSBC Configuration=		=ProSBC Configuration=

Nicole Tan: /* Typical Call Flows */

2023-03-08T21:21:37Z

Typical Call Flows

← Older revision		Revision as of 17:21, 8 March 2023
Line 14:		Line 14:
	[[Image:Captcha_CallFlow.jpg\|800px]]		[[Image:Captcha_CallFlow.jpg\|800px]]

	~~==Typical Call Flows==~~
	1. Source of ServiceProvider sends a call to ProSBC.		1. Source of ServiceProvider sends a call to ProSBC.

Nicole Tan at 21:21, 8 March 2023

2023-03-08T21:21:09Z

← Older revision		Revision as of 17:21, 8 March 2023
Line 11:		Line 11:
	=Typical Call Scenarios=		=Typical Call Scenarios=
	This section provides the simplified network diagram with typical call flows.		This section provides the simplified network diagram with typical call flows.
	==Captcha ~~CallFlow~~==		==Captcha Call Flow==
	[[Image:Captcha_CallFlow.jpg\|800px]]		[[Image:Captcha_CallFlow.jpg\|800px]]

	~~[[Image:ClearIP 302 with CNAM.jpg\|800px]]~~

	==Typical Call Flows==		==Typical Call Flows==

Nicole Tan at 21:20, 8 March 2023

2023-03-08T21:20:26Z

← Older revision		Revision as of 17:20, 8 March 2023
Line 11:		Line 11:
	=Typical Call Scenarios=		=Typical Call Scenarios=
	This section provides the simplified network diagram with typical call flows.		This section provides the simplified network diagram with typical call flows.
	==~~Network Diagram~~==		==Captcha CallFlow==
	[[Image:~~ClearIP Verification_CNAM_Robocal Analytics~~.jpg\|800px]]		[[Image:Captcha_CallFlow.jpg\|800px]]

	[[Image:ClearIP 302 with CNAM.jpg\|800px]]		[[Image:ClearIP 302 with CNAM.jpg\|800px]]

Nicole Tan at 22:02, 15 September 2021

2021-09-15T22:02:14Z

← Older revision		Revision as of 18:02, 15 September 2021
Line 58:		Line 58:
	Gateway->Use script: choose the right main script		Gateway->Use script: choose the right main script
	:2. Load routing scripts		:2. Load routing scripts
	*[[:File:~~Transnexus_CNAM_Verification_and_Robocall_Analytics~~.zip\|Click here to download ClearIP_Query.rb (the fitler script) and Main_ClearIP.rb (just to show how the main script should look like) Routing Scripts]]		*[[:File:ClearIP_Query.zip\|Click here to download ClearIP_Query.rb (the fitler script) and Main_ClearIP.rb (just to show how the main script should look like) Routing Scripts]]

	*Import the filter script:		*Import the filter script:

Luc Morissette at 15:35, 3 August 2021

2021-08-03T15:35:45Z

← Older revision		Revision as of 11:35, 3 August 2021
Line 80:		Line 80:
	==Configure ClearIP NAP ==		==Configure ClearIP NAP ==
	NAPs->Create New NAP		NAPs->Create New NAP
	Name->~~NAP_ClEAEIP~~		Name->NAP_CLEARIP
	Proxy address->sip.clearip.com (FQDN of ClearIP-A)		Proxy address->sip.clearip.com (FQDN of ClearIP-A)

Nicole Tan: NT:Created the page

2021-07-15T03:27:29Z

NT:Created the page

New page

{{DISPLAYTITLE:ProSBC Configuration for CAPTCHA Authentication – 302 Redirect with Transnexus ClearIP service}}

=Introduction=
This document provides instructions to configure ProSBC to operate with the TransNexus/ClearIP server for Verification with CNAM and Robocall Analytics.
TransNexus/ClearIP is a SIP redirect server that provides advanced Least Cost Routing (LCR), fraud control and STIR (Secure Telephony Identity Revisited) / SHAKEN (Secure Handling of Asserted information using toKENs) features. <br/>

ProSBC 3.0.90 or a later version is needed to support Verification with CNAM and Robocall Analytics with TransNexus.

*For simple Robocall Mitigation, please check the instruction here: https://docs.telcobridges.com/tbwiki/ProSBC:Robocall_Mitigation

=Typical Call Scenarios=
This section provides the simplified network diagram with typical call flows.
==Network Diagram==
[[Image:ClearIP Verification_CNAM_Robocal Analytics.jpg|800px]]

[[Image:ClearIP 302 with CNAM.jpg|800px]]

==Typical Call Flows==
1. Source of ServiceProvider sends a call to ProSBC.

2. ProSBC forwards the call to ClearIP for Verification with CNAM and Robocall Analytics

3. ClearIP performs Verification, CNAM lookup, Robocall Analytics, then sends one of the following responses to ProSBC

*3a. SIP 404 Not Found: No fraud is detected, not a robocall.

*3b. SIP 503 Service unavailable: No fraud is detected, not a robocall.

*4c. SIP 603 Decline: Fraud is detected, block the call.

*4d. SIP 302 with CNAM ( [V] prefix) in PAI header (P-Asserted-Identity )

4. Upon receiving 404 or 503
4a: - ProSBC returns SIP 503 (or mapping to the TDM cause code) to the Source switch to perform route advance
Call Source (TDM or SIP) --------Invite or SETUP or IAM ---------> ProSBC/TMG ----Invite--> ClearIP
Call Source (TDM or SIP) <---SIP 503 or REL with 41 or 34 -------- ProSBC/TMG < ----503---- ClearIP

4b: - ProSBC route advances on SIP 503 and sends call to next destination, does not return response to the Source switch
Call Source (TDM or SIP) ---Invite or SETUP or IAM ---> ProSBC/TMG ----Invite--> ClearIP
ProSBC/TMG < ----503---- ClearIP
ProSBC/TMG ----Invite---Next Routes
Upon receiving 603
4c: ProSBC returns SIP 603 (or mapping to the TDM cause code) to the Source switch, then release the call
Call Source (TDM or SIP) -----Invite or SETUP or IAM ------> ProSBC/TMG ----Invite--> ClearIP
Call Source (TDM or SIP) <---SIP 603 or REL with 21 -------- ProSBC/TMG < ----603---- ClearIP

Upon receiving 302
4c: ProSBC extracts the CNAM ([V] prefix)) in the PAI header of the 302, and pass it to the next destination (NAP) according to the Routes priority order
Call Source (TDM or SIP) ---Invite or SETUP or IAM ---> ProSBC/TMG ----Invite--> ClearIP
ProSBC/TMG < ----302---- ClearIP
ProSBC/TMG ----Invite with CNAM ([V] prefix)) ---Next Routes

=ProSBC Configuration=
This section provides ProSBC configuration for the solution.
==Configure Routing Script==
ProSBC is configured to use routing script to send some SIP headers to ClearIP to identify the source of the call.
:1. Enable routing script
Gateway->Use script: choose the right main script
:2. Load routing scripts
*[[:File:Transnexus_CNAM_Verification_and_Robocall_Analytics.zip|Click here to download ClearIP_Query.rb (the fitler script) and Main_ClearIP.rb (just to show how the main script should look like) Routing Scripts]]

*Import the filter script:
Gateway->Routes->Routing Script->Import Script File
File->Main_ClearIP.rb
ScriptType->Filter
Load on startup->checked

*Include the filter script to the main script
Gateway->Routes->Routing Script->Edit the main script:
- Add the "require 'ClearIP_Robo' unless defined?(ClearIPQuery)" statement at the top of the main script.
- Add the "include ClearIPQuery" statement in the main routing class.
- Add the filter " before_filter :method => :ClearIP_query" in the main routing class.
==Configure Transport Server for ClearIP NAP ==
SIP -> Create New Transport Server
Name->TS_TCP_5060
Port Type->TCP
Port->5060
IP Interface-> Select the IP interface which can reach to ClearIP on the public network

==Configure ClearIP NAP ==
NAPs->Create New NAP
Name->NAP_ClEAEIP
Proxy address->sip.clearip.com (FQDN of ClearIP-A)

==Configure Routes==

You need to configure other routes after the ClearIP routes if you want ProSBC to perform route advances upon receiving 503 or 302.
Check the below link for the detail instruction to create static routes:
https://docs.telcobridges.com/tbwiki/Toolpack:Creating_a_First_Call_Route_E

It could also combine with other Routeset routing:
https://docs.telcobridges.com/tbwiki/Toolpack:Tsbc_Call_Routes_Settings_3.1#Label_Routing

==Configure Route Retry Action==
Route retry action of 3xx, 404 and 603 must be configured to allow ProSBC to perform failover, fraud control and SHAKEN AS/VS request.
Profiles->Edit Reason Cause Mapping
404 Not found->Route retry action->Continue call
503 Service unavailable->Route retry action->Continue call
603 Decline->Route retry action->Stop call
302 Moved Temporarily-> Route retry action: Process call routing

Notes:
*The default route retry action of 404 is Stop call.
*The default route retry action of 603 is Continue call.