Documentation

Documentation.Tutorials-Presence-PuaXmppConfig History

Hide minor edits - Show changes to markup

July 02, 2014, at 01:50 PM by 89.120.101.121 -
Deleted lines 188-192:
		# make pua_usrloc send PUBLISH for phones which do not support
		# presence filter after User-Agent header
		if ( $hdr("User-Agent")!~"X-Lite" )
			pua_set_publish();
July 02, 2014, at 01:28 PM by 89.120.101.121 -
Deleted line 35:

alias="sip.domain.com"

July 02, 2014, at 01:26 PM by 89.120.101.121 -
Changed lines 1-5 from:

<-Back

Download

# OpenSIPS SIP-XMPP Gateway

debug
=3
log_stderror
=no
log_facility
=LOG_LOCAL0

fork
=yes
children
=4

listen
=udp:10.10.10.10:5060
alias="sip.domain.com"

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

mpath
="/usr/local/lib/opensips/modules/"

loadmodule
"db_mysql.so"
loadmodule
"textops.so"
loadmodule
"maxfwd.so"
loadmodule
"rr.so"
loadmodule
"sl.so"
loadmodule
"tm.so"
loadmodule
"signaling.so"
loadmodule
"usrloc.so"
loadmodule
"registrar.so"
loadmodule
"mi_fifo.so"
loadmodule
"uri.so"

loadmodule
"xmpp.so"
loadmodule
"pua.so"
loadmodule
"pua_xmpp.so"
loadmodule
"presence.so"
loadmodule
"presence_xml.so"

# ----------------- setting module-specific parameters ---------------
modparam
("usrloc|presence|presence_xml|pua", "db_url",  "mysql://opensips:opensipsrw@localhost/opensips")
modparam
("presence|pua_xmpp", "server_address", "sip:sa@10.10.10.10:5060")
modparam
("presence_xml", "force_active", 1)
modparam
("pua_xmpp", "presence_server", "sip:sa@10.10.10.10:5060")

modparam
("xmpp", "xmpp_domain", "sip.domain.com")  # the name that OpenSIPS will register with as a component to the jabber server
modparam
("xmpp", "xmpp_host", "xmpp.domain.com")   # the location of the jabber server
modparam
("xmpp", "sip_domain", "sip.domain.com")   # the domain of the sip users visible to the xmpp users
modparam
("xmpp", "backend", "component")
modparam
("xmpp", "outbound_proxy", "sip:10.10.10.10:5060")

modparam
("mi_fifo", "fifo_name", "/tmp/opensips_fifo")
modparam
("usrloc", "db_mode", 2)

