Stun Module

A stun server working with the same port as SIP (5060) in order to gain accurate information. The benefit would be an exact external address in the case of NATs translating differently when given different destination ports. The server may also advertise different network addresses than the ones it is actually listening on.

The stun server will use 4 sockets:

where ip1 / port1 represent an UDP SIP listener and ip2 / port2 are configured via the alternate_ip and alternate_port parameters.

The sockets come from existing SIP sockets or are created.

Socket1 must allways be a SIP UDP listener from OpenSIPS.

If use_listeners_as_primary is enabled the STUN server will actually use multiple sets of sockets obtained from the IP/port combinations described above, each set corresponding to a SIP UDP listener from OpenSIPS.

The server will create a separate process. This process will listen for data on created sockets. The server will register a callback function to SIP. This function is called when a specific (stun)header is found.

This stun implements RFC3489 (and XOR_MAPPED_ADDRESS from RFC5389)

Not supported attributes:

and associated ERROR_CODEs

The following modules must be loaded before this module:

None.

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

The IP of an interface which is configured as an UDP SIP listener in OpenSIPS. This is a mandatory parameter, unless use_listeners_as_primary is enabled.

Syntax: "ip [/ advertised_ip]

By default, the primary_ip and the advertised primary_ip will be identical. This may be changed with an optional "/ xxx.xxx.xxx.xxx" string.

...
modparam("stun", "primary_ip", "192.168.0.100")

# Example of a STUN server within OpenSIPS which is behind NAT
modparam("stun", "primary_ip", "192.168.0.100 / 64.50.46.78")
...
				

The port configured (together with the primary_ip) as an UDP SIP listener in OpenSIPS. The default value is 5060.

Syntax: "port [/ advertised_port]

By default, the primary_port and the advertised primary_port will be identical. This may be changed with an optional "/ adv_port" string.

...
modparam("stun", "primary_port", "5060")

# Listening on a primary port, but advertising a different one
modparam("stun", "primary_port", "5060 / 5062")
...
				

Another IP from another interface. This is a mandatory parameter.

If use_listeners_as_primary is enabled, the alternate IP must be either:

Syntax: "ip [/ advertised_ip]

By default, the alternate_ip and the advertised alternate_ip will be identical. This may be changed with an optional "/ xxx.xxx.xxx.xxx" string.

...
modparam("stun","alternate_ip","11.22.33.44")

# Example of a STUN server within OpenSIPS which is behind NAT
modparam("stun", "alternate_ip", "192.168.0.100 / 64.78.46.50")
...
				

The port used by the STUN server for the second interface. The default value is 3478 (default STUN port).

If use_listeners_as_primary is enabled, the alternate port must be either:

Syntax: "port [/ advertised_port]

By default, the alternate_port and the advertised alternate_port will be identical. This may be changed with an optional "/ adv_port" string.

...
modparam("stun","alternate_port","3479")

# Listening on an alternate port, but advertising a different one
modparam("stun", "alternate_port", "5060 / 5062")
...
				

Setting this parameter to 1 will allow all configured UDP SIP listeners to be automatically used as "primary" STUN sockets.

The primary_ip and primary_port parameters will be ignored when this behavior is enabled.

The default value is 0 (disabled).

...
modparam("stun","use_listeners_as_primary",1)
...