]> sipb.mit.edu Git - ikiwiki.git/blob - doc/security.mdwn
update
[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 # Probable holes
10
11 ## html attacks
12
13 ikiwiki does not attempt to do any santization of the html on the wiki.
14 [[MarkDown]] allows embedding of arbitrary html into a markdown document. If
15 you let anyone else edit files on the wiki, then anyone can have fun exploiting
16 the web browser bug of the day. This type of attack is typically referred
17 to as an XSS attack ([google](http://www.google.com/search?q=xss+attack)).
18
19 TODO: determine whether to try to deal with XSS attacks or whether this is
20 just something people using ikiwiki will need to keep in mind.
21
22 ## image files etc attacks
23
24 If it enounters a file type it does not understand, ikiwiki just copies it
25 into place. So if you let users add any kind of file they like, they can
26 upload images, movies, windows executables, css files, etc. If these files
27 exploit security holes in the browser of someone who's viewing the wiki,
28 that can be a security problem.
29
30 Of course nobody else seems to worry about this in other wikis, so should we?
31
32 ## web server attacks
33
34 If your web server does any parsing of special sorts of files (for example,
35 server parsed html files), then if you let anyone else add files to the wiki,
36 they can try to use this to exploit your web server.
37
38 ## multiple accessors of wiki directory
39
40 If multiple people can write to the source directory ikiwiki is using, or
41 to the destination directory it writes files to, then one can cause trouble
42 for the other when they run ikiwiki through symlink attacks.
43
44 So it's best if only one person can ever write to those directories.
45
46 ## setup files
47
48 Setup files are not safe to keep in subversion with the rest of the wiki.
49 Just don't do it. [[ikiwiki.setup]] is *not* used as the setup file for
50 this wiki, BTW.
51
52 ## svn commit logs
53
54 Anyone with svn commit access can forge "web commit from foo" and make it
55 appear on [[RecentChanges]] like foo committed. One way to avoid this would
56 be to limit web commits to those done by a certian user.
57
58 It's actually possible to force a whole series of svn commits to appear to
59 have come just before yours, by forging svn log output. This could be
60 guarded against by using svn log --xml.
61
62 ikiwiki escapes any html in svn commit logs to prevent other mischief.
63
64 ## page locking can be bypassed via direct svn commits
65
66 A [[lock]]ed page can only be edited on the web by an admin, but
67 anyone who is allowed to commit direct to svn can bypass this. This is by
68 design, although a subversion pre-commit hook could be used to prevent
69 editing of locked pages when using subversion, if you really need to.
70
71 ----
72
73 # Hopefully non-holes
74
75 (AKA, the assumptions that will be the root of most security holes...)
76
77 ## exploting ikiwiki with bad content
78
79 Someone could add bad content to the wiki and hope to exploit ikiwiki.
80 Note that ikiwiki runs with perl taint checks on, so this is unlikely.
81
82 ## publishing cgi scripts
83
84 ikiwiki does not allow cgi scripts to be published as part of the wiki. Or
85 rather, the script is published, but it's not marked executable (except in
86 the case of "destination directory file replacement" below), so hopefully
87 your web server will not run it.
88
89 ## suid wrappers
90
91 ikiwiki --wrapper is intended to generate a wrapper program that
92 runs ikiwiki to update a given wiki. The wrapper can in turn be made suid,
93 for example to be used in a [[post-commit]] hook by people who cannot write
94 to the html pages, etc.
95
96 If the wrapper script is made suid, then any bugs in this wrapper would be
97 security holes. The wrapper is written as securely as I know how, is based
98 on code that has a history of security use long before ikiwiki, and there's
99 been no problem yet.
100
101 ## shell exploits
102
103 ikiwiki does not expose untrusted data to the shell. In fact it doesn't use
104 system() at all, and the only use of backticks is on data supplied by the
105 wiki admin and untainted filenames. And it runs with taint checks on of
106 course..
107
108 ## cgi data security
109
110 When ikiwiki runs as a cgi to edit a page, it is passed the name of the
111 page to edit. It has to make sure to sanitise this page, to prevent eg,
112 editing of ../../../foo, or editing of files that are not part of the wiki,
113 such as subversion dotfiles. This is done by sanitising the filename
114 removing unallowed characters, then making sure it doesn't start with "/"
115 or contain ".." or "/.svn/". Annoyingly ad-hoc, this kind of code is where
116 security holes breed. It needs a test suite at the very least.
117
118 ## CGI::Session security
119
120 I've audited this module and it is massively insecure by default. ikiwiki
121 uses it in one of the few secure ways; by forcing it to write to a
122 directory it controls (and not /tmp) and by setting a umask that makes the
123 file not be world readable.
124
125 ## cgi password security
126
127 Login to the wiki involves sending a password in cleartext over the net.
128 Cracking the password only allows editing the wiki as that user though.
129 If you care, you can use https, I suppose.
130
131 # Fixed holes
132
133 _(Unless otherwise noted, these were discovered and immediatey fixed by the
134 ikiwiki developers.)_
135
136 ## destination directory file replacement
137
138 Any file in the destination directory that is a valid page filename can be
139 replaced, even if it was not originally rendered from a page. For example,
140 ikiwiki.cgi could be edited in the wiki, and it would write out a
141 replacement. File permission is preseved. Yipes!
142
143 This was fixed by making ikiwiki check if the file it's writing to exists;
144 if it does then it has to be a file that it's aware of creating before, or
145 it will refuse to create it.
146
147 Still, this sort of attack is something to keep in mind.
148
149 ## symlink attacks
150
151 Could a committer trick ikiwiki into following a symlink and operating on
152 some other tree that it shouldn't? svn supports symlinks, so one can get
153 into the repo. ikiwiki uses File::Find to traverse the repo, and does not
154 tell it to follow symlinks, but it might be possible to race replacing a
155 directory with a symlink and trick it into following the link.
156
157 Also, if someone checks in a symlink to /etc/passwd, ikiwiki would read and
158 publish that, which could be used to expose files a committer otherwise
159 wouldn't see.
160
161 To avoid this, ikiwiki will skip over symlinks when scanning for pages, and
162 uses locking to prevent more than one instance running at a time. The lock
163 prevents one ikiwiki from running a svn up at the wrong time to race
164 another ikiwiki. So only attackers who can write to the working copy on
165 their own can race it.
166
167 ## symlink + cgi attacks
168
169 Similarly, a svn commit of a symlink could be made, ikiwiki ignores it
170 because of the above, but the symlink is still there, and then you edit the
171 page from the web, which follows the symlink when reading the page, and
172 again when saving the changed page.
173
174 This was fixed by making ikiwiki refuse to read or write to files that are
175 symlinks, or that are in subdirectories that are symlinks, combined with
176 the above locking.
177
178 ## underlaydir override attacks
179
180 ikiwiki also scans an underlaydir for pages, this is used to provide stock
181 pages to all wikis w/o needing to copy them into the wiki. Since ikiwiki
182 internally stores only the base filename from the underlaydir or srcdir,
183 and searches for a file in either directory when reading a page source,
184 there is the potential for ikiwiki's scanner to reject a file from the
185 srcdir for some reason (such as it being a symlink), find a valid copy of
186 the file in the underlaydir, and then when loading the file, mistekenly
187 load the bad file from the srcdir.
188
189 This attack is avoided by making ikiwiki scan the srcdir first, and refuse
190 to add any files from the underlaydir if a file also exists in the srcdir
191 with the same name. **But**, note that this assumes that any given page can
192 be produced from a file with only one name (`page.mdwn` => `page.html`).
193
194 If it's possible for files with different names to produce a given page, it
195 would still be possible to use this attack to confuse ikiwiki into
196 rendering the wrong thing. This is not currently possible, but must be kept
197 in mind in the future when for example adding support for generating html
198 pages from source with some other extension.