route
{
   
if (!mf_process_maxfwd_header("10")) {
        sl_send_reply
("483","Too Many Hops");
       
exit;
   
}

   
if (has_totag()) {
       
# sequential request withing a dialog should
       
# take the path determined by record-routing
       
if (loose_route()) {
           
if (is_method("BYE")) {
                setflag
(1); # do accounting ...
                setflag
(3); # ... even if the transaction fails
           
} else if (is_method("INVITE")) {
               
# even if in most of the cases is useless, do RR for
               
# re-INVITEs alos, as some buggy clients do change route set
               
# during the dialog.
                record_route
();
           
}
           
# route it out to whatever destination was set by loose_route()
           
# in $du (destination URI).
            route
(1);
       
} else {
           
/* uncomment the following lines if you want to enable presence */
           
if (is_method("SUBSCRIBE|NOTIFY")) {
           
##  # in-dialog subscribe requests
                route
(2);
               
exit;
           
}
           
if ( is_method("ACK") ) {
               
if ( t_check_trans() ) {
                   
# non loose-route, but stateful ACK; must be an ACK after
                   
# a 487 or e.g. 404 from upstream server
                    t_relay
();
                   
exit;
               
} else {
                   
# ACK without matching transaction ->
                   
# ignore and discard
                   
exit;
               
}
           
}
            sl_send_reply
("404","Not here");
       
}
       
exit;
   
}
   
#initial requests

   
# CANCEL processing
   
if (is_method("CANCEL"))
   
{
       
if (t_check_trans())
            t_relay
();
       
exit;
   
}

    t_check_trans
();

   
# authenticate if from local subscriber (uncomment to enable auth)
   
# authenticate all initial non-REGISTER request that pretend to be
   
# generated by local subscriber (domain from FROM URI is local)
   
##if (!(method=="REGISTER") && from_uri==myself) /*no multidomain version*/
   
##if (!(method=="REGISTER") && is_from_local())  /*multidomain version*/
   
##{
   
##  if (!proxy_authorize("", "subscriber")) {
   
##      proxy_challenge("", "0");
   
##      exit;
   
##  }
   
##  if (!db_check_from()) {
   
##      sl_send_reply("403","Forbidden auth ID");
   
##      exit;
   
##  }
   
##
   
##  consume_credentials();
   
##  # caller authenticated
   
##}

   
# preloaded route checking
   
if (loose_route()) {
        xlog
("L_ERR",
       
"Attempt to route with preloaded Route's [$fu/$tu/$ru/$ci]");
       
if (!is_method("ACK"))
            sl_send_reply
("403","Preload Route denied");
       
exit;
   
}
 
   
# handle initial presence messages
   
if(uri==myself || uri=~"sip:.+gmail.com" || uri=~"sip:.+@xmpp.domain.com") # detect if it's for an XMPP user
   
{
       
if( is_method("PUBLISH|SUBSCRIBE"))
            route
(2);
   
};

   
# handle xmpp messages
   
if(is_method("MESSAGE") && (uri=~"sip:.+gmail.com" || uri=~"sip:.+@xmpp.domain.com"))
   
{
       
if(!t_newtran())
       
{
            sl_reply_error
();
           
exit;
       
}
       
if (xmpp_send_message()) {
            t_reply
("200", "Accepted");
       
} else {
            t_reply
("404", "Not found");
       
}
       
exit;
   
};

   
# record routing
   
if (!is_method("REGISTER|MESSAGE"))
        record_route
();

   
# account only INVITEs
   
if (is_method("INVITE")) {
        setflag
(1); # do accounting
   
}
   
if (!uri==myself)
   
## replace with following line if multi-domain support is used
   
##if (!is_uri_host_local())
   
{
        append_hf
("P-hint: outbound\r\n");
       
# if you have some interdomain connections via TLS
       
##if($rd=="tls_domain1.net") {
       
##  t_relay("tls:domain1.net");
       
##  exit;
       
##} else if($rd=="tls_domain2.net") {
       
##  t_relay("tls:domain2.net");
       
##  exit;
       
##}
        route
(1);
   
}

   
# requests for my domain

   
if (is_method("REGISTER"))
   
{
       
# authenticate the REGISTER requests (uncomment to enable auth)
       
##if (!www_authorize("", "subscriber"))
       
##{
       
##  www_challenge("", "0");
       
##  exit;
       
##}
       
##
       
##if (!db_check_to())
       
##{
       
##  sl_send_reply("403","Forbidden auth ID");
       
##  exit;
       
##}

       
if (!save("location"))
            sl_reply_error
();

       
exit;
   
}

   
if ($rU==NULL) {
       
# request with no Username in RURI
        sl_send_reply
("484","Address Incomplete");
       
exit;
   
}

   
# apply DB based aliases (uncomment to enable)
   
##alias_db_lookup("dbaliases");

   
# do lookup with method filtering
   
if (!lookup("location","m")) {
       
switch ($retcode) {
           
case -1:
           
case -3:
                t_newtran
();
                t_reply
("404", "Not Found");
               
exit;
           
case -2:
                sl_send_reply
("405", "Method Not Allowed");
               
exit;
       
}
   
}

   
# when routing via usrloc, log the missed calls also
    setflag
(2);

    route
(1);
}


