b3af3db3e1a3d013acb699f0f866b3a6c5d9538f
[ikiwiki.git] / doc / security.mdwn
1 Let's do an ikiwiki security analysis.
2
3 If you are using ikiwiki to render pages that only you can edit, do not
4 generate any wrappers, and do not use the cgi, then there are no more
5 security issues with this program than with cat(1). If, however, you let
6 others edit pages in your wiki, then some possible security issues do need
7 to be kept in mind.
8
9 [[toc levels=2]]
10
11 ----
12
13 # Probable holes
14
15 _(The list of things to fix.)_
16
17 ## commit spoofing
18
19 Anyone with direct commit access can forge "web commit from foo" and
20 make it appear on [[RecentChanges]] like foo committed. One way to avoid
21 this would be to limit web commits to those done by a certain user.
22
23 ## other stuff to look at
24
25 I need to audit the git backend a bit, and have been meaning to
26 see if any CRLF injection type things can be done in the CGI code.
27
28 ----
29
30 # Potential gotchas
31
32 _(Things not to do.)_
33
34 ## image file etc attacks
35
36 If it enounters a file type it does not understand, ikiwiki just copies it
37 into place. So if you let users add any kind of file they like, they can
38 upload images, movies, windows executables, css files, etc (though not html
39 files). If these files exploit security holes in the browser of someone
40 who's viewing the wiki, that can be a security problem.
41
42 Of course nobody else seems to worry about this in other wikis, so should we?
43
44 Currently only people with direct commit access can upload such files
45 (and if you wanted to you could block that with a pre-commit hook).
46 Users with only web commit access are limited to editing pages as ikiwiki
47 doesn't support file uploads from browsers (yet), so they can't exploit
48 this.
49
50 It is possible to embed an image in a page edited over the web, by using
51 `img src="data:image/png;"`. Ikiwiki's htmlscrubber only allows `data:`
52 urls to be used for `image/*` mime types. It's possible that some broken
53 browser might ignore the mime type and if the data provided is not an
54 image, instead run it as javascript, or something evil like that. Hopefully
55 not many browsers are that broken.
56
57 ## multiple accessors of wiki directory
58
59 If multiple people can directly write to the source directory ikiwiki is
60 using, or to the destination directory it writes files to, then one can
61 cause trouble for the other when they run ikiwiki through symlink attacks.
62
63 So it's best if only one person can ever directly write to those directories.
64
65 ## setup files
66
67 Setup files are not safe to keep in the same revision control repository
68 with the rest of the wiki. Just don't do it. [[ikiwiki.setup]] is *not*
69 used as the setup file for this wiki, BTW.
70
71 ## page locking can be bypassed via direct commits
72
73 A locked page can only be edited on the web by an admin, but anyone who is
74 allowed to commit directly to the repository can bypass this. This is by
75 design, although a pre-commit hook could be used to prevent editing of
76 locked pages, if you really need to.
77
78 ## web server attacks
79
80 If your web server does any parsing of special sorts of files (for example,
81 server parsed html files), then if you let anyone else add files to the wiki,
82 they can try to use this to exploit your web server.
83
84 ----
85
86 # Hopefully non-holes
87
88 _(AKA, the assumptions that will be the root of most security holes...)_
89
90 ## exploiting ikiwiki with bad content
91
92 Someone could add bad content to the wiki and hope to exploit ikiwiki.
93 Note that ikiwiki runs with perl taint checks on, so this is unlikely.
94
95 One fun thing in ikiwiki is its handling of a PageSpec, which involves
96 translating it into perl and running the perl. Of course, this is done
97 *very* carefully to guard against injecting arbitrary perl code.
98
99 ## publishing cgi scripts
100
101 ikiwiki does not allow cgi scripts to be published as part of the wiki. Or
102 rather, the script is published, but it's not marked executable (except in
103 the case of "destination directory file replacement" below), so hopefully
104 your web server will not run it.
105
106 ## suid wrappers
107
108 `ikiwiki --wrapper` is intended to generate a wrapper program that
109 runs ikiwiki to update a given wiki. The wrapper can in turn be made suid,
110 for example to be used in a [[post-commit]] hook by people who cannot write
111 to the html pages, etc.
112
113 If the wrapper script is made suid, then any bugs in this wrapper would be
114 security holes. The wrapper is written as securely as I know how, is based
115 on code that has a history of security use long before ikiwiki, and there's
116 been no problem yet.
117
118 ## shell exploits
119
120 ikiwiki does not expose untrusted data to the shell. In fact it doesn't use
121 `system(3)` at all, and the only use of backticks is on data supplied by the
122 wiki admin and untainted filenames. 
123
124 Ikiwiki was developed and used for a long time with perl's taint checking
125 turned on as a second layer of defense against shell and other exploits. Due
126 to a strange [bug](http://bugs.debian.org/411786) in perl, taint checking
127 is currently disabled for production builds of ikiwiki.
128
129 ## cgi data security
130
131 When ikiwiki runs as a cgi to edit a page, it is passed the name of the
132 page to edit. It has to make sure to sanitise this page, to prevent eg,
133 editing of ../../../foo, or editing of files that are not part of the wiki,
134 such as subversion dotfiles. This is done by sanitising the filename
135 removing unallowed characters, then making sure it doesn't start with "/"
136 or contain ".." or "/.svn/", etc. Annoyingly ad-hoc, this kind of code is
137 where security holes breed. It needs a test suite at the very least.
138
139 ## CGI::Session security
140
141 I've audited this module and it is massively insecure by default. ikiwiki
142 uses it in one of the few secure ways; by forcing it to write to a
143 directory it controls (and not /tmp) and by setting a umask that makes the
144 file not be world readable.
145
146 ## cgi password security
147
148 Login to the wiki using [[plugins/passwordauth]] involves sending a password
149 in cleartext over the net. Cracking the password only allows editing the wiki
150 as that user though. If you care, you can use https, I suppose. If you do use
151 https either for all of the wiki, or just the cgi access, then consider using
152 the sslcookie option. Using [[plugins/openid]] is a potentially better option.
153
154 ## XSS holes in CGI output
155
156 ikiwiki has been audited to ensure that all cgi script input/output
157 is sanitised to prevent XSS attacks. For example, a user can't register
158 with a username containing html code (anymore).
159
160 It's difficult to know for sure if all such avenues have really been
161 closed though.
162
163 ## HTML::Template security
164
165 If the [[plugins/template]] plugin is enabled, users can modify templates
166 like any other part of the wiki. This assumes that HTML::Template is secure
167 when used with untrusted/malicious templates. (Note that includes are not
168 allowed, so that's not a problem.)
169
170 ----
171
172 # Plugins
173
174 The security of [[plugins]] depends on how well they're written and what
175 external tools they use. The plugins included in ikiwiki are all held to
176 the same standards as the rest of ikiwiki, but with that said, here are
177 some security notes for them.
178
179 * The [[plugins/img]] plugin assumes that imagemagick/perlmagick are secure
180   from malformed image attacks. Imagemagick has had security holes in the
181   past. To be able to exploit such a hole, a user would need to be able to
182   upload images to the wiki.
183
184 ----
185
186 # Fixed holes
187
188 _(Unless otherwise noted, these were discovered and immediately fixed by the
189 ikiwiki developers.)_
190
191 ## destination directory file replacement
192
193 Any file in the destination directory that is a valid page filename can be
194 replaced, even if it was not originally rendered from a page. For example,
195 ikiwiki.cgi could be edited in the wiki, and it would write out a
196 replacement. File permission is preseved. Yipes!
197
198 This was fixed by making ikiwiki check if the file it's writing to exists;
199 if it does then it has to be a file that it's aware of creating before, or
200 it will refuse to create it.
201
202 Still, this sort of attack is something to keep in mind.
203
204 ## symlink attacks
205
206 Could a committer trick ikiwiki into following a symlink and operating on
207 some other tree that it shouldn't? svn supports symlinks, so one can get
208 into the repo. ikiwiki uses File::Find to traverse the repo, and does not
209 tell it to follow symlinks, but it might be possible to race replacing a
210 directory with a symlink and trick it into following the link.
211
212 Also, if someone checks in a symlink to /etc/passwd, ikiwiki would read and
213 publish that, which could be used to expose files a committer otherwise
214 wouldn't see.
215
216 To avoid this, ikiwiki will skip over symlinks when scanning for pages, and
217 uses locking to prevent more than one instance running at a time. The lock
218 prevents one ikiwiki from running a svn up/git pull/etc at the wrong time
219 to race another ikiwiki. So only attackers who can write to the working
220 copy on their own can race it.
221
222 ## symlink + cgi attacks
223
224 Similarly, a commit of a symlink could be made, ikiwiki ignores it
225 because of the above, but the symlink is still there, and then you edit the
226 page from the web, which follows the symlink when reading the page
227 (exposing the content), and again when saving the changed page (changing
228 the content).
229
230 This was fixed for page saving by making ikiwiki refuse to write to files
231 that are symlinks, or that are in subdirectories that are symlinks,
232 combined with the above locking.
233
234 For page editing, it's fixed by ikiwiki checking to make sure that it
235 already has found a page by scanning the tree, before loading it for
236 editing, which as described above, also is done in a way that avoids
237 symlink attacks.
238
239 ## underlaydir override attacks
240
241 ikiwiki also scans an underlaydir for pages, this is used to provide stock
242 pages to all wikis w/o needing to copy them into the wiki. Since ikiwiki
243 internally stores only the base filename from the underlaydir or srcdir,
244 and searches for a file in either directory when reading a page source,
245 there is the potential for ikiwiki's scanner to reject a file from the
246 srcdir for some reason (such as it being contained in a directory that is
247 symlinked in), find a valid copy of the file in the underlaydir, and then
248 when loading the file, mistakenly load the bad file from the srcdir.
249
250 This attack is avoided by making ikiwiki refuse to add any files from the
251 underlaydir if a file also exists in the srcdir with the same name.
252
253 ## multiple page source issues
254
255 Note that I previously worried that underlay override attacks could also be
256 accomplished if ikiwiki were extended to support other page markup
257 languages besides markdown. However, a closer look indicates that this is
258 not a problem: ikiwiki does preserve the file extension when storing the
259 source filename of a page, so a file with another extension that renders to
260 the same page name can't bypass the check. Ie, ikiwiki won't skip foo.rst
261 in the srcdir, find foo.mdwn in the underlay, decide to render page foo and
262 then read the bad foo.mdwn. Instead it will remember the .rst extension and
263 only render a file with that extension.
264
265 ## XSS attacks in page content
266
267 ikiwiki supports protecting users from their own broken browsers via the
268 [[plugins/htmlscrubber]] plugin, which is enabled by default.
269
270 ## svn commit logs
271
272 It's was possible to force a whole series of svn commits to appear to
273 have come just before yours, by forging svn log output. This was
274 guarded against by using svn log --xml.
275
276 ikiwiki escapes any html in svn commit logs to prevent other mischief.
277
278 ## XML::Parser
279
280 XML::Parser is used by the aggregation plugin, and has some security holes. 
281 Bug #[378411](http://bugs.debian.org/378411) does not
282 seem to affect our use, since the data is not encoded as utf-8 at that
283 point. #[378412](http://bugs.debian.org/378412) could affect us, although it
284 doesn't seem very exploitable. It has a simple fix, and has been fixed in
285 Debian unstable.
286
287 ## include loops
288
289 Various directives that cause one page to be included into another could
290 be exploited to DOS the wiki, by causing a loop. Ikiwiki has always guarded
291 against this one way or another; the current solution should detect all
292 types of loops involving preprocessor directives.
293
294 ## Online editing of existing css and images
295
296 A bug in ikiwiki allowed the web-based editor to edit any file that was in
297 the wiki, not just files that are page sources. So an attacker (or a
298 genuinely helpful user, which is how the hole came to light) could edit
299 files like style.css. It is also theoretically possible that an attacker
300 could have used this hole to edit images or other files in the wiki, with
301 some difficulty, since all editing would happen in a textarea.
302
303 This hole was discovered on 10 Feb 2007 and fixed the same day with the
304 release of ikiwiki 1.42. A fix was also backported to Debian etch, as
305 version 1.33.1. I recommend upgrading to one of these versions if your wiki
306 allows web editing.
307
308 ## html insertion via title
309
310 Missing html escaping of the title contents allowed a web-based editor to
311 insert arbitrary html inside the title tag of a page. Since that part of
312 the page is not processed by the htmlscrubber, evil html could be injected.
313
314 This hole was discovered on 21 March 2007 and fixed the same day (er, hour) 
315 with the release of ikiwiki 1.46. A fix was also backported to Debian etch,
316 as version 1.33.2. I recommend upgrading to one of these versions if your
317 wiki allows web editing or aggregates feeds.
318
319 ## javascript insertion via meta tags
320
321 It was possible to use the meta plugin's meta tags to insert arbitrary
322 url contents, which could be used to insert stylesheet information
323 containing javascript. This was fixed by sanitising meta tags.
324
325 This hole was discovered on 21 March 2007 and fixed the same day
326 with the release of ikiwiki 1.47. A fix was also backported to Debian etch,
327 as version 1.33.3. I recommend upgrading to one of these versions if your
328 wiki can be edited by third parties.
329
330 ## insufficient checking for symlinks in srcdir path
331
332 Ikiwiki did not check if path to the srcdir to contained a symlink. If an
333 attacker had commit access to the directories in the path, they could
334 change it to a symlink, causing ikiwiki to read and publish files that were
335 not intended to be published. (But not write to them due to other checks.)
336
337 In most configurations, this is not exploitable, because the srcdir is
338 checked out of revision control, but the directories leading up to it are
339 not. Or, the srcdir is a single subdirectory of a project in revision
340 control (ie, `ikiwiki/doc`), and if the subdirectory were a symlink,
341 ikiwiki would still typically not follow it.
342
343 There are at least two configurations where this is exploitable:
344
345 * If the srcdir is a deeper subdirectory of a project. For example if it is
346   `project/foo/doc`, an an attacker can replace `foo` with a symlink to a
347   directory containing a `doc` directory (not a symlink), then ikiwiki
348   would follow the symlink.
349 * If the path to the srcdir in ikiwiki's configuration ended in "/", 
350   and the srcdir is a single subdirectory of a project, (ie,
351   `ikiwiki/doc/`), the srcdir could be a symlink and ikiwiki would not
352   notice.
353
354 This security hole was discovered on 26 November 2007 and fixed the same
355 day with the release of ikiwiki 2.14. I recommend upgrading to this version
356 if your wiki can be committed to by third parties. Alternatively, don't use
357 a trailing slash in the srcdir, and avoid the (unusual) configurations that
358 allow the security hole to be exploited.
359
360 ## javascript insertion via uris
361
362 The htmlscrubber did not block javascript in uris. This was fixed by adding
363 a whitelist of valid uri types, which does not include javascript. 
364 ([[cve CVE-2008-0809]]) Some urls specifyable by the meta plugin could also
365 theoretically have been used to inject javascript; this was also blocked
366 ([[cve CVE-2008-0808]]).
367
368 This hole was discovered on 10 February 2008 and fixed the same day
369 with the release of ikiwiki 2.31.1. (And a few subsequent versions..)
370 A fix was also backported to Debian etch, as version 1.33.4. I recommend
371 upgrading to one of these versions if your wiki can be edited by third
372 parties.
373
374 ## Cross Site Request Forging
375
376 Cross Site Request Forging could be used to constuct a link that would
377 change a logged-in user's password or other preferences if they clicked on
378 the link. It could also be used to construct a link that would cause a wiki
379 page to be modified by a logged-in user. ([[cve CVE-2008-0165]])
380
381 These holes were discovered on 10 April 2008 and fixed the same day with
382 the release of ikiwiki 2.42. A fix was also backported to Debian etch, as
383 version 1.33.5. I recommend upgrading to one of these versions.
384
385 ## Cleartext passwords
386
387 Until version 2.48, ikiwiki stored passwords in cleartext in the `userdb`.
388 That risks exposing all users' passwords if the file is somehow exposed. To
389 pre-emtively guard against that, current versions of ikiwiki store password
390 hashes (using Eksblowfish).
391
392 If you use the [[plugins/passwordauth]] plugin, I recommend upgrading to
393 ikiwiki 2.48, installing the [[Authen::Passphrase]] perl module, and running
394 `ikiwiki-transition hashpassword` to replace all existing cleartext passwords
395 with strong blowfish hashes. 
396
397 You might also consider changing to [[plugins/openid]], which does not 
398 require ikiwiki deal with passwords at all, and does not involve users sending
399 passwords in cleartext over the net to log in, either.