xmpp Module

Andreea Spirea

Edited by

Andreea Spirea

Revision History
Revision $Revision: 4772 $$Date: 2008-10-08 12:20:19 +0200 (Wed, 08 Oct 2008) $

Table of Contents

1. Admin Guide
1.1. Overview
1.2. Dependencies
1.2.1. OpenSIPS Modules
1.2.2. External Libraries or Applications
1.3. Exported Parameters
1.3.1. backend(string)
1.3.2. domain_separator (string)
1.3.3. gateway_domain (string)
1.3.4. xmpp_domain (string)
1.3.5. xmpp_host (string)
1.3.6. xmpp_port (integer)
1.3.7. xmpp_password (string)
1.3.8. outbound_proxy (string)
1.4. Exported Functions
1.4.1. xmpp_send_message()
1.5. Configuration

List of Examples

1.1. Set backend parameter
1.2. Set domain_separator parameter
1.3. Set gateway_domain parameter
1.4. Set xmpp_domain parameter
1.5. Set xmpp_host parameter
1.6. Set xmpp_port parameter
1.7. Set xmpp_password parameter
1.8. Set outbound_proxy parameter
1.9. xmpp_send_message() usage

Chapter 1. Admin Guide

1.1. Overview

This modules is a gateway between OpenSIPS and a jabber server. It enables the exchange of instant messages between SIP clients and XMPP(jabber) clients.

The gateway has two modes to run:

  • the component-mode - the gateway requires a standalone XMPP server amd the 'xmpp' module acts as a XMPP component

  • the server-mode - the module acts itself as a XMPP server, no requirement for another XMPP server in the system. NOTE: this is limited implementation of a XMPP server, it does not support SRV or TLS so far. This mode is in beta stage for the moment.

In the component mode, you need a local XMPP server (recommended Jabberd2); the xmpp module will relay all your connections to a tcp connection to the local jabber server. The documentation and the source for a Jabber server are located at the following link: http://jabberd.jabberstudio.org/2/#download