route
[1] {
   
# send it out now; use stateful forwarding as it works reliably
   
# even for UDP2TCP

   
if (!t_relay()) {
        sl_reply_error
();
   
};
   
exit;
}

route
[2] {
   
# create new transaction to catch retransmissions
   
if(!t_newtran())
   
{
        sl_reply_error
();
       
exit;
   
}

   
# if it is Notify - for xmpp gateway
   
if( is_method("NOTIFY"))
   
{
        t_reply
("200", "OK");
        pua_xmpp_notify
();
       
exit;
   
}

   
# handle presence specific messages
   
if(is_method("PUBLISH"))
   
{
        handle_publish
();
   
}
   
else
   
if(is_method("SUBSCRIBE"))
   
{
        handle_subscribe
();
       
if($hdr(Event)== "presence" && (uri=~"sip:.+gmail.com" || uri=~"sip:.+@xmpp.domain.com") )
            pua_xmpp_req_winfo
("$ruri", "$hdr(Expires)");
   
}
   
exit;
}

   
to:
Documentation -> Tutorials -> Presence -> Presence User Agent Extensions -> SIMPLE SIP-to-XMPP gateway


#
# OpenSIPS 1.11.x configuration file
#
# SIP to XMPP Gateway + SIP Presence Server
#

# ----------- global configuration parameters ------------------------

debug=3
fork=yes
log_stderror=no

check_via=no
dns=no
rev_dns=no

listen=udp:10.10.10.10:5060
children=2

alias="sip.domain.com"

# ------------------ module loading ----------------------------------
mpath="/usr/local/opensips/lib/modules/"

loadmodule "db_mysql.so"
loadmodule "sl.so"
loadmodule "signaling.so"
loadmodule "tm.so"
loadmodule "maxfwd.so"
alias="sip.domain.com"
loadmodule "textops.so"
loadmodule "sipmsgops.so"
loadmodule "rr.so"
loadmodule "mi_fifo.so"
loadmodule "usrloc.so"
loadmodule "registrar.so"
loadmodule "presence.so"
loadmodule "presence_xml.so"
loadmodule "xmpp.so"
loadmodule "pua.so"
loadmodule "pua_xmpp.so"

# Uncomment this if you want digest authentication
#loadmodule "auth.so"
#loadmodule "auth_db.so"

# ----------------- setting module-specific parameters ---------------
modparam("mi_fifo","fifo_name","/tmp/opensips_fifo")

# -- usrloc params --
modparam("usrloc","db_mode",2)
modparam("usrloc","db_url","mysql://opensips:opensipsrw@localhost/opensips")

# -- auth params --
# Uncomment if you are using auth module
#modparam("auth_db", "calculate_ha1", yes)
#modparam("auth_db", "password_column", "password")

# -- presence params --
modparam("presence|presence_xml","db_url","mysql://opensips:opensipsrw@localhost/opensips")
modparam("presence","server_address","sip:sa@10.10.10.10:5060")
modparam("presence_xml","force_active",1)

# -- pua and pua_xmpp parameters --
modparam("pua","db_url","mysql://opensips:opensipsrw@localhost/opensips")
modparam("pua_xmpp","default_domain","10.10.10.10")

# -- xmpp parameters --
# the name that OpenSIPS will register with as a component to the jabber server
modparam("xmpp", "xmpp_domain", "sip.domain.com")
# the location of the jabber server
modparam("xmpp", "xmpp_host", "xmpp.domain.com")
# the domain of the sip users visible to the xmpp users 
modparam("xmpp", "sip_domain", "sip.domain.com")
modparam("xmpp", "backend", "component")
modparam("xmpp", "outbound_proxy", "sip:10.10.10.10:5060")


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

