Merge "ast_coredumper: allow setting asterisk binary explicitly"
[asterisk/asterisk.git] / README-SERIOUSLY.bestpractices.txt
1 ==================
2 | Best Practices |
3 ==================
4
5 The purpose of this document is to define best practices when working with
6 Asterisk in order to minimize possible security breaches and to provide tried
7 examples in field deployments. This is a living document and is subject to
8 change over time as best practices are defined.
9
10 --------
11 Sections
12 --------
13
14 * Filtering Data:
15         How to protect yourself from redial attacks
16
17 * Proper Device Naming:
18         Why to not use numbered extensions for devices
19
20 * Secure Passwords:
21         Secure passwords limit your risk to brute force attacks
22
23 * Reducing Pattern Match Typos:
24         Using the 'same' prefix, or using Goto()
25
26 * Manager Class Authorizations:
27         Recognizing potential issues with certain classes of authorization
28
29 * Avoid Privilege Escalations:
30         Disable the ability to execute functions that may escalate privileges
31
32 ----------------
33 Additional Links
34 ----------------
35
36 Additional links that contain useful information about best practices or
37 security are listed below.
38
39 * Seven Steps to Better SIP Security:
40         http://blogs.digium.com/2009/03/28/sip-security/
41
42 * Asterisk VoIP Security (webinar):
43         http://www.asterisk.org/security/webinar/
44
45
46 ==============
47 Filtering Data
48 ==============
49
50 In the Asterisk dialplan, several channel variables contain data potentially
51 supplied by outside sources. This could lead to a potential security concern
52 where those outside sources may send cleverly crafted strings of data which
53 could be utilized, e.g. to place calls to unexpected locations.
54
55 An example of this can be found in the use of pattern matching and the ${EXTEN}
56 channel variable. Note that ${EXTEN} is not the only system created channel
57 variable, so it is important to be aware of where the data you're using is
58 coming from.
59
60 For example, this common dialplan takes 2 or more characters of data, starting
61 with a number 0-9, and then accepts any additional information supplied by the
62 request.
63
64 [NOTE: We use SIP in this example, but is not limited to SIP only; protocols
65        such as Jabber/XMPP or IAX2 are also susceptible to the same sort of
66        injection problem.]
67
68
69 [incoming]
70 exten => _X.,1,Verbose(2,Incoming call to extension ${EXTEN})
71 exten => _X.,n,Dial(SIP/${EXTEN})
72 exten => _X.,n,Hangup()
73
74 This dialplan may be utilized to accept calls to extensions, which then dial a
75 numbered device name configured in one of the channel configuration files (such
76 as sip.conf, iax.conf, etc...) (see the section Proper Device Naming for more
77 information on why this approach is flawed).
78
79 The example we've given above looks harmless enough until you take into
80 consideration that several channel technologies accept characters that could
81 be utilized in a clever attack. For example, instead of just sending a request
82 to dial extension 500 (which in our example above would create the string
83 SIP/500 and is then used by the Dial() application to place a call), someone
84 could potentially send a string like "500&SIP/itsp/14165551212".
85
86 The string "500&SIP/itsp/14165551212" would then be contained within the
87 ${EXTEN} channel variable, which is then utilized by the Dial() application in
88 our example, thereby giving you the dialplan line of:
89
90 exten => _X.,n,Dial(SIP/500&SIP/itsp/14165551212)
91
92 Our example above has now provided someone with a method to place calls out of
93 your ITSP in a place where you didn't expect to allow it. There are a couple of
94 ways in which you can mitigate this impact: stricter pattern matching, or using
95 the FILTER() dialplan function.
96
97 The CALLERID(num) and CALLERID(name) values are other commonly used values that
98 are sources of data potentially supplied by outside sources.  If you use these
99 values as parameters to the System(), MixMonitor(), or Monitor() applications
100 or the SHELL() dialplan function, you can allow injection of arbitrary operating
101 system command execution.  The FILTER() dialplan function is available to remove
102 dangerous characters from untrusted strings to block the command injection.
103
104 Strict Pattern Matching
105 -----------------------
106
107 The simple way to mitigate this problem is with a strict pattern match that does
108 not utilize the period (.) or bang (!) characters to match on one-or-more
109 characters or zero-or-more characters (respectively). To fine tune our example
110 to only accept three digit extensions, we could change our pattern match to
111 be:
112
113 exten => _XXX,n,Dial(SIP/${EXTEN})
114
115 In this way, we have minimized our impact because we're not allowing anything
116 other than the numbers zero through nine. But in some cases we really do need to
117 handle variable pattern matches, such as when dialing international numbers
118 or when we want to handle something like a SIP URI. In this case, we'll need to
119 utilize the FILTER() dialplan function.
120
121 Using FILTER()
122 --------------
123
124 The FILTER() dialplan function is used to filter strings by only allowing
125 characters that you have specified. This is a perfect candidate for controlling
126 which characters you want to pass to the Dial() application, or any other
127 application which will contain dynamic information passed to Asterisk from an
128 external source. Lets take a look at how we can use FILTER() to control what
129 data we allow.
130
131 Using our previous example to accept any string length of 2 or more characters,
132 starting with a number of zero through nine, we can use FILTER() to limit what
133 we will accept to just numbers. Our example would then change to something like:
134
135 [incoming]
136 exten => _X.,1,Verbose(2,Incoming call to extension ${EXTEN})
137 exten => _X.,n,Dial(SIP/${FILTER(0-9,${EXTEN})})
138 exten => _X.,n,Hangup()
139
140 Note how we've wrapped the ${EXTEN} channel variable with the FILTER() function
141 which will then only pass back characters that fit into the numerical range that
142 we've defined.
143
144 Alternatively, if we didn't want to utilize the FILTER() function within the
145 Dial() application directly, we could save the value to a channel variable,
146 which has a side effect of being usable in other locations of your dialplan if
147 necessary, and to handle error checking in a separate location.
148
149 [incoming]
150 exten => _X.,1,Verbose(2,Incoming call to extension ${EXTEN})
151 exten => _X.,n,Set(SAFE_EXTEN=${FILTER(0-9,${EXTEN})})
152 exten => _X.,n,Dial(SIP/${SAFE_EXTEN})
153 exten => _X.,n,Hangup()
154
155 Now we can use the ${SAFE_EXTEN} channel variable anywhere throughout the rest
156 of our dialplan, knowing we've already filtered it. We could also perform an
157 error check to verify that what we've received in ${EXTEN} also matches the data
158 passed back by FILTER(), and to fail the call if things do not match.
159
160 [incoming]
161 exten => _X.,1,Verbose(2,Incoming call to extension ${EXTEN})
162 exten => _X.,n,Set(SAFE_EXTEN=${FILTER(0-9,${EXTEN})})
163 exten => _X.,n,GotoIf($[${EXTEN} != ${SAFE_EXTEN}]?error,1)
164 exten => _X.,n,Dial(SIP/${SAFE_EXTEN})
165 exten => _X.,n,Hangup()
166
167 exten => error,1,Verbose(2,Values of EXTEN and SAFE_EXTEN did not match.)
168 exten => error,n,Verbose(2,EXTEN: "${EXTEN}" -- SAFE_EXTEN: "${SAFE_EXTEN}")
169 exten => error,n,Playback(silence/1&invalid)
170 exten => error,n,Hangup()
171
172 Another example would be using FILTER() to control the characters we accept when
173 we're expecting to get a SIP URI for dialing.
174
175 [incoming]
176 exten => _[0-9a-zA-Z].,1,Verbose(2,Incoming call to extension ${EXTEN})
177 exten => _[0-9a-zA-Z].,n,Dial(SIP/${FILTER(.@0-9a-zA-Z,${EXTEN})
178 exten => _[0-9a-zA-Z].,n,Hangup()
179
180 Of course the FILTER() function doesn't check the formatting of the incoming
181 request. There is also the REGEX() dialplan function which can be used to
182 determine if the string passed to it matches the regular expression you've
183 created, and to take proper action on whether it matches or not. The creation of
184 regular expressions is left as an exercise for the reader.
185
186 More information about the FILTER() and REGEX() dialplan functions can be found
187 by typing "core show function FILTER" and "core show function REGEX" from your
188 Asterisk console.
189
190
191 ====================
192 Proper Device Naming
193 ====================
194
195 In Asterisk, the concept of an extension number being tied to a specific device
196 does not exist. Asterisk is aware of devices it can call or receive calls from,
197 and how you define in your dialplan how to reach those devices is up to you.
198
199 Because it has become common practice to think of a specific device as having an
200 extension number associated with it, it only becomes natural to think about
201 naming your devices the same as the extension number you're providing it. But
202 by doing this, you're limiting the powerful concept of separating user from
203 extensions, and extensions from devices.
204
205 It can also be a security hazard to name your devices with a number, as this can
206 open you up to brute force attacks. Many of the current exploits deal with
207 device configurations which utilize a number, and even worse, a password that
208 matches the devices name. For example, take a look at this poorly created device
209 in sip.conf:
210
211 [1000]
212 type=friend
213 context=international_dialing
214 secret=1000
215
216 As implied by the context, we've permitted a device named 1000 with a password
217 of 1000 to place calls internationally. If your PBX system is accessible via
218 the internet, then your system will be vulnerable to expensive international
219 calls. Even if your system is not accessible via the internet, people within
220 your organization could get access to dialing rules you'd prefer to reserve only
221 for certain people.
222
223 A more secure example for the device would be to use something like the MAC
224 address of the device, along with a strong password (see the section Secure
225 Passwords). The following example would be more secure:
226
227 [0004f2040001]
228 type=friend
229 context=international_dialing
230 secret=aE3%B8*$jk^G
231
232 Then in your dialplan, you would reference the device via the MAC address of the
233 device (or if using the softphone, a MAC address of a network interface on the
234 computer).
235
236 Also note that you should NOT use this password, as it will likely be one of the
237 first ones added to the dictionary for brute force attacks.
238
239
240 ================
241 Secure Passwords
242 ================
243
244 Secure passwords are necessary in many (if not all) environments, and Asterisk
245 is certainly no exception, especially when it comes to expensive long distance
246 calls that could potentially cost your company hundreds or thousands of dollars
247 on an expensive monthly phone bill, with little to no recourse to fight the
248 charges.
249
250 Whenever you are positioned to add a password to your system, whether that is
251 for a device configuration, a database connection, or any other secure
252 connection, be sure to use a secure password. A good example of a secure
253 password would be something like:
254
255 aE3%B8*$jk^G
256
257 Our password also contains 12 characters with a mixture of upper and
258 lower case characters, numbers, and symbols. Because these passwords are likely
259 to only be entered once, or loaded via a configuration file, there is
260 no need to create simple passwords, even in testing. Some of the holes found in
261 production systems used for exploitations involve finding the one test extension
262 that contains a weak password that was forgotten prior to putting a system into
263 production.
264
265 Using a web search you can find several online password generators such as
266 http://www.strongpasswordgenerator.com or there are several scripts that can be
267 used to generate a strong password.
268
269
270 ============================
271 Reducing Pattern Match Typos
272 ============================
273
274 As of Asterisk 1.6.2, a new method for reducing the number of complex pattern
275 matches you need to enter, which can reduce typos in your dialplan, has been
276 implemented. Traditionally, a dialplan with a complex pattern match would look
277 something like:
278
279 exten => _[3-5]XXX,1,Verbose(Incoming call to ${EXTEN})
280 exten => _[3-5]XXX,n,Set(DEVICE=${DB(device/mac_address/${EXTEN})})
281 exten => _[3-5]XXX,n,Set(TECHNOLOGY=${DB(device/technology/${EXTEN})})
282 exten => _[3-5]XXX,n,GotoIf($[${ISNULL(${TECHNOLOGY})} | ${ISNULL(${DEVICE})}]?error,1)
283 exten => _[3-5]XXX,n,Dial(${TECHNOLOGY}/${DEVICE},${GLOBAL(TIMEOUT)})
284 exten => _[3-5]XXX,n,Set(vmFlag=${IF($[${DIALSTATUS} = BUSY]?b:u)})
285 exten => _[3-5]XXX,n,Voicemail(${EXTEN}@${GLOBAL(VOICEMAIL_CONTEXT)},${vmFlag})
286 exten => _[3-5]XXX,n,Hangup()
287
288 exten => error,1,Verbose(2,Unable to lookup technology or device for extension)
289 exten => error,n,Playback(silence/1&num-not-in-db)
290 exten => error,n,Hangup()
291
292 Of course there exists the possibility for a typo when retyping the pattern
293 match _[3-5]XXX which will match on extensions 3000 through 5999. We can
294 minimize this error by utilizing the same => prefix on all lines beyond the
295 first one. Our same dialplan with using same => would look like the following:
296
297 exten => _[3-5]XXX,1,Verbose(Incoming call to ${EXTEN})
298 same => n,Set(DEVICE=${DB(device/mac_address/${EXTEN})})
299 same => n,Set(TECHNOLOGY=${DB(device/technology/${EXTEN})})
300 same => n,GotoIf($[${ISNULL(${TECHNOLOGY})} | ${ISNULL(${DEVICE})}]?error,1)
301 same => n,Dial(${TECHNOLOGY}/${DEVICE},${GLOBAL(TIMEOUT)})
302 same => n,Set(vmFlag=${IF($[${DIALSTATUS} = BUSY]?b:u)})
303 same => n,Voicemail(${EXTEN}@${GLOBAL(VOICEMAIL_CONTEXT)},${vmFlag})
304 same => n,Hangup()
305
306 exten => error,1,Verbose(2,Unable to lookup technology or device for extension)
307 same => n,Playback(silence/1&num-not-in-db)
308 same => n,Hangup()
309
310
311 ============================
312 Manager Class Authorizations
313 ============================
314
315 Manager accounts have associated class authorizations that define what actions
316 and events that account can execute/receive.  In order to run Asterisk commands
317 or dialplan applications that affect the system Asterisk executes on, the
318 "system" class authorization should be set on the account.
319
320 However, Manager commands that originate new calls into the Asterisk dialplan
321 have the potential to alter or affect the system as well, even though the
322 class authorization for origination commands is "originate".  Take, for example,
323 the Originate manager command:
324
325 Action: Originate
326 Channel: SIP/foo
327 Exten: s
328 Context: default
329 Priority: 1
330 Application: System
331 Data: echo hello world!
332
333 This manager command will attempt to execute an Asterisk application, System,
334 which is normally associated with the "system" class authorication.  While some
335 checks have been put into Asterisk to take this into account, certain dialplan
336 configurations and/or clever manipulation of the Originate manager action can
337 circumvent these checks.  For example, take the following dialplan:
338
339 exten => s,1,Verbose(Incoming call)
340 same => n,MixMonitor(foo.wav,,${EXEC_COMMAND})
341 same => n,Dial(SIP/bar)
342 same => n,Hangup()
343
344 Whatever has been defined in the variable EXEC_COMMAND will be executed after
345 MixMonitor has finished recording the call.  The dialplan writer may have
346 intended that this variable to be set by some other location in the dialplan;
347 however, the Manager action Originate allows for channel variables to be set by
348 the account initiating the new call.  This could allow the Originate action to
349 execute some command on the system by setting the EXEC_COMMAND dialplan variable
350 in the Variable: header.
351
352 In general, you should treat the Manager class authorization "originate" the
353 same as the class authorization "system".  Good system configuration, such as
354 not running Asterisk as root, can prevent serious problems from arising when
355 allowing external connections to originate calls into Asterisk.
356
357 ===========================
358 Avoid Privilege Escalations
359 ===========================
360
361 External control protocols, such as Manager, often have the ability to get and
362 set channel variables; which allows the execution of dialplan functions.
363
364 Dialplan functions within Asterisk are incredibly powerful, which is wonderful
365 for building applications using Asterisk. But during the read or write
366 execution, certain diaplan functions do much more. For example, reading the
367 SHELL() function can execute arbitrary commands on the system Asterisk is
368 running on. Writing to the FILE() function can change any file that Asterisk has
369 write access to.
370
371 When these functions are executed from an external protocol, that execution
372 could result in a privilege escalation. Asterisk can inhibit the execution of
373 these functions, if live_dangerously in the [options] section of asterisk.conf
374 is set to no.
375
376 In Asterisk 12 and later, live_dangerously defaults to no.