After you have a running XMPP server, what you need to do is set the following parameters in the OpenSIPS configuration file:

  • gateway_domain, xmpp_domain (which can be the same as gateway_domain) and xmpp_host, which are explained in the Exported Parameters section;

  • listen = your ip;

  • alias=opensips domain and alias=gateway domain;

  • in the following section of the configuration file, change to your gateway domain:

 	 ### ---8<--- cut here ---8<--- ###
	if (avp_check("$rd", "eq/s:sip-xmpp.opensips.org")) {
		if (!t_newtran()) {
  • you can also change the jabber server password, which must be the same as the xmpp_password parameter.

A use case, for the component-mode, would look like this:

  • OpenSIPS is running on sip-server.opensips.org;

  • the gateway is running on sip-xmpp.opensips.org;

  • the jabber server is running on xmpp.opensips.org;

  • the component is running on xmpp-sip.opensips.org.

In the server mode, the xmpp module is a minimal jabber server, thus you do not need to install another jabber server, the gateway will connect to the jabber servers, where the users you want to chat with have an account.

If you want to change to server-mode, you have to change the "backend" parameter, as shown in the Exported Parameters section, from component to server.

A use case, for the server-mode, would look like this:

  • OpenSIPS is running on sip-server.opensips.org;

  • the gateway is running on sip-xmpp.opensips.org;

  • the "XMPP server" is running on xmpp-sip.opensips.org.

In both cases, the destination address must have the same pattern:


From a jabber client's point of view, the destination will look like:


1.2. Dependencies

1.2.1. OpenSIPS Modules

The following modules must be loaded before this module:

  • requires 'tm' module.

1.2.2. External Libraries or Applications

The following libraries or applications must be installed before running OpenSIPS with this module loaded:

  • libexpat1-devel - used for parsing/building XML.

1.3. Exported Parameters

1.3.1. backend(string)

The mode you are using the module; it can be either component or server.

Default value is "component".

Example 1.1. Set backend parameter

 modparam("xmpp", "backend", "server")

1.3.2. domain_separator (string)

In the destination address we need an extra character as a domain separator, apart from @. The address of the XMPP(jabber) client looks like this: "sip:username<domain_separator>jabber_server@gateway_domain". The address of a SIP client has the following pattern : "sip_username<domain_separator>opensips_domain@xmpp_domain";

Default value is "*".

Example 1.2. Set domain_separator parameter

 modparam("xmpp", "domain_separator", "*")

1.3.3. gateway_domain (string)

The domain of the gateway, which must resolve. It must be the same with the gateway_domain from the destination address of the XMPP(jabber) client, as seen by the SIP client: "sip:username<delim>jjabber_server@gateway_domain".

Default value is "sip-xmpp.example.org".

Example 1.3. Set gateway_domain parameter

 modparam("xmpp", "gateway_domain", "sip-xmpp.opensips.org")

1.3.4. xmpp_domain (string)

The xmpp domain of the component or the server, depending on the mode we are in. It can be the same as the gateway_domain.

Default value is "sip-xmpp.example.org".

Example 1.4. Set xmpp_domain parameter

 modparam("xmpp", "xmpp_domain", "xmpp-sip.opensips.org")

1.3.5. xmpp_host (string)

The ip address or the name of the local jabber server, if the backend is set to "component"; or the address to bind to in the server mode.

Default value is "xmpp.example.org".

Example 1.5. Set xmpp_host parameter

 modparam("xmpp", "xmpp_host", "xmpp.opensips.org")

1.3.6. xmpp_port (integer)

In the component mode, this is the port of the jabber router we connect to. In the server mode, it is the transport address to bind to.

Default value is "5347", if backend is set to "component" and "5269", if backend is set to "server".

Example 1.6. Set xmpp_port parameter

 modparam("xmpp", "xmpp_port", "5269")

1.3.7. xmpp_password (string)

The password of the local jabber server.

Default value is "secret"; if changed here, it must also be changed in the c2s.xml, added by the jabber server. This is how the default configuration for the jabberd2 looks like:

	<!-- Username/password to authenticate as --&gt;
    <user>jabberd</user>;          <!-- default: jabberd -->;
    <pass>secret</pass>;           <!-- default: secret -->;	

Example 1.7. Set xmpp_password parameter

 modparam("xmpp", "xmpp_password", "secret")

1.3.8. outbound_proxy (string)

The SIP address used as next hop when sending the message. Very useful when using OpenSIPS with a domain name not in DNS, or when using a separate OpenSIPS instance for xmpp processing. If not set, the message will be sent to the address in destination URI.

Default value is NULL.

Example 1.8. Set outbound_proxy parameter

 modparam("xmpp", "outbound_proxy", "sip:opensips.org;transport=tcp")

1.4. Exported Functions

1.4.1.  xmpp_send_message()

Converts SIP messages to XMPP(jabber) messages, in order to be relayed to a XMPP(jabber) client.

Example 1.9. xmpp_send_message() usage


1.5. Configuration

Next is presented a sample configuration file one can use to implement a standalone SIP-to-XMPP gateway. You can run an instance of OpenSIPS on a separate machine or on different port with the following config, and have the main SIP server configured to forward all SIP requests for XMPP world to it.

# $Id: opensips-xmpp.cfg 4500 2008-07-29 09:25:46Z bogdan_iancu $
# simple quick-start config script for XMPP GW
# make sure in your main SIP server that you send
# only the adequate SIP MESSAGES to XMPP GW
# ----------- global configuration parameters ------------------------

debug=9            # debug level (cmd line: -dddddddddd)
log_stderror=yes    # (cmd line: -E)

/* Uncomment these lines to enter debugging mode 

check_via=no	# (cmd. line: -v)
dns=no          # (cmd. line: -r)
rev_dns=no      # (cmd. line: -R)


# ------------------ module loading ----------------------------------

loadmodule "sl.so"
loadmodule "tm.so"
loadmodule "rr.so"
loadmodule "maxfwd.so"
loadmodule "textops.so"
loadmodule "mi_fifo.so"

loadmodule "xmpp.so"

modparam("xmpp", "domain_separator", "*")
modparam("xmpp", "gateway_domain", "sip-xmpp.opensips.org")
modparam("xmpp", "xmpp_domain", "xmpp-sip.opensips.org")
modparam("xmpp", "xmpp_host", "xmpp.opensips.org")

modparam("xmpp", "backend", "server")
# modparam("xmpp", "backend", "component")

# ----------------- setting module-specific parameters ---------------

# -- mi_fifo params --

modparam("mi_fifo", "fifo_name", "/tmp/opensips_fifo_xmpp")

# -- usrloc params --

# -- rr params --
# add value to ;lr param to make some broken UAs happy
modparam("rr", "enable_full_lr", 1)

# -------------------------  request routing logic -------------------

# main routing logic


	# initial sanity checks -- messages with
	# max_forwards==0, or excessively long requests
	if (!mf_process_maxfwd_header("10")) {
		sl_send_reply("483","Too Many Hops");

	if (msg:len >=  2048 ) {
		sl_send_reply("513", "Message too big");

	### absorb retransmissions ###
	if (!t_newtran()) {
	if (method == "MESSAGE") {
		log("*** xmpp-handled MESSAGE message.\n");
		if (xmpp_send_message()) {
			t_reply("200", "Accepted");
		} else {
			t_reply("404", "Not found");
	log("*** xmpp: unhandled message type\n");
	t_reply("503", "Service unavailable");