# main routing logic
route{

	# initial sanity checks
	if(!mf_process_maxfwd_header("10")) {
		send_reply("483","Too Many Hops");
		exit;
	}

	if (has_totag()) {
		# sequential requests within a dialog should
		# take the path determined by record-routing
		if (loose_route()) {
			# route it out to whatever destination was set by loose_route()
			# in $du (destination URI).
			route(relay);
		} else {
			if (is_method("SUBSCRIBE|NOTIFY") && uri==myself) {
				# in-dialog subscribe requests
				route(handle_presence);
				exit;
			} else if ( is_method("ACK") ) {
				if ( t_check_trans() ) {
					# non loose-route, but stateful ACK; must be an ACK after 
					# a 487 or e.g. 404 from upstream server
					t_relay();
					exit;
				} else {
					# ACK without matching transaction ->
					# ignore and discard
					exit;
				}
			}
			send_reply("404","Not here");
		}
		exit;
	}

	# CANCEL processing
	if (is_method("CANCEL")) {
		if (t_check_trans())
			t_relay();
		exit;
	}

	t_check_trans();

	# authenticate if from local subscriber (uncomment to enable auth)
	# authenticate all initial non-REGISTER request that pretend to be
	# generated by local subscriber (domain from FROM URI is local)
	##if (!(method=="REGISTER") && from_uri==myself) {
	##  if (!proxy_authorize("", "subscriber")) {
	##      proxy_challenge("", "0");
	##      exit;
	##  }
	##  if (!db_check_from()) {
	##      send_reply("403","Forbidden auth ID");
	##      exit;
	##  }
	##
	##  consume_credentials();
	##}

	# SIP to XMPP traffic (to an XMPP user)
	if ( ($rd=~".+gmail.com$" || $rd=="xmpp.domain.com") ) {
		# handle initial presence messages
		if ( is_method("PUBLISH|SUBSCRIBE") )
			route(handle_presence);

		# handle xmpp messages
		if (is_method("MESSAGE") ) {
			t_newtran();
			if (xmpp_send_message()) {
				t_reply("200", "Accepted");
			} else {
				t_reply("404", "Not found");
			}
			exit;
		}
	} # SIP 2 XMPP

	# record routing
	if (!is_method("REGISTER|MESSAGE"))
		record_route();

	if (uri!=myself) {
		# routing to other SIP domains
		route(relay);
	}

	# SIP 2 SIP presence traffic
	if (is_method("PUBLISH|SUBSCRIBE")) {
		route(handle_presence);
		exit;
	}

	if (is_method("REGISTER")) {

		# Uncomment this if you want to use digest authentication
		#if (!www_authorize("", "subscriber")) {
		#  www_challenge("", "0");
		#  exit;
		#}

		# make pua_usrloc send PUBLISH for phones which do not support
		# presence filter after User-Agent header
		if ( $hdr("User-Agent")!~"X-Lite" )
			pua_set_publish();

		save("location");
		exit;
	}

	# native SIP destinations are handled using our USRLOC DB
	if(!lookup("location")) {
		send_reply("404","Not Found");
		exit;
	}

	route(relay);
}


route[relay]{
	# send it out
	if(!t_relay())
		sl_reply_error();

	exit;
}


route[handle_presence]
{
	if(!t_newtran()){
		sl_reply_error();
		exit;
	}

	# if it is NOTIFY - for xmpp gateway
	if( is_method("NOTIFY")) {
		t_reply("200", "OK");
		pua_xmpp_notify();
	} else

	if (is_method("PUBLISH")) {
		handle_publish();
	} else

	if (is_method("SUBSCRIBE")) {
		handle_subscribe();
		if( $hdr(Event)== "presence" && 
		($rd=~".+gmail.com$" || $rd=="xmpp.domain.com") )
			pua_xmpp_req_winfo("$ru", "$hdr(Expires)");
	}

	exit;
}
May 09, 2013, at 12:47 PM by 109.99.235.212 -
Added lines 1-5:

<-Back

Download

# OpenSIPS SIP-XMPP Gateway

debug
=3
log_stderror
=no
log_facility
=LOG_LOCAL0

fork
=yes
children
=4

listen
=udp:10.10.10.10:5060
alias="sip.domain.com"

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

mpath
="/usr/local/lib/opensips/modules/"

