Cisco IOS XR Session Border Controller Configuration Guide Release 3.6
Configuring Header Profiles

Table Of Contents

Configuring Header Profiles

Contents

Restrictions for Configuring Header Profiles

Information About Header Profiles

How to Configure Header Profiles

Configuring Header Profiles

Applying Header Profiles

Examples of Header Profiles

Example of Configuring Header Profiles

Example of Applying Header Profiles

Additional References

Related Documents

Standards

MIBs

RFCs

Technical Assistance


Configuring Header Profiles


You can configure the SBC with header whitelist and blacklist profiles on Session Initiation Protocol (SIP) messages. These profiles are used to control which headers are passed through (whitelists) and which headers are discarded (blacklists) on Session Initiation Protocol (SIP) messages. This feature helps to avoid misusing the SBE or SIP adjacency by SIP users and improves the efficiency of SIP calls.

Feature History for Header Profiles

Release
Modification

Release 3.4.1

This feature was introduced on the Cisco XR 12000 Series Router.

Release 3.5.0

No modification.

Release 3.6.0

No modification.


Contents

This module contains the following sections:

Restrictions for Configuring Header Profiles

Information About Header Profiles

How to Configure Header Profiles

Examples of Header Profiles

Additional References

Restrictions for Configuring Header Profiles

The total size of SIP headers that the SBC can pass through on any SIP message should not exceed one kilobyte.

Any given profile must be exclusively a whitelist or a blacklist. It cannot contain elements of both.

Two profiles are applied to process any given SIP message: one inbound and, if permitted through that, one outbound.

Profiles only check SIP header names. The contents of the header (all content after the ":") are ignored.

SIP headers that are essential to the operation of an SBC cannot be blacklisted and are implicitly added to any whitelist.

Profiles can not be removed while they are in active use by an adjacency.

Information About Header Profiles

After you configure a profile, you can assign it for a default application. Any SIP adjacency can apply it to signaling for that adjacency.

You can add or remove headers from profiles at any time. Headers configured on a profile must contain characters that are valid for a SIP header.

Profiles cannot be deleted while any adjacency is using them. You can see which adjacencies are using a profile by entering the following show command:

show services sbc <sbc-name> sbe sip header-profile <name>

Table 3 lists the fixed set of essential SIP headers, which are not permitted to be configured on any profile.

Table 3 Essential Headers

To

Content-Type

Accept

Route

Referred-By

From

Content-Length

Expires

Record-Route

Referred-To

Via

Contact

Min-Expires

Proxy-Authorization

Replaces

Call-ID

Supported

Authorization

Proxy-Require

Resource-Priority

CSeq

Require

WWW-Authenticate

Diversion

Server

Max-Forwards

Allow

Proxy-Authenticate

Event

Subscription State


Profiles are an optional part of the configuration. If no profile is applicable to a given SIP signal, then the essential headers are processed and all other headers are not forwarded.

How to Configure Header Profiles

You first configure the header profiles and then apply them as explained in the following sections:

Configuring Header Profiles

Applying Header Profiles

Configuring Header Profiles

SUMMARY STEPS

1. configure

2. sbc service-name sbe sip

3. header-profile profile-name

4. blacklist

5. header name

6. description text

7. commit

8. exit

9. show services sbc service-name sbe sip-header-profile profile name

10. show services sbc service-name sbe sip header-profiles

11. show services sbc sbc name sbe sip essential-headers

DETAILED STEPS

 
Command or Action
Purpose

Step 1 

configure

Example:

RP/0/0/CPU0:router# configure

Enables global configuration mode.

Step 2 

sbc service-name sbe sip

Example:

RP/0/0/CPU0:router(config)# sbc mysbc sbe sip

Enters the submode for configuring the header profile.

Use the service-name argument to define the name of the service.

Step 3 

header-profile profile-name

Example:

RP/0/0/CPU0:router(config-sbc-sbe-sip)# header-profile profile1

Configures a header profile.

If you enter the name default, the default profile is configured. This profile is used for all adjacencies which do not have a specific profile configured.

Step 4 

blacklist

Example:

RP/0/0/CPU0:router(config-sbc-sbe-sip-hdr-prf)# blacklist

Configures a profile to be a blacklist.

The no version of this command configures the profile to be a whitelist.

Note By default, profiles are whitelists.

Step 5 

header name

Example:

RP/0/0/CPU0:router(config-sbc-sbe-sip-hdr-prf)# header test1

Configures the profile to contain the header test1.

Step 6 

description text

Example:

RP/0/0/CPU0:router(config-sbc-sbe-sip-hdr-prf)# description blacklist profile

Adds a description for the specified profile.

The no form of this command removes the description.

This description is displayed when the show command is used for this profile and is displayed for each profile when displaying a summary of all profiles.

Step 7 

commit

Example:

RP/0/0/CPU0:router(config-sbc-sbe-sip-hdr-prf)# commit

Saves configuration changes. Use the commit command to save the configuration changes to the running configuration file and remain within the configuration session.

Step 8 

exit

Example:

RP/0/0/CPU0:router(config-sbc-sbe-sip-hdr-prf)# exit

Exits the header profile mode to the sbe mode.

Step 9 

show services sbc sbc-name sbe sip-header-profile name

Example:

RP/0/0/CPU0:router(config-sbc-sbe)# show services sbc mysbc sbe sip header-profile profile1

Displays details for the header profile with the designated name.

Use name default to view the default profile.

Step 10 

show services sbc sbc-name sbe sip header-profiles

Example:

RP/0/0/CPU0:router(config-sbc-sbe)# show services sbc mysbc sbe sip header-profiles

Displays a list of all configured header profiles.

Step 11 

show services sbc sbc name sbe sip essential-headers

Example:

RP/0/0/CPU0:router(config-sbc-sbe)# show services sbc mysbc sbe sip essential-headers

Displays a list of the essential headers listed in Table 3.

Applying Header Profiles

SUMMARY STEPS

1. configure

2. sbc service-name

3. sbe

4. adjacency sip adjacency-name

5. header-profile inbound profile-name

6. commit

7. exit

8. show services sbc service-name sbe sip header-profile name

DETAILED STEPS

 
Command or Action
Purpose

Step 1 

configure

Example:

RP/0/0/CPU0:router# configure

Enables global configuration mode.

Step 2 

sbc service-name

Example:

RP/0/0/CPU0:router(config)# sbc mysbc

Enters the mode of an SBC service.

Use the service-name argument to define the name of the service.

Step 3 

sbe

Example:

RP/0/0/CPU0:router(config-sbc)# sbe

Enters the mode of an SBE entity within an SBC service.

Step 4 

adjacency sip adjacency-name

Example:

RP/0/0/CPU0:router(config-sbc-sbe)# adjacency sip sipGW

Enters the mode of an SBE SIP adjacency.

Use the adjacency-name argument to define the name of the service.

Step 5 

header-profile inbound profile-name

Example:

RP/0/0/CPU0:router(config-sbc-sbe-adj-sip)# header-profile inbound profile1

Sets profile1 to be used for inbound signaling on adjacency sipGW.

Step 6 

commit

Example:

RP/0/0/CPU0:router(config-sbc-sbe-sip-hdr-prf)# commit

Saves configuration changes. Use the commit command to save the configuration changes to the running configuration file and remain within the configuration session.

Step 7 

exit

Example:

RP/0/0/CPU0:router(config-sbc-sbe-sip-hdr-prf)# exit

Exits the header profile mode to the sbe mode.

Step 8 

show services sbc sbc-name sbe sip header-profile name

Example:

RP/0/0/CPU0:router# show services sbc sbc-name sbe sip header-profile name

Displays the header profile information.

Examples of Header Profiles

This section provides a sample configuration and output for header profiles.

Example of Configuring Header Profiles

The following example shows the commands and output generated when you configure the header profiles.

RP/0/0/CPU0:node3(config)#sbc umsbc-node3 sbe
RP/0/0/CPU0:node3(config-sbc-sbe)#sip header-profile test1
RP/0/0/CPU0:node3(config-sbc-sbe-sip-hdr)#blacklist  
RP/0/0/CPU0:node3(config-sbc-sbe-sip-hdr)#header abcd
RP/0/0/CPU0:node3(config-sbc-sbe-sip-hdr)#commit
RP/0/0/CPU0:node3#sh services sbc umsbc-node3 sbe sip header-profiles
Header profiles for SBC service "umsbc-node3"
  Name                          In use
  ====================================
  test1                          Yes
  default                        Yes
RP/0/0/CPU0:node3#sh services sbc umsbc-node3 sbe sip header-profile test1
  Header profile "test1"
    Type:    Blacklist
    Headers:
      abcd
    In use by: Not in use with any adjacencies

Example of Applying Header Profiles

The following example shows the commands and output generated when you are applying a header profile to an SBC.

RP/0/0/CPU0:node3#conf t
RP/0/0/CPU0:node3(config)#sbc umsbc-node3 sbe
RP/0/0/CPU0:node3(config-sbc-sbe)#adjacency sip sipp-10
RP/0/0/CPU0:node3(config-sbc-sbe-adj-sip)#header-profile inbound test1
RP/0/0/CPU0:node3(config-sbc-sbe-adj-sip)#header-profile outbound test1
RP/0/0/CPU0:node3(config-sbc-sbe-adj-sip)#commit
RP/0/0/CPU0:node3#sh services sbc umsbc-node3 sbe sip header-profile test1
  Header profile "test1"
    Type:    Blacklist
    Headers:
      abcd
    In use by:
       Adjacency: sipp-10 (in, out)
show running-config

sbc umsbc-node3
 service-location preferred-active 0/6/CPU0
 sbe
  activate

sip header-profile test1
   blacklist
   header abcd
  !
  adjacency sip sipp-10
   header-profile inbound test1
   header-profile outbound test1
   signaling-address ipv4 88.88.109.8
   signaling-port 5060
   remote-address ipv4 10.10.105.222/32
   security trusted-encrypted
   signaling-peer 10.10.105.222
   signaling-peer-port 5060
   account sip-customer

Additional References

The following sections provide references related to configuring header profiles.

Related Documents

Related Topic
Document Title

Cisco IOS XR master command reference

Cisco IOS XR Master Commands List

Cisco IOS XR SBC interface configuration commands

Cisco IOS XR Session Border Controller Command Reference

Initial system bootup and configuration information for a router using the Cisco IOS XR Software

Cisco IOS XR Getting Started Guide

Cisco IOS XR command modes

Cisco IOS XR Command Mode Reference


Standards

Standards
Title

No new or modified standards are supported by this feature, and support from existing standards has not been modified by this feature.


MIBs

MIBs
MIBs Link

To locate and download MIBs using Cisco IOS XR software, use the Cisco MIB Locator found at the following URL and choose a platform under the Cisco Access Products menu:

http://cisco.com/public/sw-center/netmgmt/cmtk/mibs.shtml


RFCs

RFCs
Title

RFC 2833

RTP Payload for DTMF Digits, Telephony Tones and Telephony Signals

RFC 3261

SIP: Session Initiation Protocol


Technical Assistance

Description
Link

The Cisco Technical Support website contains thousands of pages of searchable technical content, including links to products, technologies, solutions, technical tips, and tools. Registered Cisco.com users can log in from this page to access even more content.

http://www.cisco.com/techsupport