Versions Compared

Old Version 3

changes.mady.by.user Ribbon Communications

Saved on

compared with

New Version Current

changes.mady.by.user Ribbon Communications

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Panel

In this section:

Table of Contents
maxLevel4



Info
iconfalse

Related articles:


Excerpt Include
Services - Privacy Profile
Services - Privacy Profile
nopaneltrue

Info
titleNote

The SBC gives precedence to SIP Privacy handling when the SIP Adaptive Transparency Profile is enabled. For example, if the incoming SIP message contains "privacy: Id" and the flag applyPrivacyId under profiles services privacyProfile is set to enable, the SBC does not include P-ASSERTED-ID header in the egress message. 

The SBC supports privacy profile over GW-GW calls (SBC-SBC GW calls).

For information on SIP Adaptive Transparency Profile, refer to SIP Adaptive Transparency Profile - CLI.

Command Syntax

Code Block
languagenone
% set profiles services privacyProfile <privacyProfile>
	anonymizationValueforHostpart <anonymization string>
	anonymizationValueforUserpart <anonymization string>
	anonymizationValueforDispName <anonymization string>
	applyPrivacyId <disabled | enabled>
	applyPrivacyUser <disabled | enabled | <ifRcvdPrivacyUserOrIdOrBoth>
    passThruPrivacyInfo <disabled | enabled>
    supportPrivacyId <disabled | enabled | ifRcvdPrivacyId>
	supportPrivacyUser <disabled | enabled | ifRcvdPrivacyUser | ifRcvdPrivacyUserOrIdOrBoth>
	useReceivedValues 
		  sipFromHeader <displayName | userPart | fqdnHostPart | ipHostPart | params> 
		  sipPaiHeader <displayName | userPart | fqdnHostPart | ipHostPart | params>
		  telFromHeader <displayName | userPart | params>
		  telPaiHeader <displayName | userPart | params>

Command Parameters

The Privacy Profile parameters are defined below:

ParameterLength/RangeDescription
anonymizationValueforHostpartUCHAR (0..64)Values to use for anonymization Hostpart in from" and contact headers while applying privacy semantics.
anonymizationValueforUserpartUCHAR (0..64)Values to use for anonymization Userpart in from and contact headers while applying privacy semantics.
anonymizationValueforDispNameUCHAR (0..64)Values to use for anonymization Display Name in from and contact headers while applying privacy semantics.

privacyProfile <name>

1-23 characters

<privacyProfile name> – The unique name for this Privacy Profile. This profile is used to apply privacy services independently on each call leg.

NOTE: To attach this Privacy Profile to a trunk group, refer to SIP Trunk Group - Services - CLI.

applyPrivacyIdN/A

If the incoming SIP message contains "privacy: Id" and this flag is enabled, the

Spacevars
0product
does not include P-Asserted-Id header in the egress message.

  • disabled (default)
  • enabled

applyPrivacyUser

N/A

If the incoming SIP message contains "privacy: user" and this flag is enabled, the

Spacevars
0product
anonymizes FROM and Contact headers.

  • disabled (default)
  • enabled
  • ifRcvdPrivacyUserOrIdOrBoth - The applyPrivacyUser procedures are applied even if Privacy:id is received and Privacy:user is not.

passThruPrivacyInfo

N/A

NOTE: This flag overrides the other privacyProfile flags.

If this flag is enabled, the Privacy header is passed transparently to the outgoing message and the

Spacevars
0product
sends P-Asserted-Id or FROM header as received.

  • disabled
  • enabled (default)

supportPrivacyId

N/A

If this flag is enabled, the outgoing SIP message from the

Spacevars
0product
does not include the P-Asserted-Id (PAI) header even though the incoming message does not contain "privacy: id" header. When set to the option "ifRcvdPrivacyId", the
Spacevars
0product
 removes PAI/Privacy: id only if the ingress INVITE includes the "privacy: id" header.

  • disabled (default)
  • enabled
  • ifRcvdPrivacyId -  The SBC removes PAI/Privacy: id only if the Ingress INVITE contains Privacy:id header.