loadmodule
"db_mysql.so"
loadmodule
"textops.so"
loadmodule
"maxfwd.so"
loadmodule
"rr.so"
loadmodule
"sl.so"
loadmodule
"tm.so"
loadmodule
"signaling.so"
loadmodule
"usrloc.so"
loadmodule
"registrar.so"
loadmodule
"mi_fifo.so"
loadmodule
"uri.so"

loadmodule
"xmpp.so"
loadmodule
"pua.so"
loadmodule
"pua_xmpp.so"
loadmodule
"presence.so"
loadmodule
"presence_xml.so"

# ----------------- setting module-specific parameters ---------------
modparam
("usrloc|presence|presence_xml|pua", "db_url",  "mysql://opensips:opensipsrw@localhost/opensips")
modparam
("presence|pua_xmpp", "server_address", "sip:sa@10.10.10.10:5060")
modparam
("presence_xml", "force_active", 1)
modparam
("pua_xmpp", "presence_server", "sip:sa@10.10.10.10:5060")

modparam
("xmpp", "xmpp_domain", "sip.domain.com")  # the name that OpenSIPS will register with as a component to the jabber server
modparam
("xmpp", "xmpp_host", "xmpp.domain.com")   # the location of the jabber server
modparam
("xmpp", "sip_domain", "sip.domain.com")   # the domain of the sip users visible to the xmpp users
modparam
("xmpp", "backend", "component")
modparam
("xmpp", "outbound_proxy", "sip:10.10.10.10:5060")

modparam
("mi_fifo", "fifo_name", "/tmp/opensips_fifo")
modparam
("usrloc", "db_mode", 2)

