Application Server Guide¶
You can add new call features or functionality to calls by adding an application server. Clearwater supports application servers through the standard IMS interface ISC. This article explains the features and limitations of this support. See Configuring an Application Server for details of how to configure Clearwater to use this function.
What is an application server?¶
An application server (AS) is a server which is brought into or notified of a call by the network in order to provide call features or other behaviour.
In IMS, an application server is a SIP entity which is invoked by the S-CSCF for each dialog, both originating and terminating, as configured by the initial filter criteria (iFCs) of the relevant subscribers. The application server may reject or accept the call itself, redirect it, pass it back to the S-CSCF as a proxy, originate new calls, or perform more complex actions (such as forking) as a B2BUA. It may choose to remain in the signaling path, or drop out.
The application server communicates with the IMS core via the ISC interface. This is a SIP interface. The details are given in 3GPP TS 24.229, especially s5.4 (the S-CSCF side) and s5.7 (the AS side). Further useful information can be found in 3GPP TS 23.228. Section references below are to 3GPP TS 24.229 unless otherwise specified.
For a more detailed look at the ISC interface, and how it is implemented in Clearwater, see the ISC interface guide in the Sprout developer documentation.
In Clearwater most S-CSCF function, including the ISC interface, is implemented in Sprout. Sprout invokes application servers over the ISC interface, as specified in the iFCs.
- Per the IMS specs, this invocation occurs on dialog-initiating
requests such as INVITE, SUBSCRIBE, MESSAGE, etc, and according to
the triggers within the iFCs (s18.104.22.168, s22.214.171.124):
- When specified, Sprout will route the message to the AS; the AS can either route it onward, act as a B2BUA for e.g. call diversion, or give a final response.
- Clearwater has full support for chained iFCs. The original dialog is tracked by Sprout using an ODI token in the Route header. This support includes support for forking ASs at any point in the chain.
- Service trigger points (i.e., conditions) are implemented, including SIP method, SIP headers, SDP lines, registration parameters, and request URIs.
- Service trigger points can have session case configuration, allowing the AS to only be invoked on originating calls or on terminating calls.
- No per-AS configuration is required; ASs are invoked simply by their URI appearing in the iFCs.
- AS invocation also occurs on REGISTER - this is called third-party
registration (3GPP TS 24.229 s126.96.36.199 and 7A):
- When a UE registers with Sprout, if the iFCs require it, it passes a third-party registration onto an AS.
- Message body handling for third-party registration, per 3GPP TS 24.229 s188.8.131.52A: including optionally service info, a copy of the registration, and a copy of the response.
- Network-initiated deregister. If the third-party registration fails and the iFC requests it, we must deregister the UE.
Supported SIP headers¶
The following SIP headers are supported on the ISC interface:
- All standard RFC3261 headers and relevant flows, including
Contact, etc. Also
Privacy(per RFC3323) and
P-Asserted-Identity- bare minimal support only: we set it to the same value as
From:on the outbound ISC interface, and never strip it. Full support will be added in future phases. This header is needed by originating ASs, particularly in cases where privacy is requested (see RFC3325). Full support would involve setting it in P-CSCF (bono), and ensuring it is set/stripped in the right places. The proposed minimal support has the limitation that ASs which don’t understand
P-Served-Userwon’t work correctly when privacy is invoked. See 3GPP TS 24.229 s184.108.40.206A.
P-Served-User. This is needed for proper support of AS chains, to avoid service-interaction tangles. It is set by Sprout and set/stripped in the appropriate places.
Points of Note¶
- Some ISC signaling is trust-dependent. For Clearwater, all ASs are trusted - we think support for untrusted ASs is unlikely to be required.
- IP Connectivity
- We assume that there is no NAT (static or otherwise) between the AS and the Clearwater core.
Current Spec Deltas¶
As of June 2015, Clearwater has the following limitations on the ISC interface:
- Change of request URI:
- 3GPP TS 24.229 s220.127.116.11 step 3 allows a terminating AS to change the request URI to another URI that matches it (i.e., is canonically equal or an alias) without interrupting the interpretation of the iFCs.
- Clearwater only supports this for URIs which are canonically equal; it does not support changing to an alias URI (i.e., a different public identity belonging to the same alias group of the same private identity, per 3GPP TS 24.229 s3.1, 3GPP TS 29.228 sB.2.1).
Request-Disposition: no-fork(3GPP TS 24.229 s18.104.22.168 step 10, s5.7.3, RFC 3841)
- Clearwater ignores this directive - it always INVITEs all registered endpoints.
The following features may be implemented by Clearwater in future phases:
- Billing: both billing headers within ISC, and AS communicating with the billing system via Rf/Ro.
P-Access-Network-Info: should be passed (from the UE) and stripped in the appropriate places, and possibly set by bono.
History-Infodraft-ietf-sipcore-rfc4244bis (not RFC4244, which is inaccurate wrt real implementations).
user=dialstringhandling (RFC4967). The specs (3GPP TS 24.229 s22.214.171.124, esp step 10) are quite clear that this is handed off to an AS or handled in a deployment-specific way, as for various other URI formats, so there is nothing to do here.
P-Preferred-Service(RFC6050, TS 23.228 s4.13), i.e., IMS Communication Services and ICSIs.
- IMS debug package, IMS logging.
- Support for untrusted ASs.
- Support for terminating ASs changing to an alias URI.
- Support for
Request-Disposition: no-fork, which should pick a single endpoint to INVITE.
Clearwater implements the ISC interface only. An AS may also expect to communicate over several other interfaces:
- AS interrogates HSS over Sh. If the AS requires this it should access the HSS directly, bypassing Clearwater’s Homestead cache. It is not supported in deployments without an HSS.
- AS interrogates SRF over Dh. Typical Clearwater deployments do not include an SRF.
- UE retrieves and edits AS configuration via Ut. An AS is free to provide this or any other configuration interface it chooses. Homer does not provide a generic Ut interface for ASs to store configuration information.
The built-in MMTEL application server¶
Clearwater has a built-in application server,
mmtel.<deployment-domain>, which implements a subset of the MMTEL
services defined in GSMA PRD
and 3GPP TS
- Originating Identification Presentation (OIP)
- Originating Identification Restriction (OIR)
- Communication Diversion (CDIV)
- Communication Barring (CB)
Note that Clearwater is also able to support a number of other IR.92 services, either through inherent support (by transparently passing messages between UEs) or through integration with external application servers. See the IR.92 Supplementary Services document for more information.
The built-in MMTEL application server is invoked only for calls
configured to use it. To use it, simply configure a subscriber’s iFCs to
indicate the use of
mmtel.<deployment-domain> as an application
server. The MMTEL application server can be used on its own, or as one
of a chain of application servers handling a call. The default iFCs
configured by Ellis specify that the built-in MMTEL application server
should be used for all originating and terminating calls.