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