1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
|
mangler Module
Gabriel Vasile
FhG FOKUS
Edited by
Gabriel Vasile
Copyright 2003 Fill in here
_________________________________________________________
Table of Contents
1. User's Guide
1.1. Overview
1.2. Dependencies
1.2.1. OpenSER Modules
1.2.2. External Libraries or Applications
1.3. Exported Parameters
1.3.1. contact_flds_separator (string)
1.4. Exported Functions
1.4.1. sdp_mangle_ip(pattern, newip)
1.4.2. sdp_mangle_port(offset)
1.4.3. encode_contact(encoding_prefix)
1.4.4. decode_contact()
1.4.5. decode_contact_header()
2. Developer's Guide
3. Frequently Asked Questions
List of Examples
1-1. Set db_url parameter
1-2. sdp_mangle_ip usage
1-3. sdp_mangle_port usage
1-4. encode_contact usage
1-5. decode_contact usage
1-6. decode_contact_header usage
_________________________________________________________
Chapter 1. User's Guide
1.1. Overview
This is a module to help with SDP mangling. Still in testing.
_________________________________________________________
1.2. Dependencies
1.2.1. OpenSER Modules
The following modules must be loaded before this module:
* No dependencies on other OpenSER modules.
_________________________________________________________
1.2.2. External Libraries or Applications
The following libraries or applications must be installed
before running OpenSER with this module loaded:
* None.
_________________________________________________________
1.3. Exported Parameters
1.3.1. contact_flds_separator (string)
First char of this parameter is used as separator for
encoding/decoding Contact header.
Warning
First char of this field must be set to a value which is not
used inside username,password or other fields of contact.
Otherwise it is possible for the decoding step to fail/produce
wrong results.
Default value is "*".
Example 1-1. Set db_url parameter
...
modparam("mangler", "contact_flds_separator", "-")
...
then an encoded uri might look
sip:user-password-ip-port-protocol@PublicIP
_________________________________________________________
1.4. Exported Functions
1.4.1. sdp_mangle_ip(pattern, newip)
Changes IP addresses inside SDP package in lines describing
connections like c=IN IP4 Currently in only changes IP4
addresses since IP6 probably will not need to traverse NAT :)
The function returns negative on error, or number of
replacements + 1.
Meaning of the parameters is as follows:
* pattern - A pair ip/mask used to match IP's located inside
SDP package in lines c=IN IP4 ip. This lines will only be
mangled if located IP is in the network described by this
pattern. Examples of valid patterns are
"10.0.0.0/255.0.0.0" or "10.0.0.0/8" etc.
* newip - A string representing the new IP to be put inside
SDP package if old IP address matches pattern.
This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE.
Example 1-2. sdp_mangle_ip usage
...
sdp_mangle_ip("10.0.0.0/8","193.175.135.38");
...
_________________________________________________________
1.4.2. sdp_mangle_port(offset)
Changes ports inside SDP package in lines describing media
like m=audio 13451.
The function returns negative on error, or number of
replacements + 1.
Meaning of the parameters is as follows:
* offset - A string representing an integer which will be
added/subtracted from the located port.
This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE.
Example 1-3. sdp_mangle_port usage
...
sdp_mangle_port("-12000");
...
_________________________________________________________
1.4.3. encode_contact(encoding_prefix)
This function will encode uri-s inside Contact header in the
following manner
sip:username:password@ip:port;transport=protocol goes
sip:enc_pref*username*ip*port*protocol@public_ip * is the
default separator.
The function returns negative on error, 1 on success.
Meaning of the parameters is as follows:
* encoding_prefix - Something to allow us to determine that
a contact is encoded publicip--a routable IP, most
probably you should put your external IP of your NAT box.
This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE.
Example 1-4. encode_contact usage
...
if (src_ip == 10.0.0.0/8) encode_contact("enc_prefix","193.175.135.38")
;
...
_________________________________________________________
1.4.4. decode_contact()
This function will decode the URI in first line in packets
which come with encoded URI in the following manner
sip:enc_pref*username*ip*port*protocol@public_ip goes to
sip:username:password@ip:port;transport=protocol It uses the
default set parameter for contact encoding separator.
The function returns negative on error, 1 on success.
Meaning of the parameters is as follows:
This function can be used from REQUEST_ROUTE.
Example 1-5. decode_contact usage
...
if (uri =~ "^enc*") { decode_contact(); }
...
_________________________________________________________
1.4.5. decode_contact_header()
This function will decode URIs inside Contact header in the
following manner
sip:enc_pref*username*ip*port*protocol@public_ip goes to
sip:username:password@ip:port;transport=protocol. It uses the
default set parameter for contact encoding separator.
The function returns negative on error, 1 on success.
Meaning of the parameters is as follows:
This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE.
Example 1-6. decode_contact_header usage
...
if (uri =~ "^enc*") { decode_contact_header(); }
...
_________________________________________________________
Chapter 2. Developer's Guide
The module does not provide any API to use in other OpenSER
modules.
_________________________________________________________
Chapter 3. Frequently Asked Questions
3.1. Where can I find more about OpenSER?
3.2. Where can I post a question about this module?
3.3. How can I report a bug?
3.1. Where can I find more about OpenSER?
Take a look at http://openser.org/.
3.2. Where can I post a question about this module?
First at all check if your question was already answered on
one of our mailing lists:
* User Mailing List -
http://openser.org/cgi-bin/mailman/listinfo/users
* Developer Mailing List -
http://openser.org/cgi-bin/mailman/listinfo/devel
E-mails regarding any stable OpenSER release should be sent to
<users@openser.org> and e-mails regarding development versions
should be sent to <devel@openser.org>.
If you want to keep the mail private, send it to
<team@openser.org>.
3.3. How can I report a bug?
Please follow the guidelines provided at:
http://sourceforge.net/tracker/?group_id=139143.
|
