Sip headers manipulation - Revision history

Allyntree: added display title

2023-03-13T17:44:05Z

added display title

← Older revision		Revision as of 13:44, 13 March 2023
Line 1:		Line 1:
	{{DISPLAYTITLE:SIP ~~headers manipulation~~}}		{{DISPLAYTITLE:SIP Headers Manipulation}}

	The behavior 'SIP headers manipulation' allows SBC users to freely add, remove and modify the sip headers when SBC forwards the received invite, 18x and 200 SIP messages (there are limitations, please refer to the limitations section below).		The behavior 'SIP headers manipulation' allows SBC users to freely add, remove and modify the sip headers when SBC forwards the received invite, 18x and 200 SIP messages (there are limitations, please refer to the limitations section below).

Allyntree: minor edits

2023-03-13T17:43:22Z

minor edits

← Older revision		Revision as of 13:43, 13 March 2023
Line 1:		Line 1:
	The behavior 'SIP headers manipulation' allows ~~the~~ SBC users to freely add ,remove and modify the sip headers when SBC forwards the received invite, 18x and 200 ~~sip~~ messages (there are limitations, please refer to the limitations section below).		{{DISPLAYTITLE:SIP headers manipulation}}

			The behavior 'SIP headers manipulation' allows SBC users to freely add, remove and modify the sip headers when SBC forwards the received invite, 18x and 200 SIP messages (there are limitations, please refer to the limitations section below).

	== Configuration: ==		== Configuration: ==
Line 55:		Line 57:
	== Limitations: ==		== Limitations: ==

	# 'SIP headers manipulation' can only affect SIP headers ~~who~~ are not already modified/generated by the other SBC behaviors, see example below.		# 'SIP headers manipulation' can only affect SIP headers that are not already modified/generated by the other SBC behaviors, see example below.
	# Header values are viewed as a constant string~~, the~~ routing script cannot pass ~~variable~~ to SBC.		# Header values are viewed as a constant string. The routing script cannot pass variables to SBC.
	# If the manipulated header is already present, it will be overwritten.		# If the manipulated header is already present, it will be overwritten.
	# Manipulate headers hash can only be set once per call (on the incoming invite message). It is not possible to update the hash later during the call.		# Manipulate headers hash can only be set once per call (on the incoming invite message). It is not possible to update the hash later during the call.

Luc Morissette: Added category FAQ

2023-01-11T14:32:36Z

Added category FAQ

← Older revision		Revision as of 10:32, 11 January 2023
Line 135:		Line 135:
	Warning		Warning
	WWW-Authenticate		WWW-Authenticate


			[[category:FAQ]]

Song tao xie at 16:33, 25 August 2020

2020-08-25T16:33:15Z

← Older revision		Revision as of 12:33, 25 August 2020
Line 46:		Line 46:

	call["behaviorrbt"] = {}		call["behaviorrbt"] = {}
			#if set call["behaviorrbt"]["18x"] as 'no', sbc will not generate ring back tone
	call["behaviorrbt"]["18x"] = "yes"		call["behaviorrbt"]["18x"] = "yes"

Song tao xie at 16:16, 25 August 2020

2020-08-25T16:16:49Z

← Older revision		Revision as of 12:16, 25 August 2020
Line 45:		Line 45:
	call[:manipulation]["200"][:TEST] = "STXIE"		call[:manipulation]["200"][:TEST] = "STXIE"

	params		call["behaviorrbt"] = {}
			call["behaviorrbt"]["18x"] = "yes"

			params
	end		end

Song tao xie at 12:14, 16 August 2020

2020-08-16T12:14:47Z

← Older revision		Revision as of 08:14, 16 August 2020
Line 41:		Line 41:
	#don't like "matchandreplace:inactive\|JF,sendrecv\|inactive", we don't support several possible patterns for now		#don't like "matchandreplace:inactive\|JF,sendrecv\|inactive", we don't support several possible patterns for now


	call[:manipulation]["200"]["P-Charging-Vector"] = "PCV"		call[:manipulation]["200"]["P-Charging-Vector"] = "PCV"
	call[:manipulation]["200"][:banana] = "yellow"		call[:manipulation]["200"][:banana] = "yellow"
	call[:manipulation]["200"][:TEST] = "STXIE"		call[:manipulation]["200"][:TEST] = "STXIE"

	params		params

