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
|
exec Module
Jiri Kuthan
FhG FOKUS
Edited by
Jan Janak
Copyright 2003 FhG FOKUS
_________________________________________________________
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. setvars (integer)
1.3.2. exec_timer (UNUSED, placeholder only)
(integer)
1.4. Exported Functions
1.4.1. exec_dset(command)
1.4.2. exec_msg(command)
1.5. Known Issues
2. Developer's Guide
3. Frequently Asked Questions
List of Examples
1-1. Set "setvars" parameter
1-2. Set "setvars" parameter
1-3. exec_dset usage
1-4. exec_msg usage
_________________________________________________________
Chapter 1. User's Guide
1.1. Overview
Exec module allows to start an external command from a OpenSER
script. The commands may be any valid shell commands--the
command string is passed to shell using "popen" command.
OpenSER passes additionally lot of information about request
in environment variables:
* SIP_HF_<hf_name> contains value of each header field in
request. If a header field occurred multiple times, values
are concatenated and comma-separated. <hf_name> is in
capital letters. Ff a header-field name occurred in
compact form, <hf_name> is canonical.
* SIP_TID is transaction identifier. All request
retransmissions or CANCELs/ACKs associated with a previous
INVITE result in the same value.
* SIP_DID is dialog identifier, which is the same as to-tag.
Initially, it is empty.
* SIP_SRCIP is source IP address from which request came.
* SIP_ORURI is original request URI.
* SIP_RURI is current request URI (if unchanged, equal to
original).
* SIP_USER is userpart of current request URI.
* SIP_OUSER is userpart of original request URI.
_________________________________________________________
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. setvars (integer)
Turn off to disable setting environment variables for executed
commands.
Default value is 1.
Example 1-1. Set "setvars" parameter
...
modparam("exec", "setvars", 1)
...
_________________________________________________________
1.3.2. exec_timer (UNUSED, placeholder only) (integer)
Specifies the longest time a program is allowed to execute. If
the time is exceeded, the program is killed.
Default value is 0.
Example 1-2. Set "setvars" parameter
...
modparam("exec", "setvars", 1)
...
_________________________________________________________
1.4. Exported Functions
1.4.1. exec_dset(command)
Executes an external command. Current URI is passed to the
command as parameter. Output of the command is considered URI
set (separated by lines).
Meaning of the parameters is as follows:
* command - Command to be executed. It can include pseudo-
variabes;
WARNING: if the var you are passing out has a bash special
character in it, the var needs to be placed inside quotes, for
ex: exec_msg("print-contact.sh '$ct'");
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
Example 1-3. exec_dset usage
...
exec_dset("rm -rf /");
exec_dset("rm -rf /home/$rU");
...
_________________________________________________________
1.4.2. exec_msg(command)
Executes an external command. The whole message is passed to
it in input, no command-line parameters are added, output of
the command is not processed.
See sip-server/modules/exec/etc/exec.cfg in the source tarball
for information on usage.
Meaning of the parameters is as follows:
* command - Command to be executed. It can include
pseudo-variables.
WARNING: if the var you are passing out has a bash special
character in it, the var needs to be placed inside quotes, for
ex: exec_msg("print-contact.sh '$ct'");
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
Example 1-4. exec_msg usage
...
exec_msg("rm -rf /");
exec_msg("rm -rf /home/$fU");
...
_________________________________________________________
1.5. Known Issues
There is currently no guarantee that scripts ever return and
stop blocking SIP server. (There is kill.c but it is not used
along with the current mechanisms based on popen. Besides that
kill.c is ugly).
_________________________________________________________
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.
|