route
{
   
if (!mf_process_maxfwd_header("10")) {
        sl_send_reply
("483","Too Many Hops");
       
exit;
   
}

   
if (has_totag()) {
       
# sequential request withing a dialog should
       
# take the path determined by record-routing
       
if (loose_route()) {
           
if (is_method("BYE")) {
                setflag
(1); # do accounting ...
                setflag
(3); # ... even if the transaction fails
           
} else if (is_method("INVITE")) {
               
# even if in most of the cases is useless, do RR for
               
# re-INVITEs alos, as some buggy clients do change route set
               
# during the dialog.
                record_route
();
           
}
           
# route it out to whatever destination was set by loose_route()
           
# in $du (destination URI).
            route
(1);
       
} else {
           
/* uncomment the following lines if you want to enable presence */
           
if (is_method("SUBSCRIBE|NOTIFY")) {
           
##  # in-dialog subscribe requests
                route
(2);
               
exit;
           
}
           
if ( is_method("ACK") ) {
               
if ( t_check_trans() ) {
                   
# non loose-route, but stateful ACK; must be an ACK after
                   
# a 487 or e.g. 404 from upstream server
                    t_relay
();
                   
exit;
               
} else {
                   
# ACK without matching transaction ->
                   
# ignore and discard
                   
exit;
               
}
           
}
            sl_send_reply
("404","Not here");
       
}
       
exit;
   
}
   
#initial requests

   
# CANCEL processing
   
if (is_method("CANCEL"))
   
{
       
if (t_check_trans())
            t_relay
();
       
exit;
   
}

    t_check_trans
();

   
# authenticate if from local subscriber (uncomment to enable auth)
   
# authenticate all initial non-REGISTER request that pretend to be
   
# generated by local subscriber (domain from FROM URI is local)
   
##if (!(method=="REGISTER") && from_uri==myself) /*no multidomain version*/
   
##if (!(method=="REGISTER") && is_from_local())  /*multidomain version*/
   
##{
   
##  if (!proxy_authorize("", "subscriber")) {
   
##      proxy_challenge("", "0");
   
##      exit;
   
##  }
   
##  if (!db_check_from()) {
   
##      sl_send_reply("403","Forbidden auth ID");
   
##      exit;
   
##  }
   
##
   
##  consume_credentials();
   
##  # caller authenticated
   
##}

   
# preloaded route checking
   
if (loose_route()) {
        xlog
("L_ERR",
       
"Attempt to route with preloaded Route's [$fu/$tu/$ru/$ci]");
       
if (!is_method("ACK"))
            sl_send_reply
("403","Preload Route denied");
       
exit;
   
}
 
   
# handle initial presence messages
   
if(uri==myself || uri=~"sip:.+gmail.com" || uri=~"sip:.+@xmpp.domain.com") # detect if it's for an XMPP user
   
{
       
if( is_method("PUBLISH|SUBSCRIBE"))
            route
(2);
   
};

   
# handle xmpp messages
   
if(is_method("MESSAGE") && (uri=~"sip:.+gmail.com" || uri=~"sip:.+@xmpp.domain.com"))
   
{
       
if(!t_newtran())
       
{
            sl_reply_error
();
           
exit;
       
}
       
if (xmpp_send_message()) {
            t_reply
("200", "Accepted");
       
} else {
            t_reply
("404", "Not found");
       
}
       
exit;
   
};

   
# record routing
   
if (!is_method("REGISTER|MESSAGE"))
        record_route
();

   
# account only INVITEs
   
if (is_method("INVITE")) {
        setflag
(1); # do accounting
   
}
   
if (!uri==myself)
   
## replace with following line if multi-domain support is used
   
##if (!is_uri_host_local())
   
{
        append_hf
("P-hint: outbound\r\n");
       
# if you have some interdomain connections via TLS
       
##if($rd=="tls_domain1.net") {
       
##  t_relay("tls:domain1.net");
       
##  exit;
       
##} else if($rd=="tls_domain2.net") {
       
##  t_relay("tls:domain2.net");
       
##  exit;
       
##}
        route
(1);
   
}

   
# requests for my domain

   
if (is_method("REGISTER"))
   
{
       
# authenticate the REGISTER requests (uncomment to enable auth)
       
##if (!www_authorize("", "subscriber"))
       
##{
       
##  www_challenge("", "0");
       
##  exit;
       
##}
       
##
       
##if (!db_check_to())
       
##{
       
##  sl_send_reply("403","Forbidden auth ID");
       
##  exit;
       
##}

       
if (!save("location"))
            sl_reply_error
();

       
exit;
   
}

   
if ($rU==NULL) {
       
# request with no Username in RURI
        sl_send_reply
("484","Address Incomplete");
       
exit;
   
}

   
# apply DB based aliases (uncomment to enable)
   
##alias_db_lookup("dbaliases");

   
# do lookup with method filtering
   
if (!lookup("location","m")) {
       
switch ($retcode) {
           
case -1:
           
case -3:
                t_newtran
();
                t_reply
("404", "Not Found");
               
exit;
           
case -2:
                sl_send_reply
("405", "Method Not Allowed");
               
exit;
       
}
   
}

   
# when routing via usrloc, log the missed calls also
    setflag
(2);

    route
(1);
}


route
[1] {
   
# send it out now; use stateful forwarding as it works reliably
   
# even for UDP2TCP

   
if (!t_relay()) {
        sl_reply_error
();
   
};
   
exit;
}

route
[2] {
   
# create new transaction to catch retransmissions
   
if(!t_newtran())
   
{
        sl_reply_error
();
       
exit;
   
}

   
# if it is Notify - for xmpp gateway
   
if( is_method("NOTIFY"))
   
{
        t_reply
("200", "OK");
        pua_xmpp_notify
();
       
exit;
   
}

   
# handle presence specific messages
   
if(is_method("PUBLISH"))
   
{
        handle_publish
();
   
}
   
else
   
if(is_method("SUBSCRIBE"))
   
{
        handle_subscribe
();
       
if($hdr(Event)== "presence" && (uri=~"sip:.+gmail.com" || uri=~"sip:.+@xmpp.domain.com") )
            pua_xmpp_req_winfo
("$ruri", "$hdr(Expires)");
   
}
   
exit;
}

   

Page last modified on July 02, 2014, at 01:50 PM