Song tao xie at 12:13, 16 August 2020

2020-08-16T12:13:22Z

@@ Line 30: / Line 30: @@
      call[:manipulation]["18x"][:salad] = "green"
      call[:manipulation]["200"]["P-Charging-Vector"] = "PCV"
      call[:manipulation]["200"][:banana] = "yellow"

Cbilodeau: sort headers alphabetically

2020-08-07T17:29:31Z

sort headers alphabetically

← Older revision		Revision as of 13:29, 7 August 2020
Line 48:		Line 48:

	=== Headers that cannot be used in 'SIP headers manipulation': ===		=== Headers that cannot be used in 'SIP headers manipulation': ===
	- Accept		Accept
	- Accept-Encoding		Accept-Contact
	- Accept-Language		Accept-Encoding
	- Alert-Info		Accept-Language
	- Allow		Alert-Info
	- ~~Authorization~~		Allow
	- Authentication-Info		Allow-Events
	~~- Also~~		Also
	- Call-ID		Anonymity
	- Call-Info		Authentication-Info
	- Contact		Authorization
	- Content-Disposition		Call-ID
	- Content-Encoding		Call-Info
	- Content-Language		Contact
	- Content-Length		Content-Disposition
	- Content-Type		Content-Encoding
	- CSeq		Content-Language
	- Date		Content-Length
	- Encryption		Content-Type
	- Error-Info		CSeq
	- Expires		Date
	- From		Encryption
	- In-Reply-To		Error-Info
	- Max-Forwards		Event
	- MIME-version		Expires
	- Min-Expires		From
	- Organization		In-Reply-To
	- ~~Priority~~		Max-Forwards
	- ~~Proxy-Authenticate~~		MIME-version
	- ~~Proxy~~-Authorization		Min-Expires
	- ~~Proxy~~-~~Require~~		Min-SE
	~~- Record-Route~~		Organization
	~~- Reply-To~~		P-Asserted-Identity
	- ~~Require~~		P-Media-Authorization
	- ~~Response-Key~~		P-Preferred-Identity
	- ~~Retry-After~~		Priority
	~~- Route~~		Privacy
	~~- Server~~		Proxy-Authenticate
	~~- Subject~~		Proxy-Authorization
	~~- Supported~~		Proxy-Require
	~~- Timestamp~~		RAck
	~~- To~~		Reason
	~~- Unsupported~~		Record-Route
	~~- User-Agen~~		Refer-To
	~~- Via~~		Referred-By
	- RAck		Reject-Contact
	~~- RSeq~~		Remote-Party-ID
	- ~~Warning~~		Replaces
	~~- WWW-Authenticate~~		Reply-To
	~~- Event~~		Request-Disposition
	~~- Allow-Events~~		Require
	- Refer-To		Response-Key
	- Referred-By		Retry-After
	- ~~Replaces~~		Route
	- ~~Session~~-~~Expires~~		RPID-Privacy
	- ~~Min-SE~~		RSeq
	- Request-Disposition		Security-Client
	- ~~Accept-Contact~~		Security-Server
	- ~~Reject-Contact~~		Security-Verify
	~~- Anonymity~~		Server
	- RPID-Privacy		Service-Route
	~~- Remote-Party-ID~~		Session-Expires
	~~- Subscription-State~~		Subject
	- Security-Client		Subscription-State
	- Security-Server		Supported
	- Security-Verify		Timestamp
	- ~~Reason~~		To
	- P-~~Media-Authorization~~		Unsupported
	- ~~Privacy~~		User-Agen
	~~- P-Asserted-Identity~~		Via
	~~- P-Preferred-Identity~~		Warning
	- ~~Service-Route~~		WWW-Authenticate

Cbilodeau: fix format

2020-08-07T16:37:12Z

fix format

