updates
[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 ----
10
11 # Probable holes
12
13 _(The list of things to fix.)_
14
15 ## commit spoofing
16
17 Anyone with direct commit access can forge "web commit from foo" and
18 make it appear on [[RecentChanges]] like foo committed. One way to avoid
19 this would be to limit web commits to those done by a certian user.
20
21 ## other stuff to look at
22
23 I need to audit the git backend a bit, and have been meaning to
24 see if any CRLF injection type things can be done in the CGI code.
25
26 ----
27
28 # Potential gotchas
29
30 _(Things not to do.)_
31
32 ## image file etc attacks
33
34 If it enounters a file type it does not understand, ikiwiki just copies it
35 into place. So if you let users add any kind of file they like, they can
36 upload images, movies, windows executables, css files, etc (though not html
37 files). If these files exploit security holes in the browser of someone
38 who's viewing the wiki, that can be a security problem.
39
40 Of course nobody else seems to worry about this in other wikis, so should we?
41
42 Currently only people with direct svn commit access can upload such files
43 (and if you wanted to you could block that with a svn pre-commit hook).
44 Users with only web commit access are limited to editing pages as ikiwiki
45 doesn't support file uploads from browsers (yet), so they can't exploit
46 this.
47
48 ## multiple accessors of wiki directory
49
50 If multiple people can write to the source directory ikiwiki is using, or
51 to the destination directory it writes files to, then one can cause trouble
52 for the other when they run ikiwiki through symlink attacks.
53
54 So it's best if only one person can ever write to those directories.
55
56 ## setup files
57
58 Setup files are not safe to keep in subversion with the rest of the wiki.
59 Just don't do it. [[ikiwiki.setup]] is *not* used as the setup file for
60 this wiki, BTW.
61
62 ## page locking can be bypassed via direct svn commits
63
64 A locked page can only be edited on the web by an admin, but
65 anyone who is allowed to commit direct to svn can bypass this. This is by
66 design, although a subversion pre-commit hook could be used to prevent
67 editing of locked pages when using subversion, if you really need to.
68
69 ## web server attacks
70
71 If your web server does any parsing of special sorts of files (for example,
72 server parsed html files), then if you let anyone else add files to the wiki,
73 they can try to use this to exploit your web server.
74
75 ----
76
77 # Hopefully non-holes
78
79 _(AKA, the assumptions that will be the root of most security holes...)_
80
81 ## exploting ikiwiki with bad content
82
83 Someone could add bad content to the wiki and hope to exploit ikiwiki.
84 Note that ikiwiki runs with perl taint checks on, so this is unlikely.
85
86 One fun thing in ikiwiki is its handling of a PageSpec, which involves
87 translating it into perl and running the perl. Of course, this is done
88 *very* carefully to guard against injecting arbitrary perl code.
89
90 ## publishing cgi scripts
91
92 ikiwiki does not allow cgi scripts to be published as part of the wiki. Or
93 rather, the script is published, but it's not marked executable (except in
94 the case of "destination directory file replacement" below), so hopefully
95 your web server will not run it.
96
97 ## suid wrappers
98
99 ikiwiki --wrapper is intended to generate a wrapper program that
100 runs ikiwiki to update a given wiki. The wrapper can in turn be made suid,
101 for example to be used in a [[post-commit]] hook by people who cannot write
102 to the html pages, etc.
103
104 If the wrapper script is made suid, then any bugs in this wrapper would be
105 security holes. The wrapper is written as securely as I know how, is based
106 on code that has a history of security use long before ikiwiki, and there's
107 been no problem yet.
108
109 ## shell exploits
110
111 ikiwiki does not expose untrusted data to the shell. In fact it doesn't use
112 system() at all, and the only use of backticks is on data supplied by the
113 wiki admin and untainted filenames. And it runs with taint checks on of
114 course..
115
116 ## cgi data security
117
118 When ikiwiki runs as a cgi to edit a page, it is passed the name of the
119 page to edit. It has to make sure to sanitise this page, to prevent eg,
120 editing of ../../../foo, or editing of files that are not part of the wiki,
121 such as subversion dotfiles. This is done by sanitising the filename
122 removing unallowed characters, then making sure it doesn't start with "/"
123 or contain ".." or "/.svn/". Annoyingly ad-hoc, this kind of code is where
124 security holes breed. It needs a test suite at the very least.
125
126 ## CGI::Session security
127
128 I've audited this module and it is massively insecure by default. ikiwiki
129 uses it in one of the few secure ways; by forcing it to write to a
130 directory it controls (and not /tmp) and by setting a umask that makes the
131 file not be world readable.
132
133 ## cgi password security
134
135 Login to the wiki involves sending a password in cleartext over the net.
136 Cracking the password only allows editing the wiki as that user though.
137 If you care, you can use https, I suppose.
138
139 ## XSS holes in CGI output
140
141 ikiwiki has not yet been audited to ensure that all cgi script input/output
142 is sanitised to prevent XSS attacks. For example, a user can't register
143 with a username containing html code (anymore).
144
145 It's difficult to know for sure if all such avenues have really been
146 closed though.
147
148 ----
149
150 # Fixed holes
151
152 _(Unless otherwise noted, these were discovered and immediately fixed by the
153 ikiwiki developers.)_
154
155 ## destination directory file replacement
156
157 Any file in the destination directory that is a valid page filename can be
158 replaced, even if it was not originally rendered from a page. For example,
159 ikiwiki.cgi could be edited in the wiki, and it would write out a
160 replacement. File permission is preseved. Yipes!
161
162 This was fixed by making ikiwiki check if the file it's writing to exists;
163 if it does then it has to be a file that it's aware of creating before, or
164 it will refuse to create it.
165
166 Still, this sort of attack is something to keep in mind.
167
168 ## symlink attacks
169
170 Could a committer trick ikiwiki into following a symlink and operating on
171 some other tree that it shouldn't? svn supports symlinks, so one can get
172 into the repo. ikiwiki uses File::Find to traverse the repo, and does not
173 tell it to follow symlinks, but it might be possible to race replacing a
174 directory with a symlink and trick it into following the link.
175
176 Also, if someone checks in a symlink to /etc/passwd, ikiwiki would read and
177 publish that, which could be used to expose files a committer otherwise
178 wouldn't see.
179
180 To avoid this, ikiwiki will skip over symlinks when scanning for pages, and
181 uses locking to prevent more than one instance running at a time. The lock
182 prevents one ikiwiki from running a svn up at the wrong time to race
183 another ikiwiki. So only attackers who can write to the working copy on
184 their own can race it.
185
186 ## symlink + cgi attacks
187
188 Similarly, a svn commit of a symlink could be made, ikiwiki ignores it
189 because of the above, but the symlink is still there, and then you edit the
190 page from the web, which follows the symlink when reading the page
191 (exposing the content), and again when saving the changed page (changing
192 the content).
193
194 This was fixed for page saving by making ikiwiki refuse to write to files
195 that are symlinks, or that are in subdirectories that are symlinks,
196 combined with the above locking.
197
198 For page editing, it's fixed by ikiwiki checking to make sure that it
199 already has found a page by scanning the tree, before loading it for
200 editing, which as described above, also is done in a way that avoids
201 symlink attacks.
202
203 ## underlaydir override attacks
204
205 ikiwiki also scans an underlaydir for pages, this is used to provide stock
206 pages to all wikis w/o needing to copy them into the wiki. Since ikiwiki
207 internally stores only the base filename from the underlaydir or srcdir,
208 and searches for a file in either directory when reading a page source,
209 there is the potential for ikiwiki's scanner to reject a file from the
210 srcdir for some reason (such as it being contained in a directory that is
211 symlinked in), find a valid copy of the file in the underlaydir, and then
212 when loading the file, mistakenly load the bad file from the srcdir.
213
214 This attack is avoided by making ikiwiki refuse to add any files from the
215 underlaydir if a file also exists in the srcdir with the same name.
216
217 ## multiple page source issues
218
219 Note that I previously worried that underlay override attacks could also be
220 accomplished if ikiwiki were extended to support other page markup
221 languages besides markdown. However, a closer look indicates that this is
222 not a problem: ikiwiki does preserve the file extension when storing the
223 source filename of a page, so a file with another extension that renders to
224 the same page name can't bypass the check. Ie, ikiwiki won't skip foo.rst
225 in the srcdir, find foo.mdwn in the underlay, decide to render page foo and
226 then read the bad foo.mdwn. Instead it will remember the .rst extension and
227 only render a file with that extension.
228
229 ## XSS attacks in page content
230
231 ikiwiki supports protecting users from their own broken browsers via the
232 [[plugins/htmlscrubber]] plugin, which is enabled by default.
233
234 ## svn commit logs
235
236 It's was possible to force a whole series of svn commits to appear to
237 have come just before yours, by forging svn log output. This was
238 guarded against by using svn log --xml.
239
240 ikiwiki escapes any html in svn commit logs to prevent other mischief.
241
242 ## XML::Parser
243
244 XML::Parser is used by the aggregation plugin, and has some security holes. 
245 #[378411](http://bugs.debian.org/378411) does not
246 seem to affect our use, since the data is not encoded as utf-8 at that
247 point. #[378412](http://bugs.debian.org/378412) could affect us, although it
248 doesn't seem very exploitable. It has a simple fix, and has been fixed in
249 Debian unstable.