supportPrivacyUser

N/A

If this flag is enabled, the outgoing SIP message from the

Spacevars
0product
includes anonymized FROM and Contact headers even though the incoming message does not contain "privacy: user" header. 

  • disabled (default)
  • enabled
  • ifRcvdPrivacyUser - The SBC anonymizes the From and Contact header only if the Ingress INVITE contains Privacy: user header.
  • ifRcvdPrivacyUserOrIdOrBoth - Apply the SupportPrivacyUser procedures even if Privacy:id is received and Privacy:user is not.
useReceivedValuesN/A

Send the From and PAI headers transparently in conjunction with parameters above.

  • SIPPAIHeader - Choose the applicable Ingress SIP PAI fields for the SBC to copy to the Egress PAI header: 
    • displayName
    • userPart
    • fqdnHostPart
    • ipHostPart
    • params
  • SIPFromHeader - Choose the applicable Ingress SIP From fields for the SBC to copy to the Egress From header:
    • displayName
    • userPart
    • fqdnHostPart
    • ipHostPart
    • params
  • TelPAIHeader - Choose the applicable Ingress TEL PAI fields for the SBC to copy to the Egress PAI header:
    • displayName
    • userPart
    • params
  • TelFromHeader - Choose the applicable Ingress TEL From fields for the SBC to copy to the Egress From header:
    • displayName
    • userPart
    • params

 

Info

When privacy profile and privacyParamRestricted is set, then privacy profile gets higher precedence.


Info
titleNote

When an Invite is received with the Privacy:id, even though the Privacy Profile is not configured to Anonymize From /Contact Header due to Ingress Leg properties, the SBC sends From Header anonymized. Ribbon recommends to configure useReceivedValues < sipFromHeader/ telFromHeader> to avoid this scenario.



Command Examples

The following example configures a Privacy Profile and attaches it to a trunk group:

Code Block
languagenone
set profiles services privacyProfile Test applyPrivacyId enabled applyPrivacyUser enabled passThruPrivacyInfo disabled supportPrivacyId enabled supportPrivacyUser enabled
set addressContext default zone defaultSigZone sipTrunkGroup TG1 services privacyProfile Test
commit
 
show profiles services privacyProfile
privacyProfile Test {
    applyPrivacyId      enabled;
    applyPrivacyUser    enabled;
    supportPrivacyId    enabled;
    supportPrivacyUser  enabled;
    passThruPrivacyInfo disabled;
}
[ok]

The following examples configure a Privacy Profile using the fields anonymizationValueforUserpart, anonymizationValueforHostpart, and anonymizationValueforDispName in the privacy profile.

Code Block
set profiles services privacyProfile <EGR_PRIV> anonymizationValueforHostpart <Anonymous.invalid>
set profiles services privacyProfile <EGR_PRIV> anonymizationValueforUserpart <Anonymous>
set profiles services privacyProfile <EGR_PRIV> anonymizationValueforDispName <Anonymous>
set profiles services privacyProfile <EGR_PRIV> supportPrivacyId <disabled/enabled/ifRcvdPrivacyId>
set profiles services privacyProfile <EGR_PRIV> supportPrivacyUser<disabled/enabled/ifRcvdPrivacyUser/ifRcvdPrivacyUserOrIdOrBoth>


The following examples configure a Use Received Values using the fields  sipFromHeader, sipPaiHeader, telFromHeader, and telPaiHeader.

Code Block
set profiles services privacyProfile PP useReceivedValues sipFromHeader displayName
set profiles services privacyProfile PP useReceivedValues sipPaiHeader  fqdnHostPart  
set profiles services privacyProfile PP useReceivedValues telFromHeader  displayName  
set profiles services privacyProfile PP useReceivedValues telPaiHeader  params  
set profiles services privacyProfile PP useReceivedValues telPaiHeader displayName