← Older revision		Revision as of 12:37, 7 August 2020
Line 1:		Line 1:
	The behavior 'SIP headers manipulation' allows the SBC users to freely add ,remove and modify the sip headers when SBC forwards the received invite, 18x and 200 sip messages (there are limitations, please refer to the limitations section below).		The behavior 'SIP headers manipulation' allows the SBC users to freely add ,remove and modify the sip headers when SBC forwards the received invite, 18x and 200 sip messages (there are limitations, please refer to the limitations section below).

	Configuration:		== Configuration: ==
	To use the behavior, you need to select the option "Enable SIP headers manipulation" under the path "Gateway -> Advanced Parameters" and use the filter script "sip_headers_manipulation.rb" in routing script setting.		To use the behavior, you need to select the option "Enable SIP headers manipulation" under the path "Gateway -> Advanced Parameters" and use the filter script "sip_headers_manipulation.rb" in routing script setting.

	Usage:		== Usage: ==
	The manipulation actions are based on what are defined in "sip_headers_manipulation.rb" dynamically or statically. In sip_headers_manipulation.rb, there is filter_sip_headers_manipulation that should be applied as 'after filter' in main script and need to use call[:manipulation] to save what you want SBC to do regarding headers manipulation. An example is :		The manipulation actions are based on what are defined in "sip_headers_manipulation.rb" dynamically or statically. In sip_headers_manipulation.rb, there is filter_sip_headers_manipulation that should be applied as 'after filter' in main script and need to use call[:manipulation] to save what you want SBC to do regarding headers manipulation. An example is :

Line 38:		Line 38:


	Limitations:		== Limitations: ==

			# 'SIP headers manipulation' can only affect SIP headers who are not already modified/generated by the other SBC behaviors, see example below.
			# Header values are viewed as a constant string, the routing script cannot pass variable to SBC.
			# If the manipulated header is already present, it will be overwritten.
			# Manipulate headers hash can only be set once per call (on the incoming invite message). It is not possible to update the hash later during the call.
			# SIP header in Re-invite and 200 OK attached to Re-invite cannot be affected by this behavior.

	~~1.'SIP headers manipulation' can only affect SIP headers who are not already modified/generated by the other SBC behaviors, see example below.~~
	~~2.Header values are viewed as a constant string, the routing script cannot pass variable to SBC.~~
	~~3. If the manipulated header is already present, it will be overwritten.~~
	~~4. Manipulate headers hash can only be set once per call (on the incoming invite message). It is not possible to update the hash later during the call.~~
	~~5. SIP header in Re-invite and 200 OK attached to Re-invite cannot be affected by this behavior.~~


	~~Headers:~~
	~~-Can be modified in 'SIP headers manipulation'.~~
	~~- All X- headers~~
	~~- Most P- headers? (except P-Asserted-Identity)~~

			=== Headers that cannot be used in 'SIP headers manipulation': ===
	~~-Cannot not~~ be used in 'SIP headers manipulation'
	- Accept		- Accept
	- Accept-Encoding		- Accept-Encoding

Song tao xie at 17:02, 5 August 2020

2020-08-05T17:02:20Z

← Older revision		Revision as of 13:02, 5 August 2020
Line 39:		Line 39:

	Limitations:		Limitations:
	-'SIP headers manipulation' can only affect SIP headers who are not already modified/generated by the other SBC behaviors, see ~~examples~~ below.
	-Header values are viewed as a constant string, the routing script cannot pass variable to SBC.		1.'SIP headers manipulation' can only affect SIP headers who are not already modified/generated by the other SBC behaviors, see example below.
	-If the manipulated header is already present, it will be overwritten.		2.Header values are viewed as a constant string, the routing script cannot pass variable to SBC.
	-Manipulate headers hash can only be set once per call (on the incoming invite message). It is not possible to update the hash later during the call.		3. If the manipulated header is already present, it will be overwritten.
	-SIP header in Re-invite and 200 OK attached to Re-invite cannot be affected by this behavior.		4. Manipulate headers hash can only be set once per call (on the incoming invite message). It is not possible to update the hash later during the call.
			5. SIP header in Re-invite and 200 OK attached to Re-invite cannot be affected by this behavior.