1RTPPROXY(8) [FIXME: manual] RTPPROXY(8)
2
6 rtpproxy - RTP (Real-time Transport Protocol) Proxy Server
7
9 rtpproxy [-?] [-2] [-f] [-v] [-R] [-l addr1[/addr2]] [-6 addr1[/addr2]]
10 [-s ctrl_socket] [-t tos] [-p pidfile] [-T max_ttl]
11 [-r rdir [-S sdir]] [-m min_port] [-M max_port]
12 [-u uname[:gname]] [-F] [-i] [-n timeout_socket] [-P] [-a]
13 [-d log_level[:log_facility]]
14
16 rtpproxy is a symmetric RTP proxy designed to be used in conjunction
17 with the SIP Express Router (SER) or any other SIP proxy or SIP B2BUA
18 capable of rewriting SDP bodies in SIP messages that it processes.
19 The main purpose of rtpproxy is to make the communication between SIP
21 user agents behind NAT(s) (Network Address Translator) possible.
22 Several cases exists when direct end-to-end communication is not
23 possible and RTP streams have to be relayed through another host.
24 Rtpproxy can be used to setup such a relaying host.
25 When two listen interfaces have been specified using the command line
27 parameters described below then rtpproxy will enter so called bridging
28 mode. In briding mode rtpproxy forwards RTP packets received on one
29 interface to the other interface and vice versa. This mode can be used
30 to forward RTP packets between networks without direct network level
31 connectivy (provided that the host running rtpproxy has one interface
32 in both of them). One particular application of bridging mode is
33 IPv4/IPv6 traversal of RTP packets.
34 When instructured by SER rtpproxy can also record the entire RTP
36 session in a file on a local harddisk or play a pre-recorded file to
37 the user agent (so called Music-on-Hold).
38
40 -?
41 Show summary of options.
42 -2
44 Send every RTP packet twice in sessions that use low-bitrate
45 codecs. Only packets that are smaller than 128 bytes will be sent
46 twice. This option can improve audio quality on lossy links.
47 -f
49 Rtpproxy will stay in foreground mode if this option is set.
50 -v
52 Show version of program.
53 -l addr1[/addr2]
55 IPv4 listen IP address(es). You can specify either one or two
56 addresses. If two addresses have been specified then rtpproxy will
57 work in bridging mode.
58 -6 addr1[/addr2]
60 IPv6 listen IP address(es). You can specify either one or two
61 addresses. If two addresses have been specified then rtpproxy will
62 work in bridging mode.
63 -s ctrl_socket
65 This parameter configures rtpproxy control socket. The control
66 socket is used by nathelper module of SER to create/modify/delete
67 RTP sessions to be relayed. Format of ctrl_socket is
68 <type>:<socket>. Following types are supported:
69 · udp: Create UDP control socket. In this mode RTPProxy will
71 listen on UDP for control messages from SER/nathelper.
72 Example: -s udp:127.0.0.1:9000
74 IP address can be ´*´ in which case rtpproxy will listen on all
76 local interfaces. If omitted port 22222 is used.
77 Note
79 RTPProxy control protocol has no built-in security
80 mechanisms. Make sure that you protect the listening IP and
81 port properly when using RTPProxy with UDP control socket.
82 · udp6: Create IPv6 UDP control socket. In this mode RTPProxy
84 will listen on UDP/IPv6 for control messages from
85 SER/nathelper.
86 Example: -s udp6:::1:9000
88 · unix: Create UNIX domain socket for control interface. In this
90 mode SER/nathelper and RTPProxy must be running on the same
91 host. This is the default setting for both SER/nathelper and
92 rtpproxy.
93 Example: -s unix:/var/run/rtpproxy.sock
95 Default value is /var/run/rtpproxy.sock.
97 -t tos
99 Set ToS (Type of Service) in the outgoing UDP packets to this
100 value. Default value is 0xB8. Setting this parameter to -1
101 disables setting ToS resulting in operating system default ToS
102 being used instead.
103 -r rec_dir
105 Directory where recorded RTP sessions will be stored.
106 -S spool_dir
108 Spool directory for RTP sessions being recorded. The file will
109 be moved to directory configured in -r option after the session
110 finishes.
111 -R
113 Do not record RTCP when recording an RTP session. This option
114 is disabled (rtpproxy will record RTCP) by default.
115 -p pid_file
117 This parameter configures the name of the file where PID of
118 running rtpproxy will be stored. Default is
119 /var/run/rtpproxy.pid.
120 -T max_ttl
122 Limit the maximum TTL (Time To Live) of outgoing IP packets to
123 the value of max_ttl.
124 -m min_port
126 Set lower limit on UDP ports range that the RTPproxy uses for
127 RTP/RTCP sessions to min_port. Default is 35000.
128 -M max_port
130 Set upper limit on UDP ports range that the RTPproxy uses for
131 RTP/RTCP sessions to max_port. Default is 65000.
132 -u uname[:gname]
134 Switch RTPproxy to UID identified by the uname and optional GID
135 identified by gname when proxy is up and running.
136 -F
138 By default the RTPproxy will warn user if running as superuser
139 (UID 0) in local control mode and refuse to run in remote
140 control mode at all. This switch removes the check.
141 -i
143 Enable independent timeout mode. By default, a timeout (which
144 results in automatic destruction of the session) can only occur
145 if no RTP packets are received on any of the session´s ports.
146 This option if set varies that behaviour, such that a timeout
147 will occur if packets are still being received on one port but
148 not the other. The option should be used with caution since in
149 some cases it´s perfectly fine to have packets coming from only
150 one side of conversation (i.e. when the second party has muted
151 its audio).
152 -n timeout_socket
154 This parameter configures the optional timeout notification
155 socket. The socket should be created by another application,
156 preferably before starting rtpproxy. For those sessions where
157 the timeout mechanism is enabled, notifications are sent on
158 this socket if the session times out.
159 Example: -n unix:/var/run/rtpproxy_timeout.sock
161 There is no default value, notifications are not sent and not
163 permitted unless a value is specified explicitly.
164 -P
166 Record sessions using PCAP file format instead of non-standard
167 ad-hoc format. The PCAP format, which is the de-facto standard
168 for packet capturing software, has the advantage of being
169 compatible with numerous third-party tools and utilities, such
170 as Wireshark (Ethereal) for example. The drawback of PCAP is
171 sligtly larger overhead (extra 12 bytes for every saved RTP
172 packet for IPv4). Also, recording IPv6 sessions in PCAP format
173 is not supported at the moment.
174 -a
176 Record all sessions going through the RTPproxy unconditionally.
177 By default the RTPproxy requires call control software (i.e.
178 SER, OpenSER or B2BUA) to enable recording explicitly on
179 per-session basis by sending appropriate record command.
180 -d log_level[:log_facility]
182 This parameter configures the verbosity level of the log
183 output. Possible log_level values in the order from the most
184 verboe to the least verbose are: DBUG, INFO, WARN, ERR and
185 CRIT.
186 The optional log_facility parameter sets syslog(3) facility
188 assigned to log messages.
189 Example: -d WARN:LOG_LOCAL5
191 The default level in foreground mode is is DBUG, in background
193 - WARN and facility is LOG_DAEMON.
194
196 When SER receives an INVITE request, it extracts Call-ID from it and
197 communicates it to rtpproxy via Unix domain socket or UDP. Rtproxy
198 looks for an existing session with such Call-ID. If the session exists
199 it returns UDP port for that session, if not, then it creates a new
200 session, binds to a first empty UDP port from the range specified at
201 the compile time and returns number of that port to a SER. After
202 receiving reply from the proxy, SER replaces media ip:port in the SDP
203 to point to the proxy and forwards request as usually.
204 When SER receives a non-negative SIP reply with SDP it again extracts
206 Call-ID from it and communicates it to the proxy. In this case the
207 proxy does not allocate a new session if it doesn´t exist, but simply
208 performs a lookup among existing sessions and returns either a port
209 number if the session is found, or error code indicating that there is
210 no session with such id. After receiving positive reply from the proxy,
211 SER replaces media ip:port in the SIP reply to point to the proxy and
212 forwards reply as usually.
213 After the session has been created, the proxy listens on the port it
215 has allocated for that session and waits for receiving at least one UDP
216 packet from each of two parties participating in the call. Once such
217 packet is received, the proxy fills one of two ip:port structures
218 associated with each call with source ip:port of that packet. When both
219 structures are filled in, the proxy starts relaying UDP packets between
220 parties.
221 The proxy tracks idle time for each of existing sessions (i.e. the time
223 within which there were no packets relayed), and automatically cleans
224 up a sessions whose idle times exceed the value specified at compile
225 time (60 seconds by default).
226
228 /usr/sbin/rtpproxy
229
231 This program is licensed under the BSD license. See COPYING file in the
232 rtpproxy sources for details.
233
235 The latest version of this program can be found at
236 http://www.rtpproxy.org/.
237
239 ser(8).
240
242 Maxim Sobolev
243 Author.
244
246 CopyrightCopyright © 2006 janakj
247[FIXME: source] Jun 16, 2008 RTPPROXY(8)