OpenXCAP

Background

[[Image(htdocs:SIPSIMPLE-concept.png, align=right, nolink)]]XCAP protocol allows a client to read, write, and modify application configuration data stored in XML format on a server. XCAP maps XML document sub-trees and element attributes to HTTP URIs, so that these components can be directly accessed by HTTP. An XCAP server is used by the XCAP clients to store data like Presence policy in combination with a SIP server that supports PUBLISH/SUBSCRIBE/NOTIFY methods to provide a complete [http://www.tech-invite.com/Ti-sip-WGs.html#wg-simple SIP SIMPLE] server solution.

The XCAP server is used as a policy decision maker by the SIP Presence server to manage the subscriptions and notifications of presence information based on end-user controlled preferences. An immediate advantage of using an XCAP server is to allow end-users to reliably syncronize presence configuration data like buddy lists and access lists between multiple SIP SIMPLE devices. The XCAP server can also be used to publish to SIP devices information retrieved from external sources and using different APIs acting like a bridge between real-time communications based on SIP protocol and other web technologies like SOAP/XML.

Project description

OpenXCAP is an open source, easy extensible, fully featured XCAP server with TLS security and support for multiple realms. The server is written in the Python programming language and is based on the following RFCs:

• The Extensible Markup Language (XML) Configuration Access Protocol (XCAP) [http://www.tools.ietf.org/html/rfc4825 RFC 4825]
• Formats for Representing Resource Lists [http://www.tools.ietf.org/html/rfc4826 RFC 4826] (still under construction)
• Usage for Manipulating Presence Document Contents [http://www.tools.ietf.org/html/rfc4827 RFC 4827]
• Presence Authorization Rules [http://tech-invite.com/SIPWGs/03-WG-SIMPLE/Drafts/draft-ietf-simple-presence-rules-10.txt draft-ietf-simple-presence-rules-10]

The software is provided under the [source:LICENSE BSD LICENSE]

Download

The software was released on September 1-st, 2007.

[wiki:Download Download page]

Running the server

[wiki:Running Running the server page]

Features

=== Supported XCAP applications ===

• '''Resource lists (auid = resource-lists)'''. A resource lists application is any application that needs access to a list of resources, identified by a URI, to which operations, such as subscriptions, can be applied.
• '''PIDF Manipulation (auid = pidf-manipulation)'''. Pidf-manipulation application usage defines how XCAP is used to manipulate the contents of PIDF based presence documents.
• '''Presence Rules (auid = presence-rules)'''. A Presence Rules application is an application which uses authorization policies, also known as authorization rules, to specify what presence information can be given to which watchers, and when.
• '''Watchers (auid = watchers, proprietary application)'''. This application returns the list of watchers from OpenSER presence agent and their status in an XML format

Under development

'''RLS Services (auid = rls-services)'''. A Resource List Server (RLS) services application is Session Initiation Protocol (SIP) application whereby a server receives SIP SUBSCRIBE requests for resource, and generates subscriptions towards the resource list.

=== Data storage ===

OpenXCAP server uses storage based on MySQL server and works out of the box with [http://openser.org OpenSER Proxy/Registrar/Presence] server.

=== Security ===

The server has the following security features:

• TLS encryption and digital certificates using GnuTLS library
• Digest or basic HTTP authentication with support for multiple realms
• Database passwords can be stored in an encrypted format

=== XCAP clients ===

No server is useful without clients supporting their features. Below is a list with XCAP clients known to be working with OpenXCAP:

• [http://openser.org OpenSER]
• [wiki:soap-simple-proxy soap-simple-proxy] This client allows publication of arbitrary information and policy management using an easy to use SOAP/XML interface
• Eyebeam from [http://www.counterpath.com/eyebeam-overview.html Counterpath]

Credits

Main author: Mircea Amarascu

Contributers: Ruud Klaver, Dan Pascu

Support

You may obtain support from various sources:

• The project is supported via this wiki collaboration system by [http://ag-projects.com AG Projects]. To open ticket please Register first. The ticketing support system is available only for registered users. The support is provided on a best-effort basis.
• For interaction between OpenXCAP and OpenSER you may consult the [http://openser.org/pipermail/users/ OpenSER users mailing list]
• [wiki:Installation OpenXCAP Installation guide]

Commercial products

OpenXCAP is part of turnkey SIP platforms offered by AG Projects:

[http://www.ag-projects.com/Products http://www.ag-projects.com/Products]